@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/feature-libraries/chunked-forest/codec/fieldBatch.js

@@ -0,0 +1,7 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fieldBatch.js.map

package/dist/feature-libraries/chunked-forest/codec/fieldBatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldBatch.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/fieldBatch.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ITreeCursorSynchronous } from \"../../../core\";\n\n/**\n * Collection of field cursors to compress as a batch.\n * Cursors must be in fields mode.\n */\nexport type FieldBatch = readonly ITreeCursorSynchronous[];\n"]}

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

@@ -0,0 +1,208 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Static } from "@sinclair/typebox";
+export declare const version = 1;
+export declare const validVersions: Set<number>;
+/**
+ * Top level length is implied from length of data array.
+ * All content are of this shape.
+ */
+export declare const EncodedNestedArray: import("@sinclair/typebox").TNumber;
+/**
+ * Inline array.
+ */
+export declare const EncodedInlineArray: 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 declare const EncodedAnyShape: import("@sinclair/typebox").TLiteral<0>;
+export declare const EncodedFieldShape: import("@sinclair/typebox").TObject<{
+    /**
+     * Field key for this field.
+     */
+    key: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+    /**
+     * Shape of data in this field.
+     */
+    shape: import("@sinclair/typebox").TNumber;
+}>;
+export type EncodedFieldShape = Static<typeof EncodedFieldShape>;
+declare enum CounterRelativeTo {
+    PreviousNodeOfType_DepthFirstPreOrder = 0
+}
+declare enum CounterMode {
+    Number = 0,
+    UUID = 1
+}
+/**
+ * Delta encoded value relative to a previous node's value.
+ */
+export declare const EncodedCounter: import("@sinclair/typebox").TObject<{
+    relativeTo: import("@sinclair/typebox").TEnum<typeof CounterRelativeTo>;
+    delta: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    mode: import("@sinclair/typebox").TEnum<typeof CounterMode>;
+}>;
+/**
+ * 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 three 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.
+ * 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 EncodedTreeShape} for usage.
+ */
+export declare const EncodedValueShape: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TBoolean, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>]>;
+export type EncodedValueShape = undefined | Static<typeof EncodedValueShape>;
+export declare const EncodedTreeShape: 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>]>>;
+    fields: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        /**
+         * Field key for this field.
+         */
+        key: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+        /**
+         * Shape of data in this field.
+         */
+        shape: import("@sinclair/typebox").TNumber;
+    }>>;
+    /**
+     * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+     */
+    extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>;
+/**
+ * Discriminated union of chunk shapes.
+ *
+ * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.
+ */
+export declare const EncodedChunkShape: import("@sinclair/typebox").TObject<{
+    /**
+     * {@link EncodedNestedArray} union member.
+     */
+    a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    /**
+     * {@link EncodedInlineArray} union member.
+     */
+    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 EncodedTreeShape} union member.
+     */
+    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>]>>;
+        fields: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            /**
+             * Field key for this field.
+             */
+            key: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+            /**
+             * Shape of data in this field.
+             */
+            shape: import("@sinclair/typebox").TNumber;
+        }>>;
+        /**
+         * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+         */
+        extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>>;
+    /**
+     * {@link EncodedAnyShape} union member.
+     */
+    d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+}>;
+export type EncodedChunkShape = Static<typeof EncodedChunkShape>;
+export type EncodedNestedArray = Static<typeof EncodedNestedArray>;
+export type EncodedInlineArray = Static<typeof EncodedInlineArray>;
+export type EncodedTreeShape = Static<typeof EncodedTreeShape>;
+export type EncodedAnyShape = Static<typeof EncodedAnyShape>;
+export declare const EncodedFieldBatch: 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<number>]>;
+    identifiers: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    shapes: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        /**
+         * {@link EncodedNestedArray} union member.
+         */
+        a: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        /**
+         * {@link EncodedInlineArray} union member.
+         */
+        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 EncodedTreeShape} union member.
+         */
+        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>]>>;
+            fields: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+                /**
+                 * Field key for this field.
+                 */
+                key: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+                /**
+                 * Shape of data in this field.
+                 */
+                shape: import("@sinclair/typebox").TNumber;
+            }>>;
+            /**
+             * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+             */
+            extraFields: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+        }>>;
+        /**
+         * {@link EncodedAnyShape} union member.
+         */
+        d: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TLiteral<0>>;
+    }>>;
+}>;
+export type EncodedFieldBatch = Static<typeof EncodedFieldBatch>;
+export {};
+//# sourceMappingURL=format.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/format.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAKjD,eAAO,MAAM,OAAO,IAAM,CAAC;AAI3B,eAAO,MAAM,aAAa,aAAqB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,qCAAa,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,kBAAkB;;IAG7B;;OAEG;;EAIJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,yCAAkB,CAAC;AAK/C,eAAO,MAAM,iBAAiB;IAE5B;;OAEG;;IAEH;;OAEG;;EAIJ,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEjE,aAAK,iBAAiB;IAErB,qCAAqC,IAAA;CAErC;AAED,aAAK,WAAW;IACf,MAAM,IAAA;IAEN,IAAI,IAAA;CACJ;AAED;;GAEG;AACH,eAAO,MAAM,cAAc;;;;EAQ1B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,iBAAiB,kJAK5B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE7E,eAAO,MAAM,gBAAgB;IAE3B;;OAEG;;;;QA3EH;;WAEG;;QAEH;;WAEG;;;IAyEH;;OAEG;;EAIJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB;IAE5B;;OAEG;;IAEH;;OAEG;;;QAxHH;;WAEG;;;IAwHH;;OAEG;;QA/BH;;WAEG;;;;YA3EH;;eAEG;;YAEH;;eAEG;;;QAyEH;;WAEG;;;IAyBH;;OAEG;;EAIJ,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEjE,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACnE,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,OAAO,kBAAkB,CAAC,CAAC;AACnE,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC/D,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AAE7D,eAAO,MAAM,iBAAiB;;;;;QA3B5B;;WAEG;;QAEH;;WAEG;;;YAxHH;;eAEG;;;QAwHH;;WAEG;;YA/BH;;eAEG;;;;gBA3EH;;mBAEG;;gBAEH;;mBAEG;;;YAyEH;;eAEG;;;QAyBH;;WAEG;;;EAagF,CAAC;AACtF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/feature-libraries/chunked-forest/codec/format.js

