@fluidframework/container-runtime 2.0.0-dev.5.3.2.178189 → 2.0.0-dev.6.4.0.191457

package/src/summary/summaryManager.ts

@@ -3,18 +3,32 @@
  * Licensed under the MIT License.
  */
 
-import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { IDisposable } from "@fluidframework/core-interfaces";
-import { assert } from "@fluidframework/common-utils";
 import {
-	ChildLogger,
+	IDisposable,
+	IEvent,
+	IEventProvider,
+	ITelemetryBaseLogger,
+} from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils";
+import { TypedEventEmitter } from "@fluid-internal/client-utils";
+import {
+	createChildLogger,
 	ITelemetryLoggerExt,
 	PerformanceEvent,
 } from "@fluidframework/telemetry-utils";
-import { DriverErrorType } from "@fluidframework/driver-definitions";
+import { DriverErrorTypes } from "@fluidframework/driver-definitions";
 import { IThrottler } from "../throttler";
 import { ISummarizerClientElection } from "./summarizerClientElection";
-import { ISummarizer, SummarizerStopReason } from "./summarizerTypes";
+import {
+	EnqueueSummarizeResult,
+	IEnqueueSummarizeOptions,
+	IOnDemandSummarizeOptions,
+	ISummarizeEventProps,
+	ISummarizeResults,
+	ISummarizer,
+	ISummarizerEvents,
+	SummarizerStopReason,
+} from "./summarizerTypes";
 import { SummaryCollection } from "./summaryCollection";
 import { Summarizer } from "./summarizer";
 
