@fluidframework/id-compressor 2.0.0-dev-rc.1.0.0.232845 → 2.0.0-dev-rc.2.0.0.246488

package/.eslintrc.cjs

@@ -4,15 +4,15 @@
  */
 
 module.exports = {
-	extends: [require.resolve("@fluidframework/eslint-config-fluid/minimal"), "prettier"],
+	extends: [
+		require.resolve("@fluidframework/eslint-config-fluid/minimal-deprecated"),
+		"prettier",
+	],
 	parserOptions: {
 		project: ["./tsconfig.json", "./src/test/tsconfig.json"],
 	},
 	rules: {
 		"@typescript-eslint/strict-boolean-expressions": "off",
-
-		// This library is used in the browser, so we don't want dependencies on most node libraries.
-		"import/no-nodejs-modules": ["error", { allow: ["events"] }],
 	},
 	overrides: [
 		{
@@ -20,7 +20,7 @@ module.exports = {
 			files: ["*.spec.ts", "src/test/**"],
 			rules: {
 				// Test files are run in node only so additional node libraries can be used.
-				"import/no-nodejs-modules": ["error", { allow: ["assert", "crypto", "events"] }],
+				"import/no-nodejs-modules": ["error", { allow: ["assert", "crypto"] }],
 			},
 		},
 	],

package/{.mocharc.js → .mocharc.cjs}

@@ -5,7 +5,7 @@
 
 "use strict";
 
-const getFluidTestMochaConfig = require("@fluidframework/mocha-test-setup/mocharc-common");
+const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
 
 const packageDir = __dirname;
 const config = getFluidTestMochaConfig(packageDir);

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluidframework/id-compressor
 
+## 2.0.0-rc.2.0.0
+
+### Minor Changes
+
+-   id-compressor: Deprecated ID compressor class has been removed from the public API. ([#19054](https://github.com/microsoft/FluidFramework/issues/19054)) [46a05617b2](https://github.com/microsoft/FluidFramework/commits/46a05617b2a42bf2763e49e4ccddd3ee8df9c05d)
+
+    This change should be a no-op for consumers, as there were already better static creation/deserialization functions for use and compressor types are generally unused outside the runtime.
+
 ## 2.0.0-rc.1.0.0
 
 ### Minor Changes

package/{api-extractor-esm.json → api-extractor-cjs.json}

@@ -1,4 +1,8 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base-esm.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.cjs.primary.json",
+	// CJS is actually secondary; so, no report.
+	"apiReport": {
+		"enabled": false
+	}
 }

package/api-extractor-lint.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-lint.json"
+	"extends": "../../../common/build/build-common/api-extractor-lint.esm.primary.json"
 }

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.json"
+	"extends": "../../../common/build/build-common/api-extractor-base.esm.primary.json"
 }

package/api-report/id-compressor.api.md

@@ -44,7 +44,7 @@ export interface IdCreationRange {
 export interface IIdCompressor {
     decompress(id: SessionSpaceCompressedId): StableId;
     generateCompressedId(): SessionSpaceCompressedId;
-    // (undocumented)
+    generateDocumentUniqueId(): (SessionSpaceCompressedId & OpSpaceCompressedId) | StableId;
     localSessionId: SessionId;
     normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
     normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
@@ -52,7 +52,7 @@ export interface IIdCompressor {
     tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
 }
 
-// @alpha (undocumented)
+// @alpha
 export interface IIdCompressorCore {
     beginGhostSession(ghostSessionId: SessionId, ghostSessionCallback: () => void): any;
     finalizeCreationRange(range: IdCreationRange): void;

package/dist/finalSpace.d.ts

@@ -2,8 +2,8 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { IdCluster } from "./sessions";
-import { FinalCompressedId } from "./identifiers";
+import { IdCluster } from "./sessions.js";
+import { FinalCompressedId } from "./identifiers.js";
 /**
  * All IDs that have been finalized (acked), grouped into clusters sorted by their base final IDs.
  * These clusters span the positive integer space and are not sparse, meaning a cluster's base final

package/dist/finalSpace.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"finalSpace.d.ts","sourceRoot":"","sources":["../src/finalSpace.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,SAAS,EAAyD,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAElD;;;;GAIG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,IAAW,QAAQ,IAAI,SAAS,SAAS,EAAE,CAE1C;IAEM,cAAc,IAAI,SAAS,GAAG,SAAS;IAIvC,UAAU,CAAC,UAAU,EAAE,SAAS;IAWvC;;;OAGG;IACI,mBAAmB,IAAI,iBAAiB;IAO/C;;;OAGG;IACI,mBAAmB,IAAI,iBAAiB;IAOxC,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;CAQzC"}
+{"version":3,"file":"finalSpace.d.ts","sourceRoot":"","sources":["../src/finalSpace.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,SAAS,EAAyD,MAAM,eAAe,CAAC;AACjG,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAErD;;;;GAIG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAE/C,IAAW,QAAQ,IAAI,SAAS,SAAS,EAAE,CAE1C;IAEM,cAAc,IAAI,SAAS,GAAG,SAAS;IAIvC,UAAU,CAAC,UAAU,EAAE,SAAS;IAWvC;;;OAGG;IACI,mBAAmB,IAAI,iBAAiB;IAO/C;;;OAGG;IACI,mBAAmB,IAAI,iBAAiB;IAOxC,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO;CAQzC"}

package/dist/finalSpace.js

@@ -6,7 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FinalSpace = void 0;
 const core_utils_1 = require("@fluidframework/core-utils");
-const sessions_1 = require("./sessions");
+const sessions_js_1 = require("./sessions.js");
 /**
  * All IDs that have been finalized (acked), grouped into clusters sorted by their base final IDs.
  * These clusters span the positive integer space and are not sparse, meaning a cluster's base final
@@ -37,7 +37,7 @@ class FinalSpace {
         const lastCluster = this.getLastCluster();
         return lastCluster === undefined
             ? 0
-            : ((0, sessions_1.lastFinalizedFinal)(lastCluster) + 1);
+            : ((0, sessions_js_1.lastFinalizedFinal)(lastCluster) + 1);
     }
     /**
      * @returns the upper bound (exclusive) of allocated IDs in final space, i.e. one greater than the last final ID in the last cluster.
@@ -47,11 +47,11 @@ class FinalSpace {
         const lastCluster = this.getLastCluster();
         return lastCluster === undefined
             ? 0
-            : ((0, sessions_1.lastAllocatedFinal)(lastCluster) + 1);
+            : ((0, sessions_js_1.lastAllocatedFinal)(lastCluster) + 1);
     }
     equals(other) {
         for (let i = 0; i < this.clusterList.length; i++) {
-            if (!(0, sessions_1.clustersEqual)(this.clusterList[i], other.clusterList[i])) {
+            if (!(0, sessions_js_1.clustersEqual)(this.clusterList[i], other.clusterList[i])) {
                 return false;
             }
         }

package/dist/finalSpace.js.map

@@ -1 +1 @@
-{"version":3,"file":"finalSpace.js","sourceRoot":"","sources":["../src/finalSpace.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,yCAA8F;AAG9F;;;;GAIG;AACH,MAAa,UAAU;IAAvB;QACkB,gBAAW,GAAgB,EAAE,CAAC;IAmDhD,CAAC;IAjDA,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAEM,cAAc;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAEM,UAAU,CAAC,UAAqB;QACtC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,IAAA,mBAAM,EACL,WAAW,KAAK,SAAS;YACxB,qEAAqE;YACrE,UAAU,CAAC,WAAW,KAAK,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,EAC1E,KAAK,CAAC,oDAAoD,CAC1D,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,WAAW,KAAK,SAAS;YAC/B,CAAC,CAAE,CAAuB;YAC1B,CAAC,CAAE,CAAE,IAAA,6BAAkB,EAAC,WAAW,CAAY,GAAG,CAAC,CAAuB,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,WAAW,KAAK,SAAS;YAC/B,CAAC,CAAE,CAAuB;YAC1B,CAAC,CAAE,CAAE,IAAA,6BAAkB,EAAC,WAAW,CAAY,GAAG,CAAC,CAAuB,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,KAAiB;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACjD,IAAI,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC9D,OAAO,KAAK,CAAC;aACb;SACD;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC;IAC7D,CAAC;CACD;AApDD,gCAoDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IdCluster, clustersEqual, lastAllocatedFinal, lastFinalizedFinal } from \"./sessions\";\nimport { FinalCompressedId } from \"./identifiers\";\n\n/**\n * All IDs that have been finalized (acked), grouped into clusters sorted by their base final IDs.\n * These clusters span the positive integer space and are not sparse, meaning a cluster's base final\n * ID will always be one greater than the last final ID in the previous cluster (or 0 if there is not one).\n */\nexport class FinalSpace {\n\tprivate readonly clusterList: IdCluster[] = [];\n\n\tpublic get clusters(): readonly IdCluster[] {\n\t\treturn this.clusterList;\n\t}\n\n\tpublic getLastCluster(): IdCluster | undefined {\n\t\treturn this.clusterList[this.clusterList.length - 1];\n\t}\n\n\tpublic addCluster(newCluster: IdCluster) {\n\t\tconst lastCluster = this.getLastCluster();\n\t\tassert(\n\t\t\tlastCluster === undefined ||\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/restrict-plus-operands\n\t\t\t\tnewCluster.baseFinalId === lastCluster.baseFinalId + lastCluster.capacity,\n\t\t\t0x753 /* Cluster insert to final_space is out of order. */,\n\t\t);\n\t\tthis.clusterList.push(newCluster);\n\t}\n\n\t/**\n\t * @returns the upper bound (exclusive) of finalized IDs in final space, i.e. one greater than the last final ID in the last cluster.\n\t * Note: this does not include allocated but unfinalized space in clusters.\n\t */\n\tpublic getFinalizedIdLimit(): FinalCompressedId {\n\t\tconst lastCluster = this.getLastCluster();\n\t\treturn lastCluster === undefined\n\t\t\t? (0 as FinalCompressedId)\n\t\t\t: (((lastFinalizedFinal(lastCluster) as number) + 1) as FinalCompressedId);\n\t}\n\n\t/**\n\t * @returns the upper bound (exclusive) of allocated IDs in final space, i.e. one greater than the last final ID in the last cluster.\n\t * Note: this does includes all allocated IDs in clusters.\n\t */\n\tpublic getAllocatedIdLimit(): FinalCompressedId {\n\t\tconst lastCluster = this.getLastCluster();\n\t\treturn lastCluster === undefined\n\t\t\t? (0 as FinalCompressedId)\n\t\t\t: (((lastAllocatedFinal(lastCluster) as number) + 1) as FinalCompressedId);\n\t}\n\n\tpublic equals(other: FinalSpace): boolean {\n\t\tfor (let i = 0; i < this.clusterList.length; i++) {\n\t\t\tif (!clustersEqual(this.clusterList[i], other.clusterList[i])) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t\treturn this.clusterList.length === other.clusterList.length;\n\t}\n}\n"]}
+{"version":3,"file":"finalSpace.js","sourceRoot":"","sources":["../src/finalSpace.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AACpD,+CAAiG;AAGjG;;;;GAIG;AACH,MAAa,UAAU;IAAvB;QACkB,gBAAW,GAAgB,EAAE,CAAC;IAmDhD,CAAC;IAjDA,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAEM,cAAc;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IAEM,UAAU,CAAC,UAAqB;QACtC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,IAAA,mBAAM,EACL,WAAW,KAAK,SAAS;YACxB,qEAAqE;YACrE,UAAU,CAAC,WAAW,KAAK,WAAW,CAAC,WAAW,GAAG,WAAW,CAAC,QAAQ,EAC1E,KAAK,CAAC,oDAAoD,CAC1D,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,WAAW,KAAK,SAAS;YAC/B,CAAC,CAAE,CAAuB;YAC1B,CAAC,CAAE,CAAE,IAAA,gCAAkB,EAAC,WAAW,CAAY,GAAG,CAAC,CAAuB,CAAC;IAC7E,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,OAAO,WAAW,KAAK,SAAS;YAC/B,CAAC,CAAE,CAAuB;YAC1B,CAAC,CAAE,CAAE,IAAA,gCAAkB,EAAC,WAAW,CAAY,GAAG,CAAC,CAAuB,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,KAAiB;QAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACjD,IAAI,CAAC,IAAA,2BAAa,EAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC9D,OAAO,KAAK,CAAC;aACb;SACD;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC;IAC7D,CAAC;CACD;AApDD,gCAoDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IdCluster, clustersEqual, lastAllocatedFinal, lastFinalizedFinal } from \"./sessions.js\";\nimport { FinalCompressedId } from \"./identifiers.js\";\n\n/**\n * All IDs that have been finalized (acked), grouped into clusters sorted by their base final IDs.\n * These clusters span the positive integer space and are not sparse, meaning a cluster's base final\n * ID will always be one greater than the last final ID in the previous cluster (or 0 if there is not one).\n */\nexport class FinalSpace {\n\tprivate readonly clusterList: IdCluster[] = [];\n\n\tpublic get clusters(): readonly IdCluster[] {\n\t\treturn this.clusterList;\n\t}\n\n\tpublic getLastCluster(): IdCluster | undefined {\n\t\treturn this.clusterList[this.clusterList.length - 1];\n\t}\n\n\tpublic addCluster(newCluster: IdCluster) {\n\t\tconst lastCluster = this.getLastCluster();\n\t\tassert(\n\t\t\tlastCluster === undefined ||\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/restrict-plus-operands\n\t\t\t\tnewCluster.baseFinalId === lastCluster.baseFinalId + lastCluster.capacity,\n\t\t\t0x753 /* Cluster insert to final_space is out of order. */,\n\t\t);\n\t\tthis.clusterList.push(newCluster);\n\t}\n\n\t/**\n\t * @returns the upper bound (exclusive) of finalized IDs in final space, i.e. one greater than the last final ID in the last cluster.\n\t * Note: this does not include allocated but unfinalized space in clusters.\n\t */\n\tpublic getFinalizedIdLimit(): FinalCompressedId {\n\t\tconst lastCluster = this.getLastCluster();\n\t\treturn lastCluster === undefined\n\t\t\t? (0 as FinalCompressedId)\n\t\t\t: (((lastFinalizedFinal(lastCluster) as number) + 1) as FinalCompressedId);\n\t}\n\n\t/**\n\t * @returns the upper bound (exclusive) of allocated IDs in final space, i.e. one greater than the last final ID in the last cluster.\n\t * Note: this does includes all allocated IDs in clusters.\n\t */\n\tpublic getAllocatedIdLimit(): FinalCompressedId {\n\t\tconst lastCluster = this.getLastCluster();\n\t\treturn lastCluster === undefined\n\t\t\t? (0 as FinalCompressedId)\n\t\t\t: (((lastAllocatedFinal(lastCluster) as number) + 1) as FinalCompressedId);\n\t}\n\n\tpublic equals(other: FinalSpace): boolean {\n\t\tfor (let i = 0; i < this.clusterList.length; i++) {\n\t\t\tif (!clustersEqual(this.clusterList[i], other.clusterList[i])) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t\treturn this.clusterList.length === other.clusterList.length;\n\t}\n}\n"]}

package/dist/id-compressor-alpha.d.ts

@@ -62,6 +62,120 @@ export declare interface IdCreationRange {
     };
 }
 
+/**
+ * A distributed UUID generator and compressor.
+ * `IdCompressor` offers the ability to generate arbitrary non-colliding v4 UUIDs, called stable IDs, while compressing them into small integers
+ * for efficient storage and transmission. It also provides the ability to decompress these integers back into their original UUIDs.
+ *
+ * The compressor is designed to be used in a distributed environment, where multiple clients may be generating IDs concurrently.
+ * IDs generated by a compressor, via calls to `generateCompressedId`, are created in the compressor's "local" session.
+ * These IDs are unique within the session, but may not be unique across sessions. In the context of Fluid, the scope of a session
+ * is the same as the scope of a container. This means that anytime IDs are transferred between sessions, they must be translated
+ * through a process called "normalization":
+ * - The scope of a local session (in which local IDs are unique) is called the "session space" of the client.
+ * - The context of persisted state (in Fluid, this is the context of ops and summaries) is called "op space".
+ * - `SessionSpaceCompressedId`s, generated via calls to `generateCompressedId`, should NEVER be serialized directly.
+ * In Fluid, this means they should not be included in ops or summaries.
+ * - Before serialization, IDs must be normalized to op space to ensure they are interpretable by other clients.
+ * - Upon receipt, IDs should be normalized back to session space before use.
+ *
+ * Example Usage:
+ *
+ * ### Client A (Sender)
+ *
+ * ```typescript
+ * // Generate several local IDs
+ * const localId1 = idCompressor.generateCompressedId();
+ * const localId2 = idCompressor.generateCompressedId();
+ * const localId3 = idCompressor.generateCompressedId();
+ *
+ * // Normalize these IDs to op space for inclusion in a message
+ * const opSpaceId1 = idCompressor.normalizeToOpSpace(localId1);
+ * const opSpaceId2 = idCompressor.normalizeToOpSpace(localId2);
+ * const opSpaceId3 = idCompressor.normalizeToOpSpace(localId3);
+ *
+ * // Create and send a message containing these op space IDs along with the sender's session ID
+ * // In Fluid, this would be an op or summary
+ * const message = {
+ *     sessionID: idCompressor.localSessionId,
+ *     ids: [opSpaceId1, opSpaceId2, opSpaceId3]
+ * };
+ * ```
+ *
+ * ### Client B (Receiver)
+ *
+ * ```typescript
+ * // Receive the message from Client A
+ * const receivedMessage = ...; // In Fluid, this would be an op or summary
+ *
+ * // Normalize the received IDs back to session space, utilizing the sender's session ID
+ * const sessionSpaceId1 = idCompressor.normalizeToSessionSpace(receivedMessage.ids[0], receivedMessage.sessionID);
+ * const sessionSpaceId2 = idCompressor.normalizeToSessionSpace(receivedMessage.ids[1], receivedMessage.sessionID);
+ * const sessionSpaceId3 = idCompressor.normalizeToSessionSpace(receivedMessage.ids[2], receivedMessage.sessionID);
+ * ```
+ * @public
+ */
+export declare interface IIdCompressor {
+    /**
+     * The local session ID.
+     */
+    localSessionId: SessionId;
+    /**
+     * Generates a new compressed ID.
+     * The returned ID is in session space and should not be serialized directly. See `IIdCompressor` for more details.
+     * @returns A new local ID in session space.
+     */
+    generateCompressedId(): SessionSpaceCompressedId;
+    /**
+     * Generates a new ID that is guaranteed to be unique across all sessions known to this compressor without the need for any
+     * normalization. The returned ID is not guaranteed to be a compressed ID (small number); it may be a stable ID (UUID string).
+     * In Fluid, the likelihood of generating the bulkier stable ID is dictated by network conditions and is highly probably in
+     * scenarios such as offline. This is still useful for use cases where simplicity is more important than performance and
+     * this approach will often be superior to generating a UUID.
+     * If small numbers are a requirement, `generateCompressedId` and normalization should be used instead.
+     * See `IIdCompressor` for more details.
+     * @returns A new local ID in session space.
+     */
+    generateDocumentUniqueId(): (SessionSpaceCompressedId & OpSpaceCompressedId) | StableId;
+    /**
+     * Normalizes a session space ID into op space.
+     * The returned ID is in op space and can be safely serialized. However, it should be normalized back to session space before use.
+     * See `IIdCompressor` for more details.
+     * @param id - The local ID to normalize.
+     * @returns The ID in op space.
+     */
+    normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
+    /**
+     * Normalizes an ID into session space.
+     * @param id - The ID to normalize.
+     * @param originSessionId - The session from which `id` originated. This should be the ID of the client that normalized `id` to op space.
+     * This means that it may not be the client that created `id` in the first place, but rather the client that serialized it.
+     * This is an important distinction in the case of a reference, where a client might refer to an ID created by another client.
+     * @returns The session-space ID in the local session corresponding to `id`.
+     */
+    normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
+    /**
+     * Decompresses a previously compressed ID into a UUID.
+     * @param id - The compressed ID to be decompressed.
+     * @returns The UUID associated with the compressed ID.
+     * @throws If the ID was not generated by any session known to this compressor.
+     */
+    decompress(id: SessionSpaceCompressedId): StableId;
+    /**
+     * Recompresses a UUID.
+     * @param uncompressed - The UUID to recompress.
+     * @returns The `CompressedId` associated with `uncompressed`.
+     * @throws If the UUID was not generated by any session known to this compressor.
+     */
+    recompress(uncompressed: StableId): SessionSpaceCompressedId;
+    /**
+     * Attempts to recompress a UUID.
+     * @param uncompressed - The UUID to recompress.
+     * @returns The `CompressedId` associated with `uncompressed` or undefined if the UUID was not generated by any session known to this compressor.
+     */
+    tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
+}
+
 /**
  * A distributed UUID generator and compressor.
  *
@@ -122,53 +236,6 @@ export declare interface IdCreationRange {
  *
  * These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops
  * should use op-space IDs.
- * @public
- */
-export declare interface IIdCompressor {
-    localSessionId: SessionId;
-    /**
-     * Generates a new compressed ID or returns an existing one.
-     * This should ONLY be called to generate IDs for local operations.
-     * @returns A new local ID in session space.
-     */
-    generateCompressedId(): SessionSpaceCompressedId;
-    /**
-     * Normalizes a session space ID into op space.
-     * @param id - the local ID to normalize.
-     * @returns the ID in op space.
-     */
-    normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
-    /**
-     * Normalizes an ID into session space.
-     * @param id - the ID to normalize. If it is a local ID, it is assumed to have been created by the session corresponding
-     * to `sessionId`.
-     * @param originSessionId - the session from which `id` originated
-     * @returns the session-space ID corresponding to `id`, which might not have been a final ID if the client that created it had not yet
-     * finalized it. This can occur when a client references an ID during the window of time in which it is waiting to receive the ordered
-     * range that contained it from the server.
-     */
-    normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
-    /**
-     * Decompresses a previously compressed ID into a UUID.
-     * @param id - the compressed ID to be decompressed.
-     * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.
-     */
-    decompress(id: SessionSpaceCompressedId): StableId;
-    /**
-     * Recompresses a UUID.
-     * @param uncompressed - the UUID to recompress.
-     * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.
-     */
-    recompress(uncompressed: StableId): SessionSpaceCompressedId;
-    /**
-     * Attempts to recompresses a UUID.
-     * @param uncompressed - the UUID to recompress,
-     * @returns the `CompressedId` associated with `uncompressed` or undefined if it has not been previously compressed by this compressor.
-     */
-    tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
-}
-
-/**
  * @alpha
  */
 export declare interface IIdCompressorCore {

package/dist/id-compressor-beta.d.ts

@@ -15,106 +15,114 @@ import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
 
 /**
  * A distributed UUID generator and compressor.
- *
- * Generates arbitrary non-colliding v4 UUIDs, called stable IDs, for multiple "sessions" (which can be distributed across the network),
- * providing each session with the ability to map these UUIDs to `numbers`.
- *
- * A session is a unique identifier that denotes a single compressor. New IDs are created through a single compressor API
- * which should then sent in ranges to the server for total ordering (and are subsequently relayed to other clients). When a new ID is
- * created it is said to be created by the compressor's "local" session.
- *
- * For each stable ID created, two numeric IDs are provided by the compressor:
- *
- * 1. A session-local ID, which is stable for the lifetime of the session (which could be longer than that of the compressor object, as it may
- * be serialized for offline usage). Available as soon as the stable ID is allocated. These IDs are session-unique and are thus only
- * safely usable within the scope of the compressor that created it.
- *
- * 2. A final ID, which is stable across serialization and deserialization of an IdCompressor. Available as soon as the range containing
- * the corresponding session-local ID is totally ordered (via consensus) with respect to other sessions' allocations.
- * Final IDs are known to and publicly usable by any compressor that has received them.
- *
- * Compressors will allocate UUIDs in non-random ways to reduce entropy allowing for optimized storage of the data needed
- * to map the UUIDs to the numbers.
- *
- * The following invariants are upheld by IdCompressor:
- *
- * 1. Session-local IDs will always decompress to the same UUIDs for the lifetime of the session.
- *
- * 2. Final IDs will always decompress to the same UUIDs.
- *
- * 3. After a server-processed range of session-local IDs (from any session) is received by a compressor, any of those session-local IDs may be
- * translated by the compressor into the corresponding final ID. For any given session-local ID, this translation will always yield the
- * same final ID.
- *
- * 4. A UUID will always compress into the same session-local ID for the lifetime of the session.
- *
- * Session-local IDs are sent across the wire in efficiently-represented ranges. These ranges are created by querying the compressor, and *must*
- * be ordered (i.e. sent to the server) in the order they are created in order to preserve the above invariants.
- *
- * Session-local IDs can be used immediately after creation, but will eventually (after being sequenced) have a corresponding final ID. This
- * could make reasoning about equality of those two forms difficult. For example, if a cache is keyed off of a
- * session-local ID but is later queried using the final ID (which is semantically equal, as it decompresses to the same UUID/string) it will
- * produce a cache miss. In order to make using collections of both remotely created and locally created IDs easy, regardless of whether the
- * session-local IDs have been finalized, the compressor defines two "spaces" of IDs:
- *
- * 1. Session space: in this space, all IDs are normalized to their "most local form". This means that all IDs created by the local session
- * will be in local form, regardless of if they have been finalized. Remotely created IDs, which could only have been received after
- * finalizing and will never have a local form for the compressor, will of course be final IDs. This space should be used with consumer APIs
- * and data structures, as the lifetime of the IDs is guaranteed to be the same as the compressor object. Care must be taken to not use
- * these IDs across compressor objects, as the local IDs are specific to the compressor that created them.
- *
- * 2. Op space: in this space, all IDs are normalized to their "most final form". This means that all IDs except session-local IDs that
- * have not yet been finalized will be in final ID form. This space is useful for serialization in ops (e.g. references), as other clients
- * that receive them need not do any work to normalize them to *their* session-space in the common case. Note that IDs in op space may move
- * out of Op space over time, namely, when a session-local ID in this space becomes finalized, and thereafter has a "more final form".
- * Consequentially, it may be useful to restrict parameters of a persisted type to this space (to optimize perf), but it is potentially
- * incorrect to use this type for a runtime variable. This is an asymmetry that does not affect session space, as local IDs are always as
- * "local as possible".
- *
- * These two spaces naturally define a rule: consumers of compressed IDs should use session-space IDs, but serialized forms such as ops
- * should use op-space IDs.
+ * `IdCompressor` offers the ability to generate arbitrary non-colliding v4 UUIDs, called stable IDs, while compressing them into small integers
+ * for efficient storage and transmission. It also provides the ability to decompress these integers back into their original UUIDs.
+ *
+ * The compressor is designed to be used in a distributed environment, where multiple clients may be generating IDs concurrently.
+ * IDs generated by a compressor, via calls to `generateCompressedId`, are created in the compressor's "local" session.
+ * These IDs are unique within the session, but may not be unique across sessions. In the context of Fluid, the scope of a session
+ * is the same as the scope of a container. This means that anytime IDs are transferred between sessions, they must be translated
+ * through a process called "normalization":
+ * - The scope of a local session (in which local IDs are unique) is called the "session space" of the client.
+ * - The context of persisted state (in Fluid, this is the context of ops and summaries) is called "op space".
+ * - `SessionSpaceCompressedId`s, generated via calls to `generateCompressedId`, should NEVER be serialized directly.
+ * In Fluid, this means they should not be included in ops or summaries.
+ * - Before serialization, IDs must be normalized to op space to ensure they are interpretable by other clients.
+ * - Upon receipt, IDs should be normalized back to session space before use.
+ *
+ * Example Usage:
+ *
+ * ### Client A (Sender)
+ *
+ * ```typescript
+ * // Generate several local IDs
+ * const localId1 = idCompressor.generateCompressedId();
+ * const localId2 = idCompressor.generateCompressedId();
+ * const localId3 = idCompressor.generateCompressedId();
+ *
+ * // Normalize these IDs to op space for inclusion in a message
+ * const opSpaceId1 = idCompressor.normalizeToOpSpace(localId1);
+ * const opSpaceId2 = idCompressor.normalizeToOpSpace(localId2);
+ * const opSpaceId3 = idCompressor.normalizeToOpSpace(localId3);
+ *
+ * // Create and send a message containing these op space IDs along with the sender's session ID
+ * // In Fluid, this would be an op or summary
+ * const message = {
+ *     sessionID: idCompressor.localSessionId,
+ *     ids: [opSpaceId1, opSpaceId2, opSpaceId3]
+ * };
+ * ```
+ *
+ * ### Client B (Receiver)
+ *
+ * ```typescript
+ * // Receive the message from Client A
+ * const receivedMessage = ...; // In Fluid, this would be an op or summary
+ *
+ * // Normalize the received IDs back to session space, utilizing the sender's session ID
+ * const sessionSpaceId1 = idCompressor.normalizeToSessionSpace(receivedMessage.ids[0], receivedMessage.sessionID);
+ * const sessionSpaceId2 = idCompressor.normalizeToSessionSpace(receivedMessage.ids[1], receivedMessage.sessionID);
+ * const sessionSpaceId3 = idCompressor.normalizeToSessionSpace(receivedMessage.ids[2], receivedMessage.sessionID);
+ * ```
  * @public
  */
 export declare interface IIdCompressor {
+    /**
+     * The local session ID.
+     */
     localSessionId: SessionId;
     /**
-     * Generates a new compressed ID or returns an existing one.
-     * This should ONLY be called to generate IDs for local operations.
+     * Generates a new compressed ID.
+     * The returned ID is in session space and should not be serialized directly. See `IIdCompressor` for more details.
      * @returns A new local ID in session space.
      */
     generateCompressedId(): SessionSpaceCompressedId;
+    /**
+     * Generates a new ID that is guaranteed to be unique across all sessions known to this compressor without the need for any
+     * normalization. The returned ID is not guaranteed to be a compressed ID (small number); it may be a stable ID (UUID string).
+     * In Fluid, the likelihood of generating the bulkier stable ID is dictated by network conditions and is highly probably in
+     * scenarios such as offline. This is still useful for use cases where simplicity is more important than performance and
+     * this approach will often be superior to generating a UUID.
+     * If small numbers are a requirement, `generateCompressedId` and normalization should be used instead.
+     * See `IIdCompressor` for more details.
+     * @returns A new local ID in session space.
+     */
+    generateDocumentUniqueId(): (SessionSpaceCompressedId & OpSpaceCompressedId) | StableId;
     /**
      * Normalizes a session space ID into op space.
-     * @param id - the local ID to normalize.
-     * @returns the ID in op space.
+     * The returned ID is in op space and can be safely serialized. However, it should be normalized back to session space before use.
+     * See `IIdCompressor` for more details.
+     * @param id - The local ID to normalize.
+     * @returns The ID in op space.
      */
     normalizeToOpSpace(id: SessionSpaceCompressedId): OpSpaceCompressedId;
     /**
      * Normalizes an ID into session space.
-     * @param id - the ID to normalize. If it is a local ID, it is assumed to have been created by the session corresponding
-     * to `sessionId`.
-     * @param originSessionId - the session from which `id` originated
-     * @returns the session-space ID corresponding to `id`, which might not have been a final ID if the client that created it had not yet
-     * finalized it. This can occur when a client references an ID during the window of time in which it is waiting to receive the ordered
-     * range that contained it from the server.
+     * @param id - The ID to normalize.
+     * @param originSessionId - The session from which `id` originated. This should be the ID of the client that normalized `id` to op space.
+     * This means that it may not be the client that created `id` in the first place, but rather the client that serialized it.
+     * This is an important distinction in the case of a reference, where a client might refer to an ID created by another client.
+     * @returns The session-space ID in the local session corresponding to `id`.
      */
     normalizeToSessionSpace(id: OpSpaceCompressedId, originSessionId: SessionId): SessionSpaceCompressedId;
     /**
      * Decompresses a previously compressed ID into a UUID.
-     * @param id - the compressed ID to be decompressed.
-     * @returns the UUID associated with the compressed ID. Fails if the ID was not generated by this compressor.
+     * @param id - The compressed ID to be decompressed.
+     * @returns The UUID associated with the compressed ID.
+     * @throws If the ID was not generated by any session known to this compressor.
      */
     decompress(id: SessionSpaceCompressedId): StableId;
     /**
      * Recompresses a UUID.
-     * @param uncompressed - the UUID to recompress.
-     * @returns the `CompressedId` associated with `uncompressed`. Fails if it has not been previously compressed by this compressor.
+     * @param uncompressed - The UUID to recompress.
+     * @returns The `CompressedId` associated with `uncompressed`.
+     * @throws If the UUID was not generated by any session known to this compressor.
      */
     recompress(uncompressed: StableId): SessionSpaceCompressedId;
     /**
-     * Attempts to recompresses a UUID.
-     * @param uncompressed - the UUID to recompress,
-     * @returns the `CompressedId` associated with `uncompressed` or undefined if it has not been previously compressed by this compressor.
+     * Attempts to recompress a UUID.
+     * @param uncompressed - The UUID to recompress.
+     * @returns The `CompressedId` associated with `uncompressed` or undefined if the UUID was not generated by any session known to this compressor.
      */
     tryRecompress(uncompressed: StableId): SessionSpaceCompressedId | undefined;
 }