@fluidframework/tree 2.74.0-370705 → 2.80.0

package/lib/feature-libraries/modular-schema/modularChangeCodecV1.d.ts

@@ -2,16 +2,48 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { type ICodecOptions, type IJsonCodec, type IMultiFormatCodec } from "../../codec/index.js";
-import { type ChangeEncodingContext, type EncodedRevisionTag, type RevisionTag } from "../../core/index.js";
-import { type JsonCompatibleReadOnly } from "../../util/index.js";
-import { type FieldBatchCodec } from "../chunked-forest/index.js";
+import type { TAnySchema } from "@sinclair/typebox";
+import { type ICodecOptions, type IJsonCodec, type IMultiFormatCodec, type SchemaValidationFunction } from "../../codec/index.js";
+import type { ChangeEncodingContext, EncodedRevisionTag, FieldKindIdentifier, RevisionInfo, RevisionTag } from "../../core/index.js";
+import { type IdAllocator, type JsonCompatibleReadOnly, type Mutable } from "../../util/index.js";
+import { type FieldBatchCodec, type TreeChunk } from "../chunked-forest/index.js";
 import { TreeCompressionStrategy } from "../treeCompressionUtils.js";
-import type { FieldKindConfiguration } from "./fieldKindConfiguration.js";
-import { type FieldChangeset, type ModularChangeset } from "./modularChangeTypes.js";
-import { EncodedModularChangeset } from "./modularChangeFormatV1.js";
 import type { FieldChangeEncodingContext } from "./fieldChangeHandler.js";
-export type ModularChangeCodec = IJsonCodec<ModularChangeset, EncodedModularChangeset, EncodedModularChangeset, ChangeEncodingContext>;
-export type FieldCodec = IMultiFormatCodec<FieldChangeset, JsonCompatibleReadOnly, JsonCompatibleReadOnly, FieldChangeEncodingContext>;
+import type { FieldKindConfiguration } from "./fieldKindConfiguration.js";
+import { type EncodedBuilds, type EncodedFieldChangeMap, EncodedModularChangesetV1, type EncodedNodeChangeset, type EncodedRevisionInfo } from "./modularChangeFormatV1.js";
+import { type FieldChangeset, type FieldChangeMap, type ModularChangeset, type NodeChangeset, type NodeId } from "./modularChangeTypes.js";
+import type { ChangeAtomIdBTree } from "../changeAtomIdBTree.js";
+type ModularChangeCodec = IJsonCodec<ModularChangeset, EncodedModularChangesetV1, EncodedModularChangesetV1, ChangeEncodingContext>;
+type FieldCodec = IMultiFormatCodec<FieldChangeset, JsonCompatibleReadOnly, JsonCompatibleReadOnly, FieldChangeEncodingContext>;
+type FieldChangesetCodecs = Map<FieldKindIdentifier, {
+    compiledSchema?: SchemaValidationFunction<TAnySchema>;
+    codec: FieldCodec;
+}>;
+export declare function getFieldChangesetCodec(fieldKind: FieldKindIdentifier, fieldChangesetCodecs: FieldChangesetCodecs): {
+    compiledSchema?: SchemaValidationFunction<TAnySchema>;
+    codec: FieldCodec;
+};
+export declare function encodeFieldChangesForJson(change: FieldChangeMap, context: ChangeEncodingContext, nodeChanges: ChangeAtomIdBTree<NodeChangeset>, fieldChangesetCodecs: FieldChangesetCodecs): EncodedFieldChangeMap;
+export declare function encodeFieldChangesForJsonI(change: FieldChangeMap, context: FieldChangeEncodingContext, fieldChangesetCodecs: FieldChangesetCodecs): EncodedFieldChangeMap;
+export declare function encodeNodeChangesForJson(change: NodeChangeset, context: FieldChangeEncodingContext, fieldChangesetCodecs: FieldChangesetCodecs): EncodedNodeChangeset;
+export declare function decodeFieldChangesFromJson(encodedChange: EncodedFieldChangeMap, parentId: NodeId | undefined, decoded: ModularChangeset, context: ChangeEncodingContext, idAllocator: IdAllocator, fieldKinds: FieldKindConfiguration, fieldChangesetCodecs: FieldChangesetCodecs): FieldChangeMap;
+export declare function decodeNodeChangesetFromJson(encodedChange: EncodedNodeChangeset, id: NodeId, decoded: ModularChangeset, context: ChangeEncodingContext, idAllocator: IdAllocator, fieldKinds: FieldKindConfiguration, fieldChangesetCodecs: FieldChangesetCodecs): NodeChangeset;
+export declare function encodeDetachedNodes(detachedNodes: ChangeAtomIdBTree<TreeChunk> | undefined, context: ChangeEncodingContext, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, fieldsCodec: FieldBatchCodec, chunkCompressionStrategy: TreeCompressionStrategy): EncodedBuilds | undefined;
+export declare function decodeDetachedNodes(encoded: EncodedBuilds | undefined, context: ChangeEncodingContext, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, fieldsCodec: FieldBatchCodec, chunkCompressionStrategy: TreeCompressionStrategy): ChangeAtomIdBTree<TreeChunk> | undefined;
+export declare function encodeRevisionInfos(revisions: readonly RevisionInfo[], context: ChangeEncodingContext, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>): EncodedRevisionInfo[] | undefined;
+export declare function decodeRevisionInfos(revisions: readonly EncodedRevisionInfo[] | undefined, context: ChangeEncodingContext, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>): RevisionInfo[] | undefined;
+export declare function encodeChange(change: ModularChangeset, context: ChangeEncodingContext, fieldChangesetCodecs: Map<FieldKindIdentifier, {
+    compiledSchema?: SchemaValidationFunction<TAnySchema>;
+    codec: FieldCodec;
+}>, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, fieldsCodec: FieldBatchCodec, chunkCompressionStrategy: TreeCompressionStrategy): EncodedModularChangesetV1;
+export declare function decodeChange(encodedChange: EncodedModularChangesetV1, context: ChangeEncodingContext, fieldKinds: FieldKindConfiguration, fieldChangesetCodecs: Map<FieldKindIdentifier, {
+    compiledSchema?: SchemaValidationFunction<TAnySchema>;
+    codec: FieldCodec;
+}>, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, fieldsCodec: FieldBatchCodec, chunkCompressionStrategy: TreeCompressionStrategy): Mutable<ModularChangeset>;
+export declare function getFieldChangesetCodecs(fieldKinds: FieldKindConfiguration, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, codecOptions: ICodecOptions): Map<FieldKindIdentifier, {
+    compiledSchema?: SchemaValidationFunction<TAnySchema>;
+    codec: FieldCodec;
+}>;
 export declare function makeModularChangeCodecV1(fieldKinds: FieldKindConfiguration, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag, EncodedRevisionTag, ChangeEncodingContext>, fieldsCodec: FieldBatchCodec, codecOptions: ICodecOptions, chunkCompressionStrategy?: TreeCompressionStrategy): ModularChangeCodec;
