@dxos/keys 0.8.4-main.fd6878d → 0.8.4-main.fdfb99ef29

package/dist/lib/node-esm/index.mjs

@@ -82,18 +82,20 @@ var require_base32_decode = __commonJS({
 });
 
 // src/dxn.ts
-import { Schema as Schema3 } from "effect";
+import * as Schema3 from "effect/Schema";
 import { devtoolsFormatter, inspectCustom } from "@dxos/debug";
 import { assertArgument, invariant as invariant2 } from "@dxos/invariant";
 
 // src/object-id.ts
-import { Schema } from "effect";
-import { ulid } from "ulidx";
+import * as Schema from "effect/Schema";
+import { monotonicFactory } from "ulidx";
 var ObjectIdSchema = Schema.String.pipe(Schema.pattern(/^[0-7][0-9A-HJKMNP-TV-Z]{25}$/i)).annotations({
   description: "A Universally Unique Lexicographically Sortable Identifier",
   pattern: "^[0-7][0-9A-HJKMNP-TV-Z]{25}$"
 });
 var ObjectId = class extends ObjectIdSchema {
+  static #factory = monotonicFactory();
+  static #seedTime = void 0;
   static isValid(id) {
     try {
       Schema.decodeSync(ObjectId)(id);
@@ -103,7 +105,46 @@ var ObjectId = class extends ObjectIdSchema {
     }
   }
   static random() {
-    return ulid();
+    return this.#factory(this.#seedTime);
+  }
+  static dangerouslyDisableRandomness() {
+    this.#factory = monotonicFactory(makeTestPRNG());
+    this.#seedTime = (/* @__PURE__ */ new Date("2025-01-01")).getTime();
+  }
+};
+var makeTestPRNG = () => {
+  const rng = new SimplePRNG();
+  return () => {
+    return rng.next();
+  };
+};
+var SimplePRNG = class _SimplePRNG {
+  #seed;
+  // LCG parameters (from Numerical Recipes)
+  static #a = 1664525;
+  static #c = 1013904223;
+  static #m = Math.pow(2, 32);
+  /**
+  * Creates a new PRNG instance.
+  * @param seed - Initial seed value. If not provided, uses 0.
+  */
+  constructor(seed = 0) {
+    this.#seed = seed;
+  }
+  /**
+  * Generates the next pseudo-random number in the range [0, 1).
+  * @returns A pseudo-random number between 0 (inclusive) and 1 (exclusive).
+  */
+  next() {
+    this.#seed = (_SimplePRNG.#a * this.#seed + _SimplePRNG.#c) % _SimplePRNG.#m;
+    return this.#seed / _SimplePRNG.#m;
+  }
+  /**
+  * Resets the generator with a new seed.
+  * @param seed - New seed value.
+  */
+  reset(seed) {
+    this.#seed = seed;
   }
 };
 
@@ -170,7 +211,7 @@ function base32Encode(data, variant, options) {
 }
 
 // src/space-id.ts
-import { Schema as Schema2 } from "effect";
+import * as Schema2 from "effect/Schema";
 import { invariant } from "@dxos/invariant";
 
 // src/random-bytes.ts
@@ -182,7 +223,6 @@ var randomBytes = (length) => {
 };
 
 // src/space-id.ts
-var __dxlog_file = "/__w/dxos/dxos/packages/common/keys/src/space-id.ts";
 var MULTIBASE_PREFIX = "B";
 var ENCODED_LENGTH = 33;
 var isValid = (value) => {
@@ -191,36 +231,12 @@ var isValid = (value) => {
 var SpaceId = class extends Schema2.String.pipe(Schema2.filter(isValid)) {
   static byteLength = 20;
   static encode = (value) => {
-    invariant(value instanceof Uint8Array, "Invalid type", {
-      F: __dxlog_file,
-      L: 43,
-      S: this,
-      A: [
-        "value instanceof Uint8Array",
-        "'Invalid type'"
-      ]
-    });
-    invariant(value.length === SpaceId.byteLength, "Invalid length", {
-      F: __dxlog_file,
-      L: 44,
-      S: this,
-      A: [
-        "value.length === SpaceId.byteLength",
-        "'Invalid length'"
-      ]
-    });
+    invariant(value instanceof Uint8Array, "Invalid type");
+    invariant(value.length === SpaceId.byteLength, "Invalid length");
     return MULTIBASE_PREFIX + base32Encode(value, "RFC4648");
   };
   static decode = (value) => {
-    invariant(value.startsWith(MULTIBASE_PREFIX), "Invalid multibase32 encoding", {
-      F: __dxlog_file,
-      L: 49,
-      S: this,
-      A: [
-        "value.startsWith(MULTIBASE_PREFIX)",
-        "'Invalid multibase32 encoding'"
-      ]
-    });
+    invariant(value.startsWith(MULTIBASE_PREFIX), "Invalid multibase32 encoding");
     return new Uint8Array((0, import_base32_decode.default)(value.slice(1), "RFC4648"));
   };
   static isValid = isValid;
@@ -230,7 +246,6 @@ var SpaceId = class extends Schema2.String.pipe(Schema2.filter(isValid)) {
 };
 
 // src/dxn.ts
-var __dxlog_file2 = "/__w/dxos/dxos/packages/common/keys/src/dxn.ts";
 var LOCAL_SPACE_TAG = "@";
 var DXN_ECHO_REGEXP = /@(dxn:[a-zA-Z0-p:@]+)/;
 var QueueSubspaceTags = Object.freeze({
@@ -243,12 +258,12 @@ var DXN = class _DXN {
   static Schema = Schema3.NonEmptyString.pipe(
     Schema3.pattern(/^dxn:([^:]+):(?:[^:]+:?)+[^:]$/),
     // TODO(dmaretskyi): To set the format we need to move the annotation IDs out of the echo-schema package.
-    // FormatAnnotation.set(FormatEnum.DXN),
+    // FormatAnnotation.set(TypeFormat.DXN),
     Schema3.annotations({
       title: "DXN",
       description: "DXN URI",
       examples: [
-        "dxn:type:example.com/type/MyType",
+        "dxn:type:com.example.type.my-type",
         "dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6"
       ]
     })
@@ -261,15 +276,15 @@ var DXN = class _DXN {
   */
   static kind = Object.freeze({
     /**
-    * dxn:type:<type name>[:<version>]
+    * dxn:type:<type_name>[:<version>]
     */
     TYPE: "type",
     /**
-    * dxn:echo:<space id>:<echo id>
-    * dxn:echo:@:<echo id>
+    * dxn:echo:<space_id>:<echo_id>
+    * dxn:echo:@:<echo_id>
     */
-    // TODO(burdon): Rename to OBJECT? (BREAKING CHANGE).
-    // TODO(burdon): Add separate Kind for space.
+    // TODO(burdon): Rename to OBJECT? (BREAKING CHANGE to update "echo").
+    // TODO(burdon): Add separate Kind for space?
     ECHO: "echo",
     /**
     * The subspace tag enables us to partition queues by usage within the context of a space.
@@ -279,12 +294,17 @@ var DXN = class _DXN {
     */
     QUEUE: "queue"
   });
-  get kind() {
-    return this.#kind;
-  }
+  /**
+  * Exactly equals.
+  */
   static equals(a, b) {
     return a.kind === b.kind && a.parts.length === b.parts.length && a.parts.every((part, i) => part === b.parts[i]);
   }
+  static equalsEchoId(a, b) {
+    const a1 = a.asEchoDXN();
+    const b1 = b.asEchoDXN();
+    return !!a1 && !!b1 && a1.echoId === b1.echoId;
+  }
   // TODO(burdon): Rename isValid.
   static isDXNString(dxn) {
     return dxn.startsWith("dxn:");
@@ -313,7 +333,7 @@ var DXN = class _DXN {
     }
   }
   /**
-  * @example `dxn:type:example.com/type/Contact`
+  * @example `dxn:type:com.example.type.person`
   */
   static fromTypename(typename) {
     return new _DXN(_DXN.kind.TYPE, [
@@ -321,7 +341,7 @@ var DXN = class _DXN {
     ]);
   }
   /**
-  * @example `dxn:type:example.com/type/Contact:0.1.0`
+  * @example `dxn:type:com.example.type.person:0.1.0`
   */
   // TODO(dmaretskyi): Consider using @ as the version separator.
   static fromTypenameAndVersion(typename, version) {
@@ -335,7 +355,7 @@ var DXN = class _DXN {
   */
   static fromSpaceAndObjectId(spaceId, objectId) {
     assertArgument(SpaceId.isValid(spaceId), `Invalid space ID: ${spaceId}`);
-    assertArgument(ObjectId.isValid(objectId), `Invalid object ID: ${objectId}`);
+    assertArgument(ObjectId.isValid(objectId), "objectId", `Invalid object ID: ${objectId}`);
     return new _DXN(_DXN.kind.ECHO, [
       spaceId,
       objectId
@@ -345,7 +365,7 @@ var DXN = class _DXN {
   * @example `dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6`
   */
   static fromLocalObjectId(id) {
-    assertArgument(ObjectId.isValid(id), `Invalid object ID: ${id}`);
+    assertArgument(ObjectId.isValid(id), "id", `Invalid object ID: ${id}`);
     return new _DXN(_DXN.kind.ECHO, [
       LOCAL_SPACE_TAG,
       id
@@ -353,8 +373,8 @@ var DXN = class _DXN {
   }
   static fromQueue(subspaceTag, spaceId, queueId, objectId) {
     assertArgument(SpaceId.isValid(spaceId), `Invalid space ID: ${spaceId}`);
-    assertArgument(ObjectId.isValid(queueId), `Invalid queue ID: ${queueId}`);
-    assertArgument(!objectId || ObjectId.isValid(objectId), `Invalid object ID: ${objectId}`);
+    assertArgument(ObjectId.isValid(queueId), "queueId", `Invalid queue ID: ${queueId}`);
+    assertArgument(!objectId || ObjectId.isValid(objectId), "objectId", `Invalid object ID: ${objectId}`);
     return new _DXN(_DXN.kind.QUEUE, [
       subspaceTag,
       spaceId,
@@ -367,17 +387,17 @@ var DXN = class _DXN {
   #kind;
   #parts;
   constructor(kind, parts) {
-    assertArgument(parts.length > 0, `Invalid DXN: ${parts}`);
-    assertArgument(parts.every((part) => typeof part === "string" && part.length > 0 && part.indexOf(":") === -1), `Invalid DXN: ${parts}`);
+    assertArgument(parts.length > 0, "parts", `Invalid DXN: ${parts}`);
+    assertArgument(parts.every((part) => typeof part === "string" && part.length > 0 && part.indexOf(":") === -1), "parts", `Invalid DXN: ${parts}`);
     switch (kind) {
       case _DXN.kind.TYPE:
         if (parts.length > 2) {
-          throw new Error('Invalid "type" DXN');
+          throw new Error("Invalid DXN.kind.TYPE");
         }
         break;
       case _DXN.kind.ECHO:
         if (parts.length !== 2) {
-          throw new Error('Invalid "echo" DXN');
+          throw new Error("Invalid DXN.kind.ECHO");
         }
         break;
     }
@@ -412,22 +432,20 @@ var DXN = class _DXN {
       }
     };
   }
+  get kind() {
+    return this.#kind;
+  }
   get parts() {
     return this.#parts;
   }
   // TODO(burdon): Should getters fail?
   get typename() {
-    invariant2(this.#kind === _DXN.kind.TYPE, void 0, {
-      F: __dxlog_file2,
-      L: 234,
-      S: this,
-      A: [
-        "this.#kind === DXN.kind.TYPE",
-        ""
-      ]
-    });
+    invariant2(this.#kind === _DXN.kind.TYPE);
     return this.#parts[0];
   }
+  equals(other) {
+    return _DXN.equals(this, other);
+  }
   hasTypenameOf(typename) {
     return this.#kind === _DXN.kind.TYPE && this.#parts.length === 1 && this.#parts[0] === typename;
   }
@@ -452,6 +470,7 @@ var DXN = class _DXN {
     const [spaceId, echoId] = this.#parts;
     return {
       spaceId: spaceId === LOCAL_SPACE_TAG ? void 0 : spaceId,
+      // TODO(burdon): objectId.
       echoId
     };
   }
@@ -484,40 +503,15 @@ var DXN = class _DXN {
 // src/identity-did.ts
 var import_base32_decode2 = __toESM(require_base32_decode(), 1);
 import { invariant as invariant3 } from "@dxos/invariant";
-var __dxlog_file3 = "/__w/dxos/dxos/packages/common/keys/src/identity-did.ts";
 var IdentityDid = Object.freeze({
   byteLength: 20,
   encode: (value) => {
-    invariant3(value instanceof Uint8Array, "Invalid type", {
-      F: __dxlog_file3,
-      L: 22,
-      S: void 0,
-      A: [
-        "value instanceof Uint8Array",
-        "'Invalid type'"
-      ]
-    });
-    invariant3(value.length === IdentityDid.byteLength, "Invalid length", {
-      F: __dxlog_file3,
-      L: 23,
-      S: void 0,
-      A: [
-        "value.length === IdentityDid.byteLength",
-        "'Invalid length'"
-      ]
-    });
+    invariant3(value instanceof Uint8Array, "Invalid type");
+    invariant3(value.length === IdentityDid.byteLength, "Invalid length");
     return DID_PREFIX + MULTIBASE_PREFIX2 + base32Encode(value, "RFC4648");
   },
   decode: (value) => {
-    invariant3(value.startsWith(DID_PREFIX + MULTIBASE_PREFIX2), "Invalid multibase32 encoding", {
-      F: __dxlog_file3,
-      L: 28,
-      S: void 0,
-      A: [
-        "value.startsWith(DID_PREFIX + MULTIBASE_PREFIX)",
-        "'Invalid multibase32 encoding'"
-      ]
-    });
+    invariant3(value.startsWith(DID_PREFIX + MULTIBASE_PREFIX2), "Invalid multibase32 encoding");
     return new Uint8Array((0, import_base32_decode2.default)(value.slice(10), "RFC4648"));
   },
   isValid: (value) => {
@@ -535,7 +529,6 @@ var ENCODED_LENGTH2 = 42;
 var import_base32_decode3 = __toESM(require_base32_decode(), 1);
 import { devtoolsFormatter as devtoolsFormatter2, equalsSymbol, inspectCustom as inspectCustom2, truncateKey } from "@dxos/debug";
 import { invariant as invariant4 } from "@dxos/invariant";
-var __dxlog_file4 = "/__w/dxos/dxos/packages/common/keys/src/public-key.ts";
 var PUBLIC_KEY_LENGTH = 32;
 var SECRET_KEY_LENGTH = 64;
 var isLikeArrayBuffer = (value) => typeof value === "object" && value !== null && Object.getPrototypeOf(value).constructor.name === "ArrayBuffer";
@@ -548,15 +541,7 @@ var PublicKey = class _PublicKey {
   * @returns PublicKey
   */
   static from(source) {
-    invariant4(source, void 0, {
-      F: __dxlog_file4,
-      L: 50,
-      S: this,
-      A: [
-        "source",
-        ""
-      ]
-    });
+    invariant4(source);
     if (source instanceof _PublicKey) {
       return source;
     } else if (source instanceof Buffer) {
@@ -640,15 +625,7 @@ var PublicKey = class _PublicKey {
   * @deprecated All keys should be represented as instances of PublicKey.
   */
   static bufferize(str) {
-    invariant4(typeof str === "string", "Invalid type", {
-      F: __dxlog_file4,
-      L: 153,
-      S: this,
-      A: [
-        "typeof str === 'string'",
-        "'Invalid type'"
-      ]
-    });
+    invariant4(typeof str === "string", "Invalid type");
     const buffer = Buffer.from(str, "hex");
     return buffer;
   }
@@ -663,15 +640,7 @@ var PublicKey = class _PublicKey {
     } else if (key instanceof Uint8Array) {
       key = Buffer.from(key.buffer, key.byteOffset, key.byteLength);
     }
-    invariant4(key instanceof Buffer, "Invalid type", {
-      F: __dxlog_file4,
-      L: 172,
-      S: this,
-      A: [
-        "key instanceof Buffer",
-        "'Invalid type'"
-      ]
-    });
+    invariant4(key instanceof Buffer, "Invalid type");
     return key.toString("hex");
   }
   /**
@@ -682,15 +651,7 @@ var PublicKey = class _PublicKey {
     return key.toHex();
   }
   static fromMultibase32(encoded) {
-    invariant4(encoded.startsWith("B"), "Invalid multibase32 encoding", {
-      F: __dxlog_file4,
-      L: 185,
-      S: this,
-      A: [
-        "encoded.startsWith('B')",
-        "'Invalid multibase32 encoding'"
-      ]
-    });
+    invariant4(encoded.startsWith("B"), "Invalid multibase32 encoding");
     return new _PublicKey(new Uint8Array((0, import_base32_decode3.default)(encoded.slice(1), "RFC4648")));
   }
   constructor(_value) {
@@ -717,7 +678,7 @@ var PublicKey = class _PublicKey {
   toMultibase32() {
     return "B" + base32Encode(this._value, "RFC4648");
   }
-  truncate(length = void 0) {
+  truncate(length) {
     return truncateKey(this, length);
   }
   asBuffer() {
@@ -831,6 +792,7 @@ export {
   PublicKey,
   QueueSubspaceTags,
   SECRET_KEY_LENGTH,
+  SimplePRNG,
   SpaceId
 };
 //# sourceMappingURL=index.mjs.map