@dxos/keys 0.8.4-main.84f28bd → 0.8.4-main.8baae0fced

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

@@ -82,28 +82,73 @@ 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 { invariant as invariant2 } from "@dxos/invariant";
+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",
+  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);
       return true;
-    } catch (err) {
+    } catch {
       return false;
     }
   }
   static random() {
-    return ulid();
+    return this.#factory(this.#seedTime);
+  }
+  static dangerouslyDisableRandomness() {
+    this.#factory = monotonicFactory(makeTestPRNG());
+    this.#seedTime = (/* @__PURE__ */ new Date("2025-01-01")).getTime();
+  }
+  static dangerouslySetSeed(time, seed) {
+    this.#factory = monotonicFactory(makeTestPRNG(seed));
+    this.#seedTime = time;
+  }
+};
+var makeTestPRNG = (seed = 0) => {
+  const rng = new SimplePRNG(seed);
+  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 +215,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,121 +227,88 @@ 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) => {
   return typeof value === "string" && value.startsWith(MULTIBASE_PREFIX) && value.length === ENCODED_LENGTH;
 };
 var SpaceId = class extends Schema2.String.pipe(Schema2.filter(isValid)) {
-  static {
-    this.byteLength = 20;
-  }
-  static {
-    this.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'"
-        ]
-      });
-      return MULTIBASE_PREFIX + base32Encode(value, "RFC4648");
-    };
-  }
-  static {
-    this.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'"
-        ]
-      });
-      return new Uint8Array((0, import_base32_decode.default)(value.slice(1), "RFC4648"));
-    };
-  }
-  static {
-    this.isValid = isValid;
-  }
-  static {
-    this.random = () => {
-      return SpaceId.encode(randomBytes(SpaceId.byteLength));
-    };
-  }
+  static byteLength = 20;
+  static encode = (value) => {
+    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");
+    return new Uint8Array((0, import_base32_decode.default)(value.slice(1), "RFC4648"));
+  };
+  static isValid = isValid;
+  static random = () => {
+    return SpaceId.encode(randomBytes(SpaceId.byteLength));
+  };
 };
 
 // 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({
   DATA: "data",
   TRACE: "trace"
 });
 var DXN = class _DXN {
-  static {
-    // TODO(dmaretskyi): Should this be a transformation into the DXN type?
-    this.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),
-      Schema3.annotations({
-        title: "DXN",
-        description: "DXN URI",
-        examples: [
-          "dxn:type:example.com/type/MyType",
-          "dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6"
-        ]
-      })
-    );
-  }
+  // TODO(burdon): Rename to DXN (i.e., DXN.DXN).
+  // TODO(dmaretskyi): Should this be a transformation into the DXN type?
+  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(TypeFormat.DXN),
+    Schema3.annotations({
+      title: "DXN",
+      description: "DXN URI",
+      examples: [
+        "dxn:type:com.example.type.my-type",
+        "dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6"
+      ]
+    })
+  );
   static hash(dxn) {
     return dxn.toString();
   }
