@fluidframework/tree 2.117.0 → 3.0.0

package/dist/feature-libraries/optional-field/optionalFieldChangeFormatV2.d.ts

@@ -4,22 +4,22 @@
  */
 import * as Type from "@sinclair/typebox";
 import type { Static, TSchema } from "@sinclair/typebox";
-export declare const EncodedRegisterId: Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>;
+export declare const EncodedRegisterId: Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>;
 export type EncodedRegisterId = Static<typeof EncodedRegisterId>;
-export declare const EncodedOptionalChangeset: <Schema extends Type.TSchema>(tNodeChange: Schema) => Type.TObject<{
-    m: Type.TOptional<Type.TArray<Type.TTuple<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>]>>>;
-    c: Type.TOptional<Type.TArray<Type.TTuple<[Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>, Schema]>>>;
+export declare const EncodedOptionalChangeset: <Schema extends TSchema>(tNodeChange: Schema) => Type.TObject<{
+    m: Type.TOptional<Type.TArray<Type.TTuple<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>]>>>;
+    c: Type.TOptional<Type.TArray<Type.TTuple<[Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>, Schema]>>>;
     r: Type.TOptional<Type.TObject<{
         e: Type.TBoolean;
-        s: Type.TOptional<Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>>;
-        d: Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>;
+        s: Type.TOptional<Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>>;
+        d: Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>;
     }>>;
 }>;
 export type EncodedOptionalChangeset<Schema extends TSchema> = Static<ReturnType<typeof EncodedOptionalChangeset<Schema>>>;
 declare const EncodedReplace: Type.TObject<{
     e: Type.TBoolean;
-    s: Type.TOptional<Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>>;
-    d: Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor").OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>;
+    s: Type.TOptional<Type.TUnion<[Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>, Type.TNull]>>;
+    d: Type.TUnion<[Type.TTuple<[Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>, Type.TUnion<[Type.TLiteral<"root">, Type.TUnsafe<import("../../util/brand.js").Brand<import("@fluidframework/id-compressor", { with: { "resolution-mode": "import" } }).OpSpaceCompressedId, "EncodedRevisionTag">>]>]>, Type.TUnsafe<import("../../core/index.js").ChangesetLocalId>]>;
 }>;
 export type EncodedReplace = Static<typeof EncodedReplace>;
 export {};

package/dist/feature-libraries/optional-field/optionalFieldChangeFormatV2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"optionalFieldChangeFormatV2.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldChangeFormatV2.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,EAAiB,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAQxE,eAAO,MAAM,iBAAiB,iWAAiD,CAAC;AAChF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIjE,eAAO,MAAM,wBAAwB,6CAAyC,MAAM;;;;;;;;EAalF,CAAC;AAEH,MAAM,MAAM,wBAAwB,CAAC,MAAM,SAAS,OAAO,IAAI,MAAM,CACpE,UAAU,CAAC,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC,CACnD,CAAC;AAgBF,QAAA,MAAM,cAAc;;;;EAWnB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC"}
+{"version":3,"file":"optionalFieldChangeFormatV2.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldChangeFormatV2.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,KAAK,EAAiB,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAQxE,eAAO,MAAM,iBAAiB,4YAAiD,CAAC;AAChF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAIjE,eAAO,MAAM,wBAAwB,GAAI,MAAM,SAAS,OAAO,EAAE,aAAa,MAAM;;;;;;;;EAalF,CAAC;AAEH,MAAM,MAAM,wBAAwB,CAAC,MAAM,SAAS,OAAO,IAAI,MAAM,CACpE,UAAU,CAAC,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC,CACnD,CAAC;AAgBF,QAAA,MAAM,cAAc;;;;EAWnB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC"}

package/dist/feature-libraries/optional-field/optionalFieldCodecV2.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeOptionalFieldCodec = void 0;
+exports.makeOptionalFieldCodec = makeOptionalFieldCodec;
 const changeAtomIdCodec_js_1 = require("../changeAtomIdCodec.js");
 const index_js_1 = require("../modular-schema/index.js");
 const optionalFieldChangeFormatV2_js_1 = require("./optionalFieldChangeFormatV2.js");
@@ -83,5 +83,4 @@ function makeOptionalFieldCodec(revisionTagCodec) {
         encodedSchema: (0, optionalFieldChangeFormatV2_js_1.EncodedOptionalChangeset)(index_js_1.EncodedNodeChangeset),
     };
 }
-exports.makeOptionalFieldCodec = makeOptionalFieldCodec;
 //# sourceMappingURL=optionalFieldCodecV2.js.map

package/dist/feature-libraries/optional-field/optionalFieldCodecV2.js.map