@@ -0,0 +1,138 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncodedFieldBatch = exports.EncodedChunkShape = exports.EncodedTreeShape = exports.EncodedValueShape = exports.EncodedCounter = exports.EncodedFieldShape = exports.EncodedAnyShape = exports.EncodedInlineArray = exports.EncodedNestedArray = exports.validVersions = exports.version = void 0;
+const typebox_1 = require("@sinclair/typebox");
+const codec_1 = require("../../../codec");
+const formatGeneric_1 = require("./formatGeneric");
+// TODO: Versions from here and schemaIndexFormat.ts should eventually be deduplicated into one version.
+exports.version = 1.0;
+// Compatible versions used for format/version validation.
+// TODO: A proper version update policy will need to be documented.
+exports.validVersions = new Set([exports.version]);
+/**
+ * Top level length is implied from length of data array.
+ * All content are of this shape.
+ */
+exports.EncodedNestedArray = formatGeneric_1.ShapeIndex;
+/**
+ * Inline array.
+ */
+exports.EncodedInlineArray = typebox_1.Type.Object({
+    length: formatGeneric_1.Count,
+    /**
+     * All entries are this shape.
+     */
+    shape: formatGeneric_1.ShapeIndex,
+}, { additionalProperties: false });
+/**
+ * Encoded as `shape, ...[data for shape]`.
+ *
+ * Used for polymorphism.
+ */
+exports.EncodedAnyShape = typebox_1.Type.Literal(0);
+// Content of the field is:
+// [shape if not provided in fieldShape], [data for one chunk of specified shape]
+// If data is in multiple chunks needs to be converted into a single chunk, for example via an array chunk.
+exports.EncodedFieldShape = typebox_1.Type.Object({
+    /**
+     * Field key for this field.
+     */
+    key: formatGeneric_1.IdentifierOrIndex,
+    /**
+     * Shape of data in this field.
+     */
+    shape: formatGeneric_1.ShapeIndex,
+}, { additionalProperties: false });
+var CounterRelativeTo;
+(function (CounterRelativeTo) {
+    // Relative to previous node of same type in depth first pre-order traversal.
+    CounterRelativeTo[CounterRelativeTo["PreviousNodeOfType_DepthFirstPreOrder"] = 0] = "PreviousNodeOfType_DepthFirstPreOrder";
+    // TODO: add alternative relative mode relative to previous note at a path to allow delta encoded sequences (like points where x and y are delta encoded relative to previous points).
+})(CounterRelativeTo || (CounterRelativeTo = {}));
+var CounterMode;
+(function (CounterMode) {
+    CounterMode[CounterMode["Number"] = 0] = "Number";
+    // TODO: document wrap modes and bit skipping. Note UUID subVersion here (ex: UUIDv4)
+    CounterMode[CounterMode["UUID"] = 1] = "UUID";
+})(CounterMode || (CounterMode = {}));
+/**
+ * Delta encoded value relative to a previous node's value.
+ */
+exports.EncodedCounter = typebox_1.Type.Object({
+    relativeTo: typebox_1.Type.Enum(CounterRelativeTo),
+    // If not provided, delta inline in data.
+    delta: typebox_1.Type.Optional(typebox_1.Type.Number()),
+    mode: typebox_1.Type.Enum(CounterMode),
+}, { additionalProperties: false });
+/**
+ * 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 three 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.
+ * 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 EncodedTreeShape} for usage.
+ */
+exports.EncodedValueShape = typebox_1.Type.Union([
+    typebox_1.Type.Boolean(),
+    typebox_1.Type.Array(typebox_1.Type.Any(), { minItems: 1, maxItems: 1 }),
+    // TODO: support delta encoding and/or special node identifier handling
+    // EncodedCounter,
+]);
+exports.EncodedTreeShape = typebox_1.Type.Object({
+    /**
+     * If not provided, inlined in data.
+     */
+    type: typebox_1.Type.Optional(formatGeneric_1.IdentifierOrIndex),
+    value: typebox_1.Type.Optional(exports.EncodedValueShape),
+    fields: typebox_1.Type.Array(exports.EncodedFieldShape),
+    /**
+     * If undefined, no data. Otherwise, nested array of `[key, ...data]*`
+     */
+    extraFields: typebox_1.Type.Optional(formatGeneric_1.ShapeIndex),
+}, { additionalProperties: false });
+/**
+ * Discriminated union of chunk shapes.
+ *
+ * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.
+ */
+exports.EncodedChunkShape = typebox_1.Type.Object({
+    /**
+     * {@link EncodedNestedArray} union member.
+     */
+    a: typebox_1.Type.Optional(exports.EncodedNestedArray),
+    /**
+     * {@link EncodedInlineArray} union member.
+     */
+    b: typebox_1.Type.Optional(exports.EncodedInlineArray),
+    /**
+     * {@link EncodedTreeShape} union member.
+     */
+    c: typebox_1.Type.Optional(exports.EncodedTreeShape),
+    /**
+     * {@link EncodedAnyShape} union member.
+     */
+    d: typebox_1.Type.Optional(exports.EncodedAnyShape),
+}, codec_1.unionOptions);
+exports.EncodedFieldBatch = (0, formatGeneric_1.EncodedFieldBatchGeneric)(exports.version, exports.EncodedChunkShape);
+//# sourceMappingURL=format.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/format.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+CAAiD;AACjD,0CAA8C;AAC9C,mDAAiG;AAEjG,wGAAwG;AAC3F,QAAA,OAAO,GAAG,GAAG,CAAC;AAE3B,0DAA0D;AAC1D,mEAAmE;AACtD,QAAA,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,eAAO,CAAC,CAAC,CAAC;AAEhD;;;GAGG;AACU,QAAA,kBAAkB,GAAG,0BAAU,CAAC;AAE7C;;GAEG;AACU,QAAA,kBAAkB,GAAG,cAAI,CAAC,MAAM,CAC5C;IACC,MAAM,EAAE,qBAAK;IACb;;OAEG;IACH,KAAK,EAAE,0BAAU;CACjB,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAEF;;;;GAIG;AACU,QAAA,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAE/C,2BAA2B;AAC3B,iFAAiF;AACjF,2GAA2G;AAC9F,QAAA,iBAAiB,GAAG,cAAI,CAAC,MAAM,CAC3C;IACC;;OAEG;IACH,GAAG,EAAE,iCAAiB;IACtB;;OAEG;IACH,KAAK,EAAE,0BAAU;CACjB,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAGF,IAAK,iBAIJ;AAJD,WAAK,iBAAiB;IACrB,6EAA6E;IAC7E,2HAAqC,CAAA;IACrC,sLAAsL;AACvL,CAAC,EAJI,iBAAiB,KAAjB,iBAAiB,QAIrB;AAED,IAAK,WAIJ;AAJD,WAAK,WAAW;IACf,iDAAM,CAAA;IACN,qFAAqF;IACrF,6CAAI,CAAA;AACL,CAAC,EAJI,WAAW,KAAX,WAAW,QAIf;AAED;;GAEG;AACU,QAAA,cAAc,GAAG,cAAI,CAAC,MAAM,CACxC;IACC,UAAU,EAAE,cAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC;IACxC,yCAAyC;IACzC,KAAK,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,EAAE,CAAC;IACnC,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,WAAW,CAAC;CAC5B,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,iBAAiB,GAAG,cAAI,CAAC,KAAK,CAAC;IAC3C,cAAI,CAAC,OAAO,EAAE;IACd,cAAI,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACpD,uEAAuE;IACvE,kBAAkB;CAClB,CAAC,CAAC;AAGU,QAAA,gBAAgB,GAAG,cAAI,CAAC,MAAM,CAC1C;IACC;;OAEG;IACH,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,iCAAiB,CAAC;IACtC,KAAK,EAAE,cAAI,CAAC,QAAQ,CAAC,yBAAiB,CAAC;IACvC,MAAM,EAAE,cAAI,CAAC,KAAK,CAAC,yBAAiB,CAAC;IACrC;;OAEG;IACH,WAAW,EAAE,cAAI,CAAC,QAAQ,CAAC,0BAAU,CAAC;CACtC,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAEF;;;;GAIG;AACU,QAAA,iBAAiB,GAAG,cAAI,CAAC,MAAM,CAC3C;IACC;;OAEG;IACH,CAAC,EAAE,cAAI,CAAC,QAAQ,CAAC,0BAAkB,CAAC;IACpC;;OAEG;IACH,CAAC,EAAE,cAAI,CAAC,QAAQ,CAAC,0BAAkB,CAAC;IACpC;;OAEG;IACH,CAAC,EAAE,cAAI,CAAC,QAAQ,CAAC,wBAAgB,CAAC;IAClC;;OAEG;IACH,CAAC,EAAE,cAAI,CAAC,QAAQ,CAAC,uBAAe,CAAC;CACjC,EACD,oBAAY,CACZ,CAAC;AASW,QAAA,iBAAiB,GAAG,IAAA,wCAAwB,EAAC,eAAO,EAAE,yBAAiB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Static, Type } from \"@sinclair/typebox\";\nimport { unionOptions } from \"../../../codec\";\nimport { EncodedFieldBatchGeneric, IdentifierOrIndex, ShapeIndex, Count } from \"./formatGeneric\";\n\n// TODO: Versions from here and schemaIndexFormat.ts should eventually be deduplicated into one version.\nexport const version = 1.0;\n\n// Compatible versions used for format/version validation.\n// TODO: A proper version update policy will need to be documented.\nexport const validVersions = new Set([version]);\n\n/**\n * Top level length is implied from length of data array.\n * All content are of this shape.\n */\nexport const EncodedNestedArray = ShapeIndex;\n\n/**\n * Inline array.\n */\nexport const EncodedInlineArray = 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 const EncodedAnyShape = Type.Literal(0);\n\n// Content of the field is:\n// [shape if not provided in fieldShape], [data for one chunk of specified shape]\n// If data is in multiple chunks needs to be converted into a single chunk, for example via an array chunk.\nexport const EncodedFieldShape = Type.Object(\n\t{\n\t\t/**\n\t\t * Field key for this field.\n\t\t */\n\t\tkey: IdentifierOrIndex,\n\t\t/**\n\t\t * Shape of data in this field.\n\t\t */\n\t\tshape: ShapeIndex,\n\t},\n\t{ additionalProperties: false },\n);\nexport type EncodedFieldShape = Static<typeof EncodedFieldShape>;\n\nenum CounterRelativeTo {\n\t// Relative to previous node of same type in depth first pre-order traversal.\n\tPreviousNodeOfType_DepthFirstPreOrder,\n\t// TODO: add alternative relative mode relative to previous note at a path to allow delta encoded sequences (like points where x and y are delta encoded relative to previous points).\n}\n\nenum CounterMode {\n\tNumber,\n\t// TODO: document wrap modes and bit skipping. Note UUID subVersion here (ex: UUIDv4)\n\tUUID,\n}\n\n/**\n * Delta encoded value relative to a previous node's value.\n */\nexport const EncodedCounter = Type.Object(\n\t{\n\t\trelativeTo: Type.Enum(CounterRelativeTo),\n\t\t// If not provided, delta inline in data.\n\t\tdelta: Type.Optional(Type.Number()),\n\t\tmode: Type.Enum(CounterMode),\n\t},\n\t{ additionalProperties: false },\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 three 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 * 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 EncodedTreeShape} for usage.\n */\nexport const EncodedValueShape = Type.Union([\n\tType.Boolean(),\n\tType.Array(Type.Any(), { minItems: 1, maxItems: 1 }),\n\t// TODO: support delta encoding and/or special node identifier handling\n\t// EncodedCounter,\n]);\nexport type EncodedValueShape = undefined | Static<typeof EncodedValueShape>;\n\nexport const EncodedTreeShape = 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\tfields: Type.Array(EncodedFieldShape),\n\t\t/**\n\t\t * If undefined, no data. Otherwise, nested array of `[key, ...data]*`\n\t\t */\n\t\textraFields: Type.Optional(ShapeIndex),\n\t},\n\t{ additionalProperties: false },\n);\n\n/**\n * Discriminated union of chunk shapes.\n *\n * See {@link DiscriminatedUnionDispatcher} for more information on this pattern.\n */\nexport const EncodedChunkShape = Type.Object(\n\t{\n\t\t/**\n\t\t * {@link EncodedNestedArray} union member.\n\t\t */\n\t\ta: Type.Optional(EncodedNestedArray),\n\t\t/**\n\t\t * {@link EncodedInlineArray} union member.\n\t\t */\n\t\tb: Type.Optional(EncodedInlineArray),\n\t\t/**\n\t\t * {@link EncodedTreeShape} union member.\n\t\t */\n\t\tc: Type.Optional(EncodedTreeShape),\n\t\t/**\n\t\t * {@link EncodedAnyShape} union member.\n\t\t */\n\t\td: Type.Optional(EncodedAnyShape),\n\t},\n\tunionOptions,\n);\n\nexport type EncodedChunkShape = Static<typeof EncodedChunkShape>;\n\nexport type EncodedNestedArray = Static<typeof EncodedNestedArray>;\nexport type EncodedInlineArray = Static<typeof EncodedInlineArray>;\nexport type EncodedTreeShape = Static<typeof EncodedTreeShape>;\nexport type EncodedAnyShape = Static<typeof EncodedAnyShape>;\n\nexport const EncodedFieldBatch = EncodedFieldBatchGeneric(version, EncodedChunkShape);\nexport type EncodedFieldBatch = Static<typeof EncodedFieldBatch>;\n"]}

