@fluidframework/tree 2.91.0 → 2.93.0

package/lib/feature-libraries/chunked-forest/codec/format/formatV1.d.ts

@@ -0,0 +1,187 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type Static } from "@sinclair/typebox";
+/**
+ * Top level length is implied from length of data array.
+ * All content are of this shape.
+ */
+export type EncodedNestedArrayShape = Static<typeof EncodedNestedArrayShape>;
+export declare const EncodedNestedArrayShape: import("@sinclair/typebox").TNumber;
+/**
+ * Inline array.
+ */
+export type EncodedInlineArrayShape = Static<typeof EncodedInlineArrayShape>;
+export declare const EncodedInlineArrayShape: import("@sinclair/typebox").TObject<{
+    length: import("@sinclair/typebox").TNumber;
+    /**
+     * All entries are this shape.
+     */
+    shape: import("@sinclair/typebox").TNumber;
+}>;
+/**
+ * Encoded as `shape, ...[data for shape]`.
+ *
+ * Used for polymorphism.
+ */
+export type EncodedAnyShape = Static<typeof EncodedAnyShape>;
+export declare const EncodedAnyShape: import("@sinclair/typebox").TLiteral<0>;
+/**
+ * Content of the encoded field is specified by the Shape referenced by the ShapeIndex.
+ * This is a tuple for conciseness.
+ */
+export type EncodedFieldShape = Static<typeof EncodedFieldShape>;
+export declare const EncodedFieldShape: import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>;
+/**
+ * Used in {@link EncodedValueShape} for special field kind handling.
+ */
+export declare enum SpecialField {
+    /**
+     * Special case for Identifier field kind.
+     */
+    Identifier = 0
+}
+/**
+ * Shape of a value on a node.
+ *
+ * Due to limitations of TypeBox and differences between JavaScript objects, TypeScript types and JSON,
+ * the case where no information about the value is captured in the shape is a bit confusing.
+ * In TypeBox this is allowed by the user of this type putting it in an optional property.
+ * In TypeScript it is modeled using `undefined`.
+ * In JavaScript the property may be missing or explicitly `undefined`.
+ * In JSON this will serialize as the property being omitted.
+ * In this case, the value will be encoded as either:
+ * - `false` (when there is no value) OR
+ * - `true, value` when there is a value.
+ *
+ * For a more compact encoding, there are 4 options for the shape:
+ * - `true`: there is a value, and it will simply be encoded by putting it in the output buffer (so `value`).
+ * - `false`: there is never a value, and it takes up no space in the output buffer.
+ * - `[value]`: there is a value, and its always the same.
+ * - `SpecialField.Identifier`: special case for node identifier handling.
+ * Takes up no space in the output buffer: the value comes from the shape arrays's content.
+ * It is wrapped in an array to differentiate value shape types.
+ *
+ * In the future other value shape formats may be added, likely as objects.
+ *
+ * @remarks
+ * See {@link EncodedNodeShape} for usage.
+ */
+export declare const EncodedValueShape: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof SpecialField>]>;
+export type EncodedValueShape = undefined | Static<typeof EncodedValueShape>;
+/**
+ * The encoded form of a {@link Shape} for a node.
+ */
+export type EncodedNodeShape = Static<typeof EncodedNodeShape>;
+export declare const EncodedNodeShape: import("@sinclair/typebox").TObject<{
+    /**
+     * If not provided, inlined in data.
+     */
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>>;
+    value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof SpecialField>]>>;
+    /**
+     * Fields with fixed (per key) shapes.
+     * They are encoded in the order they are specified here.
+     * To ensure the order is preserved, this is an array instead of an object with keys.
+     */
+    fields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>>>;
+    /**
+     * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+     * Covers any fields beyond those in `fields`.
+     */
+    extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>;
+/**
+ * The chunk shapes supported by the V1 format.
+ * @remarks
+ * See {@link EncodedChunkShapeV1}.
+ */
+export declare const shapesV1: {
+    /**
+     * {@link EncodedNestedArrayShape} union member.
+     */
+    readonly a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    /**
+     * {@link EncodedInlineArrayShape} union member.
+     */
+    readonly b: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        length: import("@sinclair/typebox").TNumber;
+        /**
+         * All entries are this shape.
+         */
+        shape: import("@sinclair/typebox").TNumber;
+    }>>;
+    /**
+     * {@link EncodedNodeShape} union member.
+     */
+    readonly c: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        /**
+         * If not provided, inlined in data.
+         */
+        type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>>;
+        value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof SpecialField>]>>;
+        /**
+         * Fields with fixed (per key) shapes.
+         * They are encoded in the order they are specified here.
+         * To ensure the order is preserved, this is an array instead of an object with keys.
+         */
+        fields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>>>;
+        /**
+         * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+         * Covers any fields beyond those in `fields`.
+         */
+        extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+    /**
+     * {@link EncodedAnyShape} union member.
+     */
+    readonly d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+};
+/**
+ * Discriminated union that represents the shapes of chunks in the encoded data.
+ * "Chunk" here refers to a chunk of tree data, rooted at a range of nodes, that is encoded as a
+ * single unit in a specific format represented by one of the shapes in this union.
+ *
+ * The concept of "chunk" is same for the tree data in memory and in the encoded wire format.
+ * The physical representation of the chunk may differ, but the logical structure remains the same.
+ * This is similar to other such concepts in the system.
+ *
+ * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.
+ * @privateRemarks
+ * Because the TypeScript types for how we model these unions don't require exactly one property,
+ * to prevent a union with more options from being assignable to this one, we include Never.
+ * This matters in this case because the V2 format only differs in that it has another entry in this Union.
+ */
+export type EncodedChunkShapeV1 = Static<typeof EncodedChunkShapeV1>;
+export declare const EncodedChunkShapeV1: import("@sinclair/typebox").TObject<{
+    e: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNever>;
+    a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    b: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        length: import("@sinclair/typebox").TNumber;
+        /**
+         * All entries are this shape.
+         */
+        shape: import("@sinclair/typebox").TNumber;
+    }>>;
+    c: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        /**
+         * If not provided, inlined in data.
+         */
+        type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>>;
+        value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof SpecialField>]>>;
+        /**
+         * Fields with fixed (per key) shapes.
+         * They are encoded in the order they are specified here.
+         * To ensure the order is preserved, this is an array instead of an object with keys.
+         */
+        fields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>>>;
+        /**
+         * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+         * Covers any fields beyond those in `fields`.
+         */
+        extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+    d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+}>;
+//# sourceMappingURL=formatV1.d.ts.map

