@dxos/keys 0.8.1-main.ba2dec9 → 0.8.1-staging.31c3ee1

package/dist/types/src/dxn.d.ts

@@ -1,6 +1,14 @@
 import type { inspect, InspectOptionsStylized } from 'node:util';
 import { inspectCustom } from '@dxos/debug';
 import type { SpaceId } from './space-id';
+/**
+ * Tags for ECHO DXNs that should resolve the object ID in the local space.
+ */
+export declare const LOCAL_SPACE_TAG = "@";
+export declare const QueueSubspaceTags: Readonly<{
+    DATA: "data";
+    TRACE: "trace";
+}>;
 /**
  * DXN unambiguously names a resource like an ECHO object, schema definition, plugin, etc.
  * Each DXN starts with a dxn prefix, followed by a resource kind.
@@ -9,7 +17,6 @@ import type { SpaceId } from './space-id';
  * '@' in the place of the space id is used to denote that the DXN should be resolved in the local space.
  *
  * @example
- *
  * ```
  * dxn:echo:<space key>:<echo id>
  * dxn:echo:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6
@@ -48,11 +55,11 @@ export declare class DXN {
     /**
      * @example `dxn:type:example.com/type/Contact`
      */
-    static fromTypename(type: string): DXN;
+    static fromTypename(typename: string): DXN;
     /**
      * @example `dxn:type:example.com/type/Contact:0.1.0`
      */
-    static fromTypenameAndVersion(type: string, version: string): DXN;
+    static fromTypenameAndVersion(typename: string, version: string): DXN;
     /**
      * @example `dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6`
      */
@@ -60,18 +67,21 @@ export declare class DXN {
     constructor(kind: string, parts: string[]);
     get kind(): string;
     get parts(): string[];
-    toTypename(): string;
+    get typename(): string;
     hasTypenameOf(typename: string): boolean;
+    isLocalObjectId(): boolean;
     asTypeDXN(): DXN.TypeDXN | undefined;
     asEchoDXN(): DXN.EchoDXN | undefined;
     asQueueDXN(): DXN.QueueDXN | undefined;
-    isLocalObjectId(): boolean;
-    toString(): string;
+    toString(): DXN.String;
     /**
      * Used by Node.js to get textual representation of this object when it's printed with a `console.log` statement.
      */
     [inspectCustom](depth: number, options: InspectOptionsStylized, inspectFn: typeof inspect): string;
 }
