@fluid-experimental/tree 0.59.2001 → 0.59.3000

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

@@ -17,30 +17,22 @@ export declare type NumericUuid = readonly [string, number] & {
 };
 /**
  * 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.
+ * @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
+ * @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
+ * @param stableId - a minimal uuid string
  * @returns a numeric representation of `stableId`.
  */
 export declare function numericUuidFromStableId(stableId: StableId): NumericUuid;
-/**
- * Asserts that the supplied uuid is a stable ID.
- */
-export declare function assertIsStableId(uuid: string): StableId;
-/**
- * Returns whether the supplied string is a v4 variant 2 uuid.
- */
-export declare function isStableId(str: string): str is StableId;
 /**
  * Creates a session base ID.
  * This method (rather than standard uuid generation methods) should be used to generate session IDs.
@@ -52,7 +44,7 @@ export declare function createSessionId(): SessionId;
 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`.`
+ * @returns the result of incrementing the uuid by `amount`.
  */
 export declare function incrementUuid(uuid: NumericUuid, amount: number): NumericUuid;
 /**

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

@@ -1 +1 @@
-{"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,gBAAgB,CAAC;AAErD;;;;;;;;GAQG;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,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgDrG;AAaD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,SAAI,GAAG,QAAQ,CAQ/E;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAKvE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAGvD;AASD;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,IAAI,QAAQ,CAgDvD;AAED;;;GAGG;AACH,wBAAgB,eAAe,IAAI,SAAS,CAG3C;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,CA+C5E;AAiID;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAgB3D"}
+{"version":3,"file":"NumericUuid.d.ts","sourceRoot":"","sources":["../../src/id-compressor/NumericUuid.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAGrD;;;;;;;;GAQG;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,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgDrG;AAaD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,SAAI,GAAG,QAAQ,CAQ/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,CA+C5E;AAiID;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAgB3D"}

package/dist/id-compressor/NumericUuid.js

@@ -4,10 +4,10 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureSessionUuid = exports.incrementUuid = exports.numericUuidEquals = exports.createSessionId = exports.isStableId = exports.assertIsStableId = exports.numericUuidFromStableId = exports.stableIdFromNumericUuid = exports.getPositiveDelta = void 0;
+exports.ensureSessionUuid = exports.incrementUuid = exports.numericUuidEquals = exports.createSessionId = exports.numericUuidFromStableId = exports.stableIdFromNumericUuid = exports.getPositiveDelta = void 0;
 /* eslint-disable no-bitwise */
-const uuid_1 = require("uuid");
 const Common_1 = require("../Common");
+const UuidUtilities_1 = require("../UuidUtilities");
 const bitsInNumericUuidInteger = 52; // Not tunable. Do not change.
 const nibblesInNumericUuidInteger = bitsInNumericUuidInteger / 4;
 const stringEntryLength = 22;