package/lib/feature-libraries/chunked-forest/codec/format/formatV1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatV1.d.ts","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/formatV1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAMtD;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC7E,eAAO,MAAM,uBAAuB,qCAAa,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC7E,eAAO,MAAM,uBAAuB;;IAGlC;;OAEG;;EAIJ,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AAC7D,eAAO,MAAM,eAAe,yCAAkB,CAAC;AAE/C;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AACjE,eAAO,MAAM,iBAAiB,2LAS5B,CAAC;AAEH;;GAEG;AACH,oBAAY,YAAY;IACvB;;OAEG;IACH,UAAU,IAAI;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,iBAAiB,0MAM5B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC/D,eAAO,MAAM,gBAAgB;IAE3B;;OAEG;;;IAGH;;;;OAIG;;IAEH;;;OAGG;;EAIJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,QAAQ;IACpB;;OAEG;;IAEH;;OAEG;;;QAnHF;;WAEG;;;IAmHJ;;OAEG;;QApCF;;WAEG;;;QAGH;;;;WAIG;;QAEH;;;WAGG;;;IAwBJ;;OAEG;;CAEM,CAAC;AAEX;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACrE,eAAO,MAAM,mBAAmB;;;;;QA/I9B;;WAEG;;;;QAiFH;;WAEG;;;QAGH;;;;WAIG;;QAEH;;;WAGG;;;;EAiDJ,CAAC"}

package/lib/feature-libraries/chunked-forest/codec/format/formatV1.js

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Type } from "@sinclair/typebox";
+import { unionOptions } from "../../../../codec/index.js";
+import { Count, IdentifierOrIndex, ShapeIndex } from "./formatGeneric.js";
+export const EncodedNestedArrayShape = ShapeIndex;
+export const EncodedInlineArrayShape = Type.Object({
+    length: Count,
+    /**
+     * All entries are this shape.
+     */
+    shape: ShapeIndex,
+}, { additionalProperties: false });
+export const EncodedAnyShape = Type.Literal(0);
+export const EncodedFieldShape = Type.Tuple([
+    /**
+     * Field key for this field.
+     */
+    IdentifierOrIndex,
+    /**
+     * Shape of data in this field.
+     */
+    ShapeIndex,
+]);
+/**
+ * Used in {@link EncodedValueShape} for special field kind handling.
+ */
+export var SpecialField;
+(function (SpecialField) {
+    /**
+     * Special case for Identifier field kind.
+     */
+    SpecialField[SpecialField["Identifier"] = 0] = "Identifier";
+})(SpecialField || (SpecialField = {}));
+/**
+ * Shape of a value on a node.
+ *
+ * Due to limitations of TypeBox and differences between JavaScript objects, TypeScript types and JSON,
+ * the case where no information about the value is captured in the shape is a bit confusing.
+ * In TypeBox this is allowed by the user of this type putting it in an optional property.
+ * In TypeScript it is modeled using `undefined`.
+ * In JavaScript the property may be missing or explicitly `undefined`.
+ * In JSON this will serialize as the property being omitted.
+ * In this case, the value will be encoded as either:
+ * - `false` (when there is no value) OR
+ * - `true, value` when there is a value.
+ *
+ * For a more compact encoding, there are 4 options for the shape:
+ * - `true`: there is a value, and it will simply be encoded by putting it in the output buffer (so `value`).
+ * - `false`: there is never a value, and it takes up no space in the output buffer.
+ * - `[value]`: there is a value, and its always the same.
+ * - `SpecialField.Identifier`: special case for node identifier handling.
+ * Takes up no space in the output buffer: the value comes from the shape arrays's content.
+ * It is wrapped in an array to differentiate value shape types.
+ *
+ * In the future other value shape formats may be added, likely as objects.
+ *
+ * @remarks
+ * See {@link EncodedNodeShape} for usage.
+ */
+export const EncodedValueShape = Type.Union([
+    Type.Boolean(),
+    Type.Array(Type.Any(), { minItems: 1, maxItems: 1 }),
+    Type.Enum(SpecialField),
+    // TODO: support delta encoding and/or special node identifier handling
+    // EncodedCounter,
+]);
+export const EncodedNodeShape = Type.Object({
+    /**
+     * If not provided, inlined in data.
+     */
+    type: Type.Optional(IdentifierOrIndex),
+    value: Type.Optional(EncodedValueShape),
+    /**
+     * Fields with fixed (per key) shapes.
+     * They are encoded in the order they are specified here.
+     * To ensure the order is preserved, this is an array instead of an object with keys.
+     */
+    fields: Type.Optional(Type.Array(EncodedFieldShape)),
+    /**
+     * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+     * Covers any fields beyond those in `fields`.
+     */
+    extraFields: Type.Optional(ShapeIndex),
+}, { additionalProperties: false });
+/**
+ * The chunk shapes supported by the V1 format.
+ * @remarks
+ * See {@link EncodedChunkShapeV1}.
+ */
+export const shapesV1 = {
+    /**
+     * {@link EncodedNestedArrayShape} union member.
+     */
+    a: Type.Optional(EncodedNestedArrayShape),
+    /**
+     * {@link EncodedInlineArrayShape} union member.
+     */
+    b: Type.Optional(EncodedInlineArrayShape),
+    /**
+     * {@link EncodedNodeShape} union member.
+     */
+    c: Type.Optional(EncodedNodeShape),
+    /**
+     * {@link EncodedAnyShape} union member.
+     */
+    d: Type.Optional(EncodedAnyShape),
+};
+export const EncodedChunkShapeV1 = Type.Object({ ...shapesV1, e: Type.Optional(Type.Never()) }, unionOptions);
+//# sourceMappingURL=formatV1.js.map

