@fluidframework/tree 2.117.0 → 3.0.0

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

@@ -1 +1 @@
-{"version":3,"file":"schemaSummarizer.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/schemaSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AASjE,OAAO,EAGN,iBAAiB,GACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,mBAAmB,GAInB,MAAM,iCAAiC,CAAC;AAGzC,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAN,IAAkB,0BAajB;AAbD,WAAkB,0BAA0B;IAC3C;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,iFAAY,CAAA;AACb,CAAC,EAbiB,0BAA0B,KAA1B,0BAA0B,QAa3C;AAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAA6B;;;CAG7D,CAAC,CAAC;AAEH;;GAEG;AACH,SAAS,sCAAsC,CAC9C,OAAqC;IAErC,2EAA2E;IAC3E,6CAAqC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,gBACZ,SAAQ,mBAA+C;IAKvD,YACkB,MAA+B,EAChD,YAA0B,EACT,KAAmC,EACpD,mBAAiD;QAEjD,KAAK,CACJ,QAAQ,EACR,sCAAsC,CAAC,mBAAmB,CAAC,EAC3D,iBAAiB,EACjB,IAAI,CAAC,gCAAgC,CACrC,CAAC;QAVe,WAAM,GAAN,MAAM,CAAyB;QAE/B,UAAK,GAAL,KAAK,CAA8B;QASpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC/C,gFAAgF;YAChF,uGAAuG;YACvG,IAAI,CAAC,yBAAyB,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/D,CAAC,CAAC,CAAC;IACJ,CAAC;IAES,iBAAiB,CAAC,KAO3B;QACA,MAAM,EAAE,OAAO,EAAE,yBAAyB,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;QAClF,IACC,CAAC,QAAQ;YACT,yBAAyB,KAAK,SAAS;YACvC,IAAI,CAAC,yBAAyB,KAAK,SAAS;YAC5C,yBAAyB,CAAC,2BAA2B,IAAI,IAAI,CAAC,yBAAyB,EACtF,CAAC;YACF,OAAO,CAAC,SAAS,CAChB,eAAe,EACf,WAAW,CAAC,IAAI,EAChB,GAAG,yBAAyB,CAAC,WAAW,IAAI,eAAe,EAAE,CAC7D,CAAC;QACH,CAAC;aAAM,CAAC;YACP,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7D,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;IAES,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B;QAE3B,MAAM,YAAY,GAAoB,MAAM,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC/E,kEAAkE;QAClE,0EAA0E;QAC1E,iDAAiD;QACjD,MAAM,CACL,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAC9B,KAAK,CAAC,0EAA0E,CAChF,CAAC;QAEF,MAAM,YAAY,GAAG,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC1D,+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","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/internal\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport { SummaryType } from \"@fluidframework/driver-definitions\";\nimport type {\n\tIExperimentalIncrementalSummaryContext,\n\tITelemetryContext,\n\tOldestSupportedClientVersion,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport type { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport type { IJsonCodec } from \"../../codec/index.js\";\nimport {\n\ttype MutableTreeStoredSchema,\n\ttype TreeStoredSchema,\n\tschemaDataIsEmpty,\n} from \"../../core/index.js\";\nimport {\n\tVersionedSummarizer,\n\ttype Summarizable,\n\ttype SummaryElementParser,\n\ttype SummaryElementStringifier,\n} from \"../../shared-tree-core/index.js\";\nimport type { CollabWindow } from \"../incrementalSummarizationUtils.js\";\n\nexport const schemaStringKey = \"SchemaString\";\n\n/**\n * The versions for the schema summary format.\n */\nexport const enum SchemaSummaryFormatVersion {\n\t/**\n\t * This version represents summary format before summary versioning was introduced.\n\t */\n\tv1 = 1,\n\t/**\n\t * This version adds metadata to the summary. This is backward compatible with version 1.\n\t */\n\tv2 = 2,\n\t/**\n\t * The latest version of the summary. Must be updated when a new version is added.\n\t */\n\tvLatest = v2,\n}\n\nconst supportedVersions = new Set<SchemaSummaryFormatVersion>([\n\tSchemaSummaryFormatVersion.v1,\n\tSchemaSummaryFormatVersion.v2,\n]);\n\n/**\n * Returns the summary version to use as per the given minimum version for collab.\n */\nfunction minVersionToSchemaSummaryFormatVersion(\n\tversion: OldestSupportedClientVersion,\n): SchemaSummaryFormatVersion {\n\t// Currently, version 2 is written which adds metadata blob to the summary.\n\treturn SchemaSummaryFormatVersion.v2;\n}\n\n/**\n * Provides methods for summarizing and loading a schema repository.\n */\nexport class SchemaSummarizer\n\textends VersionedSummarizer<SchemaSummaryFormatVersion>\n\timplements Summarizable\n{\n\tprivate schemaIndexLastChangedSeq: number | undefined;\n\n\tpublic constructor(\n\t\tprivate readonly schema: MutableTreeStoredSchema,\n\t\tcollabWindow: CollabWindow,\n\t\tprivate readonly codec: IJsonCodec<TreeStoredSchema>,\n\t\tminVersionForCollab: OldestSupportedClientVersion,\n\t) {\n\t\tsuper(\n\t\t\t\"Schema\",\n\t\t\tminVersionToSchemaSummaryFormatVersion(minVersionForCollab),\n\t\t\tsupportedVersions,\n\t\t\ttrue /* supportPreVersioningFormat */,\n\t\t);\n\t\tthis.schema.events.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\tprotected summarizeInternal(props: {\n\t\tstringify: SummaryElementStringifier;\n\t\tfullTree?: boolean;\n\t\ttrackState?: boolean;\n\t\ttelemetryContext?: ITelemetryContext;\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext;\n\t\tbuilder: SummaryTreeBuilder;\n\t}): void {\n\t\tconst { builder, incrementalSummaryContext, stringify, fullTree = false } = props;\n\t\tif (\n\t\t\t!fullTree &&\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}/${schemaStringKey}`,\n\t\t\t);\n\t\t} else {\n\t\t\tconst dataString = stringify(this.codec.encode(this.schema));\n\t\t\tbuilder.addBlob(schemaStringKey, dataString);\n\t\t}\n\t}\n\n\tprotected async loadInternal(\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, \"utf8\");\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"]}
+{"version":3,"file":"schemaSummarizer.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-index/schemaSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AASjE,OAAO,EAGN,iBAAiB,GACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,mBAAmB,GAInB,MAAM,iCAAiC,CAAC;AAGzC,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAN,IAAkB,0BAajB;AAbD,WAAkB,0BAA0B;IAC3C;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,iFAAY,CAAA;AACb,CAAC,EAbiB,0BAA0B,KAA1B,0BAA0B,QAa3C;AAED,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAA6B;;;CAG7D,CAAC,CAAC;AAEH;;GAEG;AACH,SAAS,sCAAsC,CAC9C,OAAqC;IAErC,2EAA2E;IAC3E,6CAAqC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,gBACZ,SAAQ,mBAA+C;IAMrC;IAEA;IALV,yBAAyB,CAAqB;IAEtD,YACkB,MAA+B,EAChD,YAA0B,EACT,KAAmC,EACpD,mBAAiD;QAEjD,KAAK,CACJ,QAAQ,EACR,sCAAsC,CAAC,mBAAmB,CAAC,EAC3D,iBAAiB,EACjB,IAAI,CAAC,gCAAgC,CACrC,CAAC;QAVe,WAAM,GAAN,MAAM,CAAyB;QAE/B,UAAK,GAAL,KAAK,CAA8B;QASpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC/C,gFAAgF;YAChF,uGAAuG;YACvG,IAAI,CAAC,yBAAyB,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/D,CAAC,CAAC,CAAC;IACJ,CAAC;IAES,iBAAiB,CAAC,KAO3B;QACA,MAAM,EAAE,OAAO,EAAE,yBAAyB,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;QAClF,IACC,CAAC,QAAQ;YACT,yBAAyB,KAAK,SAAS;YACvC,IAAI,CAAC,yBAAyB,KAAK,SAAS;YAC5C,yBAAyB,CAAC,2BAA2B,IAAI,IAAI,CAAC,yBAAyB,EACtF,CAAC;YACF,OAAO,CAAC,SAAS,CAChB,eAAe,EACf,WAAW,CAAC,IAAI,EAChB,GAAG,yBAAyB,CAAC,WAAW,IAAI,eAAe,EAAE,CAC7D,CAAC;QACH,CAAC;aAAM,CAAC;YACP,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7D,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;IAES,KAAK,CAAC,YAAY,CAC3B,QAAgC,EAChC,KAA2B;QAE3B,MAAM,YAAY,GAAoB,MAAM,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC/E,kEAAkE;QAClE,0EAA0E;QAC1E,iDAAiD;QACjD,MAAM,CACL,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,EAC9B,KAAK,CAAC,0EAA0E,CAChF,CAAC;QAEF,MAAM,YAAY,GAAG,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC1D,+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","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/internal\";\nimport type { IChannelStorageService } from \"@fluidframework/datastore-definitions/internal\";\nimport { SummaryType } from \"@fluidframework/driver-definitions\";\nimport type {\n\tIExperimentalIncrementalSummaryContext,\n\tITelemetryContext,\n\tOldestSupportedClientVersion,\n} from \"@fluidframework/runtime-definitions/internal\";\nimport type { SummaryTreeBuilder } from \"@fluidframework/runtime-utils/internal\";\n\nimport type { IJsonCodec } from \"../../codec/index.js\";\nimport {\n\ttype MutableTreeStoredSchema,\n\ttype TreeStoredSchema,\n\tschemaDataIsEmpty,\n} from \"../../core/index.js\";\nimport {\n\tVersionedSummarizer,\n\ttype Summarizable,\n\ttype SummaryElementParser,\n\ttype SummaryElementStringifier,\n} from \"../../shared-tree-core/index.js\";\nimport type { CollabWindow } from \"../incrementalSummarizationUtils.js\";\n\nexport const schemaStringKey = \"SchemaString\";\n\n/**\n * The versions for the schema summary format.\n */\nexport const enum SchemaSummaryFormatVersion {\n\t/**\n\t * This version represents summary format before summary versioning was introduced.\n\t */\n\tv1 = 1,\n\t/**\n\t * This version adds metadata to the summary. This is backward compatible with version 1.\n\t */\n\tv2 = 2,\n\t/**\n\t * The latest version of the summary. Must be updated when a new version is added.\n\t */\n\tvLatest = v2,\n}\n\nconst supportedVersions = new Set<SchemaSummaryFormatVersion>([\n\tSchemaSummaryFormatVersion.v1,\n\tSchemaSummaryFormatVersion.v2,\n]);\n\n/**\n * Returns the summary version to use as per the given minimum version for collab.\n */\nfunction minVersionToSchemaSummaryFormatVersion(\n\tversion: OldestSupportedClientVersion,\n): SchemaSummaryFormatVersion {\n\t// Currently, version 2 is written which adds metadata blob to the summary.\n\treturn SchemaSummaryFormatVersion.v2;\n}\n\n/**\n * Provides methods for summarizing and loading a schema repository.\n */\nexport class SchemaSummarizer\n\textends VersionedSummarizer<SchemaSummaryFormatVersion>\n\timplements Summarizable\n{\n\tprivate schemaIndexLastChangedSeq: number | undefined;\n\n\tpublic constructor(\n\t\tprivate readonly schema: MutableTreeStoredSchema,\n\t\tcollabWindow: CollabWindow,\n\t\tprivate readonly codec: IJsonCodec<TreeStoredSchema>,\n\t\tminVersionForCollab: OldestSupportedClientVersion,\n\t) {\n\t\tsuper(\n\t\t\t\"Schema\",\n\t\t\tminVersionToSchemaSummaryFormatVersion(minVersionForCollab),\n\t\t\tsupportedVersions,\n\t\t\ttrue /* supportPreVersioningFormat */,\n\t\t);\n\t\tthis.schema.events.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\tprotected summarizeInternal(props: {\n\t\tstringify: SummaryElementStringifier;\n\t\tfullTree?: boolean;\n\t\ttrackState?: boolean;\n\t\ttelemetryContext?: ITelemetryContext;\n\t\tincrementalSummaryContext?: IExperimentalIncrementalSummaryContext;\n\t\tbuilder: SummaryTreeBuilder;\n\t}): void {\n\t\tconst { builder, incrementalSummaryContext, stringify, fullTree = false } = props;\n\t\tif (\n\t\t\t!fullTree &&\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}/${schemaStringKey}`,\n\t\t\t);\n\t\t} else {\n\t\t\tconst dataString = stringify(this.codec.encode(this.schema));\n\t\t\tbuilder.addBlob(schemaStringKey, dataString);\n\t\t}\n\t}\n\n\tprotected async loadInternal(\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, \"utf8\");\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"]}