package/dist/feature-libraries/chunked-forest/codec/formatGeneric.d.ts

@@ -0,0 +1,43 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Static, TSchema } from "@sinclair/typebox";
+/**
+ * Identifier OR Index of an identifier in the identifier list.
+ */
+export declare const IdentifierOrIndex: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
+export type IdentifierOrIndex = Static<typeof IdentifierOrIndex>;
+/**
+ * Reference to a shape, by index.
+ *
+ * Shapes use a dictionary encoding where they are referenced by their index in a shape array.
+ */
+export declare const ShapeIndex: import("@sinclair/typebox").TNumber;
+export type ShapeIndex = Static<typeof ShapeIndex>;
+export declare const Count: import("@sinclair/typebox").TNumber;
+declare const EncodedFieldBatchBase: import("@sinclair/typebox").TObject<{
+    version: import("@sinclair/typebox").TNumber;
+    identifiers: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    /**
+     * Top level array is list of field from batch.
+     * Inner are TreeValues mixed with indexes into "shapes" and nested arrays where lengths are needed.
+     */
+    data: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TAny>>;
+}>;
+/**
+ * Format for encoding a tree chunk.
+ * @param version - format version. Must be changed if there is any change to the generic schema, or the `shape` schema.
+ * @param shape - schema for union of shape format, see {@link DiscriminatedUnionDispatcher}.
+ */
+export declare const EncodedFieldBatchGeneric: <TShapeSchema extends TSchema>(version: number, shape: TShapeSchema) => 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<number>]>;
+    identifiers: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    shapes: import("@sinclair/typebox").TArray<TShapeSchema>;
+}>;
+export interface EncodedFieldBatchGeneric<TEncodedShape> extends Static<typeof EncodedFieldBatchBase> {
+    shapes: TEncodedShape[];
+}
+export {};
+//# sourceMappingURL=formatGeneric.d.ts.map