+/**
+ * API namespace.
+ */
 export declare namespace DXN {
     type TypeDXN = {
         type: string;
@@ -87,13 +97,11 @@ export declare namespace DXN {
         queueId: string;
         objectId?: string;
     };
+    /**
+     * DXN represented as a javascript string.
+     */
+    type String = string & {
+        __DXNString: never;
+    };
 }
-/**
- * Tags for ECHO DXNs that should resolve the object ID in the local space.
- */
-export declare const LOCAL_SPACE_TAG = "@";
-export declare const QueueSubspaceTags: Readonly<{
-    DATA: "data";
-    TRACE: "trace";
-}>;
 //# sourceMappingURL=dxn.d.ts.map

package/dist/types/src/dxn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dxn.d.ts","sourceRoot":"","sources":["../../../src/dxn.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE1C;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,GAAG;;IACd;;OAEG;IACH,MAAM,CAAC,IAAI;QACT;;WAEG;;QAEH;;;WAGG;;QAEH;;;;;WAKG;;OAEF;IAEH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG;IAI5B,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG;IAkB9B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM;IAQ3B;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM;IAIhC;;OAEG;IAEH,MAAM,CAAC,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAI3D;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM;gBAOvB,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;IAsBzC,IAAI,IAAI,WAEP;IAED,IAAI,KAAK,aAER;IAED,UAAU;IAKV,aAAa,CAAC,QAAQ,EAAE,MAAM;IAI9B,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAYpC,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAYpC,UAAU,IAAI,GAAG,CAAC,QAAQ,GAAG,SAAS;IAkBtC,eAAe;IAIf,QAAQ;IAIR;;OAEG;IACH,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,EAAE,OAAO,OAAO;CAS1F;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,KAAY,OAAO,GAAG;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,KAAY,OAAO,GAAG;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,MAAM,CAAC;AAEnC,eAAO,MAAM,iBAAiB;;;EAG5B,CAAC"}
+{"version":3,"file":"dxn.d.ts","sourceRoot":"","sources":["../../../src/dxn.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAEjE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAG5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,eAAe,MAAM,CAAC;AAGnC,eAAO,MAAM,iBAAiB;;;EAG5B,CAAC;AAEH;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,GAAG;;IACd;;OAEG;IACH,MAAM,CAAC,IAAI;QACT;;WAEG;;QAGH;;;WAGG;;QAKH;;;;;WAKG;;OAEF;IAEH,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG;IAK5B,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG;IAkB9B,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAQ7C;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM;IAIpC;;OAEG;IAEH,MAAM,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAI/D;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM;gBAOvB,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;IAsBzC,IAAI,IAAI,WAEP;IAED,IAAI,KAAK,aAER;IAED,IAAI,QAAQ,WAGX;IAED,aAAa,CAAC,QAAQ,EAAE,MAAM;IAI9B,eAAe;IAIf,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAYpC,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAYpC,UAAU,IAAI,GAAG,CAAC,QAAQ,GAAG,SAAS;IAkBtC,QAAQ,IAAI,GAAG,CAAC,MAAM;IAItB;;OAEG;IACH,CAAC,aAAa,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,SAAS,EAAE,OAAO,OAAO;CAS1F;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,KAAY,OAAO,GAAG;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,KAAY,OAAO,GAAG;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,KAAY,QAAQ,GAAG;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF;;OAEG;IACH,KAAY,MAAM,GAAG,MAAM,GAAG;QAAE,WAAW,EAAE,KAAK,CAAA;KAAE,CAAC;CAItD"}

package/dist/types/src/space-id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"space-id.d.ts","sourceRoot":"","sources":["../../../src/space-id.ts"],"names":[],"mappings":"AAWA;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,CAAC;AAEnD,eAAO,MAAM,OAAO;;oBAEF,UAAU,KAAG,OAAO;oBAMpB,OAAO,KAAG,UAAU;qBAKnB,MAAM,KAAG,KAAK,IAAI,OAAO;kBAG9B,OAAO;EAGnB,CAAC"}
+{"version":3,"file":"space-id.d.ts","sourceRoot":"","sources":["../../../src/space-id.ts"],"names":[],"mappings":"AAWA;;;;GAIG;AAEH,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG;IAAE,SAAS,EAAE,IAAI,CAAA;CAAE,CAAC;AAEnD,eAAO,MAAM,OAAO;;oBAEF,UAAU,KAAG,OAAO;oBAMpB,OAAO,KAAG,UAAU;qBAKnB,MAAM,KAAG,KAAK,IAAI,OAAO;kBAG9B,OAAO;EAGnB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/keys",
-  "version": "0.8.1-main.ba2dec9",
+  "version": "0.8.1-staging.31c3ee1",
   "description": "Key utils and definitions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -27,9 +27,9 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/debug": "0.8.1-main.ba2dec9",
-    "@dxos/invariant": "0.8.1-main.ba2dec9",
-    "@dxos/node-std": "0.8.1-main.ba2dec9"
+    "@dxos/debug": "0.8.1-staging.31c3ee1",
+    "@dxos/invariant": "0.8.1-staging.31c3ee1",
+    "@dxos/node-std": "0.8.1-staging.31c3ee1"
   },
   "devDependencies": {
     "base32-decode": "^1.0.0",

package/src/dxn.ts

@@ -9,6 +9,17 @@ import { invariant } from '@dxos/invariant';
 
 import type { SpaceId } from './space-id';
 
+/**
+ * Tags for ECHO DXNs that should resolve the object ID in the local space.
+ */
+export const LOCAL_SPACE_TAG = '@';
+
+// TODO(burdon): Namespace for.
+export const QueueSubspaceTags = Object.freeze({
+  DATA: 'data',
+  TRACE: 'trace',
+});
+
 /**
  * DXN unambiguously names a resource like an ECHO object, schema definition, plugin, etc.
  * Each DXN starts with a dxn prefix, followed by a resource kind.
@@ -17,7 +28,6 @@ import type { SpaceId } from './space-id';
  * '@' in the place of the space id is used to denote that the DXN should be resolved in the local space.
  *
  * @example
- *
  * ```
  * dxn:echo:<space key>:<echo id>
  * dxn:echo:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6
@@ -35,11 +45,15 @@ export class DXN {
      * dxn:type:<type name>[:<version>]
      */
     TYPE: 'type',
+
     /**
      * dxn:echo:<space id>:<echo id>
      * dxn:echo:@:<echo id>
      */
+    // TODO(burdon): Rename to OBJECT?
+    // 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]
@@ -53,6 +67,7 @@ export class DXN {
     return a.kind === b.kind && a.parts.length === b.parts.length && a.parts.every((part, i) => part === b.parts[i]);
   }
 
+  // TODO(burdon): Rename isValid.
   static isDXNString(dxn: string) {
     return dxn.startsWith('dxn:');
   }
@@ -75,7 +90,7 @@ export class DXN {
     return new DXN(kind, parts);
   }
 
-  static tryParse(dxn: string) {
+  static tryParse(dxn: string): DXN | undefined {
     try {
       return DXN.parse(dxn);
     } catch (error) {
@@ -86,16 +101,16 @@ export class DXN {
   /**
    * @example `dxn:type:example.com/type/Contact`
    */
-  static fromTypename(type: string) {
-    return new DXN(DXN.kind.TYPE, [type]);
+  static fromTypename(typename: string) {
+    return new DXN(DXN.kind.TYPE, [typename]);
   }
 
   /**
    * @example `dxn:type:example.com/type/Contact:0.1.0`
    */
   // TODO(dmaretskyi): Consider using @ as the version separator.
-  static fromTypenameAndVersion(type: string, version: string) {
-    return new DXN(DXN.kind.TYPE, [type, version]);
+  static fromTypenameAndVersion(typename: string, version: string) {
+    return new DXN(DXN.kind.TYPE, [typename, version]);
   }
 
   /**
@@ -138,7 +153,7 @@ export class DXN {
     return this.#parts;
   }
 
-  toTypename() {
+  get typename() {
     invariant(this.#kind === DXN.kind.TYPE);
     return this.#parts[0];
   }
@@ -147,6 +162,10 @@ export class DXN {
     return this.#kind === DXN.kind.TYPE && this.#parts.length === 1 && this.#parts[0] === typename;
   }
 
+  isLocalObjectId() {
+    return this.#kind === DXN.kind.ECHO && this.#parts[0] === LOCAL_SPACE_TAG && this.#parts.length === 2;
+  }
+
   asTypeDXN(): DXN.TypeDXN | undefined {
     if (this.kind !== DXN.kind.TYPE) {
       return undefined;
@@ -189,12 +208,8 @@ export class DXN {
     };
   }
 
-  isLocalObjectId() {
-    return this.#kind === DXN.kind.ECHO && this.#parts[0] === LOCAL_SPACE_TAG && this.#parts.length === 2;
-  }
-
-  toString() {
-    return `dxn:${this.#kind}:${this.#parts.join(':')}`;
+  toString(): DXN.String {
+    return `dxn:${this.#kind}:${this.#parts.join(':')}` as DXN.String;
   }
 
   /**
@@ -211,6 +226,9 @@ export class DXN {
   }
 }
 
+/**
+ * API namespace.
+ */
 export declare namespace DXN {
   export type TypeDXN = {
     type: string;
@@ -219,6 +237,7 @@ export declare namespace DXN {
 
   export type EchoDXN = {
     spaceId?: SpaceId;
+    // TODO(burdon): Rename objectId.
     echoId: string; // TODO(dmaretskyi): ObjectId.
   };
 
@@ -228,14 +247,12 @@ export declare namespace DXN {
     queueId: string; // TODO(dmaretskyi): ObjectId.
     objectId?: string; // TODO(dmaretskyi): ObjectId.
   };
-}
-
-/**
- * Tags for ECHO DXNs that should resolve the object ID in the local space.
- */
-export const LOCAL_SPACE_TAG = '@';
 
-export const QueueSubspaceTags = Object.freeze({
-  DATA: 'data',
-  TRACE: 'trace',
-});
+  /**
+   * DXN represented as a javascript string.
+   */
+  export type String = string & { __DXNString: never };
+  // TODO(burdon): Make brand.
+  // export const String = S.String.pipe(S.brand('DXN'));
+  // export type String = S.To(typoeof String);
+}

package/src/space-id.ts

@@ -14,6 +14,7 @@ import { randomBytes } from './random-bytes';
  * Space keys are generated by creating a keypair, and then taking the first 20 bytes of the SHA-256 hash of the public key and encoding them to multibase RFC4648 base-32 format (prefixed with B, see Multibase Table).
  * @example BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE
  */
+// TODO(burdon): Use effect brand.
 export type SpaceId = string & { __SpaceId: true };
 
 export const SpaceId = Object.freeze({