@posthog/core 1.1.0 → 1.2.0

package/src/vendor/uuidv7.ts

@@ -0,0 +1,479 @@
+// vendor from: https://github.com/LiosK/uuidv7/blob/f30b7a7faff73afbce0b27a46c638310f96912ba/src/index.ts
+// https://github.com/LiosK/uuidv7#license
+
+/**
+ * uuidv7: An experimental implementation of the proposed UUID Version 7
+ *
+ * @license Apache-2.0
+ * @copyright 2021-2023 LiosK
+ * @packageDocumentation
+ */
+
+const DIGITS = "0123456789abcdef";
+
+/** Represents a UUID as a 16-byte byte array. */
+export class UUID {
+  /** @param bytes - The 16-byte byte array representation. */
+  private constructor(readonly bytes: Readonly<Uint8Array>) {}
+
+  /**
+   * Creates an object from the internal representation, a 16-byte byte array
+   * containing the binary UUID representation in the big-endian byte order.
+   *
+   * This method does NOT shallow-copy the argument, and thus the created object
+   * holds the reference to the underlying buffer.
+   *
+   * @throws TypeError if the length of the argument is not 16.
+   */
+  static ofInner(bytes: Readonly<Uint8Array>): UUID {
+    if (bytes.length !== 16) {
+      throw new TypeError("not 128-bit length");
+    } else {
+      return new UUID(bytes);
+    }
+  }
+
+  /**
+   * Builds a byte array from UUIDv7 field values.
+   *
+   * @param unixTsMs - A 48-bit `unix_ts_ms` field value.
+   * @param randA - A 12-bit `rand_a` field value.
+   * @param randBHi - The higher 30 bits of 62-bit `rand_b` field value.
+   * @param randBLo - The lower 32 bits of 62-bit `rand_b` field value.
+   * @throws RangeError if any field value is out of the specified range.
+   */
+  static fromFieldsV7(
+    unixTsMs: number,
+    randA: number,
+    randBHi: number,
+    randBLo: number,
+  ): UUID {
+    if (
+      !Number.isInteger(unixTsMs) ||
+      !Number.isInteger(randA) ||
+      !Number.isInteger(randBHi) ||
+      !Number.isInteger(randBLo) ||
+      unixTsMs < 0 ||
+      randA < 0 ||
+      randBHi < 0 ||
+      randBLo < 0 ||
+      unixTsMs > 0xffff_ffff_ffff ||
+      randA > 0xfff ||
+      randBHi > 0x3fff_ffff ||
+      randBLo > 0xffff_ffff
+    ) {
+      throw new RangeError("invalid field value");
+    }
+
+    const bytes = new Uint8Array(16);
+    bytes[0] = unixTsMs / 2 ** 40;
+    bytes[1] = unixTsMs / 2 ** 32;
+    bytes[2] = unixTsMs / 2 ** 24;
+    bytes[3] = unixTsMs / 2 ** 16;
+    bytes[4] = unixTsMs / 2 ** 8;
+    bytes[5] = unixTsMs;
+    bytes[6] = 0x70 | (randA >>> 8);
+    bytes[7] = randA;
+    bytes[8] = 0x80 | (randBHi >>> 24);
+    bytes[9] = randBHi >>> 16;
+    bytes[10] = randBHi >>> 8;
+    bytes[11] = randBHi;
+    bytes[12] = randBLo >>> 24;
+    bytes[13] = randBLo >>> 16;
+    bytes[14] = randBLo >>> 8;
+    bytes[15] = randBLo;
+    return new UUID(bytes);
+  }
+
+  /**
+   * Builds a byte array from a string representation.
+   *
+   * This method accepts the following formats:
+   *
+   * - 32-digit hexadecimal format without hyphens: `0189dcd553117d408db09496a2eef37b`
+   * - 8-4-4-4-12 hyphenated format: `0189dcd5-5311-7d40-8db0-9496a2eef37b`
+   * - Hyphenated format with surrounding braces: `{0189dcd5-5311-7d40-8db0-9496a2eef37b}`
+   * - RFC 4122 URN format: `urn:uuid:0189dcd5-5311-7d40-8db0-9496a2eef37b`
+   *
+   * Leading and trailing whitespaces represents an error.
+   *
+   * @throws SyntaxError if the argument could not parse as a valid UUID string.
+   */
+  static parse(uuid: string): UUID {
+    let hex: string | undefined = undefined;
+    switch (uuid.length) {
+      case 32:
+        hex = /^[0-9a-f]{32}$/i.exec(uuid)?.[0];
+        break;
+      case 36:
+        hex =
+          /^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{12})$/i
+            .exec(uuid)
+            ?.slice(1, 6)
+            .join("");
+        break;
+      case 38:
+        hex =
+          /^\{([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{12})\}$/i
+            .exec(uuid)
+            ?.slice(1, 6)
+            .join("");
+        break;
+      case 45:
+        hex =
+          /^urn:uuid:([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{12})$/i
+            .exec(uuid)
+            ?.slice(1, 6)
+            .join("");
+        break;
+      default:
+        break;
+    }
+
+    if (hex) {
+      const inner = new Uint8Array(16);
+      for (let i = 0; i < 16; i += 4) {
+        const n = parseInt(hex.substring(2 * i, 2 * i + 8), 16);
+        inner[i + 0] = n >>> 24;
+        inner[i + 1] = n >>> 16;
+        inner[i + 2] = n >>> 8;
+        inner[i + 3] = n;
+      }
+      return new UUID(inner);
+    } else {
+      throw new SyntaxError("could not parse UUID string");
+    }
+  }
+
+  /**
+   * @returns The 8-4-4-4-12 canonical hexadecimal string representation
+   * (`0189dcd5-5311-7d40-8db0-9496a2eef37b`).
+   */
+  toString(): string {
+    let text = "";
+    for (let i = 0; i < this.bytes.length; i++) {
+      text += DIGITS.charAt(this.bytes[i] >>> 4);
+      text += DIGITS.charAt(this.bytes[i] & 0xf);
+      if (i === 3 || i === 5 || i === 7 || i === 9) {
+        text += "-";
+      }
+    }
+    return text;
+  }
+
+  /**
+   * @returns The 32-digit hexadecimal representation without hyphens
+   * (`0189dcd553117d408db09496a2eef37b`).
+   */
+  toHex(): string {
+    let text = "";
+    for (let i = 0; i < this.bytes.length; i++) {
+      text += DIGITS.charAt(this.bytes[i] >>> 4);
+      text += DIGITS.charAt(this.bytes[i] & 0xf);
+    }
+    return text;
+  }
+
+  /** @returns The 8-4-4-4-12 canonical hexadecimal string representation. */
+  toJSON(): string {
+    return this.toString();
+  }
+
+  /**
+   * Reports the variant field value of the UUID or, if appropriate, "NIL" or
+   * "MAX".
+   *
+   * For convenience, this method reports "NIL" or "MAX" if `this` represents
+   * the Nil or Max UUID, although the Nil and Max UUIDs are technically
+   * subsumed under the variants `0b0` and `0b111`, respectively.
+   */
+  getVariant():
+    | "VAR_0"
+    | "VAR_10"
+    | "VAR_110"
+    | "VAR_RESERVED"
+    | "NIL"
+    | "MAX" {
+    const n = this.bytes[8] >>> 4;
+    if (n < 0) {
+      throw new Error("unreachable");
+    } else if (n <= 0b0111) {
+      return this.bytes.every((e) => e === 0) ? "NIL" : "VAR_0";
+    } else if (n <= 0b1011) {
+      return "VAR_10";
+    } else if (n <= 0b1101) {
+      return "VAR_110";
+    } else if (n <= 0b1111) {
+      return this.bytes.every((e) => e === 0xff) ? "MAX" : "VAR_RESERVED";
+    } else {
+      throw new Error("unreachable");
+    }
+  }
+
+  /**
+   * Returns the version field value of the UUID or `undefined` if the UUID does
+   * not have the variant field value of `0b10`.
+   */
+  getVersion(): number | undefined {
+    return this.getVariant() === "VAR_10" ? this.bytes[6] >>> 4 : undefined;
+  }
+
+  /** Creates an object from `this`. */
+  clone(): UUID {
+    return new UUID(this.bytes.slice(0));
+  }
+
+  /** Returns true if `this` is equivalent to `other`. */
+  equals(other: UUID): boolean {
+    return this.compareTo(other) === 0;
+  }
+
+  /**
+   * Returns a negative integer, zero, or positive integer if `this` is less
+   * than, equal to, or greater than `other`, respectively.
+   */
+  compareTo(other: UUID): number {
+    for (let i = 0; i < 16; i++) {
+      const diff = this.bytes[i] - other.bytes[i];
+      if (diff !== 0) {
+        return Math.sign(diff);
+      }
+    }
+    return 0;
+  }
+}
+
+/**
+ * Encapsulates the monotonic counter state.
+ *
+ * This class provides APIs to utilize a separate counter state from that of the
+ * global generator used by {@link uuidv7} and {@link uuidv7obj}. In addition to
+ * the default {@link generate} method, this class has {@link generateOrAbort}
+ * that is useful to absolutely guarantee the monotonically increasing order of
+ * generated UUIDs. See their respective documentation for details.
+ */
+export class V7Generator {
+  private timestamp = 0;
+  private counter = 0;
+
+  /** The random number generator used by the generator. */
+  private readonly random: { nextUint32(): number };
+
+  /**
+   * Creates a generator object with the default random number generator, or
+   * with the specified one if passed as an argument. The specified random
+   * number generator should be cryptographically strong and securely seeded.
+   */
+  constructor(randomNumberGenerator?: {
+    /** Returns a 32-bit random unsigned integer. */
+    nextUint32(): number;
+  }) {
+    this.random = randomNumberGenerator ?? getDefaultRandom();
+  }
+
+  /**
+   * Generates a new UUIDv7 object from the current timestamp, or resets the
+   * generator upon significant timestamp rollback.
+   *
+   * This method returns a monotonically increasing UUID by reusing the previous
+   * timestamp even if the up-to-date timestamp is smaller than the immediately
+   * preceding UUID's. However, when such a clock rollback is considered
+   * significant (i.e., by more than ten seconds), this method resets the
+   * generator and returns a new UUID based on the given timestamp, breaking the
+   * increasing order of UUIDs.
+   *
+   * See {@link generateOrAbort} for the other mode of generation and
+   * {@link generateOrResetCore} for the low-level primitive.
+   */
+  generate(): UUID {
+    return this.generateOrResetCore(Date.now(), 10_000);
+  }
+
+  /**
+   * Generates a new UUIDv7 object from the current timestamp, or returns
+   * `undefined` upon significant timestamp rollback.
+   *
+   * This method returns a monotonically increasing UUID by reusing the previous
+   * timestamp even if the up-to-date timestamp is smaller than the immediately
+   * preceding UUID's. However, when such a clock rollback is considered
+   * significant (i.e., by more than ten seconds), this method aborts and
+   * returns `undefined` immediately.
+   *
+   * See {@link generate} for the other mode of generation and
+   * {@link generateOrAbortCore} for the low-level primitive.
+   */
+  generateOrAbort(): UUID | undefined {
+    return this.generateOrAbortCore(Date.now(), 10_000);
+  }
+
+  /**
+   * Generates a new UUIDv7 object from the `unixTsMs` passed, or resets the
+   * generator upon significant timestamp rollback.
+   *
+   * This method is equivalent to {@link generate} except that it takes a custom
+   * timestamp and clock rollback allowance.
+   *
+   * @param rollbackAllowance - The amount of `unixTsMs` rollback that is
+   * considered significant. A suggested value is `10_000` (milliseconds).
+   * @throws RangeError if `unixTsMs` is not a 48-bit positive integer.
+   */
+  generateOrResetCore(unixTsMs: number, rollbackAllowance: number): UUID {
+    let value = this.generateOrAbortCore(unixTsMs, rollbackAllowance);
+    if (value === undefined) {
+      // reset state and resume
+      this.timestamp = 0;
+      value = this.generateOrAbortCore(unixTsMs, rollbackAllowance)!;
+    }
+    return value;
+  }
+
+  /**
+   * Generates a new UUIDv7 object from the `unixTsMs` passed, or returns
+   * `undefined` upon significant timestamp rollback.
+   *
+   * This method is equivalent to {@link generateOrAbort} except that it takes a
+   * custom timestamp and clock rollback allowance.
+   *
+   * @param rollbackAllowance - The amount of `unixTsMs` rollback that is
+   * considered significant. A suggested value is `10_000` (milliseconds).
+   * @throws RangeError if `unixTsMs` is not a 48-bit positive integer.
+   */
+  generateOrAbortCore(
+    unixTsMs: number,
+    rollbackAllowance: number,
+  ): UUID | undefined {
+    const MAX_COUNTER = 0x3ff_ffff_ffff;
+
+    if (
+      !Number.isInteger(unixTsMs) ||
+      unixTsMs < 1 ||
+      unixTsMs > 0xffff_ffff_ffff
+    ) {
+      throw new RangeError("`unixTsMs` must be a 48-bit positive integer");
+    } else if (rollbackAllowance < 0 || rollbackAllowance > 0xffff_ffff_ffff) {
+      throw new RangeError("`rollbackAllowance` out of reasonable range");
+    }
+
+    if (unixTsMs > this.timestamp) {
+      this.timestamp = unixTsMs;
+      this.resetCounter();
+    } else if (unixTsMs + rollbackAllowance >= this.timestamp) {
+      // go on with previous timestamp if new one is not much smaller
+      this.counter++;
+      if (this.counter > MAX_COUNTER) {
+        // increment timestamp at counter overflow
+        this.timestamp++;
+        this.resetCounter();
+      }
+    } else {
+      // abort if clock went backwards to unbearable extent
+      return undefined;
+    }
+
+    return UUID.fromFieldsV7(
+      this.timestamp,
+      Math.trunc(this.counter / 2 ** 30),
+      this.counter & (2 ** 30 - 1),
+      this.random.nextUint32(),
+    );
+  }
+
+  /** Initializes the counter at a 42-bit random integer. */
+  private resetCounter(): void {
+    this.counter =
+      this.random.nextUint32() * 0x400 + (this.random.nextUint32() & 0x3ff);
+  }
+
+  /**
+   * Generates a new UUIDv4 object utilizing the random number generator inside.
+   *
+   * @internal
+   */
+  generateV4(): UUID {
+    const bytes = new Uint8Array(
+      Uint32Array.of(
+        this.random.nextUint32(),
+        this.random.nextUint32(),
+        this.random.nextUint32(),
+        this.random.nextUint32(),
+      ).buffer,
+    );
+    bytes[6] = 0x40 | (bytes[6] >>> 4);
+    bytes[8] = 0x80 | (bytes[8] >>> 2);
+    return UUID.ofInner(bytes);
+  }
+}
+
+/** A global flag to force use of cryptographically strong RNG. */
+// declare const UUIDV7_DENY_WEAK_RNG: boolean;
+
+/** Returns the default random number generator available in the environment. */
+const getDefaultRandom = (): { nextUint32(): number } => {
+// fix: crypto isn't available in react-native, always use Math.random
+
+//   // detect Web Crypto API
+//   if (
+//     typeof crypto !== "undefined" &&
+//     typeof crypto.getRandomValues !== "undefined"
+//   ) {
+//     return new BufferedCryptoRandom();
+//   } else {
+//     // fall back on Math.random() unless the flag is set to true
+//     if (typeof UUIDV7_DENY_WEAK_RNG !== "undefined" && UUIDV7_DENY_WEAK_RNG) {
+//       throw new Error("no cryptographically strong RNG available");
+//     }
+//     return {
+//       nextUint32: (): number =>
+//         Math.trunc(Math.random() * 0x1_0000) * 0x1_0000 +
+//         Math.trunc(Math.random() * 0x1_0000),
+//     };
+//   }
+  return {
+    nextUint32: (): number =>
+      Math.trunc(Math.random() * 0x1_0000) * 0x1_0000 +
+      Math.trunc(Math.random() * 0x1_0000),
+  };
+};
+
+// /**
+//  * Wraps `crypto.getRandomValues()` to enable buffering; this uses a small
+//  * buffer by default to avoid both unbearable throughput decline in some
+//  * environments and the waste of time and space for unused values.
+//  */
+// class BufferedCryptoRandom {
+//   private readonly buffer = new Uint32Array(8);
+//   private cursor = 0xffff;
+//   nextUint32(): number {
+//     if (this.cursor >= this.buffer.length) {
+//       crypto.getRandomValues(this.buffer);
+//       this.cursor = 0;
+//     }
+//     return this.buffer[this.cursor++];
+//   }
+// }
+
+let defaultGenerator: V7Generator | undefined;
+
+/**
+ * Generates a UUIDv7 string.
+ *
+ * @returns The 8-4-4-4-12 canonical hexadecimal string representation
+ * ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").
+ */
+export const uuidv7 = (): string => uuidv7obj().toString();
+
+/** Generates a UUIDv7 object. */
+export const uuidv7obj = (): UUID =>
+  (defaultGenerator || (defaultGenerator = new V7Generator())).generate();
+
+/**
+ * Generates a UUIDv4 string.
+ *
+ * @returns The 8-4-4-4-12 canonical hexadecimal string representation
+ * ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").
+ */
+export const uuidv4 = (): string => uuidv4obj().toString();
+
+/** Generates a UUIDv4 object. */
+export const uuidv4obj = (): UUID =>
+  (defaultGenerator || (defaultGenerator = new V7Generator())).generateV4();