@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/schema-index/format.d.ts

@@ -0,0 +1,60 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Static } from "@sinclair/typebox";
+import { schemaFormat } from "../../core";
+export declare const TreeNodeSchemaFormat: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>;
+    data: import("@sinclair/typebox").TObject<{
+        object: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            name: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKey>;
+            kind: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKindIdentifier>;
+            types: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>>>;
+        }>>>;
+        map: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            kind: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKindIdentifier>;
+            types: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>>>;
+        }>>;
+        leaf: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<typeof schemaFormat.PersistedValueSchema>>;
+    }>;
+}>;
+/**
+ * Format for encoding as json.
+ *
+ * For consistency all lists are sorted and undefined values are omitted.
+ *
+ * This chooses to use lists of named objects instead of maps:
+ * this choice is somewhat arbitrary, but avoids user data being used as object keys,
+ * which can sometimes be an issue (for example handling that for "__proto__" can require care).
+ * It also makes it simpler to determinately sort by keys.
+ */
+export declare const Format: import("@sinclair/typebox").TObject<{
+    version: import("@sinclair/typebox").TLiteral<1>;
+    nodeSchema: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        name: import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>;
+        data: import("@sinclair/typebox").TObject<{
+            object: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                name: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKey>;
+                kind: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKindIdentifier>;
+                types: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>>>;
+            }>>>;
+            map: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+                kind: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKindIdentifier>;
+                types: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>>>;
+            }>>;
+            leaf: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<typeof schemaFormat.PersistedValueSchema>>;
+        }>;
+    }>>;
+    rootFieldSchema: import("@sinclair/typebox").TObject<{
+        kind: import("@sinclair/typebox").TUnsafe<schemaFormat.FieldKindIdentifier>;
+        types: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnsafe<schemaFormat.TreeNodeSchemaIdentifier<string>>>>;
+    }>;
+}>;
+export type Format = Static<typeof Format>;
+export type TreeNodeSchemaFormat = Static<typeof TreeNodeSchemaFormat>;
+export declare const Versioned: import("@sinclair/typebox").TObject<{
+    version: import("@sinclair/typebox").TString;
+}>;
+export type Versioned = Static<typeof Versioned>;
+//# sourceMappingURL=format.d.ts.map

package/dist/feature-libraries/schema-index/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/format.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAiB,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI1C,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;EAMhC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;EAOlB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,MAAM,CAAC,CAAC;AAE3C,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEvE,eAAO,MAAM,SAAS;;EAEpB,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,SAAS,CAAC,CAAC"}

package/dist/feature-libraries/schema-index/format.js

@@ -0,0 +1,33 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Versioned = exports.Format = exports.TreeNodeSchemaFormat = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const core_1 = require("../../core");
+const noAdditionalProps = { additionalProperties: false };
+exports.TreeNodeSchemaFormat = typebox_1.Type.Object({
+    name: core_1.schemaFormat.TreeNodeSchemaIdentifierSchema,
+    data: core_1.schemaFormat.TreeNodeSchemaDataFormat,
+}, noAdditionalProps);
+/**
+ * Format for encoding as json.
+ *
+ * For consistency all lists are sorted and undefined values are omitted.
+ *
+ * This chooses to use lists of named objects instead of maps:
+ * this choice is somewhat arbitrary, but avoids user data being used as object keys,
+ * which can sometimes be an issue (for example handling that for "__proto__" can require care).
+ * It also makes it simpler to determinately sort by keys.
+ */
+exports.Format = typebox_1.Type.Object({
+    version: typebox_1.Type.Literal(core_1.schemaFormat.version),
+    nodeSchema: typebox_1.Type.Array(exports.TreeNodeSchemaFormat),
+    rootFieldSchema: core_1.schemaFormat.FieldSchemaFormat,
+}, noAdditionalProps);
+exports.Versioned = typebox_1.Type.Object({
+    version: typebox_1.Type.String(),
+});
+//# sourceMappingURL=format.js.map

