@fluidframework/id-compressor 2.93.0 → 2.100.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/id-compressor",
-  "version": "2.93.0",
+  "version": "2.100.0",
   "description": "ID compressor",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -81,22 +81,22 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.93.0",
-    "@fluidframework/core-interfaces": "~2.93.0",
-    "@fluidframework/core-utils": "~2.93.0",
-    "@fluidframework/telemetry-utils": "~2.93.0",
+    "@fluid-internal/client-utils": "~2.100.0",
+    "@fluidframework/core-interfaces": "~2.100.0",
+    "@fluidframework/core-utils": "~2.100.0",
+    "@fluidframework/telemetry-utils": "~2.100.0",
     "@tylerbu/sorted-btree-es6": "^2.1.1",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
     "@biomejs/biome": "~2.4.5",
-    "@fluid-internal/mocha-test-setup": "~2.93.0",
-    "@fluid-private/stochastic-test-utils": "~2.93.0",
-    "@fluid-tools/benchmark": "^0.55.0",
-    "@fluid-tools/build-cli": "^0.64.0",
+    "@fluid-internal/mocha-test-setup": "~2.100.0",
+    "@fluid-private/stochastic-test-utils": "~2.100.0",
+    "@fluid-tools/benchmark": "^0.58.0",
+    "@fluid-tools/build-cli": "^0.65.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.64.0",
+    "@fluidframework/build-tools": "^0.65.0",
     "@fluidframework/eslint-config-fluid": "^9.0.0",
     "@fluidframework/id-compressor-previous": "npm:@fluidframework/id-compressor@2.92.0",
     "@microsoft/api-extractor": "7.58.1",
@@ -114,7 +114,12 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {},
+    "broken": {
+      "Interface_IIdCompressorCore": {
+        "forwardCompat": false,
+        "backCompat": false
+      }
+    },
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/idCompressor.ts

@@ -6,11 +6,14 @@
 import { bufferToString, stringToBuffer } from "@fluid-internal/client-utils";
 import type { ITelemetryBaseLogger } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
