@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/schemaBuilderBase.js

@@ -0,0 +1,227 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeField = exports.normalizeAllowedTypes = exports.SchemaBuilderBase = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const util_1 = require("../util");
+const typed_schema_1 = require("./typed-schema");
+const default_schema_1 = require("./default-schema");
+/**
+ * Builds schema libraries, and the schema within them.
+ * @internal
+ *
+ * @privateRemarks
+ * This class does not directly depend on any specific field kinds,
+ * or bake in any defaults that might have compatibility implications.
+ * All use of such implicit defaults is done by subclasses, which thus get versioning implications.
+ */
+class SchemaBuilderBase {
+    /**
+     * @param defaultKind - The default field kind to use when inferring a {@link TreeFieldSchema} from {@link ImplicitAllowedTypes}.
+     */
+    constructor(defaultKind, options) {
+        this.defaultKind = defaultKind;
+        this.finalized = false;
+        this.treeNodeSchema = new Map();
+        this.adapters = {};
+        this.name = options.name ?? options.scope;
+        this.lintConfiguration = { ...typed_schema_1.schemaLintDefault, ...options.lint };
+        this.libraries = new Set();
+        this.addLibraries(...(options.libraries ?? []));
+        this.scope = options.scope;
+    }
+    scoped(name) {
+        return `${this.scope}.${name}`;
+    }
+    /**
+     * Adds more libraries to this one.
+     *
+     * Unlike adding of individual schema, adding of libraries is idempotent.
+     * If a single library is added multiple times (even indirectly via libraries it was added into),
+     * only a single copy will be included, so they will not conflict.
+     * This allows adding any library this one depends on without risk of conflicts for users of this library.
+     * Contents within the added libraries can still conflict however.
+     * Such errors will be reported when finalizing this builder into a library of document schema.
+     */
+    addLibraries(...libraries) {
+        for (const libs of libraries) {
+            for (const lib of libs.libraries) {
+                this.libraries.add(lib);
+            }
+        }
+    }
+    addNodeSchema(schema) {
+        (0, core_utils_1.assert)(!this.treeNodeSchema.has(schema.name), 0x799 /* Conflicting TreeNodeSchema names */);
+        this.treeNodeSchema.set(schema.name, schema);
+    }
+    finalizeCommon(field) {
+        (0, core_utils_1.assert)(!this.finalized, 0x79a /* SchemaBuilder can only be finalized once. */);
+        this.finalized = true;
+        this.libraries.add({
+            name: this.name,
+            nodeSchema: this.treeNodeSchema,
+            adapters: this.adapters,
+        });
+        // Check for errors and aggregate data
+        return (0, typed_schema_1.aggregateSchemaLibraries)(this.name, this.lintConfiguration, this.libraries, field);
+    }
+    /**
+     * Produce SchemaLibraries which capture the content added to this builder, as well as any additional SchemaLibraries that were added to it.
+     * May only be called once after adding content to builder is complete.
+     */
+    intoLibrary() {
+        const aggregated = this.finalizeCommon();
+        // Full library set (instead of just aggregated) is kept since it is required to handle deduplication of libraries included through different paths.
+        return { nodeSchema: aggregated.nodeSchema, libraries: this.libraries };
+    }
+    /**
+     * Produce a TreeSchema which captures the content added to this builder, any additional SchemaLibraries that were added to it and a root field.
+     * Can be used with schematize to provide schema aware access to document content.
+     *
+     * @remarks
+     * May only be called once after adding content to builder is complete.
+     */
+    intoSchema(root) {
+        // return this.toDocumentSchemaInternal(normalizeField(root, DefaultFieldKind));
+        const field = this.normalizeField(root);
+        const library = this.finalizeCommon(field);
+        const typed = {
+            nodeSchema: library.nodeSchema,
+            adapters: library.adapters,
+            rootFieldSchema: field,
+            policy: default_schema_1.defaultSchemaPolicy,
+        };
+        return typed;
+    }
+    /**
+     * Define (and add to this library) a {@link ObjectNodeSchema}.
+     *
+     * The name must be unique among all TreeNodeSchema in the the document schema.
+     */
+    object(name, t) {
+        const schema = typed_schema_1.ObjectNodeSchema.create(this, this.scoped(name), (0, util_1.transformObjectMap)(t, (field) => this.normalizeField(field)));
+        this.addNodeSchema(schema);
+        return schema;
+    }
+    /**
+     * Same as `object` but with less type safety and works for recursive objects.
+     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
+     *
+     * See {@link Unenforced} for details.
+     *
+     * TODO: Make this work with ImplicitFieldSchema.
+     */
+    objectRecursive(name, t) {
+        return this.object(name, t);
+    }
+    /**
+     * Define (and add to this library) a {@link MapNodeSchema}.
+     */
+    map(name, fieldSchema) {
+        const schema = typed_schema_1.MapNodeSchema.create(this, this.scoped(name), fieldSchema);
+        this.addNodeSchema(schema);
+        return schema;
+    }
+    /**
+     * Same as `map` but with less type safety and works for recursive objects.
+     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
+     *
+     * See {@link Unenforced} for details.
+     *
+     * TODO: Make this work with ImplicitFieldSchema.
+     */
+    mapRecursive(name, t) {
+        return this.map(name, t);
+    }
+    /**
+     * Define (and add to this library) a {@link FieldNodeSchema}.
+     *
+     * The name must be unique among all TreeNodeSchema in the the document schema.
+     *
+     * @privateRemarks
+     * TODO: Write and link document outlining field vs node data model and the separation of concerns related to that.
+     * TODO: Maybe find a better name for this.
+     */
+    fieldNode(name, fieldSchema) {
+        const schema = typed_schema_1.FieldNodeSchema.create(this, this.scoped(name), this.normalizeField(fieldSchema));
+        this.addNodeSchema(schema);
+        return schema;
+    }
+    /**
+     * Same as `fieldNode` but with less type safety and works for recursive objects.
+     * Reduced type safety is a side effect of a workaround for a TypeScript limitation.
+     *
+     * See {@link Unenforced} for details.
+     *
+     * TODO: Make this work with ImplicitFieldSchema.
+     */
+    fieldNodeRecursive(name, t) {
+        return this.fieldNode(name, t);
+    }
+    /**
+     * Define a {@link TreeFieldSchema}.
+     *
+     * @param kind - The [kind](https://en.wikipedia.org/wiki/Kind_(type_theory)) of this field.
+     * Determine the multiplicity, viewing and editing APIs as well as the merge resolution policy.
+     * @param allowedTypes - What types of children are allowed in this field.
+     * @returns a {@link TreeFieldSchema} which can be used as a object field (see {@link SchemaBuilderBase.object}),
+     * a map field (see {@link SchemaBuilderBase.map}), a field node (see {@link SchemaBuilderBase.fieldNode}) or the root field (see {@link SchemaBuilderBase.intoSchema}).
+     *
+     * @privateRemarks
+     * TODO:
+     * If a solution to TreeFieldSchema not being able to have extends clauses gets found,
+     * consider just having users do `new TreeFieldSchema` instead?
+     */
+    static field(kind, allowedTypes) {
+        return typed_schema_1.TreeFieldSchema.create(kind, normalizeAllowedTypes(allowedTypes));
+    }
+    /**
+     * Define a schema for a field.
+     * Same as {@link SchemaBuilderBase.field} but is less type safe and supports recursive types.
+     * This API is less safe to work around a [limitation of TypeScript](https://github.com/microsoft/TypeScript/issues/55758).
+     *
+     * T must extends `AllowedTypes`: This cannot be enforced via TypeScript since such an "extends" clauses cause recursive types to error with:
+     * "'theSchema' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer."
+     *
+     * TODO: Try and find a way to provide a more specific type without triggering the above error.
+     */
+    static fieldRecursive(kind, ...allowedTypes) {
+        return typed_schema_1.TreeFieldSchema.createUnsafe(kind, allowedTypes);
+    }
+    /**
+     * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema} using this schema builder's `defaultKind`.
+     */
+    normalizeField(schema) {
+        return normalizeField(schema, this.defaultKind);
+    }
+}
+exports.SchemaBuilderBase = SchemaBuilderBase;
+/**
+ * Normalizes an {@link ImplicitAllowedTypes} into  {@link AllowedTypes}.
+ */
+function normalizeAllowedTypes(schema) {
+    if (schema === typed_schema_1.Any) {
+        return [typed_schema_1.Any];
+    }
+    if (schema instanceof typed_schema_1.TreeNodeSchemaBase) {
+        return [schema];
+    }
+    (0, core_utils_1.assert)(Array.isArray(schema), 0x7c6 /* invalid ImplicitAllowedTypes */);
+    return schema;
+}
+exports.normalizeAllowedTypes = normalizeAllowedTypes;
+/**
+ * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema}.
+ */
+function normalizeField(schema, defaultKind) {
+    if (schema instanceof typed_schema_1.TreeFieldSchema) {
+        return schema;
+    }
+    const allowedTypes = normalizeAllowedTypes(schema);
+    return typed_schema_1.TreeFieldSchema.create(defaultKind, allowedTypes);
+}
+exports.normalizeField = normalizeField;
+//# sourceMappingURL=schemaBuilderBase.js.map