-  static {
+  /**
+  * Kind constants.
+  */
+  static kind = Object.freeze({
     /**
-    * Kind constants.
+    * dxn:type:<type_name>[:<version>]
     */
-    this.kind = Object.freeze({
-      /**
-      * dxn:type:<type name>[:<version>]
-      */
-      TYPE: "type",
-      /**
-      * dxn:echo:<space id>:<echo id>
-      * dxn:echo:@:<echo id>
-      */
-      // TODO(burdon): Rename to OBJECT? (BREAKING CHANGE).
-      // 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.
-      * dxn:queue:<subspace_tag>:<space_id>:<queue_id>[:object_id]
-      * dxn:queue:data:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6
-      * dxn:queue:trace:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6
-      */
-      QUEUE: "queue"
-    });
-  }
-  get kind() {
-    return this.#kind;
-  }
+    TYPE: "type",
+    /**
+    * dxn:echo:<space_id>:<echo_id>
+    * dxn:echo:@:<echo_id>
+    */
+    // 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.
+    * dxn:queue:<subspace_tag>:<space_id>:<queue_id>[:object_id]
+    * dxn:queue:data:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6
+    * dxn:queue:trace:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6
+    */
+    QUEUE: "queue"
+  });
+  /**
+  * 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:");
@@ -320,12 +332,12 @@ var DXN = class _DXN {
   static tryParse(dxn) {
     try {
       return _DXN.parse(dxn);
-    } catch (error) {
+    } catch {
       return void 0;
     }
   }
   /**
-  * @example `dxn:type:example.com/type/Contact`
+  * @example `dxn:type:com.example.type.person`
   */
   static fromTypename(typename) {
     return new _DXN(_DXN.kind.TYPE, [
@@ -333,7 +345,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) {
@@ -343,42 +355,30 @@ var DXN = class _DXN {
     ]);
   }
   /**
+  * @example `dxn:echo:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6`
+  */
+  static fromSpaceAndObjectId(spaceId, objectId) {
+    assertArgument(SpaceId.isValid(spaceId), `Invalid space ID: ${spaceId}`);
+    assertArgument(ObjectId.isValid(objectId), "objectId", `Invalid object ID: ${objectId}`);
+    return new _DXN(_DXN.kind.ECHO, [
+      spaceId,
+      objectId
+    ]);
+  }
+  /**
   * @example `dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6`
   */
   static fromLocalObjectId(id) {
+    assertArgument(ObjectId.isValid(id), "id", `Invalid object ID: ${id}`);
     return new _DXN(_DXN.kind.ECHO, [
       LOCAL_SPACE_TAG,
       id
     ]);
   }
   static fromQueue(subspaceTag, spaceId, queueId, objectId) {
-    invariant2(SpaceId.isValid(spaceId), void 0, {
-      F: __dxlog_file2,
-      L: 150,
-      S: this,
-      A: [
-        "SpaceId.isValid(spaceId)",
-        ""
-      ]
-    });
-    invariant2(ObjectId.isValid(queueId), void 0, {
-      F: __dxlog_file2,
-      L: 151,
-      S: this,
-      A: [
-        "ObjectId.isValid(queueId)",
-        ""
-      ]
-    });
-    invariant2(!objectId || ObjectId.isValid(objectId), void 0, {
-      F: __dxlog_file2,
-      L: 152,
-      S: this,
-      A: [
-        "!objectId || ObjectId.isValid(objectId)",
-        ""
-      ]
-    });
+    assertArgument(SpaceId.isValid(spaceId), `Invalid space ID: ${spaceId}`);
+    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,
@@ -391,33 +391,17 @@ var DXN = class _DXN {
   #kind;
   #parts;
   constructor(kind, parts) {
-    invariant2(parts.length > 0, void 0, {
-      F: __dxlog_file2,
-      L: 161,
-      S: this,
-      A: [
-        "parts.length > 0",
-        ""
-      ]
-    });
-    invariant2(parts.every((part) => typeof part === "string" && part.length > 0 && part.indexOf(":") === -1), void 0, {
-      F: __dxlog_file2,
-      L: 162,
-      S: this,
-      A: [
-        "parts.every((part) => typeof part === 'string' && part.length > 0 && part.indexOf(':') === -1)",
-        ""
-      ]
-    });
+    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;
     }
@@ -452,22 +436,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: 217,
-      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;
   }
@@ -480,6 +462,7 @@ var DXN = class _DXN {
     }
     const [type, version] = this.#parts;
     return {
+      // TODO(wittjosiah): Should be `typename` for consistency.
       type,
       version
     };
@@ -491,6 +474,7 @@ var DXN = class _DXN {
     const [spaceId, echoId] = this.#parts;
     return {
       spaceId: spaceId === LOCAL_SPACE_TAG ? void 0 : spaceId,
+      // TODO(burdon): objectId.
       echoId
     };
   }
@@ -509,45 +493,29 @@ var DXN = class _DXN {
       objectId
     };
   }
+  /**
+  * Produces a new DXN with the given parts appended.
+  */
+  extend(parts) {
+    return new _DXN(this.#kind, [
+      ...this.#parts,
+      ...parts
+    ]);
+  }
 };
 
 // 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) => {