package/dist/feature-libraries/schema-index/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/format.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+CAAgE;AAChE,qCAA0C;AAE1C,MAAM,iBAAiB,GAAkB,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;AAE5D,QAAA,oBAAoB,GAAG,cAAI,CAAC,MAAM,CAC9C;IACC,IAAI,EAAE,mBAAY,CAAC,8BAA8B;IACjD,IAAI,EAAE,mBAAY,CAAC,wBAAwB;CAC3C,EACD,iBAAiB,CACjB,CAAC;AAEF;;;;;;;;;GASG;AACU,QAAA,MAAM,GAAG,cAAI,CAAC,MAAM,CAChC;IACC,OAAO,EAAE,cAAI,CAAC,OAAO,CAAC,mBAAY,CAAC,OAAO,CAAC;IAC3C,UAAU,EAAE,cAAI,CAAC,KAAK,CAAC,4BAAoB,CAAC;IAC5C,eAAe,EAAE,mBAAY,CAAC,iBAAiB;CAC/C,EACD,iBAAiB,CACjB,CAAC;AAMW,QAAA,SAAS,GAAG,cAAI,CAAC,MAAM,CAAC;IACpC,OAAO,EAAE,cAAI,CAAC,MAAM,EAAE;CACtB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ObjectOptions, Static, Type } from \"@sinclair/typebox\";\nimport { schemaFormat } from \"../../core\";\n\nconst noAdditionalProps: ObjectOptions = { additionalProperties: false };\n\nexport const TreeNodeSchemaFormat = Type.Object(\n\t{\n\t\tname: schemaFormat.TreeNodeSchemaIdentifierSchema,\n\t\tdata: schemaFormat.TreeNodeSchemaDataFormat,\n\t},\n\tnoAdditionalProps,\n);\n\n/**\n * Format for encoding as json.\n *\n * For consistency all lists are sorted and undefined values are omitted.\n *\n * This chooses to use lists of named objects instead of maps:\n * this choice is somewhat arbitrary, but avoids user data being used as object keys,\n * which can sometimes be an issue (for example handling that for \"__proto__\" can require care).\n * It also makes it simpler to determinately sort by keys.\n */\nexport const Format = Type.Object(\n\t{\n\t\tversion: Type.Literal(schemaFormat.version),\n\t\tnodeSchema: Type.Array(TreeNodeSchemaFormat),\n\t\trootFieldSchema: schemaFormat.FieldSchemaFormat,\n\t},\n\tnoAdditionalProps,\n);\n\nexport type Format = Static<typeof Format>;\n\nexport type TreeNodeSchemaFormat = Static<typeof TreeNodeSchemaFormat>;\n\nexport const Versioned = Type.Object({\n\tversion: Type.String(),\n});\nexport type Versioned = Static<typeof Versioned>;\n"]}

package/dist/feature-libraries/schema-index/index.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { SchemaSummarizer, encodeTreeSchema } from "./schemaSummarizer";
+export { makeSchemaCodec } from "./codec";
+export { Format } from "./format";
+//# sourceMappingURL=index.d.ts.map

package/dist/feature-libraries/schema-index/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}

package/dist/feature-libraries/schema-index/index.js

@@ -0,0 +1,15 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Format = exports.makeSchemaCodec = exports.encodeTreeSchema = exports.SchemaSummarizer = void 0;
+var schemaSummarizer_1 = require("./schemaSummarizer");
+Object.defineProperty(exports, "SchemaSummarizer", { enumerable: true, get: function () { return schemaSummarizer_1.SchemaSummarizer; } });
+Object.defineProperty(exports, "encodeTreeSchema", { enumerable: true, get: function () { return schemaSummarizer_1.encodeTreeSchema; } });
+var codec_1 = require("./codec");
+Object.defineProperty(exports, "makeSchemaCodec", { enumerable: true, get: function () { return codec_1.makeSchemaCodec; } });
+var format_1 = require("./format");
+Object.defineProperty(exports, "Format", { enumerable: true, get: function () { return format_1.Format; } });
+//# sourceMappingURL=index.js.map

package/dist/feature-libraries/schema-index/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uDAAwE;AAA/D,oHAAA,gBAAgB,OAAA;AAAE,oHAAA,gBAAgB,OAAA;AAC3C,iCAA0C;AAAjC,wGAAA,eAAe,OAAA;AACxB,mCAAkC;AAAzB,gGAAA,MAAM,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { SchemaSummarizer, encodeTreeSchema } from \"./schemaSummarizer\";\nexport { makeSchemaCodec } from \"./codec\";\nexport { Format } from \"./format\";\n"]}

package/dist/feature-libraries/schema-index/schemaSummarizer.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IFluidDataStoreRuntime, IChannelStorageService } from "@fluidframework/datastore-definitions";
+import { ITelemetryContext, ISummaryTreeWithStats, IGarbageCollectionData, IExperimentalIncrementalSummaryContext } from "@fluidframework/runtime-definitions";
+import { ICodecOptions } from "../../codec";
+import { MutableTreeStoredSchema, TreeStoredSchema } from "../../core";
+import { Summarizable, SummaryElementParser, SummaryElementStringifier } from "../../shared-tree-core";
+import { JsonCompatible } from "../../util";
+import { CollabWindow } from "../incrementalSummarizationUtils";
+/**
+ * Provides methods for summarizing and loading a schema repository.
+ */
+export declare class SchemaSummarizer implements Summarizable {
+    private readonly runtime;
+    private readonly schema;
+    readonly key = "Schema";
+    private readonly codec;
+    private schemaIndexLastChangedSeq;
+    constructor(runtime: IFluidDataStoreRuntime, schema: MutableTreeStoredSchema, options: ICodecOptions, collabWindow: CollabWindow);
+    getAttachSummary(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext | undefined): ISummaryTreeWithStats;
+    summarize(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext | undefined): Promise<ISummaryTreeWithStats>;
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    load(services: IChannelStorageService, parse: SummaryElementParser): Promise<void>;
+}
+/**
+ * Dumps schema into a deterministic JSON compatible semi-human readable but unspecified format.
+ *
+ * @remarks
+ * This can be used to help inspect schema for debugging, and to save a snapshot of schema to help detect and review changes to an applications schema.
+ *
+ * This format may change across major versions of this package: such changes are considered breaking.
+ * Beyond that, no compatibility guarantee is provided for this format: it should never be relied upon to load data, it should only be used for comparing outputs from this function.
+ * @privateRemarks
+ * This currently uses the schema summary format, but that could be changed to something more human readable (particularly if the encoded format becomes less human readable).
+ * This intentionally does not leak the format types in the API.
+ * @internal
+ */
+export declare function encodeTreeSchema(schema: TreeStoredSchema): JsonCompatible;
+//# sourceMappingURL=schemaSummarizer.d.ts.map

