@evolu/common 8.0.0-next.4 → 8.0.0

package/dist/src/local-first/Evolu.d.ts

@@ -3,21 +3,20 @@
  *
  * @module
  */
-import { type NonEmptyReadonlyArray } from "../Array.js";
-import type { ConsoleDep } from "../Console.js";
-import { type LockManagerDep } from "../LockManager.js";
-import type { FlushSyncDep, ReloadAppDep } from "../Platform.js";
-import type { Listener, ReadonlyStore, Unsubscribe } from "../Store.js";
-import { type Task } from "../Task.js";
-import type { TypeError } from "../Type.js";
-import { Name } from "../Type.js";
-import type { CreateBroadcastChannelDep, CreateMessageChannelDep } from "../Worker.js";
-import type { CreateDbWorkerDep } from "./Db.js";
-import type { EvoluError } from "./Error.js";
-import type { AppOwner, Owner, OwnerTransport, ReadonlyOwner } from "./Owner.js";
-import type { Queries, QueriesToQueryRowsPromises, Query, QueryRows, Row } from "./Query.js";
-import type { EvoluSchema, IndexesConfig, Mutation, ValidateSchema } from "./Schema.js";
-import type { SharedWorkerDep } from "./Shared.js";
+import { type NonEmptyReadonlyArray } from "../Array.ts";
+import type { ConsoleDep } from "../Console.ts";
+import { type LockManagerDep } from "../LockManager.ts";
+import type { FlushSyncDep, ReloadAppDep } from "../Platform.ts";
+import type { Listener, ReadonlyStore, Unsubscribe } from "../Store.ts";
+import type { Task } from "../Task.ts";
+import { Name, type TypeError, UrlSafeString } from "../Type.ts";
+import type { CreateBroadcastChannelDep, CreateMessageChannelDep } from "../Worker.ts";
+import type { CreateDbWorkerDep } from "./Db.ts";
+import type { EvoluError } from "./Error.ts";
+import type { AppOwner, Owner, OwnerTransport, ReadonlyOwner } from "./Owner.ts";
+import type { Queries, QueriesToQueryRowsPromises, Query, QueryRows, Row } from "./Query.ts";
+import type { EvoluSchema, IndexesConfig, Mutation, ValidateSchema } from "./Schema.ts";
+import type { SharedWorkerDep } from "./Shared.ts";
 export interface EvoluConfig {
     /**
      * The app name. Evolu is multitenant - it can run multiple instances
@@ -33,27 +32,30 @@ export interface EvoluConfig {
      * ### Example
      *
      * ```ts
-     * // appName: AppName.orThrow("MyApp")
+     * import { AppName } from "@evolu/common";
+     *
+     * const appName = AppName.orThrow("MyApp");
+     * expect(appName).toBe("MyApp");
      * ```
      */
     readonly appName: AppName;
     /**
      * {@link AppOwner} used to create this {@link Evolu} instance.
      *
-     * Exposed as {@link Evolu.appOwner}. If `appOwner` is not passed, Evolu
-     * creates one.
+     * Exposed as {@link Evolu.appOwner}. Create an AppOwner before the first run,
+     * or restore one from secure storage before creating Evolu.
      *
      * AppOwner controls access to the encrypted local SQLite database. If its
      * secret material (Owner secret / Mnemonic) is not stored safely, data
      * written by that instance is permanently inaccessible.
      *
-     * Best onboarding UX is accountless first use: let users try a ready-to-use
-     * app, then prompt backup of `evolu.appOwner`.
+     * Best onboarding UX is accountless first use: create an AppOwner, let users
+     * try a ready-to-use app, then prompt backup of `evolu.appOwner`.
      *
      * Recommended usage:
      *
-     * - Omit `appOwner` for first run, then persist `evolu.appOwner` after user
-     *   activity and guide the user to back it up.
+     * - Create and persist an `appOwner` for first run, then guide the user to back
+     *   it up after user activity.
      * - Pass `appOwner` restored from secure storage (for example, Expo
      *   SecureStore, WebAuthn-backed storage, or app-managed account recovery
      *   flow).
@@ -89,33 +91,51 @@ export interface EvoluConfig {
      *
      * The default value is:
      *
-     * `{ type: "WebSocket", url: "wss://free.evoluhq.com" }`.
+     * `[{ type: "WebSocket", url: "wss://free.evoluhq.com" }]`.
      *
      * ### Example
      *
      * ```ts
-     * // Single WebSocket relay
-     * transports: [{ type: "WebSocket", url: "wss://relay1.example.com" }];
+     * import {
+     *   createAppOwner,
+     *   createOwnerWebSocketTransport,
+     *   createOwnerSecret,
+     *   createRandomBytes,
+     *   type OwnerTransport,
+     * } from "@evolu/common";
+     *
+     * // Create once, persist the mnemonic securely, and restore it on later runs.
+     * const appOwner = createAppOwner(
+     *   createOwnerSecret({ randomBytes: createRandomBytes() }),
+     * );
+     *
+     * // Use one relay.
+     * const singleRelay = [
+     *   { type: "WebSocket", url: "wss://relay1.example.com" },
+     * ] satisfies ReadonlyArray<OwnerTransport>;
      *
-     * // Multiple WebSocket relays for redundancy
-     * transports: [
+     * // Use independent relays for redundancy.
+     * const redundantRelays = [
      *   { type: "WebSocket", url: "wss://relay1.example.com" },
      *   { type: "WebSocket", url: "wss://relay2.example.com" },
-     *   { type: "WebSocket", url: "wss://relay3.example.com" },
-     * ];
+     * ] satisfies ReadonlyArray<OwnerTransport>;
      *
-     * // Local-only instance (no sync) - useful for device settings or when relay
-     * // URL will be provided later (e.g., after authentication), allowing users
-     * // to work offline before the app connects
-     * transports: [];
+     * // Start local-only before authentication. After authentication, pass an
+     * // owner-scoped transport to evolu.useOwner.
+     * const localOnlyBeforeAuthentication =
+     *   [] satisfies ReadonlyArray<OwnerTransport>;
      *
-     * // Using createOwnerWebSocketTransport helper for relay authentication
-     * transports: [
+     * // Include the OwnerId when the relay authenticates owners.
+     * const authenticatedRelay = [
      *   createOwnerWebSocketTransport({
-     *     url: "ws://localhost:4000",
-     *     ownerId,
+     *     url: "wss://relay.example.com",
+     *     ownerId: appOwner.id,
      *   }),
      * ];
+     *
+     * expect(authenticatedRelay[0]?.url).toBe(
+     *   `wss://relay.example.com?ownerId=${appOwner.id}`,
+     * );
      * ```
      */
     readonly transports?: ReadonlyArray<OwnerTransport>;
@@ -140,7 +160,28 @@ export interface EvoluConfig {
      * ### Example
      *
      * ```ts
-     * const evolu = createEvolu(evoluReactDeps)(Schema, {
+     * import {
+     *   AppName,
+     *   createAppOwner,
+     *   createEvolu,
+     *   createOwnerSecret,
+     *   createRandomBytes,
+     *   id,
+     * } from "@evolu/common";
+     *
+     * const Schema = {
+     *   todo: { id: id("Todo") },
+     *   todoCategory: { id: id("TodoCategory") },
+     * };
+     * // Create once, persist the mnemonic securely, and restore it on later runs.
+     * const appOwner = createAppOwner(
+     *   createOwnerSecret({ randomBytes: createRandomBytes() }),
+     * );
+     *
+     * const createTodoEvolu = createEvolu(Schema, {
+     *   appName: AppName.orThrow("IndexedTodos"),
+     *   appOwner,
+     *   transports: [],
      *   indexes: (create) => [
      *     create("todoCreatedAt").on("todo").column("createdAt"),
      *     create("todoCategoryCreatedAt")
@@ -148,6 +189,8 @@ export interface EvoluConfig {
      *       .column("createdAt"),
      *   ],
      * });
+     *
+     * expect(createTodoEvolu).toBeTypeOf("function");
      * ```
      */
     readonly indexes?: IndexesConfig;
@@ -176,11 +219,12 @@ export interface EvoluConfig {
  * Uses the same safe alphabet as {@link UrlSafeString} (letters, digits, `-`,
  * `_`) and must be between 1 and 41 characters.
  */
-export declare const AppName: import("../Type.js").BrandType<import("../Type.js").BrandType<import("../Type.js").Type<"String", string, string, import("../Type.js").StringError, string, import("../Type.js").StringError>, "UrlSafeString", import("../Type.js").RegexError<"UrlSafeString">, import("../Type.js").StringError>, "AppName", AppNameError, import("../Type.js").StringError | import("../Type.js").RegexError<"UrlSafeString">>;
-export type AppName = typeof AppName.Type;
+export declare const AppName: import("../Type.ts").BrandType<import("../Type.ts").BrandType<import("../Type.ts").Type<"String", string, string, import("../Type.ts").TypeOfError<"String">, null, import("../Type.ts").TypeOfError<"String">, never, string, true>, "UrlSafeString", import("../Type.ts").RegexError<"UrlSafeString">>, "AppName", AppNameError>;
+export type AppName = typeof AppName.Output;
 export interface AppNameError extends TypeError<"AppName"> {
+    readonly value: UrlSafeString;
 }
-export declare const testAppName: string & import("../Brand.js").Brand<"UrlSafeString"> & import("../Brand.js").Brand<"AppName">;
+export declare const testAppName: string & import("../Brand.ts").Brand<"UrlSafeString"> & import("../Brand.ts").Brand<"AppName">;
 /**
  * Local-first SQL database with typed queries, mutations, and sync.
  *
@@ -202,19 +246,45 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * every row has a globally unique, conflict-free identifier without
      * coordination.
      *
+     * Pass `onComplete` when follow-up work must wait until the mutation and its
+     * query patches have been applied.
+     *
      * ### Example
      *
      * ```ts
-     * const { id } = evolu.insert("todo", {
-     *   title: NonEmptyString100.orThrow("Learn Evolu"),
-     * });
-     *
-     * // With onComplete callback
-     * evolu.insert(
-     *   "todo",
-     *   { title: NonEmptyString100.orThrow("Another todo") },
-     *   { onComplete: () => console.log("Insert completed") },
-     * );
+     * import {
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   type Evolu,
+     * } from "@evolu/common";
+     *
+     * const TodoId = id("Todo");
+     * type TodoId = typeof TodoId.Output;
+     * const Schema = {
+     *   todo: { id: TodoId, title: NonEmptyTrimmedString100 },
+     * };
+     *
+     * const insertTodo = (evolu: Evolu<typeof Schema>) =>
+     *   evolu.insert("todo", {
+     *     title: NonEmptyTrimmedString100.orThrow("Learn Evolu"),
+     *   }).id;
+     *
+     * const insertTodoAndNotify = (
+     *   evolu: Evolu<typeof Schema>,
+     *   onComplete: () => void,
+     * ) =>
+     *   evolu.insert(
+     *     "todo",
+     *     { title: NonEmptyTrimmedString100.orThrow("Another todo") },
+     *     { onComplete },
+     *   ).id;
+     *
+     * expectTypeOf<
+     *   [
+     *     ReturnType<typeof insertTodo>,
+     *     ReturnType<typeof insertTodoAndNotify>,
+     *   ]
+     * >().toEqualTypeOf<[TodoId, TodoId]>();
      * ```
      *
      * @see {@link Mutation}
@@ -228,13 +298,31 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * ### Example
      *
      * ```ts
-     * const { id } = evolu.update("todo", {
-     *   id: todoId,
-     *   title: NonEmptyString100.orThrow("Updated title"),
-     * });
-     *
-     * // Soft delete
-     * evolu.update("todo", { id: todoId, isDeleted: sqliteTrue });
+     * import {
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   sqliteTrue,
+     *   type Evolu,
+     * } from "@evolu/common";
+     *
+     * const TodoId = id("Todo");
+     * type TodoId = typeof TodoId.Output;
+     * const Schema = {
+     *   todo: { id: TodoId, title: NonEmptyTrimmedString100 },
+     * };
+     *
+     * const renameTodo = (evolu: Evolu<typeof Schema>, todoId: TodoId) =>
+     *   evolu.update("todo", {
+     *     id: todoId,
+     *     title: NonEmptyTrimmedString100.orThrow("Updated title"),
+     *   }).id;
+     *
+     * const softDeleteTodo = (evolu: Evolu<typeof Schema>, todoId: TodoId) =>
+     *   evolu.update("todo", { id: todoId, isDeleted: sqliteTrue }).id;
+     *
+     * expectTypeOf<
+     *   [ReturnType<typeof renameTodo>, ReturnType<typeof softDeleteTodo>]
+     * >().toEqualTypeOf<[TodoId, TodoId]>();
      * ```
      *
      * @see {@link Mutation}
@@ -255,11 +343,26 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * ### Example
      *
      * ```ts
-     * const stableId = createIdFromString("my-todo-1");
-     * const { id } = evolu.upsert("todo", {
-     *   id: stableId,
-     *   title: NonEmptyString100.orThrow("Learn Evolu"),
-     * });
+     * import {
+     *   createIdFromString,
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   type Evolu,
+     * } from "@evolu/common";
+     *
+     * const TodoId = id("Todo");
+     * type TodoId = typeof TodoId.Output;
+     * const Schema = {
+     *   todo: { id: TodoId, title: NonEmptyTrimmedString100 },
+     * };
+     * const stableId = TodoId.orThrow(createIdFromString("my-todo-1"));
+     * const upsertTodo = (evolu: Evolu<typeof Schema>) =>
+     *   evolu.upsert("todo", {
+     *     id: stableId,
+     *     title: NonEmptyTrimmedString100.orThrow("Learn Evolu"),
+     *   }).id;
+     *
+     * expectTypeOf(upsertTodo).returns.toEqualTypeOf<TodoId>();
      * ```
      *
      * @see {@link Mutation}
@@ -283,25 +386,74 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * ### Example
      *
      * ```ts
+     * import {
+     *   createQueryBuilder,
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   type Evolu,
+     *   type QueryRows,
+     * } from "@evolu/common";
+     *
+     * const Schema = {
+     *   todo: { id: id("Todo"), title: NonEmptyTrimmedString100 },
+     * };
      * const createQuery = createQueryBuilder(Schema);
      * const allTodos = createQuery((db) =>
      *   db.selectFrom("todo").selectAll(),
      * );
-     * evolu.loadQuery(allTodos).then((rows) => {
-     *   console.log(rows);
-     * });
+     * const loadTodos = async (evolu: Evolu<typeof Schema>) => {
+     *   const rows = await evolu.loadQuery(allTodos);
+     *   return rows;
+     * };
+     *
+     * expectTypeOf(loadTodos).returns.toEqualTypeOf<
+     *   Promise<QueryRows<typeof allTodos.Row>>
+     * >();
      * ```
      */
     readonly loadQuery: <R extends Row>(query: Query<S, R>) => Promise<QueryRows<R>>;
     /**
-     * Load an array of {@link Query} queries and return an array of
+     * Load an array of {@link Query} values and return an array of
      * {@link QueryRows} promises. It's like `queries.map(loadQuery)` but with
      * proper types for returned promises.
      *
      * ### Example
      *
      * ```ts
-     * evolu.loadQueries([allTodos, todoById(1)]);
+     * import {
+     *   createIdFromString,
+     *   createQueryBuilder,
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   type Evolu,
+     *   type QueryRows,
+     * } from "@evolu/common";
+     *
+     * const TodoId = id("Todo");
+     * type TodoId = typeof TodoId.Output;
+     * const Schema = {
+     *   todo: { id: TodoId, title: NonEmptyTrimmedString100 },
+     * };
+     * const createQuery = createQueryBuilder(Schema);
+     * const allTodos = createQuery((db) =>
+     *   db.selectFrom("todo").select(["id", "title"]),
+     * );
+     * const todoById = (todoId: TodoId) =>
+     *   createQuery((db) =>
+     *     db.selectFrom("todo").select("title").where("id", "=", todoId),
+     *   );
+     * const firstTodo = todoById(
+     *   TodoId.orThrow(createIdFromString("first-todo")),
+     * );
+     * const loadTodoQueries = (evolu: Evolu<typeof Schema>) =>
+     *   evolu.loadQueries([allTodos, firstTodo]);
+     *
+     * expectTypeOf(loadTodoQueries).returns.toEqualTypeOf<
+     *   [
+     *     Promise<QueryRows<typeof allTodos.Row>>,
+     *     Promise<QueryRows<typeof firstTodo.Row>>,
+     *   ]
+     * >();
      * ```
      */
     readonly loadQueries: <Q extends Queries<S>>(queries: [...Q]) => [...QueriesToQueryRowsPromises<Q>];
@@ -311,9 +463,31 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * ### Example
      *
      * ```ts
-     * const unsubscribe = evolu.subscribeQuery(allTodos)(() => {
-     *   const rows = evolu.getQueryRows(allTodos);
-     * });
+     * import {
+     *   createQueryBuilder,
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   type Evolu,
+     *   type QueryRows,
+     *   type Unsubscribe,
+     * } from "@evolu/common";
+     *
+     * const Schema = {
+     *   todo: { id: id("Todo"), title: NonEmptyTrimmedString100 },
+     * };
+     * const createQuery = createQueryBuilder(Schema);
+     * const allTodos = createQuery((db) =>
+     *   db.selectFrom("todo").select("title"),
+     * );
+     * const subscribeToTodos = (
+     *   evolu: Evolu<typeof Schema>,
+     *   onRows: (rows: QueryRows<typeof allTodos.Row>) => void,
+     * ) =>
+     *   evolu.subscribeQuery(allTodos)(() => {
+     *     onRows(evolu.getQueryRows(allTodos));
+     *   });
+     *
+     * expectTypeOf(subscribeToTodos).returns.toEqualTypeOf<Unsubscribe>();
      * ```
      */
     readonly subscribeQuery: (query: Query<S>) => (listener: Listener) => Unsubscribe;
@@ -323,9 +497,27 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * ### Example
      *
      * ```ts
-     * const unsubscribe = evolu.subscribeQuery(allTodos)(() => {
-     *   const rows = evolu.getQueryRows(allTodos);
-     * });
+     * import {
+     *   createQueryBuilder,
+     *   id,
+     *   NonEmptyTrimmedString100,
+     *   type Evolu,
+     *   type QueryRows,
+     * } from "@evolu/common";
+     *
+     * const Schema = {
+     *   todo: { id: id("Todo"), title: NonEmptyTrimmedString100 },
+     * };
+     * const createQuery = createQueryBuilder(Schema);
+     * const allTodos = createQuery((db) =>
+     *   db.selectFrom("todo").select("title"),
+     * );
+     * const getTodos = (evolu: Evolu<typeof Schema>) =>
+     *   evolu.getQueryRows(allTodos);
+     *
+     * expectTypeOf(getTodos).returns.toEqualTypeOf<
+     *   QueryRows<typeof allTodos.Row>
+     * >();
      * ```
      */
     readonly getQueryRows: <R extends Row>(query: Query<S, R>) => QueryRows<R>;
@@ -353,6 +545,8 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      *
      * All instances identified by {@link Evolu.name} will be self-disposed. Use
      * {@link EvoluConfig.onDatabaseDeleted} to update app UI when that happens.
+     *
+     * Currently not implemented.
      */
     readonly deleteDatabase: () => void;
     /**
@@ -363,6 +557,8 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      *
      * It also stops using that owner across all tabs and instances. Use
      * {@link EvoluConfig.onOwnerDeleted} to update app UI when that happens.
+     *
+     * Currently not implemented.
      */
     readonly deleteOwner: (owner: Owner) => void;
     /**
@@ -381,20 +577,51 @@ export interface Evolu<S extends EvoluSchema = EvoluSchema> extends AsyncDisposa
      * ### Example
      *
      * ```ts
-     * // Use an Owner (starts syncing).
-     * const unuseOwner = evolu.useOwner(shardOwner, [
-     *   createOwnerWebSocketTransport({
-     *     url: "ws://localhost:4000",
-     *     ownerId: shardOwner.id,
-     *   }),
-     * ]);
-     *
-     * // Later, stop using the Owner.
-     * unuseOwner();
-     *
-     * // Bulk operations.
-     * const unuseOwners = owners.map(evolu.useOwner);
-     * // Later: for (const unuse of unuseOwners) unuse();
+     * import {
+     *   createAppOwner,
+     *   createOwnerWebSocketTransport,
+     *   createOwnerSecret,
+     *   createRandomBytes,
+     *   deriveShardOwner,
+     *   type Evolu,
+     *   type ReadonlyOwner,
+     *   type UnuseOwner,
+     * } from "@evolu/common";
+     *
+     * // Create once, persist the mnemonic securely, and restore it on later runs.
+     * const appOwner = createAppOwner(
+     *   createOwnerSecret({ randomBytes: createRandomBytes() }),
+     * );
+     * const shardOwner = deriveShardOwner(appOwner, ["todos", 1]);
+     * const shardTransport = createOwnerWebSocketTransport({
+     *   url: "wss://relay.example.com",
+     *   ownerId: shardOwner.id,
+     * });
+     * const useShardOwner = (evolu: Evolu): UnuseOwner =>
+     *   evolu.useOwner(shardOwner, [shardTransport]);
+     *
+     * const useOwners = (
+     *   evolu: Evolu,
+     *   owners: ReadonlyArray<ReadonlyOwner>,
+     * ): UnuseOwner => {
+     *   const unuseOwners = owners.map((owner) =>
+     *     evolu.useOwner(owner, [
+     *       createOwnerWebSocketTransport({
+     *         url: "wss://relay.example.com",
+     *         ownerId: owner.id,
+     *       }),
+     *     ]),
+     *   );
+     *   return () => {
+     *     for (const unuse of unuseOwners) unuse();
+     *   };
+     * };
+     *
+     * // Call each returned UnuseOwner once to stop syncing.
+     * expect(shardTransport).toEqual({
+     *   type: "WebSocket",
+     *   url: `wss://relay.example.com?ownerId=${shardOwner.id}`,
+     * });
      * ```
      */
     readonly useOwner: (owner: ReadonlyOwner | Owner, transports?: NonEmptyReadonlyArray<OwnerTransport>) => UnuseOwner;
@@ -406,18 +633,28 @@ export interface EvoluErrorDep {
      * {@link ReadonlyStore} of {@link EvoluError} shared by all {@link Evolu}
      * instances created from the same {@link createEvoluDeps} result.
      *
-     * Subscribe once to show user-facing messages across all instances. Logging
-     * is handled by platform {@link createRun} global error handlers.
+     * Subscribe once to show user-facing error messages across all instances.
      *
      * ### Example
      *
      * ```ts
+     * import { createStore, Millis, type EvoluError } from "@evolu/common";
+     * import type { EvoluErrorDep } from "@evolu/common/local-first";
+     *
+     * // Stand-in for run.deps.evoluError from createEvoluDeps.
+     * using evoluError = createStore<EvoluError | null>(null);
+     * const deps = { evoluError } satisfies EvoluErrorDep;
+     * let displayedMessage = "";
+     * const showMessage = (message: string) => {
+     *   displayedMessage = message;
+     * };
+     *
      * deps.evoluError.subscribe(() => {
      *   const error = deps.evoluError.get();
      *   if (!error) return;
      *
      *   switch (error.type) {
-     *     case "InvalidComputerClock":
+     *     case "TimestampDriftError":
      *       // Show guidance specific to the detected error.
      *       showMessage(
      *         "Your system clock appears incorrect. Please fix it.",
@@ -428,6 +665,15 @@ export interface EvoluErrorDep {
      *       showMessage("Something went wrong. Please try again.");
      *   }
      * });
+     *
+     * deps.evoluError.set({
+     *   type: "TimestampDriftError",
+     *   next: Millis.orThrow(360000),
+     *   now: Millis.orThrow(0),
+     * });
+     * expect(displayedMessage).toBe(
+     *   "Your system clock appears incorrect. Please fix it.",
+     * );
      * ```
      */
     readonly evoluError: ReadonlyStore<EvoluError | null>;
@@ -438,7 +684,7 @@ export interface EvoluErrorDep {
  * Includes platform adapters, the shared {@link EvoluErrorDep.evoluError} store,
  * and disposal for owned resources.
  */
-export type EvoluDeps = EvoluPlatformDeps & EvoluErrorDep & Disposable;
+export type EvoluDeps = EvoluPlatformDeps & ConsoleDep & EvoluErrorDep & Disposable;
 /**
  * Platform-specific dependencies required to create {@link EvoluDeps}.
  *

package/dist/src/local-first/Evolu.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Evolu.d.ts","sourceRoot":"","sources":["../../../src/local-first/Evolu.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAIL,KAAK,qBAAqB,EAC3B,MAAM,aAAa,CAAC;AAOrB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAIhD,OAAO,EAGL,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAKjE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAExE,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAM,SAAS,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAIL,IAAI,EAEL,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,yBAAyB,EACzB,uBAAuB,EACxB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,QAAQ,EACR,KAAK,EAEL,cAAc,EACd,aAAa,EAEd,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,OAAO,EACP,0BAA0B,EAC1B,KAAK,EACL,SAAS,EACT,GAAG,EAEJ,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,QAAQ,EAER,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EAIV,eAAe,EAChB,MAAM,aAAa,CAAC;AAKrB,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAEpD;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IAEjC;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClD;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,oZAInB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAC;AAC1C,MAAM,WAAW,YAAa,SAAQ,SAAS,CAAC,SAAS,CAAC;CAAG;AAE7D,eAAO,MAAM,WAAW,gGAA2C,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,KAAK,CACpB,CAAC,SAAS,WAAW,GAAG,WAAW,CACnC,SAAQ,eAAe;IACvB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,wBAAwB;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,EAChC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KACf,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EACzC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,KACZ,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,cAAc,EAAE,CACvB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KACZ,CAAC,QAAQ,EAAE,QAAQ,KAAK,WAAW,CAAC;IAEzC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAE3E;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAIhE;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;IAEpC;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,aAAa,GAAG,KAAK,EAC5B,UAAU,CAAC,EAAE,qBAAqB,CAAC,cAAc,CAAC,KAC/C,UAAU,CAAC;CACjB;AAED,mFAAmF;AACnF,MAAM,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC;AAEpC,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,aAAa,GAAG,UAAU,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAC/C,yBAAyB,GACzB,uBAAuB,GACvB,cAAc,GACd,YAAY,GACZ,eAAe,GACf,OAAO,CAAC,UAAU,CAAC,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC;AAExB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,GAAI,MAAM,iBAAiB,KAAG,SAsDzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GACrB,CAAC,SAAS,WAAW,EACpB,QAAQ,cAAc,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EAC/D,QAAQ,WAAW,KAClB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAybzC,CAAC"}
+{"version":3,"file":"Evolu.d.ts","sourceRoot":"","sources":["../../../src/local-first/Evolu.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAIL,KAAK,qBAAqB,EAC3B,MAAM,aAAa,CAAC;AAGrB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAIhD,OAAO,EAGL,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAKjE,OAAO,KAAK,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAExE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAML,IAAI,EACJ,KAAK,SAAS,EACd,aAAa,EACd,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EACV,yBAAyB,EACzB,uBAAuB,EACxB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,QAAQ,EACR,KAAK,EAEL,cAAc,EACd,aAAa,EAEd,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,OAAO,EACP,0BAA0B,EAC1B,KAAK,EACL,SAAS,EACT,GAAG,EAEJ,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,WAAW,EACX,aAAa,EACb,QAAQ,EAER,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EAIV,eAAe,EAChB,MAAM,aAAa,CAAC;AAKrB,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4EG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAEpD;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;IAEjC;;;;;OAKG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClD;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,oUASnB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC;AAC5C,MAAM,WAAW,YAAa,SAAQ,SAAS,CAAC,SAAS,CAAC;IACxD,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;CAC/B;AAED,eAAO,MAAM,WAAW,gGAA2C,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,KAAK,CACpB,CAAC,SAAS,WAAW,GAAG,WAAW,CACnC,SAAQ,eAAe;IACvB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,wBAAwB;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,SAAS,GAAG,EAChC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KACf,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,EACzC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,KACZ,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CAAC,cAAc,EAAE,CACvB,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KACZ,CAAC,QAAQ,EAAE,QAAQ,KAAK,WAAW,CAAC;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAE3E;;;;;;;;OAQG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAIhE;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,IAAI,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,QAAQ,CAAC,QAAQ,EAAE,CACjB,KAAK,EAAE,aAAa,GAAG,KAAK,EAC5B,UAAU,CAAC,EAAE,qBAAqB,CAAC,cAAc,CAAC,KAC/C,UAAU,CAAC;CACjB;AAED,mFAAmF;AACnF,MAAM,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC;AAEpC,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,iBAAiB,GACvC,UAAU,GACV,aAAa,GACb,UAAU,CAAC;AAEb;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,GAC/C,yBAAyB,GACzB,uBAAuB,GACvB,cAAc,GACd,YAAY,GACZ,eAAe,GACf,OAAO,CAAC,UAAU,CAAC,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC;AAExB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,SAAU,iBAAiB,KAAG,SAuDzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GACrB,CAAC,SAAS,WAAW,UACZ,cAAc,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,UACvD,WAAW,KAClB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAgbzC,CAAC"}