@dxos/keys 0.8.4-main.c1de068 → 0.8.4-main.dedc0f3

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

@@ -90,7 +90,7 @@ import { assertArgument, invariant as invariant2 } from "@dxos/invariant";
 import { Schema } from "effect";
 import { ulid } 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 {
@@ -98,7 +98,7 @@ var ObjectId = class extends ObjectIdSchema {
     try {
       Schema.decodeSync(ObjectId)(id);
       return true;
-    } catch (err) {
+    } catch {
       return false;
     }
   }
@@ -182,121 +182,143 @@ var randomBytes = (length) => {
 };
 
 // src/space-id.ts
+function _define_property(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
+var _Schema_String_pipe;
+var _class;
 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");
-    };
+var SpaceId = (_class = class extends (_Schema_String_pipe = Schema2.String.pipe(Schema2.filter(isValid))) {
+}, _define_property(_class, "byteLength", 20), _define_property(_class, "encode", (value) => {
+  invariant(value instanceof Uint8Array, "Invalid type", {
+    F: __dxlog_file,
+    L: 43,
+    S: _class,
+    A: [
+      "value instanceof Uint8Array",
+      "'Invalid type'"
+    ]
+  });
+  invariant(value.length === SpaceId.byteLength, "Invalid length", {
+    F: __dxlog_file,
+    L: 44,
+    S: _class,
+    A: [
+      "value.length === SpaceId.byteLength",
+      "'Invalid length'"
+    ]
+  });
+  return MULTIBASE_PREFIX + base32Encode(value, "RFC4648");
+}), _define_property(_class, "decode", (value) => {
+  invariant(value.startsWith(MULTIBASE_PREFIX), "Invalid multibase32 encoding", {
+    F: __dxlog_file,
+    L: 49,
+    S: _class,
+    A: [
+      "value.startsWith(MULTIBASE_PREFIX)",
+      "'Invalid multibase32 encoding'"
+    ]
+  });
+  return new Uint8Array((0, import_base32_decode.default)(value.slice(1), "RFC4648"));
+}), _define_property(_class, "isValid", isValid), _define_property(_class, "random", () => {
+  return SpaceId.encode(randomBytes(SpaceId.byteLength));
+}), _class);
+
+// src/dxn.ts
+function _check_private_redeclaration(obj, privateCollection) {
+  if (privateCollection.has(obj)) {
+    throw new TypeError("Cannot initialize the same private elements twice on an object");
   }
-  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"));
-    };
+}
+function _class_apply_descriptor_get(receiver, descriptor) {
+  if (descriptor.get) {
+    return descriptor.get.call(receiver);
   }
-  static {
-    this.isValid = isValid;
+  return descriptor.value;
+}
+function _class_apply_descriptor_set(receiver, descriptor, value) {
+  if (descriptor.set) {
+    descriptor.set.call(receiver, value);
+  } else {
+    if (!descriptor.writable) {
+      throw new TypeError("attempted to set read only private field");
+    }
+    descriptor.value = value;
   }
-  static {
-    this.random = () => {
-      return SpaceId.encode(randomBytes(SpaceId.byteLength));
-    };
+}
+function _class_extract_field_descriptor(receiver, privateMap, action) {
+  if (!privateMap.has(receiver)) {
+    throw new TypeError("attempted to " + action + " private field on non-instance");
   }
-};
-
-// src/dxn.ts
+  return privateMap.get(receiver);
+}
+function _class_private_field_get(receiver, privateMap) {
+  var descriptor = _class_extract_field_descriptor(receiver, privateMap, "get");
+  return _class_apply_descriptor_get(receiver, descriptor);
+}
+function _class_private_field_init(obj, privateMap, value) {
+  _check_private_redeclaration(obj, privateMap);
+  privateMap.set(obj, value);
+}
+function _class_private_field_set(receiver, privateMap, value) {
+  var descriptor = _class_extract_field_descriptor(receiver, privateMap, "set");
+  _class_apply_descriptor_set(receiver, descriptor, value);
+  return value;
+}
+function _define_property2(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
 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 _kind = /* @__PURE__ */ new WeakMap();
+var _parts = /* @__PURE__ */ new WeakMap();
+var _inspectCustom = inspectCustom;
+var _devtoolsFormatter = devtoolsFormatter;
 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"
-        ]
-      })
-    );
-  }
   static hash(dxn) {
     return dxn.toString();
   }