package/lib/feature-libraries/chunked-forest/codec/format/formatV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatV1.js","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/formatV1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAe,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAO1E,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAAC;AAMlD,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CACjD;IACC,MAAM,EAAE,KAAK;IACb;;OAEG;IACH,KAAK,EAAE,UAAU;CACjB,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAQF,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAO/C,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC;IAC3C;;OAEG;IACH,iBAAiB;IACjB;;OAEG;IACH,UAAU;CACV,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,YAKX;AALD,WAAY,YAAY;IACvB;;OAEG;IACH,2DAAc,CAAA;AACf,CAAC,EALW,YAAY,KAAZ,YAAY,QAKvB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC;IAC3C,IAAI,CAAC,OAAO,EAAE;IACd,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACpD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IACvB,uEAAuE;IACvE,kBAAkB;CAClB,CAAC,CAAC;AAOH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAC1C;IACC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACtC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;IACvC;;;;OAIG;IACH,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpD;;;OAGG;IACH,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;CACtC,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACvB;;OAEG;IACH,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IACzC;;OAEG;IACH,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC;IACzC;;OAEG;IACH,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAClC;;OAEG;IACH,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;CACxB,CAAC;AAkBX,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAC7C,EAAE,GAAG,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,EAC/C,YAAY,CACZ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type Static, Type } from \"@sinclair/typebox\";\n\nimport { unionOptions } from \"../../../../codec/index.js\";\n\nimport { Count, IdentifierOrIndex, ShapeIndex } from \"./formatGeneric.js\";\n\n/**\n * Top level length is implied from length of data array.\n * All content are of this shape.\n */\nexport type EncodedNestedArrayShape = Static<typeof EncodedNestedArrayShape>;\nexport const EncodedNestedArrayShape = ShapeIndex;\n\n/**\n * Inline array.\n */\nexport type EncodedInlineArrayShape = Static<typeof EncodedInlineArrayShape>;\nexport const EncodedInlineArrayShape = Type.Object(\n\t{\n\t\tlength: Count,\n\t\t/**\n\t\t * All entries are this shape.\n\t\t */\n\t\tshape: ShapeIndex,\n\t},\n\t{ additionalProperties: false },\n);\n\n/**\n * Encoded as `shape, ...[data for shape]`.\n *\n * Used for polymorphism.\n */\nexport type EncodedAnyShape = Static<typeof EncodedAnyShape>;\nexport const EncodedAnyShape = Type.Literal(0);\n\n/**\n * Content of the encoded field is specified by the Shape referenced by the ShapeIndex.\n * This is a tuple for conciseness.\n */\nexport type EncodedFieldShape = Static<typeof EncodedFieldShape>;\nexport const EncodedFieldShape = Type.Tuple([\n\t/**\n\t * Field key for this field.\n\t */\n\tIdentifierOrIndex,\n\t/**\n\t * Shape of data in this field.\n\t */\n\tShapeIndex,\n]);\n\n/**\n * Used in {@link EncodedValueShape} for special field kind handling.\n */\nexport enum SpecialField {\n\t/**\n\t * Special case for Identifier field kind.\n\t */\n\tIdentifier = 0,\n}\n\n/**\n * Shape of a value on a node.\n *\n * Due to limitations of TypeBox and differences between JavaScript objects, TypeScript types and JSON,\n * the case where no information about the value is captured in the shape is a bit confusing.\n * In TypeBox this is allowed by the user of this type putting it in an optional property.\n * In TypeScript it is modeled using `undefined`.\n * In JavaScript the property may be missing or explicitly `undefined`.\n * In JSON this will serialize as the property being omitted.\n * In this case, the value will be encoded as either:\n * - `false` (when there is no value) OR\n * - `true, value` when there is a value.\n *\n * For a more compact encoding, there are 4 options for the shape:\n * - `true`: there is a value, and it will simply be encoded by putting it in the output buffer (so `value`).\n * - `false`: there is never a value, and it takes up no space in the output buffer.\n * - `[value]`: there is a value, and its always the same.\n * - `SpecialField.Identifier`: special case for node identifier handling.\n * Takes up no space in the output buffer: the value comes from the shape arrays's content.\n * It is wrapped in an array to differentiate value shape types.\n *\n * In the future other value shape formats may be added, likely as objects.\n *\n * @remarks\n * See {@link EncodedNodeShape} for usage.\n */\nexport const EncodedValueShape = Type.Union([\n\tType.Boolean(),\n\tType.Array(Type.Any(), { minItems: 1, maxItems: 1 }),\n\tType.Enum(SpecialField),\n\t// TODO: support delta encoding and/or special node identifier handling\n\t// EncodedCounter,\n]);\nexport type EncodedValueShape = undefined | Static<typeof EncodedValueShape>;\n\n/**\n * The encoded form of a {@link Shape} for a node.\n */\nexport type EncodedNodeShape = Static<typeof EncodedNodeShape>;\nexport const EncodedNodeShape = Type.Object(\n\t{\n\t\t/**\n\t\t * If not provided, inlined in data.\n\t\t */\n\t\ttype: Type.Optional(IdentifierOrIndex),\n\t\tvalue: Type.Optional(EncodedValueShape),\n\t\t/**\n\t\t * Fields with fixed (per key) shapes.\n\t\t * They are encoded in the order they are specified here.\n\t\t * To ensure the order is preserved, this is an array instead of an object with keys.\n\t\t */\n\t\tfields: Type.Optional(Type.Array(EncodedFieldShape)),\n\t\t/**\n\t\t * If undefined, no data. Otherwise, nested array of `[key, ...data]*`\n\t\t * Covers any fields beyond those in `fields`.\n\t\t */\n\t\textraFields: Type.Optional(ShapeIndex),\n\t},\n\t{ additionalProperties: false },\n);\n\n/**\n * The chunk shapes supported by the V1 format.\n * @remarks\n * See {@link EncodedChunkShapeV1}.\n */\nexport const shapesV1 = {\n\t/**\n\t * {@link EncodedNestedArrayShape} union member.\n\t */\n\ta: Type.Optional(EncodedNestedArrayShape),\n\t/**\n\t * {@link EncodedInlineArrayShape} union member.\n\t */\n\tb: Type.Optional(EncodedInlineArrayShape),\n\t/**\n\t * {@link EncodedNodeShape} union member.\n\t */\n\tc: Type.Optional(EncodedNodeShape),\n\t/**\n\t * {@link EncodedAnyShape} union member.\n\t */\n\td: Type.Optional(EncodedAnyShape),\n} as const;\n\n/**\n * Discriminated union that represents the shapes of chunks in the encoded data.\n * \"Chunk\" here refers to a chunk of tree data, rooted at a range of nodes, that is encoded as a\n * single unit in a specific format represented by one of the shapes in this union.\n *\n * The concept of \"chunk\" is same for the tree data in memory and in the encoded wire format.\n * The physical representation of the chunk may differ, but the logical structure remains the same.\n * This is similar to other such concepts in the system.\n *\n * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.\n * @privateRemarks\n * Because the TypeScript types for how we model these unions don't require exactly one property,\n * to prevent a union with more options from being assignable to this one, we include Never.\n * This matters in this case because the V2 format only differs in that it has another entry in this Union.\n */\nexport type EncodedChunkShapeV1 = Static<typeof EncodedChunkShapeV1>;\nexport const EncodedChunkShapeV1 = Type.Object(\n\t{ ...shapesV1, e: Type.Optional(Type.Never()) },\n\tunionOptions,\n);\n"]}