package/dist/feature-libraries/schemaBuilderBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaBuilderBase.js","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilderBase.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAEpD,kCAAgF;AAChF,iDAkBwB;AAExB,qDAAuD;AAwCvD;;;;;;;;GAQG;AACH,MAAa,iBAAiB;IAoB7B;;OAEG;IACH,YACkB,WAAyB,EAC1C,OAAqC;QADpB,gBAAW,GAAX,WAAW,CAAc;QAjBnC,cAAS,GAAY,KAAK,CAAC;QAClB,mBAAc,GAAkD,IAAI,GAAG,EAAE,CAAC;QAC1E,aAAQ,GAAa,EAAE,CAAC;QAkBxC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC;QAC1C,IAAI,CAAC,iBAAiB,GAAG,EAAE,GAAG,gCAAiB,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QACnE,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAES,MAAM,CACf,IAAU;QAEV,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,EAAmD,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACK,YAAY,CAAC,GAAG,SAA0B;QACjD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;YAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,EAAE;gBACjC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aACxB;SACD;IACF,CAAC;IAES,aAAa,CAA2B,MAAS;QAC1D,IAAA,mBAAM,EAAC,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC5F,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEO,cAAc,CAAC,KAAuB;QAC7C,IAAA,mBAAM,EAAC,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC/E,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI,CAAC,cAAc;YAC/B,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAC,CAAC;QAEH,sCAAsC;QACtC,OAAO,IAAA,uCAAwB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3F,CAAC;IAED;;;OAGG;IACI,WAAW;QACjB,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAEzC,oJAAoJ;QACpJ,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACI,UAAU,CAChB,IAAa;QAEb,gFAAgF;QAChF,MAAM,KAAK,GAA0C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE3C,MAAM,KAAK,GAA0D;YACpE,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,eAAe,EAAE,KAAK;YACtB,MAAM,EAAE,oCAAmB;SAC3B,CAAC;QACF,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAIZ,IAAU,EACV,CAAI;QAKJ,MAAM,MAAM,GAAG,+BAAgB,CAAC,MAAM,CACrC,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EACjB,IAAA,yBAAkB,EAAC,CAAC,EAAE,CAAC,KAAK,EAAmB,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAE3E,CACD,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAGpB,IAAU,EAAE,CAAI;QACjB,OAAO,IAAI,CAAC,MAAM,CACjB,IAAI,EACJ,CAAsE,CACf,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,GAAG,CACT,IAAU,EACV,WAAc;QAEd,MAAM,MAAM,GAAG,4BAAa,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;QAC1E,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,YAAY,CAClB,IAAU,EACV,CAAI;QAEJ,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAmB,CAA0C,CAAC;IACrF,CAAC;IAED;;;;;;;;OAQG;IACI,SAAS,CACf,IAAU,EACV,WAAc;QAEd,MAAM,MAAM,GAAG,8BAAe,CAAC,MAAM,CACpC,IAAI,EACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EACjB,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAChC,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CACxB,IAAU,EACV,CAAI;QAEJ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAwB,CAGnD,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,KAAK,CAClB,IAAU,EACV,YAAe;QAEf,OAAO,8BAAe,CAAC,MAAM,CAAC,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,cAAc,CAI1B,IAAU,EAAE,GAAG,YAAe;QAC/B,OAAO,8BAAe,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACO,cAAc,CACvB,MAAe;QAEf,OAAO,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;CACD;AA5QD,8CA4QC;AA+BD;;GAEG;AACH,SAAgB,qBAAqB,CACpC,MAAe;IAEf,IAAI,MAAM,KAAK,kBAAG,EAAE;QACnB,OAAO,CAAC,kBAAG,CAA8C,CAAC;KAC1D;IACD,IAAI,MAAM,YAAY,iCAAkB,EAAE;QACzC,OAAO,CAAC,MAAM,CAA8C,CAAC;KAC7D;IACD,IAAA,mBAAM,EAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACxE,OAAO,MAAmD,CAAC;AAC5D,CAAC;AAXD,sDAWC;AAaD;;GAEG;AACH,SAAgB,cAAc,CAC7B,MAAe,EACf,WAAqB;IAErB,IAAI,MAAM,YAAY,8BAAe,EAAE;QACtC,OAAO,MAA2C,CAAC;KACnD;IACD,MAAM,YAAY,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,8BAAe,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAGtD,CAAC;AACH,CAAC;AAZD,wCAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { Adapters, TreeNodeSchemaIdentifier } from \"../core\";\nimport { Assume, RestrictiveReadonlyRecord, transformObjectMap } from \"../util\";\nimport {\n\tSchemaLibraryData,\n\tSchemaLintConfiguration,\n\taggregateSchemaLibraries,\n\tschemaLintDefault,\n\tAllowedTypes,\n\tTreeNodeSchema,\n\tTreeFieldSchema,\n\tFlexTreeSchema,\n\tFlexList,\n\tUnenforced,\n\tAny,\n\tMapFieldSchema,\n\tSchemaCollection,\n\tObjectNodeSchema,\n\tMapNodeSchema,\n\tFieldNodeSchema,\n\tTreeNodeSchemaBase,\n} from \"./typed-schema\";\nimport { FieldKind } from \"./modular-schema\";\nimport { defaultSchemaPolicy } from \"./default-schema\";\n\n/**\n * Configuration for a SchemaBuilder.\n * @internal\n */\nexport interface SchemaBuilderOptions<TScope extends string = string> {\n\t/**\n\t * Prefix appended to the identifiers of all {@link TreeNodeSchema} produced by this builder.\n\t * Use of [Reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation) or a UUIDv4 is recommended to avoid collisions.\n\t */\n\tscope: TScope;\n\n\t/**\n\t * Name used to refer to this builder in error messages.\n\t * Has no impact on the actual generated schema.\n\t * Defaults to scope.\n\t */\n\tname?: string;\n\n\t/**\n\t * Optional configuration for \"linting\".\n\t * See {@link SchemaLintConfiguration}. Currently defaults to enabling all lints.\n\t */\n\tlint?: Partial<SchemaLintConfiguration>;\n\n\t/**\n\t * Libraries to include in this one.\n\t *\n\t * @remarks\n\t * Unlike adding of individual schema, adding of libraries is idempotent.\n\t * If a single library is added multiple times (even indirectly via libraries it was added into),\n\t * only a single copy will be included, so they will not conflict.\n\t * This allows adding any library this one depends on without risk of conflicts for users of this library.\n\t * Contents within the added libraries can still conflict however.\n\t * Such errors will be reported when finalizing this builder into a library or document schema.\n\t */\n\tlibraries?: SchemaLibrary[];\n}\n\n/**\n * Builds schema libraries, and the schema within them.\n * @internal\n *\n * @privateRemarks\n * This class does not directly depend on any specific field kinds,\n * or bake in any defaults that might have compatibility implications.\n * All use of such implicit defaults is done by subclasses, which thus get versioning implications.\n */\nexport class SchemaBuilderBase<\n\tTScope extends string,\n\tTDefaultKind extends FieldKind,\n\tTName extends number | string = string,\n> {\n\tprivate readonly lintConfiguration: SchemaLintConfiguration;\n\tprivate readonly libraries: Set<SchemaLibraryData>;\n\tprivate finalized: boolean = false;\n\tprivate readonly treeNodeSchema: Map<TreeNodeSchemaIdentifier, TreeNodeSchema> = new Map();\n\tprivate readonly adapters: Adapters = {};\n\t/**\n\t * Prefix appended to the identifiers of all {@link TreeNodeSchema} produced by this builder.\n\t */\n\tpublic readonly scope: TScope;\n\n\t/**\n\t * Used in error messages to identify content produced by this builder.\n\t */\n\tpublic readonly name: string;\n\n\t/**\n\t * @param defaultKind - The default field kind to use when inferring a {@link TreeFieldSchema} from {@link ImplicitAllowedTypes}.\n\t */\n\tpublic constructor(\n\t\tprivate readonly defaultKind: TDefaultKind,\n\t\toptions: SchemaBuilderOptions<TScope>,\n\t) {\n\t\tthis.name = options.name ?? options.scope;\n\t\tthis.lintConfiguration = { ...schemaLintDefault, ...options.lint };\n\t\tthis.libraries = new Set();\n\t\tthis.addLibraries(...(options.libraries ?? []));\n\t\tthis.scope = options.scope;\n\t}\n\n\tprotected scoped<Name extends TName>(\n\t\tname: Name,\n\t): TreeNodeSchemaIdentifier<`${TScope}.${Name}`> {\n\t\treturn `${this.scope}.${name}` as TreeNodeSchemaIdentifier<`${TScope}.${Name}`>;\n\t}\n\n\t/**\n\t * Adds more libraries to this one.\n\t *\n\t * Unlike adding of individual schema, adding of libraries is idempotent.\n\t * If a single library is added multiple times (even indirectly via libraries it was added into),\n\t * only a single copy will be included, so they will not conflict.\n\t * This allows adding any library this one depends on without risk of conflicts for users of this library.\n\t * Contents within the added libraries can still conflict however.\n\t * Such errors will be reported when finalizing this builder into a library of document schema.\n\t */\n\tprivate addLibraries(...libraries: SchemaLibrary[]) {\n\t\tfor (const libs of libraries) {\n\t\t\tfor (const lib of libs.libraries) {\n\t\t\t\tthis.libraries.add(lib);\n\t\t\t}\n\t\t}\n\t}\n\n\tprotected addNodeSchema<T extends TreeNodeSchema>(schema: T): void {\n\t\tassert(!this.treeNodeSchema.has(schema.name), 0x799 /* Conflicting TreeNodeSchema names */);\n\t\tthis.treeNodeSchema.set(schema.name, schema);\n\t}\n\n\tprivate finalizeCommon(field?: TreeFieldSchema): SchemaLibraryData {\n\t\tassert(!this.finalized, 0x79a /* SchemaBuilder can only be finalized once. */);\n\t\tthis.finalized = true;\n\t\tthis.libraries.add({\n\t\t\tname: this.name,\n\t\t\tnodeSchema: this.treeNodeSchema,\n\t\t\tadapters: this.adapters,\n\t\t});\n\n\t\t// Check for errors and aggregate data\n\t\treturn aggregateSchemaLibraries(this.name, this.lintConfiguration, this.libraries, field);\n\t}\n\n\t/**\n\t * Produce SchemaLibraries which capture the content added to this builder, as well as any additional SchemaLibraries that were added to it.\n\t * May only be called once after adding content to builder is complete.\n\t */\n\tpublic intoLibrary(): SchemaLibrary {\n\t\tconst aggregated = this.finalizeCommon();\n\n\t\t// Full library set (instead of just aggregated) is kept since it is required to handle deduplication of libraries included through different paths.\n\t\treturn { nodeSchema: aggregated.nodeSchema, libraries: this.libraries };\n\t}\n\n\t/**\n\t * Produce a TreeSchema which captures the content added to this builder, any additional SchemaLibraries that were added to it and a root field.\n\t * Can be used with schematize to provide schema aware access to document content.\n\t *\n\t * @remarks\n\t * May only be called once after adding content to builder is complete.\n\t */\n\tpublic intoSchema<const TSchema extends ImplicitFieldSchema>(\n\t\troot: TSchema,\n\t): FlexTreeSchema<NormalizeField<TSchema, TDefaultKind>> {\n\t\t// return this.toDocumentSchemaInternal(normalizeField(root, DefaultFieldKind));\n\t\tconst field: NormalizeField<TSchema, TDefaultKind> = this.normalizeField(root);\n\t\tconst library = this.finalizeCommon(field);\n\n\t\tconst typed: FlexTreeSchema<NormalizeField<TSchema, TDefaultKind>> = {\n\t\t\tnodeSchema: library.nodeSchema,\n\t\t\tadapters: library.adapters,\n\t\t\trootFieldSchema: field,\n\t\t\tpolicy: defaultSchemaPolicy,\n\t\t};\n\t\treturn typed;\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link ObjectNodeSchema}.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t */\n\tpublic object<\n\t\tconst Name extends TName,\n\t\tconst T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>,\n\t>(\n\t\tname: Name,\n\t\tt: T,\n\t): ObjectNodeSchema<\n\t\t`${TScope}.${Name}`,\n\t\t{ [key in keyof T]: NormalizeField<T[key], TDefaultKind> }\n\t> {\n\t\tconst schema = ObjectNodeSchema.create(\n\t\t\tthis,\n\t\t\tthis.scoped(name),\n\t\t\ttransformObjectMap(t, (field): TreeFieldSchema => this.normalizeField(field)) as {\n\t\t\t\t[key in keyof T]: NormalizeField<T[key], TDefaultKind>;\n\t\t\t},\n\t\t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Same as `object` but with less type safety and works for recursive objects.\n\t * Reduced type safety is a side effect of a workaround for a TypeScript limitation.\n\t *\n\t * See {@link Unenforced} for details.\n\t *\n\t * TODO: Make this work with ImplicitFieldSchema.\n\t */\n\tpublic objectRecursive<\n\t\tconst Name extends TName,\n\t\tconst T extends Unenforced<RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>,\n\t>(name: Name, t: T): ObjectNodeSchema<`${TScope}.${Name}`, T> {\n\t\treturn this.object(\n\t\t\tname,\n\t\t\tt as unknown as RestrictiveReadonlyRecord<string, ImplicitFieldSchema>,\n\t\t) as unknown as ObjectNodeSchema<`${TScope}.${Name}`, T>;\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link MapNodeSchema}.\n\t */\n\tpublic map<Name extends TName, const T extends MapFieldSchema>(\n\t\tname: Name,\n\t\tfieldSchema: T,\n\t): MapNodeSchema<`${TScope}.${Name}`, T> {\n\t\tconst schema = MapNodeSchema.create(this, this.scoped(name), fieldSchema);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Same as `map` but with less type safety and works for recursive objects.\n\t * Reduced type safety is a side effect of a workaround for a TypeScript limitation.\n\t *\n\t * See {@link Unenforced} for details.\n\t *\n\t * TODO: Make this work with ImplicitFieldSchema.\n\t */\n\tpublic mapRecursive<Name extends TName, const T extends Unenforced<MapFieldSchema>>(\n\t\tname: Name,\n\t\tt: T,\n\t): MapNodeSchema<`${TScope}.${Name}`, T> {\n\t\treturn this.map(name, t as MapFieldSchema) as MapNodeSchema<`${TScope}.${Name}`, T>;\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link FieldNodeSchema}.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t *\n\t * @privateRemarks\n\t * TODO: Write and link document outlining field vs node data model and the separation of concerns related to that.\n\t * TODO: Maybe find a better name for this.\n\t */\n\tpublic fieldNode<Name extends TName, const T extends ImplicitFieldSchema>(\n\t\tname: Name,\n\t\tfieldSchema: T,\n\t): FieldNodeSchema<`${TScope}.${Name}`, NormalizeField<T, TDefaultKind>> {\n\t\tconst schema = FieldNodeSchema.create(\n\t\t\tthis,\n\t\t\tthis.scoped(name),\n\t\t\tthis.normalizeField(fieldSchema),\n\t\t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n\n\t/**\n\t * Same as `fieldNode` but with less type safety and works for recursive objects.\n\t * Reduced type safety is a side effect of a workaround for a TypeScript limitation.\n\t *\n\t * See {@link Unenforced} for details.\n\t *\n\t * TODO: Make this work with ImplicitFieldSchema.\n\t */\n\tpublic fieldNodeRecursive<Name extends TName, const T extends Unenforced<ImplicitFieldSchema>>(\n\t\tname: Name,\n\t\tt: T,\n\t): FieldNodeSchema<`${TScope}.${Name}`, T> {\n\t\treturn this.fieldNode(name, t as ImplicitFieldSchema) as FieldNodeSchema<\n\t\t\t`${TScope}.${Name}`,\n\t\t\tT\n\t\t>;\n\t}\n\n\t/**\n\t * Define a {@link TreeFieldSchema}.\n\t *\n\t * @param kind - The [kind](https://en.wikipedia.org/wiki/Kind_(type_theory)) of this field.\n\t * Determine the multiplicity, viewing and editing APIs as well as the merge resolution policy.\n\t * @param allowedTypes - What types of children are allowed in this field.\n\t * @returns a {@link TreeFieldSchema} which can be used as a object field (see {@link SchemaBuilderBase.object}),\n\t * a map field (see {@link SchemaBuilderBase.map}), a field node (see {@link SchemaBuilderBase.fieldNode}) or the root field (see {@link SchemaBuilderBase.intoSchema}).\n\t *\n\t * @privateRemarks\n\t * TODO:\n\t * If a solution to TreeFieldSchema not being able to have extends clauses gets found,\n\t * consider just having users do `new TreeFieldSchema` instead?\n\t */\n\tpublic static field<Kind extends FieldKind, T extends ImplicitAllowedTypes>(\n\t\tkind: Kind,\n\t\tallowedTypes: T,\n\t): TreeFieldSchema<Kind, NormalizeAllowedTypes<T>> {\n\t\treturn TreeFieldSchema.create(kind, normalizeAllowedTypes(allowedTypes));\n\t}\n\n\t/**\n\t * Define a schema for a field.\n\t * Same as {@link SchemaBuilderBase.field} but is less type safe and supports recursive types.\n\t * This API is less safe to work around a [limitation of TypeScript](https://github.com/microsoft/TypeScript/issues/55758).\n\t *\n\t * T must extends `AllowedTypes`: This cannot be enforced via TypeScript since such an \"extends\" clauses cause recursive types to error with:\n\t * \"'theSchema' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer.\"\n\t *\n\t * TODO: Try and find a way to provide a more specific type without triggering the above error.\n\t */\n\tpublic static fieldRecursive<\n\t\tKind extends FieldKind,\n\t\t// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-arguments\n\t\tT extends FlexList<Unenforced<TreeNodeSchema>>,\n\t>(kind: Kind, ...allowedTypes: T): TreeFieldSchema<Kind, T> {\n\t\treturn TreeFieldSchema.createUnsafe(kind, allowedTypes);\n\t}\n\n\t/**\n\t * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema} using this schema builder's `defaultKind`.\n\t */\n\tprotected normalizeField<TSchema extends ImplicitFieldSchema>(\n\t\tschema: TSchema,\n\t): NormalizeField<TSchema, TDefaultKind> {\n\t\treturn normalizeField(schema, this.defaultKind);\n\t}\n}\n\n/**\n * Schema information collected by a SchemaBuilder, including referenced libraries.\n * Can be aggregated into other libraries by adding to their builders.\n * @internal\n */\nexport interface SchemaLibrary extends SchemaCollection {\n\t/**\n\t * Schema data aggregated from a collection of libraries by a SchemaBuilder.\n\t */\n\treadonly libraries: ReadonlySet<SchemaLibraryData>;\n}\n\n/**\n * Generalized version of AllowedTypes allowing for more concise expressions in some cases.\n * @internal\n */\nexport type ImplicitAllowedTypes = AllowedTypes | TreeNodeSchema | Any;\n\n/**\n * Normalizes an {@link ImplicitAllowedTypes} into  {@link AllowedTypes}.\n * @internal\n */\nexport type NormalizeAllowedTypes<TSchema extends ImplicitAllowedTypes> =\n\tTSchema extends TreeNodeSchema\n\t\t? readonly [TSchema]\n\t\t: TSchema extends Any\n\t\t? readonly [Any]\n\t\t: TSchema;\n\n/**\n * Normalizes an {@link ImplicitAllowedTypes} into  {@link AllowedTypes}.\n */\nexport function normalizeAllowedTypes<TSchema extends ImplicitAllowedTypes>(\n\tschema: TSchema,\n): NormalizeAllowedTypes<TSchema> {\n\tif (schema === Any) {\n\t\treturn [Any] as unknown as NormalizeAllowedTypes<TSchema>;\n\t}\n\tif (schema instanceof TreeNodeSchemaBase) {\n\t\treturn [schema] as unknown as NormalizeAllowedTypes<TSchema>;\n\t}\n\tassert(Array.isArray(schema), 0x7c6 /* invalid ImplicitAllowedTypes */);\n\treturn schema as unknown as NormalizeAllowedTypes<TSchema>;\n}\n\n/**\n * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema}.\n * @internal\n */\nexport type NormalizeField<\n\tTSchema extends ImplicitFieldSchema,\n\tTDefault extends FieldKind,\n> = TSchema extends TreeFieldSchema\n\t? TSchema\n\t: TreeFieldSchema<TDefault, NormalizeAllowedTypes<Assume<TSchema, ImplicitAllowedTypes>>>;\n\n/**\n * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema}.\n */\nexport function normalizeField<TSchema extends ImplicitFieldSchema, TDefault extends FieldKind>(\n\tschema: TSchema,\n\tdefaultKind: TDefault,\n): NormalizeField<TSchema, TDefault> {\n\tif (schema instanceof TreeFieldSchema) {\n\t\treturn schema as NormalizeField<TSchema, TDefault>;\n\t}\n\tconst allowedTypes = normalizeAllowedTypes(schema);\n\treturn TreeFieldSchema.create(defaultKind, allowedTypes) as unknown as NormalizeField<\n\t\tTSchema,\n\t\tTDefault\n\t>;\n}\n\n/**\n * Type that when combined with a default {@link FieldKind} can be normalized into a {@link TreeFieldSchema}.\n * @internal\n */\nexport type ImplicitFieldSchema = TreeFieldSchema | ImplicitAllowedTypes;\n"]}