package/dist/feature-libraries/schema-index/schemaSummarizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaSummarizer.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/schemaSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,sCAAsC,EACtC,MAAM,qCAAqC,CAAC;AAG7C,OAAO,EAAE,aAAa,EAAc,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAqB,MAAM,YAAY,CAAC;AAC1F,OAAO,EACN,YAAY,EACZ,oBAAoB,EACpB,yBAAyB,EACzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAKhE;;GAEG;AACH,qBAAa,gBAAiB,YAAW,YAAY;IAQnD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IARxB,SAAgB,GAAG,YAAY;IAE/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuC;IAE7D,OAAO,CAAC,yBAAyB,CAAqB;gBAGpC,OAAO,EAAE,sBAAsB,EAC/B,MAAM,EAAE,uBAAuB,EAChD,OAAO,EAAE,aAAa,EACtB,YAAY,EAAE,YAAY;IAUpB,gBAAgB,CACtB,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAAG,SAAS,GAC5E,qBAAqB;IAmBX,SAAS,CACrB,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAAG,SAAS,GAC5E,OAAO,CAAC,qBAAqB,CAAC;IAI1B,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAU7C,IAAI,CAChB,QAAQ,EAAE,sBAAsB,EAChC,KAAK,EAAE,oBAAoB,GACzB,OAAO,CAAC,IAAI,CAAC;CAgBhB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc,CAEzE"}

package/dist/feature-libraries/schema-index/schemaSummarizer.js

@@ -0,0 +1,86 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeTreeSchema = exports.SchemaSummarizer = void 0;
+const client_utils_1 = require("@fluid-internal/client-utils");
+const core_utils_1 = require("@fluidframework/core-utils");
+const runtime_utils_1 = require("@fluidframework/runtime-utils");
+const protocol_definitions_1 = require("@fluidframework/protocol-definitions");
+const core_1 = require("../../core");
+const codec_1 = require("./codec");
+const schemaStringKey = "SchemaString";
+/**
+ * Provides methods for summarizing and loading a schema repository.
+ */
+class SchemaSummarizer {
+    constructor(runtime, schema, options, collabWindow) {
+        this.runtime = runtime;
+        this.schema = schema;
+        this.key = "Schema";
+        this.codec = (0, codec_1.makeSchemaCodec)(options);
+        this.schema.on("afterSchemaChange", () => {
+            // Invalidate the cache, as we need to regenerate the blob if the schema changes
+            // We are assuming that schema changes from remote ops are valid, as we are in a summarization context.
+            this.schemaIndexLastChangedSeq = collabWindow.getCurrentSeq();
+        });
+    }
+    getAttachSummary(stringify, fullTree, trackState, telemetryContext, incrementalSummaryContext) {
+        const builder = new runtime_utils_1.SummaryTreeBuilder();
+        if (incrementalSummaryContext !== undefined &&
+            this.schemaIndexLastChangedSeq !== undefined &&
+            incrementalSummaryContext.latestSummarySequenceNumber >= this.schemaIndexLastChangedSeq) {
+            builder.addHandle(schemaStringKey, protocol_definitions_1.SummaryType.Blob, `${incrementalSummaryContext.summaryPath}/indexes/${this.key}/${schemaStringKey}`);
+        }
+        else {
+            const dataString = JSON.stringify(this.codec.encode(this.schema));
+            builder.addBlob(schemaStringKey, dataString);
+        }
+        return builder.getSummaryTree();
+    }
+    async summarize(stringify, fullTree, trackState, telemetryContext, incrementalSummaryContext) {
+        throw new Error("Method not implemented.");
+    }
+    getGCData(fullGC) {
+        // TODO: Properly implement garbage collection. Right now, garbage collection is performed automatically
+        // by the code in SharedObject (from which SharedTreeCore extends). The `runtime.uploadBlob` API delegates
+        // to the `BlobManager`, which automatically populates the summary with ISummaryAttachment entries for each
+        // blob.
+        return {
+            gcNodes: {},
+        };
+    }
+    async load(services, parse) {
+        const schemaBuffer = await services.readBlob(schemaStringKey);
+        // After the awaits, validate that the schema is in a clean state.
+        // This detects any schema that could have been accidentally added through
+        // invalid means and are about to be overwritten.
+        (0, core_utils_1.assert)((0, core_1.schemaDataIsEmpty)(this.schema), 0x3da /* there should not already be stored schema when loading stored schema */);
+        const schemaString = (0, client_utils_1.bufferToString)(schemaBuffer, "utf-8");
+        // Currently no Fluid handles are used, so just use JSON.parse.
+        const decoded = this.codec.decode(JSON.parse(schemaString));
+        this.schema.apply(decoded);
+        this.schemaIndexLastChangedSeq = 0;
+    }
+}
+exports.SchemaSummarizer = SchemaSummarizer;
+/**
+ * Dumps schema into a deterministic JSON compatible semi-human readable but unspecified format.
+ *
+ * @remarks
+ * This can be used to help inspect schema for debugging, and to save a snapshot of schema to help detect and review changes to an applications schema.
+ *
+ * This format may change across major versions of this package: such changes are considered breaking.
+ * Beyond that, no compatibility guarantee is provided for this format: it should never be relied upon to load data, it should only be used for comparing outputs from this function.
+ * @privateRemarks
+ * This currently uses the schema summary format, but that could be changed to something more human readable (particularly if the encoded format becomes less human readable).
+ * This intentionally does not leak the format types in the API.
+ * @internal
+ */
+function encodeTreeSchema(schema) {
+    return (0, codec_1.encodeRepo)(schema);
+}
+exports.encodeTreeSchema = encodeTreeSchema;
+//# sourceMappingURL=schemaSummarizer.js.map

