@fluidframework/id-compressor 2.0.0-dev-rc.1.0.0.224419

package/dist/idCompressor.d.ts

@@ -0,0 +1,84 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
+import { IdCreationRange, IIdCompressor, IIdCompressorCore, OpSpaceCompressedId, SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession, SessionId, SessionSpaceCompressedId, StableId } from "./types";
+/**
+ * See {@link IIdCompressor} and {@link IIdCompressorCore}
+ *
+ * @alpha
+ *
+ * @deprecated Not intended for public use and will be removed from the public API in the future.
+ * Use `createIdCompressor` instead.
+ */
+export declare class IdCompressor implements IIdCompressor, IIdCompressorCore {
+    private readonly logger?;
+    /**
+     * Max allowed initial cluster size.
+     */
+    static readonly maxClusterSize: number;
+    readonly localSessionId: SessionId;
+    private readonly localSession;
+    private readonly normalizer;
+    private localGenCount;
+    private nextRangeBaseGenCount;
+    private readonly sessions;
+    private readonly finalSpace;
+    /**
+     * Roughly equates to a minimum of 1M sessions before we start allocating 64 bit IDs.
+     * Eventually, this can be adjusted dynamically to have cluster reservation policies that
+     * optimize the number of eager finals.
+     * It is not readonly as it is accessed by tests for clear-box testing.
+     */
+    private nextRequestedClusterSize;
+    private telemetryLocalIdCount;
+    private telemetryEagerFinalIdCount;
+    private constructor();
+    /**
+     * @deprecated Use `createIdCompressor` instead.
+     */
+    static create(logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
+    /**
+     * @deprecated Use `createIdCompressor` instead.
+     */
+    static create(sessionId: SessionId, logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
+    generateCompressedId(): SessionSpaceCompressedId;
+    private generateNextLocalId;
+    takeNextCreationRange(): IdCreationRange;
+    private static assertValidRange;
+    finalizeCreationRange(range: IdCreationRange): void;
+    private addEmptyCluster;
+    normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
+    normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
+    decompress(id: SessionSpaceCompressedId): StableId;
+    recompress(uncompressed: StableId): SessionSpaceCompressedId;
+    tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
+    serialize(withSession: true): SerializedIdCompressorWithOngoingSession;
+    serialize(withSession: false): SerializedIdCompressorWithNoSession;
+    static deserialize(serialized: SerializedIdCompressorWithOngoingSession): IdCompressor;
+    static deserialize(serialized: SerializedIdCompressorWithNoSession, newSessionId: SessionId): IdCompressor;
+    equals(other: IdCompressor, includeLocalState: boolean): boolean;
+}
+/**
+ * Create a new {@link IIdCompressor}.
+ * @alpha
+ */
+export declare function createIdCompressor(logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
+/**
+ * Create a new {@link IIdCompressor}.
+ * @param sessionId - The seed ID for the compressor.
+ * @alpha
+ */
+export declare function createIdCompressor(sessionId: SessionId, logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
+/**
+ * Deserializes the supplied state into an ID compressor.
+ * @alpha
+ */
+export declare function deserializeIdCompressor(serialized: SerializedIdCompressorWithOngoingSession): IIdCompressor & IIdCompressorCore;
+/**
+ * Deserializes the supplied state into an ID compressor.
+ * @alpha
+ */
+export declare function deserializeIdCompressor(serialized: SerializedIdCompressorWithNoSession, newSessionId: SessionId): IIdCompressor & IIdCompressorCore;
+//# sourceMappingURL=idCompressor.d.ts.map

package/dist/idCompressor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"idCompressor.d.ts","sourceRoot":"","sources":["../src/idCompressor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE,OAAO,EACN,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EAEnB,mCAAmC,EACnC,wCAAwC,EACxC,SAAS,EACT,wBAAwB,EACxB,QAAQ,EACR,MAAM,SAAS,CAAC;AAqCjB;;;;;;;GAOG;AACH,qBAAa,YAAa,YAAW,aAAa,EAAE,iBAAiB;IA6CnE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IA5CzB;;OAEG;IACH,gBAAuB,cAAc,SAAW;IAIhD,SAAgB,cAAc,EAAE,SAAS,CAAC;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgC;IAE3D,OAAO,CAAC,aAAa,CAAK;IAQ1B,OAAO,CAAC,qBAAqB,CAAK;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAoB;IAM/C;;;;;OAKG;IAEH,OAAO,CAAC,wBAAwB,CAAe;IAE/C,OAAO,CAAC,qBAAqB,CAAK;IAElC,OAAO,CAAC,0BAA0B,CAAK;IAIvC,OAAO;IAqBP;;OAEG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,aAAa,GAAG,iBAAiB;IACtF;;OAEG;WACW,MAAM,CACnB,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB;IAyB7B,oBAAoB,IAAI,wBAAwB;IAyBvD,OAAO,CAAC,mBAAmB;IAMpB,qBAAqB,IAAI,eAAe;IAoB/C,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAaxB,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAmF1D,OAAO,CAAC,eAAe;IAWhB,kBAAkB,CAAC,EAAE,EAAE,wBAAwB,GAAG,mBAAmB;IAerE,uBAAuB,CAC7B,EAAE,EAAE,mBAAmB,EACvB,eAAe,EAAE,SAAS,GACxB,wBAAwB;IA4CpB,UAAU,CAAC,EAAE,EAAE,wBAAwB,GAAG,QAAQ;IAwClD,UAAU,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB;IAQ5D,aAAa,CAAC,YAAY,EAAE,QAAQ,GAAG,wBAAwB,GAAG,SAAS;IAwC3E,SAAS,CAAC,WAAW,EAAE,IAAI,GAAG,wCAAwC;IACtE,SAAS,CAAC,WAAW,EAAE,KAAK,GAAG,mCAAmC;WAuE3D,WAAW,CAAC,UAAU,EAAE,wCAAwC,GAAG,YAAY;WAC/E,WAAW,CACxB,UAAU,EAAE,mCAAmC,EAC/C,YAAY,EAAE,SAAS,GACrB,YAAY;IAyER,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,OAAO,GAAG,OAAO;CAgBvE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CACjC,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB,CAAC;AACrC;;;;GAIG;AACH,wBAAgB,kBAAkB,CACjC,SAAS,EAAE,SAAS,EACpB,MAAM,CAAC,EAAE,oBAAoB,GAC3B,aAAa,GAAG,iBAAiB,CAAC;AAQrC;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,wCAAwC,GAClD,aAAa,GAAG,iBAAiB,CAAC;AACrC;;;GAGG;AACH,wBAAgB,uBAAuB,CACtC,UAAU,EAAE,mCAAmC,EAC/C,YAAY,EAAE,SAAS,GACrB,aAAa,GAAG,iBAAiB,CAAC"}

package/dist/identifiers.cjs

@@ -0,0 +1,15 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFinalId = void 0;
+/**
+ * @returns true if the supplied ID is a final ID.
+ */
+function isFinalId(id) {
+    return id >= 0;
+}
+exports.isFinalId = isFinalId;
+//# sourceMappingURL=identifiers.cjs.map

package/dist/identifiers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifiers.cjs","sourceRoot":"","sources":["../src/identifiers.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAwBH;;GAEG;AACH,SAAgB,SAAS,CACxB,EAAkD;IAElD,OAAO,EAAE,IAAI,CAAC,CAAC;AAChB,CAAC;AAJD,8BAIC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { OpSpaceCompressedId, SessionSpaceCompressedId } from \"./types\";\n\n/**\n * A compressed ID that is stable and unique within the scope of network of compressors (i.e. a document).\n * It can only be used/decompressed in the context of the originating document.\n */\nexport type FinalCompressedId = number & {\n\treadonly FinalCompressedId: \"5d83d1e2-98b7-4e4e-a889-54c855cfa73d\";\n\n\t// Same brand as OpNormalizedCompressedId, as final IDs are always finally normalized\n\treadonly OpNormalized: \"9209432d-a959-4df7-b2ad-767ead4dbcae\";\n};\n\n/**\n * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).\n * Internally, it should not be persisted outside a scope annotated with the originating SessionId in order to be unambiguous.\n * If external persistence is needed (e.g. by a client), a StableId should be used instead.\n */\nexport type LocalCompressedId = number & {\n\treadonly LocalCompressedId: \"6fccb42f-e2a4-4243-bd29-f13d12b9c6d1\";\n} & SessionSpaceCompressedId; // Same brand as CompressedId, as local IDs are always locally normalized\n\n/**\n * @returns true if the supplied ID is a final ID.\n */\nexport function isFinalId(\n\tid: SessionSpaceCompressedId | OpSpaceCompressedId,\n): id is FinalCompressedId {\n\treturn id >= 0;\n}\n\n/**\n * A StableId which is suitable for use as a session identifier\n */\nexport type NumericUuid = bigint & {\n\treadonly NumericUuid: \"be04dd4d-9d7e-4337-a833-eec64c61aa46\";\n};\n"]}

package/dist/identifiers.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { OpSpaceCompressedId, SessionSpaceCompressedId } from "./types";
+/**
+ * A compressed ID that is stable and unique within the scope of network of compressors (i.e. a document).
+ * It can only be used/decompressed in the context of the originating document.
+ */
+export type FinalCompressedId = number & {
+    readonly FinalCompressedId: "5d83d1e2-98b7-4e4e-a889-54c855cfa73d";
+    readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
+};
+/**
+ * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).
+ * Internally, it should not be persisted outside a scope annotated with the originating SessionId in order to be unambiguous.
+ * If external persistence is needed (e.g. by a client), a StableId should be used instead.
+ */
+export type LocalCompressedId = number & {
+    readonly LocalCompressedId: "6fccb42f-e2a4-4243-bd29-f13d12b9c6d1";
+} & SessionSpaceCompressedId;
+/**
+ * @returns true if the supplied ID is a final ID.
+ */
+export declare function isFinalId(id: SessionSpaceCompressedId | OpSpaceCompressedId): id is FinalCompressedId;
+/**
+ * A StableId which is suitable for use as a session identifier
+ */
+export type NumericUuid = bigint & {
+    readonly NumericUuid: "be04dd4d-9d7e-4337-a833-eec64c61aa46";
+};
+//# sourceMappingURL=identifiers.d.ts.map

package/dist/identifiers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifiers.d.ts","sourceRoot":"","sources":["../src/identifiers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG;IACxC,QAAQ,CAAC,iBAAiB,EAAE,sCAAsC,CAAC;IAGnE,QAAQ,CAAC,YAAY,EAAE,sCAAsC,CAAC;CAC9D,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG;IACxC,QAAQ,CAAC,iBAAiB,EAAE,sCAAsC,CAAC;CACnE,GAAG,wBAAwB,CAAC;AAE7B;;GAEG;AACH,wBAAgB,SAAS,CACxB,EAAE,EAAE,wBAAwB,GAAG,mBAAmB,GAChD,EAAE,IAAI,iBAAiB,CAEzB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG;IAClC,QAAQ,CAAC,WAAW,EAAE,sCAAsC,CAAC;CAC7D,CAAC"}

package/dist/index.cjs

@@ -0,0 +1,20 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isStableId = exports.generateStableId = exports.assertIsStableId = exports.createSessionId = exports.IdCompressor = exports.deserializeIdCompressor = exports.createIdCompressor = void 0;
+/**
+ * Exports for `id-compressor`
+ */
+var idCompressor_1 = require("./idCompressor.cjs");
+Object.defineProperty(exports, "createIdCompressor", { enumerable: true, get: function () { return idCompressor_1.createIdCompressor; } });
+Object.defineProperty(exports, "deserializeIdCompressor", { enumerable: true, get: function () { return idCompressor_1.deserializeIdCompressor; } });
+Object.defineProperty(exports, "IdCompressor", { enumerable: true, get: function () { return idCompressor_1.IdCompressor; } });
+var utilities_1 = require("./utilities.cjs");
+Object.defineProperty(exports, "createSessionId", { enumerable: true, get: function () { return utilities_1.createSessionId; } });
+Object.defineProperty(exports, "assertIsStableId", { enumerable: true, get: function () { return utilities_1.assertIsStableId; } });
+Object.defineProperty(exports, "generateStableId", { enumerable: true, get: function () { return utilities_1.generateStableId; } });
+Object.defineProperty(exports, "isStableId", { enumerable: true, get: function () { return utilities_1.isStableId; } });
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AAEH,mDAA2F;AAAlF,kHAAA,kBAAkB,OAAA;AAAE,uHAAA,uBAAuB,OAAA;AAAE,4GAAA,YAAY,OAAA;AAClE,6CAA8F;AAArF,4GAAA,eAAe,OAAA;AAAE,6GAAA,gBAAgB,OAAA;AAAE,6GAAA,gBAAgB,OAAA;AAAE,uGAAA,UAAU,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Exports for `id-compressor`\n */\n\nexport { createIdCompressor, deserializeIdCompressor, IdCompressor } from \"./idCompressor\";\nexport { createSessionId, assertIsStableId, generateStableId, isStableId } from \"./utilities\";\nexport {\n\tIIdCompressorCore,\n\tIIdCompressor,\n\tSerializedIdCompressor,\n\tSerializedIdCompressorWithOngoingSession,\n\tSerializedIdCompressorWithNoSession,\n\tSessionSpaceCompressedId,\n\tOpSpaceCompressedId,\n\tSessionId,\n\tStableId,\n\tIdCreationRange,\n} from \"./types\";\n"]}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Exports for `id-compressor`
+ */
+export { createIdCompressor, deserializeIdCompressor, IdCompressor } from "./idCompressor";
+export { createSessionId, assertIsStableId, generateStableId, isStableId } from "./utilities";
+export { IIdCompressorCore, IIdCompressor, SerializedIdCompressor, SerializedIdCompressorWithOngoingSession, SerializedIdCompressorWithNoSession, SessionSpaceCompressedId, OpSpaceCompressedId, SessionId, StableId, IdCreationRange, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9F,OAAO,EACN,iBAAiB,EACjB,aAAa,EACb,sBAAsB,EACtB,wCAAwC,EACxC,mCAAmC,EACnC,wBAAwB,EACxB,mBAAmB,EACnB,SAAS,EACT,QAAQ,EACR,eAAe,GACf,MAAM,SAAS,CAAC"}

package/dist/packageVersion.cjs

@@ -0,0 +1,12 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pkgVersion = exports.pkgName = void 0;
+exports.pkgName = "@fluidframework/id-compressor";
+exports.pkgVersion = "2.0.0-dev-rc.1.0.0.224419";
+//# sourceMappingURL=packageVersion.cjs.map

package/dist/packageVersion.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.cjs","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,UAAU,GAAG,2BAA2B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/id-compressor\";\nexport const pkgVersion = \"2.0.0-dev-rc.1.0.0.224419\";\n"]}