package/lib/feature-libraries/chunked-forest/codec/format/formatV2.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { type Static } from "@sinclair/typebox";
+/**
+ * Encoded content is a {@link ChunkReferenceId}.
+ * This represents the shape of a chunk that is encoded separately and is referenced by its {@link ChunkReferenceId}.
+ */
+export type EncodedIncrementalChunkShape = Static<typeof EncodedIncrementalChunkShape>;
+export declare const EncodedIncrementalChunkShape: import("@sinclair/typebox").TLiteral<0>;
+/**
+ * V2 extension of {@link EncodedChunkShapeV1}.
+ * @remarks
+ * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.
+ */
+export type EncodedChunkShapeV2 = Static<typeof EncodedChunkShapeV2>;
+export declare const EncodedChunkShapeV2: import("@sinclair/typebox").TObject<{
+    e: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+    a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    b: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        length: import("@sinclair/typebox").TNumber;
+        shape: import("@sinclair/typebox").TNumber;
+    }>>;
+    c: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>>;
+        value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof import("./formatV1.js").SpecialField>]>>;
+        fields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>>>;
+        extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+    d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+}>;
+//# sourceMappingURL=formatV2.d.ts.map

package/lib/feature-libraries/chunked-forest/codec/format/formatV2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatV2.d.ts","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/formatV2.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAMtD;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC,OAAO,4BAA4B,CAAC,CAAC;AACvF,eAAO,MAAM,4BAA4B,yCAAkB,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACrE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;EAM/B,CAAC"}