@@ -73,7 +87,7 @@ export interface ISummaryManagerConfig {
  * It observes changes in calculated summarizer and reacts to changes by either creating summarizer client or
  * stopping existing summarizer client.
  */
-export class SummaryManager implements IDisposable {
+export class SummaryManager extends TypedEventEmitter<ISummarizerEvents> implements IDisposable {
 	private readonly logger: ITelemetryLoggerExt;
 	private readonly opsToBypassInitialDelay: number;
 	private readonly initialDelayMs: number;
@@ -97,7 +111,7 @@ export class SummaryManager implements IDisposable {
 			SummaryCollection,
 			"opsSinceLastAck" | "addOpListener" | "removeOpListener"
 		>,
-		parentLogger: ITelemetryLoggerExt,
+		parentLogger: ITelemetryBaseLogger,
 		/** Creates summarizer by asking interactive container to spawn summarizing container and
 		 * get back its Summarizer instance. */
 		private readonly requestSummarizerFn: () => Promise<ISummarizer>,
@@ -108,8 +122,14 @@ export class SummaryManager implements IDisposable {
 		}: Readonly<Partial<ISummaryManagerConfig>> = {},
 		private readonly disableHeuristics?: boolean,
 	) {
-		this.logger = ChildLogger.create(parentLogger, "SummaryManager", {
-			all: { clientId: () => this.latestClientId },
+		super();
+
+		this.logger = createChildLogger({
+			logger: parentLogger,
+			namespace: "SummaryManager",
+			properties: {
+				all: { clientId: () => this.latestClientId },
+			},
 		});
 
 		this.connectedState.on("connected", this.handleConnected);
@@ -141,6 +161,10 @@ export class SummaryManager implements IDisposable {
 		this.refreshSummarizer();
 	};
 
+	private readonly handleSummarizeEvent = (eventProps: ISummarizeEventProps) => {
+		this.emit("summarize", eventProps);
+	};
+
 	private static readonly isStartingOrRunning = (state: SummaryManagerState) =>
 		state === SummaryManagerState.Starting || state === SummaryManagerState.Running;
 
@@ -242,6 +266,7 @@ export class SummaryManager implements IDisposable {
 
 				const summarizer = await this.requestSummarizerFn();
 				this.summarizer = summarizer;
+				this.summarizer.on("summarize", this.handleSummarizeEvent);
 
 				// Re-validate that it need to be running. Due to asynchrony, it may be not the case anymore
 				// If we can't run the LastSummary, simply return as to avoid paying the cost of launching
@@ -304,7 +329,7 @@ export class SummaryManager implements IDisposable {
 					// If failure happened on container load, we may not yet realized that socket disconnected, so check
 					// offlineError.
 					const category =
-						error?.errorType === DriverErrorType.offlineError ? "generic" : "error";
+						error?.errorType === DriverErrorTypes.offlineError ? "generic" : "error";
 					this.logger.sendTelemetryEvent(
 						{
 							eventName: "SummarizerException",
@@ -318,6 +343,7 @@ export class SummaryManager implements IDisposable {
 				assert(this.state !== SummaryManagerState.Off, 0x264 /* "Expected: Not Off" */);
 				this.state = SummaryManagerState.Off;
 
+				this.summarizer?.off("summarize", this.handleSummarizeEvent);
 				this.summarizer?.close();
 				this.summarizer = undefined;
 
@@ -400,26 +426,27 @@ export class SummaryManager implements IDisposable {
 		return startWithInitialDelay;
 	}
 
-	public readonly summarizeOnDemand: ISummarizer["summarizeOnDemand"] = (...args) => {
+	public summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults {
 		if (this.summarizer === undefined) {
 			throw Error("No running summarizer client");
 			// TODO: could spawn a summarizer client temporarily.
 		}
-		return this.summarizer.summarizeOnDemand(...args);
-	};
+		return this.summarizer.summarizeOnDemand(options);
+	}
 
-	public readonly enqueueSummarize: ISummarizer["enqueueSummarize"] = (...args) => {
+	public enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult {
 		if (this.summarizer === undefined) {
 			throw Error("No running summarizer client");
 			// TODO: could spawn a summarizer client temporarily.
 		}
-		return this.summarizer.enqueueSummarize(...args);
-	};
+		return this.summarizer.enqueueSummarize(options);
+	}
 
 	public dispose() {
 		this.clientElection.off("electedSummarizerChanged", this.refreshSummarizer);
 		this.connectedState.off("connected", this.handleConnected);
 		this.connectedState.off("disconnected", this.handleDisconnected);
+		this.summarizer?.off("summarize", this.handleSummarizeEvent);
 		this._disposed = true;
 	}
 }

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

@@ -1,11 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { IdCreationRange, UnackedLocalId } from "@fluidframework/runtime-definitions";
-export declare function getIds(range: IdCreationRange): {
-    first: UnackedLocalId;
-    last: UnackedLocalId;
-    overrides?: IdCreationRange.Overrides;
-} | undefined;
-//# sourceMappingURL=idRange.d.ts.map

package/dist/id-compressor/idRange.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"idRange.d.ts","sourceRoot":"","sources":["../../src/id-compressor/idRange.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAE3F,wBAAgB,MAAM,CACrB,KAAK,EAAE,eAAe,GAEpB;IAAE,KAAK,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,cAAc,CAAC;IAAC,SAAS,CAAC,EAAE,eAAe,CAAC,SAAS,CAAA;CAAE,GACtF,SAAS,CAsBX"}

package/dist/id-compressor/idRange.js

@@ -1,29 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIds = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
-function getIds(range) {
-    const { ids } = range;
-    if (ids === undefined) {
-        return undefined;
-    }
-    let first = ids.first;
-    let last = ids.last;
-    const overrides = ids;
-    if (overrides.overrides !== undefined) {
-        first !== null && first !== void 0 ? first : (first = overrides.overrides[0][0]);
-        last !== null && last !== void 0 ? last : (last = overrides.overrides[overrides.overrides.length - 1][0]);
-    }
-    (0, common_utils_1.assert)(first !== undefined && last !== undefined, 0x49b /* malformed IdCreationRange */);
-    return {
-        first,
-        last,
-        overrides: overrides.overrides,
-    };
-}
-exports.getIds = getIds;
-//# sourceMappingURL=idRange.js.map

package/dist/id-compressor/idRange.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"idRange.js","sourceRoot":"","sources":["../../src/id-compressor/idRange.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAAsD;AAGtD,SAAgB,MAAM,CACrB,KAAsB;IAItB,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IACtB,IAAI,GAAG,KAAK,SAAS,EAAE;QACtB,OAAO,SAAS,CAAC;KACjB;IAED,IAAI,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IACtB,IAAI,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAEpB,MAAM,SAAS,GAAG,GAA4C,CAAC;IAC/D,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS,EAAE;QACtC,KAAK,aAAL,KAAK,cAAL,KAAK,IAAL,KAAK,GAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC;QACpC,IAAI,aAAJ,IAAI,cAAJ,IAAI,IAAJ,IAAI,GAAK,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC;KAChE;IAED,IAAA,qBAAM,EAAC,KAAK,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAEzF,OAAO;QACN,KAAK;QACL,IAAI;QACJ,SAAS,EAAE,SAAS,CAAC,SAAS;KAC9B,CAAC;AACH,CAAC;AA1BD,wBA0BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport type { IdCreationRange, UnackedLocalId } from \"@fluidframework/runtime-definitions\";\n\nexport function getIds(\n\trange: IdCreationRange,\n):\n\t| { first: UnackedLocalId; last: UnackedLocalId; overrides?: IdCreationRange.Overrides }\n\t| undefined {\n\tconst { ids } = range;\n\tif (ids === undefined) {\n\t\treturn undefined;\n\t}\n\n\tlet first = ids.first;\n\tlet last = ids.last;\n\n\tconst overrides = ids as Partial<IdCreationRange.HasOverrides>;\n\tif (overrides.overrides !== undefined) {\n\t\tfirst ??= overrides.overrides[0][0];\n\t\tlast ??= overrides.overrides[overrides.overrides.length - 1][0];\n\t}\n\n\tassert(first !== undefined && last !== undefined, 0x49b /* malformed IdCreationRange */);\n\n\treturn {\n\t\tfirst,\n\t\tlast,\n\t\toverrides: overrides.overrides,\n\t};\n}\n"]}

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

@@ -1,59 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { SessionId, StableId } from "@fluidframework/runtime-definitions";
-/**
- * A UUID (128 bit identifier) optimized for use as a 128 bit unsigned integer with fast addition and toString operations.
- * The string entry is the upper 76 bits of the uuid and the integer entry holds the lower 52 bits:
- *
- * ```
- * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid
- * SSSSSSSS-SSSS-SSSS-SSS               - array[0]: string
- *                       N NNNNNNNNNNNN - array[1]: integer
- * ```
- *
- * The integer keeps the common case cost of incrementing and computing deltas very low.
- * The string optimizes toString by caching the the majority of the resulting string.
- */
-export declare type NumericUuid = readonly [string, number] & {
-    readonly NumericUuid: "9132ea20-a811-4756-85f8-aa6da5ca90f8";
-};
-/**
- * Calculates the numeric delta between a and b (i.e. a - b).
- * @param a - an uuid
- * @param b - an other uuid
- * @param maxDelta - the maximum integer delta (inclusive) to tolerate.
- * @returns undefined if the delta is negative or greater than `maxDelta`
- */
-export declare function getPositiveDelta(a: NumericUuid, b: NumericUuid, maxDelta: number): number | undefined;
-/**
- * @param offset - an optional offset to increment the returned StableId
- * @returns the string representation of a `NumericUuid`.
- */
-export declare function stableIdFromNumericUuid(uuid: NumericUuid, offset?: number): StableId;
-/**
- * @param stableId - a minimal uuid string
- * @returns a numeric representation of `stableId`.
- */
-export declare function numericUuidFromStableId(stableId: StableId): NumericUuid;
-/**
- * Creates a session base ID.
- * This method (rather than standard uuid generation methods) should be used to generate session IDs.
- */
-export declare function createSessionId(): SessionId;
-/**
- * Compares numeric uuids for equality.
- */
-export declare function numericUuidEquals(a: NumericUuid, b: NumericUuid): boolean;
-/**
- * Increments the uuid. `amount` must be a positive integer.
- * @returns the result of incrementing the uuid by `amount`.
- */
-export declare function incrementUuid(uuid: NumericUuid, amount: number): NumericUuid;
-/**
- * Any session uuid with all of its highish bits set is in danger of overflowing after fewer than 2^53 increments.
- * By zeroing one of those bits at random, potential overflow is prevented.
- */
-export declare function ensureSessionUuid(uuid: StableId): SessionId;
-//# sourceMappingURL=numericUuid.d.ts.map

package/dist/id-compressor/numericUuid.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"numericUuid.d.ts","sourceRoot":"","sources":["../../src/id-compressor/numericUuid.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAI1E;;;;;;;;;;;;GAYG;AACH,oBAAY,WAAW,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACrD,QAAQ,CAAC,WAAW,EAAE,sCAAsC,CAAC;CAC7D,CAAC;AAQF;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC/B,CAAC,EAAE,WAAW,EACd,CAAC,EAAE,WAAW,EACd,QAAQ,EAAE,MAAM,GACd,MAAM,GAAG,SAAS,CAgDpB;AAaD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,SAAI,GAAG,QAAQ,CAW/E;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAKvE;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,SAAS,CAE3C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,GAAG,OAAO,CAEzE;AAQD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,WAAW,CAoD5E;AAiJD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAoB3D"}

package/dist/id-compressor/numericUuid.js

@@ -1,325 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureSessionUuid = exports.incrementUuid = exports.numericUuidEquals = exports.createSessionId = exports.numericUuidFromStableId = exports.stableIdFromNumericUuid = exports.getPositiveDelta = void 0;
-/* eslint-disable no-bitwise */
-/* eslint-disable @typescript-eslint/no-namespace */
-const common_utils_1 = require("@fluidframework/common-utils");
-const utils_1 = require("./utils");
-const uuidUtilities_1 = require("./uuidUtilities");
-const bitsInNumericUuidInteger = 52; // Not tunable. Do not change.
-const nibblesInNumericUuidInteger = bitsInNumericUuidInteger / 4;
-const stringEntryLength = 22;
-const maxNumericUuidInteger = 2 ** bitsInNumericUuidInteger - 1;
-const fiftyThirdBit = 2 ** 52;
-/**
- * Calculates the numeric delta between a and b (i.e. a - b).
- * @param a - an uuid
- * @param b - an other uuid
- * @param maxDelta - the maximum integer delta (inclusive) to tolerate.
- * @returns undefined if the delta is negative or greater than `maxDelta`
- */
-function getPositiveDelta(a, b, maxDelta) {
-    const [stringEntryA, lowNumberA] = a;
-    const [stringEntryB, lowNumberB] = b;
-    if (stringEntryA === stringEntryB) {
-        const difference = lowNumberA - lowNumberB;
-        if (difference >= 0 && difference <= maxDelta) {
-            return difference;
-        }
-        return undefined;
-    }
-    const highNumberA = Number.parseInt(ChunkMath.Upper.parse(stringEntryA), 16);
-    const highNumberB = Number.parseInt(ChunkMath.Upper.parse(stringEntryB), 16);
-    let subtractHigh = highNumberA - highNumberB;
-    if (Math.abs(subtractHigh) > 1) {
-        // If the high bits differ by more than 1, then there is no chance that any lower bits could compensate
-        return undefined;
-    }
-    let midNumberA = ChunkMath.getNumericValue(ChunkMath.Variant.parse(stringEntryA));
-    const midNumberB = ChunkMath.getNumericValue(ChunkMath.Variant.parse(stringEntryB));
-    let subtractLow = lowNumberA - lowNumberB;
-    if (subtractLow < 0) {
-        midNumberA -= 1;
-        subtractLow += fiftyThirdBit;
-    }
-    let subtractMid = midNumberA - midNumberB;
-    if (subtractMid < 0) {
-        subtractHigh -= 1;
-        subtractMid += ChunkMath.twentyThirdBit;
-    }
-    if (subtractHigh !== 0) {
-        // a < b, no positive delta, or
-        // a > b by much more than MAX_SAFE_INTEGER
-        return undefined;
-    }
-    if (subtractMid > 1) {
-        return undefined;
-    }
-    else {
-        const trueDelta = fiftyThirdBit * subtractMid + subtractLow;
-        return trueDelta > maxDelta ? undefined : trueDelta;
-    }
-}
-exports.getPositiveDelta = getPositiveDelta;
-// Pre-allocated array of strings of zeros.
-// Used to pad hex strings up to 52 bits
-const zeros = [];
-for (let i = 0; i < nibblesInNumericUuidInteger; i++) {
-    zeros.push("0".repeat(i));
-}
-function padToLengthWithZeros(str, count) {
-    return str.length === count ? str : zeros[count - str.length] + str;
-}
-/**
- * @param offset - an optional offset to increment the returned StableId
- * @returns the string representation of a `NumericUuid`.
- */
-function stableIdFromNumericUuid(uuid, offset = 0) {
-    const lowerAdd = uuid[1] + offset;
-    // Common fast-path
-    if (lowerAdd <= maxNumericUuidInteger) {
-        const lowerString = padToLengthWithZeros(lowerAdd.toString(16), nibblesInNumericUuidInteger);
-        return `${uuid[0] + lowerString.slice(0, 1)}-${lowerString.slice(1)}`;
-    }
-    return stableIdFromNumericUuid(incrementUuid(uuid, offset));
-}
-exports.stableIdFromNumericUuid = stableIdFromNumericUuid;
-/**
- * @param stableId - a minimal uuid string
- * @returns a numeric representation of `stableId`.
- */
-function numericUuidFromStableId(stableId) {
-    const uuid = new Array(2);
-    uuid[0] = stableId.slice(0, stringEntryLength);
-    uuid[1] = Number.parseInt(ChunkMath.Lower.parse(stableId), 16);
-    return uuid;
-}
-exports.numericUuidFromStableId = numericUuidFromStableId;
-/**
- * Creates a session base ID.
- * This method (rather than standard uuid generation methods) should be used to generate session IDs.
- */
-function createSessionId() {
-    return ensureSessionUuid((0, uuidUtilities_1.generateStableId)());
-}
-exports.createSessionId = createSessionId;
-/**
- * Compares numeric uuids for equality.
- */
-function numericUuidEquals(a, b) {
-    return a[0] === b[0] && a[1] === b[1];
-}
-exports.numericUuidEquals = numericUuidEquals;
-/**
- * The maximum value that can be contained in the upper string region of a numeric UUID (i.e. the string region excluding the version
- * nibble and the variant chunk)
- */
-const maxUpperNumber = 2 ** 48 - 1;
-/**
- * Increments the uuid. `amount` must be a positive integer.
- * @returns the result of incrementing the uuid by `amount`.
- */
-function incrementUuid(uuid, amount) {
-    /*
-     * UUIDs incremented beyond the max UUID "ffffffff-ffff-4fff-bfff-ffffffffffff" will cause a failure.
-     * Also, some reserved bits of the v4 UUID must be treated as immutable (e.g. the version and
-     * variant bits) and thus must not be incremented.
-     */
-    let newUuid;
-    const result = uuid[1] + amount;
-    if (result <= maxNumericUuidInteger) {
-        // The new number still fits within the number region of a numeric UUID.
-        // Incrementing is usually done with small amounts, so this is the dominantly common case.
-        newUuid = [uuid[0], result];
-    }
-    else {
-        // The numeric UUID's number region has overflowed. We will need to carry the overflow into the variant chunk (see `VariantChunk`).
-        /** The amount left over after filling up the rest of the uuid's number region with the increment amount */
-        const remainder = amount - (maxNumericUuidInteger - uuid[1]) - 1;
-        const stringEntry = uuid[0];
-        const [newVariantChunkString, carried] = ChunkMath.increment(stringEntry);
-        if (carried) {
-            // The variant chunk itself also overflowed. We'll need to carry the overflow further, into the upper string region of the UUID.
-            const upperString = ChunkMath.Upper.parse(stringEntry);
-            const upperNumber = Number.parseInt(upperString, 16);
-            (0, common_utils_1.assert)(upperNumber <= maxUpperNumber, 0x49c /* Unexpectedly large upper number when incrementing UUID */);
-            const newUpperNumber = upperNumber + 1;
-            if (newUpperNumber > maxUpperNumber) {
-                (0, utils_1.fail)("Exceeded maximum numeric UUID");
-            }
-            else {
-                // The variant chunk overflowed but the upper string region did not. Splice in the incremented string region.
-                const newUpperChunk = padToLengthWithZeros(newUpperNumber.toString(16), 12);
-                newUuid = [
-                    `${ChunkMath.Upper.hyphenate(newUpperChunk)}-4${ChunkMath.Variant.hyphenate(newVariantChunkString)}`,
-                    remainder,
-                ];
-            }
-        }
-        else {
-            // The variant chunk did not overflow, so just splice it back in.
-            newUuid = [
-                `${ChunkMath.Upper.slice(stringEntry)}-4${ChunkMath.Variant.hyphenate(newVariantChunkString)}`,
-                remainder,
-            ];
-        }
-    }
-    return newUuid;
-}
-exports.incrementUuid = incrementUuid;
-var ChunkMath;
-(function (ChunkMath) {
-    /*
-     * Recall the UUID diagram from the top of this file which describes the layout of a Numeric UUID. To implement addition, we define
-     * another region called the "variant chunk" which overlaps with the "string" region. Note that it is just beneath the required v4 uuid
-     * version identifier (the 13th nibble 'V' which is always '4' in a v4 UUID) and just above the "number" region of the layout. It
-     * contains inside of it the v4 UUID variant identifier bits as well (see https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.1).
-     *
-     * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid
-     * SSSSSSSS SSSS SSSS SSS               - array[0]: string
-     *                       N NNNNNNNNNNNN - array[1]: integer
-     *                VVV-VVV               - the variant chunk
-     *
-     * By defining the variant chunk in this way it is simple to splice in the v4 UUID version identifier ('V') just above it and any
-     * "bit math" required due to the fact that the variant identifier bits ('v') do not fill up an entire nibble is handled within it.
-     * The variant chunk is made up of 6 nibbles. Note the "vv" which denotes the two bits used for the v4 UUID variant identifier:
-     *
-     * AAAA BBBB CCCC vvDD EEEE FFFF
-     *
-     * Since we'll be needing to "skip" the variant bits ("vv") when doing addition, we define a a few masks which will be used below to
-     * separate the variant chunk into pieces before recombining it:
-     */
-    //                                         AAAA BBBB CCCC vvDD EEEE FFFF
-    const upperVariantChunkMask = 0xfff000; // XXXX XXXX XXXX
-    const variantBitMask = 0x800; //                          XX
-    const middleVariantChunkMask = 0x300; //                    XX
-    const lowerVariantChunkMask = 0xff; //                         XXXX XXXX
-    /** The maximum numeric value that can be represented by the numerically relevant bits in the variant chunk */
-    const maxVariantNumber = 2 ** 22 - 1;
-    ChunkMath.twentyThirdBit = 2 ** 22;
-    /**
-     * The upper chunk, denoted by 'U's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL
-     */
-    let Upper;
-    (function (Upper) {
-        function parse(stringEntry) {
-            return stringEntry.slice(0, 8) + stringEntry.slice(9, 13);
-        }
-        Upper.parse = parse;
-        function hyphenate(upperChunk) {
-            return `${upperChunk.slice(0, 8)}-${upperChunk.slice(8)}`;
-        }
-        Upper.hyphenate = hyphenate;
-        function slice(stringEntry) {
-            return stringEntry.slice(0, 13);
-        }
-        Upper.slice = slice;
-    })(Upper = ChunkMath.Upper || (ChunkMath.Upper = {}));
-    /**
-     * The variant chunk, denoted by 'V's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL
-     */
-    let Variant;
-    (function (Variant) {
-        function parse(stringEntry) {
-            return stringEntry.slice(15, 18) + stringEntry.slice(19, 22);
-        }
-        Variant.parse = parse;
-        function hyphenate(variantChunk) {
-            return `${variantChunk.slice(0, 3)}-${variantChunk.slice(3)}`;
-        }
-        Variant.hyphenate = hyphenate;
-    })(Variant = ChunkMath.Variant || (ChunkMath.Variant = {}));
-    /**
-     * The lower chunk, denoted by 'L's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL
-     */
-    let Lower;
-    (function (Lower) {
-        function parse(stableId) {
-            return (stableId.slice(stringEntryLength, stringEntryLength + 1) +
-                stableId.slice(stringEntryLength + 2));
-        }
-        Lower.parse = parse;
-        function hyphenate(lowerChunk) {
-            return `${lowerChunk.slice(0, 1)}-${lowerChunk.slice(1)}`;
-        }
-        Lower.hyphenate = hyphenate;
-    })(Lower = ChunkMath.Lower || (ChunkMath.Lower = {}));
-    /**
-     * Returns the number representation of the given bits corresponding to the variant chunk. The value is derived by
-     * parsing all bits except for reserved bits (i.e. the variant bits).
-     * @param variantChunk - the variantChunk
-     */
-    function getNumericValue(variantChunk) {
-        const variantChunkBits = Number.parseInt(variantChunk, 16);
-        const upperVariantBits = (variantChunkBits & upperVariantChunkMask) >> 2;
-        const middleVariantBits = variantChunkBits & middleVariantChunkMask;
-        const lowerVariantBits = variantChunkBits & lowerVariantChunkMask;
-        return upperVariantBits + middleVariantBits + lowerVariantBits;
-    }
-    ChunkMath.getNumericValue = getNumericValue;
-    /**
-     * Given the string portion of a numeric uuid, add one to it.
-     * @returns the resulting hex string and whether or not the new value overflowed, i.e. it exceeds `maxVariantNumber`. In this case,
-     * the resulting hex string will wrap around to its minimum value '000b00'
-     */
-    function increment(stringEntry) {
-        // To implement addition, the variant identifier bits are extracted from the variant chunk, the chunk is interpreted as a number,
-        // that number is incremented by 1, and then the variant identifier bits are returned as we convert the number back into a hex
-        // string.
-        // This diagram may be helpful for seeing how the nibbles line up before and after the variant identifier bits are extracted. The
-        // letters used for each nibble ("AAAA", "BBBB") etc. are arbitrary and are simply there to differentiate the nibbles as they shift.
-        // --------------------------------
-        // 1. AAAA BBBB CCCC vvDD EEEE FFFF
-        // 2.   AA AABB BBCC CCDD EEEE FFFF
-        // 3.   AA AABB BBCC CCDD EEEE FFFF
-        //                              + 1
-        //    = GG GGHH HHII IIJJ JJKK KKLL
-        // 4. GGGG HHHH IIII vvJJ JJKK KKLL
-        // 1. The variant chunk is given as a 6 character (6 nibble) hex string, where the fourth nibble contains the variant bits
-        // 2. The numerically important bits (i.e. not the variant identifier bits vv which are constant) are extracted into a single number
-        const variantChunk = Variant.parse(stringEntry);
-        const variantNumber = getNumericValue(variantChunk);
-        (0, common_utils_1.assert)(variantNumber <= maxVariantNumber, 0x49d /* Unexpectedly large variant number when incrementing UUID */);
-        // 3. Add one to the variant number to produce our new variant number.
-        const newVariantNumber = variantNumber + 1;
-        // 4. The variant identifier bits are added back into the number, which is then turned back into a hex string
-        const newUpperVariantBits = (newVariantNumber & (upperVariantChunkMask >> 2)) << 2;
-        const newMiddleVariantBits = (newVariantNumber & middleVariantChunkMask) | variantBitMask; // Add the variant bits back in
-        const newLowerVariantBits = newVariantNumber & lowerVariantChunkMask;
-        const newVariantChunkBits = newUpperVariantBits + newMiddleVariantBits + newLowerVariantBits;
-        const newVariantChunk = padToLengthWithZeros(newVariantChunkBits.toString(16), variantChunk.length);
-        return [newVariantChunk, newVariantNumber > maxVariantNumber];
-    }
-    ChunkMath.increment = increment;
-})(ChunkMath || (ChunkMath = {}));
-const maxUpperUuid = "ffffffff-ffff-4fff-bf";
-const maxNibbleCount = [...maxUpperUuid].filter((n) => n === "f").length;
-const newNibbles = ["7", "b", "d", "e"];
-function isMaxUpperNibble(index) {
-    return maxUpperUuid.charAt(index) === "f";
-}
-/**
- * Any session uuid with all of its highish bits set is in danger of overflowing after fewer than 2^53 increments.
- * By zeroing one of those bits at random, potential overflow is prevented.
- */
-function ensureSessionUuid(uuid) {
-    if (uuid.startsWith(maxUpperUuid)) {
-        const targetNibble = Math.floor(Math.random() * maxNibbleCount);
-        let actualIndex = 0;
-        for (let nibbleIndex = 0; nibbleIndex < targetNibble && !isMaxUpperNibble(actualIndex); actualIndex += 1) {
-            if (isMaxUpperNibble(actualIndex)) {
-                nibbleIndex++;
-            }
-        }
-        const newNibble = newNibbles[Math.floor(Math.random() * newNibbles.length)]; // Randomly choose a bit to zero
-        const newUuid = uuid.slice(0, actualIndex) + newNibble + uuid.slice(actualIndex + 1);
-        return newUuid;
-    }
-    return uuid;
-}
-exports.ensureSessionUuid = ensureSessionUuid;
-//# sourceMappingURL=numericUuid.js.map

package/dist/id-compressor/numericUuid.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"numericUuid.js","sourceRoot":"","sources":["../../src/id-compressor/numericUuid.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAA+B;AAC/B,oDAAoD;AAEpD,+DAAsD;AAEtD,mCAA+B;AAC/B,mDAAmD;AAmBnD,MAAM,wBAAwB,GAAG,EAAE,CAAC,CAAC,8BAA8B;AACnE,MAAM,2BAA2B,GAAG,wBAAwB,GAAG,CAAC,CAAC;AACjE,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,qBAAqB,GAAG,CAAC,IAAI,wBAAwB,GAAG,CAAC,CAAC;AAChE,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,CAAC;AAE9B;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC/B,CAAc,EACd,CAAc,EACd,QAAgB;IAEhB,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;IAErC,IAAI,YAAY,KAAK,YAAY,EAAE;QAClC,MAAM,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;QAC3C,IAAI,UAAU,IAAI,CAAC,IAAI,UAAU,IAAI,QAAQ,EAAE;YAC9C,OAAO,UAAU,CAAC;SAClB;QACD,OAAO,SAAS,CAAC;KACjB;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7E,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC;IAE7E,IAAI,YAAY,GAAG,WAAW,GAAG,WAAW,CAAC;IAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE;QAC/B,uGAAuG;QACvG,OAAO,SAAS,CAAC;KACjB;IAED,IAAI,UAAU,GAAG,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAClF,MAAM,UAAU,GAAG,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAEpF,IAAI,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAC1C,IAAI,WAAW,GAAG,CAAC,EAAE;QACpB,UAAU,IAAI,CAAC,CAAC;QAChB,WAAW,IAAI,aAAa,CAAC;KAC7B;IAED,IAAI,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAC1C,IAAI,WAAW,GAAG,CAAC,EAAE;QACpB,YAAY,IAAI,CAAC,CAAC;QAClB,WAAW,IAAI,SAAS,CAAC,cAAc,CAAC;KACxC;IAED,IAAI,YAAY,KAAK,CAAC,EAAE;QACvB,+BAA+B;QAC/B,2CAA2C;QAC3C,OAAO,SAAS,CAAC;KACjB;IAED,IAAI,WAAW,GAAG,CAAC,EAAE;QACpB,OAAO,SAAS,CAAC;KACjB;SAAM;QACN,MAAM,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;QAC5D,OAAO,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;KACpD;AACF,CAAC;AApDD,4CAoDC;AAED,2CAA2C;AAC3C,wCAAwC;AACxC,MAAM,KAAK,GAAa,EAAE,CAAC;AAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,2BAA2B,EAAE,CAAC,EAAE,EAAE;IACrD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED,SAAS,oBAAoB,CAAC,GAAW,EAAE,KAAa;IACvD,OAAO,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;AACrE,CAAC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CAAC,IAAiB,EAAE,MAAM,GAAG,CAAC;IACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IAClC,mBAAmB;IACnB,IAAI,QAAQ,IAAI,qBAAqB,EAAE;QACtC,MAAM,WAAW,GAAG,oBAAoB,CACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EACrB,2BAA2B,CAC3B,CAAC;QACF,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAc,CAAC;KAClF;IACD,OAAO,uBAAuB,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAC7D,CAAC;AAXD,0DAWC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CAAC,QAAkB;IACzD,MAAM,IAAI,GAAwB,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/C,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC/C,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/D,OAAO,IAAmD,CAAC;AAC5D,CAAC;AALD,0DAKC;AAED;;;GAGG;AACH,SAAgB,eAAe;IAC9B,OAAO,iBAAiB,CAAC,IAAA,gCAAgB,GAAE,CAAC,CAAC;AAC9C,CAAC;AAFD,0CAEC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,CAAc,EAAE,CAAc;IAC/D,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC;AAFD,8CAEC;AAED;;;GAGG;AACH,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAEnC;;;GAGG;AACH,SAAgB,aAAa,CAAC,IAAiB,EAAE,MAAc;IAC9D;;;;OAIG;IACH,IAAI,OAAyB,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IAChC,IAAI,MAAM,IAAI,qBAAqB,EAAE;QACpC,wEAAwE;QACxE,0FAA0F;QAC1F,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;KAC5B;SAAM;QACN,mIAAmI;QACnI,2GAA2G;QAC3G,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACjE,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5B,MAAM,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAE1E,IAAI,OAAO,EAAE;YACZ,gIAAgI;YAChI,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACvD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACrD,IAAA,qBAAM,EACL,WAAW,IAAI,cAAc,EAC7B,KAAK,CAAC,4DAA4D,CAClE,CAAC;YACF,MAAM,cAAc,GAAG,WAAW,GAAG,CAAC,CAAC;YACvC,IAAI,cAAc,GAAG,cAAc,EAAE;gBACpC,IAAA,YAAI,EAAC,+BAA+B,CAAC,CAAC;aACtC;iBAAM;gBACN,6GAA6G;gBAC7G,MAAM,aAAa,GAAG,oBAAoB,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC5E,OAAO,GAAG;oBACT,GAAG,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,SAAS,CAC1E,qBAAqB,CACrB,EAAE;oBACH,SAAS;iBACT,CAAC;aACF;SACD;aAAM;YACN,iEAAiE;YACjE,OAAO,GAAG;gBACT,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,SAAS,CACpE,qBAAqB,CACrB,EAAE;gBACH,SAAS;aACT,CAAC;SACF;KACD;IAED,OAAO,OAAmD,CAAC;AAC5D,CAAC;AApDD,sCAoDC;AAED,IAAU,SAAS,CAsIlB;AAtID,WAAU,SAAS;IAClB;;;;;;;;;;;;;;;;;;;OAmBG;IAEH,wEAAwE;IACxE,MAAM,qBAAqB,GAAG,QAAQ,CAAC,CAAC,iBAAiB;IACzD,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,8BAA8B;IAC5D,MAAM,sBAAsB,GAAG,KAAK,CAAC,CAAC,wBAAwB;IAC9D,MAAM,qBAAqB,GAAG,IAAI,CAAC,CAAC,oCAAoC;IAExE,8GAA8G;IAC9G,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAExB,wBAAc,GAAG,CAAC,IAAI,EAAE,CAAC;IAEtC;;OAEG;IACH,IAAiB,KAAK,CAYrB;IAZD,WAAiB,KAAK;QACrB,SAAgB,KAAK,CAAC,WAAmB;YACxC,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3D,CAAC;QAFe,WAAK,QAEpB,CAAA;QAED,SAAgB,SAAS,CAAC,UAAkB;YAC3C,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,CAAC;QAFe,eAAS,YAExB,CAAA;QAED,SAAgB,KAAK,CAAC,WAAmB;YACxC,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACjC,CAAC;QAFe,WAAK,QAEpB,CAAA;IACF,CAAC,EAZgB,KAAK,GAAL,eAAK,KAAL,eAAK,QAYrB;IAED;;OAEG;IACH,IAAiB,OAAO,CAQvB;IARD,WAAiB,OAAO;QACvB,SAAgB,KAAK,CAAC,WAAmB;YACxC,OAAO,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9D,CAAC;QAFe,aAAK,QAEpB,CAAA;QAED,SAAgB,SAAS,CAAC,YAAoB;YAC7C,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,CAAC;QAFe,iBAAS,YAExB,CAAA;IACF,CAAC,EARgB,OAAO,GAAP,iBAAO,KAAP,iBAAO,QAQvB;IAED;;OAEG;IACH,IAAiB,KAAK,CAWrB;IAXD,WAAiB,KAAK;QACrB,SAAgB,KAAK,CAAC,QAAkB;YACvC,OAAO,CACN,QAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,CAAC,CAAC;gBACxD,QAAQ,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,CACrC,CAAC;QACH,CAAC;QALe,WAAK,QAKpB,CAAA;QAED,SAAgB,SAAS,CAAC,UAAkB;YAC3C,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,CAAC;QAFe,eAAS,YAExB,CAAA;IACF,CAAC,EAXgB,KAAK,GAAL,eAAK,KAAL,eAAK,QAWrB;IAED;;;;OAIG;IACH,SAAgB,eAAe,CAAC,YAAoB;QACnD,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3D,MAAM,gBAAgB,GAAG,CAAC,gBAAgB,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACzE,MAAM,iBAAiB,GAAG,gBAAgB,GAAG,sBAAsB,CAAC;QACpE,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,qBAAqB,CAAC;QAClE,OAAO,gBAAgB,GAAG,iBAAiB,GAAG,gBAAgB,CAAC;IAChE,CAAC;IANe,yBAAe,kBAM9B,CAAA;IAED;;;;OAIG;IACH,SAAgB,SAAS,CAAC,WAAmB;QAC5C,iIAAiI;QACjI,8HAA8H;QAC9H,UAAU;QAEV,iIAAiI;QACjI,oIAAoI;QACpI,mCAAmC;QACnC,mCAAmC;QACnC,mCAAmC;QACnC,mCAAmC;QACnC,mCAAmC;QACnC,mCAAmC;QACnC,mCAAmC;QAEnC,0HAA0H;QAC1H,oIAAoI;QACpI,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAChD,MAAM,aAAa,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QACpD,IAAA,qBAAM,EACL,aAAa,IAAI,gBAAgB,EACjC,KAAK,CAAC,8DAA8D,CACpE,CAAC;QACF,sEAAsE;QACtE,MAAM,gBAAgB,GAAG,aAAa,GAAG,CAAC,CAAC;QAC3C,6GAA6G;QAC7G,MAAM,mBAAmB,GAAG,CAAC,gBAAgB,GAAG,CAAC,qBAAqB,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACnF,MAAM,oBAAoB,GAAG,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,GAAG,cAAc,CAAC,CAAC,+BAA+B;QAC1H,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,qBAAqB,CAAC;QACrE,MAAM,mBAAmB,GACxB,mBAAmB,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;QAClE,MAAM,eAAe,GAAG,oBAAoB,CAC3C,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAChC,YAAY,CAAC,MAAM,CACnB,CAAC;QACF,OAAO,CAAC,eAAe,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IApCe,mBAAS,YAoCxB,CAAA;AACF,CAAC,EAtIS,SAAS,KAAT,SAAS,QAsIlB;AAED,MAAM,YAAY,GAAG,uBAAuB,CAAC;AAC7C,MAAM,cAAc,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC;AACzE,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxC,SAAS,gBAAgB,CAAC,KAAa;IACtC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;AAC3C,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,IAAc;IAC/C,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE;QAClC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,CAAC;QAChE,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,KACC,IAAI,WAAW,GAAG,CAAC,EACnB,WAAW,GAAG,YAAY,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAC5D,WAAW,IAAI,CAAC,EACf;YACD,IAAI,gBAAgB,CAAC,WAAW,CAAC,EAAE;gBAClC,WAAW,EAAE,CAAC;aACd;SACD;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,gCAAgC;QAC7G,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACrF,OAAO,OAAoB,CAAC;KAC5B;IAED,OAAO,IAAiB,CAAC;AAC1B,CAAC;AApBD,8CAoBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable no-bitwise */\n/* eslint-disable @typescript-eslint/no-namespace */\n\nimport { assert } from \"@fluidframework/common-utils\";\nimport { SessionId, StableId } from \"@fluidframework/runtime-definitions\";\nimport { fail } from \"./utils\";\nimport { generateStableId } from \"./uuidUtilities\";\n\n/**\n * A UUID (128 bit identifier) optimized for use as a 128 bit unsigned integer with fast addition and toString operations.\n * The string entry is the upper 76 bits of the uuid and the integer entry holds the lower 52 bits:\n *\n * ```\n * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid\n * SSSSSSSS-SSSS-SSSS-SSS               - array[0]: string\n *                       N NNNNNNNNNNNN - array[1]: integer\n * ```\n *\n * The integer keeps the common case cost of incrementing and computing deltas very low.\n * The string optimizes toString by caching the the majority of the resulting string.\n */\nexport type NumericUuid = readonly [string, number] & {\n\treadonly NumericUuid: \"9132ea20-a811-4756-85f8-aa6da5ca90f8\";\n};\n\nconst bitsInNumericUuidInteger = 52; // Not tunable. Do not change.\nconst nibblesInNumericUuidInteger = bitsInNumericUuidInteger / 4;\nconst stringEntryLength = 22;\nconst maxNumericUuidInteger = 2 ** bitsInNumericUuidInteger - 1;\nconst fiftyThirdBit = 2 ** 52;\n\n/**\n * Calculates the numeric delta between a and b (i.e. a - b).\n * @param a - an uuid\n * @param b - an other uuid\n * @param maxDelta - the maximum integer delta (inclusive) to tolerate.\n * @returns undefined if the delta is negative or greater than `maxDelta`\n */\nexport function getPositiveDelta(\n\ta: NumericUuid,\n\tb: NumericUuid,\n\tmaxDelta: number,\n): number | undefined {\n\tconst [stringEntryA, lowNumberA] = a;\n\tconst [stringEntryB, lowNumberB] = b;\n\n\tif (stringEntryA === stringEntryB) {\n\t\tconst difference = lowNumberA - lowNumberB;\n\t\tif (difference >= 0 && difference <= maxDelta) {\n\t\t\treturn difference;\n\t\t}\n\t\treturn undefined;\n\t}\n\n\tconst highNumberA = Number.parseInt(ChunkMath.Upper.parse(stringEntryA), 16);\n\tconst highNumberB = Number.parseInt(ChunkMath.Upper.parse(stringEntryB), 16);\n\n\tlet subtractHigh = highNumberA - highNumberB;\n\tif (Math.abs(subtractHigh) > 1) {\n\t\t// If the high bits differ by more than 1, then there is no chance that any lower bits could compensate\n\t\treturn undefined;\n\t}\n\n\tlet midNumberA = ChunkMath.getNumericValue(ChunkMath.Variant.parse(stringEntryA));\n\tconst midNumberB = ChunkMath.getNumericValue(ChunkMath.Variant.parse(stringEntryB));\n\n\tlet subtractLow = lowNumberA - lowNumberB;\n\tif (subtractLow < 0) {\n\t\tmidNumberA -= 1;\n\t\tsubtractLow += fiftyThirdBit;\n\t}\n\n\tlet subtractMid = midNumberA - midNumberB;\n\tif (subtractMid < 0) {\n\t\tsubtractHigh -= 1;\n\t\tsubtractMid += ChunkMath.twentyThirdBit;\n\t}\n\n\tif (subtractHigh !== 0) {\n\t\t// a < b, no positive delta, or\n\t\t// a > b by much more than MAX_SAFE_INTEGER\n\t\treturn undefined;\n\t}\n\n\tif (subtractMid > 1) {\n\t\treturn undefined;\n\t} else {\n\t\tconst trueDelta = fiftyThirdBit * subtractMid + subtractLow;\n\t\treturn trueDelta > maxDelta ? undefined : trueDelta;\n\t}\n}\n\n// Pre-allocated array of strings of zeros.\n// Used to pad hex strings up to 52 bits\nconst zeros: string[] = [];\nfor (let i = 0; i < nibblesInNumericUuidInteger; i++) {\n\tzeros.push(\"0\".repeat(i));\n}\n\nfunction padToLengthWithZeros(str: string, count: number): string {\n\treturn str.length === count ? str : zeros[count - str.length] + str;\n}\n\n/**\n * @param offset - an optional offset to increment the returned StableId\n * @returns the string representation of a `NumericUuid`.\n */\nexport function stableIdFromNumericUuid(uuid: NumericUuid, offset = 0): StableId {\n\tconst lowerAdd = uuid[1] + offset;\n\t// Common fast-path\n\tif (lowerAdd <= maxNumericUuidInteger) {\n\t\tconst lowerString = padToLengthWithZeros(\n\t\t\tlowerAdd.toString(16),\n\t\t\tnibblesInNumericUuidInteger,\n\t\t);\n\t\treturn `${uuid[0] + lowerString.slice(0, 1)}-${lowerString.slice(1)}` as StableId;\n\t}\n\treturn stableIdFromNumericUuid(incrementUuid(uuid, offset));\n}\n\n/**\n * @param stableId - a minimal uuid string\n * @returns a numeric representation of `stableId`.\n */\nexport function numericUuidFromStableId(stableId: StableId): NumericUuid {\n\tconst uuid: (string | number)[] = new Array(2);\n\tuuid[0] = stableId.slice(0, stringEntryLength);\n\tuuid[1] = Number.parseInt(ChunkMath.Lower.parse(stableId), 16);\n\treturn uuid as readonly (number | string)[] as NumericUuid;\n}\n\n/**\n * Creates a session base ID.\n * This method (rather than standard uuid generation methods) should be used to generate session IDs.\n */\nexport function createSessionId(): SessionId {\n\treturn ensureSessionUuid(generateStableId());\n}\n\n/**\n * Compares numeric uuids for equality.\n */\nexport function numericUuidEquals(a: NumericUuid, b: NumericUuid): boolean {\n\treturn a[0] === b[0] && a[1] === b[1];\n}\n\n/**\n * The maximum value that can be contained in the upper string region of a numeric UUID (i.e. the string region excluding the version\n * nibble and the variant chunk)\n */\nconst maxUpperNumber = 2 ** 48 - 1;\n\n/**\n * Increments the uuid. `amount` must be a positive integer.\n * @returns the result of incrementing the uuid by `amount`.\n */\nexport function incrementUuid(uuid: NumericUuid, amount: number): NumericUuid {\n\t/*\n\t * UUIDs incremented beyond the max UUID \"ffffffff-ffff-4fff-bfff-ffffffffffff\" will cause a failure.\n\t * Also, some reserved bits of the v4 UUID must be treated as immutable (e.g. the version and\n\t * variant bits) and thus must not be incremented.\n\t */\n\tlet newUuid: [string, number];\n\tconst result = uuid[1] + amount;\n\tif (result <= maxNumericUuidInteger) {\n\t\t// The new number still fits within the number region of a numeric UUID.\n\t\t// Incrementing is usually done with small amounts, so this is the dominantly common case.\n\t\tnewUuid = [uuid[0], result];\n\t} else {\n\t\t// The numeric UUID's number region has overflowed. We will need to carry the overflow into the variant chunk (see `VariantChunk`).\n\t\t/** The amount left over after filling up the rest of the uuid's number region with the increment amount */\n\t\tconst remainder = amount - (maxNumericUuidInteger - uuid[1]) - 1;\n\t\tconst stringEntry = uuid[0];\n\t\tconst [newVariantChunkString, carried] = ChunkMath.increment(stringEntry);\n\n\t\tif (carried) {\n\t\t\t// The variant chunk itself also overflowed. We'll need to carry the overflow further, into the upper string region of the UUID.\n\t\t\tconst upperString = ChunkMath.Upper.parse(stringEntry);\n\t\t\tconst upperNumber = Number.parseInt(upperString, 16);\n\t\t\tassert(\n\t\t\t\tupperNumber <= maxUpperNumber,\n\t\t\t\t0x49c /* Unexpectedly large upper number when incrementing UUID */,\n\t\t\t);\n\t\t\tconst newUpperNumber = upperNumber + 1;\n\t\t\tif (newUpperNumber > maxUpperNumber) {\n\t\t\t\tfail(\"Exceeded maximum numeric UUID\");\n\t\t\t} else {\n\t\t\t\t// The variant chunk overflowed but the upper string region did not. Splice in the incremented string region.\n\t\t\t\tconst newUpperChunk = padToLengthWithZeros(newUpperNumber.toString(16), 12);\n\t\t\t\tnewUuid = [\n\t\t\t\t\t`${ChunkMath.Upper.hyphenate(newUpperChunk)}-4${ChunkMath.Variant.hyphenate(\n\t\t\t\t\t\tnewVariantChunkString,\n\t\t\t\t\t)}`,\n\t\t\t\t\tremainder,\n\t\t\t\t];\n\t\t\t}\n\t\t} else {\n\t\t\t// The variant chunk did not overflow, so just splice it back in.\n\t\t\tnewUuid = [\n\t\t\t\t`${ChunkMath.Upper.slice(stringEntry)}-4${ChunkMath.Variant.hyphenate(\n\t\t\t\t\tnewVariantChunkString,\n\t\t\t\t)}`,\n\t\t\t\tremainder,\n\t\t\t];\n\t\t}\n\t}\n\n\treturn newUuid as readonly [string, number] as NumericUuid;\n}\n\nnamespace ChunkMath {\n\t/*\n\t * Recall the UUID diagram from the top of this file which describes the layout of a Numeric UUID. To implement addition, we define\n\t * another region called the \"variant chunk\" which overlaps with the \"string\" region. Note that it is just beneath the required v4 uuid\n\t * version identifier (the 13th nibble 'V' which is always '4' in a v4 UUID) and just above the \"number\" region of the layout. It\n\t * contains inside of it the v4 UUID variant identifier bits as well (see https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.1).\n\t *\n\t * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid\n\t * SSSSSSSS SSSS SSSS SSS               - array[0]: string\n\t *                       N NNNNNNNNNNNN - array[1]: integer\n\t *                VVV-VVV               - the variant chunk\n\t *\n\t * By defining the variant chunk in this way it is simple to splice in the v4 UUID version identifier ('V') just above it and any\n\t * \"bit math\" required due to the fact that the variant identifier bits ('v') do not fill up an entire nibble is handled within it.\n\t * The variant chunk is made up of 6 nibbles. Note the \"vv\" which denotes the two bits used for the v4 UUID variant identifier:\n\t *\n\t * AAAA BBBB CCCC vvDD EEEE FFFF\n\t *\n\t * Since we'll be needing to \"skip\" the variant bits (\"vv\") when doing addition, we define a a few masks which will be used below to\n\t * separate the variant chunk into pieces before recombining it:\n\t */\n\n\t//                                         AAAA BBBB CCCC vvDD EEEE FFFF\n\tconst upperVariantChunkMask = 0xfff000; // XXXX XXXX XXXX\n\tconst variantBitMask = 0x800; //                          XX\n\tconst middleVariantChunkMask = 0x300; //                    XX\n\tconst lowerVariantChunkMask = 0xff; //                         XXXX XXXX\n\n\t/** The maximum numeric value that can be represented by the numerically relevant bits in the variant chunk */\n\tconst maxVariantNumber = 2 ** 22 - 1;\n\n\texport const twentyThirdBit = 2 ** 22;\n\n\t/**\n\t * The upper chunk, denoted by 'U's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL\n\t */\n\texport namespace Upper {\n\t\texport function parse(stringEntry: string): string {\n\t\t\treturn stringEntry.slice(0, 8) + stringEntry.slice(9, 13);\n\t\t}\n\n\t\texport function hyphenate(upperChunk: string): string {\n\t\t\treturn `${upperChunk.slice(0, 8)}-${upperChunk.slice(8)}`;\n\t\t}\n\n\t\texport function slice(stringEntry: string): string {\n\t\t\treturn stringEntry.slice(0, 13);\n\t\t}\n\t}\n\n\t/**\n\t * The variant chunk, denoted by 'V's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL\n\t */\n\texport namespace Variant {\n\t\texport function parse(stringEntry: string): string {\n\t\t\treturn stringEntry.slice(15, 18) + stringEntry.slice(19, 22);\n\t\t}\n\n\t\texport function hyphenate(variantChunk: string): string {\n\t\t\treturn `${variantChunk.slice(0, 3)}-${variantChunk.slice(3)}`;\n\t\t}\n\t}\n\n\t/**\n\t * The lower chunk, denoted by 'L's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL\n\t */\n\texport namespace Lower {\n\t\texport function parse(stableId: StableId): string {\n\t\t\treturn (\n\t\t\t\tstableId.slice(stringEntryLength, stringEntryLength + 1) +\n\t\t\t\tstableId.slice(stringEntryLength + 2)\n\t\t\t);\n\t\t}\n\n\t\texport function hyphenate(lowerChunk: string): string {\n\t\t\treturn `${lowerChunk.slice(0, 1)}-${lowerChunk.slice(1)}`;\n\t\t}\n\t}\n\n\t/**\n\t * Returns the number representation of the given bits corresponding to the variant chunk. The value is derived by\n\t * parsing all bits except for reserved bits (i.e. the variant bits).\n\t * @param variantChunk - the variantChunk\n\t */\n\texport function getNumericValue(variantChunk: string): number {\n\t\tconst variantChunkBits = Number.parseInt(variantChunk, 16);\n\t\tconst upperVariantBits = (variantChunkBits & upperVariantChunkMask) >> 2;\n\t\tconst middleVariantBits = variantChunkBits & middleVariantChunkMask;\n\t\tconst lowerVariantBits = variantChunkBits & lowerVariantChunkMask;\n\t\treturn upperVariantBits + middleVariantBits + lowerVariantBits;\n\t}\n\n\t/**\n\t * Given the string portion of a numeric uuid, add one to it.\n\t * @returns the resulting hex string and whether or not the new value overflowed, i.e. it exceeds `maxVariantNumber`. In this case,\n\t * the resulting hex string will wrap around to its minimum value '000b00'\n\t */\n\texport function increment(stringEntry: string): [newVariantChunk: string, overflowed: boolean] {\n\t\t// To implement addition, the variant identifier bits are extracted from the variant chunk, the chunk is interpreted as a number,\n\t\t// that number is incremented by 1, and then the variant identifier bits are returned as we convert the number back into a hex\n\t\t// string.\n\n\t\t// This diagram may be helpful for seeing how the nibbles line up before and after the variant identifier bits are extracted. The\n\t\t// letters used for each nibble (\"AAAA\", \"BBBB\") etc. are arbitrary and are simply there to differentiate the nibbles as they shift.\n\t\t// --------------------------------\n\t\t// 1. AAAA BBBB CCCC vvDD EEEE FFFF\n\t\t// 2.   AA AABB BBCC CCDD EEEE FFFF\n\t\t// 3.   AA AABB BBCC CCDD EEEE FFFF\n\t\t//                              + 1\n\t\t//    = GG GGHH HHII IIJJ JJKK KKLL\n\t\t// 4. GGGG HHHH IIII vvJJ JJKK KKLL\n\n\t\t// 1. The variant chunk is given as a 6 character (6 nibble) hex string, where the fourth nibble contains the variant bits\n\t\t// 2. The numerically important bits (i.e. not the variant identifier bits vv which are constant) are extracted into a single number\n\t\tconst variantChunk = Variant.parse(stringEntry);\n\t\tconst variantNumber = getNumericValue(variantChunk);\n\t\tassert(\n\t\t\tvariantNumber <= maxVariantNumber,\n\t\t\t0x49d /* Unexpectedly large variant number when incrementing UUID */,\n\t\t);\n\t\t// 3. Add one to the variant number to produce our new variant number.\n\t\tconst newVariantNumber = variantNumber + 1;\n\t\t// 4. The variant identifier bits are added back into the number, which is then turned back into a hex string\n\t\tconst newUpperVariantBits = (newVariantNumber & (upperVariantChunkMask >> 2)) << 2;\n\t\tconst newMiddleVariantBits = (newVariantNumber & middleVariantChunkMask) | variantBitMask; // Add the variant bits back in\n\t\tconst newLowerVariantBits = newVariantNumber & lowerVariantChunkMask;\n\t\tconst newVariantChunkBits =\n\t\t\tnewUpperVariantBits + newMiddleVariantBits + newLowerVariantBits;\n\t\tconst newVariantChunk = padToLengthWithZeros(\n\t\t\tnewVariantChunkBits.toString(16),\n\t\t\tvariantChunk.length,\n\t\t);\n\t\treturn [newVariantChunk, newVariantNumber > maxVariantNumber];\n\t}\n}\n\nconst maxUpperUuid = \"ffffffff-ffff-4fff-bf\";\nconst maxNibbleCount = [...maxUpperUuid].filter((n) => n === \"f\").length;\nconst newNibbles = [\"7\", \"b\", \"d\", \"e\"];\nfunction isMaxUpperNibble(index: number): boolean {\n\treturn maxUpperUuid.charAt(index) === \"f\";\n}\n\n/**\n * Any session uuid with all of its highish bits set is in danger of overflowing after fewer than 2^53 increments.\n * By zeroing one of those bits at random, potential overflow is prevented.\n */\nexport function ensureSessionUuid(uuid: StableId): SessionId {\n\tif (uuid.startsWith(maxUpperUuid)) {\n\t\tconst targetNibble = Math.floor(Math.random() * maxNibbleCount);\n\t\tlet actualIndex = 0;\n\t\tfor (\n\t\t\tlet nibbleIndex = 0;\n\t\t\tnibbleIndex < targetNibble && !isMaxUpperNibble(actualIndex);\n\t\t\tactualIndex += 1\n\t\t) {\n\t\t\tif (isMaxUpperNibble(actualIndex)) {\n\t\t\t\tnibbleIndex++;\n\t\t\t}\n\t\t}\n\n\t\tconst newNibble = newNibbles[Math.floor(Math.random() * newNibbles.length)]; // Randomly choose a bit to zero\n\t\tconst newUuid = uuid.slice(0, actualIndex) + newNibble + uuid.slice(actualIndex + 1);\n\t\treturn newUuid as SessionId;\n\t}\n\n\treturn uuid as SessionId;\n}\n"]}