package/dist/packageVersion.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ *
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+export declare const pkgName = "@fluidframework/id-compressor";
+export declare const pkgVersion = "2.0.0-dev-rc.1.0.0.224419";
+//# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,kCAAkC,CAAC;AACvD,eAAO,MAAM,UAAU,8BAA8B,CAAC"}

package/dist/persistanceUtilities.cjs

@@ -0,0 +1,43 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readBoolean = exports.readNumericUuid = exports.readNumber = exports.writeBoolean = exports.writeNumericUuid = exports.writeNumber = void 0;
+const halfNumeric = BigInt("0xFFFFFFFFFFFFFFFF");
+const sixtyFour = BigInt(64);
+function writeNumber(buffer, index, value) {
+    buffer[index] = value;
+    return index + 1;
+}
+exports.writeNumber = writeNumber;
+function writeNumericUuid(buffer, index, value) {
+    buffer[index] = value & halfNumeric;
+    buffer[index + 1] = value >> sixtyFour;
+    return index + 2; // UUID values are 16 bytes.
+}
+exports.writeNumericUuid = writeNumericUuid;
+function writeBoolean(buffer, index, value) {
+    return writeNumber(buffer, index, value ? 1 : 0);
+}
+exports.writeBoolean = writeBoolean;
+function readNumber(index) {
+    const value = index.bufferFloat[index.index];
+    index.index += 1;
+    return value;
+}
+exports.readNumber = readNumber;
+function readNumericUuid(index) {
+    const lowerHalf = index.bufferUint[index.index];
+    const upperHalf = index.bufferUint[index.index + 1];
+    const value = (upperHalf << sixtyFour) | lowerHalf;
+    index.index += 2;
+    return value;
+}
+exports.readNumericUuid = readNumericUuid;
+function readBoolean(index) {
+    return readNumber(index) === 1;
+}
+exports.readBoolean = readBoolean;
+//# sourceMappingURL=persistanceUtilities.cjs.map