@@ -1 +1 @@
-{"version":3,"file":"optionalFieldCodecV2.js","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecV2.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAYH,kEAAgE;AAMhE,yDAAkE;AAElE,qFAA+F;AAG/F,SAAS,mBAAmB,CAC3B,iBAIC;IAED,OAAO;QACN,MAAM,EAAE,CAAC,UAAsB,EAAE,OAA8B,EAAE,EAAE;YAClE,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC;YACb,CAAC;YACD,OAAO,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,EAAE,CAAC,UAA6B,EAAE,OAA8B,EAAE,EAAE;YACzE,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,MAAM,CAAC;YACf,CAAC;YACD,OAAO,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QACD,aAAa,EAAE,kDAAiB;KAChC,CAAC;AACH,CAAC;AAED,SAAgB,sBAAsB,CACrC,gBAIC;IAQD,MAAM,iBAAiB,GAAG,IAAA,4CAAqB,EAAC,gBAAgB,CAAC,CAAC;IAClE,MAAM,eAAe,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAE/D,OAAO;QACN,MAAM,EAAE,CAAC,MAAyB,EAAE,OAAmC,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAyC,EAAE,CAAC;YAEzD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC;oBAC5C,iBAAiB,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;oBAClD,iBAAiB,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;iBAClD,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACvC,OAAO,CAAC,CAAC,GAAG;oBACX,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC,OAAO;oBAC9B,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;iBACzE,CAAC;gBACF,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;oBAC3C,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;gBACpF,CAAC;YACF,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;gBACf,KAAK,MAAM,CAAC,EAAE,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;oBACrD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;wBACd,eAAe,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC;wBAC/C,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;qBAC/B,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;YAED,OAAO,OAAO,CAAC;QAChB,CAAC;QAED,MAAM,EAAE,CACP,OAA6C,EAC7C,OAAmC,EAClC,EAAE;YACH,MAAM,OAAO,GAA+B;gBAC3C,KAAK,EACJ,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;oBAC5C,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC;oBACzD,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC;iBACzD,CAAC,IAAI,EAAE;gBACT,YAAY,EACX,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC;oBACvC,eAAe,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC;oBAC/C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC;iBACjC,CAAC,IAAI,EAAE;aACT,CAAC;YAEF,IAAI,OAAO,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAqB;oBACjC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;oBACpB,GAAG,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;iBAC/D,CAAC;gBACF,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;gBACxE,CAAC;gBACD,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC;YAChC,CAAC;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,aAAa,EAAE,IAAA,yDAAwB,EAAC,+BAAoB,CAAC;KAC7D,CAAC;AACH,CAAC;AAjFD,wDAiFC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TAnySchema } from \"@sinclair/typebox\";\n\nimport type { IJsonCodec, JsonCodecPart } from \"../../codec/index.js\";\nimport type {\n\tRevisionTagSchema,\n\tChangeAtomId,\n\tChangeEncodingContext,\n\tRevisionTag,\n} from \"../../core/index.js\";\nimport type { Mutable } from \"../../util/index.js\";\nimport { makeChangeAtomIdCodec } from \"../changeAtomIdCodec.js\";\nimport type {\n\tFieldChangeEncodingContext,\n\tFieldChangeDecodingContext,\n\tEncodedChangeAtomId,\n} from \"../modular-schema/index.js\";\nimport { EncodedNodeChangeset } from \"../modular-schema/index.js\";\n\nimport { EncodedOptionalChangeset, EncodedRegisterId } from \"./optionalFieldChangeFormatV2.js\";\nimport type { OptionalChangeset, RegisterId, Replace } from \"./optionalFieldChangeTypes.js\";\n\nfunction makeRegisterIdCodec(\n\tchangeAtomIdCodec: JsonCodecPart<\n\t\tChangeAtomId,\n\t\ttypeof EncodedChangeAtomId,\n\t\tChangeEncodingContext\n\t>,\n): JsonCodecPart<RegisterId, typeof EncodedRegisterId, ChangeEncodingContext> {\n\treturn {\n\t\tencode: (registerId: RegisterId, context: ChangeEncodingContext) => {\n\t\t\tif (registerId === \"self\") {\n\t\t\t\treturn null;\n\t\t\t}\n\t\t\treturn changeAtomIdCodec.encode(registerId, context);\n\t\t},\n\t\tdecode: (registerId: EncodedRegisterId, context: ChangeEncodingContext) => {\n\t\t\tif (registerId === null) {\n\t\t\t\treturn \"self\";\n\t\t\t}\n\t\t\treturn changeAtomIdCodec.decode(registerId, context);\n\t\t},\n\t\tencodedSchema: EncodedRegisterId,\n\t};\n}\n\nexport function makeOptionalFieldCodec(\n\trevisionTagCodec: JsonCodecPart<\n\t\tRevisionTag,\n\t\ttypeof RevisionTagSchema,\n\t\tChangeEncodingContext\n\t>,\n): IJsonCodec<\n\tOptionalChangeset,\n\tEncodedOptionalChangeset<TAnySchema>,\n\tEncodedOptionalChangeset<TAnySchema>,\n\tFieldChangeEncodingContext,\n\tFieldChangeDecodingContext\n> {\n\tconst changeAtomIdCodec = makeChangeAtomIdCodec(revisionTagCodec);\n\tconst registerIdCodec = makeRegisterIdCodec(changeAtomIdCodec);\n\n\treturn {\n\t\tencode: (change: OptionalChangeset, context: FieldChangeEncodingContext) => {\n\t\t\tconst encoded: EncodedOptionalChangeset<TAnySchema> = {};\n\n\t\t\tif (change.moves.length > 0) {\n\t\t\t\tencoded.m = change.moves.map(([src, dst]) => [\n\t\t\t\t\tchangeAtomIdCodec.encode(src, context.baseContext),\n\t\t\t\t\tchangeAtomIdCodec.encode(dst, context.baseContext),\n\t\t\t\t]);\n\t\t\t}\n\n\t\t\tif (change.valueReplace !== undefined) {\n\t\t\t\tencoded.r = {\n\t\t\t\t\te: change.valueReplace.isEmpty,\n\t\t\t\t\td: changeAtomIdCodec.encode(change.valueReplace.dst, context.baseContext),\n\t\t\t\t};\n\t\t\t\tif (change.valueReplace.src !== undefined) {\n\t\t\t\t\tencoded.r.s = registerIdCodec.encode(change.valueReplace.src, context.baseContext);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (change.childChanges.length > 0) {\n\t\t\t\tencoded.c = [];\n\t\t\t\tfor (const [id, childChange] of change.childChanges) {\n\t\t\t\t\tencoded.c.push([\n\t\t\t\t\t\tregisterIdCodec.encode(id, context.baseContext),\n\t\t\t\t\t\tcontext.encodeNode(childChange),\n\t\t\t\t\t]);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn encoded;\n\t\t},\n\n\t\tdecode: (\n\t\t\tencoded: EncodedOptionalChangeset<TAnySchema>,\n\t\t\tcontext: FieldChangeDecodingContext,\n\t\t) => {\n\t\t\tconst decoded: Mutable<OptionalChangeset> = {\n\t\t\t\tmoves:\n\t\t\t\t\tencoded.m?.map(([encodedSrc, encodedDst]) => [\n\t\t\t\t\t\tchangeAtomIdCodec.decode(encodedSrc, context.baseContext),\n\t\t\t\t\t\tchangeAtomIdCodec.decode(encodedDst, context.baseContext),\n\t\t\t\t\t]) ?? [],\n\t\t\t\tchildChanges:\n\t\t\t\t\tencoded.c?.map(([id, encodedChange]) => [\n\t\t\t\t\t\tregisterIdCodec.decode(id, context.baseContext),\n\t\t\t\t\t\tcontext.decodeNode(encodedChange),\n\t\t\t\t\t]) ?? [],\n\t\t\t};\n\n\t\t\tif (encoded.r !== undefined) {\n\t\t\t\tconst replace: Mutable<Replace> = {\n\t\t\t\t\tisEmpty: encoded.r.e,\n\t\t\t\t\tdst: changeAtomIdCodec.decode(encoded.r.d, context.baseContext),\n\t\t\t\t};\n\t\t\t\tif (encoded.r.s !== undefined) {\n\t\t\t\t\treplace.src = registerIdCodec.decode(encoded.r.s, context.baseContext);\n\t\t\t\t}\n\t\t\t\tdecoded.valueReplace = replace;\n\t\t\t}\n\t\t\treturn decoded;\n\t\t},\n\t\tencodedSchema: EncodedOptionalChangeset(EncodedNodeChangeset),\n\t};\n}\n"]}
+{"version":3,"file":"optionalFieldCodecV2.js","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecV2.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AA+CH,wDAiFC;AApHD,kEAAgE;AAMhE,yDAAkE;AAElE,qFAA+F;AAG/F,SAAS,mBAAmB,CAC3B,iBAIC;IAED,OAAO;QACN,MAAM,EAAE,CAAC,UAAsB,EAAE,OAA8B,EAAE,EAAE;YAClE,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;gBAC3B,OAAO,IAAI,CAAC;YACb,CAAC;YACD,OAAO,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,EAAE,CAAC,UAA6B,EAAE,OAA8B,EAAE,EAAE;YACzE,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,MAAM,CAAC;YACf,CAAC;YACD,OAAO,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC;QACD,aAAa,EAAE,kDAAiB;KAChC,CAAC;AACH,CAAC;AAED,SAAgB,sBAAsB,CACrC,gBAIC;IAQD,MAAM,iBAAiB,GAAG,IAAA,4CAAqB,EAAC,gBAAgB,CAAC,CAAC;IAClE,MAAM,eAAe,GAAG,mBAAmB,CAAC,iBAAiB,CAAC,CAAC;IAE/D,OAAO;QACN,MAAM,EAAE,CAAC,MAAyB,EAAE,OAAmC,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAyC,EAAE,CAAC;YAEzD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC;oBAC5C,iBAAiB,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;oBAClD,iBAAiB,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;iBAClD,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACvC,OAAO,CAAC,CAAC,GAAG;oBACX,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC,OAAO;oBAC9B,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC;iBACzE,CAAC;gBACF,IAAI,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;oBAC3C,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;gBACpF,CAAC;YACF,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC;gBACf,KAAK,MAAM,CAAC,EAAE,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;oBACrD,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;wBACd,eAAe,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC;wBAC/C,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;qBAC/B,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;YAED,OAAO,OAAO,CAAC;QAChB,CAAC;QAED,MAAM,EAAE,CACP,OAA6C,EAC7C,OAAmC,EAClC,EAAE;YACH,MAAM,OAAO,GAA+B;gBAC3C,KAAK,EACJ,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC;oBAC5C,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC;oBACzD,iBAAiB,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC;iBACzD,CAAC,IAAI,EAAE;gBACT,YAAY,EACX,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,aAAa,CAAC,EAAE,EAAE,CAAC;oBACvC,eAAe,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC;oBAC/C,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC;iBACjC,CAAC,IAAI,EAAE;aACT,CAAC;YAEF,IAAI,OAAO,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAqB;oBACjC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;oBACpB,GAAG,EAAE,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;iBAC/D,CAAC;gBACF,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;gBACxE,CAAC;gBACD,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC;YAChC,CAAC;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,aAAa,EAAE,IAAA,yDAAwB,EAAC,+BAAoB,CAAC;KAC7D,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { TAnySchema } from \"@sinclair/typebox\";\n\nimport type { IJsonCodec, JsonCodecPart } from \"../../codec/index.js\";\nimport type {\n\tRevisionTagSchema,\n\tChangeAtomId,\n\tChangeEncodingContext,\n\tRevisionTag,\n} from \"../../core/index.js\";\nimport type { Mutable } from \"../../util/index.js\";\nimport { makeChangeAtomIdCodec } from \"../changeAtomIdCodec.js\";\nimport type {\n\tFieldChangeEncodingContext,\n\tFieldChangeDecodingContext,\n\tEncodedChangeAtomId,\n} from \"../modular-schema/index.js\";\nimport { EncodedNodeChangeset } from \"../modular-schema/index.js\";\n\nimport { EncodedOptionalChangeset, EncodedRegisterId } from \"./optionalFieldChangeFormatV2.js\";\nimport type { OptionalChangeset, RegisterId, Replace } from \"./optionalFieldChangeTypes.js\";\n\nfunction makeRegisterIdCodec(\n\tchangeAtomIdCodec: JsonCodecPart<\n\t\tChangeAtomId,\n\t\ttypeof EncodedChangeAtomId,\n\t\tChangeEncodingContext\n\t>,\n): JsonCodecPart<RegisterId, typeof EncodedRegisterId, ChangeEncodingContext> {\n\treturn {\n\t\tencode: (registerId: RegisterId, context: ChangeEncodingContext) => {\n\t\t\tif (registerId === \"self\") {\n\t\t\t\treturn null;\n\t\t\t}\n\t\t\treturn changeAtomIdCodec.encode(registerId, context);\n\t\t},\n\t\tdecode: (registerId: EncodedRegisterId, context: ChangeEncodingContext) => {\n\t\t\tif (registerId === null) {\n\t\t\t\treturn \"self\";\n\t\t\t}\n\t\t\treturn changeAtomIdCodec.decode(registerId, context);\n\t\t},\n\t\tencodedSchema: EncodedRegisterId,\n\t};\n}\n\nexport function makeOptionalFieldCodec(\n\trevisionTagCodec: JsonCodecPart<\n\t\tRevisionTag,\n\t\ttypeof RevisionTagSchema,\n\t\tChangeEncodingContext\n\t>,\n): IJsonCodec<\n\tOptionalChangeset,\n\tEncodedOptionalChangeset<TAnySchema>,\n\tEncodedOptionalChangeset<TAnySchema>,\n\tFieldChangeEncodingContext,\n\tFieldChangeDecodingContext\n> {\n\tconst changeAtomIdCodec = makeChangeAtomIdCodec(revisionTagCodec);\n\tconst registerIdCodec = makeRegisterIdCodec(changeAtomIdCodec);\n\n\treturn {\n\t\tencode: (change: OptionalChangeset, context: FieldChangeEncodingContext) => {\n\t\t\tconst encoded: EncodedOptionalChangeset<TAnySchema> = {};\n\n\t\t\tif (change.moves.length > 0) {\n\t\t\t\tencoded.m = change.moves.map(([src, dst]) => [\n\t\t\t\t\tchangeAtomIdCodec.encode(src, context.baseContext),\n\t\t\t\t\tchangeAtomIdCodec.encode(dst, context.baseContext),\n\t\t\t\t]);\n\t\t\t}\n\n\t\t\tif (change.valueReplace !== undefined) {\n\t\t\t\tencoded.r = {\n\t\t\t\t\te: change.valueReplace.isEmpty,\n\t\t\t\t\td: changeAtomIdCodec.encode(change.valueReplace.dst, context.baseContext),\n\t\t\t\t};\n\t\t\t\tif (change.valueReplace.src !== undefined) {\n\t\t\t\t\tencoded.r.s = registerIdCodec.encode(change.valueReplace.src, context.baseContext);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (change.childChanges.length > 0) {\n\t\t\t\tencoded.c = [];\n\t\t\t\tfor (const [id, childChange] of change.childChanges) {\n\t\t\t\t\tencoded.c.push([\n\t\t\t\t\t\tregisterIdCodec.encode(id, context.baseContext),\n\t\t\t\t\t\tcontext.encodeNode(childChange),\n\t\t\t\t\t]);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\treturn encoded;\n\t\t},\n\n\t\tdecode: (\n\t\t\tencoded: EncodedOptionalChangeset<TAnySchema>,\n\t\t\tcontext: FieldChangeDecodingContext,\n\t\t) => {\n\t\t\tconst decoded: Mutable<OptionalChangeset> = {\n\t\t\t\tmoves:\n\t\t\t\t\tencoded.m?.map(([encodedSrc, encodedDst]) => [\n\t\t\t\t\t\tchangeAtomIdCodec.decode(encodedSrc, context.baseContext),\n\t\t\t\t\t\tchangeAtomIdCodec.decode(encodedDst, context.baseContext),\n\t\t\t\t\t]) ?? [],\n\t\t\t\tchildChanges:\n\t\t\t\t\tencoded.c?.map(([id, encodedChange]) => [\n\t\t\t\t\t\tregisterIdCodec.decode(id, context.baseContext),\n\t\t\t\t\t\tcontext.decodeNode(encodedChange),\n\t\t\t\t\t]) ?? [],\n\t\t\t};\n\n\t\t\tif (encoded.r !== undefined) {\n\t\t\t\tconst replace: Mutable<Replace> = {\n\t\t\t\t\tisEmpty: encoded.r.e,\n\t\t\t\t\tdst: changeAtomIdCodec.decode(encoded.r.d, context.baseContext),\n\t\t\t\t};\n\t\t\t\tif (encoded.r.s !== undefined) {\n\t\t\t\t\treplace.src = registerIdCodec.decode(encoded.r.s, context.baseContext);\n\t\t\t\t}\n\t\t\t\tdecoded.valueReplace = replace;\n\t\t\t}\n\t\t\treturn decoded;\n\t\t},\n\t\tencodedSchema: EncodedOptionalChangeset(EncodedNodeChangeset),\n\t};\n}\n"]}

