@evolu/common 7.4.0 → 8.0.0-next.0

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

@@ -1,218 +1,29 @@
-import { NonEmptyReadonlyArray } from "../Array.js";
-import { CallbackId } from "../Callbacks.js";
-import { ConsoleConfig, ConsoleDep } from "../Console.js";
-import { EncryptionKey, RandomBytesDep, SymmetricCryptoDecryptError } from "../Crypto.js";
-import { TransferableError } from "../Error.js";
-import { RandomDep } from "../Random.js";
-import { CreateSqliteDriverDep, SqliteError } from "../Sqlite.js";
-import { TimeDep } from "../Time.js";
-import { Id, Mnemonic, SimpleName } from "../Type.js";
-import { CreateWebSocketDep } from "../WebSocket.js";
-import { Worker } from "../Worker.js";
-import { AppOwner, OwnerTransport } from "./Owner.js";
-import { ProtocolError } from "./Protocol.js";
-import { Query, QueryPatches } from "./Query.js";
-import { DbSchema, MutationChange } from "./Schema.js";
-import { SyncOwner } from "./Sync.js";
-import { TimestampConfig, TimestampError } from "./Timestamp.js";
-export interface DbConfig extends ConsoleConfig, TimestampConfig {
-    /**
-     * The name of the Evolu instance. Evolu is multitenant - it can run multiple
-     * instances concurrently. Each instance must have a unique name.
-     *
-     * The instance name is used as the SQLite database filename for persistent
-     * storage, ensuring that database files are separated and invisible to each
-     * other.
-     *
-     * The default value is: `Evolu`.
-     *
-     * ### Example
-     *
-     * ```ts
-     * // name: SimpleName.orThrow("MyApp")
-     * ```
-     */
-    readonly name: SimpleName;
-    /**
-     * Transport configuration for data sync and backup. Supports single transport
-     * or multiple transports simultaneously for redundancy.
-     *
-     * **Redundancy:** The ideal setup uses at least two completely independent
-     * relays - for example, a home relay and a geographically separate relay.
-     * Data is sent to both relays simultaneously, providing true redundancy
-     * similar to using two independent clouds. This eliminates vendor lock-in and
-     * ensures your app continues working regardless of circumstances - whether
-     * home relay hardware is stolen or a remote relay provider shuts down.
-     *
-     * Currently supports:
-     *
-     * - WebSocket: Real-time bidirectional communication with relay servers
-     *
-     * Empty transports create local-only instances. Transports can be dynamically
-     * added and removed for any owner (including {@link AppOwner}) via
-     * {@link Evolu#useOwner}.
-     *
-     * Use {@link createOwnerWebSocketTransport} to create WebSocket transport
-     * configurations with proper URL formatting and {@link OwnerId} inclusion. The
-     * {@link OwnerId} in the URL enables relay authentication, allowing relay
-     * servers to control access (e.g., for paid tiers or private instances).
-     *
-     * The default value is:
-     *
-     * `{ type: "WebSocket", url: "wss://free.evoluhq.com" }`.
-     *
-     * ### Example
-     *
-     * ```ts
-     * // Single WebSocket relay
-     * transports: [{ type: "WebSocket", url: "wss://relay1.example.com" }];
-     *
-     * // Multiple WebSocket relays for redundancy
-     * transports: [
-     *   { type: "WebSocket", url: "wss://relay1.example.com" },
-     *   { type: "WebSocket", url: "wss://relay2.example.com" },
-     *   { type: "WebSocket", url: "wss://relay3.example.com" },
-     * ];
-     *
-     * // 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: [];
-     *
-     * // Using createOwnerWebSocketTransport helper for relay authentication
-     * transports: [
-     *   createOwnerWebSocketTransport({
-     *     url: "ws://localhost:4000",
-     *     ownerId,
-     *   }),
-     * ];
-     * ```
-     */
-    readonly transports: ReadonlyArray<OwnerTransport>;
-    /**
-     * External AppOwner to use when creating Evolu instance. Use this when you
-     * want to manage AppOwner creation and persistence externally (e.g., with
-     * your own authentication system). If omitted, Evolu will automatically
-     * create and persist an AppOwner locally.
-     *
-     * For device-specific settings and account management state, we can use a
-     * separate local-only Evolu instance via `transports: []`.
-     *
-     * ### Example
-     *
-     * ```ts
-     * const ConfigId = id("Config");
-     * type ConfigId = typeof ConfigId.Type;
-     *
-     * const DeviceSchema = {
-     *   config: {
-     *     id: ConfigId,
-     *     key: NonEmptyString50,
-     *     value: NonEmptyString50,
-     *   },
-     * };
-     *
-     * // Local-only instance for device settings (no sync)
-     * const deviceEvolu = createEvolu(evoluReactWebDeps)(DeviceSchema, {
-     *   name: SimpleName.orThrow("MyApp-Device"),
-     *   transports: [], // No sync - stays local to device
-     * });
-     *
-     * // Main synced instance for user data
-     * const evolu = createEvolu(evoluReactWebDeps)(MainSchema, {
-     *   name: SimpleName.orThrow("MyApp"),
-     *   // Default transports for sync
-     * });
-     * ```
-     */
-    readonly externalAppOwner?: AppOwner;
-    /**
-     * Use in-memory SQLite database instead of persistent storage. Useful for
-     * testing or temporary data that doesn't need persistence.
-     *
-     * In-memory databases exist only in RAM and are completely destroyed when the
-     * process ends, making them forensically safe for sensitive data.
-     *
-     * The default value is: `false`.
-     */
-    readonly inMemory?: boolean;
-    /**
-     * Encryption key for the SQLite database.
-     *
-     * Note: If an unencrypted SQLite database already exists and you provide an
-     * encryptionKey, SQLite will throw an error.
-     *
-     * @experimental
-     */
-    readonly encryptionKey?: EncryptionKey;
+/**
+ * Platform-agnostic Evolu DbWorker.
+ *
+ * @module
+ */
+import type { ConsoleLevel } from "../Console.js";
+import { EncryptionKey, type RandomBytesDep } from "../Crypto.js";
+import type { CreateSqliteDriverDep, SqliteSchema } from "../Sqlite.js";
+import { type LeaderLockDep, type Task } from "../Task.js";
+import type { Name } from "../Type.js";
+import type { NativeMessagePort, Worker, WorkerDeps, WorkerSelf } from "../Worker.js";
+import type { DbWorkerInput, DbWorkerOutput } from "./Shared.js";
+export type DbWorker = Worker<DbWorkerInit>;
+export interface DbWorkerInit {
+    readonly type: "Init";
+    readonly name: Name;
+    readonly consoleLevel: ConsoleLevel;
+    readonly sqliteSchema: SqliteSchema;
+    readonly encryptionKey: EncryptionKey;
+    readonly memoryOnly: boolean;
+    readonly port: NativeMessagePort<DbWorkerOutput, DbWorkerInput>;
 }
-export declare const defaultDbConfig: DbConfig;
-export type DbWorker = Worker<DbWorkerInput, DbWorkerOutput>;
-export type CreateDbWorker = (name: SimpleName) => DbWorker;
+export type CreateDbWorker = () => DbWorker;
 export interface CreateDbWorkerDep {
     readonly createDbWorker: CreateDbWorker;
 }
-export type DbWorkerInput = {
-    readonly type: "init";
-    readonly config: DbConfig;
-    readonly dbSchema: DbSchema;
-} | {
-    readonly type: "getAppOwner";
-} | {
-    readonly type: "mutate";
-    readonly tabId: Id;
-    readonly changes: NonEmptyReadonlyArray<MutationChange>;
-    readonly onCompleteIds: ReadonlyArray<CallbackId>;
-    readonly subscribedQueries: ReadonlyArray<Query>;
-} | {
-    readonly type: "query";
-    readonly tabId: Id;
-    readonly queries: NonEmptyReadonlyArray<Query>;
-} | {
-    readonly type: "reset";
-    readonly onCompleteId: CallbackId;
-    readonly reload: boolean;
-    readonly restore?: {
-        readonly dbSchema: DbSchema;
-        readonly mnemonic: Mnemonic;
-    };
-} | {
-    readonly type: "ensureDbSchema";
-    readonly dbSchema: DbSchema;
-} | {
-    readonly type: "export";
-    readonly onCompleteId: CallbackId;
-} | {
-    readonly type: "useOwner";
-    readonly use: boolean;
-    readonly owner: SyncOwner;
-};
-export type DbWorkerOutput = {
-    readonly type: "onError";
-    readonly error: ProtocolError | SqliteError | SymmetricCryptoDecryptError | TimestampError | TransferableError;
-} | {
-    readonly type: "onGetAppOwner";
-    readonly appOwner: AppOwner;
-} | {
-    readonly type: "onQueryPatches";
-    readonly tabId: Id;
-    readonly queryPatches: ReadonlyArray<QueryPatches>;
-    readonly onCompleteIds: ReadonlyArray<CallbackId>;
-} | {
-    readonly type: "refreshQueries";
-    readonly tabId?: Id;
-} | {
-    readonly type: "onReset";
-    readonly onCompleteId: CallbackId;
-    readonly reload: boolean;
-} | {
-    readonly type: "onExport";
-    readonly onCompleteId: CallbackId;
-    readonly file: Uint8Array;
-};
-export type DbWorkerPlatformDeps = ConsoleDep & CreateSqliteDriverDep & CreateWebSocketDep & RandomBytesDep & RandomDep & TimeDep;
-export interface PostMessageDep {
-    readonly postMessage: (message: DbWorkerOutput) => void;
-}
-export declare const createDbWorkerForPlatform: (platformDeps: DbWorkerPlatformDeps) => DbWorker;
+export type DbWorkerDeps = WorkerDeps & LeaderLockDep & CreateSqliteDriverDep & RandomBytesDep;
+export declare const startDbWorker: (self: WorkerSelf<DbWorkerInit>) => Task<void, never, DbWorkerDeps>;
 //# sourceMappingURL=Db.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Db.d.ts","sourceRoot":"","sources":["../../../src/local-first/Db.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,qBAAqB,EACtB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAEL,aAAa,EACb,cAAc,EACd,2BAA2B,EAC5B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAEL,qBAAqB,EAGrB,WAAW,EACZ,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,EAGL,MAAM,EACP,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,QAAQ,EAQR,cAAc,EAEf,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,aAAa,EAAmB,MAAM,eAAe,CAAC;AAC/D,OAAO,EAIL,KAAK,EACL,YAAY,EACb,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,QAAQ,EAGR,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,OAAO,EAML,SAAS,EAEV,MAAM,WAAW,CAAC;AACnB,OAAO,EAIL,eAAe,EACf,cAAc,EAEf,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,QAAS,SAAQ,aAAa,EAAE,eAAe;IAC9D;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC;IAErC;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;CACxC;AAED,eAAO,MAAM,eAAe,EAAE,QAK7B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,UAAU,KAAK,QAAQ,CAAC;AAE5D,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACzC;AAED,MAAM,MAAM,aAAa,GACrB;IACE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;CAC9B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;IACnB,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC,cAAc,CAAC,CAAC;IACxD,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IAClD,QAAQ,CAAC,iBAAiB,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;CAClD,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;IACnB,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC,KAAK,CAAC,CAAC;CAChD,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;KAC7B,CAAC;CACH,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;CACnC,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B,CAAC;AAEN,MAAM,MAAM,cAAc,GACtB;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EACV,aAAa,GACb,WAAW,GACX,2BAA2B,GAC3B,cAAc,GACd,iBAAiB,CAAC;CACvB,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;IACnB,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IACnD,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACnD,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;CACrB,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,UAAU,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC3B,CAAC;AAEN,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAC3C,qBAAqB,GACrB,kBAAkB,GAClB,cAAc,GACd,SAAS,GACT,OAAO,CAAC;AAYV,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC;CACzD;AAED,eAAO,MAAM,yBAAyB,GACpC,cAAc,oBAAoB,KACjC,QAuBC,CAAC"}
+{"version":3,"file":"Db.d.ts","sourceRoot":"","sources":["../../../src/local-first/Db.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EACL,aAAa,EAEb,KAAK,cAAc,EACpB,MAAM,cAAc,CAAC;AAItB,OAAO,KAAK,EACV,qBAAqB,EAGrB,YAAY,EACb,MAAM,cAAc,CAAC;AAUtB,OAAO,EAAY,KAAK,aAAa,EAAE,KAAK,IAAI,EAAE,MAAM,YAAY,CAAC;AAErE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AASvC,OAAO,KAAK,EACV,iBAAiB,EACjB,MAAM,EACN,UAAU,EACV,UAAU,EACX,MAAM,cAAc,CAAC;AAqBtB,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AA8BjE,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;AAE5C,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;CACjE;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAC;AAE5C,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACzC;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GACnC,aAAa,GACb,qBAAqB,GACrB,cAAc,CAAC;AAEjB,eAAO,MAAM,aAAa,GACvB,MAAM,UAAU,CAAC,YAAY,CAAC,KAAG,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,CAmO/D,CAAC"}