package/dist/persistanceUtilities.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistanceUtilities.cjs","sourceRoot":"","sources":["../src/persistanceUtilities.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAKH,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,CAAC,CAAC;AACjD,MAAM,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;AAE7B,SAAgB,WAAW,CAAC,MAAoB,EAAE,KAAa,EAAE,KAAa;IAC7E,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IACtB,OAAO,KAAK,GAAG,CAAC,CAAC;AAClB,CAAC;AAHD,kCAGC;AAED,SAAgB,gBAAgB,CAC/B,MAAsB,EACtB,KAAa,EACb,KAAkB;IAElB,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,WAAW,CAAC;IACpC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,KAAK,IAAI,SAAS,CAAC;IACvC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,4BAA4B;AAC/C,CAAC;AARD,4CAQC;AAED,SAAgB,YAAY,CAAC,MAAoB,EAAE,KAAa,EAAE,KAAc;IAC/E,OAAO,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClD,CAAC;AAFD,oCAEC;AAaD,SAAgB,UAAU,CAAC,KAAY;IACtC,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7C,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IACjB,OAAO,KAAK,CAAC;AACd,CAAC;AAJD,gCAIC;AAED,SAAgB,eAAe,CAAC,KAAY;IAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACpD,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,SAAS,CAAC,GAAG,SAAS,CAAC;IACnD,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;IACjB,OAAO,KAAoB,CAAC;AAC7B,CAAC;AAND,0CAMC;AAED,SAAgB,WAAW,CAAC,KAAY;IACvC,OAAO,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAFD,kCAEC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable no-bitwise */\nimport { NumericUuid } from \"./identifiers\";\n\nconst halfNumeric = BigInt(\"0xFFFFFFFFFFFFFFFF\");\nconst sixtyFour = BigInt(64);\n\nexport function writeNumber(buffer: Float64Array, index: number, value: number): number {\n\tbuffer[index] = value;\n\treturn index + 1;\n}\n\nexport function writeNumericUuid(\n\tbuffer: BigUint64Array,\n\tindex: number,\n\tvalue: NumericUuid,\n): number {\n\tbuffer[index] = value & halfNumeric;\n\tbuffer[index + 1] = value >> sixtyFour;\n\treturn index + 2; // UUID values are 16 bytes.\n}\n\nexport function writeBoolean(buffer: Float64Array, index: number, value: boolean): number {\n\treturn writeNumber(buffer, index, value ? 1 : 0);\n}\n\n/**\n * Helper type to allow returning a value when reading as well as incrementing an index to make\n * deserialization easier.\n * Should be constructed with two views of the same buffer and index set to 0.\n */\nexport interface Index {\n\tbufferFloat: Float64Array;\n\tbufferUint: BigUint64Array;\n\tindex: number;\n}\n\nexport function readNumber(index: Index): number {\n\tconst value = index.bufferFloat[index.index];\n\tindex.index += 1;\n\treturn value;\n}\n\nexport function readNumericUuid(index: Index): NumericUuid {\n\tconst lowerHalf = index.bufferUint[index.index];\n\tconst upperHalf = index.bufferUint[index.index + 1];\n\tconst value = (upperHalf << sixtyFour) | lowerHalf;\n\tindex.index += 2;\n\treturn value as NumericUuid;\n}\n\nexport function readBoolean(index: Index): boolean {\n\treturn readNumber(index) === 1;\n}\n"]}