package/lib/feature-libraries/chunked-forest/codec/format/formatV2.js

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Type } from "@sinclair/typebox";
+import { unionOptions } from "../../../../codec/index.js";
+import { shapesV1 } from "./formatV1.js";
+export const EncodedIncrementalChunkShape = Type.Literal(0);
+export const EncodedChunkShapeV2 = Type.Object({
+    ...shapesV1,
+    e: Type.Optional(EncodedIncrementalChunkShape),
+}, unionOptions);
+//# sourceMappingURL=formatV2.js.map

package/lib/feature-libraries/chunked-forest/codec/format/formatV2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatV2.js","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/formatV2.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAe,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAOzC,MAAM,CAAC,MAAM,4BAA4B,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAQ5D,MAAM,CAAC,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAC7C;IACC,GAAG,QAAQ;IACX,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CAAC;CAC9C,EACD,YAAY,CACZ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { type Static, Type } from \"@sinclair/typebox\";\n\nimport { unionOptions } from \"../../../../codec/index.js\";\n\nimport { shapesV1 } from \"./formatV1.js\";\n\n/**\n * Encoded content is a {@link ChunkReferenceId}.\n * This represents the shape of a chunk that is encoded separately and is referenced by its {@link ChunkReferenceId}.\n */\nexport type EncodedIncrementalChunkShape = Static<typeof EncodedIncrementalChunkShape>;\nexport const EncodedIncrementalChunkShape = Type.Literal(0);\n\n/**\n * V2 extension of {@link EncodedChunkShapeV1}.\n * @remarks\n * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.\n */\nexport type EncodedChunkShapeV2 = Static<typeof EncodedChunkShapeV2>;\nexport const EncodedChunkShapeV2 = Type.Object(\n\t{\n\t\t...shapesV1,\n\t\te: Type.Optional(EncodedIncrementalChunkShape),\n\t},\n\tunionOptions,\n);\n"]}

package/lib/feature-libraries/chunked-forest/codec/format/index.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export type { EncodedChunkShapeV1, EncodedInlineArrayShape, EncodedNestedArrayShape, EncodedNodeShape, EncodedValueShape, EncodedFieldShape, } from "./formatV1.js";
+export { EncodedAnyShape, SpecialField, } from "./formatV1.js";
+export { EncodedIncrementalChunkShape, EncodedChunkShapeV2 } from "./formatV2.js";
+export { FieldBatchFormatVersion, EncodedFieldBatchV1, EncodedFieldBatchV2, type EncodedFieldBatchV1OrV2, type EncodedFieldBatchV1AndV2, type EncodedChunkShapeV1OrV2, } from "./versions.js";
+export type { ShapeIndex, IdentifierOrIndex, EncodedFieldBatchGeneric, } from "./formatGeneric.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/feature-libraries/chunked-forest/codec/format/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,mBAAmB,EACnB,uBAAuB,EACvB,uBAAuB,EACvB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,GACjB,MAAM,eAAe,CAAC;AACvB,OAAO,EACN,eAAe,EACf,YAAY,GACZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAClF,OAAO,EACN,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC5B,MAAM,eAAe,CAAC;AACvB,YAAY,EACX,UAAU,EACV,iBAAiB,EACjB,wBAAwB,GACxB,MAAM,oBAAoB,CAAC"}

package/lib/feature-libraries/chunked-forest/codec/format/index.js

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { EncodedAnyShape, SpecialField, } from "./formatV1.js";
+export { EncodedIncrementalChunkShape, EncodedChunkShapeV2 } from "./formatV2.js";
+export { FieldBatchFormatVersion, EncodedFieldBatchV1, EncodedFieldBatchV2, } from "./versions.js";
+//# sourceMappingURL=index.js.map

package/lib/feature-libraries/chunked-forest/codec/format/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,OAAO,EACN,eAAe,EACf,YAAY,GACZ,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAClF,OAAO,EACN,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,GAInB,MAAM,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tEncodedChunkShapeV1,\n\tEncodedInlineArrayShape,\n\tEncodedNestedArrayShape,\n\tEncodedNodeShape,\n\tEncodedValueShape,\n\tEncodedFieldShape,\n} from \"./formatV1.js\";\nexport {\n\tEncodedAnyShape,\n\tSpecialField,\n} from \"./formatV1.js\";\nexport { EncodedIncrementalChunkShape, EncodedChunkShapeV2 } from \"./formatV2.js\";\nexport {\n\tFieldBatchFormatVersion,\n\tEncodedFieldBatchV1,\n\tEncodedFieldBatchV2,\n\ttype EncodedFieldBatchV1OrV2,\n\ttype EncodedFieldBatchV1AndV2,\n\ttype EncodedChunkShapeV1OrV2,\n} from \"./versions.js\";\nexport type {\n\tShapeIndex,\n\tIdentifierOrIndex,\n\tEncodedFieldBatchGeneric,\n} from \"./formatGeneric.js\";\n"]}

package/lib/feature-libraries/chunked-forest/codec/format/versions.d.ts