package/dist/feature-libraries/chunked-forest/codec/formatGeneric.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatGeneric.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/formatGeneric.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAQ,MAAM,mBAAmB,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,iBAAiB,gHAG5B,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,UAAU,qCAA6C,CAAC;AACrE,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC;AAEnD,eAAO,MAAM,KAAK,qCAA6C,CAAC;AAEhE,QAAA,MAAM,qBAAqB;;;IAIzB;;;OAGG;;EAIJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,0CAC3B,MAAM;;;;;EAYd,CAAC;AAEH,MAAM,WAAW,wBAAwB,CAAC,aAAa,CACtD,SAAQ,MAAM,CAAC,OAAO,qBAAqB,CAAC;IAC5C,MAAM,EAAE,aAAa,EAAE,CAAC;CACxB"}

package/dist/feature-libraries/chunked-forest/codec/formatGeneric.js

@@ -0,0 +1,45 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncodedFieldBatchGeneric = exports.Count = exports.ShapeIndex = exports.IdentifierOrIndex = void 0;
+const typebox_1 = require("@sinclair/typebox");
+/**
+ * Identifier OR Index of an identifier in the identifier list.
+ */
+exports.IdentifierOrIndex = typebox_1.Type.Union([
+    typebox_1.Type.String(),
+    typebox_1.Type.Number({ multipleOf: 1, minimum: 0 }),
+]);
+/**
+ * Reference to a shape, by index.
+ *
+ * Shapes use a dictionary encoding where they are referenced by their index in a shape array.
+ */
+exports.ShapeIndex = typebox_1.Type.Number({ multipleOf: 1, minimum: 0 });
+exports.Count = typebox_1.Type.Number({ multipleOf: 1, minimum: 0 });
+const EncodedFieldBatchBase = typebox_1.Type.Object({
+    version: typebox_1.Type.Number(),
+    identifiers: typebox_1.Type.Array(typebox_1.Type.String()),
+    /**
+     * Top level array is list of field from batch.
+     * Inner are TreeValues mixed with indexes into "shapes" and nested arrays where lengths are needed.
+     */
+    data: typebox_1.Type.Array(typebox_1.Type.Array(typebox_1.Type.Any())),
+}, { additionalProperties: false });
+/**
+ * Format for encoding a tree chunk.
+ * @param version - format version. Must be changed if there is any change to the generic schema, or the `shape` schema.
+ * @param shape - schema for union of shape format, see {@link DiscriminatedUnionDispatcher}.
+ */
+const EncodedFieldBatchGeneric = (version, shape) => typebox_1.Type.Composite([
+    EncodedFieldBatchBase,
+    typebox_1.Type.Object({
+        version: typebox_1.Type.Literal(version),
+        shapes: typebox_1.Type.Array(shape),
+    }),
+], { additionalProperties: false });
+exports.EncodedFieldBatchGeneric = EncodedFieldBatchGeneric;
+//# sourceMappingURL=formatGeneric.js.map