package/dist/persistanceUtilities.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { NumericUuid } from "./identifiers";
+export declare function writeNumber(buffer: Float64Array, index: number, value: number): number;
+export declare function writeNumericUuid(buffer: BigUint64Array, index: number, value: NumericUuid): number;
+export declare function writeBoolean(buffer: Float64Array, index: number, value: boolean): number;
+/**
+ * Helper type to allow returning a value when reading as well as incrementing an index to make
+ * deserialization easier.
+ * Should be constructed with two views of the same buffer and index set to 0.
+ */
+export interface Index {
+    bufferFloat: Float64Array;
+    bufferUint: BigUint64Array;
+    index: number;
+}
+export declare function readNumber(index: Index): number;
+export declare function readNumericUuid(index: Index): NumericUuid;
+export declare function readBoolean(index: Index): boolean;
+//# sourceMappingURL=persistanceUtilities.d.ts.map

package/dist/persistanceUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"persistanceUtilities.d.ts","sourceRoot":"","sources":["../src/persistanceUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAK5C,wBAAgB,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAGtF;AAED,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,WAAW,GAChB,MAAM,CAIR;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM,CAExF;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACrB,WAAW,EAAE,YAAY,CAAC;IAC1B,UAAU,EAAE,cAAc,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;CACd;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAI/C;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAMzD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAEjD"}