package/dist/feature-libraries/schema-index/schemaSummarizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaSummarizer.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/schemaSummarizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA8D;AAC9D,2DAAoD;AAWpD,iEAAmE;AACnE,+EAAmE;AAEnE,qCAA0F;AAS1F,mCAAsD;AAEtD,MAAM,eAAe,GAAG,cAAc,CAAC;AACvC;;GAEG;AACH,MAAa,gBAAgB;IAO5B,YACkB,OAA+B,EAC/B,MAA+B,EAChD,OAAsB,EACtB,YAA0B;QAHT,YAAO,GAAP,OAAO,CAAwB;QAC/B,WAAM,GAAN,MAAM,CAAyB;QARjC,QAAG,GAAG,QAAQ,CAAC;QAY9B,IAAI,CAAC,KAAK,GAAG,IAAA,uBAAe,EAAC,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YACxC,gFAAgF;YAChF,uGAAuG;YACvG,IAAI,CAAC,yBAAyB,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/D,CAAC,CAAC,CAAC;IACJ,CAAC;IAEM,gBAAgB,CACtB,SAAoC,EACpC,QAAkB,EAClB,UAAoB,EACpB,gBAAoC,EACpC,yBAA8E;QAE9E,MAAM,OAAO,GAAG,IAAI,kCAAkB,EAAE,CAAC;QACzC,IACC,yBAAyB,KAAK,SAAS;YACvC,IAAI,CAAC,yBAAyB,KAAK,SAAS;YAC5C,yBAAyB,CAAC,2BAA2B,IAAI,IAAI,CAAC,yBAAyB,EACtF;YACD,OAAO,CAAC,SAAS,CAChB,eAAe,EACf,kCAAW,CAAC,IAAI,EAChB,GAAG,yBAAyB,CAAC,WAAW,YAAY,IAAI,CAAC,GAAG,IAAI,eAAe,EAAE,CACjF,CAAC;SACF;aAAM;YACN,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAClE,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;SAC7C;QACD,OAAO,OAAO,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS,CACrB,SAAoC,EACpC,QAAkB,EAClB,UAAoB,EACpB,gBAAoC,EACpC,yBAA8E;QAE9E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC5C,CAAC;IAEM,SAAS,CAAC,MAAgB;QAChC,wGAAwG;QACxG,0GAA0G;QAC1G,2GAA2G;QAC3G,QAAQ;QACR,OAAO;YACN,OAAO,EAAE,EAAE;SACX,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAChB,QAAgC,EAChC,KAA2B;QAE3B,MAAM,YAAY,GAAoB,MAAM,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC/E,kEAAkE;QAClE,0EAA0E;QAC1E,iDAAiD;QACjD,IAAA,mBAAM,EACL,IAAA,wBAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,EAC9B,KAAK,CAAC,0EAA0E,CAChF,CAAC;QAEF,MAAM,YAAY,GAAG,IAAA,6BAAc,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAC3D,+DAA+D;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,IAAI,CAAC,yBAAyB,GAAG,CAAC,CAAC;IACpC,CAAC;CACD;AArFD,4CAqFC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,gBAAgB,CAAC,MAAwB;IACxD,OAAO,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AAFD,4CAEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport {\n\tIFluidDataStoreRuntime,\n\tIChannelStorageService,\n} from \"@fluidframework/datastore-definitions\";\nimport {\n\tITelemetryContext,\n\tISummaryTreeWithStats,\n\tIGarbageCollectionData,\n\tIExperimentalIncrementalSummaryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { SummaryTreeBuilder } from \"@fluidframework/runtime-utils\";\nimport { SummaryType } from \"@fluidframework/protocol-definitions\";\nimport { ICodecOptions, IJsonCodec } from \"../../codec\";\nimport { MutableTreeStoredSchema, TreeStoredSchema, schemaDataIsEmpty } from \"../../core\";\nimport {\n\tSummarizable,\n\tSummaryElementParser,\n\tSummaryElementStringifier,\n} from \"../../shared-tree-core\";\nimport { JsonCompatible } from \"../../util\";\nimport { CollabWindow } from \"../incrementalSummarizationUtils\";\nimport { Format } from \"./format\";\nimport { encodeRepo, makeSchemaCodec } from \"./codec\";\n\nconst schemaStringKey = \"SchemaString\";\n/**\n * Provides methods for summarizing and loading a schema repository.\n */\nexport class SchemaSummarizer implements Summarizable {\n\tpublic readonly key = \"Schema\";\n\n\tprivate readonly codec: IJsonCodec<TreeStoredSchema, Format>;\n\n\tprivate schemaIndexLastChangedSeq: number | undefined;\n\n\tpublic constructor(\n\t\tprivate readonly runtime: IFluidDataStoreRuntime,\n\t\tprivate readonly schema: MutableTreeStoredSchema,\n\t\toptions: ICodecOptions,\n\t\tcollabWindow: CollabWindow,\n\t) {\n\t\tthis.codec = makeSchemaCodec(options);\n\t\tthis.schema.on(\"afterSchemaChange\", () => {\n\t\t\t// Invalidate the cache, as we need to regenerate the blob if the schema changes\n\t\t\t// We are assuming that schema changes from remote ops are valid, as we are in a summarization context.\n\t\t\tthis.schemaIndexLastChangedSeq = collabWindow.getCurrentSeq();\n\t\t});\n\t}\n\n\tpublic getAttachSummary(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext | undefined,\n\t): ISummaryTreeWithStats {\n\t\tconst builder = new SummaryTreeBuilder();\n\t\tif (\n\t\t\tincrementalSummaryContext !== undefined &&\n\t\t\tthis.schemaIndexLastChangedSeq !== undefined &&\n\t\t\tincrementalSummaryContext.latestSummarySequenceNumber >= this.schemaIndexLastChangedSeq\n\t\t) {\n\t\t\tbuilder.addHandle(\n\t\t\t\tschemaStringKey,\n\t\t\t\tSummaryType.Blob,\n\t\t\t\t`${incrementalSummaryContext.summaryPath}/indexes/${this.key}/${schemaStringKey}`,\n\t\t\t);\n\t\t} else {\n\t\t\tconst dataString = JSON.stringify(this.codec.encode(this.schema));\n\t\t\tbuilder.addBlob(schemaStringKey, dataString);\n\t\t}\n\t\treturn builder.getSummaryTree();\n\t}\n\n\tpublic async summarize(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext | undefined,\n\t): Promise<ISummaryTreeWithStats> {\n\t\tthrow new Error(\"Method not implemented.\");\n\t}\n\n\tpublic getGCData(fullGC?: boolean): IGarbageCollectionData {\n\t\t// TODO: Properly implement garbage collection. Right now, garbage collection is performed automatically\n\t\t// by the code in SharedObject (from which SharedTreeCore extends). The `runtime.uploadBlob` API delegates\n\t\t// to the `BlobManager`, which automatically populates the summary with ISummaryAttachment entries for each\n\t\t// blob.\n\t\treturn {\n\t\t\tgcNodes: {},\n\t\t};\n\t}\n\n\tpublic async load(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t): Promise<void> {\n\t\tconst schemaBuffer: ArrayBufferLike = await services.readBlob(schemaStringKey);\n\t\t// After the awaits, validate that the schema is in a clean state.\n\t\t// This detects any schema that could have been accidentally added through\n\t\t// invalid means and are about to be overwritten.\n\t\tassert(\n\t\t\tschemaDataIsEmpty(this.schema),\n\t\t\t0x3da /* there should not already be stored schema when loading stored schema */,\n\t\t);\n\n\t\tconst schemaString = bufferToString(schemaBuffer, \"utf-8\");\n\t\t// Currently no Fluid handles are used, so just use JSON.parse.\n\t\tconst decoded = this.codec.decode(JSON.parse(schemaString));\n\t\tthis.schema.apply(decoded);\n\t\tthis.schemaIndexLastChangedSeq = 0;\n\t}\n}\n\n/**\n * Dumps schema into a deterministic JSON compatible semi-human readable but unspecified format.\n *\n * @remarks\n * This can be used to help inspect schema for debugging, and to save a snapshot of schema to help detect and review changes to an applications schema.\n *\n * This format may change across major versions of this package: such changes are considered breaking.\n * Beyond that, no compatibility guarantee is provided for this format: it should never be relied upon to load data, it should only be used for comparing outputs from this function.\n * @privateRemarks\n * This currently uses the schema summary format, but that could be changed to something more human readable (particularly if the encoded format becomes less human readable).\n * This intentionally does not leak the format types in the API.\n * @internal\n */\nexport function encodeTreeSchema(schema: TreeStoredSchema): JsonCompatible {\n\treturn encodeRepo(schema);\n}\n"]}