-  static {
-    /**
-    * Kind constants.
-    */
-    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;
-  }
+  /**
+  * 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,7 +342,7 @@ var DXN = class _DXN {
   static tryParse(dxn) {
     try {
       return _DXN.parse(dxn);
-    } catch (error) {
+    } catch {
       return void 0;
     }
   }
@@ -343,43 +365,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), `Invalid object ID: ${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: 151,
-      S: this,
-      A: [
-        "SpaceId.isValid(spaceId)",
-        ""
-      ]
-    });
-    invariant2(ObjectId.isValid(queueId), void 0, {
-      F: __dxlog_file2,
-      L: 152,
-      S: this,
-      A: [
-        "ObjectId.isValid(queueId)",
-        ""
-      ]
-    });
-    invariant2(!objectId || ObjectId.isValid(objectId), void 0, {
-      F: __dxlog_file2,
-      L: 153,
-      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,
@@ -389,44 +398,8 @@ var DXN = class _DXN {
       ] : []
     ]);
   }
-  #kind;
-  #parts;
-  constructor(kind, parts) {
-    invariant2(parts.length > 0, void 0, {
-      F: __dxlog_file2,
-      L: 162,
-      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: 163,
-      S: this,
-      A: [
-        "parts.every((part) => typeof part === 'string' && part.length > 0 && part.indexOf(':') === -1)",
-        ""
-      ]
-    });
-    switch (kind) {
-      case _DXN.kind.TYPE:
-        if (parts.length > 2) {
-          throw new Error('Invalid "type" DXN');
-        }
-        break;
-      case _DXN.kind.ECHO:
-        if (parts.length !== 2) {
-          throw new Error('Invalid "echo" DXN');
-        }
-        break;
-    }
-    this.#kind = kind;
-    this.#parts = parts;
-  }
   toString() {
-    return `dxn:${this.#kind}:${this.#parts.join(":")}`;
+    return `dxn:${_class_private_field_get(this, _kind)}:${_class_private_field_get(this, _parts).join(":")}`;
   }
   toJSON() {
     return this.toString();
@@ -434,13 +407,13 @@ var DXN = class _DXN {
   /**
   * Used by Node.js to get textual representation of this object when it's printed with a `console.log` statement.
   */
-  [inspectCustom](depth, options, inspectFn) {
+  [_inspectCustom](depth, options, inspectFn) {
     const printControlCode = (code) => {
       return `\x1B[${code}m`;
     };
     return printControlCode(inspectFn.colors.blueBright[0]) + this.toString() + printControlCode(inspectFn.colors.reset[0]);
   }
-  get [devtoolsFormatter]() {
+  get [_devtoolsFormatter]() {
     return {
       header: () => {
         return [
@@ -453,33 +426,39 @@ var DXN = class _DXN {
       }
     };
   }
+  get kind() {
+    return _class_private_field_get(this, _kind);
+  }
   get parts() {
-    return this.#parts;
+    return _class_private_field_get(this, _parts);
   }
   // TODO(burdon): Should getters fail?
   get typename() {
-    invariant2(this.#kind === _DXN.kind.TYPE, void 0, {
+    invariant2(_class_private_field_get(this, _kind) === _DXN.kind.TYPE, void 0, {
       F: __dxlog_file2,
-      L: 218,
+      L: 250,
       S: this,
       A: [
         "this.#kind === DXN.kind.TYPE",
         ""
       ]
     });
-    return this.#parts[0];
+    return _class_private_field_get(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;
+    return _class_private_field_get(this, _kind) === _DXN.kind.TYPE && _class_private_field_get(this, _parts).length === 1 && _class_private_field_get(this, _parts)[0] === typename;
   }
   isLocalObjectId() {
-    return this.#kind === _DXN.kind.ECHO && this.#parts[0] === LOCAL_SPACE_TAG && this.#parts.length === 2;
+    return _class_private_field_get(this, _kind) === _DXN.kind.ECHO && _class_private_field_get(this, _parts)[0] === LOCAL_SPACE_TAG && _class_private_field_get(this, _parts).length === 2;
   }
   asTypeDXN() {
     if (this.kind !== _DXN.kind.TYPE) {
       return void 0;
     }
-    const [type, version] = this.#parts;
+    const [type, version] = _class_private_field_get(this, _parts);
     return {
       // TODO(wittjosiah): Should be `typename` for consistency.
       type,
@@ -490,9 +469,10 @@ var DXN = class _DXN {
     if (this.kind !== _DXN.kind.ECHO) {
       return void 0;
     }
-    const [spaceId, echoId] = this.#parts;
+    const [spaceId, echoId] = _class_private_field_get(this, _parts);
     return {
       spaceId: spaceId === LOCAL_SPACE_TAG ? void 0 : spaceId,
+      // TODO(burdon): objectId.
       echoId
     };
   }
@@ -500,7 +480,7 @@ var DXN = class _DXN {
     if (this.kind !== _DXN.kind.QUEUE) {
       return void 0;
     }
-    const [subspaceTag, spaceId, queueId, objectId] = this.#parts;
+    const [subspaceTag, spaceId, queueId, objectId] = _class_private_field_get(this, _parts);
     if (typeof queueId !== "string") {
       return void 0;
     }
@@ -511,7 +491,75 @@ var DXN = class _DXN {
       objectId
     };
   }
+  /**
+  * Produces a new DXN with the given parts appended.
+  */
+  extend(parts) {
+    return new _DXN(_class_private_field_get(this, _kind), [
+      ..._class_private_field_get(this, _parts),
+      ...parts
+    ]);
+  }
+  constructor(kind, parts) {
+    _class_private_field_init(this, _kind, {
+      writable: true,
+      value: void 0
+    });
+    _class_private_field_init(this, _parts, {
+      writable: true,
+      value: void 0
+    });
+    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 DXN.kind.TYPE");
+        }
+        break;
+      case _DXN.kind.ECHO:
+        if (parts.length !== 2) {
+          throw new Error("Invalid DXN.kind.ECHO");
+        }
+        break;
+    }
+    _class_private_field_set(this, _kind, kind);
+    _class_private_field_set(this, _parts, parts);
+  }
 };
+_define_property2(DXN, "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"
+    ]
+  })
+));
+_define_property2(DXN, "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 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"
+}));
 
 // src/identity-did.ts
 var import_base32_decode2 = __toESM(require_base32_decode(), 1);