package/dist/sessionSpaceNormalizer.cjs

@@ -0,0 +1,80 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionSpaceNormalizer = void 0;
+const appendOnlySortedMap_1 = require("./appendOnlySortedMap.cjs");
+const utilities_1 = require("./utilities.cjs");
+/**
+ * The `SessionSpaceNormalizer` tracks the form of the IDs created by the local session.
+ * More precisely, it acts as a set of all `LocalCompressedId`s created by the local session and allows querying whether a specific
+ * ID was produced by the local session. This information can be used to determine whether the nth ID created by the local session
+ * was produced as a local ID (negative) or a final ID (positive).
+ *
+ * The local and final forms of IDs made by a session can be thought of as two equal-length sparse arrays, aligned such
+ * that normalizeLocalToFinal(locals[i]) === finals[i] and vice versa.
+ * Below is an example to illustrate how various mappings can arise:
+ *
+ * ```
+ *     +- Creation Index
+ *    /     +- Locals
+ *   /     /    +- Finals
+ *  /     /    /
+ * ---+-----+----
+ * 0  | -1  | 0   -|___ Two IDs are allocated as locals since no cluster exists. A new cluster is created when acked.
+ * 1  | -2  | 1   -|
+ * 2  |     | 2   -|
+ * 3  |     | 3   --|-- Three more IDs are allocated as finals eagerly since a cluster exists with available capacity.
+ * 4  |     | 4   -|
+ * 5  | -6  | 10  ----- One ID is allocated as a local (it overflows the existing cluster) and a new cluster is created after ack.
+ * 6  |     | 11  ----- This ID (and the subsequent few) is allocated eagerly as a final ID into the existing cluster.
+ * 7  |     | 12
+ * 8  |     | 13
+ * 9  |     | 14
+ * 10 | -11 |     ----- The cluster is out of room, so a local ID is allocated. It has no corresponding final ID since it has not been acked.
+ * ```
+ *
+ * This class stores the set of local IDs and thus their indices, as local IDs are essentially negative offsets from the first ID.
+ * The form (local or final) of a given ID index (for example, the 5th ID made by the local session) can be deduced from this information.
+ */
+class SessionSpaceNormalizer {
+    constructor() {
+        // Run-length encoding of IDs that were generated as local IDs. They are stored as a list of tuples (genCount, count)
+        // that are sorted on the genCount so that contains checks can use a binary search.
+        this.localIdRanges = new appendOnlySortedMap_1.AppendOnlySortedMap(utilities_1.compareFiniteNumbers);
+    }
+    get idRanges() {
+        return this.localIdRanges;
+    }
+    addLocalRange(baseGenCount, count) {
+        const last = this.localIdRanges.last();
+        if (last !== undefined) {
+            const [lastGenCount, lastCount] = last;
+            // Check to see if the added run of local IDs is contiguous with the last range added.
+            // If it is, simply merge them (this is the common case).
+            if (lastGenCount + lastCount === baseGenCount) {
+                this.localIdRanges.replaceLast(lastGenCount, lastCount + count);
+                return;
+            }
+        }
+        this.localIdRanges.append(baseGenCount, count);
+    }
+    contains(query) {
+        const genCount = (0, utilities_1.genCountFromLocalId)(query);
+        const containingBlock = this.localIdRanges.getPairOrNextLower(genCount);
+        if (containingBlock !== undefined) {
+            const [baseGenCount, count] = containingBlock;
+            if (genCount <= baseGenCount + (count - 1)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    equals(other) {
+        return this.localIdRanges.equals(other.localIdRanges, (countA, countB) => countA === countB);
+    }
+}
+exports.SessionSpaceNormalizer = SessionSpaceNormalizer;
+//# sourceMappingURL=sessionSpaceNormalizer.cjs.map

package/dist/sessionSpaceNormalizer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionSpaceNormalizer.cjs","sourceRoot":"","sources":["../src/sessionSpaceNormalizer.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,mEAA4D;AAE5D,+CAAwE;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,sBAAsB;IAAnC;QACC,qHAAqH;QACrH,mFAAmF;QAClE,kBAAa,GAAG,IAAI,yCAAmB,CAAiB,gCAAoB,CAAC,CAAC;IAsChG,CAAC;IApCA,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IAEM,aAAa,CAAC,YAAoB,EAAE,KAAa;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,IAAI,KAAK,SAAS,EAAE;YACvB,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC;YACvC,sFAAsF;YACtF,yDAAyD;YACzD,IAAI,YAAY,GAAG,SAAS,KAAK,YAAY,EAAE;gBAC9C,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,YAAY,EAAE,SAAS,GAAG,KAAK,CAAC,CAAC;gBAChE,OAAO;aACP;SACD;QACD,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAEM,QAAQ,CAAC,KAAwB;QACvC,MAAM,QAAQ,GAAG,IAAA,+BAAmB,EAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;QACxE,IAAI,eAAe,KAAK,SAAS,EAAE;YAClC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,GAAG,eAAe,CAAC;YAC9C,IAAI,QAAQ,IAAI,YAAY,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE;gBAC3C,OAAO,IAAI,CAAC;aACZ;SACD;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,MAAM,CAAC,KAA6B;QAC1C,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC/B,KAAK,CAAC,aAAa,EACnB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,MAAM,CACrC,CAAC;IACH,CAAC;CACD;AAzCD,wDAyCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AppendOnlySortedMap } from \"./appendOnlySortedMap\";\nimport { LocalCompressedId } from \"./identifiers\";\nimport { compareFiniteNumbers, genCountFromLocalId } from \"./utilities\";\n\n/**\n * The `SessionSpaceNormalizer` tracks the form of the IDs created by the local session.\n * More precisely, it acts as a set of all `LocalCompressedId`s created by the local session and allows querying whether a specific\n * ID was produced by the local session. This information can be used to determine whether the nth ID created by the local session\n * was produced as a local ID (negative) or a final ID (positive).\n *\n * The local and final forms of IDs made by a session can be thought of as two equal-length sparse arrays, aligned such\n * that normalizeLocalToFinal(locals[i]) === finals[i] and vice versa.\n * Below is an example to illustrate how various mappings can arise:\n *\n * ```\n *     +- Creation Index\n *    /     +- Locals\n *   /     /    +- Finals\n *  /     /    /\n * ---+-----+----\n * 0  | -1  | 0   -|___ Two IDs are allocated as locals since no cluster exists. A new cluster is created when acked.\n * 1  | -2  | 1   -|\n * 2  |     | 2   -|\n * 3  |     | 3   --|-- Three more IDs are allocated as finals eagerly since a cluster exists with available capacity.\n * 4  |     | 4   -|\n * 5  | -6  | 10  ----- One ID is allocated as a local (it overflows the existing cluster) and a new cluster is created after ack.\n * 6  |     | 11  ----- This ID (and the subsequent few) is allocated eagerly as a final ID into the existing cluster.\n * 7  |     | 12\n * 8  |     | 13\n * 9  |     | 14\n * 10 | -11 |     ----- The cluster is out of room, so a local ID is allocated. It has no corresponding final ID since it has not been acked.\n * ```\n *\n * This class stores the set of local IDs and thus their indices, as local IDs are essentially negative offsets from the first ID.\n * The form (local or final) of a given ID index (for example, the 5th ID made by the local session) can be deduced from this information.\n */\nexport class SessionSpaceNormalizer {\n\t// Run-length encoding of IDs that were generated as local IDs. They are stored as a list of tuples (genCount, count)\n\t// that are sorted on the genCount so that contains checks can use a binary search.\n\tprivate readonly localIdRanges = new AppendOnlySortedMap<number, number>(compareFiniteNumbers);\n\n\tpublic get idRanges(): Pick<AppendOnlySortedMap<number, number>, \"size\" | \"entries\"> {\n\t\treturn this.localIdRanges;\n\t}\n\n\tpublic addLocalRange(baseGenCount: number, count: number): void {\n\t\tconst last = this.localIdRanges.last();\n\t\tif (last !== undefined) {\n\t\t\tconst [lastGenCount, lastCount] = last;\n\t\t\t// Check to see if the added run of local IDs is contiguous with the last range added.\n\t\t\t// If it is, simply merge them (this is the common case).\n\t\t\tif (lastGenCount + lastCount === baseGenCount) {\n\t\t\t\tthis.localIdRanges.replaceLast(lastGenCount, lastCount + count);\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\t\tthis.localIdRanges.append(baseGenCount, count);\n\t}\n\n\tpublic contains(query: LocalCompressedId): boolean {\n\t\tconst genCount = genCountFromLocalId(query);\n\t\tconst containingBlock = this.localIdRanges.getPairOrNextLower(genCount);\n\t\tif (containingBlock !== undefined) {\n\t\t\tconst [baseGenCount, count] = containingBlock;\n\t\t\tif (genCount <= baseGenCount + (count - 1)) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\t\treturn false;\n\t}\n\n\tpublic equals(other: SessionSpaceNormalizer): boolean {\n\t\treturn this.localIdRanges.equals(\n\t\t\tother.localIdRanges,\n\t\t\t(countA, countB) => countA === countB,\n\t\t);\n\t}\n}\n"]}

