@dxos/keys 0.8.3 → 0.8.4-main.1068cf700f

package/package.json

@@ -1,21 +1,23 @@
 {
   "name": "@dxos/keys",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1068cf700f",
   "description": "Key utils and definitions.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
   "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
-      "node": {
-        "require": "./dist/lib/node/index.cjs",
-        "default": "./dist/lib/node-esm/index.mjs"
-      },
-      "types": "./dist/types/src/index.d.ts"
+      "node": "./dist/lib/node-esm/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -27,15 +29,18 @@
     "src"
   ],
   "dependencies": {
-    "effect": "3.14.21",
     "ulidx": "^2.3.0",
-    "@dxos/invariant": "0.8.3",
-    "@dxos/debug": "0.8.3",
-    "@dxos/node-std": "0.8.3"
+    "@dxos/debug": "0.8.4-main.1068cf700f",
+    "@dxos/node-std": "0.8.4-main.1068cf700f",
+    "@dxos/invariant": "0.8.4-main.1068cf700f"
   },
   "devDependencies": {
     "base32-decode": "^1.0.0",
-    "base32-encode": "^2.0.0"
+    "base32-encode": "^2.0.0",
+    "effect": "3.19.16"
+  },
+  "peerDependencies": {
+    "effect": "3.19.16"
   },
   "publishConfig": {
     "access": "public"

package/src/dxn.ts

@@ -2,11 +2,12 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
-import type { inspect, InspectOptionsStylized } from 'node:util';
+import type { InspectOptionsStylized, inspect } from 'node:util';
 
-import { devtoolsFormatter, type DevtoolsFormatter, inspectCustom } from '@dxos/debug';
-import { invariant } from '@dxos/invariant';
+import * as Schema from 'effect/Schema';
+
+import { type DevtoolsFormatter, devtoolsFormatter, inspectCustom } from '@dxos/debug';
+import { assertArgument, invariant } from '@dxos/invariant';
 
 import { ObjectId } from './object-id';
 import { SpaceId } from './space-id';
@@ -18,6 +19,8 @@ import { SpaceId } from './space-id';
 // TODO(dmaretskyi): "@" is a separator character in the URI spec.
 export const LOCAL_SPACE_TAG = '@';
 
+export const DXN_ECHO_REGEXP = /@(dxn:[a-zA-Z0-p:@]+)/;
+
 // TODO(burdon): Namespace for.
 export const QueueSubspaceTags = Object.freeze({
   DATA: 'data',
@@ -26,6 +29,12 @@ export const QueueSubspaceTags = Object.freeze({
 
 export type QueueSubspaceTag = (typeof QueueSubspaceTags)[keyof typeof QueueSubspaceTags];
 
+// TODO(burdon): Refactor.
+// Consider: https://github.com/multiformats/multiaddr
+// dxn:echo:[<space-id>:[<queue-id>:]]<object-id>
+// dxn:echo:[S/<space-id>:[Q/<queue-id>:]]<object-id>
+// dxn:type:dxos.org/markdown/Contact
+
 /**
  * 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.
@@ -43,11 +52,12 @@ export type QueueSubspaceTag = (typeof QueueSubspaceTags)[keyof typeof QueueSubs
  * ```
  */
 export class DXN {
+  // TODO(burdon): Rename to DXN (i.e., DXN.DXN).
   // TODO(dmaretskyi): Should this be a transformation into the DXN type?
   static Schema = Schema.NonEmptyString.pipe(
     Schema.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),
     Schema.annotations({
       title: 'DXN',
       description: 'DXN URI',
@@ -64,16 +74,16 @@ export 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',
 
     /**
@@ -85,14 +95,19 @@ export class DXN {
     QUEUE: 'queue',
   });
 
-  get kind() {
-    return this.#kind;
-  }
-
+  /**
+   * Exactly equals.
+   */
   static equals(a: DXN, b: DXN): boolean {
     return a.kind === b.kind && a.parts.length === b.parts.length && a.parts.every((part, i) => part === b.parts[i]);
   }
 
+  static equalsEchoId(a: DXN, b: DXN): boolean {
+    const a1 = a.asEchoDXN();
+    const b1 = b.asEchoDXN();
+    return !!a1 && !!b1 && a1.echoId === b1.echoId;
+  }
+
   // TODO(burdon): Rename isValid.
   static isDXNString(dxn: string): boolean {
     return dxn.startsWith('dxn:');
@@ -119,37 +134,47 @@ export class DXN {
   static tryParse(dxn: string): DXN | undefined {
     try {
       return DXN.parse(dxn);
-    } catch (error) {
+    } catch {
       return undefined;
     }
   }
 
   /**
-   * @example `dxn:type:example.com/type/Contact`
+   * @example `dxn:type:example.com/type/Person`
    */
   static fromTypename(typename: string): DXN {
     return new DXN(DXN.kind.TYPE, [typename]);
   }
 
   /**
-   * @example `dxn:type:example.com/type/Contact:0.1.0`
+   * @example `dxn:type:example.com/type/Person:0.1.0`
    */
   // TODO(dmaretskyi): Consider using @ as the version separator.
   static fromTypenameAndVersion(typename: string, version: string): DXN {
     return new DXN(DXN.kind.TYPE, [typename, version]);
   }
 
+  /**
+   * @example `dxn:echo:BA25QRC2FEWCSAMRP4RZL65LWJ7352CKE:01J00J9B45YHYSGZQTQMSKMGJ6`
+   */
+  static fromSpaceAndObjectId(spaceId: SpaceId, objectId: ObjectId): DXN {
+    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: string): DXN {
+    assertArgument(ObjectId.isValid(id), 'id', `Invalid object ID: ${id}`);
     return new DXN(DXN.kind.ECHO, [LOCAL_SPACE_TAG, id]);
   }
 
   static fromQueue(subspaceTag: QueueSubspaceTag, spaceId: SpaceId, queueId: ObjectId, objectId?: ObjectId) {
-    invariant(SpaceId.isValid(spaceId));
-    invariant(ObjectId.isValid(queueId));
-    invariant(!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, queueId, ...(objectId ? [objectId] : [])]);
   }
@@ -158,19 +183,23 @@ export class DXN {
   #parts: string[];
 
   constructor(kind: string, parts: string[]) {
-    invariant(parts.length > 0);
-    invariant(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}`,
+    );
 
     // Per-type validation.
     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;
     }
@@ -179,6 +208,39 @@ 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 kind() {
+    return this.#kind;
+  }
+
   get parts() {
     return this.#parts;
   }
@@ -189,6 +251,10 @@ export class DXN {
     return this.#parts[0];
   }
 
+  equals(other: DXN): boolean {
+    return DXN.equals(this, other);
+  }
+
   hasTypenameOf(typename: string): boolean {
     return this.#kind === DXN.kind.TYPE && this.#parts.length === 1 && this.#parts[0] === typename;
   }
@@ -204,6 +270,7 @@ export class DXN {
 
     const [type, version] = this.#parts;
     return {
+      // TODO(wittjosiah): Should be `typename` for consistency.
       type,
       version: version as string | undefined,
     };
@@ -217,6 +284,7 @@ export class DXN {
     const [spaceId, echoId] = this.#parts;
     return {
       spaceId: spaceId === LOCAL_SPACE_TAG ? undefined : (spaceId as SpaceId | undefined),
+      // TODO(burdon): objectId.
       echoId,
     };
   }
@@ -232,66 +300,33 @@ export class DXN {
     }
 
     return {
-      subspaceTag,
+      subspaceTag: subspaceTag as QueueSubspaceTag,
       spaceId: spaceId as SpaceId,
       queueId,
       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.
+   * Produces a new DXN with the given parts appended.
    */
-  [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()];
-      },
-    };
+  extend(parts: string[]): DXN {
+    return new DXN(this.#kind, [...this.#parts, ...parts]);
   }
 }
 
-// TODO(dmaretskyi): Fluent API:
-/*
-class DXN {
-  ...
-isEchoDXN(): this is EchoDXN {
-  return this.#kind === DXN.kind.ECHO;
-}
-...
-}
-
-interface EchoDXN extends DXN {
-  objectId: ObjectId;
-}
-
-declare const dxn: DXN;
-
-dxn.objectId
-
-if(dxn.isEchoDXN()) {
-  dxn.objectId
-}
-  ```
-
 /**
  * API namespace.
  */
 export declare namespace DXN {
+  /**
+   * DXN represented as a javascript string.
+   */
+  // TODO(burdon): Use Effect branded string?
+  // export const String = S.String.pipe(S.brand('DXN'));
+  // export type String = S.To(typoeof String);
+  export type String = string & { __DXNString: never };
+
   export type TypeDXN = {
     type: string;
     version?: string;
@@ -299,22 +334,13 @@ export declare namespace DXN {
 
   export type EchoDXN = {
     spaceId?: SpaceId;
-    // TODO(burdon): Rename objectId.
-    echoId: string; // TODO(dmaretskyi): ObjectId.
+    echoId: string; // TODO(dmaretskyi): Rename to `objectId` and use `ObjectId` for the type.
   };
 
   export type QueueDXN = {
-    subspaceTag: string;
+    subspaceTag: QueueSubspaceTag;
     spaceId: SpaceId;
     queueId: string; // TODO(dmaretskyi): ObjectId.
     objectId?: string; // TODO(dmaretskyi): ObjectId.
   };
-
-  /**
-   * 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/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/object-id.ts

@@ -2,23 +2,53 @@
 // Copyright 2025 DXOS.org
 //
 
-import { Schema } from 'effect';
-import { ulid } from 'ulidx';
+import * as Schema from 'effect/Schema';
+import { type PRNG, type ULIDFactory, monotonicFactory } from 'ulidx';
 
 // TODO(dmaretskyi): Make brand.
 // export const ObjectIdBrand: unique symbol = Symbol('@dxos/echo/ObjectId');
 // export const ObjectIdSchema = Schema.ULID.pipe(S.brand(ObjectIdBrand));
 const 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}$',
 });
 
 export type ObjectId = typeof ObjectIdSchema.Type;
 
 export interface ObjectIdClass extends Schema.SchemaClass<ObjectId, string> {
+  /**
+   * @returns true if the string is a valid ObjectId.
+   */
   isValid(id: string): id is ObjectId;
+
+  /**
+   * Creates an ObjectId from a string validating the format.
+   */
   make(id: string): ObjectId;
+
+  /**
+   * Generates a random ObjectId.
+   */
   random(): ObjectId;
+
+  /**
+   * WARNING: To be used only within tests.
+   *
+   * Disables randomness in ObjectId generation, causing the same sequence of IDs to be generated.
+   * Do not use in production code as this will cause data collisions.
+   * Place this at the top of the test file to ensure that the same sequence of IDs is generated.
+   *
+   * ```ts
+   * ObjectId.dangerouslyDisableRandomness();
+   *
+   * describe('suite', () => {
+   *   // ...
+   * });
+   * ```
+   *
+   * NOTE: The generated IDs depend on the order of ObjectId.random() calls, which might be affected by test order, scheduling, etc.
+   */
+  dangerouslyDisableRandomness(): void;
 }
 
 /**
@@ -27,16 +57,75 @@ export interface ObjectIdClass extends Schema.SchemaClass<ObjectId, string> {
  * Follows ULID spec.
  */
 export const ObjectId: ObjectIdClass = class extends ObjectIdSchema {
+  static #factory: ULIDFactory = monotonicFactory();
+  static #seedTime: number | undefined = undefined;
+
   static isValid(id: string): id is ObjectId {
     try {
       Schema.decodeSync(ObjectId)(id);
       return true;
-    } catch (err) {
+    } catch {
       return false;
     }
   }
 
   static random(): ObjectId {
-    return ulid() as ObjectId;
+    return this.#factory(this.#seedTime) as ObjectId;
+  }
+
+  static dangerouslyDisableRandomness() {
+    this.#factory = monotonicFactory(makeTestPRNG());
+    this.#seedTime = new Date('2025-01-01').getTime();
   }
 };
+
+/**
+ * Test PRNG that always starts with the same seed and produces the same sequence.
+ */
+const makeTestPRNG = (): PRNG => {
+  const rng = new SimplePRNG();
+  return () => {
+    return rng.next();
+  };
+};
+
+/**
+ * Simple Linear Congruential Generator (LCG) for pseudo-random number generation.
+ * Returns numbers in the range [0, 1) (0 inclusive, 1 exclusive).
+ */
+export class SimplePRNG {
+  #seed: number;
+
+  // LCG parameters (from Numerical Recipes)
+  static readonly #a = 1664525;
+  static readonly #c = 1013904223;
+  static readonly #m = Math.pow(2, 32);
+
+  /**
+   * Creates a new PRNG instance.
+   * @param seed - Initial seed value. If not provided, uses 0.
+   */
+  constructor(seed: number = 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(): number {
+    // Update seed using LCG formula: (a * seed + c) mod m
+    this.#seed = (SimplePRNG.#a * this.#seed + SimplePRNG.#c) % SimplePRNG.#m;
+
+    // Normalize to [0, 1) range
+    return this.#seed / SimplePRNG.#m;
+  }
+
+  /**
+   * Resets the generator with a new seed.
+   * @param seed - New seed value.
+   */
+  reset(seed: number): void {
+    this.#seed = seed;
+  }
+}

package/src/prng.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+/**
+ * Simple Linear Congruential Generator (LCG) for pseudo-random number generation.
+ * Returns numbers in the range [0, 1) (0 inclusive, 1 exclusive).
+ */
+export class SimplePRNG {
+  private _seed: number;
+
+  // LCG parameters (from Numerical Recipes)
+  private static readonly _a = 1664525;
+  private static readonly _c = 1013904223;
+  private static readonly _m = Math.pow(2, 32);
+
+  /**
+   * Creates a new PRNG instance.
+   * @param seed - Initial seed value. If not provided, uses current timestamp.
+   */
+  constructor(seed?: number) {
+    this._seed = seed ?? Date.now();
+  }
+
+  /**
+   * Generates the next pseudo-random number in the range [0, 1).
+   * @returns A pseudo-random number between 0 (inclusive) and 1 (exclusive).
+   */
+  next(): number {
+    // Update seed using LCG formula: (a * seed + c) mod m
+    this._seed = (SimplePRNG._a * this._seed + SimplePRNG._c) % SimplePRNG._m;
+
+    // Normalize to [0, 1) range
+    return this._seed / SimplePRNG._m;
+  }
+
+  /**
+   * Resets the generator with a new seed.
+   * @param seed - New seed value.
+   */
+  reset(seed: number): void {
+    this._seed = seed;
+  }
+}
+
+/**
+ * Creates a simple PRNG function with optional seed.
+ * @param seed - Optional seed value.
+ * @returns A function that returns pseudo-random numbers in [0, 1).
+ */
+export const createPRNG = (seed?: number): (() => number) => {
+  const prng = new SimplePRNG(seed);
+  return () => prng.next();
+};

package/src/public-key.ts

@@ -2,15 +2,16 @@
 // Copyright 2020 DXOS.org
 //
 
+import { type InspectOptionsStylized, type inspect } from 'node:util';
+
 import base32Decode from 'base32-decode';
 import base32Encode from 'base32-encode';
-import { type inspect, type InspectOptionsStylized } from 'node:util';
 
 import {
-  devtoolsFormatter,
   type DevtoolsFormatter,
-  equalsSymbol,
   type Equatable,
+  devtoolsFormatter,
+  equalsSymbol,
   inspectCustom,
   truncateKey,
 } from '@dxos/debug';

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);

package/src/space-id.ts

@@ -4,7 +4,7 @@
 
 import base32Decode from 'base32-decode';
 import base32Encode from 'base32-encode';
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 
 import { invariant } from '@dxos/invariant';
 
@@ -17,7 +17,7 @@ const MULTIBASE_PREFIX = 'B';
 
 const ENCODED_LENGTH = 33;
 
-const isValid = (value: string): value is SpaceId => {
+const isValid = (value: unknown): value is SpaceId => {
   return typeof value === 'string' && value.startsWith(MULTIBASE_PREFIX) && value.length === ENCODED_LENGTH;
 };
 
@@ -33,7 +33,7 @@ export const SpaceId: Schema.Schema<SpaceId, string> & {
   byteLength: number;
   encode: (value: Uint8Array) => SpaceId;
   decode: (value: SpaceId) => Uint8Array;
-  isValid: (value: string) => value is SpaceId;
+  isValid: (value: unknown) => value is SpaceId;
   make: (value: string) => SpaceId;
   random: () => SpaceId;
 } = class extends Schema.String.pipe(Schema.filter(isValid)) {