package/dist/feature-libraries/chunked-forest/codec/formatGeneric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatGeneric.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/formatGeneric.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+CAA0D;AAE1D;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAI,CAAC,KAAK,CAAC;IAC3C,cAAI,CAAC,MAAM,EAAE;IACb,cAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;CAC1C,CAAC,CAAC;AAGH;;;;GAIG;AACU,QAAA,UAAU,GAAG,cAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;AAGxD,QAAA,KAAK,GAAG,cAAI,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;AAEhE,MAAM,qBAAqB,GAAG,cAAI,CAAC,MAAM,CACxC;IACC,OAAO,EAAE,cAAI,CAAC,MAAM,EAAE;IACtB,WAAW,EAAE,cAAI,CAAC,KAAK,CAAC,cAAI,CAAC,MAAM,EAAE,CAAC;IACtC;;;OAGG;IACH,IAAI,EAAE,cAAI,CAAC,KAAK,CAAC,cAAI,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,EAAE,CAAC,CAAC;CACxC,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAEF;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CACvC,OAAe,EACf,KAAmB,EAClB,EAAE,CACH,cAAI,CAAC,SAAS,CACb;IACC,qBAAqB;IACrB,cAAI,CAAC,MAAM,CAAC;QACX,OAAO,EAAE,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC;QAC9B,MAAM,EAAE,cAAI,CAAC,KAAK,CAAC,KAAK,CAAC;KACzB,CAAC;CACF,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAC/B,CAAC;AAbU,QAAA,wBAAwB,4BAalC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Static, TSchema, Type } from \"@sinclair/typebox\";\n\n/**\n * Identifier OR Index of an identifier in the identifier list.\n */\nexport const IdentifierOrIndex = Type.Union([\n\tType.String(),\n\tType.Number({ multipleOf: 1, minimum: 0 }),\n]);\nexport type IdentifierOrIndex = Static<typeof IdentifierOrIndex>;\n\n/**\n * Reference to a shape, by index.\n *\n * Shapes use a dictionary encoding where they are referenced by their index in a shape array.\n */\nexport const ShapeIndex = Type.Number({ multipleOf: 1, minimum: 0 });\nexport type ShapeIndex = Static<typeof ShapeIndex>;\n\nexport const Count = Type.Number({ multipleOf: 1, minimum: 0 });\n\nconst EncodedFieldBatchBase = Type.Object(\n\t{\n\t\tversion: Type.Number(),\n\t\tidentifiers: Type.Array(Type.String()),\n\t\t/**\n\t\t * Top level array is list of field from batch.\n\t\t * Inner are TreeValues mixed with indexes into \"shapes\" and nested arrays where lengths are needed.\n\t\t */\n\t\tdata: Type.Array(Type.Array(Type.Any())),\n\t},\n\t{ additionalProperties: false },\n);\n\n/**\n * Format for encoding a tree chunk.\n * @param version - format version. Must be changed if there is any change to the generic schema, or the `shape` schema.\n * @param shape - schema for union of shape format, see {@link DiscriminatedUnionDispatcher}.\n */\nexport const EncodedFieldBatchGeneric = <TShapeSchema extends TSchema>(\n\tversion: number,\n\tshape: TShapeSchema,\n) =>\n\tType.Composite(\n\t\t[\n\t\t\tEncodedFieldBatchBase,\n\t\t\tType.Object({\n\t\t\t\tversion: Type.Literal(version),\n\t\t\t\tshapes: Type.Array(shape),\n\t\t\t}),\n\t\t],\n\t\t{ additionalProperties: false },\n\t);\n\nexport interface EncodedFieldBatchGeneric<TEncodedShape>\n\textends Static<typeof EncodedFieldBatchBase> {\n\tshapes: TEncodedShape[];\n}\n"]}

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

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { EncodedFieldBatch } from "./format";
+export { FieldBatch } from "./fieldBatch";
+export { FieldBatchCodec, makeFieldBatchCodec, FieldBatchEncoder } from "./codecs";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC"}

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

