/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */
import { fail } from "@fluidframework/core-utils/internal";
import { forbiddenFieldKindIdentifier, Multiplicity, } from "../../core/index.js";
import { identifierFieldIdentifier } from "../fieldKindIdentifiers.js";
import { FlexFieldKind, ModularChangeFormatVersion, referenceFreeFieldChangeRebaser, } from "../modular-schema/index.js";
import { optional, required } from "../optional-field/index.js";
import { sequence } from "../sequence-field/index.js";
import { noChangeCodecFamily } from "./noChangeCodecs.js";
/**
 * ChangeHandler that only handles no-op / identity changes.
 */
export const noChangeHandler = {
    rebaser: referenceFreeFieldChangeRebaser({
        compose: (change1, change2) => 0,
        invert: (changes) => 0,
        rebase: (change, over) => 0,
        mute: (changes) => 0,
    }),
    codecsFactory: () => noChangeCodecFamily,
    editor: { buildChildChanges: () => fail(0xb0d /* Child changes not supported */) },
    intoDelta: (change, deltaFromChild) => ({}),
    relevantRemovedRoots: (change) => [],
    isEmpty: (change) => true,
    getNestedChanges: (change) => [],
    createEmpty: () => 0,
    getCrossFieldKeys: () => [],
};
/**
 * Exactly one identifier.
 */
export const identifier = new FlexFieldKind(identifierFieldIdentifier, Multiplicity.Single, {
    changeHandler: noChangeHandler,
    // By omitting required here,
    // this is making a policy choice that a schema upgrade cannot be done from required to identifier.
    // Since an identifier can be upgraded into a required field,
    // preventing the inverse helps ensure that schema upgrades are monotonic.
    // Which direction is allowed is a subjective policy choice.
    allowMonotonicUpgradeFrom: new Set([]),
});
/**
 * Exactly 0 items.
 *
 * Using Forbidden makes what types are listed for allowed in a field irrelevant
 * since the field will never have values in it.
 *
 * Using Forbidden is equivalent to picking a kind that permits empty (like sequence or optional)
 * and having no allowed types (or only never types).
 * Because of this, its possible to express everything constraint wise without Forbidden,
 * but using Forbidden can be more semantically clear than optional with no allowed types.
 *
 * For view schema, this can be useful if you need to:
 * - run a specific out of schema handler when a field is present,
 * but otherwise are ignoring or tolerating (ex: via extra fields) unmentioned fields.
 * - prevent a specific field from being used as an extra field
 * (perhaps for some past of future compatibility reason)
 * - keep a field in a schema for metadata purposes
 * (ex: for improved error messaging, error handling or documentation)
 * that is not used in this specific version of the schema (ex: to document what it was or will be used for).
 *
 * For stored schema, this can be useful if you need to:
 * - have a field which can have its schema updated to Optional or Sequence of any type.
 * - to exclude a field from extra fields
 * - for the schema system to use as a default for fields which aren't declared
 * (ex: when updating a field that did not exist into one that does)
 *
 * See {@link emptyField} for a constant, reusable field using Forbidden.
 */
export const forbidden = new FlexFieldKind(forbiddenFieldKindIdentifier, Multiplicity.Forbidden, {
    changeHandler: noChangeHandler,
    allowMonotonicUpgradeFrom: new Set(),
});
export const fieldKindConfigurations = new Map([
    [
        ModularChangeFormatVersion.v3,
        new Map([
            [required.identifier, { kind: required, formatVersion: 2 }],
            [optional.identifier, { kind: optional, formatVersion: 2 }],
            [sequence.identifier, { kind: sequence, formatVersion: 2 }],
            [forbidden.identifier, { kind: forbidden, formatVersion: 1 }],
            [identifier.identifier, { kind: identifier, formatVersion: 1 }],
        ]),
    ],
    [
        ModularChangeFormatVersion.v4,
        new Map([
            [required.identifier, { kind: required, formatVersion: 2 }],
            [optional.identifier, { kind: optional, formatVersion: 2 }],
            [sequence.identifier, { kind: sequence, formatVersion: 3 }],
            [forbidden.identifier, { kind: forbidden, formatVersion: 1 }],
            [identifier.identifier, { kind: identifier, formatVersion: 1 }],
        ]),
    ],
    [
        ModularChangeFormatVersion.v5,
        new Map([
            [required.identifier, { kind: required, formatVersion: 2 }],
            [optional.identifier, { kind: optional, formatVersion: 2 }],
            [sequence.identifier, { kind: sequence, formatVersion: 3 }],
            [forbidden.identifier, { kind: forbidden, formatVersion: 1 }],
            [identifier.identifier, { kind: identifier, formatVersion: 1 }],
        ]),
    ],
]);
export function getCodecTreeForModularChangeFormat(version) {
    const dependencies = fieldKindConfigurations.get(version) ?? fail(0xc7c /* Unknown modular change format */);
    const children = [...dependencies.entries()].map(([key, { formatVersion }]) => ({
        name: `FieldKind:${key}`,
        version: formatVersion,
    }));
    return {
        name: "ModularChange",
        version,
        children,
    };
}
/**
 * All supported field kinds.
 *
 * @privateRemarks
 * Before making a SharedTree format change which impacts which set of field kinds are allowed,
 * code which uses this should be audited for compatibility considerations.
 */
export const fieldKinds = new Map([required, optional, sequence, identifier, forbidden].map((s) => [s.identifier, s]));
/**
 * Default FieldKinds with their editor types erased.
 */
export const FieldKinds = { required, optional, sequence, identifier, forbidden };
/**
 * FullSchemaPolicy with the default field kinds.
 */
export const defaultSchemaPolicy = {
    fieldKinds,
};
//# sourceMappingURL=defaultFieldKinds.js.map