package/dist/sessionSpaceNormalizer.d.ts

@@ -0,0 +1,46 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AppendOnlySortedMap } from "./appendOnlySortedMap";
+import { LocalCompressedId } from "./identifiers";
+/**
+ * The `SessionSpaceNormalizer` tracks the form of the IDs created by the local session.
+ * More precisely, it acts as a set of all `LocalCompressedId`s created by the local session and allows querying whether a specific
+ * ID was produced by the local session. This information can be used to determine whether the nth ID created by the local session
+ * was produced as a local ID (negative) or a final ID (positive).
+ *
+ * The local and final forms of IDs made by a session can be thought of as two equal-length sparse arrays, aligned such
+ * that normalizeLocalToFinal(locals[i]) === finals[i] and vice versa.
+ * Below is an example to illustrate how various mappings can arise:
+ *
+ * ```
+ *     +- Creation Index
+ *    /     +- Locals
+ *   /     /    +- Finals
+ *  /     /    /
+ * ---+-----+----
+ * 0  | -1  | 0   -|___ Two IDs are allocated as locals since no cluster exists. A new cluster is created when acked.
+ * 1  | -2  | 1   -|
+ * 2  |     | 2   -|
+ * 3  |     | 3   --|-- Three more IDs are allocated as finals eagerly since a cluster exists with available capacity.
+ * 4  |     | 4   -|
+ * 5  | -6  | 10  ----- One ID is allocated as a local (it overflows the existing cluster) and a new cluster is created after ack.
+ * 6  |     | 11  ----- This ID (and the subsequent few) is allocated eagerly as a final ID into the existing cluster.
+ * 7  |     | 12
+ * 8  |     | 13
+ * 9  |     | 14
+ * 10 | -11 |     ----- The cluster is out of room, so a local ID is allocated. It has no corresponding final ID since it has not been acked.
+ * ```
+ *
+ * This class stores the set of local IDs and thus their indices, as local IDs are essentially negative offsets from the first ID.
+ * The form (local or final) of a given ID index (for example, the 5th ID made by the local session) can be deduced from this information.
+ */
+export declare class SessionSpaceNormalizer {
+    private readonly localIdRanges;
+    get idRanges(): Pick<AppendOnlySortedMap<number, number>, "size" | "entries">;
+    addLocalRange(baseGenCount: number, count: number): void;
+    contains(query: LocalCompressedId): boolean;
+    equals(other: SessionSpaceNormalizer): boolean;
+}
+//# sourceMappingURL=sessionSpaceNormalizer.d.ts.map

package/dist/sessionSpaceNormalizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionSpaceNormalizer.d.ts","sourceRoot":"","sources":["../src/sessionSpaceNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAGlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,sBAAsB;IAGlC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiE;IAE/F,IAAW,QAAQ,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,CAEnF;IAEM,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAcxD,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAY3C,MAAM,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO;CAMrD"}