package/dist/feature-libraries/schemaBuilder.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ValueSchema } from "../core";
+import { SchemaBuilderBase, SchemaBuilderOptions } from "./schemaBuilderBase";
+import { FieldKinds } from "./default-schema";
+import { LeafNodeSchema } from "./typed-schema";
+/**
+ * Extends {@link SchemaBuilderBase} with functionality only used to create built in special libraries.
+ * Defaults to "required" fields.
+ * @privateRemarks Should not be package exported.
+ */
+export declare class SchemaBuilderInternal<TScope extends `com.fluidframework.${string}`> extends SchemaBuilderBase<TScope, typeof FieldKinds.required> {
+    constructor(options: SchemaBuilderOptions<TScope>);
+    /**
+     * Define (and add to this library) a {@link TreeNodeSchema} for a node that wraps a value.
+     * Such nodes will be implicitly unwrapped to the value in some APIs.
+     *
+     * The name must be unique among all TreeNodeSchema in the the document schema.
+     *
+     * In addition to the normal properties of all nodes (having a schema for example),
+     * Leaf nodes only contain a value.
+     * Leaf nodes cannot have fields.
+     *
+     * TODO: Maybe ban undefined from allowed values here.
+     * TODO: Decide and document how unwrapping works for non-primitive terminals.
+     */
+    leaf<Name extends string, const T extends ValueSchema>(name: Name, t: T): LeafNodeSchema<`${TScope}.${Name}`, T>;
+}
+//# sourceMappingURL=schemaBuilder.d.ts.map