@@ -567,14 +615,27 @@ 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";
+function _define_property3(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
 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 _inspectCustom2 = inspectCustom2;
+var _devtoolsFormatter2 = devtoolsFormatter2;
+var _equalsSymbol = equalsSymbol;
 var PublicKey = class _PublicKey {
-  static {
-    this.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
@@ -583,7 +644,7 @@ var PublicKey = class _PublicKey {
   static from(source) {
     invariant4(source, void 0, {
       F: __dxlog_file4,
-      L: 49,
+      L: 50,
       S: this,
       A: [
         "source",
@@ -675,7 +736,7 @@ var PublicKey = class _PublicKey {
   static bufferize(str) {
     invariant4(typeof str === "string", "Invalid type", {
       F: __dxlog_file4,
-      L: 152,
+      L: 153,
       S: this,
       A: [
         "typeof str === 'string'",
@@ -698,7 +759,7 @@ var PublicKey = class _PublicKey {
     }
     invariant4(key instanceof Buffer, "Invalid type", {
       F: __dxlog_file4,
-      L: 171,
+      L: 172,
       S: this,
       A: [
         "key instanceof Buffer",
@@ -717,7 +778,7 @@ var PublicKey = class _PublicKey {
   static fromMultibase32(encoded) {
     invariant4(encoded.startsWith("B"), "Invalid multibase32 encoding", {
       F: __dxlog_file4,
-      L: 184,
+      L: 185,
       S: this,
       A: [
         "encoded.startsWith('B')",
@@ -726,12 +787,6 @@ var PublicKey = class _PublicKey {
     });
     return new _PublicKey(new Uint8Array((0, import_base32_decode3.default)(encoded.slice(1), "RFC4648")));
   }
-  constructor(_value) {
-    this._value = _value;
-    if (!(_value instanceof Uint8Array)) {
-      throw new TypeError(`Expected Uint8Array, got: ${_value}`);
-    }
-  }
   toString() {
     return this.toHex();
   }
@@ -765,7 +820,7 @@ var PublicKey = class _PublicKey {
   /**
   * Used by Node.js to get textual representation of this object when it's printed with a `console.log` statement.
   */
-  [inspectCustom2](depth, options, inspectFn) {
+  [_inspectCustom2](depth, options, inspectFn) {
     if (!options.colors || typeof process.stdout.hasColors !== "function" || !process.stdout.hasColors()) {
       return `<PublicKey ${this.truncate()}>`;
     }
@@ -790,7 +845,7 @@ var PublicKey = class _PublicKey {
     const color = colors[this.getInsecureHash(colors.length)];
     return `PublicKey(${printControlCode(inspectFn.colors[color][0])}${this.truncate()}${printControlCode(inspectFn.colors.reset[0])})`;
   }
-  get [devtoolsFormatter2]() {
+  get [_devtoolsFormatter2]() {
     return {
       header: () => {
         const colors = [
@@ -843,19 +898,28 @@ var PublicKey = class _PublicKey {
     }
     let equal = true;
     for (let i = 0; i < this._value.length; i++) {
-      equal &&= this._value[i] === otherConverted._value[i];
+      equal && (equal = this._value[i] === otherConverted._value[i]);
     }
     return equal;
   }
-  [equalsSymbol](other) {
+  [_equalsSymbol](other) {
     if (!_PublicKey.isPublicKey(other)) {
       return false;
     }
     return this.equals(other);
   }
+  constructor(_value) {
+    _define_property3(this, "_value", void 0);
+    this._value = _value;
+    if (!(_value instanceof Uint8Array)) {
+      throw new TypeError(`Expected Uint8Array, got: ${_value}`);
+    }
+  }
 };
+_define_property3(PublicKey, "ZERO", PublicKey.from("00".repeat(PUBLIC_KEY_LENGTH)));
 export {
   DXN,
+  DXN_ECHO_REGEXP,
   IdentityDid,
   LOCAL_SPACE_TAG,
   ObjectId,