@fluidframework/id-compressor 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/id-compressor",
-  "version": "2.0.0-rc.1.0.4",
+  "version": "2.0.0-rc.2.0.0",
   "description": "ID compressor",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,8 +11,70 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./public": {
+      "import": {
+        "types": "./lib/id-compressor-public.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/id-compressor-public.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./alpha": {
+      "import": {
+        "types": "./lib/id-compressor-alpha.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/id-compressor-alpha.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./internal": {
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./test": {
+      "import": {
+        "types": "./lib/test/index.d.ts",
+        "default": "./lib/test/index.js"
+      },
+      "require": {
+        "types": "./dist/test/index.d.ts",
+        "default": "./dist/test/index.js"
+      }
+    },
+    "./test/idCompressorTestUtilities": {
+      "import": {
+        "types": "./lib/test/idCompressorTestUtilities.d.ts",
+        "default": "./lib/test/idCompressorTestUtilities.js"
+      },
+      "require": {
+        "types": "./dist/test/idCompressorTestUtilities.d.ts",
+        "default": "./dist/test/idCompressorTestUtilities.js"
+      }
+    }
+  },
   "main": "dist/index.js",
-  "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
   "c8": {
     "all": true,
@@ -35,37 +97,36 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-private/stochastic-test-utils": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluid-private/stochastic-test-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.29.0",
+    "@fluid-tools/build-cli": "^0.34.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.29.0",
-    "@fluidframework/eslint-config-fluid": "^3.2.0",
+    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/eslint-config-fluid": "^4.0.0",
     "@fluidframework/id-compressor-previous": "npm:@fluidframework/id-compressor@2.0.0-internal.8.0.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@microsoft/api-extractor": "^7.38.3",
+    "@microsoft/api-extractor": "^7.42.3",
     "@types/mocha": "^9.1.1",
     "@types/uuid": "^9.0.2",
     "c8": "^8.0.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "eslint": "~8.50.0",
+    "eslint": "~8.55.0",
     "mocha": "^10.2.0",
     "mocha-json-output-reporter": "^2.0.1",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "tsc-multi": "^1.1.0",
     "typescript": "~5.1.6"
   },
   "fluidBuild": {
@@ -85,16 +146,18 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --local",
-    "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
+    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
+    "api-extractor:esnext": "api-extractor run --local",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
-    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
+    "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
-    "check:are-the-types-wrong": "attw --pack",
+    "build:test": "npm run build:test:esm && npm run build:test:cjs",
+    "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
+    "build:test:esm": "tsc --project ./src/test/tsconfig.json",
+    "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
     "clean": "rimraf --glob dist lib \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
@@ -108,9 +171,12 @@
     "test": "npm run test:mocha",
     "test:benchmark:report": "mocha --timeout 999999 --perfMode --parentProcess --fgrep @Benchmark --reporter @fluid-tools/benchmark/dist/MochaReporter.js \"./dist/**/*.perf.spec.*js\"",
     "test:coverage": "c8 npm test",
-    "test:mocha": "mocha --ignore \"dist/test/types/*\" --recursive dist/test -r node_modules/@fluidframework/mocha-test-setup",
+    "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
+    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\" --exit",
+    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc",
+    "test:snapshots:regen": "npm run test:mocha:esm -- --snapshot",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "tsc:watch": "tsc --watch"
   }
 }

package/src/finalSpace.ts

@@ -4,8 +4,8 @@
  */
 
 import { assert } from "@fluidframework/core-utils";
-import { IdCluster, clustersEqual, lastAllocatedFinal, lastFinalizedFinal } from "./sessions";
-import { FinalCompressedId } from "./identifiers";
+import { IdCluster, clustersEqual, lastAllocatedFinal, lastFinalizedFinal } from "./sessions.js";
+import { FinalCompressedId } from "./identifiers.js";
 
 /**
  * All IDs that have been finalized (acked), grouped into clusters sorted by their base final IDs.

package/src/idCompressor.ts

@@ -18,8 +18,8 @@ import {
 	SessionId,
 	SessionSpaceCompressedId,
 	StableId,
-} from "./types";
-import { FinalCompressedId, isFinalId, LocalCompressedId, NumericUuid } from "./identifiers";
+} from "./types/index.js";
+import { FinalCompressedId, isFinalId, LocalCompressedId, NumericUuid } from "./identifiers.js";
 import {
 	createSessionId,
 	localIdFromGenCount,
@@ -28,7 +28,7 @@ import {
 	offsetNumericUuid,
 	stableIdFromNumericUuid,
 	subtractNumericUuids,
-} from "./utilities";
+} from "./utilities.js";
 import {
 	Index,
 	readBoolean,
@@ -37,7 +37,7 @@ import {
 	writeBoolean,
 	writeNumber,
 	writeNumericUuid,
-} from "./persistanceUtilities";
+} from "./persistanceUtilities.js";
 import {
 	getAlignedLocal,
 	getAlignedFinal,
@@ -46,9 +46,9 @@ import {
 	Session,
 	Sessions,
 	lastFinalizedFinal,
-} from "./sessions";
-import { SessionSpaceNormalizer } from "./sessionSpaceNormalizer";
-import { FinalSpace } from "./finalSpace";
+} from "./sessions.js";
+import { SessionSpaceNormalizer } from "./sessionSpaceNormalizer.js";
+import { FinalSpace } from "./finalSpace.js";
 
 /**
  * The version of IdCompressor that is currently persisted.
@@ -58,11 +58,6 @@ const currentWrittenVersion = 2.0;
 
 /**
  * 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 class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	/**
@@ -109,7 +104,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 
 	// #endregion
 
-	private constructor(
+	public constructor(
 		localSessionIdOrDeserialized: SessionId | Sessions,
 		private readonly logger?: ITelemetryLoggerExt,
 	) {
@@ -130,41 +125,6 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		}
 	}
 
-	/**
-	 * @deprecated Use `createIdCompressor` instead.
-	 */
-	public static create(logger?: ITelemetryBaseLogger): IIdCompressor & IIdCompressorCore;
-	/**
-	 * @deprecated Use `createIdCompressor` instead.
-	 */
-	public static create(
-		sessionId: SessionId,
-		logger?: ITelemetryBaseLogger,
-	): IIdCompressor & IIdCompressorCore;
-	public static create(
-		sessionIdOrLogger?: SessionId | ITelemetryBaseLogger,
-		loggerOrUndefined?: ITelemetryBaseLogger,
-	): IIdCompressor & IIdCompressorCore {
-		let localSessionId: SessionId;
-		let logger: ITelemetryBaseLogger | undefined;
-		if (sessionIdOrLogger === undefined) {
-			localSessionId = createSessionId();
-		} else {
-			if (typeof sessionIdOrLogger === "string") {
-				localSessionId = sessionIdOrLogger;
-				logger = loggerOrUndefined;
-			} else {
-				localSessionId = createSessionId();
-				logger = loggerOrUndefined;
-			}
-		}
-		const compressor = new IdCompressor(
-			localSessionId,
-			logger === undefined ? undefined : createChildLogger({ logger }),
-		);
-		return compressor;
-	}
-
 	public generateCompressedId(): SessionSpaceCompressedId {
 		// This ghost session code inside this block should not be changed without a version bump (it is performed at a consensus point)
 		if (this.ongoingGhostSession) {
@@ -206,11 +166,25 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		}
 	}
 
+	public generateDocumentUniqueId(): (SessionSpaceCompressedId & OpSpaceCompressedId) | StableId {
+		const id = this.generateCompressedId();
+		return isFinalId(id) ? id : this.decompress(id);
+	}
+
+	/**
+	 * Starts a ghost session. Only exposed for test purposes (this class is not exported from the package).
+	 * @param ghostSessionId - The session ID to start the ghost session with.
+	 */
+	public startGhostSession(ghostSessionId: SessionId): void {
+		assert(!this.ongoingGhostSession, 0x8fe /* Ghost session already in progress. */);
+		this.ongoingGhostSession = { ghostSessionId };
+	}
+
 	/**
 	 * {@inheritdoc IIdCompressorCore.beginGhostSession}
 	 */
 	public beginGhostSession(ghostSessionId: SessionId, ghostSessionCallback: () => void) {
-		this.ongoingGhostSession = { ghostSessionId };
+		this.startGhostSession(ghostSessionId);
 		try {
 			ghostSessionCallback();
 		} finally {
@@ -589,15 +563,27 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		return bufferToString(serializedFloat.buffer, "base64") as SerializedIdCompressor;
 	}
 
-	public static deserialize(serialized: SerializedIdCompressorWithOngoingSession): IdCompressor;
+	public static deserialize(
+		serialized: SerializedIdCompressorWithOngoingSession,
+		logger?: ITelemetryLoggerExt,
+	): IdCompressor;
 	public static deserialize(
 		serialized: SerializedIdCompressorWithNoSession,
 		newSessionId: SessionId,
+		logger?: ITelemetryLoggerExt,
 	): IdCompressor;
 	public static deserialize(
 		serialized: SerializedIdCompressor,
-		sessionId?: SessionId,
+		loggerOrSessionId?: ITelemetryLoggerExt | SessionId,
 	): IdCompressor {
+		let sessionId: SessionId | undefined;
+		let logger: ITelemetryLoggerExt | undefined;
+		if (typeof loggerOrSessionId === "string") {
+			sessionId = loggerOrSessionId;
+		} else {
+			logger = loggerOrSessionId;
+		}
+
 		const buffer = stringToBuffer(serialized, "base64");
 		const index: Index = {
 			index: 0,
@@ -609,13 +595,17 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			case 1.0:
 				throw new Error("IdCompressor version 1.0 is no longer supported.");
 			case 2.0:
-				return IdCompressor.deserialize2_0(index, sessionId);
+				return IdCompressor.deserialize2_0(index, sessionId, logger);
 			default:
 				throw new Error("Unknown IdCompressor serialized version.");
 		}
 	}
 
-	private static deserialize2_0(index: Index, sessionId?: SessionId): IdCompressor {
+	static deserialize2_0(
+		index: Index,
+		sessionId?: SessionId,
+		logger?: ITelemetryLoggerExt,
+	): IdCompressor {
 		const hasLocalState = readBoolean(index);
 		const sessionCount = readNumber(index);
 		const clusterCount = readNumber(index);
@@ -641,7 +631,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 			sessions.push([numeric, new Session(numeric)]);
 		}
 
-		const compressor = new IdCompressor(new Sessions(sessions));
+		const compressor = new IdCompressor(new Sessions(sessions), logger);
 
 		// Clusters
 		let baseFinalId = 0;
@@ -714,7 +704,24 @@ export function createIdCompressor(
 	sessionIdOrLogger?: SessionId | ITelemetryBaseLogger,
 	loggerOrUndefined?: ITelemetryBaseLogger,
 ): IIdCompressor & IIdCompressorCore {
-	return IdCompressor.create(sessionIdOrLogger as SessionId, loggerOrUndefined);
+	let localSessionId: SessionId;
+	let logger: ITelemetryBaseLogger | undefined;
+	if (sessionIdOrLogger === undefined) {
+		localSessionId = createSessionId();
+	} else {
+		if (typeof sessionIdOrLogger === "string") {
+			localSessionId = sessionIdOrLogger;
+			logger = loggerOrUndefined;
+		} else {
+			localSessionId = createSessionId();
+			logger = sessionIdOrLogger;
+		}
+	}
+	const compressor = new IdCompressor(
+		localSessionId,
+		logger === undefined ? undefined : createChildLogger({ logger }),
+	);
+	return compressor;
 }
 
 /**
@@ -723,6 +730,7 @@ export function createIdCompressor(
  */
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressorWithOngoingSession,
+	logger?: ITelemetryLoggerExt,
 ): IIdCompressor & IIdCompressorCore;
 /**
  * Deserializes the supplied state into an ID compressor.
@@ -731,12 +739,20 @@ export function deserializeIdCompressor(
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressorWithNoSession,
 	newSessionId: SessionId,
+	logger?: ITelemetryLoggerExt,
 ): IIdCompressor & IIdCompressorCore;
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressor | SerializedIdCompressorWithNoSession,
-	sessionId?: SessionId,
+	sessionIdOrLogger?: SessionId | ITelemetryLoggerExt,
+	logger?: ITelemetryLoggerExt | undefined,
 ): IIdCompressor & IIdCompressorCore {
-	return sessionId === undefined
-		? IdCompressor.deserialize(serialized as SerializedIdCompressorWithOngoingSession)
-		: IdCompressor.deserialize(serialized as SerializedIdCompressorWithNoSession, sessionId);
+	if (typeof sessionIdOrLogger === "string") {
+		return IdCompressor.deserialize(
+			serialized as SerializedIdCompressorWithNoSession,
+			sessionIdOrLogger,
+			logger,
+		);
+	}
+
+	return IdCompressor.deserialize(serialized as SerializedIdCompressorWithOngoingSession, logger);
 }

package/src/identifiers.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { OpSpaceCompressedId, SessionSpaceCompressedId } from "./types";
+import { OpSpaceCompressedId, SessionSpaceCompressedId } from "./types/index.js";
 
 /**
  * A compressed ID that is stable and unique within the scope of network of compressors (i.e. a document).

package/src/index.ts

@@ -7,8 +7,8 @@
  * Exports for `id-compressor`
  */
 
-export { createIdCompressor, deserializeIdCompressor, IdCompressor } from "./idCompressor";
-export { createSessionId, assertIsStableId, generateStableId, isStableId } from "./utilities";
+export { createIdCompressor, deserializeIdCompressor } from "./idCompressor.js";
+export { createSessionId, assertIsStableId, generateStableId, isStableId } from "./utilities.js";
 export {
 	IIdCompressorCore,
 	IIdCompressor,
@@ -20,4 +20,4 @@ export {
 	SessionId,
 	StableId,
 	IdCreationRange,
-} from "./types";
+} from "./types/index.js";

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/id-compressor";
-export const pkgVersion = "2.0.0-rc.1.0.4";
+export const pkgVersion = "2.0.0-rc.2.0.0";

package/src/persistanceUtilities.ts

@@ -4,7 +4,7 @@
  */
 
 /* eslint-disable no-bitwise */
-import { NumericUuid } from "./identifiers";
+import { NumericUuid } from "./identifiers.js";
 
 const halfNumeric = BigInt("0xFFFFFFFFFFFFFFFF");
 const sixtyFour = BigInt(64);

package/src/sessionSpaceNormalizer.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { AppendOnlySortedMap } from "./appendOnlySortedMap";
-import { LocalCompressedId } from "./identifiers";
-import { compareFiniteNumbers, genCountFromLocalId } from "./utilities";
+import { AppendOnlySortedMap } from "./appendOnlySortedMap.js";
+import { LocalCompressedId } from "./identifiers.js";
+import { compareFiniteNumbers, genCountFromLocalId } from "./utilities.js";
 
 /**
  * The `SessionSpaceNormalizer` tracks the form of the IDs created by the local session.

package/src/sessions.ts

@@ -5,7 +5,7 @@
 
 import { BTree } from "@tylerbu/sorted-btree-es6";
 import { assert } from "@fluidframework/core-utils";
-import { SessionId, StableId } from "./types";
+import { SessionId, StableId } from "./types/index.js";
 import {
 	compareBigints,
 	localIdFromGenCount,
@@ -14,8 +14,8 @@ import {
 	stableIdFromNumericUuid,
 	subtractNumericUuids,
 	offsetNumericUuid,
-} from "./utilities";
-import { FinalCompressedId, LocalCompressedId, NumericUuid } from "./identifiers";
+} from "./utilities.js";
+import { FinalCompressedId, LocalCompressedId, NumericUuid } from "./identifiers.js";
 
 /**
  * A collection of all sessions known to the compressor (i.e. all finalized/acked allocated UUIDs and their corresponding local and final forms).