+import type { TelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 import {
-	type ITelemetryLoggerExt,
 	LoggingError,
 	createChildLogger,
+	extractTelemetryLoggerExt,
 } from "@fluidframework/telemetry-utils/internal";
+// eslint-disable-next-line import-x/no-internal-modules -- Needed to avoid specialized /internal ITelemetryLoggerExt
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/legacy";
 
 import { FinalSpace } from "./finalSpace.js";
 import {
@@ -40,7 +43,6 @@ import {
 } from "./sessions.js";
 import type {
 	IIdCompressor,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
 	IIdCompressorCore,
 	IdCreationRange,
 	OpSpaceCompressedId,
@@ -77,7 +79,6 @@ function rangeFinalizationError(expectedStart: number, actualStart: number): Log
 /**
  * See {@link IIdCompressor} and {@link IIdCompressorCore}
  */
-// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
 export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	/**
 	 * Max allowed initial cluster size.
@@ -129,7 +130,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 
 	public constructor(
 		localSessionIdOrDeserialized: SessionId | Sessions,
-		private readonly logger: ITelemetryLoggerExt | undefined,
+		private readonly logger: TelemetryLoggerExt | undefined,
 	) {
 		if (typeof localSessionIdOrDeserialized === "string") {
 			this.localSessionId = localSessionIdOrDeserialized;
@@ -622,13 +623,13 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 		params:
 			| {
 					serialized: SerializedIdCompressorWithOngoingSession;
-					logger?: ITelemetryLoggerExt | undefined;
+					logger?: TelemetryLoggerExt | undefined;
 					newSessionId?: never;
 			  }
 			| {
 					serialized: SerializedIdCompressorWithNoSession;
 					newSessionId: SessionId;
-					logger?: ITelemetryLoggerExt | undefined;
+					logger?: TelemetryLoggerExt | undefined;
 			  },
 	): IdCompressor {
 		const { serialized, newSessionId, logger } = params;
@@ -655,7 +656,7 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 	static deserialize2_0(
 		index: Index,
 		sessionId: SessionId | undefined,
-		logger: ITelemetryLoggerExt | undefined,
+		logger: TelemetryLoggerExt | undefined,
 	): IdCompressor {
 		const hasLocalState = readBoolean(index);
 		const sessionCount = readNumber(index);
@@ -739,39 +740,22 @@ export class IdCompressor implements IIdCompressor, IIdCompressorCore {
 /**
  * Create a new {@link IIdCompressor}.
  *
- * @remarks
- * The returned compressor previously also implemented {@link IIdCompressorCore}, but that
- * interface is {@link IIdCompressorCore | deprecated} and will be removed from the return
- * type in a future release. Consumers should type variables as {@link IIdCompressor} and
- * use {@link (serializeIdCompressor:1)} for serialization instead of calling `serialize()` directly.
- *
  * @legacy @beta
  */
-export function createIdCompressor(
-	logger?: ITelemetryBaseLogger,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
-): IIdCompressor & IIdCompressorCore;
+export function createIdCompressor(logger?: ITelemetryBaseLogger): IIdCompressor;
 /**
  * Create a new {@link IIdCompressor}.
  * @param sessionId - The seed ID for the compressor.
  *
- * @remarks
- * The returned compressor previously also implemented {@link IIdCompressorCore}, but that
- * interface is {@link IIdCompressorCore | deprecated} and will be removed from the return
- * type in a future release. Consumers should type variables as {@link IIdCompressor} and
- * use {@link (serializeIdCompressor:1)} for serialization instead of calling `serialize()` directly.
- *
  * @legacy @beta
  */
 export function createIdCompressor(
 	sessionId: SessionId,
 	logger?: ITelemetryBaseLogger,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
-): IIdCompressor & IIdCompressorCore;
+): IIdCompressor;
 export function createIdCompressor(
 	sessionIdOrLogger?: SessionId | ITelemetryBaseLogger,
 	loggerOrUndefined?: ITelemetryBaseLogger,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
 ): IIdCompressor & IIdCompressorCore {
 	let localSessionId: SessionId;
 	let logger: ITelemetryBaseLogger | undefined;
@@ -796,46 +780,31 @@ export function createIdCompressor(
 /**
  * Deserializes the supplied state into an ID compressor.
  *
- * @remarks
- * The returned compressor previously also implemented {@link IIdCompressorCore}, but that
- * interface is {@link IIdCompressorCore | deprecated} and will be removed from the return
- * type in a future release. Consumers should type variables as {@link IIdCompressor} and
- * use {@link (serializeIdCompressor:1)} for serialization instead of calling `serialize()` directly.
- *
  * @legacy @beta
  */
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressorWithOngoingSession,
 	logger?: ITelemetryLoggerExt,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
-): IIdCompressor & IIdCompressorCore;
+): IIdCompressor;
 /**
  * Deserializes the supplied state into an ID compressor.
  *
- * @remarks
- * The returned compressor previously also implemented {@link IIdCompressorCore}, but that
- * interface is {@link IIdCompressorCore | deprecated} and will be removed from the return
- * type in a future release. Consumers should type variables as {@link IIdCompressor} and
- * use {@link (serializeIdCompressor:1)} for serialization instead of calling `serialize()` directly.
- *
  * @legacy @beta
  */
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressorWithNoSession,
 	newSessionId: SessionId,
 	logger?: ITelemetryLoggerExt,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
-): IIdCompressor & IIdCompressorCore;
+): IIdCompressor;
 export function deserializeIdCompressor(
 	serialized: SerializedIdCompressor | SerializedIdCompressorWithNoSession,
 	sessionIdOrLogger: SessionId | ITelemetryLoggerExt | undefined,
 	loggerOrUndefined?: ITelemetryLoggerExt,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
 ): IIdCompressor & IIdCompressorCore {
 	if (typeof sessionIdOrLogger === "string") {
 		return IdCompressor.deserialize({
 			serialized: serialized as SerializedIdCompressorWithNoSession,
-			logger: loggerOrUndefined,
+			logger: extractTelemetryLoggerExt<{ PossiblyUndefined: true }>(loggerOrUndefined),
 			newSessionId: sessionIdOrLogger,
 		});
 	}
@@ -846,7 +815,7 @@ export function deserializeIdCompressor(
 	);
 	return IdCompressor.deserialize({
 		serialized: serialized as SerializedIdCompressorWithOngoingSession,
-		logger: sessionIdOrLogger,
+		logger: extractTelemetryLoggerExt<{ PossiblyUndefined: true }>(sessionIdOrLogger),
 	});
 }
 