@@ -0,0 +1,93 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { Static } from "@sinclair/typebox";
+import { type Values } from "../../../../util/index.js";
+import { EncodedChunkShapeV1 } from "./formatV1.js";
+import { EncodedChunkShapeV2 } from "./formatV2.js";
+/**
+ * The format version for the field batch.
+ */
+export type FieldBatchFormatVersion = Values<typeof FieldBatchFormatVersion>;
+export declare const FieldBatchFormatVersion: {
+    readonly v1: import("../../../../util/brand.js").Brand<1, "FieldBatchFormatVersion">;
+    readonly v2: import("../../../../util/brand.js").Brand<2, "FieldBatchFormatVersion">;
+};
+/**
+ * Encoded {@link FieldBatch} using V1 format.
+ * @remarks
+ * Does not support {@link EncodedIncrementalChunkShape}.
+ */
+export type EncodedFieldBatchV1 = Static<typeof EncodedFieldBatchV1>;
+export declare const EncodedFieldBatchV1: import("@sinclair/typebox").TObject<{
+    data: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>>;
+    version: import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TLiteral<FieldBatchFormatVersion>]>;
+    identifiers: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    shapes: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        e: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNever>;
+        a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        b: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            length: import("@sinclair/typebox").TNumber;
+            shape: import("@sinclair/typebox").TNumber;
+        }>>;
+        c: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>>;
+            value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof import("./formatV1.js").SpecialField>]>>;
+            fields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>>>;
+            extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        }>>;
+        d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+    }>>;
+}>;
+/**
+ * Encoded {@link FieldBatch} using V2 format.
+ * @remarks
+ * Adds support for {@link EncodedIncrementalChunkShape}.
+ */
+export type EncodedFieldBatchV2 = Static<typeof EncodedFieldBatchV2>;
+export declare const EncodedFieldBatchV2: import("@sinclair/typebox").TObject<{
+    data: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>>;
+    version: import("@sinclair/typebox").TIntersect<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TLiteral<FieldBatchFormatVersion>]>;
+    identifiers: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    shapes: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        e: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+        a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        b: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            length: import("@sinclair/typebox").TNumber;
+            shape: import("@sinclair/typebox").TNumber;
+        }>>;
+        c: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>>;
+            value: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>, import("@sinclair/typebox").TEnum<typeof import("./formatV1.js").SpecialField>]>>;
+            fields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>, import("@sinclair/typebox").TNumber]>>>;
+            extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        }>>;
+        d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+    }>>;
+}>;
+/**
+ * Encoded {@link FieldBatch}, which might use V2 features, but might also have been from a V1 encoder.
+ * @remarks
+ * Type wise, equivalent to V2, as that is a superset of V1.
+ * Used instead of just V2 for clarity.
+ */
+export type EncodedFieldBatchV1OrV2 = EncodedFieldBatchV1 | EncodedFieldBatchV2;
+/**
+ * Encoded data, compatible with both V1 and V2 formats.
+ * @remarks
+ * This is the intersection of the two versions, which is possible because V2 is a non-breaking extension of V1.
+ * This type can be used when the code is compatible with both versions and does not need to distinguish between them.
+ *
+ * Type wise, equivalent to V1, as that is a subset of V2.
+ * Used instead of just V1 for clarity.
+ */
+export type EncodedFieldBatchV1AndV2 = EncodedFieldBatchV1 & EncodedFieldBatchV2;
+/**
+ * Encoded chunk shape, which might use V2 features, but might also have been from a V1 encoder.
+ * @remarks
+ * Type wise, equivalent to V2, as that is a superset of V1.
+ * Used instead of just V2 for clarity.
+ */
+export type EncodedChunkShapeV1OrV2 = EncodedChunkShapeV1 | EncodedChunkShapeV2;
+//# sourceMappingURL=versions.d.ts.map

package/lib/feature-libraries/chunked-forest/codec/format/versions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/versions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAc,KAAK,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAGpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAC7E,eAAO,MAAM,uBAAuB;;;CAclC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACrE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;EAG/B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACrE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;EAG/B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEjF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG,mBAAmB,CAAC"}

package/lib/feature-libraries/chunked-forest/codec/format/versions.js

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strictEnum } from "../../../../util/index.js";
+import { EncodedFieldBatchGeneric } from "./formatGeneric.js";
+import { EncodedChunkShapeV1 } from "./formatV1.js";
+import { EncodedChunkShapeV2 } from "./formatV2.js";
+export const FieldBatchFormatVersion = strictEnum("FieldBatchFormatVersion", {
+    /**
+     * Initial version.
+     * @remarks
+     * For simplicity of implementation the format for this version allows the same chunk shapes as v2, but must not use {@link EncodedIncrementalChunkShape}
+     * as older clients will not know how to handle that shape but think they can handle this format.
+     */
+    v1: 1,
+    /**
+     * Adds support for incremental encoding of chunks.
+     * @remarks
+     * {@link EncodedIncrementalChunkShape} was added in this version.
+     */
+    v2: 2,
+});
+export const EncodedFieldBatchV1 = EncodedFieldBatchGeneric(FieldBatchFormatVersion.v1, EncodedChunkShapeV1);
+export const EncodedFieldBatchV2 = EncodedFieldBatchGeneric(FieldBatchFormatVersion.v2, EncodedChunkShapeV2);
+//# sourceMappingURL=versions.js.map