package/lib/feature-libraries/schemaChecker.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+import type { ITelemetryBaseProperties } from "@fluidframework/core-interfaces";
 import { type TreeFieldStoredSchema, Multiplicity, type SchemaAndPolicy } from "../core/index.js";
 import type { MapTreeFieldViewGeneric, MinimalMapTreeNodeView } from "./mapTreeCursor.js";
 export declare enum SchemaValidationError {
@@ -17,28 +18,17 @@ export declare enum SchemaValidationError {
     Node_MissingSchema = 9
 }
 /**
- * Additional context about a schema validation error.
- * @remarks
- * Not all fields are populated for every error type — only those relevant to the specific error.
+ * Information about a schema validation error.
  */
-export interface SchemaValidationErrorContext {
-    /**
-     * The type identifier of the node that failed validation.
-     */
-    readonly nodeType?: string;
-    /**
-     * The set of type identifiers allowed in the field, if applicable.
-     */
-    readonly allowedTypes?: ReadonlySet<string>;
-    /**
-     * Field keys on the node that were not recognized by its schema.
-     */
-    readonly unexpectedFields?: ReadonlySet<string>;
+export interface SchemaValidationErrorDetails {
+    readonly error: SchemaValidationError;
+    readonly path: readonly (string | number)[];
+    readonly telemetryProperties?: ITelemetryBaseProperties;
 }
 /**
  * Throws a UsageError indicating a tree is out of schema.
  */
-export declare function throwOutOfSchema(maybeError: SchemaValidationError, context?: SchemaValidationErrorContext): never;
+export declare function throwOutOfSchema(details: SchemaValidationErrorDetails): never;
 type NotUndefined = number | string | boolean | bigint | symbol | object;
 /**
  * Deeply checks that the provided node complies with the schema based on its identifier.
@@ -47,7 +37,7 @@ type NotUndefined = number | string | boolean | bigint | symbol | object;
  *
  * @returns the return value from `onError` if the node or anything inside of it is out of schema, otherwise `undefined`.
  */
-export declare function isNodeInSchema<T extends NotUndefined>(node: MinimalMapTreeNodeView, schemaAndPolicy: SchemaAndPolicy, onError: (error: SchemaValidationError, context?: SchemaValidationErrorContext) => T): T | undefined;
+export declare function isNodeInSchema<T extends NotUndefined>(node: MinimalMapTreeNodeView, schemaAndPolicy: SchemaAndPolicy, onError: (details: SchemaValidationErrorDetails) => T): T | undefined;
 /**
  * Deeply checks that the nodes comply with the field schema and included schema.
  *
@@ -55,7 +45,7 @@ export declare function isNodeInSchema<T extends NotUndefined>(node: MinimalMapT
  *
  * @returns the return value from `onError` if the field or anything inside of it is out of schema, otherwise `undefined`.
  */
-export declare function isFieldInSchema<T extends NotUndefined>(childNodes: MapTreeFieldViewGeneric<MinimalMapTreeNodeView>, schema: TreeFieldStoredSchema, schemaAndPolicy: SchemaAndPolicy, onError: (error: SchemaValidationError, context?: SchemaValidationErrorContext) => T): T | undefined;
+export declare function isFieldInSchema<T extends NotUndefined>(childNodes: MapTreeFieldViewGeneric<MinimalMapTreeNodeView>, schema: TreeFieldStoredSchema, schemaAndPolicy: SchemaAndPolicy, onError: (details: SchemaValidationErrorDetails) => T): T | undefined;
 /**
  * Validates that a given number of items complies with the specified {@link Multiplicity | multiplicity}.
  * @param numberOfItems - Number of items.

package/lib/feature-libraries/schemaChecker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schemaChecker.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/schemaChecker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,KAAK,qBAAqB,EAI1B,YAAY,EACZ,KAAK,eAAe,EACpB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG1F,oBAAY,qBAAqB;IAChC,2BAA2B,IAAA;IAC3B,0BAA0B,IAAA;IAC1B,gCAAgC,IAAA;IAChC,2BAA2B,IAAA;IAC3B,wBAAwB,IAAA;IACxB,qBAAqB,IAAA;IACrB,yBAAyB,IAAA;IACzB,2BAA2B,IAAA;IAC3B,2BAA2B,IAAA;IAC3B,kBAAkB,IAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC5C;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC/B,UAAU,EAAE,qBAAqB,EACjC,OAAO,CAAC,EAAE,4BAA4B,GACpC,KAAK,CAEP;AAkDD,KAAK,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzE;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,EACpD,IAAI,EAAE,sBAAsB,EAC5B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,4BAA4B,KAAK,CAAC,GAClF,CAAC,GAAG,SAAS,CAkEf;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,YAAY,EACrD,UAAU,EAAE,uBAAuB,CAAC,sBAAsB,CAAC,EAC3D,MAAM,EAAE,qBAAqB,EAC7B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,4BAA4B,KAAK,CAAC,GAClF,CAAC,GAAG,SAAS,CAgCf;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACvC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,YAAY,GACxB,qBAAqB,GAAG,SAAS,CA4BnC"}
+{"version":3,"file":"schemaChecker.d.ts","sourceRoot":"","sources":["../../src/feature-libraries/schemaChecker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,KAAK,EACX,wBAAwB,EAExB,MAAM,iCAAiC,CAAC;AAGzC,OAAO,EACN,KAAK,qBAAqB,EAI1B,YAAY,EACZ,KAAK,eAAe,EAEpB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAG1F,oBAAY,qBAAqB;IAChC,2BAA2B,IAAA;IAC3B,0BAA0B,IAAA;IAC1B,gCAAgC,IAAA;IAChC,2BAA2B,IAAA;IAC3B,wBAAwB,IAAA;IACxB,qBAAqB,IAAA;IACrB,yBAAyB,IAAA;IACzB,2BAA2B,IAAA;IAC3B,2BAA2B,IAAA;IAC3B,kBAAkB,IAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,QAAQ,CAAC,KAAK,EAAE,qBAAqB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC5C,QAAQ,CAAC,mBAAmB,CAAC,EAAE,wBAAwB,CAAC;CACxD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,4BAA4B,GAAG,KAAK,CAY7E;AA4GD,KAAK,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAEzE;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,EACpD,IAAI,EAAE,sBAAsB,EAC5B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,CAAC,OAAO,EAAE,4BAA4B,KAAK,CAAC,GACnD,CAAC,GAAG,SAAS,CA8Ff;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,YAAY,EACrD,UAAU,EAAE,uBAAuB,CAAC,sBAAsB,CAAC,EAC3D,MAAM,EAAE,qBAAqB,EAC7B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,CAAC,OAAO,EAAE,4BAA4B,KAAK,CAAC,GACnD,CAAC,GAAG,SAAS,CAyDf;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACvC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,YAAY,GACxB,qBAAqB,GAAG,SAAS,CA4BnC"}

package/lib/feature-libraries/schemaChecker.js

@@ -2,9 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { unreachableCase, fail } from "@fluidframework/core-utils/internal";
-import { UsageError } from "@fluidframework/telemetry-utils/internal";
-import { LeafNodeStoredSchema, ObjectNodeStoredSchema, MapNodeStoredSchema, Multiplicity, } from "../core/index.js";
+import { appendDebugMessage, unreachableCase, fail, } from "@fluidframework/core-utils/internal";
+import { tagSchemaArtifacts, UsageError } from "@fluidframework/telemetry-utils/internal";
+import { LeafNodeStoredSchema, ObjectNodeStoredSchema, MapNodeStoredSchema, Multiplicity, ValueSchema, } from "../core/index.js";
 import { iterableHasSome, mapIterable } from "../util/index.js";
 import { allowsValue } from "./valueUtilities.js";
 export var SchemaValidationError;
@@ -23,44 +23,107 @@ export var SchemaValidationError;
 /**
  * Throws a UsageError indicating a tree is out of schema.
  */
-export function throwOutOfSchema(maybeError, context) {
-    throw new UsageError(formatSchemaValidationError(maybeError, context));
+export function throwOutOfSchema(details) {
+    const message = `Tree does not conform to schema. ${getSchemaValidationErrorMessage(details.error)}`;
+    throw new UsageError(appendDebugMessage(message, () => getSchemaValidationDebugMessage(details)), {
+        ...tagSchemaArtifacts({
+            schemaValidationError: SchemaValidationError[details.error],
+            schemaValidationPath: JSON.stringify(details.path),
+        }),
+        ...details.telemetryProperties,
+    });
 }
-// Not exported: internal helper used by throwOutOfSchema.
-function formatSchemaValidationError(error, context) {
-    switch (error) {
+function getTelemetryProperty(details, key) {
+    const property = details.telemetryProperties?.[key];
+    return typeof property === "object" ? property.value : property;
+}
+function getSchemaValidationDebugMessage(details) {
+    const path = details.path.length === 0 ? "" : ` at path ${JSON.stringify(details.path)}`;
+    const nodeType = getTelemetryProperty(details, "nodeType");
+    const fieldKind = getTelemetryProperty(details, "fieldKind");
+    const childCount = getTelemetryProperty(details, "childCount");
+    switch (details.error) {
+        case SchemaValidationError.Field_KindNotInSchemaPolicy: {
+            return `Field kind ${JSON.stringify(fieldKind)} is not supported by the schema policy${path}.`;
+        }
+        case SchemaValidationError.Field_MissingRequiredChild: {
+            return `A required field of kind ${JSON.stringify(fieldKind)} must contain exactly one child, but found ${childCount}${path}.`;
+        }
+        case SchemaValidationError.Field_MultipleChildrenNotAllowed: {
+            return `A field of kind ${JSON.stringify(fieldKind)} allows at most one child, but found ${childCount}${path}.`;
+        }
+        case SchemaValidationError.Field_ChildInForbiddenField: {
+            return `A forbidden field of kind ${JSON.stringify(fieldKind)} must be empty, but found ${childCount} ${childCount === 1 ? "child" : "children"}${path}.`;
+        }
         case SchemaValidationError.Field_NodeTypeNotAllowed: {
-            const nodeDesc = context?.nodeType === undefined ? "unknown" : `"${context.nodeType}"`;
-            const allowedDesc = context?.allowedTypes === undefined
-                ? "unknown"
-                : `[${[...context.allowedTypes].map((t) => `"${t}"`).join(", ")}]`;
-            return (`Tree does not conform to schema. ` +
-                `A node of type ${nodeDesc} is not allowed in this field. Allowed types: ${allowedDesc}. ` +
-                `If using a staged allowed type, the stored schema has not been upgraded to include this type yet. ` +
-                `Either upgrade the schema to enable the staged type or avoid inserting content of this type until the schema is upgraded.`);
+            return `A node of type ${JSON.stringify(nodeType)} is not allowed in this field${path}. Allowed types: ${getTelemetryProperty(details, "allowedTypes")}. If using a staged allowed type, upgrade the stored schema before inserting this content.`;
+        }
+        case SchemaValidationError.LeafNode_InvalidValue: {
+            return `Leaf node ${JSON.stringify(nodeType)} requires a value matching ${JSON.stringify(getTelemetryProperty(details, "expectedValueType"))}, but found ${JSON.stringify(getTelemetryProperty(details, "actualValueType"))}${path}.`;
+        }
+        case SchemaValidationError.LeafNode_FieldsNotAllowed: {
+            return `Leaf node ${JSON.stringify(nodeType)} must not contain fields${path}. Unexpected fields: ${getTelemetryProperty(details, "unexpectedFields")}.`;
+        }
+        case SchemaValidationError.ObjectNode_FieldNotInSchema: {
+            return `A node of type ${JSON.stringify(nodeType)} has fields not defined in its schema${path}. Unexpected fields: ${getTelemetryProperty(details, "unexpectedFields")}.`;
+        }
+        case SchemaValidationError.NonLeafNode_ValueNotAllowed: {
+            return `Non-leaf node ${JSON.stringify(nodeType)} must not have a value, but found ${JSON.stringify(getTelemetryProperty(details, "actualValueType"))}${path}.`;
         }
         case SchemaValidationError.Node_MissingSchema: {
-            const nodeDesc = context?.nodeType === undefined ? "unknown" : `"${context.nodeType}"`;
-            return (`Tree does not conform to schema. ` +
-                `No schema definition was found for node type ${nodeDesc}. ` +
-                `Ensure the node's type is included in the schema and that the stored schema has been upgraded if needed.`);
+            return `No schema definition was found for node type ${JSON.stringify(nodeType)}${path}. Ensure the node's type is included in the schema and that the stored schema has been upgraded if needed.`;
+        }
+        default: {
+            return unreachableCase(details.error);
+        }
+    }
+}
+function getSchemaValidationErrorMessage(error) {
+    switch (error) {
+        case SchemaValidationError.Field_KindNotInSchemaPolicy: {
+            return "The field kind is not supported by the schema policy.";
+        }
+        case SchemaValidationError.Field_MissingRequiredChild: {
+            return "A required field is missing its child.";
+        }
+        case SchemaValidationError.Field_MultipleChildrenNotAllowed: {
+            return "A field contains more children than its kind allows.";
+        }
+        case SchemaValidationError.Field_ChildInForbiddenField: {
+            return "A forbidden field contains children.";
+        }
+        case SchemaValidationError.Field_NodeTypeNotAllowed: {
+            return "A node type is not allowed in its field.";
+        }
+        case SchemaValidationError.LeafNode_InvalidValue: {
+            return "A leaf node value does not match its schema.";
+        }
+        case SchemaValidationError.LeafNode_FieldsNotAllowed: {
+            return "A leaf node contains fields.";
         }
         case SchemaValidationError.ObjectNode_FieldNotInSchema: {
-            const nodeDesc = context?.nodeType === undefined ? "unknown" : `"${context.nodeType}"`;
-            const fieldsDesc = context?.unexpectedFields === undefined || context.unexpectedFields.size === 0
-                ? undefined
-                : `[${[...context.unexpectedFields].map((f) => `"${f}"`).join(", ")}]`;
-            const fieldsPart = fieldsDesc === undefined
-                ? "The node has fields that are not defined in its schema."
-                : `Unexpected fields: ${fieldsDesc}.`;
-            return (`Tree does not conform to schema. ` +
-                `A node of type ${nodeDesc} has fields not defined in its schema. ${fieldsPart}`);
+            return "An object node contains fields not defined in its schema.";
+        }
+        case SchemaValidationError.NonLeafNode_ValueNotAllowed: {
+            return "A non-leaf node contains a value.";
+        }
+        case SchemaValidationError.Node_MissingSchema: {
+            return "The node type has no schema definition.";
         }
         default: {
-            return `Tree does not conform to schema: ${SchemaValidationError[error]}.`;
+            return unreachableCase(error);
         }
     }
 }
+function schemaValidationError(error, telemetryProperties) {
+    return { error, path: [], telemetryProperties };
+}
+function prependPath(onError, segment) {
+    return (details) => onError({ ...details, path: [segment, ...details.path] });
+}
+function getValueType(value) {
+    return value === null ? "null" : typeof value;
+}
 /**
  * Deeply checks that the provided node complies with the schema based on its identifier.
  *
@@ -72,28 +135,41 @@ export function isNodeInSchema(node, schemaAndPolicy, onError) {
     // Validate the schema declared by the node exists
     const schema = schemaAndPolicy.schema.nodeSchema.get(node.type);
     if (schema === undefined) {
-        return onError(SchemaValidationError.Node_MissingSchema, {
-            nodeType: node.type,
-        });
+        return onError(schemaValidationError(SchemaValidationError.Node_MissingSchema, tagSchemaArtifacts({ nodeType: node.type })));
     }
     // Validate the node is well formed according to its schema
     if (schema instanceof LeafNodeStoredSchema) {
         if (iterableHasSome(node.fields)) {
-            return onError(SchemaValidationError.LeafNode_FieldsNotAllowed);
+            const unexpectedFields = [...mapIterable(node.fields, ([key]) => key)].sort();
+            return onError(schemaValidationError(SchemaValidationError.LeafNode_FieldsNotAllowed, {
+                ...tagSchemaArtifacts({
+                    nodeType: node.type,
+                    unexpectedFields: JSON.stringify(unexpectedFields),
+                }),
+            }));
         }
         if (!allowsValue(schema.leafValue, node.value)) {
-            return onError(SchemaValidationError.LeafNode_InvalidValue);
+            return onError(schemaValidationError(SchemaValidationError.LeafNode_InvalidValue, {
+                ...tagSchemaArtifacts({
+                    nodeType: node.type,
+                    expectedValueType: ValueSchema[schema.leafValue],
+                }),
+                actualValueType: getValueType(node.value),
+            }));
         }
     }
     else {
         if (node.value !== undefined) {
-            return onError(SchemaValidationError.NonLeafNode_ValueNotAllowed);
+            return onError(schemaValidationError(SchemaValidationError.NonLeafNode_ValueNotAllowed, {
+                ...tagSchemaArtifacts({ nodeType: node.type }),
+                actualValueType: getValueType(node.value),
+            }));
         }
         if (schema instanceof ObjectNodeStoredSchema) {
             const uncheckedFieldsFromNode = new Set(mapIterable(node.fields, ([key, field]) => key));
             for (const [fieldKey, fieldSchema] of schema.objectNodeFields) {
                 const nodeField = node.fields.get(fieldKey) ?? [];
-                const fieldInSchemaResult = isFieldInSchema(nodeField, fieldSchema, schemaAndPolicy, onError);
+                const fieldInSchemaResult = isFieldInSchema(nodeField, fieldSchema, schemaAndPolicy, prependPath(onError, fieldKey));
                 if (fieldInSchemaResult !== undefined) {
                     return fieldInSchemaResult;
                 }
@@ -104,15 +180,17 @@ export function isNodeInSchema(node, schemaAndPolicy, onError) {
             // Code using this with a stored schema derived from a view schema rather than the document can be problematic because it may be missing unknown fields that the actual document has.
             // Other schema evolution features like "staged" allowed types will likely cause similar issues elsewhere in this checker.
             if (uncheckedFieldsFromNode.size > 0) {
-                return onError(SchemaValidationError.ObjectNode_FieldNotInSchema, {
-                    nodeType: node.type,
-                    unexpectedFields: uncheckedFieldsFromNode,
-                });
+                return onError(schemaValidationError(SchemaValidationError.ObjectNode_FieldNotInSchema, {
+                    ...tagSchemaArtifacts({
+                        nodeType: node.type,
+                        unexpectedFields: JSON.stringify([...uncheckedFieldsFromNode].sort()),
+                    }),
+                }));
             }
         }
         else if (schema instanceof MapNodeStoredSchema) {
-            for (const [_key, field] of node.fields) {
-                const fieldInSchemaResult = isFieldInSchema(field, schema.mapFields, schemaAndPolicy, onError);
+            for (const [key, field] of node.fields) {
+                const fieldInSchemaResult = isFieldInSchema(field, schema.mapFields, schemaAndPolicy, prependPath(onError, key));
                 if (fieldInSchemaResult !== undefined) {
                     return fieldInSchemaResult;
                 }
@@ -135,28 +213,34 @@ export function isFieldInSchema(childNodes, schema, schemaAndPolicy, onError) {
     // Validate that the field kind is handled by the schema policy
     const kind = schemaAndPolicy.policy.fieldKinds.get(schema.kind);
     if (kind === undefined) {
-        return onError(SchemaValidationError.Field_KindNotInSchemaPolicy);
+        return onError(schemaValidationError(SchemaValidationError.Field_KindNotInSchemaPolicy, tagSchemaArtifacts({ fieldKind: schema.kind })));
     }
     // Validate that the field doesn't contain more nodes than its type supports
     {
         const multiplicityCheck = compliesWithMultiplicity(childNodes.length, kind.multiplicity);
         if (multiplicityCheck !== undefined) {
-            return onError(multiplicityCheck);
+            return onError(schemaValidationError(multiplicityCheck, {
+                ...tagSchemaArtifacts({ fieldKind: schema.kind }),
+                childCount: childNodes.length,
+            }));
         }
     }
+    let index = 0;
     for (const node of childNodes) {
         // Validate the type declared by the node is allowed in this field
         if (schema.types !== undefined && !schema.types.has(node.type)) {
-            return onError(SchemaValidationError.Field_NodeTypeNotAllowed, {
+            const allowedTypes = [...schema.types].sort();
+            return prependPath(onError, index)(schemaValidationError(SchemaValidationError.Field_NodeTypeNotAllowed, tagSchemaArtifacts({
                 nodeType: node.type,
-                allowedTypes: schema.types,
-            });
+                allowedTypes: JSON.stringify(allowedTypes),
+            })));
         }
         // Validate the node complies with the type it declares to be.
-        const nodeInSchemaResult = isNodeInSchema(node, schemaAndPolicy, onError);
+        const nodeInSchemaResult = isNodeInSchema(node, schemaAndPolicy, prependPath(onError, index));
         if (nodeInSchemaResult !== undefined) {
             return nodeInSchemaResult;
         }
+        index += 1;
     }
     return undefined;
 }

package/lib/feature-libraries/schemaChecker.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemaChecker.js","sourceRoot":"","sources":["../../src/feature-libraries/schemaChecker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEtE,OAAO,EAEN,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,YAAY,GAEZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,MAAM,CAAN,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAChC,+GAA2B,CAAA;IAC3B,6GAA0B,CAAA;IAC1B,yHAAgC,CAAA;IAChC,+GAA2B,CAAA;IAC3B,yGAAwB,CAAA;IACxB,mGAAqB,CAAA;IACrB,2GAAyB,CAAA;IACzB,+GAA2B,CAAA;IAC3B,+GAA2B,CAAA;IAC3B,6FAAkB,CAAA;AACnB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,QAWhC;AAsBD;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC/B,UAAiC,EACjC,OAAsC;IAEtC,MAAM,IAAI,UAAU,CAAC,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,0DAA0D;AAC1D,SAAS,2BAA2B,CACnC,KAA4B,EAC5B,OAAiD;IAEjD,QAAQ,KAAK,EAAE,CAAC;QACf,KAAK,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,CAAC;YACvF,MAAM,WAAW,GAChB,OAAO,EAAE,YAAY,KAAK,SAAS;gBAClC,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YACrE,OAAO,CACN,mCAAmC;gBACnC,kBAAkB,QAAQ,iDAAiD,WAAW,IAAI;gBAC1F,oGAAoG;gBACpG,2HAA2H,CAC3H,CAAC;QACH,CAAC;QACD,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC;YAC/C,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,CAAC;YACvF,OAAO,CACN,mCAAmC;gBACnC,gDAAgD,QAAQ,IAAI;gBAC5D,0GAA0G,CAC1G,CAAC;QACH,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,GAAG,CAAC;YACvF,MAAM,UAAU,GACf,OAAO,EAAE,gBAAgB,KAAK,SAAS,IAAI,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,CAAC;gBAC7E,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;YACzE,MAAM,UAAU,GACf,UAAU,KAAK,SAAS;gBACvB,CAAC,CAAC,yDAAyD;gBAC3D,CAAC,CAAC,sBAAsB,UAAU,GAAG,CAAC;YACxC,OAAO,CACN,mCAAmC;gBACnC,kBAAkB,QAAQ,0CAA0C,UAAU,EAAE,CAChF,CAAC;QACH,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,OAAO,oCAAoC,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC;QAC5E,CAAC;IACF,CAAC;AACF,CAAC;AAID;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC7B,IAA4B,EAC5B,eAAgC,EAChC,OAAoF;IAEpF,kDAAkD;IAClD,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,OAAO,CAAC,qBAAqB,CAAC,kBAAkB,EAAE;YACxD,QAAQ,EAAE,IAAI,CAAC,IAAI;SACnB,CAAC,CAAC;IACJ,CAAC;IAED,2DAA2D;IAE3D,IAAI,MAAM,YAAY,oBAAoB,EAAE,CAAC;QAC5C,IAAI,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,OAAO,OAAO,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;QAC7D,CAAC;IACF,CAAC;SAAM,CAAC;QACP,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,MAAM,YAAY,sBAAsB,EAAE,CAAC;YAC9C,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACzF,KAAK,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClD,MAAM,mBAAmB,GAAG,eAAe,CAC1C,SAAS,EACT,WAAW,EACX,eAAe,EACf,OAAO,CACP,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,mBAAmB,CAAC;gBAC5B,CAAC;gBACD,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YACD,4GAA4G;YAC5G,yIAAyI;YACzI,qLAAqL;YACrL,0HAA0H;YAC1H,IAAI,uBAAuB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACtC,OAAO,OAAO,CAAC,qBAAqB,CAAC,2BAA2B,EAAE;oBACjE,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,gBAAgB,EAAE,uBAAuB;iBACzC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;aAAM,IAAI,MAAM,YAAY,mBAAmB,EAAE,CAAC;YAClD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACzC,MAAM,mBAAmB,GAAG,eAAe,CAC1C,KAAK,EACL,MAAM,CAAC,SAAS,EAChB,eAAe,EACf,OAAO,CACP,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,mBAAmB,CAAC;gBAC5B,CAAC;YACF,CAAC;QACF,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACrD,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC9B,UAA2D,EAC3D,MAA6B,EAC7B,eAAgC,EAChC,OAAoF;IAEpF,+DAA+D;IAC/D,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC,qBAAqB,CAAC,2BAA2B,CAAC,CAAC;IACnE,CAAC;IAED,4EAA4E;IAC5E,CAAC;QACA,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzF,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC/B,kEAAkE;QAClE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChE,OAAO,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,EAAE;gBAC9D,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,YAAY,EAAE,MAAM,CAAC,KAAK;aAC1B,CAAC,CAAC;QACJ,CAAC;QAED,8DAA8D;QAC9D,MAAM,kBAAkB,GAAG,cAAc,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAC1E,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,kBAAkB,CAAC;QAC3B,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACvC,aAAqB,EACrB,YAA0B;IAE1B,QAAQ,YAAY,EAAE,CAAC;QACtB,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YAC1B,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,qBAAqB,CAAC,0BAA0B,CAAC;YACzD,CAAC;iBAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC9B,OAAO,qBAAqB,CAAC,gCAAgC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YAClB,CAAC;QACF,CAAC;QACD,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5B,OAAO,aAAa,GAAG,CAAC;gBACvB,CAAC,CAAC,qBAAqB,CAAC,gCAAgC;gBACxD,CAAC,CAAC,SAAS,CAAC;QACd,CAAC;QACD,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5B,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;YAC7B,OAAO,aAAa,KAAK,CAAC;gBACzB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,qBAAqB,CAAC,2BAA2B,CAAC;QACtD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,eAAe,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC;IACF,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { unreachableCase, fail } from \"@fluidframework/core-utils/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\ttype TreeFieldStoredSchema,\n\tLeafNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tMultiplicity,\n\ttype SchemaAndPolicy,\n} from \"../core/index.js\";\nimport { iterableHasSome, mapIterable } from \"../util/index.js\";\n\nimport type { MapTreeFieldViewGeneric, MinimalMapTreeNodeView } from \"./mapTreeCursor.js\";\nimport { allowsValue } from \"./valueUtilities.js\";\n\nexport enum SchemaValidationError {\n\tField_KindNotInSchemaPolicy,\n\tField_MissingRequiredChild,\n\tField_MultipleChildrenNotAllowed,\n\tField_ChildInForbiddenField,\n\tField_NodeTypeNotAllowed,\n\tLeafNode_InvalidValue,\n\tLeafNode_FieldsNotAllowed,\n\tObjectNode_FieldNotInSchema,\n\tNonLeafNode_ValueNotAllowed,\n\tNode_MissingSchema,\n}\n\n/**\n * Additional context about a schema validation error.\n * @remarks\n * Not all fields are populated for every error type — only those relevant to the specific error.\n */\nexport interface SchemaValidationErrorContext {\n\t/**\n\t * The type identifier of the node that failed validation.\n\t */\n\treadonly nodeType?: string;\n\t/**\n\t * The set of type identifiers allowed in the field, if applicable.\n\t */\n\treadonly allowedTypes?: ReadonlySet<string>;\n\t/**\n\t * Field keys on the node that were not recognized by its schema.\n\t */\n\treadonly unexpectedFields?: ReadonlySet<string>;\n}\n\n/**\n * Throws a UsageError indicating a tree is out of schema.\n */\nexport function throwOutOfSchema(\n\tmaybeError: SchemaValidationError,\n\tcontext?: SchemaValidationErrorContext,\n): never {\n\tthrow new UsageError(formatSchemaValidationError(maybeError, context));\n}\n\n// Not exported: internal helper used by throwOutOfSchema.\nfunction formatSchemaValidationError(\n\terror: SchemaValidationError,\n\tcontext: SchemaValidationErrorContext | undefined,\n): string {\n\tswitch (error) {\n\t\tcase SchemaValidationError.Field_NodeTypeNotAllowed: {\n\t\t\tconst nodeDesc = context?.nodeType === undefined ? \"unknown\" : `\"${context.nodeType}\"`;\n\t\t\tconst allowedDesc =\n\t\t\t\tcontext?.allowedTypes === undefined\n\t\t\t\t\t? \"unknown\"\n\t\t\t\t\t: `[${[...context.allowedTypes].map((t) => `\"${t}\"`).join(\", \")}]`;\n\t\t\treturn (\n\t\t\t\t`Tree does not conform to schema. ` +\n\t\t\t\t`A node of type ${nodeDesc} is not allowed in this field. Allowed types: ${allowedDesc}. ` +\n\t\t\t\t`If using a staged allowed type, the stored schema has not been upgraded to include this type yet. ` +\n\t\t\t\t`Either upgrade the schema to enable the staged type or avoid inserting content of this type until the schema is upgraded.`\n\t\t\t);\n\t\t}\n\t\tcase SchemaValidationError.Node_MissingSchema: {\n\t\t\tconst nodeDesc = context?.nodeType === undefined ? \"unknown\" : `\"${context.nodeType}\"`;\n\t\t\treturn (\n\t\t\t\t`Tree does not conform to schema. ` +\n\t\t\t\t`No schema definition was found for node type ${nodeDesc}. ` +\n\t\t\t\t`Ensure the node's type is included in the schema and that the stored schema has been upgraded if needed.`\n\t\t\t);\n\t\t}\n\t\tcase SchemaValidationError.ObjectNode_FieldNotInSchema: {\n\t\t\tconst nodeDesc = context?.nodeType === undefined ? \"unknown\" : `\"${context.nodeType}\"`;\n\t\t\tconst fieldsDesc =\n\t\t\t\tcontext?.unexpectedFields === undefined || context.unexpectedFields.size === 0\n\t\t\t\t\t? undefined\n\t\t\t\t\t: `[${[...context.unexpectedFields].map((f) => `\"${f}\"`).join(\", \")}]`;\n\t\t\tconst fieldsPart =\n\t\t\t\tfieldsDesc === undefined\n\t\t\t\t\t? \"The node has fields that are not defined in its schema.\"\n\t\t\t\t\t: `Unexpected fields: ${fieldsDesc}.`;\n\t\t\treturn (\n\t\t\t\t`Tree does not conform to schema. ` +\n\t\t\t\t`A node of type ${nodeDesc} has fields not defined in its schema. ${fieldsPart}`\n\t\t\t);\n\t\t}\n\t\tdefault: {\n\t\t\treturn `Tree does not conform to schema: ${SchemaValidationError[error]}.`;\n\t\t}\n\t}\n}\n\ntype NotUndefined = number | string | boolean | bigint | symbol | object;\n\n/**\n * Deeply checks that the provided node complies with the schema based on its identifier.\n *\n * @param onError - Called with the first error (if any).\n *\n * @returns the return value from `onError` if the node or anything inside of it is out of schema, otherwise `undefined`.\n */\nexport function isNodeInSchema<T extends NotUndefined>(\n\tnode: MinimalMapTreeNodeView,\n\tschemaAndPolicy: SchemaAndPolicy,\n\tonError: (error: SchemaValidationError, context?: SchemaValidationErrorContext) => T,\n): T | undefined {\n\t// Validate the schema declared by the node exists\n\tconst schema = schemaAndPolicy.schema.nodeSchema.get(node.type);\n\tif (schema === undefined) {\n\t\treturn onError(SchemaValidationError.Node_MissingSchema, {\n\t\t\tnodeType: node.type,\n\t\t});\n\t}\n\n\t// Validate the node is well formed according to its schema\n\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\tif (iterableHasSome(node.fields)) {\n\t\t\treturn onError(SchemaValidationError.LeafNode_FieldsNotAllowed);\n\t\t}\n\t\tif (!allowsValue(schema.leafValue, node.value)) {\n\t\t\treturn onError(SchemaValidationError.LeafNode_InvalidValue);\n\t\t}\n\t} else {\n\t\tif (node.value !== undefined) {\n\t\t\treturn onError(SchemaValidationError.NonLeafNode_ValueNotAllowed);\n\t\t}\n\n\t\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\t\tconst uncheckedFieldsFromNode = new Set(mapIterable(node.fields, ([key, field]) => key));\n\t\t\tfor (const [fieldKey, fieldSchema] of schema.objectNodeFields) {\n\t\t\t\tconst nodeField = node.fields.get(fieldKey) ?? [];\n\t\t\t\tconst fieldInSchemaResult = isFieldInSchema(\n\t\t\t\t\tnodeField,\n\t\t\t\t\tfieldSchema,\n\t\t\t\t\tschemaAndPolicy,\n\t\t\t\t\tonError,\n\t\t\t\t);\n\t\t\t\tif (fieldInSchemaResult !== undefined) {\n\t\t\t\t\treturn fieldInSchemaResult;\n\t\t\t\t}\n\t\t\t\tuncheckedFieldsFromNode.delete(fieldKey);\n\t\t\t}\n\t\t\t// The node has fields that we did not check as part of looking at every field defined in the node's schema.\n\t\t\t// Since this is testing compatibility with a stored schema (not view schema), \"allowUnknownOptionalFields\" does not exist at this layer.\n\t\t\t// Code using this with a stored schema derived from a view schema rather than the document can be problematic because it may be missing unknown fields that the actual document has.\n\t\t\t// Other schema evolution features like \"staged\" allowed types will likely cause similar issues elsewhere in this checker.\n\t\t\tif (uncheckedFieldsFromNode.size > 0) {\n\t\t\t\treturn onError(SchemaValidationError.ObjectNode_FieldNotInSchema, {\n\t\t\t\t\tnodeType: node.type,\n\t\t\t\t\tunexpectedFields: uncheckedFieldsFromNode,\n\t\t\t\t});\n\t\t\t}\n\t\t} else if (schema instanceof MapNodeStoredSchema) {\n\t\t\tfor (const [_key, field] of node.fields) {\n\t\t\t\tconst fieldInSchemaResult = isFieldInSchema(\n\t\t\t\t\tfield,\n\t\t\t\t\tschema.mapFields,\n\t\t\t\t\tschemaAndPolicy,\n\t\t\t\t\tonError,\n\t\t\t\t);\n\t\t\t\tif (fieldInSchemaResult !== undefined) {\n\t\t\t\t\treturn fieldInSchemaResult;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfail(0xb0e /* Unknown TreeNodeStoredSchema type */);\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Deeply checks that the nodes comply with the field schema and included schema.\n *\n * @param onError - Called with the first error (if any).\n *\n * @returns the return value from `onError` if the field or anything inside of it is out of schema, otherwise `undefined`.\n */\nexport function isFieldInSchema<T extends NotUndefined>(\n\tchildNodes: MapTreeFieldViewGeneric<MinimalMapTreeNodeView>,\n\tschema: TreeFieldStoredSchema,\n\tschemaAndPolicy: SchemaAndPolicy,\n\tonError: (error: SchemaValidationError, context?: SchemaValidationErrorContext) => T,\n): T | undefined {\n\t// Validate that the field kind is handled by the schema policy\n\tconst kind = schemaAndPolicy.policy.fieldKinds.get(schema.kind);\n\tif (kind === undefined) {\n\t\treturn onError(SchemaValidationError.Field_KindNotInSchemaPolicy);\n\t}\n\n\t// Validate that the field doesn't contain more nodes than its type supports\n\t{\n\t\tconst multiplicityCheck = compliesWithMultiplicity(childNodes.length, kind.multiplicity);\n\t\tif (multiplicityCheck !== undefined) {\n\t\t\treturn onError(multiplicityCheck);\n\t\t}\n\t}\n\n\tfor (const node of childNodes) {\n\t\t// Validate the type declared by the node is allowed in this field\n\t\tif (schema.types !== undefined && !schema.types.has(node.type)) {\n\t\t\treturn onError(SchemaValidationError.Field_NodeTypeNotAllowed, {\n\t\t\t\tnodeType: node.type,\n\t\t\t\tallowedTypes: schema.types,\n\t\t\t});\n\t\t}\n\n\t\t// Validate the node complies with the type it declares to be.\n\t\tconst nodeInSchemaResult = isNodeInSchema(node, schemaAndPolicy, onError);\n\t\tif (nodeInSchemaResult !== undefined) {\n\t\t\treturn nodeInSchemaResult;\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Validates that a given number of items complies with the specified {@link Multiplicity | multiplicity}.\n * @param numberOfItems - Number of items.\n * @param multiplicity - Kind of multiplicity to validate against.\n * @returns `true` if the specified number of items complies with the specified multiplicity; otherwise, `false`.\n */\nexport function compliesWithMultiplicity(\n\tnumberOfItems: number,\n\tmultiplicity: Multiplicity,\n): SchemaValidationError | undefined {\n\tswitch (multiplicity) {\n\t\tcase Multiplicity.Single: {\n\t\t\tif (numberOfItems < 1) {\n\t\t\t\treturn SchemaValidationError.Field_MissingRequiredChild;\n\t\t\t} else if (numberOfItems > 1) {\n\t\t\t\treturn SchemaValidationError.Field_MultipleChildrenNotAllowed;\n\t\t\t} else {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t}\n\t\tcase Multiplicity.Optional: {\n\t\t\treturn numberOfItems > 1\n\t\t\t\t? SchemaValidationError.Field_MultipleChildrenNotAllowed\n\t\t\t\t: undefined;\n\t\t}\n\t\tcase Multiplicity.Sequence: {\n\t\t\treturn undefined;\n\t\t}\n\t\tcase Multiplicity.Forbidden: {\n\t\t\treturn numberOfItems === 0\n\t\t\t\t? undefined\n\t\t\t\t: SchemaValidationError.Field_ChildInForbiddenField;\n\t\t}\n\t\tdefault: {\n\t\t\tunreachableCase(multiplicity);\n\t\t}\n\t}\n}\n"]}
+{"version":3,"file":"schemaChecker.js","sourceRoot":"","sources":["../../src/feature-libraries/schemaChecker.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,kBAAkB,EAClB,eAAe,EACf,IAAI,GACJ,MAAM,qCAAqC,CAAC;AAK7C,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAE1F,OAAO,EAEN,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,YAAY,EAEZ,WAAW,GACX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,MAAM,CAAN,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAChC,+GAA2B,CAAA;IAC3B,6GAA0B,CAAA;IAC1B,yHAAgC,CAAA;IAChC,+GAA2B,CAAA;IAC3B,yGAAwB,CAAA;IACxB,mGAAqB,CAAA;IACrB,2GAAyB,CAAA;IACzB,+GAA2B,CAAA;IAC3B,+GAA2B,CAAA;IAC3B,6FAAkB,CAAA;AACnB,CAAC,EAXW,qBAAqB,KAArB,qBAAqB,QAWhC;AAWD;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAqC;IACrE,MAAM,OAAO,GAAG,oCAAoC,+BAA+B,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IACrG,MAAM,IAAI,UAAU,CACnB,kBAAkB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC,EAC3E;QACC,GAAG,kBAAkB,CAAC;YACrB,qBAAqB,EAAE,qBAAqB,CAAC,OAAO,CAAC,KAAK,CAAC;YAC3D,oBAAoB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC;SAClD,CAAC;QACF,GAAG,OAAO,CAAC,mBAAmB;KAC9B,CACD,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAC5B,OAAqC,EACrC,GAAW;IAEX,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,GAAG,CAAC,CAAC;IACpD,OAAO,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;AACjE,CAAC;AAED,SAAS,+BAA+B,CAAC,OAAqC;IAC7E,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IACzF,MAAM,QAAQ,GAAG,oBAAoB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC3D,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,oBAAoB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/D,QAAQ,OAAO,CAAC,KAAK,EAAE,CAAC;QACvB,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,cAAc,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,yCAAyC,IAAI,GAAG,CAAC;QAChG,CAAC;QACD,KAAK,qBAAqB,CAAC,0BAA0B,CAAC,CAAC,CAAC;YACvD,OAAO,4BAA4B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,8CAA8C,UAAU,GAAG,IAAI,GAAG,CAAC;QAChI,CAAC;QACD,KAAK,qBAAqB,CAAC,gCAAgC,CAAC,CAAC,CAAC;YAC7D,OAAO,mBAAmB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,wCAAwC,UAAU,GAAG,IAAI,GAAG,CAAC;QACjH,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,6BAA6B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,6BAA6B,UAAU,IAAI,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC;QAC3J,CAAC;QACD,KAAK,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC;YACrD,OAAO,kBAAkB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,gCAAgC,IAAI,oBAAoB,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,4FAA4F,CAAC;QACpP,CAAC;QACD,KAAK,qBAAqB,CAAC,qBAAqB,CAAC,CAAC,CAAC;YAClD,OAAO,aAAa,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;QACvO,CAAC;QACD,KAAK,qBAAqB,CAAC,yBAAyB,CAAC,CAAC,CAAC;YACtD,OAAO,aAAa,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,2BAA2B,IAAI,wBAAwB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,CAAC,GAAG,CAAC;QACzJ,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,kBAAkB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,wCAAwC,IAAI,wBAAwB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,CAAC,GAAG,CAAC;QAC3K,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,iBAAiB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC;QACjK,CAAC;QACD,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC;YAC/C,OAAO,gDAAgD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,IAAI,4GAA4G,CAAC;QACpM,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,OAAO,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,+BAA+B,CAAC,KAA4B;IACpE,QAAQ,KAAK,EAAE,CAAC;QACf,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,uDAAuD,CAAC;QAChE,CAAC;QACD,KAAK,qBAAqB,CAAC,0BAA0B,CAAC,CAAC,CAAC;YACvD,OAAO,wCAAwC,CAAC;QACjD,CAAC;QACD,KAAK,qBAAqB,CAAC,gCAAgC,CAAC,CAAC,CAAC;YAC7D,OAAO,sDAAsD,CAAC;QAC/D,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,sCAAsC,CAAC;QAC/C,CAAC;QACD,KAAK,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC;YACrD,OAAO,0CAA0C,CAAC;QACnD,CAAC;QACD,KAAK,qBAAqB,CAAC,qBAAqB,CAAC,CAAC,CAAC;YAClD,OAAO,8CAA8C,CAAC;QACvD,CAAC;QACD,KAAK,qBAAqB,CAAC,yBAAyB,CAAC,CAAC,CAAC;YACtD,OAAO,8BAA8B,CAAC;QACvC,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,2DAA2D,CAAC;QACpE,CAAC;QACD,KAAK,qBAAqB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACxD,OAAO,mCAAmC,CAAC;QAC5C,CAAC;QACD,KAAK,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC;YAC/C,OAAO,yCAAyC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,qBAAqB,CAC7B,KAA4B,EAC5B,mBAA8C;IAE9C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,mBAAmB,EAAE,CAAC;AACjD,CAAC;AAED,SAAS,WAAW,CACnB,OAAqD,EACrD,OAAwB;IAExB,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IACnC,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC;AAC/C,CAAC;AAID;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAC7B,IAA4B,EAC5B,eAAgC,EAChC,OAAqD;IAErD,kDAAkD;IAClD,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,OAAO,CACb,qBAAqB,CACpB,qBAAqB,CAAC,kBAAkB,EACxC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAC3C,CACD,CAAC;IACH,CAAC;IAED,2DAA2D;IAE3D,IAAI,MAAM,YAAY,oBAAoB,EAAE,CAAC;QAC5C,IAAI,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,MAAM,gBAAgB,GAAG,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9E,OAAO,OAAO,CACb,qBAAqB,CAAC,qBAAqB,CAAC,yBAAyB,EAAE;gBACtE,GAAG,kBAAkB,CAAC;oBACrB,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;iBAClD,CAAC;aACF,CAAC,CACF,CAAC;QACH,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,OAAO,OAAO,CACb,qBAAqB,CAAC,qBAAqB,CAAC,qBAAqB,EAAE;gBAClE,GAAG,kBAAkB,CAAC;oBACrB,QAAQ,EAAE,IAAI,CAAC,IAAI;oBACnB,iBAAiB,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC;iBAChD,CAAC;gBACF,eAAe,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;aACzC,CAAC,CACF,CAAC;QACH,CAAC;IACF,CAAC;SAAM,CAAC;QACP,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,OAAO,CACb,qBAAqB,CAAC,qBAAqB,CAAC,2BAA2B,EAAE;gBACxE,GAAG,kBAAkB,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC9C,eAAe,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;aACzC,CAAC,CACF,CAAC;QACH,CAAC;QAED,IAAI,MAAM,YAAY,sBAAsB,EAAE,CAAC;YAC9C,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACzF,KAAK,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;gBAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAClD,MAAM,mBAAmB,GAAG,eAAe,CAC1C,SAAS,EACT,WAAW,EACX,eAAe,EACf,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,CAC9B,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,mBAAmB,CAAC;gBAC5B,CAAC;gBACD,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;YACD,4GAA4G;YAC5G,yIAAyI;YACzI,qLAAqL;YACrL,0HAA0H;YAC1H,IAAI,uBAAuB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;gBACtC,OAAO,OAAO,CACb,qBAAqB,CAAC,qBAAqB,CAAC,2BAA2B,EAAE;oBACxE,GAAG,kBAAkB,CAAC;wBACrB,QAAQ,EAAE,IAAI,CAAC,IAAI;wBACnB,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,uBAAuB,CAAC,CAAC,IAAI,EAAE,CAAC;qBACrE,CAAC;iBACF,CAAC,CACF,CAAC;YACH,CAAC;QACF,CAAC;aAAM,IAAI,MAAM,YAAY,mBAAmB,EAAE,CAAC;YAClD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACxC,MAAM,mBAAmB,GAAG,eAAe,CAC1C,KAAK,EACL,MAAM,CAAC,SAAS,EAChB,eAAe,EACf,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CACzB,CAAC;gBACF,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACvC,OAAO,mBAAmB,CAAC;gBAC5B,CAAC;YACF,CAAC;QACF,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACrD,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC9B,UAA2D,EAC3D,MAA6B,EAC7B,eAAgC,EAChC,OAAqD;IAErD,+DAA+D;IAC/D,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAChE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,OAAO,CACb,qBAAqB,CACpB,qBAAqB,CAAC,2BAA2B,EACjD,kBAAkB,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAC9C,CACD,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,CAAC;QACA,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzF,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACrC,OAAO,OAAO,CACb,qBAAqB,CAAC,iBAAiB,EAAE;gBACxC,GAAG,kBAAkB,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;gBACjD,UAAU,EAAE,UAAU,CAAC,MAAM;aAC7B,CAAC,CACF,CAAC;QACH,CAAC;IACF,CAAC;IAED,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC/B,kEAAkE;QAClE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,YAAY,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;YAC9C,OAAO,WAAW,CACjB,OAAO,EACP,KAAK,CACL,CACA,qBAAqB,CACpB,qBAAqB,CAAC,wBAAwB,EAC9C,kBAAkB,CAAC;gBAClB,QAAQ,EAAE,IAAI,CAAC,IAAI;gBACnB,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;aAC1C,CAAC,CACF,CACD,CAAC;QACH,CAAC;QAED,8DAA8D;QAC9D,MAAM,kBAAkB,GAAG,cAAc,CACxC,IAAI,EACJ,eAAe,EACf,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAC3B,CAAC;QACF,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,kBAAkB,CAAC;QAC3B,CAAC;QACD,KAAK,IAAI,CAAC,CAAC;IACZ,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACvC,aAAqB,EACrB,YAA0B;IAE1B,QAAQ,YAAY,EAAE,CAAC;QACtB,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;YAC1B,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,qBAAqB,CAAC,0BAA0B,CAAC;YACzD,CAAC;iBAAM,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;gBAC9B,OAAO,qBAAqB,CAAC,gCAAgC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YAClB,CAAC;QACF,CAAC;QACD,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5B,OAAO,aAAa,GAAG,CAAC;gBACvB,CAAC,CAAC,qBAAqB,CAAC,gCAAgC;gBACxD,CAAC,CAAC,SAAS,CAAC;QACd,CAAC;QACD,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5B,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,KAAK,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;YAC7B,OAAO,aAAa,KAAK,CAAC;gBACzB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,qBAAqB,CAAC,2BAA2B,CAAC;QACtD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,eAAe,CAAC,YAAY,CAAC,CAAC;QAC/B,CAAC;IACF,CAAC;AACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tappendDebugMessage,\n\tunreachableCase,\n\tfail,\n} from \"@fluidframework/core-utils/internal\";\nimport type {\n\tITelemetryBaseProperties,\n\tTelemetryBaseEventPropertyType,\n} from \"@fluidframework/core-interfaces\";\nimport { tagSchemaArtifacts, UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\ttype TreeFieldStoredSchema,\n\tLeafNodeStoredSchema,\n\tObjectNodeStoredSchema,\n\tMapNodeStoredSchema,\n\tMultiplicity,\n\ttype SchemaAndPolicy,\n\tValueSchema,\n} from \"../core/index.js\";\nimport { iterableHasSome, mapIterable } from \"../util/index.js\";\n\nimport type { MapTreeFieldViewGeneric, MinimalMapTreeNodeView } from \"./mapTreeCursor.js\";\nimport { allowsValue } from \"./valueUtilities.js\";\n\nexport enum SchemaValidationError {\n\tField_KindNotInSchemaPolicy,\n\tField_MissingRequiredChild,\n\tField_MultipleChildrenNotAllowed,\n\tField_ChildInForbiddenField,\n\tField_NodeTypeNotAllowed,\n\tLeafNode_InvalidValue,\n\tLeafNode_FieldsNotAllowed,\n\tObjectNode_FieldNotInSchema,\n\tNonLeafNode_ValueNotAllowed,\n\tNode_MissingSchema,\n}\n\n/**\n * Information about a schema validation error.\n */\nexport interface SchemaValidationErrorDetails {\n\treadonly error: SchemaValidationError;\n\treadonly path: readonly (string | number)[];\n\treadonly telemetryProperties?: ITelemetryBaseProperties;\n}\n\n/**\n * Throws a UsageError indicating a tree is out of schema.\n */\nexport function throwOutOfSchema(details: SchemaValidationErrorDetails): never {\n\tconst message = `Tree does not conform to schema. ${getSchemaValidationErrorMessage(details.error)}`;\n\tthrow new UsageError(\n\t\tappendDebugMessage(message, () => getSchemaValidationDebugMessage(details)),\n\t\t{\n\t\t\t...tagSchemaArtifacts({\n\t\t\t\tschemaValidationError: SchemaValidationError[details.error],\n\t\t\t\tschemaValidationPath: JSON.stringify(details.path),\n\t\t\t}),\n\t\t\t...details.telemetryProperties,\n\t\t},\n\t);\n}\n\nfunction getTelemetryProperty(\n\tdetails: SchemaValidationErrorDetails,\n\tkey: string,\n): TelemetryBaseEventPropertyType {\n\tconst property = details.telemetryProperties?.[key];\n\treturn typeof property === \"object\" ? property.value : property;\n}\n\nfunction getSchemaValidationDebugMessage(details: SchemaValidationErrorDetails): string {\n\tconst path = details.path.length === 0 ? \"\" : ` at path ${JSON.stringify(details.path)}`;\n\tconst nodeType = getTelemetryProperty(details, \"nodeType\");\n\tconst fieldKind = getTelemetryProperty(details, \"fieldKind\");\n\tconst childCount = getTelemetryProperty(details, \"childCount\");\n\tswitch (details.error) {\n\t\tcase SchemaValidationError.Field_KindNotInSchemaPolicy: {\n\t\t\treturn `Field kind ${JSON.stringify(fieldKind)} is not supported by the schema policy${path}.`;\n\t\t}\n\t\tcase SchemaValidationError.Field_MissingRequiredChild: {\n\t\t\treturn `A required field of kind ${JSON.stringify(fieldKind)} must contain exactly one child, but found ${childCount}${path}.`;\n\t\t}\n\t\tcase SchemaValidationError.Field_MultipleChildrenNotAllowed: {\n\t\t\treturn `A field of kind ${JSON.stringify(fieldKind)} allows at most one child, but found ${childCount}${path}.`;\n\t\t}\n\t\tcase SchemaValidationError.Field_ChildInForbiddenField: {\n\t\t\treturn `A forbidden field of kind ${JSON.stringify(fieldKind)} must be empty, but found ${childCount} ${childCount === 1 ? \"child\" : \"children\"}${path}.`;\n\t\t}\n\t\tcase SchemaValidationError.Field_NodeTypeNotAllowed: {\n\t\t\treturn `A node of type ${JSON.stringify(nodeType)} is not allowed in this field${path}. Allowed types: ${getTelemetryProperty(details, \"allowedTypes\")}. If using a staged allowed type, upgrade the stored schema before inserting this content.`;\n\t\t}\n\t\tcase SchemaValidationError.LeafNode_InvalidValue: {\n\t\t\treturn `Leaf node ${JSON.stringify(nodeType)} requires a value matching ${JSON.stringify(getTelemetryProperty(details, \"expectedValueType\"))}, but found ${JSON.stringify(getTelemetryProperty(details, \"actualValueType\"))}${path}.`;\n\t\t}\n\t\tcase SchemaValidationError.LeafNode_FieldsNotAllowed: {\n\t\t\treturn `Leaf node ${JSON.stringify(nodeType)} must not contain fields${path}. Unexpected fields: ${getTelemetryProperty(details, \"unexpectedFields\")}.`;\n\t\t}\n\t\tcase SchemaValidationError.ObjectNode_FieldNotInSchema: {\n\t\t\treturn `A node of type ${JSON.stringify(nodeType)} has fields not defined in its schema${path}. Unexpected fields: ${getTelemetryProperty(details, \"unexpectedFields\")}.`;\n\t\t}\n\t\tcase SchemaValidationError.NonLeafNode_ValueNotAllowed: {\n\t\t\treturn `Non-leaf node ${JSON.stringify(nodeType)} must not have a value, but found ${JSON.stringify(getTelemetryProperty(details, \"actualValueType\"))}${path}.`;\n\t\t}\n\t\tcase SchemaValidationError.Node_MissingSchema: {\n\t\t\treturn `No schema definition was found for node type ${JSON.stringify(nodeType)}${path}. Ensure the node's type is included in the schema and that the stored schema has been upgraded if needed.`;\n\t\t}\n\t\tdefault: {\n\t\t\treturn unreachableCase(details.error);\n\t\t}\n\t}\n}\n\nfunction getSchemaValidationErrorMessage(error: SchemaValidationError): string {\n\tswitch (error) {\n\t\tcase SchemaValidationError.Field_KindNotInSchemaPolicy: {\n\t\t\treturn \"The field kind is not supported by the schema policy.\";\n\t\t}\n\t\tcase SchemaValidationError.Field_MissingRequiredChild: {\n\t\t\treturn \"A required field is missing its child.\";\n\t\t}\n\t\tcase SchemaValidationError.Field_MultipleChildrenNotAllowed: {\n\t\t\treturn \"A field contains more children than its kind allows.\";\n\t\t}\n\t\tcase SchemaValidationError.Field_ChildInForbiddenField: {\n\t\t\treturn \"A forbidden field contains children.\";\n\t\t}\n\t\tcase SchemaValidationError.Field_NodeTypeNotAllowed: {\n\t\t\treturn \"A node type is not allowed in its field.\";\n\t\t}\n\t\tcase SchemaValidationError.LeafNode_InvalidValue: {\n\t\t\treturn \"A leaf node value does not match its schema.\";\n\t\t}\n\t\tcase SchemaValidationError.LeafNode_FieldsNotAllowed: {\n\t\t\treturn \"A leaf node contains fields.\";\n\t\t}\n\t\tcase SchemaValidationError.ObjectNode_FieldNotInSchema: {\n\t\t\treturn \"An object node contains fields not defined in its schema.\";\n\t\t}\n\t\tcase SchemaValidationError.NonLeafNode_ValueNotAllowed: {\n\t\t\treturn \"A non-leaf node contains a value.\";\n\t\t}\n\t\tcase SchemaValidationError.Node_MissingSchema: {\n\t\t\treturn \"The node type has no schema definition.\";\n\t\t}\n\t\tdefault: {\n\t\t\treturn unreachableCase(error);\n\t\t}\n\t}\n}\n\nfunction schemaValidationError(\n\terror: SchemaValidationError,\n\ttelemetryProperties?: ITelemetryBaseProperties,\n): SchemaValidationErrorDetails {\n\treturn { error, path: [], telemetryProperties };\n}\n\nfunction prependPath<T extends NotUndefined>(\n\tonError: (details: SchemaValidationErrorDetails) => T,\n\tsegment: string | number,\n): (details: SchemaValidationErrorDetails) => T {\n\treturn (details) => onError({ ...details, path: [segment, ...details.path] });\n}\n\nfunction getValueType(value: unknown): string {\n\treturn value === null ? \"null\" : typeof value;\n}\n\ntype NotUndefined = number | string | boolean | bigint | symbol | object;\n\n/**\n * Deeply checks that the provided node complies with the schema based on its identifier.\n *\n * @param onError - Called with the first error (if any).\n *\n * @returns the return value from `onError` if the node or anything inside of it is out of schema, otherwise `undefined`.\n */\nexport function isNodeInSchema<T extends NotUndefined>(\n\tnode: MinimalMapTreeNodeView,\n\tschemaAndPolicy: SchemaAndPolicy,\n\tonError: (details: SchemaValidationErrorDetails) => T,\n): T | undefined {\n\t// Validate the schema declared by the node exists\n\tconst schema = schemaAndPolicy.schema.nodeSchema.get(node.type);\n\tif (schema === undefined) {\n\t\treturn onError(\n\t\t\tschemaValidationError(\n\t\t\t\tSchemaValidationError.Node_MissingSchema,\n\t\t\t\ttagSchemaArtifacts({ nodeType: node.type }),\n\t\t\t),\n\t\t);\n\t}\n\n\t// Validate the node is well formed according to its schema\n\n\tif (schema instanceof LeafNodeStoredSchema) {\n\t\tif (iterableHasSome(node.fields)) {\n\t\t\tconst unexpectedFields = [...mapIterable(node.fields, ([key]) => key)].sort();\n\t\t\treturn onError(\n\t\t\t\tschemaValidationError(SchemaValidationError.LeafNode_FieldsNotAllowed, {\n\t\t\t\t\t...tagSchemaArtifacts({\n\t\t\t\t\t\tnodeType: node.type,\n\t\t\t\t\t\tunexpectedFields: JSON.stringify(unexpectedFields),\n\t\t\t\t\t}),\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\t\tif (!allowsValue(schema.leafValue, node.value)) {\n\t\t\treturn onError(\n\t\t\t\tschemaValidationError(SchemaValidationError.LeafNode_InvalidValue, {\n\t\t\t\t\t...tagSchemaArtifacts({\n\t\t\t\t\t\tnodeType: node.type,\n\t\t\t\t\t\texpectedValueType: ValueSchema[schema.leafValue],\n\t\t\t\t\t}),\n\t\t\t\t\tactualValueType: getValueType(node.value),\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\t} else {\n\t\tif (node.value !== undefined) {\n\t\t\treturn onError(\n\t\t\t\tschemaValidationError(SchemaValidationError.NonLeafNode_ValueNotAllowed, {\n\t\t\t\t\t...tagSchemaArtifacts({ nodeType: node.type }),\n\t\t\t\t\tactualValueType: getValueType(node.value),\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\n\t\tif (schema instanceof ObjectNodeStoredSchema) {\n\t\t\tconst uncheckedFieldsFromNode = new Set(mapIterable(node.fields, ([key, field]) => key));\n\t\t\tfor (const [fieldKey, fieldSchema] of schema.objectNodeFields) {\n\t\t\t\tconst nodeField = node.fields.get(fieldKey) ?? [];\n\t\t\t\tconst fieldInSchemaResult = isFieldInSchema(\n\t\t\t\t\tnodeField,\n\t\t\t\t\tfieldSchema,\n\t\t\t\t\tschemaAndPolicy,\n\t\t\t\t\tprependPath(onError, fieldKey),\n\t\t\t\t);\n\t\t\t\tif (fieldInSchemaResult !== undefined) {\n\t\t\t\t\treturn fieldInSchemaResult;\n\t\t\t\t}\n\t\t\t\tuncheckedFieldsFromNode.delete(fieldKey);\n\t\t\t}\n\t\t\t// The node has fields that we did not check as part of looking at every field defined in the node's schema.\n\t\t\t// Since this is testing compatibility with a stored schema (not view schema), \"allowUnknownOptionalFields\" does not exist at this layer.\n\t\t\t// Code using this with a stored schema derived from a view schema rather than the document can be problematic because it may be missing unknown fields that the actual document has.\n\t\t\t// Other schema evolution features like \"staged\" allowed types will likely cause similar issues elsewhere in this checker.\n\t\t\tif (uncheckedFieldsFromNode.size > 0) {\n\t\t\t\treturn onError(\n\t\t\t\t\tschemaValidationError(SchemaValidationError.ObjectNode_FieldNotInSchema, {\n\t\t\t\t\t\t...tagSchemaArtifacts({\n\t\t\t\t\t\t\tnodeType: node.type,\n\t\t\t\t\t\t\tunexpectedFields: JSON.stringify([...uncheckedFieldsFromNode].sort()),\n\t\t\t\t\t\t}),\n\t\t\t\t\t}),\n\t\t\t\t);\n\t\t\t}\n\t\t} else if (schema instanceof MapNodeStoredSchema) {\n\t\t\tfor (const [key, field] of node.fields) {\n\t\t\t\tconst fieldInSchemaResult = isFieldInSchema(\n\t\t\t\t\tfield,\n\t\t\t\t\tschema.mapFields,\n\t\t\t\t\tschemaAndPolicy,\n\t\t\t\t\tprependPath(onError, key),\n\t\t\t\t);\n\t\t\t\tif (fieldInSchemaResult !== undefined) {\n\t\t\t\t\treturn fieldInSchemaResult;\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfail(0xb0e /* Unknown TreeNodeStoredSchema type */);\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Deeply checks that the nodes comply with the field schema and included schema.\n *\n * @param onError - Called with the first error (if any).\n *\n * @returns the return value from `onError` if the field or anything inside of it is out of schema, otherwise `undefined`.\n */\nexport function isFieldInSchema<T extends NotUndefined>(\n\tchildNodes: MapTreeFieldViewGeneric<MinimalMapTreeNodeView>,\n\tschema: TreeFieldStoredSchema,\n\tschemaAndPolicy: SchemaAndPolicy,\n\tonError: (details: SchemaValidationErrorDetails) => T,\n): T | undefined {\n\t// Validate that the field kind is handled by the schema policy\n\tconst kind = schemaAndPolicy.policy.fieldKinds.get(schema.kind);\n\tif (kind === undefined) {\n\t\treturn onError(\n\t\t\tschemaValidationError(\n\t\t\t\tSchemaValidationError.Field_KindNotInSchemaPolicy,\n\t\t\t\ttagSchemaArtifacts({ fieldKind: schema.kind }),\n\t\t\t),\n\t\t);\n\t}\n\n\t// Validate that the field doesn't contain more nodes than its type supports\n\t{\n\t\tconst multiplicityCheck = compliesWithMultiplicity(childNodes.length, kind.multiplicity);\n\t\tif (multiplicityCheck !== undefined) {\n\t\t\treturn onError(\n\t\t\t\tschemaValidationError(multiplicityCheck, {\n\t\t\t\t\t...tagSchemaArtifacts({ fieldKind: schema.kind }),\n\t\t\t\t\tchildCount: childNodes.length,\n\t\t\t\t}),\n\t\t\t);\n\t\t}\n\t}\n\n\tlet index = 0;\n\tfor (const node of childNodes) {\n\t\t// Validate the type declared by the node is allowed in this field\n\t\tif (schema.types !== undefined && !schema.types.has(node.type)) {\n\t\t\tconst allowedTypes = [...schema.types].sort();\n\t\t\treturn prependPath(\n\t\t\t\tonError,\n\t\t\t\tindex,\n\t\t\t)(\n\t\t\t\tschemaValidationError(\n\t\t\t\t\tSchemaValidationError.Field_NodeTypeNotAllowed,\n\t\t\t\t\ttagSchemaArtifacts({\n\t\t\t\t\t\tnodeType: node.type,\n\t\t\t\t\t\tallowedTypes: JSON.stringify(allowedTypes),\n\t\t\t\t\t}),\n\t\t\t\t),\n\t\t\t);\n\t\t}\n\n\t\t// Validate the node complies with the type it declares to be.\n\t\tconst nodeInSchemaResult = isNodeInSchema(\n\t\t\tnode,\n\t\t\tschemaAndPolicy,\n\t\t\tprependPath(onError, index),\n\t\t);\n\t\tif (nodeInSchemaResult !== undefined) {\n\t\t\treturn nodeInSchemaResult;\n\t\t}\n\t\tindex += 1;\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Validates that a given number of items complies with the specified {@link Multiplicity | multiplicity}.\n * @param numberOfItems - Number of items.\n * @param multiplicity - Kind of multiplicity to validate against.\n * @returns `true` if the specified number of items complies with the specified multiplicity; otherwise, `false`.\n */\nexport function compliesWithMultiplicity(\n\tnumberOfItems: number,\n\tmultiplicity: Multiplicity,\n): SchemaValidationError | undefined {\n\tswitch (multiplicity) {\n\t\tcase Multiplicity.Single: {\n\t\t\tif (numberOfItems < 1) {\n\t\t\t\treturn SchemaValidationError.Field_MissingRequiredChild;\n\t\t\t} else if (numberOfItems > 1) {\n\t\t\t\treturn SchemaValidationError.Field_MultipleChildrenNotAllowed;\n\t\t\t} else {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t}\n\t\tcase Multiplicity.Optional: {\n\t\t\treturn numberOfItems > 1\n\t\t\t\t? SchemaValidationError.Field_MultipleChildrenNotAllowed\n\t\t\t\t: undefined;\n\t\t}\n\t\tcase Multiplicity.Sequence: {\n\t\t\treturn undefined;\n\t\t}\n\t\tcase Multiplicity.Forbidden: {\n\t\t\treturn numberOfItems === 0\n\t\t\t\t? undefined\n\t\t\t\t: SchemaValidationError.Field_ChildInForbiddenField;\n\t\t}\n\t\tdefault: {\n\t\t\tunreachableCase(multiplicity);\n\t\t}\n\t}\n}\n"]}

package/lib/feature-libraries/sequence-field/compose.js

@@ -260,6 +260,12 @@ function composeMark(mark, moveEffects, composeChild) {
     return withNodeChange(updatedMark, nodeChanges);
 }
 export class ComposeQueue {
+    moveEffects;
+    revisionMetadata;
+    baseMarks;
+    newMarks;
+    baseMarksCellSources;
+    newMarksCellSources;
     constructor(baseMarks, newMarks, moveEffects, revisionMetadata) {
         this.moveEffects = moveEffects;
         this.revisionMetadata = revisionMetadata;