@evolu/common 8.9.0 → 8.11.0

package/dist/src/Crypto.js

@@ -14,14 +14,44 @@ import { randomBytes, utf8ToBytes } from "@noble/hashes/utils.js";
 import { trySync } from "./Result.js";
 import { brand, length, NonNegativeInt, Uint8Array, zeroNonNegativeInt, } from "./Type.js";
 const Entropy = /*#__PURE__*/ brand("Entropy", Uint8Array);
+/**
+ * Cryptographic entropy of exactly 16 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy16 = /*#__PURE__*/ length(16)(Entropy);
+/**
+ * Cryptographic entropy of exactly 24 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy24 = /*#__PURE__*/ length(24)(Entropy);
+/**
+ * Cryptographic entropy of exactly 32 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy32 = /*#__PURE__*/ length(32)(Entropy);
+/**
+ * Cryptographic entropy of exactly 64 bytes.
+ *
+ * @group Random bytes
+ */
 export const Entropy64 = /*#__PURE__*/ length(64)(Entropy);
+/**
+ * Creates {@link RandomBytes} backed by the platform's secure random number
+ * generator.
+ *
+ * @group Random bytes
+ */
 export const createRandomBytes = () => ({
     create: randomBytes,
 });
-/** Creates seeded random bytes for deterministic tests. */
+/**
+ * Creates seeded random bytes for deterministic tests.
+ *
+ * @group Testing
+ */
 export const testCreateRandomBytes = (deps) => ({
     create: (bytesLength) => globalThis.Uint8Array.from({ length: bytesLength }, () => deps.randomLib.int(0, 255)),
 });