@@ -15,9 +15,9 @@ 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.
+ * @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) {
@@ -73,7 +73,7 @@ function padToLengthWithZeros(str, count) {
     return str.length === count ? str : zeros[count - str.length] + str;
 }
 /**
- * @param offset an optional offset to increment the returned StableId
+ * @param offset - an optional offset to increment the returned StableId
  * @returns the string representation of a `NumericUuid`.
  */
 function stableIdFromNumericUuid(uuid, offset = 0) {
@@ -87,7 +87,7 @@ function stableIdFromNumericUuid(uuid, offset = 0) {
 }
 exports.stableIdFromNumericUuid = stableIdFromNumericUuid;
 /**
- * @param stableId a minimal uuid string
+ * @param stableId - a minimal uuid string
  * @returns a numeric representation of `stableId`.
  */
 function numericUuidFromStableId(stableId) {
@@ -97,73 +97,12 @@ function numericUuidFromStableId(stableId) {
     return uuid;
 }
 exports.numericUuidFromStableId = numericUuidFromStableId;
-/**
- * Asserts that the supplied uuid is a stable ID.
- */
-function assertIsStableId(uuid) {
-    Common_1.assert(isStableId(uuid), `${uuid} is not a StableId.`);
-    return uuid;
-}
-exports.assertIsStableId = assertIsStableId;
-const charCode0 = '0'.charCodeAt(0);
-const charCode9 = '9'.charCodeAt(0);
-const charCodea = 'a'.charCodeAt(0);
-const charCodef = 'f'.charCodeAt(0);
-const charCodeA = 'A'.charCodeAt(0);
-const charCodeF = 'F'.charCodeAt(0);
-/**
- * Returns whether the supplied string is a v4 variant 2 uuid.
- */
-function isStableId(str) {
-    if (str.length !== 36) {
-        return false;
-    }
-    for (let i = 0; i < str.length; i++) {
-        switch (i) {
-            case 8:
-            case 13:
-            case 18:
-            case 23: {
-                if (str.charAt(i) !== '-') {
-                    return false;
-                }
-                break;
-            }
-            case 14: {
-                if (str.charAt(i) !== '4') {
-                    return false;
-                }
-                break;
-            }
-            case 19: {
-                const c = str.charAt(i);
-                if (c !== '8' && c !== '9' && c !== 'a' && c !== 'b') {
-                    return false;
-                }
-                break;
-            }
-            default: {
-                const code = str.charCodeAt(i);
-                const isUuidChar = (code >= charCode0 && code <= charCode9) ||
-                    (code >= charCodea && code <= charCodef) ||
-                    (code >= charCodeA && code <= charCodeF);
-                if (!isUuidChar) {
-                    return false;
-                }
-                break;
-            }
-        }
-    }
-    return true;
-}
-exports.isStableId = isStableId;
 /**
  * Creates a session base ID.
  * This method (rather than standard uuid generation methods) should be used to generate session IDs.
  */
 function createSessionId() {
-    const uuid = assertIsStableId(uuid_1.v4());
-    return ensureSessionUuid(uuid);
+    return ensureSessionUuid((0, UuidUtilities_1.generateStableId)());
 }
 exports.createSessionId = createSessionId;
 /**
@@ -180,7 +119,7 @@ exports.numericUuidEquals = numericUuidEquals;
 const maxUpperNumber = 2 ** 48 - 1;
 /**
  * Increments the uuid. `amount` must be a positive integer.
- * @returns the result of incrementing the uuid by `amount`.`
+ * @returns the result of incrementing the uuid by `amount`.
  */
 function incrementUuid(uuid, amount) {
     /*
@@ -205,10 +144,10 @@ function incrementUuid(uuid, amount) {
             // 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);
-            Common_1.assert(upperNumber <= maxUpperNumber);
+            (0, Common_1.assert)(upperNumber <= maxUpperNumber);
             const newUpperNumber = upperNumber + 1;
             if (newUpperNumber > maxUpperNumber) {
-                Common_1.fail('Exceeded maximum numeric UUID');
+                (0, Common_1.fail)('Exceeded maximum numeric UUID');
             }
             else {
                 // The variant chunk overflowed but the upper string region did not. Splice in the incremented string region.
@@ -301,9 +240,9 @@ var ChunkMath;
         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 variantChunkBits
+     * 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);
@@ -335,7 +274,7 @@ var ChunkMath;
         // 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);
-        Common_1.assert(variantNumber <= maxVariantNumber);
+        (0, Common_1.assert)(variantNumber <= maxVariantNumber);
         // 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

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

@@ -1 +1 @@
-{"version":3,"file":"NumericUuid.js","sourceRoot":"","sources":["../../src/id-compressor/NumericUuid.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAA+B;AAE/B,+BAA0B;AAC1B,sCAAyC;AAgBzC,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,CAAC,CAAc,EAAE,CAAc,EAAE,QAAgB;IAChF,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;AAhDD,4CAgDC;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,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,2BAA2B,CAAC,CAAC;QAC7F,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;AARD,0DAQC;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;;GAEG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC5C,eAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,qBAAqB,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC;AACb,CAAC;AAHD,4CAGC;AAED,MAAM,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACpC,MAAM,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACpC,MAAM,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACpC,MAAM,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACpC,MAAM,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACpC,MAAM,SAAS,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AAEpC;;GAEG;AACH,SAAgB,UAAU,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,EAAE;QACtB,OAAO,KAAK,CAAC;KACb;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACpC,QAAQ,CAAC,EAAE;YACV,KAAK,CAAC,CAAC;YACP,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC,CAAC;gBACR,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;oBAC1B,OAAO,KAAK,CAAC;iBACb;gBACD,MAAM;aACN;YAED,KAAK,EAAE,CAAC,CAAC;gBACR,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;oBAC1B,OAAO,KAAK,CAAC;iBACb;gBACD,MAAM;aACN;YAED,KAAK,EAAE,CAAC,CAAC;gBACR,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE;oBACrD,OAAO,KAAK,CAAC;iBACb;gBACD,MAAM;aACN;YAED,OAAO,CAAC,CAAC;gBACR,MAAM,IAAI,GAAG,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAC/B,MAAM,UAAU,GACf,CAAC,IAAI,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC;oBACxC,CAAC,IAAI,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC;oBACxC,CAAC,IAAI,IAAI,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC,CAAC;gBAE1C,IAAI,CAAC,UAAU,EAAE;oBAChB,OAAO,KAAK,CAAC;iBACb;gBACD,MAAM;aACN;SACD;KACD;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAhDD,gCAgDC;AAED;;;GAGG;AACH,SAAgB,eAAe;IAC9B,MAAM,IAAI,GAAG,gBAAgB,CAAC,SAAE,EAAE,CAAC,CAAC;IACpC,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC;AAHD,0CAGC;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,eAAM,CAAC,WAAW,IAAI,cAAc,CAAC,CAAC;YACtC,MAAM,cAAc,GAAG,WAAW,GAAG,CAAC,CAAC;YACvC,IAAI,cAAc,GAAG,cAAc,EAAE;gBACpC,aAAI,CAAC,+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,CAAC,qBAAqB,CAAC,EAAE;gBAC9F,SAAS;aACT,CAAC;SACF;KACD;IAED,OAAO,OAAmD,CAAC;AAC5D,CAAC;AA/CD,sCA+CC;AAED,IAAU,SAAS,CAsHlB;AAtHD,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,+EAA+E;IAC/E,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,iFAAiF;IACjF,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,+EAA+E;IAC/E,IAAiB,KAAK,CAQrB;IARD,WAAiB,KAAK;QACrB,SAAgB,KAAK,CAAC,QAAkB;YACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;QACzG,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;IACF,CAAC,EARgB,KAAK,GAAL,eAAK,KAAL,eAAK,QAQrB;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,eAAM,CAAC,aAAa,IAAI,gBAAgB,CAAC,CAAC;QAC1C,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,GAAG,mBAAmB,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;QAC7F,MAAM,eAAe,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACpG,OAAO,CAAC,eAAe,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IA7Be,mBAAS,YA6BxB,CAAA;AACF,CAAC,EAtHS,SAAS,KAAT,SAAS,QAsHlB;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,KAAK,IAAI,WAAW,GAAG,CAAC,EAAE,WAAW,GAAG,YAAY,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,WAAW,IAAI,CAAC,EAAE;YACzG,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;AAhBD,8CAgBC","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\nimport { v4 } from 'uuid';\nimport { assert, fail } from '../Common';\nimport { SessionId, StableId } from '../Identifiers';\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 * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid\n * SSSSSSSS-SSSS-SSSS-SSS               - array[0]: string\n *                       N NNNNNNNNNNNN - array[1]: integer\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(a: NumericUuid, b: NumericUuid, maxDelta: number): 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(lowerAdd.toString(16), nibblesInNumericUuidInteger);\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 * Asserts that the supplied uuid is a stable ID.\n */\nexport function assertIsStableId(uuid: string): StableId {\n\tassert(isStableId(uuid), `${uuid} is not a StableId.`);\n\treturn uuid;\n}\n\nconst charCode0 = '0'.charCodeAt(0);\nconst charCode9 = '9'.charCodeAt(0);\nconst charCodea = 'a'.charCodeAt(0);\nconst charCodef = 'f'.charCodeAt(0);\nconst charCodeA = 'A'.charCodeAt(0);\nconst charCodeF = 'F'.charCodeAt(0);\n\n/**\n * Returns whether the supplied string is a v4 variant 2 uuid.\n */\nexport function isStableId(str: string): str is StableId {\n\tif (str.length !== 36) {\n\t\treturn false;\n\t}\n\n\tfor (let i = 0; i < str.length; i++) {\n\t\tswitch (i) {\n\t\t\tcase 8:\n\t\t\tcase 13:\n\t\t\tcase 18:\n\t\t\tcase 23: {\n\t\t\t\tif (str.charAt(i) !== '-') {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase 14: {\n\t\t\t\tif (str.charAt(i) !== '4') {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tcase 19: {\n\t\t\t\tconst c = str.charAt(i);\n\t\t\t\tif (c !== '8' && c !== '9' && c !== 'a' && c !== 'b') {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\n\t\t\tdefault: {\n\t\t\t\tconst code = str.charCodeAt(i);\n\t\t\t\tconst isUuidChar =\n\t\t\t\t\t(code >= charCode0 && code <= charCode9) ||\n\t\t\t\t\t(code >= charCodea && code <= charCodef) ||\n\t\t\t\t\t(code >= charCodeA && code <= charCodeF);\n\n\t\t\t\tif (!isUuidChar) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn true;\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\tconst uuid = assertIsStableId(v4());\n\treturn ensureSessionUuid(uuid);\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(upperNumber <= maxUpperNumber);\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(newVariantChunkString)}`,\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/** the upper chunk, denoted by 'U's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL */\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/** the variant chunk, denoted by 'V's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL */\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/** the lower chunk, denoted by 'L's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL */\n\texport namespace Lower {\n\t\texport function parse(stableId: StableId): string {\n\t\t\treturn stableId.slice(stringEntryLength, stringEntryLength + 1) + stableId.slice(stringEntryLength + 2);\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 parsing all bits\n\t * except for reserved bits (i.e. the variant bits).\n\t * @param variantChunkBits\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(variantNumber <= maxVariantNumber);\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 = newUpperVariantBits + newMiddleVariantBits + newLowerVariantBits;\n\t\tconst newVariantChunk = padToLengthWithZeros(newVariantChunkBits.toString(16), variantChunk.length);\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 (let nibbleIndex = 0; nibbleIndex < targetNibble && !isMaxUpperNibble(actualIndex); actualIndex += 1) {\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"]}
+{"version":3,"file":"NumericUuid.js","sourceRoot":"","sources":["../../src/id-compressor/NumericUuid.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAA+B;AAE/B,sCAAyC;AAEzC,oDAAoD;AAepD,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,CAAC,CAAc,EAAE,CAAc,EAAE,QAAgB;IAChF,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;AAhDD,4CAgDC;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,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,2BAA2B,CAAC,CAAC;QAC7F,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;AARD,0DAQC;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,eAAM,EAAC,WAAW,IAAI,cAAc,CAAC,CAAC;YACtC,MAAM,cAAc,GAAG,WAAW,GAAG,CAAC,CAAC;YACvC,IAAI,cAAc,GAAG,cAAc,EAAE;gBACpC,IAAA,aAAI,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,CAAC,qBAAqB,CAAC,EAAE;gBAC9F,SAAS;aACT,CAAC;SACF;KACD;IAED,OAAO,OAAmD,CAAC;AAC5D,CAAC;AA/CD,sCA+CC;AAED,IAAU,SAAS,CAsHlB;AAtHD,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,+EAA+E;IAC/E,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,iFAAiF;IACjF,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,+EAA+E;IAC/E,IAAiB,KAAK,CAQrB;IARD,WAAiB,KAAK;QACrB,SAAgB,KAAK,CAAC,QAAkB;YACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,iBAAiB,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;QACzG,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;IACF,CAAC,EARgB,KAAK,GAAL,eAAK,KAAL,eAAK,QAQrB;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,eAAM,EAAC,aAAa,IAAI,gBAAgB,CAAC,CAAC;QAC1C,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,GAAG,mBAAmB,GAAG,oBAAoB,GAAG,mBAAmB,CAAC;QAC7F,MAAM,eAAe,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACpG,OAAO,CAAC,eAAe,EAAE,gBAAgB,GAAG,gBAAgB,CAAC,CAAC;IAC/D,CAAC;IA7Be,mBAAS,YA6BxB,CAAA;AACF,CAAC,EAtHS,SAAS,KAAT,SAAS,QAsHlB;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,KAAK,IAAI,WAAW,GAAG,CAAC,EAAE,WAAW,GAAG,YAAY,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,WAAW,IAAI,CAAC,EAAE;YACzG,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;AAhBD,8CAgBC","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\nimport { assert, fail } from '../Common';\nimport { SessionId, StableId } from '../Identifiers';\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 * UUUUUUUU-UUUU-VUUU-vUUU-UUUUUUUUUUUU - the uuid\n * SSSSSSSS-SSSS-SSSS-SSS               - array[0]: string\n *                       N NNNNNNNNNNNN - array[1]: integer\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(a: NumericUuid, b: NumericUuid, maxDelta: number): 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(lowerAdd.toString(16), nibblesInNumericUuidInteger);\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(upperNumber <= maxUpperNumber);\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(newVariantChunkString)}`,\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/** the upper chunk, denoted by 'U's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL */\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/** the variant chunk, denoted by 'V's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL */\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/** the lower chunk, denoted by 'L's in UUUUUUUU-UUUU-VVVV-vVVL-LLLLLLLLLLLL */\n\texport namespace Lower {\n\t\texport function parse(stableId: StableId): string {\n\t\t\treturn stableId.slice(stringEntryLength, stringEntryLength + 1) + stableId.slice(stringEntryLength + 2);\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(variantNumber <= maxVariantNumber);\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 = newUpperVariantBits + newMiddleVariantBits + newLowerVariantBits;\n\t\tconst newVariantChunk = padToLengthWithZeros(newVariantChunkBits.toString(16), variantChunk.length);\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 (let nibbleIndex = 0; nibbleIndex < targetNibble && !isMaxUpperNibble(actualIndex); actualIndex += 1) {\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"]}

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

@@ -0,0 +1,122 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FinalCompressedId, LocalCompressedId, SessionSpaceCompressedId } from '../Identifiers';
+/**
+ * Maps IDs created by a session between their local and final forms (i.e. normalization). These IDs are in a contiguous range.
+ * The local and final forms of IDs made by a session can be thought of as two equal-length sparse arrays, aligned such
+ * that normalizeLocalToFinal(locals[i]) === finals[i] and vice versa.
+ * Below is an example to illustrate how various mappings can arise:
+ *
+ *     +- Creation Index
+ *    /     +- Locals
+ *   /     /    +- Finals
+ *  /     /    /
+ * ---+-----+----
+ * 0  | -1  | 0   -|___ Two IDs are allocated as locals since no cluster exists. A new cluster is created when acked.
+ * 1  | -2  | 1   -|
+ * 2  |     | 2   -|
+ * 3  |     | 3   --|-- Three more IDs are allocated as finals eagerly since a cluster exists with available capacity.
+ * 4  |     | 4   -|
+ * 5  | -6  | 10  ----- One ID is allocated as a local (it overflows the existing cluster) and a new cluster is created after ack.
+ * 6  |     | 11  ----- One ID is allocated as a final eagerly into the existing cluster.
+ * 7  | -8  | 12  ----- A local ID with an override is allocated. The override forces it to be a local ID.
+ * 8  |     | 13
+ * 9  |     | 14
+ * 10 | -11 |     ----- A local ID is allocated. It has no corresponding final ID since it has not been acked.
+ *
+ * Note that in this example, some IDs (those at indices 2, 3, 4, 6, 8, and 9) have no local form. The ID at index 10 has no final form.
+ * These kinds of "gaps" occur due to the timing of allocation calls on the client and how they relate to finalization/cluster creation,
+ * which depends on receiving an ack/sequence number from the server. Given this context, "session space" can be thought of as:
+ *
+ * 		for each index in the range of IDs created by a session:
+ * 			the local form if it exists, otherwise the final form
+ *
+ * This class is designed to efficiently build and query these mappings by leveraging the facts that much of the range (in both local and
+ * final space) is uninterrupted by "gaps" and can be compactly represented by a (first, last) pair and is easily binary searched for
+ * normalization between local and final space.
+ */
+export declare class SessionIdNormalizer<TRangeObject> {
+    private readonly expensiveAsserts;
+    private nextLocalId;
+    private readonly idRanges;
+    constructor(expensiveAsserts?: boolean);
+    /**
+     * Converts the final ID to its session-space representation.
+     * This will be the corresponding local if a local form exists, and `finalId` otherwise.
+     */
+    getSessionSpaceId(finalId: FinalCompressedId): SessionSpaceCompressedId | undefined;
+    /**
+     * Converts the local ID to its corresponding final ID, if one exists.
+     */
+    getFinalId(localId: LocalCompressedId): [FinalCompressedId, TRangeObject] | undefined;
+    /**
+     * Returns the index of the supplied session-space ID in the total range of IDs created by the session, if the ID was created
+     * by the session for this `SessionIdNormalizer`.
+     */
+    getCreationIndex(finalId: FinalCompressedId): number | undefined;
+    /**
+     * Returns the session-space ID at the supplied creation index, if one exists.
+     */
+    getIdByCreationIndex(index: number): SessionSpaceCompressedId | undefined;
+    private static makeFinalRangesMap;
+    /**
+     * Returns the last final ID known to this normalizer.
+     */
+    getLastFinalId(): FinalCompressedId | undefined;
+    /**
+     * Registers and returns the next ID in local space with this normalizer. An example:
+     *
+     * Locals: [-1, -2,  X,  X]
+     * Finals: [ 0,  1,  2,  3]
+     * In this scenario, a call to this method would generate and return -5.
+     */
+    addLocalId(): LocalCompressedId;
+    /**
+     * Registers a final ID with this normalizer.
+     * If there are any local IDs at the tip of session-space that do not have a corresponding final, it will be registered (aligned) with
+     * the first of those. Otherwise, will be registered as the next ID in session space in creation order. An example:
+     *
+     * Locals: [-1, -2,  X,  -4]
+     * Finals: [ 0,  1,  2,   X]
+     * Calling `addFinalIds` with first === last === 5 results in the following:
+     * Locals: [-1, -2,  X,  -4]
+     * Finals: [ 0,  1,  2,   5]
+     * Calling `addFinalIds` with first === last === 6 results in the following:
+     * Locals: [-1, -2,  X,  -4,  X]
+     * Finals: [ 0,  1,  2,   5,  6]
+     *
+     * Non-contiguous final IDs (i.e. the first final after a "gap" in final space) must always correspond to a local ID. For example,
+     * in the final call to `addFinalIds` above would fail if first === last === 9, because the resulting state would have a
+     * non-contiguous final ID without a local form:
+     * Locals: [-1, -2,  X,  -4,  X]
+     * Finals: [ 0,  1,  2,   5,  9]
+     *                            ^final ID 9 is not contiguous and does not have a corresponding local ID
+     */
+    addFinalIds(firstFinal: FinalCompressedId, lastFinal: FinalCompressedId, rangeObject: TRangeObject): void;
+    /**
+     * Returns an enumerable of all session-space IDs known to this normalizer, in creation order.
+     */
+    [Symbol.iterator](): IterableIterator<SessionSpaceCompressedId>;
+    serialize(): SerializedSessionIdNormalizer;
+    static deserialize<TRangeObject>(serialized: SerializedSessionIdNormalizer, getRangeObject: (finalId: FinalCompressedId) => TRangeObject): SessionIdNormalizer<TRangeObject>;
+    equals(other: SessionIdNormalizer<TRangeObject>, compareRangeObjects?: (a: TRangeObject, b: TRangeObject) => boolean): boolean;
+}
+/**
+ * Serialized table for normalizing IDs made by the local session.
+ *
+ * TODO: Move this into ID compressor persisted types when integrated.
+ */
+export interface SerializedSessionIdNormalizer {
+    readonly localRanges: readonly (readonly [
+        firstLocal: LocalCompressedId,
+        lastLocal: LocalCompressedId,
+        finalRanges?: readonly (readonly [
+            alignedLocal: LocalCompressedId,
+            firstFinal: FinalCompressedId,
+            lastFinal: FinalCompressedId
+        ])[]
+    ])[];
+}
+//# sourceMappingURL=SessionIdNormalizer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SessionIdNormalizer.d.ts","sourceRoot":"","sources":["../../src/id-compressor/SessionIdNormalizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAGhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,qBAAa,mBAAmB,CAAC,YAAY;IAkBzB,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAjBpD,OAAO,CAAC,WAAW,CAA8C;IACjE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAcvB;gBAEkC,gBAAgB,UAAQ;IAE5D;;;OAGG;IACI,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,GAAG,wBAAwB,GAAG,SAAS;IAqB1F;;OAEG;IACI,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,CAAC,iBAAiB,EAAE,YAAY,CAAC,GAAG,SAAS;IAoB5F;;;OAGG;IACI,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM,GAAG,SAAS;IAgBvE;;OAEG;IACI,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS;IAwBhF,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAQjC;;OAEG;IACI,cAAc,IAAI,iBAAiB,GAAG,SAAS;IAetD;;;;;;OAMG;IACI,UAAU,IAAI,iBAAiB;IA6BtC;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,WAAW,CAAC,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,iBAAiB,EAAE,WAAW,EAAE,YAAY,GAAG,IAAI;IAkDhH;;OAEG;IACK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,wBAAwB,CAAC;IAwBhE,SAAS,IAAI,6BAA6B;WAkBnC,WAAW,CAAC,YAAY,EACrC,UAAU,EAAE,6BAA6B,EACzC,cAAc,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,YAAY,GAC1D,mBAAmB,CAAC,YAAY,CAAC;IAsB7B,MAAM,CACZ,KAAK,EAAE,mBAAmB,CAAC,YAAY,CAAC,EACxC,mBAAmB,GAAE,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,YAAY,KAAK,OAA2B,GACpF,OAAO;CA4BV;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,SAAS;QACxC,UAAU,EAAE,iBAAiB;QAC7B,SAAS,EAAE,iBAAiB;QAC5B,WAAW,CAAC,EAAE,SAAS,CAAC,SAAS;YAChC,YAAY,EAAE,iBAAiB;YAC/B,UAAU,EAAE,iBAAiB;YAC7B,SAAS,EAAE,iBAAiB;SAC5B,CAAC,EAAE;KACJ,CAAC,EAAE,CAAC;CACL"}