@@ -0,0 +1,13 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldBatchEncoder = exports.makeFieldBatchCodec = exports.EncodedFieldBatch = void 0;
+var format_1 = require("./format");
+Object.defineProperty(exports, "EncodedFieldBatch", { enumerable: true, get: function () { return format_1.EncodedFieldBatch; } });
+var codecs_1 = require("./codecs");
+Object.defineProperty(exports, "makeFieldBatchCodec", { enumerable: true, get: function () { return codecs_1.makeFieldBatchCodec; } });
+Object.defineProperty(exports, "FieldBatchEncoder", { enumerable: true, get: function () { return codecs_1.FieldBatchEncoder; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mCAA6C;AAApC,2GAAA,iBAAiB,OAAA;AAE1B,mCAAmF;AAAzD,6GAAA,mBAAmB,OAAA;AAAE,2GAAA,iBAAiB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { EncodedFieldBatch } from \"./format\";\nexport { FieldBatch } from \"./fieldBatch\";\nexport { FieldBatchCodec, makeFieldBatchCodec, FieldBatchEncoder } from \"./codecs\";\n"]}

package/dist/feature-libraries/chunked-forest/codec/nodeShape.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITreeCursorSynchronous, TreeNodeSchemaIdentifier } from "../../../core";
+import { BufferFormat, Shape } from "./chunkEncodingGeneric";
+import { Counter, DeduplicationTable } from "./chunkCodecUtilities";
+import { EncodedChunkShape, EncodedFieldShape, EncodedValueShape } from "./format";
+import { NodeEncoder, KeyedFieldEncoder, FieldEncoder, EncoderCache } from "./compressedEncode";
+export declare class NodeShape extends Shape<EncodedChunkShape> implements NodeEncoder {
+    readonly type: undefined | TreeNodeSchemaIdentifier;
+    readonly value: EncodedValueShape;
+    readonly fields: readonly KeyedFieldEncoder[];
+    readonly extraLocal: undefined | FieldEncoder;
+    private readonly explicitKeys;
+    constructor(type: undefined | TreeNodeSchemaIdentifier, value: EncodedValueShape, fields: readonly KeyedFieldEncoder[], extraLocal: undefined | FieldEncoder);
+    encodeNode(cursor: ITreeCursorSynchronous, cache: EncoderCache, outputBuffer: BufferFormat<EncodedChunkShape>): void;
+    encodeShape(identifiers: DeduplicationTable<string>, shapes: DeduplicationTable<Shape<EncodedChunkShape>>): EncodedChunkShape;
+    count(identifiers: Counter<string>, shapes: (shape: Shape<EncodedChunkShape>) => void): void;
+    get shape(): this;
+}
+export declare function encodeFieldShapes(fields: readonly KeyedFieldEncoder[], identifiers: DeduplicationTable<string>, shapes: DeduplicationTable<Shape<EncodedChunkShape>>): EncodedFieldShape[];
+//# sourceMappingURL=nodeShape.d.ts.map