package/dist/feature-libraries/sequence-field/compose.d.ts

@@ -0,0 +1,45 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { RevisionMetadataSource, RevisionTag, TaggedChange } from "../../core";
+import { IdAllocator } from "../../util";
+import { CrossFieldManager } from "../modular-schema";
+import { Changeset, Mark, MarkList } from "./types";
+import { MoveEffectTable } from "./moveEffectTable";
+/**
+ * @internal
+ */
+export type NodeChangeComposer<TNodeChange> = (changes: TaggedChange<TNodeChange>[]) => TNodeChange;
+/**
+ * Composes a sequence of changesets into a single changeset.
+ * @param changes - The changesets to be applied.
+ * Parts of the input may be reused in the output, but the input is not mutated.
+ * Each changeset in the list is assumed to be applicable after the previous one.
+ * @returns A changeset that is equivalent to applying each of the given `changes` in order.
+ *
+ * WARNING! This implementation is incomplete:
+ * - Tombstone information is ignored.
+ * - Support for moves is not implemented.
+ * - Support for slices is not implemented.
+ */
+export declare function compose<TNodeChange>(changes: TaggedChange<Changeset<TNodeChange>>[], composeChild: NodeChangeComposer<TNodeChange>, genId: IdAllocator, manager: CrossFieldManager, revisionMetadata: RevisionMetadataSource): Changeset<TNodeChange>;
+export declare function amendCompose<TNodeChange>(marks: MarkList<TNodeChange>, composeChild: NodeChangeComposer<TNodeChange>, genId: IdAllocator, manager: CrossFieldManager): MarkList<TNodeChange>;
+export declare class ComposeQueue<T> {
+    private readonly newRevision;
+    private readonly revisionMetadata;
+    private readonly baseMarks;
+    private readonly newMarks;
+    constructor(baseRevision: RevisionTag | undefined, baseMarks: Changeset<T>, newRevision: RevisionTag | undefined, newMarks: Changeset<T>, genId: IdAllocator, moveEffects: MoveEffectTable<T>, revisionMetadata: RevisionMetadataSource, composeChanges?: (a: T | undefined, b: TaggedChange<T>) => T | undefined);
+    isEmpty(): boolean;
+    pop(): ComposeMarks<T>;
+    private dequeueBase;
+    private dequeueNew;
+    private dequeueBoth;
+}
+interface ComposeMarks<T> {
+    baseMark?: Mark<T>;
+    newMark?: Mark<T>;
+}
+export {};
+//# sourceMappingURL=compose.d.ts.map

