@dxos/keys 0.8.3-staging.0fa589b → 0.8.4-main.3a94e84

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/keys",
-  "version": "0.8.3-staging.0fa589b",
+  "version": "0.8.4-main.3a94e84",
   "description": "Key utils and definitions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -27,11 +27,11 @@
     "src"
   ],
   "dependencies": {
-    "effect": "3.14.21",
+    "effect": "3.17.0",
     "ulidx": "^2.3.0",
-    "@dxos/invariant": "0.8.3-staging.0fa589b",
-    "@dxos/node-std": "0.8.3-staging.0fa589b",
-    "@dxos/debug": "0.8.3-staging.0fa589b"
+    "@dxos/debug": "0.8.4-main.3a94e84",
+    "@dxos/invariant": "0.8.4-main.3a94e84",
+    "@dxos/node-std": "0.8.4-main.3a94e84"
   },
   "devDependencies": {
     "base32-decode": "^1.0.0",

package/src/dxn.ts

@@ -6,7 +6,7 @@ import { Schema } from 'effect';
 import type { inspect, InspectOptionsStylized } from 'node:util';
 
 import { devtoolsFormatter, type DevtoolsFormatter, inspectCustom } from '@dxos/debug';
-import { invariant } from '@dxos/invariant';
+import { assertArgument, invariant } from '@dxos/invariant';
 
 import { ObjectId } from './object-id';
 import { SpaceId } from './space-id';
@@ -143,6 +143,7 @@ export class DXN {
    * @example `dxn:echo:@:01J00J9B45YHYSGZQTQMSKMGJ6`
    */
   static fromLocalObjectId(id: string): DXN {
+    assertArgument(ObjectId.isValid(id), `Invalid object ID: ${id}`);
     return new DXN(DXN.kind.ECHO, [LOCAL_SPACE_TAG, id]);
   }
 
@@ -179,6 +180,35 @@ export class DXN {
     this.#parts = parts;
   }
 
+  toString(): DXN.String {
+    return `dxn:${this.#kind}:${this.#parts.join(':')}` as DXN.String;
+  }
+
+  toJSON(): string {
+    return this.toString();
+  }
+
+  /**
+   * 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 {
+    const printControlCode = (code: number) => {
+      return `\x1b[${code}m`;
+    };
+
+    return (
+      printControlCode(inspectFn.colors.blueBright![0]) + this.toString() + printControlCode(inspectFn.colors.reset![0])
+    );
+  }
+
+  get [devtoolsFormatter](): DevtoolsFormatter {
+    return {
+      header: () => {
+        return ['span', { style: 'font-weight: bold;' }, this.toString()];
+      },
+    };
+  }
+
   get parts() {
     return this.#parts;
   }
@@ -204,6 +234,7 @@ export class DXN {
 
     const [type, version] = this.#parts;
     return {
+      // TODO(wittjosiah): Should be `typename` for consistency.
       type,
       version: version as string | undefined,
     };
@@ -238,31 +269,6 @@ export class DXN {
       objectId: objectId as string | undefined,
     };
   }
-
-  toString(): DXN.String {
-    return `dxn:${this.#kind}:${this.#parts.join(':')}` as 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 {
-    const printControlCode = (code: number) => {
-      return `\x1b[${code}m`;
-    };
-
-    return (
-      printControlCode(inspectFn.colors.blueBright![0]) + this.toString() + printControlCode(inspectFn.colors.reset![0])
-    );
-  }
-
-  get [devtoolsFormatter](): DevtoolsFormatter {
-    return {
-      header: () => {
-        return ['span', { style: 'font-weight: bold;' }, this.toString()];
-      },
-    };
-  }
 }
 
 // TODO(dmaretskyi): Fluent API:

package/src/index.ts

@@ -7,4 +7,4 @@ export * from './identity-did';
 export * from './object-id';
 export * from './public-key';
 export * from './space-id';
-export * from './types';
+export type * from './types';

package/src/random-bytes.ts

@@ -4,7 +4,7 @@
 
 export const randomBytes = (length: number) => {
   // globalThis.crypto is not available in Node.js when running in vitest even though the documentation says it should be.
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const webCrypto = globalThis.crypto ?? require('node:crypto').webcrypto;
 
   const bytes = new Uint8Array(length);