package/dist/feature-libraries/optional-field/optionalFieldCodecs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"optionalFieldCodecs.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAmB,MAAM,sBAAsB,CAAC;AAC9F,OAAO,KAAK,EACX,qBAAqB,EACrB,WAAW,EACX,iBAAiB,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACX,0BAA0B,EAC1B,0BAA0B,EAC1B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAGvE,eAAO,MAAM,4BAA4B,qBACtB,cACjB,WAAW,EACX,wBAAwB,EACxB,qBAAqB,CACrB,KACC,aAAa,iBAAiB,EAAE,0BAA0B,EAAE,0BAA0B,CACnC,CAAC"}
+{"version":3,"file":"optionalFieldCodecs.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/optional-field/optionalFieldCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,aAAa,EAAmB,MAAM,sBAAsB,CAAC;AAC9F,OAAO,KAAK,EACX,qBAAqB,EACrB,WAAW,EACX,iBAAiB,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACX,0BAA0B,EAC1B,0BAA0B,EAC1B,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAGvE,eAAO,MAAM,4BAA4B,GACxC,kBAAkB,aAAa,CAC9B,WAAW,EACX,OAAO,iBAAiB,EACxB,qBAAqB,CACrB,KACC,YAAY,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,0BAA0B,CACnC,CAAC"}