package/dist/feature-libraries/sequence-field/compose.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/sequence-field/compose.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAGN,sBAAsB,EACtB,WAAW,EAEX,YAAY,EACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EAA2C,WAAW,EAAE,MAAM,YAAY,CAAC;AAClF,OAAO,EAAE,iBAAiB,EAAoB,MAAM,mBAAmB,CAAC;AACxE,OAAO,EACN,SAAS,EACT,IAAI,EACJ,QAAQ,EAMR,MAAM,SAAS,CAAC;AAGjB,OAAO,EAIN,eAAe,EAMf,MAAM,mBAAmB,CAAC;AAgC3B;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,WAAW,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,KAAK,WAAW,CAAC;AAEpG;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,WAAW,EAClC,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,EAC/C,YAAY,EAAE,kBAAkB,CAAC,WAAW,CAAC,EAC7C,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,iBAAiB,EAC1B,gBAAgB,EAAE,sBAAsB,GACtC,SAAS,CAAC,WAAW,CAAC,CAcxB;AA4VD,wBAAgB,YAAY,CAAC,WAAW,EACvC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,EAC5B,YAAY,EAAE,kBAAkB,CAAC,WAAW,CAAC,EAC7C,KAAK,EAAE,WAAW,EAClB,OAAO,EAAE,iBAAiB,GACxB,QAAQ,CAAC,WAAW,CAAC,CAEvB;AAyBD,qBAAa,YAAY,CAAC,CAAC;IAOzB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAI5B,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAVlC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;gBAGvC,YAAY,EAAE,WAAW,GAAG,SAAS,EACrC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EACN,WAAW,EAAE,WAAW,GAAG,SAAS,EACrD,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EACtB,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,eAAe,CAAC,CAAC,CAAC,EACd,gBAAgB,EAAE,sBAAsB,EACzD,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS;IAoBlE,OAAO,IAAI,OAAO;IAIlB,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC;IAqD7B,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,UAAU;IAOlB,OAAO,CAAC,WAAW;CAanB;AAED,UAAU,YAAY,CAAC,CAAC;IACvB,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACnB,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;CAClB"}