package/dist/feature-libraries/schemaBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaBuilder.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;GAIG;AACH,qBAAa,qBAAqB,CACjC,MAAM,SAAS,sBAAsB,MAAM,EAAE,CAC5C,SAAQ,iBAAiB,CAAC,MAAM,EAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;gBAC3C,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAIxD;;;;;;;;;;;;OAYG;IACI,IAAI,CAAC,IAAI,SAAS,MAAM,EAAE,KAAK,CAAC,CAAC,SAAS,WAAW,EAC3D,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,cAAc,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;CAKzC"}

package/dist/feature-libraries/schemaBuilder.js

@@ -0,0 +1,40 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaBuilderInternal = void 0;
+const schemaBuilderBase_1 = require("./schemaBuilderBase");
+const default_schema_1 = require("./default-schema");
+const typed_schema_1 = require("./typed-schema");
+/**
+ * Extends {@link SchemaBuilderBase} with functionality only used to create built in special libraries.
+ * Defaults to "required" fields.
+ * @privateRemarks Should not be package exported.
+ */
+class SchemaBuilderInternal extends schemaBuilderBase_1.SchemaBuilderBase {
+    constructor(options) {
+        super(default_schema_1.FieldKinds.required, options);
+    }
+    /**
+     * Define (and add to this library) a {@link TreeNodeSchema} for a node that wraps a value.
+     * Such nodes will be implicitly unwrapped to the value in some APIs.
+     *
+     * The name must be unique among all TreeNodeSchema in the the document schema.
+     *
+     * In addition to the normal properties of all nodes (having a schema for example),
+     * Leaf nodes only contain a value.
+     * Leaf nodes cannot have fields.
+     *
+     * TODO: Maybe ban undefined from allowed values here.
+     * TODO: Decide and document how unwrapping works for non-primitive terminals.
+     */
+    leaf(name, t) {
+        const schema = typed_schema_1.LeafNodeSchema.create(this, this.scoped(name), t);
+        this.addNodeSchema(schema);
+        return schema;
+    }
+}
+exports.SchemaBuilderInternal = SchemaBuilderInternal;
+//# sourceMappingURL=schemaBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemaBuilder.js","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilder.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2DAA8E;AAC9E,qDAA8C;AAC9C,iDAAgD;AAEhD;;;;GAIG;AACH,MAAa,qBAEX,SAAQ,qCAAqD;IAC9D,YAAmB,OAAqC;QACvD,KAAK,CAAC,2BAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,IAAI,CACV,IAAU,EACV,CAAI;QAEJ,MAAM,MAAM,GAAG,6BAAc,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3B,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AA5BD,sDA4BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ValueSchema } from \"../core\";\nimport { SchemaBuilderBase, SchemaBuilderOptions } from \"./schemaBuilderBase\";\nimport { FieldKinds } from \"./default-schema\";\nimport { LeafNodeSchema } from \"./typed-schema\";\n\n/**\n * Extends {@link SchemaBuilderBase} with functionality only used to create built in special libraries.\n * Defaults to \"required\" fields.\n * @privateRemarks Should not be package exported.\n */\nexport class SchemaBuilderInternal<\n\tTScope extends `com.fluidframework.${string}`,\n> extends SchemaBuilderBase<TScope, typeof FieldKinds.required> {\n\tpublic constructor(options: SchemaBuilderOptions<TScope>) {\n\t\tsuper(FieldKinds.required, options);\n\t}\n\n\t/**\n\t * Define (and add to this library) a {@link TreeNodeSchema} for a node that wraps a value.\n\t * Such nodes will be implicitly unwrapped to the value in some APIs.\n\t *\n\t * The name must be unique among all TreeNodeSchema in the the document schema.\n\t *\n\t * In addition to the normal properties of all nodes (having a schema for example),\n\t * Leaf nodes only contain a value.\n\t * Leaf nodes cannot have fields.\n\t *\n\t * TODO: Maybe ban undefined from allowed values here.\n\t * TODO: Decide and document how unwrapping works for non-primitive terminals.\n\t */\n\tpublic leaf<Name extends string, const T extends ValueSchema>(\n\t\tname: Name,\n\t\tt: T,\n\t): LeafNodeSchema<`${TScope}.${Name}`, T> {\n\t\tconst schema = LeafNodeSchema.create(this, this.scoped(name), t);\n\t\tthis.addNodeSchema(schema);\n\t\treturn schema;\n\t}\n}\n"]}

package/dist/feature-libraries/schemaBuilderBase.d.ts