package/dist/feature-libraries/chunked-forest/codec/nodeShape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeShape.d.ts","sourceRoot":"","sources":["../../../../src/feature-libraries/chunked-forest/codec/nodeShape.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAEN,sBAAsB,EACtB,wBAAwB,EAExB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,YAAY,EAAmB,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACnF,OAAO,EACN,WAAW,EACX,iBAAiB,EACjB,YAAY,EACZ,YAAY,EAEZ,MAAM,oBAAoB,CAAC;AAE5B,qBAAa,SAAU,SAAQ,KAAK,CAAC,iBAAiB,CAAE,YAAW,WAAW;aAK5D,IAAI,EAAE,SAAS,GAAG,wBAAwB;aAC1C,KAAK,EAAE,iBAAiB;aACxB,MAAM,EAAE,SAAS,iBAAiB,EAAE;aACpC,UAAU,EAAE,SAAS,GAAG,YAAY;IANrD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;gBAG5B,IAAI,EAAE,SAAS,GAAG,wBAAwB,EAC1C,KAAK,EAAE,iBAAiB,EACxB,MAAM,EAAE,SAAS,iBAAiB,EAAE,EACpC,UAAU,EAAE,SAAS,GAAG,YAAY;IAM9C,UAAU,CAChB,MAAM,EAAE,sBAAsB,EAC9B,KAAK,EAAE,YAAY,EACnB,YAAY,EAAE,YAAY,CAAC,iBAAiB,CAAC,GAC3C,IAAI;IAkCA,WAAW,CACjB,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,EACvC,MAAM,EAAE,kBAAkB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAClD,iBAAiB;IAWb,KAAK,CACX,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,EAC5B,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,iBAAiB,CAAC,KAAK,IAAI,GAC/C,IAAI;IAeP,IAAW,KAAK,SAEf;CACD;AAED,wBAAgB,iBAAiB,CAChC,MAAM,EAAE,SAAS,iBAAiB,EAAE,EACpC,WAAW,EAAE,kBAAkB,CAAC,MAAM,CAAC,EACvC,MAAM,EAAE,kBAAkB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAClD,iBAAiB,EAAE,CAKrB"}