package/dist/feature-libraries/schema-edits/schemaChangeCodecs.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeSchemaChangeCodec = void 0;
+exports.makeSchemaChangeCodec = makeSchemaChangeCodec;
 const internal_1 = require("@fluidframework/core-utils/internal");
 const index_js_1 = require("../schema-index/index.js");
 const schemaChangeFormat_js_1 = require("./schemaChangeFormat.js");
@@ -35,5 +35,4 @@ function makeSchemaChangeCodec(options) {
         encodedSchema: schemaChangeFormat_js_1.EncodedSchemaChange,
     };
 }
-exports.makeSchemaChangeCodec = makeSchemaChangeCodec;
 //# sourceMappingURL=schemaChangeCodecs.js.map

package/dist/feature-libraries/schema-edits/schemaChangeCodecs.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemaChangeCodecs.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-edits/schemaChangeCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAG7D,uDAA8D;AAE9D,mEAA8D;AAG9D;;;;GAIG;AACH,SAAgB,qBAAqB,CACpC,OAA0B;IAE1B,MAAM,WAAW,GAAG,6BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtD,OAAO;QACN,MAAM,EAAE,CAAC,YAA0B,EAAuB,EAAE;YAC3D,IAAA,iBAAM,EACL,CAAC,YAAY,CAAC,SAAS,EACvB,KAAK,CAAC,wDAAwD,CAC9D,CAAC;YACF,OAAO;gBACN,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;gBAChD,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;aAChD,CAAC;QACH,CAAC;QACD,MAAM,EAAE,CAAC,OAA4B,EAAgB,EAAE;YACtD,OAAO;gBACN,MAAM,EAAE;oBACP,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;oBACpC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;iBACpC;gBACD,SAAS,EAAE,KAAK;aAChB,CAAC;QACH,CAAC;QACD,aAAa,EAAE,2CAAmB;KAClC,CAAC;AACH,CAAC;AA1BD,sDA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport type { CodecWriteOptions, JsonCodecPart } from \"../../codec/index.js\";\nimport { schemaCodecBuilder } from \"../schema-index/index.js\";\n\nimport { EncodedSchemaChange } from \"./schemaChangeFormat.js\";\nimport type { SchemaChange } from \"./schemaChangeTypes.js\";\n\n/**\n * Creates a codec for schema changes.\n * @param options - The codec options.\n * @returns The composed schema change codec part.\n */\nexport function makeSchemaChangeCodec(\n\toptions: CodecWriteOptions,\n): JsonCodecPart<SchemaChange, typeof EncodedSchemaChange> {\n\tconst schemaCodec = schemaCodecBuilder.build(options);\n\treturn {\n\t\tencode: (schemaChange: SchemaChange): EncodedSchemaChange => {\n\t\t\tassert(\n\t\t\t\t!schemaChange.isInverse,\n\t\t\t\t0x933 /* Inverse schema changes should never be transmitted */,\n\t\t\t);\n\t\t\treturn {\n\t\t\t\tnew: schemaCodec.encode(schemaChange.schema.new),\n\t\t\t\told: schemaCodec.encode(schemaChange.schema.old),\n\t\t\t};\n\t\t},\n\t\tdecode: (encoded: EncodedSchemaChange): SchemaChange => {\n\t\t\treturn {\n\t\t\t\tschema: {\n\t\t\t\t\tnew: schemaCodec.decode(encoded.new),\n\t\t\t\t\told: schemaCodec.decode(encoded.old),\n\t\t\t\t},\n\t\t\t\tisInverse: false,\n\t\t\t};\n\t\t},\n\t\tencodedSchema: EncodedSchemaChange,\n\t};\n}\n"]}
+{"version":3,"file":"schemaChangeCodecs.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-edits/schemaChangeCodecs.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAeH,sDA0BC;AAvCD,kEAA6D;AAG7D,uDAA8D;AAE9D,mEAA8D;AAG9D;;;;GAIG;AACH,SAAgB,qBAAqB,CACpC,OAA0B;IAE1B,MAAM,WAAW,GAAG,6BAAkB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtD,OAAO;QACN,MAAM,EAAE,CAAC,YAA0B,EAAuB,EAAE;YAC3D,IAAA,iBAAM,EACL,CAAC,YAAY,CAAC,SAAS,EACvB,KAAK,CAAC,wDAAwD,CAC9D,CAAC;YACF,OAAO;gBACN,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;gBAChD,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;aAChD,CAAC;QACH,CAAC;QACD,MAAM,EAAE,CAAC,OAA4B,EAAgB,EAAE;YACtD,OAAO;gBACN,MAAM,EAAE;oBACP,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;oBACpC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;iBACpC;gBACD,SAAS,EAAE,KAAK;aAChB,CAAC;QACH,CAAC;QACD,aAAa,EAAE,2CAAmB;KAClC,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport type { CodecWriteOptions, JsonCodecPart } from \"../../codec/index.js\";\nimport { schemaCodecBuilder } from \"../schema-index/index.js\";\n\nimport { EncodedSchemaChange } from \"./schemaChangeFormat.js\";\nimport type { SchemaChange } from \"./schemaChangeTypes.js\";\n\n/**\n * Creates a codec for schema changes.\n * @param options - The codec options.\n * @returns The composed schema change codec part.\n */\nexport function makeSchemaChangeCodec(\n\toptions: CodecWriteOptions,\n): JsonCodecPart<SchemaChange, typeof EncodedSchemaChange> {\n\tconst schemaCodec = schemaCodecBuilder.build(options);\n\treturn {\n\t\tencode: (schemaChange: SchemaChange): EncodedSchemaChange => {\n\t\t\tassert(\n\t\t\t\t!schemaChange.isInverse,\n\t\t\t\t0x933 /* Inverse schema changes should never be transmitted */,\n\t\t\t);\n\t\t\treturn {\n\t\t\t\tnew: schemaCodec.encode(schemaChange.schema.new),\n\t\t\t\told: schemaCodec.encode(schemaChange.schema.old),\n\t\t\t};\n\t\t},\n\t\tdecode: (encoded: EncodedSchemaChange): SchemaChange => {\n\t\t\treturn {\n\t\t\t\tschema: {\n\t\t\t\t\tnew: schemaCodec.decode(encoded.new),\n\t\t\t\t\told: schemaCodec.decode(encoded.old),\n\t\t\t\t},\n\t\t\t\tisInverse: false,\n\t\t\t};\n\t\t},\n\t\tencodedSchema: EncodedSchemaChange,\n\t};\n}\n"]}

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