@@ -0,0 +1,217 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TreeNodeSchemaIdentifier } from "../core";
+import { Assume, RestrictiveReadonlyRecord } from "../util";
+import { SchemaLibraryData, SchemaLintConfiguration, AllowedTypes, TreeNodeSchema, TreeFieldSchema, FlexTreeSchema, FlexList, Unenforced, Any, MapFieldSchema, SchemaCollection, ObjectNodeSchema, MapNodeSchema, FieldNodeSchema } from "./typed-schema";
+import { FieldKind } from "./modular-schema";
+/**
+ * Configuration for a SchemaBuilder.
+ * @internal
+ */
+export interface SchemaBuilderOptions<TScope extends string = string> {
+    /**
+     * Prefix appended to the identifiers of all {@link TreeNodeSchema} produced by this builder.
+     * Use of [Reverse domain name notation](https://en.wikipedia.org/wiki/Reverse_domain_name_notation) or a UUIDv4 is recommended to avoid collisions.
+     */
+    scope: TScope;
+    /**
+     * Name used to refer to this builder in error messages.
+     * Has no impact on the actual generated schema.
+     * Defaults to scope.
+     */
+    name?: string;
+    /**
+     * Optional configuration for "linting".
+     * See {@link SchemaLintConfiguration}. Currently defaults to enabling all lints.
+     */
+    lint?: Partial<SchemaLintConfiguration>;
+    /**
+     * Libraries to include in this one.
+     *
+     * @remarks
+     * 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 or document schema.
+     */
+    libraries?: SchemaLibrary[];
+}
+/**
+ * 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.
+ */
+export declare class SchemaBuilderBase<TScope extends string, TDefaultKind extends FieldKind, TName extends number | string = string> {
+    private readonly defaultKind;
+    private readonly lintConfiguration;
+    private readonly libraries;
+    private finalized;
+    private readonly treeNodeSchema;
+    private readonly adapters;
+    /**
+     * Prefix appended to the identifiers of all {@link TreeNodeSchema} produced by this builder.
+     */
+    readonly scope: TScope;
+    /**
+     * Used in error messages to identify content produced by this builder.
+     */
+    readonly name: string;
+    /**
+     * @param defaultKind - The default field kind to use when inferring a {@link TreeFieldSchema} from {@link ImplicitAllowedTypes}.
+     */
+    constructor(defaultKind: TDefaultKind, options: SchemaBuilderOptions<TScope>);
+    protected scoped<Name extends TName>(name: Name): TreeNodeSchemaIdentifier<`${TScope}.${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.
+     */
+    private addLibraries;
+    protected addNodeSchema<T extends TreeNodeSchema>(schema: T): void;
+    private finalizeCommon;
+    /**
+     * 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(): SchemaLibrary;
+    /**
+     * 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<const TSchema extends ImplicitFieldSchema>(root: TSchema): FlexTreeSchema<NormalizeField<TSchema, TDefaultKind>>;
+    /**
+     * Define (and add to this library) a {@link ObjectNodeSchema}.
+     *
+     * The name must be unique among all TreeNodeSchema in the the document schema.
+     */
+    object<const Name extends TName, const T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>(name: Name, t: T): ObjectNodeSchema<`${TScope}.${Name}`, {
+        [key in keyof T]: NormalizeField<T[key], TDefaultKind>;
+    }>;
+    /**
+     * 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<const Name extends TName, const T extends Unenforced<RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>>(name: Name, t: T): ObjectNodeSchema<`${TScope}.${Name}`, T>;
+    /**
+     * Define (and add to this library) a {@link MapNodeSchema}.
+     */
+    map<Name extends TName, const T extends MapFieldSchema>(name: Name, fieldSchema: T): MapNodeSchema<`${TScope}.${Name}`, T>;
+    /**
+     * 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 extends TName, const T extends Unenforced<MapFieldSchema>>(name: Name, t: T): MapNodeSchema<`${TScope}.${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 extends TName, const T extends ImplicitFieldSchema>(name: Name, fieldSchema: T): FieldNodeSchema<`${TScope}.${Name}`, NormalizeField<T, TDefaultKind>>;
+    /**
+     * 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 extends TName, const T extends Unenforced<ImplicitFieldSchema>>(name: Name, t: T): FieldNodeSchema<`${TScope}.${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 extends FieldKind, T extends ImplicitAllowedTypes>(kind: Kind, allowedTypes: T): TreeFieldSchema<Kind, NormalizeAllowedTypes<T>>;
+    /**
+     * 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 extends FieldKind, T extends FlexList<Unenforced<TreeNodeSchema>>>(kind: Kind, ...allowedTypes: T): TreeFieldSchema<Kind, T>;
+    /**
+     * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema} using this schema builder's `defaultKind`.
+     */
+    protected normalizeField<TSchema extends ImplicitFieldSchema>(schema: TSchema): NormalizeField<TSchema, TDefaultKind>;
+}
+/**
+ * Schema information collected by a SchemaBuilder, including referenced libraries.
+ * Can be aggregated into other libraries by adding to their builders.
+ * @internal
+ */
+export interface SchemaLibrary extends SchemaCollection {
+    /**
+     * Schema data aggregated from a collection of libraries by a SchemaBuilder.
+     */
+    readonly libraries: ReadonlySet<SchemaLibraryData>;
+}
+/**
+ * Generalized version of AllowedTypes allowing for more concise expressions in some cases.
+ * @internal
+ */
+export type ImplicitAllowedTypes = AllowedTypes | TreeNodeSchema | Any;
+/**
+ * Normalizes an {@link ImplicitAllowedTypes} into  {@link AllowedTypes}.
+ * @internal
+ */
+export type NormalizeAllowedTypes<TSchema extends ImplicitAllowedTypes> = TSchema extends TreeNodeSchema ? readonly [TSchema] : TSchema extends Any ? readonly [Any] : TSchema;
+/**
+ * Normalizes an {@link ImplicitAllowedTypes} into  {@link AllowedTypes}.
+ */
+export declare function normalizeAllowedTypes<TSchema extends ImplicitAllowedTypes>(schema: TSchema): NormalizeAllowedTypes<TSchema>;
+/**
+ * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema}.
+ * @internal
+ */
+export type NormalizeField<TSchema extends ImplicitFieldSchema, TDefault extends FieldKind> = TSchema extends TreeFieldSchema ? TSchema : TreeFieldSchema<TDefault, NormalizeAllowedTypes<Assume<TSchema, ImplicitAllowedTypes>>>;
+/**
+ * Normalizes an {@link ImplicitFieldSchema} into a {@link TreeFieldSchema}.
+ */
+export declare function normalizeField<TSchema extends ImplicitFieldSchema, TDefault extends FieldKind>(schema: TSchema, defaultKind: TDefault): NormalizeField<TSchema, TDefault>;
+/**
+ * Type that when combined with a default {@link FieldKind} can be normalized into a {@link TreeFieldSchema}.
+ * @internal
+ */
+export type ImplicitFieldSchema = TreeFieldSchema | ImplicitAllowedTypes;
+//# sourceMappingURL=schemaBuilderBase.d.ts.map

package/dist/feature-libraries/schemaBuilderBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaBuilderBase.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/schemaBuilderBase.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAY,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,yBAAyB,EAAsB,MAAM,SAAS,CAAC;AAChF,OAAO,EACN,iBAAiB,EACjB,uBAAuB,EAGvB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,cAAc,EACd,QAAQ,EACR,UAAU,EACV,GAAG,EACH,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,eAAe,EAEf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG7C;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM;IACnE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAExC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;CAC5B;AAED;;;;;;;;GAQG;AACH,qBAAa,iBAAiB,CAC7B,MAAM,SAAS,MAAM,EACrB,YAAY,SAAS,SAAS,EAC9B,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM;IAqBrC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAnB7B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA0B;IAC5D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IACnD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4D;IAC3F,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IACzC;;OAEG;IACH,SAAgB,KAAK,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;gBAEe,WAAW,EAAE,YAAY,EAC1C,OAAO,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAStC,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,KAAK,EAClC,IAAI,EAAE,IAAI,GACR,wBAAwB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;IAIhD;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,aAAa,CAAC,CAAC,SAAS,cAAc,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI;IAKlE,OAAO,CAAC,cAAc;IAatB;;;OAGG;IACI,WAAW,IAAI,aAAa;IAOnC;;;;;;OAMG;IACI,UAAU,CAAC,KAAK,CAAC,OAAO,SAAS,mBAAmB,EAC1D,IAAI,EAAE,OAAO,GACX,cAAc,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAcxD;;;;OAIG;IACI,MAAM,CACZ,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAEtE,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,gBAAgB,CAClB,GAAG,MAAM,IAAI,IAAI,EAAE,EACnB;SAAG,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;KAAE,CAC1D;IAYD;;;;;;;OAOG;IACI,eAAe,CACrB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,EACjF,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAO7D;;OAEG;IACI,GAAG,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,cAAc,EAC5D,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,CAAC,GACZ,aAAa,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAMxC;;;;;;;OAOG;IACI,YAAY,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,cAAc,CAAC,EACjF,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,aAAa,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAIxC;;;;;;;;OAQG;IACI,SAAS,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,mBAAmB,EACvE,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,CAAC,GACZ,eAAe,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IAUxE;;;;;;;OAOG;IACI,kBAAkB,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,mBAAmB,CAAC,EAC5F,IAAI,EAAE,IAAI,EACV,CAAC,EAAE,CAAC,GACF,eAAe,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;IAO1C;;;;;;;;;;;;;OAaG;WACW,KAAK,CAAC,IAAI,SAAS,SAAS,EAAE,CAAC,SAAS,oBAAoB,EACzE,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,eAAe,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAIlD;;;;;;;;;OASG;WACW,cAAc,CAC3B,IAAI,SAAS,SAAS,EAEtB,CAAC,SAAS,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,EAC7C,IAAI,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC,CAAC;IAI3D;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,SAAS,mBAAmB,EAC3D,MAAM,EAAE,OAAO,GACb,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC;CAGxC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACtD;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,cAAc,GAAG,GAAG,CAAC;AAEvE;;;GAGG;AACH,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,oBAAoB,IACrE,OAAO,SAAS,cAAc,GAC3B,SAAS,CAAC,OAAO,CAAC,GAClB,OAAO,SAAS,GAAG,GACnB,SAAS,CAAC,GAAG,CAAC,GACd,OAAO,CAAC;AAEZ;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,SAAS,oBAAoB,EACzE,MAAM,EAAE,OAAO,GACb,qBAAqB,CAAC,OAAO,CAAC,CAShC;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CACzB,OAAO,SAAS,mBAAmB,EACnC,QAAQ,SAAS,SAAS,IACvB,OAAO,SAAS,eAAe,GAChC,OAAO,GACP,eAAe,CAAC,QAAQ,EAAE,qBAAqB,CAAC,MAAM,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAE3F;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,SAAS,mBAAmB,EAAE,QAAQ,SAAS,SAAS,EAC7F,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,QAAQ,GACnB,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CASnC;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG,oBAAoB,CAAC"}