package/lib/feature-libraries/chunked-forest/codec/format/versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../../../../src/feature-libraries/chunked-forest/codec/format/versions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,UAAU,EAAe,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAMpD,MAAM,CAAC,MAAM,uBAAuB,GAAG,UAAU,CAAC,yBAAyB,EAAE;IAC5E;;;;;OAKG;IACH,EAAE,EAAE,CAAC;IACL;;;;OAIG;IACH,EAAE,EAAE,CAAC;CACL,CAAC,CAAC;AAQH,MAAM,CAAC,MAAM,mBAAmB,GAAG,wBAAwB,CAC1D,uBAAuB,CAAC,EAAE,EAC1B,mBAAmB,CACnB,CAAC;AAQF,MAAM,CAAC,MAAM,mBAAmB,GAAG,wBAAwB,CAC1D,uBAAuB,CAAC,EAAE,EAC1B,mBAAmB,CACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Static } from \"@sinclair/typebox\";\n\nimport { strictEnum, type Values } from \"../../../../util/index.js\";\n\nimport { EncodedFieldBatchGeneric } from \"./formatGeneric.js\";\nimport { EncodedChunkShapeV1 } from \"./formatV1.js\";\nimport { EncodedChunkShapeV2 } from \"./formatV2.js\";\n\n/**\n * The format version for the field batch.\n */\nexport type FieldBatchFormatVersion = Values<typeof FieldBatchFormatVersion>;\nexport const FieldBatchFormatVersion = strictEnum(\"FieldBatchFormatVersion\", {\n\t/**\n\t * Initial version.\n\t * @remarks\n\t * For simplicity of implementation the format for this version allows the same chunk shapes as v2, but must not use {@link EncodedIncrementalChunkShape}\n\t * as older clients will not know how to handle that shape but think they can handle this format.\n\t */\n\tv1: 1,\n\t/**\n\t * Adds support for incremental encoding of chunks.\n\t * @remarks\n\t * {@link EncodedIncrementalChunkShape} was added in this version.\n\t */\n\tv2: 2,\n});\n\n/**\n * Encoded {@link FieldBatch} using V1 format.\n * @remarks\n * Does not support {@link EncodedIncrementalChunkShape}.\n */\nexport type EncodedFieldBatchV1 = Static<typeof EncodedFieldBatchV1>;\nexport const EncodedFieldBatchV1 = EncodedFieldBatchGeneric(\n\tFieldBatchFormatVersion.v1,\n\tEncodedChunkShapeV1,\n);\n\n/**\n * Encoded {@link FieldBatch} using V2 format.\n * @remarks\n * Adds support for {@link EncodedIncrementalChunkShape}.\n */\nexport type EncodedFieldBatchV2 = Static<typeof EncodedFieldBatchV2>;\nexport const EncodedFieldBatchV2 = EncodedFieldBatchGeneric(\n\tFieldBatchFormatVersion.v2,\n\tEncodedChunkShapeV2,\n);\n\n/**\n * Encoded {@link FieldBatch}, which might use V2 features, but might also have been from a V1 encoder.\n * @remarks\n * Type wise, equivalent to V2, as that is a superset of V1.\n * Used instead of just V2 for clarity.\n */\nexport type EncodedFieldBatchV1OrV2 = EncodedFieldBatchV1 | EncodedFieldBatchV2;\n\n/**\n * Encoded data, compatible with both V1 and V2 formats.\n * @remarks\n * This is the intersection of the two versions, which is possible because V2 is a non-breaking extension of V1.\n * This type can be used when the code is compatible with both versions and does not need to distinguish between them.\n *\n * Type wise, equivalent to V1, as that is a subset of V2.\n * Used instead of just V1 for clarity.\n */\nexport type EncodedFieldBatchV1AndV2 = EncodedFieldBatchV1 & EncodedFieldBatchV2;\n\n/**\n * Encoded chunk shape, which might use V2 features, but might also have been from a V1 encoder.\n * @remarks\n * Type wise, equivalent to V2, as that is a superset of V1.\n * Used instead of just V2 for clarity.\n */\nexport type EncodedChunkShapeV1OrV2 = EncodedChunkShapeV1 | EncodedChunkShapeV2;\n"]}

package/lib/feature-libraries/chunked-forest/codec/index.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export type { EncodedFieldBatch } from "./format.js";
-export { FieldBatchFormatVersion } from "./format.js";
+export type { EncodedFieldBatchV1, EncodedFieldBatchV1OrV2, EncodedFieldBatchV2, } from "./format/index.js";
+export { FieldBatchFormatVersion } from "./format/index.js";
 export type { FieldBatch } from "./fieldBatch.js";
 export { type FieldBatchCodec, fieldBatchCodecBuilder, type FieldBatchEncodingContext, type IncrementalEncoderDecoder, type IncrementalEncoder, type IncrementalDecoder, type ChunkReferenceId, } from "./codecs.js";
 export { type IncrementalEncodingPolicy, defaultIncrementalEncodingPolicy, } from "./incrementalEncodingPolicy.js";

package/lib/feature-libraries/chunked-forest/codec/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AACtD,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EACN,KAAK,eAAe,EACpB,sBAAsB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,yBAAyB,EAC9B,gCAAgC,GAChC,MAAM,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,GACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EACN,KAAK,eAAe,EACpB,sBAAsB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,GACrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACN,KAAK,yBAAyB,EAC9B,gCAAgC,GAChC,MAAM,gCAAgC,CAAC"}

package/lib/feature-libraries/chunked-forest/codec/index.js

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export { FieldBatchFormatVersion } from "./format.js";
+export { FieldBatchFormatVersion } from "./format/index.js";
 export { fieldBatchCodecBuilder, } from "./codecs.js";
 export { defaultIncrementalEncodingPolicy, } from "./incrementalEncodingPolicy.js";
 //# sourceMappingURL=index.js.map

