@evolu/common 8.10.0 → 8.12.0

package/src/Crypto.ts

@@ -24,6 +24,11 @@ import {
   zeroNonNegativeInt,
 } from "./Type.ts";
 
+/**
+ * Cryptographically secure random bytes with length-branded results.
+ *
+ * @group Random bytes
+ */
 export interface RandomBytes {
   /**
    * Creates cryptographically secure random bytes with type-safe length
@@ -77,6 +82,11 @@ export interface RandomBytes {
   create(bytesLength: number): Entropy;
 }
 
+/**
+ * Dependency wrapper for {@link RandomBytes}.
+ *
+ * @group Random bytes
+ */
 export interface RandomBytesDep {
   readonly randomBytes: RandomBytes;
 }
@@ -84,23 +94,53 @@ export interface RandomBytesDep {
 const Entropy = /*#__PURE__*/ brand("Entropy", Uint8Array);
 type Entropy = typeof Entropy.Output;
 
+/**
+ * Cryptographic entropy of exactly 16 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy16 = /*#__PURE__*/ length(16)(Entropy);
 export type Entropy16 = typeof Entropy16.Output;
 
+/**
+ * Cryptographic entropy of exactly 24 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy24 = /*#__PURE__*/ length(24)(Entropy);
 export type Entropy24 = typeof Entropy24.Output;
 
+/**
+ * Cryptographic entropy of exactly 32 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy32 = /*#__PURE__*/ length(32)(Entropy);
 export type Entropy32 = typeof Entropy32.Output;
 
+/**
+ * Cryptographic entropy of exactly 64 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy64 = /*#__PURE__*/ length(64)(Entropy);
 export type Entropy64 = typeof Entropy64.Output;
 
+/**
+ * Creates {@link RandomBytes} backed by the platform's secure random number
+ * generator.
+ *
+ * @group Random bytes
+ */
 export const createRandomBytes = (): RandomBytes => ({
   create: randomBytes as RandomBytes["create"],
 });
 
-/** Creates seeded random bytes for deterministic tests. */
+/**
+ * Creates seeded random bytes for deterministic tests.
+ *
+ * @group Testing
+ */
 export const testCreateRandomBytes = (deps: RandomLibDep): RandomBytes =>
   ({
     create: (bytesLength: number) =>
@@ -113,6 +153,8 @@ export const testCreateRandomBytes = (deps: RandomLibDep): RandomBytes =>
  * SLIP21.
  *
  * https://github.com/satoshilabs/slips/blob/master/slip-0021.md
+ *
+ * @group Key derivation
  */
 export const createSlip21 = (
   seed: Entropy16 | Entropy32 | Entropy64,
@@ -135,6 +177,7 @@ export const createSlip21 = (
 /**
  * Derives a single node in the SLIP-21 hierarchical key derivation.
  *
+ * @group Key derivation
  * @see {@link createSlip21}
  */
 export const deriveSlip21Node = (
@@ -148,16 +191,25 @@ export const deriveSlip21Node = (
   return hmac(sha512, parentNode.slice(0, 32), message) as Entropy64;
 };
 
-/** The encryption key for symmetric encryption. */
+/**
+ * The encryption key for symmetric encryption.
+ *
+ * @group Encryption
+ */
 export const EncryptionKey = /*#__PURE__*/ brand("EncryptionKey", Entropy32);
 export type EncryptionKey = typeof EncryptionKey.Output;
 
-/** The nonce length for XChaCha20-Poly1305 encryption. */
+/**
+ * The nonce length for XChaCha20-Poly1305 encryption.
+ *
+ * @group Encryption
+ */
 export const xChaCha20Poly1305NonceLength = 24;
 
 /**
  * Branded Uint8Array for XChaCha20-Poly1305 encryption.
  *
+ * @group Encryption
  * @see {@link encryptWithXChaCha20Poly1305}
  */
 export const XChaCha20Poly1305Ciphertext = /*#__PURE__*/ brand(
@@ -196,6 +248,7 @@ export type XChaCha20Poly1305Ciphertext =
  * assertEqual(nonce.length, 24);
  * ```
  *
+ * @group Encryption
  * @see https://github.com/paulmillr/noble-ciphers
  */
 export const encryptWithXChaCha20Poly1305 =
@@ -211,6 +264,11 @@ export const encryptWithXChaCha20Poly1305 =
     return [ciphertext, nonce];
   };
 
+/**
+ * Error returned by {@link decryptWithXChaCha20Poly1305} when decryption fails.
+ *
+ * @group Encryption
+ */
 export interface DecryptWithXChaCha20Poly1305Error extends Typed<"DecryptWithXChaCha20Poly1305Error"> {
   readonly error: unknown;
 }
@@ -254,6 +312,8 @@ export interface DecryptWithXChaCha20Poly1305Error extends Typed<"DecryptWithXCh
  *
  * assertOk(decryptMessage(), "secret message");
  * ```
+ *
+ * @group Encryption
  */
 export const decryptWithXChaCha20Poly1305 = (
   ciphertext: XChaCha20Poly1305Ciphertext,
@@ -275,6 +335,8 @@ export const decryptWithXChaCha20Poly1305 = (
  * wide range of encrypted data sizes.
  *
  * See the PURBs paper for details: https://bford.info/pub/sec/purb.pdf
+ *
+ * @group Padding
  */
 export const createPadmePaddedLength = (
   length: NonNegativeInt,
@@ -287,7 +349,11 @@ export const createPadmePaddedLength = (
   return NonNegativeInt.orThrow((length + mask) & ~mask);
 };
 
-/** Creates a PADMÉ padding array of zeros for the given input length. */
+/**
+ * Creates a PADMÉ padding array of zeros for the given input length.
+ *
+ * @group Padding
+ */
 export const createPadmePadding = (length: NonNegativeInt): Uint8Array => {
   const paddedLength = createPadmePaddedLength(length);
   const paddingLength = NonNegativeInt.orThrow(paddedLength - length);
@@ -299,10 +365,16 @@ export const createPadmePadding = (length: NonNegativeInt): Uint8Array => {
  * are equal, false otherwise. Takes constant time regardless of where the
  * arrays differ.
  *
+ * @group Comparison
  * @see https://nodejs.org/api/crypto.html#cryptotimingsafeequala-b
  */
 export type TimingSafeEqual = (a: Uint8Array, b: Uint8Array) => boolean;
 
+/**
+ * Dependency wrapper for {@link TimingSafeEqual}.
+ *
+ * @group Comparison
+ */
 export interface TimingSafeEqualDep {
   readonly timingSafeEqual: TimingSafeEqual;
 }

package/src/Eq.test.ts

@@ -293,13 +293,12 @@ test("eqData", () => {
   }
   const service: Service = { run: () => undefined };
   const broadObject: NonNullable<unknown> = new WeakMap();
-  const compileTimeAssertions = () => {
+  void (() => {
     // @ts-expect-error ⛔ eqData error: Actual and expected values must consist only of Data.
     eqData(service, service);
     // @ts-expect-error ⛔ eqData error: Actual and expected values must consist only of Data.
     eqData(broadObject, broadObject);
-  };
-  assertEqual(typeof compileTimeAssertions, "function");
+  });
 });
 
 test("eqData compares deeply nested Set and Map data", () => {

package/src/Error.test.ts

@@ -1,7 +1,15 @@
 import { describe, it } from "node:test";
-import { assertEqual, assertFalse, assertSame, assertTrue } from "./Assert.ts";
-
-import { UnknownError, createUnknownError } from "./Error.ts";
+import { runInNewContext } from "node:vm";
+import {
+  assertEqual,
+  assertFalse,
+  assertInstanceOf,
+  assertSame,
+  assertTrue,
+} from "./Assert.ts";
+
+import { UnknownError, createUnknownError, defectToError } from "./Error.ts";
+import { createRun } from "./Task.ts";
 import { assertType, Object, String } from "./Type.ts";
 
 describe("createUnknownError", () => {
@@ -116,3 +124,68 @@ describe("createUnknownError", () => {
     assertSame(actual.self, actual);
   });
 });
+
+describe("defectToError", () => {
+  it("converts a panic to its Error defect", async () => {
+    const reported: Array<unknown> = [];
+    await using run = createRun({
+      reportDefect: (defect) => {
+        reported.push(defect);
+      },
+    });
+    const defect = new Error("boom");
+
+    run.panic(defect);
+
+    assertSame(defectToError(reported[0]), defect);
+  });
+
+  it("returns an Error from another realm as it is", () => {
+    const defect: unknown = runInNewContext(
+      'new TypeError("other realm failed")',
+    );
+    assertFalse(defect instanceof Error);
+
+    assertSame(defectToError(defect), defect);
+  });
+
+  it("describes a DOMException with its name and message", () => {
+    const defect = new DOMException("dom failed", "NotFoundError");
+
+    const error = defectToError(defect);
+
+    assertEqual(error.message, "NotFoundError: dom failed");
+    assertSame(error.cause, defect);
+  });
+
+  it("describes a panic's defect that is not an Error", async () => {
+    const reported: Array<unknown> = [];
+    await using run = createRun({
+      reportDefect: (defect) => {
+        reported.push(defect);
+      },
+    });
+
+    const abortError = run.panic({ type: "UnexpectedState", count: 1 });
+
+    const error = defectToError(reported[0]);
+    assertInstanceOf(error, Error);
+    assertEqual(error.message, 'Defect: {"type":"UnexpectedState","count":1}');
+    assertSame(error.cause, abortError);
+  });
+
+  it("describes an AbortError that is not a panic", () => {
+    const abortError = {
+      type: "AbortError",
+      reason: { type: "OtherAbortReason" },
+    } as const;
+
+    const error = defectToError(abortError);
+
+    assertEqual(
+      error.message,
+      'Defect: {"type":"AbortError","reason":{"type":"OtherAbortReason"}}',
+    );
+    assertSame(error.cause, abortError);
+  });
+});

package/src/Error.ts

@@ -4,6 +4,8 @@
  * @module
  */
 
+import { safelyStringifyUnknownValue } from "./String.ts";
+import { AbortError, type createRun, type ReportDefect } from "./Task.ts";
 import { type InferType, typed, type TypedType, Unknown } from "./Type.ts";
 
 /**
@@ -84,3 +86,72 @@ export const createUnknownError = (error: unknown): UnknownError => {
     }
   }
 };
+
+/**
+ * Converts a reported defect to an `Error` that a host error reporter shows
+ * readably.
+ *
+ * Hosts such as browsers and React Native show a reported value that is not an
+ * `Error` only as text such as "[object Object]", and a worker's error reaches
+ * its page, including an error tracker listening there, as that text alone. A
+ * panic reports a plain {@link AbortError}, so its defect is converted instead.
+ * An `Error` is returned as it is, including one from another realm, such as an
+ * iframe. A `DOMException` is described in an `Error` with its name and
+ * message, because Chromium reports one from a worker without them. Any other
+ * value is described in an `Error` whose cause is what was reported.
+ *
+ * Platform {@link createRun} adapters use it for their default reporting. A
+ * custom {@link ReportDefect} can use it too, such as before passing a defect to
+ * an error tracker.
+ *
+ * ### Example
+ *
+ * ```ts
+ * import {
+ *   assertEqual,
+ *   assertSame,
+ *   createRun,
+ *   defectToError,
+ * } from "@evolu/common";
+ *
+ * const errors: Array<Error> = [];
+ * await using run = createRun({
+ *   reportDefect: (reported) => {
+ *     errors.push(defectToError(reported));
+ *   },
+ * });
+ * const defect = new Error("boom");
+ *
+ * run.panic(defect);
+ *
+ * assertSame(errors[0], defect);
+ * assertEqual(
+ *   defectToError({ type: "UnexpectedState" }).message,
+ *   'Defect: {"type":"UnexpectedState"}',
+ * );
+ * ```
+ */
+export const defectToError = (reported: unknown): Error => {
+  const defect =
+    AbortError.is(reported) && reported.reason.type === "PanicAbortReason"
+      ? reported.reason.defect
+      : reported;
+  // The internal tag survives crossing realms, such as from an iframe, where
+  // instanceof fails.
+  const tag = Object.prototype.toString.call(defect);
+  // Chromium reports a DOMException from a worker without its name or message,
+  // so it is described in an Error.
+  if (tag === "[object DOMException]") {
+    const { name, message } = defect as Error;
+    return new Error(`${name}: ${message}`, { cause: defect });
+  }
+  if (defect instanceof Error || tag === "[object Error]") {
+    return defect as Error;
+  }
+  // A value with a cycle or a bigint falls back to String, often
+  // "[object Object]", and a nested Error shows as "{}". That is enough:
+  // Evolu's own defects are Errors, and the cause still holds the value.
+  return new Error(`Defect: ${safelyStringifyUnknownValue(defect)}`, {
+    cause: reported,
+  });
+};

package/src/Fs.ts

@@ -60,7 +60,11 @@ import type { ByteLength } from "./Bytes.ts";
 import type { createRun, Task } from "./Task.ts";
 import type { Typed } from "./Type.ts";
 
-/** Asynchronous file system operations. */
+/**
+ * Asynchronous file system operations.
+ *
+ * @group Core
+ */
 export interface Fs {
   /**
    * Reads a whole file, as bytes by default or as a string with an encoding. An
@@ -163,15 +167,27 @@ export interface Fs {
   ) => Task<FsTempDirectory, FsError>;
 }
 
-/** Dependency wrapper for {@link Fs}. */
+/**
+ * Dependency wrapper for {@link Fs}.
+ *
+ * @group Core
+ */
 export interface FsDep {
   readonly fs: Fs;
 }
 
-/** A file system path, or a `file:` URL. */
+/**
+ * A file system path, or a `file:` URL.
+ *
+ * @group Core
+ */
 export type FsPath = string | URL;
 
-/** Supported text encodings. */
+/**
+ * Supported text encodings.
+ *
+ * @group Core
+ */
 export type FsEncoding =
   | "ascii"
   | "utf8"
@@ -186,7 +202,11 @@ export type FsEncoding =
   | "binary"
   | "hex";
 
-/** Supported file opening modes for {@link Fs.writeFile}. */
+/**
+ * Supported file opening modes for {@link Fs.writeFile}.
+ *
+ * @group Core
+ */
 export type FsOpenFlag =
   | "a"
   | "ax"
@@ -202,7 +222,11 @@ export type FsOpenFlag =
   | "w+"
   | "wx+";
 
-/** Reads bytes by default, or text when an encoding is specified. */
+/**
+ * Reads bytes by default, or text when an encoding is specified.
+ *
+ * @group Core
+ */
 export interface FsReadFile {
   (path: FsPath): Task<Uint8Array, FsError>;
   (
@@ -211,7 +235,11 @@ export interface FsReadFile {
   ): Task<string, FsError>;
 }
 
-/** Options for {@link Fs.writeFile}. */
+/**
+ * Options for {@link Fs.writeFile}.
+ *
+ * @group Options
+ */
 export interface FsWriteFileOptions {
   /** Encoding of string data. Defaults to `utf8`. */
   readonly encoding?: FsEncoding;
@@ -221,13 +249,21 @@ export interface FsWriteFileOptions {
   readonly flag?: FsOpenFlag;
 }
 
-/** Options for {@link Fs.readDirectory}. */
+/**
+ * Options for {@link Fs.readDirectory}.
+ *
+ * @group Options
+ */
 export interface FsReadDirectoryOptions {
   /** Includes entries from nested directories. Defaults to `false`. */
   readonly recursive?: boolean;
 }
 
-/** Options for {@link Fs.createDirectory}. */
+/**
+ * Options for {@link Fs.createDirectory}.
+ *
+ * @group Options
+ */
 export interface FsCreateDirectoryOptions {
   /** Creates missing parents and accepts an existing directory. */
   readonly recursive?: boolean;
@@ -235,7 +271,11 @@ export interface FsCreateDirectoryOptions {
   readonly mode?: number;
 }
 
-/** Options for {@link Fs.copy}. */
+/**
+ * Options for {@link Fs.copy}.
+ *
+ * @group Options
+ */
 export interface FsCopyOptions {
   /**
    * Node's `force` option. Replaces existing files; `false` skips them unless
@@ -253,13 +293,21 @@ export interface FsCopyOptions {
   readonly preserveTimestamps?: boolean;
 }
 
-/** Options for {@link Fs.copyFile}. */
+/**
+ * Options for {@link Fs.copyFile}.
+ *
+ * @group Options
+ */
 export interface FsCopyFileOptions {
   /** Replaces an existing destination file. Defaults to `false`. */
   readonly overwrite?: boolean;
 }
 
-/** Options for {@link Fs.remove}. */
+/**
+ * Options for {@link Fs.remove}.
+ *
+ * @group Options
+ */
 export interface FsRemoveOptions {
   /** Removes directories and their contents. */
   readonly recursive?: boolean;
@@ -277,7 +325,11 @@ export interface FsRemoveOptions {
   readonly retryDelay?: number;
 }
 
-/** File metadata as data, with Node's numeric and timestamp field names. */
+/**
+ * File metadata as data, with Node's numeric and timestamp field names.
+ *
+ * @group Core
+ */
 export interface FsMetadata {
   readonly type: FsEntryType;
   readonly dev: number;
@@ -300,7 +352,11 @@ export interface FsMetadata {
   readonly birthtime: Date;
 }
 
-/** The kind of file system entry described by {@link FsMetadata}. */
+/**
+ * The kind of file system entry described by {@link FsMetadata}.
+ *
+ * @group Core
+ */
 export type FsEntryType =
   | "File"
   | "Directory"
@@ -311,7 +367,11 @@ export type FsEntryType =
   | "Socket"
   | "Unknown";
 
-/** Options for {@link Fs.createTempDirectory}. */
+/**
+ * Options for {@link Fs.createTempDirectory}.
+ *
+ * @group Options
+ */
 export interface FsCreateTempDirectoryOptions {
   /** Existing parent directory. Defaults to the system temporary directory. */
   readonly directory?: string;
@@ -319,12 +379,20 @@ export interface FsCreateTempDirectoryOptions {
   readonly prefix?: string;
 }
 
-/** A temporary directory removed, with its contents, on asynchronous disposal. */
+/**
+ * A temporary directory removed, with its contents, on asynchronous disposal.
+ *
+ * @group Core
+ */
 export interface FsTempDirectory extends AsyncDisposable {
   readonly path: string;
 }
 
-/** A failed file system operation. */
+/**
+ * A failed file system operation.
+ *
+ * @group Errors
+ */
 export interface FsError extends Typed<"FsError"> {
   readonly reason: FsErrorReason;
   /**
@@ -345,7 +413,11 @@ export interface FsError extends Typed<"FsError"> {
   readonly message: string;
 }
 
-/** Why a file system operation failed, mapped from the platform's error code. */
+/**
+ * Why a file system operation failed, mapped from the platform's error code.
+ *
+ * @group Errors
+ */
 export type FsErrorReason =
   | "NotFound"
   | "AlreadyExists"
@@ -392,6 +464,8 @@ export type FsErrorReason =
  *
  * assertOk(await run(saveMessage));
  * ```
+ *
+ * @group Testing
  */
 export const testCreateFs = (overrides: Partial<Fs> = {}): Fs => ({
   readFile: createUnexpectedFsOperation("readFile"),

package/src/Identicon.ts

@@ -37,6 +37,7 @@ export type IdenticonStyle = "github" | "quadrant" | "gradient" | "sutnar";
  *   assertTrue,
  *   createIdFromString,
  *   createIdenticon,
+ *   testTodoId,
  * } from "@evolu/common";
  *
  * const id = createIdFromString("identicon-example");
@@ -47,8 +48,7 @@ export type IdenticonStyle = "github" | "quadrant" | "gradient" | "sutnar";
  * );
  *
  * // Branded IDs work too.
- * const todoId = createIdFromString<"Todo">("todo-1");
- * const todoSvg = createIdenticon(todoId);
+ * const todoSvg = createIdenticon(testTodoId);
  *
  * assertTrue(svg.startsWith("<svg"));
  * assertEqual(new Set([svg, ...alternativeSvgs]).size, 4);

package/src/LeakDetector.ts

@@ -22,6 +22,8 @@ import { constVoid } from "./Function.ts";
  * a warning may come late or, in short-lived processes, never. It is a
  * development canary, not a guarantee. Production uses
  * {@link noopLeakDetector}.
+ *
+ * @group Core
  */
 export interface LeakDetector {
   /**
@@ -38,7 +40,11 @@ export interface LeakDetector {
   readonly untrack: (unregisterToken: object) => void;
 }
 
-/** Describes a tracked handle for {@link LeakDetector.track}. */
+/**
+ * Describes a tracked handle for {@link LeakDetector.track}.
+ *
+ * @group Core
+ */
 export interface Leak {
   /** Handle name used in the warning, for example `"Lease"`. */
   readonly name: string;
@@ -50,6 +56,7 @@ export interface Leak {
 /**
  * Dependency wrapper for {@link LeakDetector}.
  *
+ * @group Core
  * @see {@link LeakDetector}
  */
 export interface LeakDetectorDep {
@@ -61,6 +68,8 @@ export interface LeakDetectorDep {
  *
  * Capturing a stack per track call is too expensive for production; use
  * {@link noopLeakDetector} there.
+ *
+ * @group Core
  */
 export const createLeakDetector = (deps: ConsoleDep): LeakDetector => {
   if (typeof globalThis.FinalizationRegistry !== "function")
@@ -86,7 +95,11 @@ export const createLeakDetector = (deps: ConsoleDep): LeakDetector => {
   };
 };
 
-/** No-op {@link LeakDetector} for production. */
+/**
+ * No-op {@link LeakDetector} for production.
+ *
+ * @group Core
+ */
 export const noopLeakDetector: LeakDetector = {
   track: constVoid,
   untrack: constVoid,
@@ -118,6 +131,7 @@ const reportLeak =
 /**
  * Test {@link LeakDetector} with deterministic collection.
  *
+ * @group Testing
  * @see {@link testCreateLeakDetector}
  */
 export interface TestLeakDetector extends LeakDetector {
@@ -136,13 +150,18 @@ export interface TestLeakDetector extends LeakDetector {
 /**
  * Dependency wrapper for {@link TestLeakDetector}.
  *
+ * @group Testing
  * @see {@link TestLeakDetector}
  */
 export interface TestLeakDetectorDep extends LeakDetectorDep {
   readonly leakDetector: TestLeakDetector;
 }
 
-/** Creates {@link TestLeakDetector}. */
+/**
+ * Creates {@link TestLeakDetector}.
+ *
+ * @group Testing
+ */
 export const testCreateLeakDetector = (deps: ConsoleDep): TestLeakDetector => {
   const trackedLeaksByToken = new Map<object, ReadonlyArray<TrackedLeak>>();
   const report = reportLeak(deps);