@@ -29,6 +59,8 @@ export const testCreateRandomBytes = (deps) => ({
  * SLIP21.
  *
  * https://github.com/satoshilabs/slips/blob/master/slip-0021.md
+ *
+ * @group Key derivation
  */
 export const createSlip21 = (seed, path) => {
     let currentNode = hmac(sha512, utf8ToBytes("Symmetric key seed"), seed);
@@ -41,6 +73,7 @@ export const createSlip21 = (seed, path) => {
 /**
  * Derives a single node in the SLIP-21 hierarchical key derivation.
  *
+ * @group Key derivation
  * @see {@link createSlip21}
  */
 export const deriveSlip21Node = (label, parentNode) => {
@@ -50,13 +83,22 @@ export const deriveSlip21Node = (label, parentNode) => {
     message.set(labelBytes, 1);
     return hmac(sha512, parentNode.slice(0, 32), message);
 };
-/** The encryption key for symmetric encryption. */
+/**
+ * The encryption key for symmetric encryption.
+ *
+ * @group Encryption
+ */
 export const EncryptionKey = /*#__PURE__*/ brand("EncryptionKey", Entropy32);
-/** 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("XChaCha20Poly1305Ciphertext", Uint8Array);
@@ -89,6 +131,7 @@ export const XChaCha20Poly1305Ciphertext = /*#__PURE__*/ brand("XChaCha20Poly130
  * assertEqual(nonce.length, 24);
  * ```
  *
+ * @group Encryption
  * @see https://github.com/paulmillr/noble-ciphers
  */
 export const encryptWithXChaCha20Poly1305 = (deps) => (plaintext, encryptionKey) => {
@@ -135,6 +178,8 @@ export const encryptWithXChaCha20Poly1305 = (deps) => (plaintext, encryptionKey)
  *
  * assertOk(decryptMessage(), "secret message");
  * ```
+ *
+ * @group Encryption
  */
 export const decryptWithXChaCha20Poly1305 = (ciphertext, nonce, encryptionKey) => trySync(() => xchacha20poly1305(encryptionKey, nonce).decrypt(ciphertext), (error) => ({
     type: "DecryptWithXChaCha20Poly1305Error",
@@ -147,6 +192,8 @@ export const decryptWithXChaCha20Poly1305 = (ciphertext, nonce, encryptionKey) =
  * 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) => {
     if (length <= 0)
@@ -157,7 +204,11 @@ export const createPadmePaddedLength = (length) => {
     const mask = (1 << z) - 1;
     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) => {
     const paddedLength = createPadmePaddedLength(length);
     const paddingLength = NonNegativeInt.orThrow(paddedLength - length);

package/dist/src/Error.d.ts

@@ -29,4 +29,49 @@ export interface UnknownError extends InferType<typeof UnknownError> {
  * non-enumerable. This function extracts those properties into a plain object.
  */
 export declare 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 declare const defectToError: (reported: unknown) => Error;
 //# sourceMappingURL=Error.d.ts.map

package/dist/src/Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,KAAK,SAAS,EAAS,KAAK,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE3E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,CAClC,cAAc,EACd;IAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,OAAO,CAAA;CAAE,CAGlC,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,SAAS,CAAC,OAAO,YAAY,CAAC;CAAG;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,UAAW,OAAO,KAAG,YAkDnD,CAAC"}
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,KAAK,SAAS,EAAS,KAAK,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE3E;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,CAClC,cAAc,EACd;IAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,OAAO,CAAA;CAAE,CAGlC,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,SAAS,CAAC,OAAO,YAAY,CAAC;CAAG;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,UAAW,OAAO,KAAG,YAkDnD,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,aAAa,aAAc,OAAO,KAAG,KAuBjD,CAAC"}

package/dist/src/Error.js

@@ -3,6 +3,8 @@
  *
  * @module
  */
+import { safelyStringifyUnknownValue } from "./String.js";
+import { AbortError } from "./Task.js";
 import { typed, Unknown } from "./Type.js";
 /**
  * A wrapper for unknown errors caught at runtime.
@@ -76,3 +78,70 @@ export const createUnknownError = (error) => {
         }
     }
 };
+/**
+ * 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) => {
+    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;
+        return new Error(`${name}: ${message}`, { cause: defect });
+    }
+    if (defect instanceof Error || tag === "[object Error]") {
+        return defect;
+    }
+    // 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/dist/src/Fs.d.ts

@@ -0,0 +1,376 @@
+/**
+ * File system operations for {@link Task}s.
+ *
+ * {@link Fs} reads, writes, copies, and renames files; lists and manages
+ * directories; and provides metadata and existence checks. Each operation
+ * returns a Task.
+ *
+ * Tasks can sequence file operations without synchronous I/O. Node.js's
+ * synchronous methods are intentionally omitted to avoid accidentally blocking
+ * the event loop.
+ *
+ * Inject {@link @evolu/nodejs!createNodeFs | createNodeFs} through
+ * {@link @evolu/nodejs!runMain | runMain} or {@link createRun}. Tasks declare
+ * {@link FsDep} and access the file system through `run.deps.fs`.
+ *
+ * {@link FsError} includes the path, a diagnostic message, and a
+ * {@link FsErrorReason} such as `NotFound` or `PermissionDenied`.
+ * {@link Fs.exists} returns `false` for `NotFound` and preserves other errors.
+ *
+ * ### Example
+ *
+ * ```ts
+ * import {
+ *   assertEqual,
+ *   ok,
+ *   type FsDep,
+ *   type FsError,
+ *   type Task,
+ * } from "@evolu/common";
+ * import { createNodeFs, runMain } from "@evolu/nodejs";
+ * import { join } from "node:path";
+ *
+ * const main: Task<void, FsError, FsDep> = async (run) => {
+ *   const { fs } = run.deps;
+ *   const temp = await run(
+ *     fs.createTempDirectory({ prefix: "evolu-fs-" }),
+ *   );
+ *   if (!temp.ok) return temp;
+ *
+ *   await using directory = temp.value;
+ *   const path = join(directory.path, "message.txt");
+ *
+ *   const result = await run(fs.writeFile(path, "hello"));
+ *   if (!result.ok) return result;
+ *
+ *   const text = await run(fs.readFile(path, "utf8"));
+ *   if (!text.ok) return text;
+ *   assertEqual(text.value, "hello");
+ *
+ *   return ok();
+ * };
+ *
+ * await runMain({ fs: createNodeFs() }, { mode: "command" })(main);
+ * ```
+ *
+ * @module
+ */
+import type { ByteLength } from "./Bytes.ts";
+import type { Task } from "./Task.ts";
+import type { Typed } from "./Type.ts";
+/**
+ * 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
+     * abort requests cancellation; pending operating system reads may still
+     * finish.
+     */
+    readonly readFile: FsReadFile;
+    /**
+     * Writes a file, creating it or truncating an existing file by default. An
+     * abort requests cancellation and can leave the file partially written or
+     * truncated.
+     */
+    readonly writeFile: (path: FsPath, data: string | Uint8Array, options?: FsWriteFileOptions) => Task<void, FsError>;
+    /**
+     * Lists entry names relative to `path`, in unspecified order. With
+     * `recursive`, includes nested entries with their relative paths.
+     */
+    readonly readDirectory: (path: FsPath, options?: FsReadDirectoryOptions) => Task<ReadonlyArray<string>, FsError>;
+    /**
+     * Creates a directory. Without `recursive`, an existing directory fails with
+     * `AlreadyExists` and a missing parent with `NotFound`.
+     */
+    readonly createDirectory: (path: FsPath, options?: FsCreateDirectoryOptions) => Task<void, FsError>;
+    /**
+     * Copies a file or directory tree using Node's recursive `cp` semantics. By
+     * default, existing directories are merged and files are replaced. Symbolic
+     * links follow Node's rules: `force: false` and `errorOnExist` do not
+     * guarantee that destination links are preserved.
+     *
+     * Copying is neither exclusive nor atomic, and a failure can leave a partial
+     * copy. Use {@link Fs.copyFile} for exclusive creation of a single file.
+     */
+    readonly copy: (source: FsPath, destination: FsPath, options?: FsCopyOptions) => Task<void, FsError>;
+    /**
+     * Copies a single file. An existing destination fails with `AlreadyExists`
+     * unless `overwrite` is enabled. Without overwrite, destination creation is
+     * exclusive even when other copies run concurrently. File contents are not
+     * published atomically; a failure can leave a partial copy.
+     */
+    readonly copyFile: (source: FsPath, destination: FsPath, options?: FsCopyFileOptions) => Task<void, FsError>;
+    /**
+     * Renames or moves a file or directory using the platform's rename semantics.
+     * An existing destination file can be replaced.
+     */
+    readonly rename: (source: FsPath, destination: FsPath) => Task<void, FsError>;
+    /**
+     * Removes a file, or a directory with `recursive`. Removing a directory
+     * without `recursive` fails with `IsDirectory`. With `force`, a missing path
+     * succeeds.
+     */
+    readonly remove: (path: FsPath, options?: FsRemoveOptions) => Task<void, FsError>;
+    /** Reads file metadata, following symbolic links. */
+    readonly getMetadata: (path: FsPath) => Task<FsMetadata, FsError>;
+    /**
+     * Checks whether a path exists. `NotFound` produces `false`; other errors are
+     * returned. A `true` result does not establish read or write permission.
+     */
+    readonly exists: (path: FsPath) => Task<boolean, FsError>;
+    /**
+     * Creates a unique directory in the system temporary directory by default.
+     * Options can specify a parent directory and a name prefix. The returned
+     * resource removes the directory and its contents on disposal. Use `await
+     * using` for cleanup; disposal can throw if removal fails.
+     *
+     * Once started, this operation returns its result even if its Run aborts.
+     */
+    readonly createTempDirectory: (options?: FsCreateTempDirectoryOptions) => Task<FsTempDirectory, FsError>;
+}
+/**
+ * Dependency wrapper for {@link Fs}.
+ *
+ * @group Core
+ */
+export interface FsDep {
+    readonly fs: Fs;
+}
+/**
+ * A file system path, or a `file:` URL.
+ *
+ * @group Core
+ */
+export type FsPath = string | URL;
+/**
+ * Supported text encodings.
+ *
+ * @group Core
+ */
+export type FsEncoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex";
+/**
+ * Supported file opening modes for {@link Fs.writeFile}.
+ *
+ * @group Core
+ */
+export type FsOpenFlag = "a" | "ax" | "a+" | "ax+" | "as" | "as+" | "r" | "r+" | "rs+" | "w" | "wx" | "w+" | "wx+";
+/**
+ * Reads bytes by default, or text when an encoding is specified.
+ *
+ * @group Core
+ */
+export interface FsReadFile {
+    (path: FsPath): Task<Uint8Array, FsError>;
+    (path: FsPath, encoding: FsEncoding | {
+        readonly encoding: FsEncoding;
+    }): Task<string, FsError>;
+}
+/**
+ * Options for {@link Fs.writeFile}.
+ *
+ * @group Options
+ */
+export interface FsWriteFileOptions {
+    /** Encoding of string data. Defaults to `utf8`. */
+    readonly encoding?: FsEncoding;
+    /** File mode of a created file. Defaults to `0o666`. */
+    readonly mode?: number;
+    /** Open flag. Defaults to `w`; use `wx` to fail when the file exists. */
+    readonly flag?: FsOpenFlag;
+}
+/**
+ * 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}.
+ *
+ * @group Options
+ */
+export interface FsCreateDirectoryOptions {
+    /** Creates missing parents and accepts an existing directory. */
+    readonly recursive?: boolean;
+    /** Directory mode. Defaults to `0o777`. */
+    readonly mode?: number;
+}
+/**
+ * Options for {@link Fs.copy}.
+ *
+ * @group Options
+ */
+export interface FsCopyOptions {
+    /**
+     * Node's `force` option. Replaces existing files; `false` skips them unless
+     * `errorOnExist` is enabled. Defaults to `true`. This does not protect
+     * destination symbolic links.
+     */
+    readonly force?: boolean;
+    /**
+     * Node's `errorOnExist` option. With `force: false`, existing files and
+     * directories fail with `AlreadyExists`. Defaults to `false`. Symbolic links
+     * retain Node's behavior and may still be replaced.
+     */
+    readonly errorOnExist?: boolean;
+    /** Preserves access and modification times. Defaults to `false`. */
+    readonly preserveTimestamps?: boolean;
+}
+/**
+ * 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}.
+ *
+ * @group Options
+ */
+export interface FsRemoveOptions {
+    /** Removes directories and their contents. */
+    readonly recursive?: boolean;
+    /** Ignores a missing path. */
+    readonly force?: boolean;
+    /**
+     * Number of retries for `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or `EPERM`
+     * on Node.js. Applies only with `recursive: true`. Defaults to `0`.
+     */
+    readonly maxRetries?: number;
+    /**
+     * Base retry delay in milliseconds. Each retry waits one additional interval.
+     * Applies only with `recursive: true`. Defaults to `100`.
+     */
+    readonly retryDelay?: number;
+}
+/**
+ * File metadata as data, with Node's numeric and timestamp field names.
+ *
+ * @group Core
+ */
+export interface FsMetadata {
+    readonly type: FsEntryType;
+    readonly dev: number;
+    readonly ino: number;
+    readonly mode: number;
+    readonly nlink: number;
+    readonly uid: number;
+    readonly gid: number;
+    readonly rdev: number;
+    readonly size: ByteLength;
+    readonly blksize: number;
+    readonly blocks: number;
+    readonly atimeMs: number;
+    readonly mtimeMs: number;
+    readonly ctimeMs: number;
+    readonly birthtimeMs: number;
+    readonly atime: Date;
+    readonly mtime: Date;
+    readonly ctime: Date;
+    readonly birthtime: Date;
+}
+/**
+ * The kind of file system entry described by {@link FsMetadata}.
+ *
+ * @group Core
+ */
+export type FsEntryType = "File" | "Directory" | "SymbolicLink" | "BlockDevice" | "CharacterDevice" | "FIFO" | "Socket" | "Unknown";
+/**
+ * Options for {@link Fs.createTempDirectory}.
+ *
+ * @group Options
+ */
+export interface FsCreateTempDirectoryOptions {
+    /** Existing parent directory. Defaults to the system temporary directory. */
+    readonly directory?: string;
+    /** Prefix for the directory name. Defaults to an empty string. */
+    readonly prefix?: string;
+}
+/**
+ * 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.
+ *
+ * @group Errors
+ */
+export interface FsError extends Typed<"FsError"> {
+    readonly reason: FsErrorReason;
+    /**
+     * The operation's path, or source for copying and renaming. URL inputs use
+     * their `href`. Temporary directories use the supplied parent if its
+     * resolution fails, or the resolved parent combined with the name prefix if
+     * creation fails.
+     */
+    readonly path: string;
+    /**
+     * Destination for copying and renaming, with URL inputs represented by
+     * `href`.
+     */
+    readonly destination?: string;
+    /** The failing system call, or the method name when the platform reports none. */
+    readonly syscall: string;
+    /** The platform's diagnostic message. */
+    readonly message: string;
+}
+/**
+ * Why a file system operation failed, mapped from the platform's error code.
+ *
+ * @group Errors
+ */
+export type FsErrorReason = "NotFound" | "AlreadyExists" | "PermissionDenied" | "IsDirectory" | "NotDirectory" | "NotEmpty" | "Busy" | "Unknown";
+/**
+ * Creates a test {@link Fs} with the supplied operation overrides.
+ *
+ * Unconfigured operations throw a defect naming the method when their Task
+ * runs. Constructing a Task does not execute it. This helper performs no file
+ * system I/O; overrides provide the behavior needed by each test.
+ *
+ * ### Example
+ *
+ * ```ts
+ * import {
+ *   assertEqual,
+ *   assertOk,
+ *   ok,
+ *   testCreateFs,
+ *   testCreateRun,
+ *   type FsDep,
+ *   type FsError,
+ *   type Task,
+ * } from "@evolu/common";
+ *
+ * const saveMessage: Task<void, FsError, FsDep> = (run) =>
+ *   run(run.deps.fs.writeFile("message.txt", "hello"));
+ *
+ * await using run = testCreateRun({
+ *   fs: testCreateFs({
+ *     writeFile: (path, data) => () => {
+ *       assertEqual(path, "message.txt");
+ *       assertEqual(data, "hello");
+ *       return ok();
+ *     },
+ *   }),
+ * });
+ *
+ * assertOk(await run(saveMessage));
+ * ```
+ *
+ * @group Testing
+ */
+export declare const testCreateFs: (overrides?: Partial<Fs>) => Fs;
+//# sourceMappingURL=Fs.d.ts.map

package/dist/src/Fs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Fs.d.ts","sourceRoot":"","sources":["../../src/Fs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EAAa,IAAI,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAEvC;;;;GAIG;AACH,MAAM,WAAW,EAAE;IACjB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,CAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,EACzB,OAAO,CAAC,EAAE,kBAAkB,KACzB,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,CACtB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,sBAAsB,KAC7B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,CACxB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,wBAAwB,KAC/B,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEzB;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,CACb,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,aAAa,KACpB,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,iBAAiB,KACxB,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAE9E;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,eAAe,KACtB,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEzB,qDAAqD;IACrD,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAElE;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAE1D;;;;;;;OAOG;IACH,QAAQ,CAAC,mBAAmB,EAAE,CAC5B,OAAO,CAAC,EAAE,4BAA4B,KACnC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,OAAO,GACP,MAAM,GACN,OAAO,GACP,SAAS,GACT,UAAU,GACV,MAAM,GACN,OAAO,GACP,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,GAAG,GACH,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,GAAG,GACH,IAAI,GACJ,KAAK,GACL,GAAG,GACH,IAAI,GACJ,IAAI,GACJ,KAAK,CAAC;AAEV;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1C,CACE,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,UAAU,GAAG;QAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,GACvD,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC;IAC/B,wDAAwD;IACxD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,qEAAqE;IACrE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,iEAAiE;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,oEAAoE;IACpE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,kEAAkE;IAClE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,8BAA8B;IAC9B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,WAAW,GACX,cAAc,GACd,aAAa,GACb,iBAAiB,GACjB,MAAM,GACN,QAAQ,GACR,SAAS,CAAC;AAEd;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,6EAA6E;IAC7E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,kEAAkE;IAClE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAQ,SAAQ,KAAK,CAAC,SAAS,CAAC;IAC/C,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,kFAAkF;IAClF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,yCAAyC;IACzC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GACrB,UAAU,GACV,eAAe,GACf,kBAAkB,GAClB,aAAa,GACb,cAAc,GACd,UAAU,GACV,MAAM,GACN,SAAS,CAAC;AAEd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,YAAY,eAAe,OAAO,CAAC,EAAE,CAAC,KAAQ,EAazD,CAAC"}