@fluidframework/id-compressor 2.0.0-dev-rc.5.0.0.271717 → 2.0.0-dev-rc.5.0.0.272889

package/src/sessionSpaceNormalizer.ts

@@ -44,7 +44,9 @@ import { compareFiniteNumbers, genCountFromLocalId } from "./utilities.js";
 export class SessionSpaceNormalizer {
 	// 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.
-	private readonly localIdRanges = new AppendOnlySortedMap<number, number>(compareFiniteNumbers);
+	private readonly localIdRanges = new AppendOnlySortedMap<number, number>(
+		compareFiniteNumbers,
+	);
 
 	public get idRanges(): Pick<AppendOnlySortedMap<number, number>, "size" | "entries"> {
 		return this.localIdRanges;

package/src/test/idCompressorTestUtilities.ts

@@ -120,7 +120,10 @@ export function buildHugeCompressor(
 	capacity = 10,
 	numClustersPerSession = 3,
 ): IdCompressor {
-	const compressor = CompressorFactory.createCompressorWithSession(createSessionId(), capacity);
+	const compressor = CompressorFactory.createCompressorWithSession(
+		createSessionId(),
+		capacity,
+	);
 	const sessions: SessionId[] = [];
 	for (let i = 0; i < numSessions; i++) {
 		sessions.push(createSessionId());
@@ -378,7 +381,10 @@ export class IdCompressorTestNetwork {
 	/**
 	 * Delivers all undelivered ID ranges from the server to the target clients.
 	 */
-	public deliverOperations(clientTakingDelivery: DestinationClient, opsToDeliver?: number): void {
+	public deliverOperations(
+		clientTakingDelivery: DestinationClient,
+		opsToDeliver?: number,
+	): void {
 		let opIndexBound: number;
 		if (clientTakingDelivery === DestinationClient.All) {
 			assert(opsToDeliver === undefined);
@@ -397,10 +403,7 @@ export class IdCompressorTestNetwork {
 				const ids = range.ids;
 				if (ids !== undefined) {
 					for (const id of opSpaceIds) {
-						const sessionSpaceId = compressorTo.normalizeToSessionSpace(
-							id,
-							range.sessionId,
-						);
+						const sessionSpaceId = compressorTo.normalizeToSessionSpace(id, range.sessionId);
 						this.addNewId(clientTo, sessionSpaceId, clientFrom, sessionIdFrom, true);
 					}
 				}
@@ -584,18 +587,14 @@ export class IdCompressorTestNetwork {
 					if (originatingSession !== OriginatingClient.Remote) {
 						assert.strictEqual(
 							idDataA.sessionId,
-							this.compressors.get(idDataA.originatingClient as Client)
-								.localSessionId,
+							this.compressors.get(idDataA.originatingClient as Client).localSessionId,
 						);
 					}
 					idCreatorCount++;
 				}
 
 				const uuidASessionSpace = compressorA.decompress(sessionSpaceIdA);
-				assert.strictEqual(
-					uuidASessionSpace,
-					incrementStableId(idDataA.sessionId, idIndex),
-				);
+				assert.strictEqual(uuidASessionSpace, incrementStableId(idDataA.sessionId, idIndex));
 				assert.strictEqual(compressorA.recompress(uuidASessionSpace), sessionSpaceIdA);
 				uuids.add(uuidASessionSpace);
 				const opSpaceIdA = compressorA.normalizeToOpSpace(sessionSpaceIdA);
@@ -675,7 +674,10 @@ export function roundtrip(
 export function roundtrip(
 	compressor: ReadonlyIdCompressor,
 	withSession: boolean,
-): [SerializedIdCompressorWithOngoingSession | SerializedIdCompressorWithNoSession, IdCompressor] {
+): [
+	SerializedIdCompressorWithOngoingSession | SerializedIdCompressorWithNoSession,
+	IdCompressor,
+] {
 	// preserve the capacity request as this property is normally private and resets
 	// to a default on construction (deserialization)
 	// eslint-disable-next-line @typescript-eslint/dot-notation
@@ -867,7 +869,9 @@ export function makeOpGenerator(
 		selectableClients,
 		network,
 	}: FuzzTestState): DeliverSomeOperations {
-		const pendingClients = selectableClients.filter((c) => network.getPendingOperations(c) > 0);
+		const pendingClients = selectableClients.filter(
+			(c) => network.getPendingOperations(c) > 0,
+		);
 		if (pendingClients.length === 0) {
 			return {
 				type: "deliverSomeOperations",
@@ -1016,8 +1020,8 @@ export function createAlwaysFinalizedIdCompressor(
 		sessionIdOrLogger === undefined
 			? createIdCompressor()
 			: typeof sessionIdOrLogger === "string"
-			? createIdCompressor(sessionIdOrLogger, loggerOrUndefined)
-			: createIdCompressor(sessionIdOrLogger);
+				? createIdCompressor(sessionIdOrLogger, loggerOrUndefined)
+				: createIdCompressor(sessionIdOrLogger);
 	// Permanently put the compressor in a ghost session
 	(compressor as IdCompressor).startGhostSession(createSessionId());
 	return compressor;

package/src/test/testCommon.ts

@@ -16,7 +16,6 @@ import {
 /**
  * An identifier (v4 UUID) that has been shortened by a distributed compression algorithm.
  * Lacks a space (session/op), meaning its scope is the same as the space-specific ID from which it was derived.
- * @alpha
  */
 export type CompressedId =
 	| SessionSpaceCompressedId
@@ -27,7 +26,6 @@ export type CompressedId =
 /**
  * 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.
- * @alpha
  */
 export type FinalCompressedId = number & {
 	readonly FinalCompressedId: "5d83d1e2-98b7-4e4e-a889-54c855cfa73d";
@@ -40,7 +38,6 @@ export type FinalCompressedId = number & {
  * 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.
- * @alpha
  */
 export type LocalCompressedId = number & {
 	readonly LocalCompressedId: "6fccb42f-e2a4-4243-bd29-f13d12b9c6d1";

package/src/types/identifiers.ts

@@ -36,4 +36,6 @@ export type StableId = string & { readonly StableId: "53172b0d-a3d5-41ea-bd75-b4
  * A StableId which is suitable for use as a session identifier
  * @public
  */
-export type SessionId = StableId & { readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58" };
+export type SessionId = StableId & {
+	readonly SessionId: "4498f850-e14e-4be9-8db0-89ec00997e58";
+};

package/tsdoc.json

@@ -0,0 +1,4 @@
+{
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"extends": ["../../../common/build/build-common/tsdoc-base.json"]
+}