@@ -44,6 +44,9 @@ function minVersionToSchemaSummaryFormatVersion(version) {
  * Provides methods for summarizing and loading a schema repository.
  */
 class SchemaSummarizer extends index_js_2.VersionedSummarizer {
+    schema;
+    codec;
+    schemaIndexLastChangedSeq;
     constructor(schema, collabWindow, codec, minVersionForCollab) {
         super("Schema", minVersionToSchemaSummaryFormatVersion(minVersionForCollab), supportedVersions, true /* supportPreVersioningFormat */);
         this.schema = schema;

package/dist/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,+DAA8D;AAC9D,kEAA6D;AAE7D,2EAAiE;AASjE,kDAI6B;AAC7B,8DAKyC;AAG5B,QAAA,eAAe,GAAG,cAAc,CAAC;AAE9C;;GAEG;AACH,IAAkB,0BAajB;AAbD,WAAkB,0BAA0B;IAC3C;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,iFAAY,CAAA;AACb,CAAC,EAbiB,0BAA0B,0CAA1B,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,MAAa,gBACZ,SAAQ,8BAA+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,uBAAe,EACf,gCAAW,CAAC,IAAI,EAChB,GAAG,yBAAyB,CAAC,WAAW,IAAI,uBAAe,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,uBAAe,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,uBAAe,CAAC,CAAC;QAC/E,kEAAkE;QAClE,0EAA0E;QAC1E,iDAAiD;QACjD,IAAA,iBAAM,EACL,IAAA,4BAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,EAC9B,KAAK,CAAC,0EAA0E,CAChF,CAAC;QAEF,MAAM,YAAY,GAAG,IAAA,6BAAc,EAAC,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;AAtED,4CAsEC","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,+DAA8D;AAC9D,kEAA6D;AAE7D,2EAAiE;AASjE,kDAI6B;AAC7B,8DAKyC;AAG5B,QAAA,eAAe,GAAG,cAAc,CAAC;AAE9C;;GAEG;AACH,IAAkB,0BAajB;AAbD,WAAkB,0BAA0B;IAC3C;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,uEAAM,CAAA;IACN;;OAEG;IACH,iFAAY,CAAA;AACb,CAAC,EAbiB,0BAA0B,0CAA1B,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,MAAa,gBACZ,SAAQ,8BAA+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,uBAAe,EACf,gCAAW,CAAC,IAAI,EAChB,GAAG,yBAAyB,CAAC,WAAW,IAAI,uBAAe,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,uBAAe,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,uBAAe,CAAC,CAAC;QAC/E,kEAAkE;QAClE,0EAA0E;QAC1E,iDAAiD;QACjD,IAAA,iBAAM,EACL,IAAA,4BAAiB,EAAC,IAAI,CAAC,MAAM,CAAC,EAC9B,KAAK,CAAC,0EAA0E,CAChF,CAAC;QAEF,MAAM,YAAY,GAAG,IAAA,6BAAc,EAAC,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;AAtED,4CAsEC","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/dist/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/dist/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/dist/feature-libraries/schemaChecker.js

@@ -4,7 +4,11 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compliesWithMultiplicity = exports.isFieldInSchema = exports.isNodeInSchema = exports.throwOutOfSchema = exports.SchemaValidationError = void 0;
+exports.SchemaValidationError = void 0;
+exports.throwOutOfSchema = throwOutOfSchema;
+exports.isNodeInSchema = isNodeInSchema;
+exports.isFieldInSchema = isFieldInSchema;
+exports.compliesWithMultiplicity = compliesWithMultiplicity;
 const internal_1 = require("@fluidframework/core-utils/internal");
 const internal_2 = require("@fluidframework/telemetry-utils/internal");
 const index_js_1 = require("../core/index.js");
@@ -26,45 +30,107 @@ var SchemaValidationError;
 /**
  * Throws a UsageError indicating a tree is out of schema.
  */
-function throwOutOfSchema(maybeError, context) {
-    throw new internal_2.UsageError(formatSchemaValidationError(maybeError, context));
+function throwOutOfSchema(details) {
+    const message = `Tree does not conform to schema. ${getSchemaValidationErrorMessage(details.error)}`;
+    throw new internal_2.UsageError((0, internal_1.appendDebugMessage)(message, () => getSchemaValidationDebugMessage(details)), {
+        ...(0, internal_2.tagSchemaArtifacts)({
+            schemaValidationError: SchemaValidationError[details.error],
+            schemaValidationPath: JSON.stringify(details.path),
+        }),
+        ...details.telemetryProperties,
+    });
 }
-exports.throwOutOfSchema = throwOutOfSchema;
-// 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 (0, internal_1.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 (0, internal_1.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.
  *
@@ -76,28 +142,41 @@ 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, (0, internal_2.tagSchemaArtifacts)({ nodeType: node.type })));
     }
     // Validate the node is well formed according to its schema
     if (schema instanceof index_js_1.LeafNodeStoredSchema) {
         if ((0, index_js_2.iterableHasSome)(node.fields)) {
-            return onError(SchemaValidationError.LeafNode_FieldsNotAllowed);
+            const unexpectedFields = [...(0, index_js_2.mapIterable)(node.fields, ([key]) => key)].sort();
+            return onError(schemaValidationError(SchemaValidationError.LeafNode_FieldsNotAllowed, {
+                ...(0, internal_2.tagSchemaArtifacts)({
+                    nodeType: node.type,
+                    unexpectedFields: JSON.stringify(unexpectedFields),
+                }),
+            }));
         }
         if (!(0, valueUtilities_js_1.allowsValue)(schema.leafValue, node.value)) {
-            return onError(SchemaValidationError.LeafNode_InvalidValue);
+            return onError(schemaValidationError(SchemaValidationError.LeafNode_InvalidValue, {
+                ...(0, internal_2.tagSchemaArtifacts)({
+                    nodeType: node.type,
+                    expectedValueType: index_js_1.ValueSchema[schema.leafValue],
+                }),
+                actualValueType: getValueType(node.value),
+            }));
         }
     }
     else {
         if (node.value !== undefined) {
-            return onError(SchemaValidationError.NonLeafNode_ValueNotAllowed);
+            return onError(schemaValidationError(SchemaValidationError.NonLeafNode_ValueNotAllowed, {
+                ...(0, internal_2.tagSchemaArtifacts)({ nodeType: node.type }),
+                actualValueType: getValueType(node.value),
+            }));
         }
         if (schema instanceof index_js_1.ObjectNodeStoredSchema) {
             const uncheckedFieldsFromNode = new Set((0, index_js_2.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;
                 }
@@ -108,15 +187,17 @@ 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, {
+                    ...(0, internal_2.tagSchemaArtifacts)({
+                        nodeType: node.type,
+                        unexpectedFields: JSON.stringify([...uncheckedFieldsFromNode].sort()),
+                    }),
+                }));
             }
         }
         else if (schema instanceof index_js_1.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;
                 }
@@ -128,7 +209,6 @@ function isNodeInSchema(node, schemaAndPolicy, onError) {
     }
     return undefined;
 }
-exports.isNodeInSchema = isNodeInSchema;
 /**
  * Deeply checks that the nodes comply with the field schema and included schema.
  *
@@ -140,32 +220,37 @@ 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, (0, internal_2.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, {
+                ...(0, internal_2.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, (0, internal_2.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;
 }
-exports.isFieldInSchema = isFieldInSchema;
 /**
  * Validates that a given number of items complies with the specified {@link Multiplicity | multiplicity}.
  * @param numberOfItems - Number of items.
@@ -203,5 +288,4 @@ function compliesWithMultiplicity(numberOfItems, multiplicity) {
         }
     }
 }
-exports.compliesWithMultiplicity = compliesWithMultiplicity;
 //# sourceMappingURL=schemaChecker.js.map