+export {};
 //# sourceMappingURL=modularChangeCodecV1.d.ts.map

package/lib/feature-libraries/modular-schema/modularChangeCodecV1.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"modularChangeCodecV1.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/modular-schema/modularChangeCodecV1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAGN,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,iBAAiB,EAEtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAIN,KAAK,qBAAqB,EAE1B,KAAK,kBAAkB,EAKvB,KAAK,WAAW,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAKN,KAAK,sBAAsB,EAK3B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAGN,KAAK,eAAe,EAEpB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EACX,sBAAsB,EAEtB,MAAM,6BAA6B,CAAC;AAQrC,OAAO,EAMN,KAAK,cAAc,EAEnB,KAAK,gBAAgB,EAKrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,uBAAuB,EAOvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,0BAA0B,EAAsB,MAAM,yBAAyB,CAAC;AAI9F,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAC1C,gBAAgB,EAChB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,CACrB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,iBAAiB,CACzC,cAAc,EACd,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,CAC1B,CAAC;AAEF,wBAAgB,wBAAwB,CACvC,UAAU,EAAE,sBAAsB,EAClC,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,YAAY,EAAE,aAAa,EAC3B,wBAAwB,GAAE,uBAA4D,GACpF,kBAAkB,CA2hBpB"}
+{"version":3,"file":"modularChangeCodecV1.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/modular-schema/modularChangeCodecV1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EACN,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAG7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EACX,qBAAqB,EAErB,kBAAkB,EAElB,mBAAmB,EAEnB,YAAY,EACZ,WAAW,EACX,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,KAAK,WAAW,EAChB,KAAK,sBAAsB,EAC3B,KAAK,OAAO,EAIZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,KAAK,eAAe,EACpB,KAAK,SAAS,EAGd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,KAAK,EAAE,0BAA0B,EAAsB,MAAM,yBAAyB,CAAC;AAC9F,OAAO,KAAK,EACX,sBAAsB,EAEtB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EACN,KAAK,aAAa,EAGlB,KAAK,qBAAqB,EAC1B,yBAAyB,EACzB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,KAAK,cAAc,EAEnB,KAAK,cAAc,EAEnB,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,MAAM,EACX,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,KAAK,kBAAkB,GAAG,UAAU,CACnC,gBAAgB,EAChB,yBAAyB,EACzB,yBAAyB,EACzB,qBAAqB,CACrB,CAAC;AAEF,KAAK,UAAU,GAAG,iBAAiB,CAClC,cAAc,EACd,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,CAC1B,CAAC;AAEF,KAAK,oBAAoB,GAAG,GAAG,CAC9B,mBAAmB,EACnB;IACC,cAAc,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC;CAClB,CACD,CAAC;AAEF,wBAAgB,sBAAsB,CACrC,SAAS,EAAE,mBAAmB,EAC9B,oBAAoB,EAAE,oBAAoB,GACxC;IACF,cAAc,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC;CAClB,CAIA;AAED,wBAAgB,yBAAyB,CACxC,MAAM,EAAE,cAAc,EACtB,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,iBAAiB,CAAC,aAAa,CAAC,EAC7C,oBAAoB,EAAE,oBAAoB,GACxC,qBAAqB,CAcvB;AAED,wBAAgB,0BAA0B,CACzC,MAAM,EAAE,cAAc,EACtB,OAAO,EAAE,0BAA0B,EACnC,oBAAoB,EAAE,oBAAoB,GACxC,qBAAqB,CAwBvB;AAED,wBAAgB,wBAAwB,CACvC,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,0BAA0B,EACnC,oBAAoB,EAAE,oBAAoB,GACxC,oBAAoB,CAkBtB;AAED,wBAAgB,0BAA0B,CACzC,aAAa,EAAE,qBAAqB,EACpC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,sBAAsB,EAClC,oBAAoB,EAAE,oBAAoB,GACxC,cAAc,CA8DhB;AAED,wBAAgB,2BAA2B,CAC1C,aAAa,EAAE,oBAAoB,EACnC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,sBAAsB,EAClC,oBAAoB,EAAE,oBAAoB,GACxC,aAAa,CAqBf;AAED,wBAAgB,mBAAmB,CAClC,aAAa,EAAE,iBAAiB,CAAC,SAAS,CAAC,GAAG,SAAS,EACvD,OAAO,EAAE,qBAAqB,EAC9B,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,wBAAwB,EAAE,uBAAuB,GAC/C,aAAa,GAAG,SAAS,CA4C3B;AAED,wBAAgB,mBAAmB,CAClC,OAAO,EAAE,aAAa,GAAG,SAAS,EAClC,OAAO,EAAE,qBAAqB,EAC9B,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,wBAAwB,EAAE,uBAAuB,GAC/C,iBAAiB,CAAC,SAAS,CAAC,GAAG,SAAS,CAmC1C;AAED,wBAAgB,mBAAmB,CAClC,SAAS,EAAE,SAAS,YAAY,EAAE,EAClC,OAAO,EAAE,qBAAqB,EAC9B,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,GACC,mBAAmB,EAAE,GAAG,SAAS,CA2BnC;AAED,wBAAgB,mBAAmB,CAClC,SAAS,EAAE,SAAS,mBAAmB,EAAE,GAAG,SAAS,EACrD,OAAO,EAAE,qBAAqB,EAC9B,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,GACC,YAAY,EAAE,GAAG,SAAS,CAmB5B;AAED,wBAAgB,YAAY,CAC3B,MAAM,EAAE,gBAAgB,EACxB,OAAO,EAAE,qBAAqB,EAC9B,oBAAoB,EAAE,GAAG,CACxB,mBAAmB,EACnB;IACC,cAAc,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC;CAClB,CACD,EACD,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,wBAAwB,EAAE,uBAAuB,GAC/C,yBAAyB,CA+B3B;AAED,wBAAgB,YAAY,CAC3B,aAAa,EAAE,yBAAyB,EACxC,OAAO,EAAE,qBAAqB,EAC9B,UAAU,EAAE,sBAAsB,EAClC,oBAAoB,EAAE,GAAG,CACxB,mBAAmB,EACnB;IACC,cAAc,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACtD,KAAK,EAAE,UAAU,CAAC;CAClB,CACD,EACD,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,wBAAwB,EAAE,uBAAuB,GAC/C,OAAO,CAAC,gBAAgB,CAAC,CAsD3B;AAED,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,sBAAsB,EAClC,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,YAAY,EAAE,aAAa,GACzB,GAAG,CACL,mBAAmB,EACnB;IAAE,cAAc,CAAC,EAAE,wBAAwB,CAAC,UAAU,CAAC,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,CAC5E,CAkCA;AAED,wBAAgB,wBAAwB,CACvC,UAAU,EAAE,sBAAsB,EAClC,gBAAgB,EAAE,UAAU,CAC3B,WAAW,EACX,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,CACrB,EACD,WAAW,EAAE,eAAe,EAC5B,YAAY,EAAE,aAAa,EAC3B,wBAAwB,GAAE,uBAA4D,GACpF,kBAAkB,CAkCpB"}