package/dist/feature-libraries/chunked-forest/codec/nodeShape.js

@@ -0,0 +1,94 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeFieldShapes = exports.NodeShape = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const core_1 = require("../../../core");
+const util_1 = require("../../../util");
+const chunkEncodingGeneric_1 = require("./chunkEncodingGeneric");
+const compressedEncode_1 = require("./compressedEncode");
+class NodeShape extends chunkEncodingGeneric_1.Shape {
+    constructor(type, value, fields, extraLocal) {
+        super();
+        this.type = type;
+        this.value = value;
+        this.fields = fields;
+        this.extraLocal = extraLocal;
+        this.explicitKeys = new Set(this.fields.map((f) => f.key));
+    }
+    encodeNode(cursor, cache, outputBuffer) {
+        if (this.type === undefined) {
+            outputBuffer.push(new chunkEncodingGeneric_1.IdentifierToken(cursor.type));
+        }
+        else {
+            (0, core_utils_1.assert)(cursor.type === this.type, 0x741 /* type must match shape */);
+        }
+        (0, compressedEncode_1.encodeValue)(cursor.value, this.value, outputBuffer);
+        for (const field of this.fields) {
+            cursor.enterField((0, util_1.brand)(field.key));
+            field.shape.encodeField(cursor, cache, outputBuffer);
+            cursor.exitField();
+        }
+        const localBuffer = [];
+        (0, core_1.forEachField)(cursor, () => {
+            const key = cursor.getFieldKey();
+            if (!this.explicitKeys.has(key)) {
+                (0, core_utils_1.assert)(this.extraLocal !== undefined, 0x742 /* had extra local fields when shape does not support them */);
+                localBuffer.push(new chunkEncodingGeneric_1.IdentifierToken(key));
+                this.extraLocal.encodeField(cursor, cache, localBuffer);
+            }
+        });
+        if (this.extraLocal !== undefined) {
+            outputBuffer.push(localBuffer);
+        }
+    }
+    encodeShape(identifiers, shapes) {
+        return {
+            c: {
+                type: encodeOptionalIdentifier(this.type, identifiers),
+                value: this.value,
+                fields: encodeFieldShapes(this.fields, identifiers, shapes),
+                extraFields: encodeOptionalFieldShape(this.extraLocal, shapes),
+            },
+        };
+    }
+    count(identifiers, shapes) {
+        if (this.type !== undefined) {
+            identifiers.add(this.type);
+        }
+        for (const field of this.fields) {
+            identifiers.add(field.key);
+            shapes(field.shape.shape);
+        }
+        if (this.extraLocal !== undefined) {
+            shapes(this.extraLocal.shape);
+        }
+    }
+    get shape() {
+        return this;
+    }
+}
+exports.NodeShape = NodeShape;
+function encodeFieldShapes(fields, identifiers, shapes) {
+    return fields.map((field) => ({
+        key: encodeIdentifier(field.key, identifiers),
+        shape: shapes.valueToIndex.get(field.shape.shape) ?? (0, util_1.fail)("missing shape"),
+    }));
+}
+exports.encodeFieldShapes = encodeFieldShapes;
+function encodeIdentifier(identifier, identifiers) {
+    return identifiers.valueToIndex.get(identifier) ?? identifier;
+}
+function encodeOptionalIdentifier(identifier, identifiers) {
+    return identifier === undefined ? undefined : encodeIdentifier(identifier, identifiers);
+}
+function encodeOptionalFieldShape(shape, shapes) {
+    return shape === undefined ? undefined : dedupShape(shape.shape, shapes);
+}
+function dedupShape(shape, shapes) {
+    return shapes.valueToIndex.get(shape) ?? (0, util_1.fail)("missing shape");
+}
+//# sourceMappingURL=nodeShape.js.map