@@ -561,33 +529,49 @@ var MULTIBASE_PREFIX2 = "B";
 var DID_PREFIX = "did:halo:";
 var ENCODED_LENGTH2 = 42;
 
+// src/parse-id.ts
+var SPACE_ID_LENGTH = 33;
+var OBJECT_ID_LENGTH = 26;
+var FQ_ID_LENGTH = SPACE_ID_LENGTH + OBJECT_ID_LENGTH + 1;
+var parseId = (id) => {
+  if (!id) {
+    return {};
+  } else if (id.length === SPACE_ID_LENGTH) {
+    return {
+      spaceId: id
+    };
+  } else if (id.length === OBJECT_ID_LENGTH) {
+    return {
+      objectId: id
+    };
+  } else if (id.length === FQ_ID_LENGTH && id.indexOf(":") === SPACE_ID_LENGTH) {
+    const [spaceId, objectId] = id.split(":");
+    return {
+      spaceId,
+      objectId
+    };
+  } else {
+    return {};
+  }
+};
+
 // src/public-key.ts
 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";
 var PublicKey = class _PublicKey {
-  static {
-    this.ZERO = _PublicKey.from("00".repeat(PUBLIC_KEY_LENGTH));
-  }
+  _value;
+  static ZERO = _PublicKey.from("00".repeat(PUBLIC_KEY_LENGTH));
   /**
   * Creates new instance of PublicKey automatically determining the input format.
   * @param source A Buffer, or Uint8Array, or hex encoded string, or something with an `asUint8Array` method on it
   * @returns PublicKey
   */
   static from(source) {
-    invariant4(source, void 0, {
-      F: __dxlog_file4,
-      L: 49,
-      S: this,
-      A: [
-        "source",
-        ""
-      ]
-    });
+    invariant4(source);
     if (source instanceof _PublicKey) {
       return source;
     } else if (source instanceof Buffer) {
@@ -671,15 +655,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: 152,
-      S: this,
-      A: [
-        "typeof str === 'string'",
-        "'Invalid type'"
-      ]
-    });
+    invariant4(typeof str === "string", "Invalid type");
     const buffer = Buffer.from(str, "hex");
     return buffer;
   }
@@ -694,15 +670,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: 171,
-      S: this,
-      A: [
-        "key instanceof Buffer",
-        "'Invalid type'"
-      ]
-    });
+    invariant4(key instanceof Buffer, "Invalid type");
     return key.toString("hex");
   }
   /**
@@ -713,15 +681,7 @@ var PublicKey = class _PublicKey {
     return key.toHex();
   }
   static fromMultibase32(encoded) {
-    invariant4(encoded.startsWith("B"), "Invalid multibase32 encoding", {
-      F: __dxlog_file4,
-      L: 184,
-      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) {
@@ -748,7 +708,7 @@ var PublicKey = class _PublicKey {
   toMultibase32() {
     return "B" + base32Encode(this._value, "RFC4648");
   }
-  truncate(length = void 0) {
+  truncate(length) {
     return truncateKey(this, length);
   }
   asBuffer() {
@@ -854,13 +814,19 @@ var PublicKey = class _PublicKey {
 };
 export {
   DXN,
+  DXN_ECHO_REGEXP,
+  FQ_ID_LENGTH,
   IdentityDid,
   LOCAL_SPACE_TAG,
+  OBJECT_ID_LENGTH,
   ObjectId,
   PUBLIC_KEY_LENGTH,
   PublicKey,
   QueueSubspaceTags,
   SECRET_KEY_LENGTH,
-  SpaceId
+  SPACE_ID_LENGTH,
+  SimplePRNG,
+  SpaceId,
+  parseId
 };
 //# sourceMappingURL=index.mjs.map