@@ -886,9 +855,9 @@ export function serializeIdCompressor(
  * @remarks
  * Compressors returned by `createIdCompressor` and `deserializeIdCompressor`
  * always implement both {@link IIdCompressor} and {@link IIdCompressorCore}, but their
- * return types will be narrowed to {@link IIdCompressor} to keep {@link IIdCompressorCore}
- * out of the `@legacy` API surface. Internal consumers that need access to core
- * compressor operations (serialization, range management, etc.) should use this function.
+ * public return type is narrowed to {@link IIdCompressor}. Internal consumers that
+ * need access to core compressor operations (serialization, range management, etc.)
+ * use this function to recover the {@link IIdCompressorCore} surface.
  *
  * @param compressor - A compressor created by `createIdCompressor` or
  * `deserializeIdCompressor`.
@@ -897,12 +866,10 @@ export function serializeIdCompressor(
  */
 export function toIdCompressorWithCore(
 	compressor: IIdCompressor,
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
 ): IIdCompressor & IIdCompressorCore {
 	assert(
 		"serialize" in compressor,
 		0xced /* Expected compressor to implement IIdCompressorCore */,
 	);
-	// eslint-disable-next-line import-x/no-deprecated -- Will be undeprecated in 2.100.0 when it becomes an internal API
 	return compressor as IIdCompressor & IIdCompressorCore;
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/id-compressor";
-export const pkgVersion = "2.93.0";
+export const pkgVersion = "2.100.0";

package/src/test/idCompressorTestUtilities.ts

@@ -30,6 +30,7 @@ import {
 	type SessionSpaceCompressedId,
 	type StableId,
 	createIdCompressor,
+	toIdCompressorWithCore,
 } from "../index.js";
 import { SessionSpaceNormalizer } from "../sessionSpaceNormalizer.js";
 import { assertIsSessionId, createSessionId, localIdFromGenCount } from "../utilities.js";
@@ -1087,5 +1088,5 @@ export function createAlwaysFinalizedIdCompressor(
 	const compressor = createIdCompressor(random.uuid4() as SessionId, logger);
 	// Permanently put the compressor in a ghost session
 	(compressor as IdCompressor).startGhostSession(sessionId);
-	return compressor;
+	return toIdCompressorWithCore(compressor);
 }

package/src/test/types/validateIdCompressorPrevious.generated.ts

@@ -96,6 +96,7 @@ declare type current_as_old_for_Interface_IIdCompressor = requireAssignableTo<Ty
  * typeValidation.broken:
  * "Interface_IIdCompressorCore": {"forwardCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type old_as_current_for_Interface_IIdCompressorCore = requireAssignableTo<TypeOnly<old.IIdCompressorCore>, TypeOnly<current.IIdCompressorCore>>
 
 /*
@@ -105,6 +106,7 @@ declare type old_as_current_for_Interface_IIdCompressorCore = requireAssignableT
  * typeValidation.broken:
  * "Interface_IIdCompressorCore": {"backCompat": false}
  */
+// @ts-expect-error compatibility expected to be broken
 declare type current_as_old_for_Interface_IIdCompressorCore = requireAssignableTo<TypeOnly<current.IIdCompressorCore>, TypeOnly<old.IIdCompressorCore>>
 
 /*

package/src/types/idCompressor.ts

@@ -76,19 +76,7 @@ import type {
  * 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.
  *
- * @privateremarks To be made internal in 2.100.0
- *
- * @deprecated `IIdCompressorCore` will be removed from the public API in 2.100.0.
- *
- * - If you use `serialize()`, use the free function
- * {@link (serializeIdCompressor:1) | serializeIdCompressor(compressor, withSession)} instead.
- *
- * - `takeNextCreationRange`, `takeUnfinalizedCreationRange`, `finalizeCreationRange`, and
- * `beginGhostSession` are internal runtime operations. External consumers should not call
- * them directly. If you depend on these APIs, please file an issue on the FluidFramework
- * repository describing your use case.
- *
- * @legacy @beta
+ * @internal
  */
 export interface IIdCompressorCore {
 	/**