@livestore/adapter-web 0.4.0-dev.13 → 0.4.0-dev.15

package/src/in-memory/in-memory-adapter.ts

@@ -17,8 +17,17 @@ import type * as WebmeshWorker from '@livestore/devtools-web-common/worker'
 import type { MakeWebSqliteDb } from '@livestore/sqlite-wasm/browser'
 import { sqliteDbFactory } from '@livestore/sqlite-wasm/browser'
 import { tryAsFunctionAndNew } from '@livestore/utils'
-import type { Schema, Scope } from '@livestore/utils/effect'
-import { BrowserWorker, Effect, FetchHttpClient, Fiber, Layer, SubscriptionRef, Worker } from '@livestore/utils/effect'
+import type { Scope } from '@livestore/utils/effect'
+import {
+  BrowserWorker,
+  Effect,
+  FetchHttpClient,
+  Fiber,
+  Layer,
+  type Schema,
+  SubscriptionRef,
+  Worker,
+} from '@livestore/utils/effect'
 import { nanoid } from '@livestore/utils/nanoid'
 import * as Webmesh from '@livestore/webmesh'
 
@@ -52,11 +61,21 @@ export interface InMemoryAdapterOptions {
   }
 }
 
+/**
+ * Create a web-only in-memory LiveStore adapter.
+ *
+ * - Runs entirely in memory: fast, zero I/O, great for tests, sandboxes, or ephemeral sessions.
+ * - Works across browser execution contexts: Window, WebWorker, SharedWorker, and ServiceWorker.
+ * - DevTools: to inspect this adapter from the browser DevTools, provide a `sharedWorker` in `options.devtools`.
+ *   (The shared worker is used to bridge the DevTools UI to the running session.)
+ * - No persistence support: nothing is written to OPFS/IndexedDB/localStorage. `importSnapshot`
+ *   can bootstrap initial state only; subsequent changes are not persisted anywhere.
+ */
 export const makeInMemoryAdapter =
   (options: InMemoryAdapterOptions = {}): Adapter =>
   (adapterArgs) =>
     Effect.gen(function* () {
-      const { schema, shutdown, syncPayload, storeId, devtoolsEnabled } = adapterArgs
+      const { schema, shutdown, syncPayloadEncoded, syncPayloadSchema, storeId, devtoolsEnabled } = adapterArgs
       const sqlite3 = yield* Effect.promise(() => loadSqlite3())
 
       const sqliteDb = yield* sqliteDbFactory({ sqlite3 })({ _tag: 'in-memory' })
@@ -88,7 +107,8 @@ export const makeInMemoryAdapter =
         clientId,
         makeSqliteDb: sqliteDbFactory({ sqlite3 }),
         syncOptions: options.sync,
-        syncPayload,
+        syncPayloadEncoded,
+        syncPayloadSchema,
         importSnapshot: options.importSnapshot,
         devtoolsEnabled,
         sharedWorkerFiber,
@@ -108,6 +128,8 @@ export const makeInMemoryAdapter =
         lockStatus,
         shutdown,
         webmeshMode: 'direct',
+        // Can be undefined in Node.js
+        origin: globalThis.location?.origin,
         connectWebmeshNode: ({ sessionInfo, webmeshNode }) =>
           Effect.gen(function* () {
             if (sharedWorkerFiber === undefined || devtoolsEnabled === false) {
@@ -137,7 +159,8 @@ export interface MakeLeaderThreadArgs {
   clientId: string
   makeSqliteDb: MakeWebSqliteDb
   syncOptions: SyncOptions | undefined
-  syncPayload: Schema.JsonValue | undefined
+  syncPayloadEncoded: Schema.JsonValue | undefined
+  syncPayloadSchema: Schema.Schema<any> | undefined
   importSnapshot: Uint8Array<ArrayBuffer> | undefined
   devtoolsEnabled: boolean
   sharedWorkerFiber: SharedWorkerFiber | undefined
@@ -149,7 +172,8 @@ const makeLeaderThread = ({
   clientId,
   makeSqliteDb,
   syncOptions,
-  syncPayload,
+  syncPayloadEncoded,
+  syncPayloadSchema,
   importSnapshot,
   devtoolsEnabled,
   sharedWorkerFiber,
@@ -196,7 +220,8 @@ const makeLeaderThread = ({
         dbEventlog,
         devtoolsOptions,
         shutdownChannel,
-        syncPayload,
+        syncPayloadEncoded,
+        syncPayloadSchema,
       }),
     )
 

package/src/web-worker/client-session/persisted-adapter.ts

@@ -138,7 +138,23 @@ export const makePersistedAdapter =
   (options: WebAdapterOptions): Adapter =>
   (adapterArgs) =>
     Effect.gen(function* () {
-      const { schema, storeId, devtoolsEnabled, debugInstanceId, bootStatusQueue, shutdown, syncPayload } = adapterArgs
+      const {
+        schema,
+        storeId,
+        devtoolsEnabled,
+        debugInstanceId,
+        bootStatusQueue,
+        shutdown,
+        syncPayloadSchema: _syncPayloadSchema,
+        syncPayloadEncoded,
+      } = adapterArgs
+
+      // NOTE: The schema travels with the worker bundle (developers call
+      // `makeWorker({ schema, syncPayloadSchema })`). We only keep the
+      // destructured value here to document availability on the client session
+      // side—structured cloning the Effect schema into the worker is not
+      // possible, so we intentionally do not forward it.
+      void _syncPayloadSchema
 
       yield* ensureBrowserRequirements
 
@@ -266,7 +282,7 @@ export const makePersistedAdapter =
                 clientId,
                 devtoolsEnabled,
                 debugInstanceId,
-                syncPayload,
+                syncPayloadEncoded,
               }),
             }),
           )
@@ -490,6 +506,8 @@ export const makePersistedAdapter =
         isLeader: gotLocky,
         leaderThread,
         webmeshMode: 'direct',
+        // Can be undefined in Node.js
+        origin: globalThis.location?.origin,
         connectWebmeshNode: ({ sessionInfo, webmeshNode }) =>
           connectWebmeshNodeClientSession({ webmeshNode, sessionInfo, sharedWorker, devtoolsEnabled, schema }),
         registerBeforeUnload: (onBeforeUnload) => {

package/src/web-worker/client-session/sqlite-loader.ts

@@ -8,7 +8,7 @@ import { loadSqlite3Wasm } from '@livestore/sqlite-wasm/load-wasm'
  * The Cloudflare / Workerd runtime has stricter rules: async fetches during module
  * evaluation are blocked, so we defer loading until the worker asks for it.
  */
-const isServerRuntime = String(import.meta.env.SSR) === 'true'
+const isServerRuntime = String(import.meta.env?.SSR) === 'true' || typeof window === 'undefined'
 
 let sqlite3Promise: ReturnType<typeof loadSqlite3Wasm> | undefined
 

package/src/web-worker/common/worker-schema.ts

@@ -65,7 +65,7 @@ export class LeaderWorkerInnerInitialMessage extends Schema.TaggedRequest<Leader
       storeId: Schema.String,
       clientId: Schema.String,
       debugInstanceId: Schema.String,
-      syncPayload: Schema.UndefinedOr(Schema.JsonValue),
+      syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue),
     },
     success: Schema.Void,
     failure: UnexpectedError,

package/src/web-worker/leader-worker/make-leader-worker.ts

@@ -19,6 +19,7 @@ import {
   LogLevel,
   OtelTracer,
   Scheduler,
+  type Schema,
   Stream,
   TaskTracing,
   WorkerRunner,
@@ -33,6 +34,7 @@ import * as WorkerSchema from '../common/worker-schema.ts'
 export type WorkerOptions = {
   schema: LiveStoreSchema
   sync?: SyncOptions
+  syncPayloadSchema?: Schema.Schema<any>
   otelOptions?: {
     tracer?: otel.Tracer
   }
@@ -102,9 +104,9 @@ const makeWorkerRunnerOuter = (
       }).pipe(Effect.withSpan('@livestore/adapter-web:worker:wrapper:InitialMessage'), Layer.unwrapScoped),
   })
 
-const makeWorkerRunnerInner = ({ schema, sync: syncOptions }: WorkerOptions) =>
+const makeWorkerRunnerInner = ({ schema, sync: syncOptions, syncPayloadSchema }: WorkerOptions) =>
   WorkerRunner.layerSerialized(WorkerSchema.LeaderWorkerInnerRequest, {
-    InitialMessage: ({ storageOptions, storeId, clientId, devtoolsEnabled, debugInstanceId, syncPayload }) =>
+    InitialMessage: ({ storageOptions, storeId, clientId, devtoolsEnabled, debugInstanceId, syncPayloadEncoded }) =>
       Effect.gen(function* () {
         const sqlite3 = yield* Effect.promise(() => loadSqlite3Wasm())
         const makeSqliteDb = sqliteDbFactory({ sqlite3 })
@@ -154,7 +156,8 @@ const makeWorkerRunnerInner = ({ schema, sync: syncOptions }: WorkerOptions) =>
           dbEventlog,
           devtoolsOptions,
           shutdownChannel,
-          syncPayload,
+          syncPayloadEncoded,
+          syncPayloadSchema,
         })
       }).pipe(
         Effect.tapCauseLogPretty,

package/src/web-worker/shared-worker/make-shared-worker.ts

@@ -163,7 +163,7 @@ const makeWorkerRunner = Effect.gen(function* () {
   const InvariantsSchema = Schema.Struct({
     storeId: Schema.String,
     storageOptions: WorkerSchema.StorageType,
-    syncPayload: Schema.UndefinedOr(Schema.JsonValue),
+    syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue),
     liveStoreVersion: Schema.Literal(liveStoreVersion),
     devtoolsEnabled: Schema.Boolean,
   })
@@ -176,11 +176,11 @@ const makeWorkerRunner = Effect.gen(function* () {
     // sends a new MessagePort to the shared worker which proxies messages to the new leader thread.
     UpdateMessagePort: ({ port, initial, liveStoreVersion: clientLiveStoreVersion }) =>
       Effect.gen(function* () {
-        // Enforce invariants: storeId, storageOptions, syncPayload, liveStoreVersion must remain stable
+        // Enforce invariants: storeId, storageOptions, syncPayloadEncoded, liveStoreVersion must remain stable
         const invariants: Invariants = {
           storeId: initial.storeId,
           storageOptions: initial.storageOptions,
-          syncPayload: initial.syncPayload,
+          syncPayloadEncoded: initial.syncPayloadEncoded,
           liveStoreVersion: clientLiveStoreVersion,
           devtoolsEnabled: initial.devtoolsEnabled,
         }