package/lib/feature-libraries/chunked-forest/codec/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD,OAAO,EAEN,sBAAsB,GAMtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEN,gCAAgC,GAChC,MAAM,gCAAgC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { EncodedFieldBatch } from \"./format.js\";\nexport { FieldBatchFormatVersion } from \"./format.js\";\nexport type { FieldBatch } from \"./fieldBatch.js\";\nexport {\n\ttype FieldBatchCodec,\n\tfieldBatchCodecBuilder,\n\ttype FieldBatchEncodingContext,\n\ttype IncrementalEncoderDecoder,\n\ttype IncrementalEncoder,\n\ttype IncrementalDecoder,\n\ttype ChunkReferenceId,\n} from \"./codecs.js\";\nexport {\n\ttype IncrementalEncodingPolicy,\n\tdefaultIncrementalEncodingPolicy,\n} from \"./incrementalEncodingPolicy.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,OAAO,EAEN,sBAAsB,GAMtB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEN,gCAAgC,GAChC,MAAM,gCAAgC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tEncodedFieldBatchV1,\n\tEncodedFieldBatchV1OrV2,\n\tEncodedFieldBatchV2,\n} from \"./format/index.js\";\nexport { FieldBatchFormatVersion } from \"./format/index.js\";\nexport type { FieldBatch } from \"./fieldBatch.js\";\nexport {\n\ttype FieldBatchCodec,\n\tfieldBatchCodecBuilder,\n\ttype FieldBatchEncodingContext,\n\ttype IncrementalEncoderDecoder,\n\ttype IncrementalEncoder,\n\ttype IncrementalDecoder,\n\ttype ChunkReferenceId,\n} from \"./codecs.js\";\nexport {\n\ttype IncrementalEncodingPolicy,\n\tdefaultIncrementalEncodingPolicy,\n} from \"./incrementalEncodingPolicy.js\";\n"]}

package/lib/feature-libraries/chunked-forest/codec/nodeEncoder.d.ts

@@ -6,14 +6,14 @@ import { type ITreeCursorSynchronous, type TreeNodeSchemaIdentifier } from "../.
 import type { Counter, DeduplicationTable } from "./chunkCodecUtilities.js";
 import { type BufferFormat, Shape } from "./chunkEncodingGeneric.js";
 import { type EncoderContext, type FieldEncoder, type KeyedFieldEncoder, type NodeEncoder } from "./compressedEncode.js";
-import type { EncodedChunkShape, EncodedFieldShape, EncodedValueShape } from "./format.js";
+import type { EncodedChunkShapeV1OrV2, EncodedFieldShape, EncodedValueShape } from "./format/index.js";
 /**
  * Encodes a node with the {@link EncodedNodeShape} shape.
  * @remarks
  * The fact this is also a Shape is an implementation detail of the encoder: that allows the shape it uses to be itself,
  * which is an easy way to keep all the related code together without extra objects.
  */
-export declare class NodeShapeBasedEncoder extends Shape<EncodedChunkShape> implements NodeEncoder {
+export declare class NodeShapeBasedEncoder extends Shape<EncodedChunkShapeV1OrV2> implements NodeEncoder {
     readonly type: undefined | TreeNodeSchemaIdentifier;
     readonly value: EncodedValueShape;
     /**
@@ -57,10 +57,10 @@ export declare class NodeShapeBasedEncoder extends Shape<EncodedChunkShape> impl
      */
     otherFieldsEncoder: undefined | FieldEncoder);
     private getValueToEncode;
-    encodeNode(cursor: ITreeCursorSynchronous, context: EncoderContext, outputBuffer: BufferFormat<EncodedChunkShape>): void;
-    encodeShape(identifiers: DeduplicationTable<string>, shapes: DeduplicationTable<Shape<EncodedChunkShape>>): EncodedChunkShape;
-    countReferencedShapesAndIdentifiers(identifiers: Counter<string>, shapeDiscovered: (shape: Shape<EncodedChunkShape>) => void): void;
-    get shape(): Shape<EncodedChunkShape>;
+    encodeNode(cursor: ITreeCursorSynchronous, context: EncoderContext, outputBuffer: BufferFormat<EncodedChunkShapeV1OrV2>): void;
+    encodeShape(identifiers: DeduplicationTable<string>, shapes: DeduplicationTable<Shape<EncodedChunkShapeV1OrV2>>): EncodedChunkShapeV1OrV2;
+    countReferencedShapesAndIdentifiers(identifiers: Counter<string>, shapeDiscovered: (shape: Shape<EncodedChunkShapeV1OrV2>) => void): void;
+    get shape(): Shape<EncodedChunkShapeV1OrV2>;
 }
-export declare function encodeFieldShapes(fieldEncoders: readonly KeyedFieldEncoder[], identifiers: DeduplicationTable<string>, shapes: DeduplicationTable<Shape<EncodedChunkShape>>): EncodedFieldShape[] | undefined;
+export declare function encodeFieldShapes(fieldEncoders: readonly KeyedFieldEncoder[], identifiers: DeduplicationTable<string>, shapes: DeduplicationTable<Shape<EncodedChunkShapeV1OrV2>>): EncodedFieldShape[] | undefined;
 //# sourceMappingURL=nodeEncoder.d.ts.map