@livestore/sync-cf 0.4.0-dev.2 → 0.4.0-dev.20

package/dist/client/transport/ws-rpc-client.js

@@ -0,0 +1,108 @@
+import { InvalidPullError, InvalidPushError, IsOfflineError, SyncBackend, UnknownError } from '@livestore/common';
+import { splitChunkBySize } from '@livestore/common/sync';
+import { omit } from '@livestore/utils';
+import { Chunk, Effect, Layer, Option, RpcClient, RpcSerialization, Schedule, Schema, Socket, Stream, SubscriptionRef, UrlParams, } from '@livestore/utils/effect';
+import { MAX_PUSH_EVENTS_PER_REQUEST, MAX_WS_MESSAGE_BYTES } from "../../common/constants.js";
+import { SearchParamsSchema } from "../../common/mod.js";
+import { SyncWsRpc } from "../../common/ws-rpc-schema.js";
+/**
+ * Creates a sync backend that uses WebSocket to communicate with the sync backend.
+ *
+ * @example
+ * ```ts
+ * import { makeWsSync } from '@livestore/sync-cf/client'
+ *
+ * const syncBackend = makeWsSync({ url: 'wss://sync.example.com' })
+ */
+export const makeWsSync = (options) => ({ storeId, payload }) => Effect.gen(function* () {
+    const urlParamsData = yield* Schema.encode(SearchParamsSchema)({
+        storeId,
+        payload,
+        transport: 'ws',
+    }).pipe(UnknownError.mapToUnknownError);
+    const urlParams = UrlParams.fromInput(urlParamsData);
+    const wsUrl = `${options.url}?${UrlParams.toString(urlParams)}`;
+    const isConnected = yield* SubscriptionRef.make(false);
+    // TODO bring this back in a cross-platform way
+    // If the browser already tells us we're offline, then we'll at least wait until the browser
+    // thinks we're online again. (We'll only know for sure once the WS conneciton is established.)
+    // while (typeof navigator !== 'undefined' && navigator.onLine === false) {
+    //   yield* Effect.sleep(1000)
+    // }
+    // TODO bring this back in a cross-platform way
+    // if (navigator.onLine === false) {
+    //   yield* Effect.async((cb) => self.addEventListener('online', () => cb(Effect.void)))
+    // }
+    const pingInterval = options.ping?.requestInterval ?? 10_000;
+    const ProtocolLive = RpcClient.layerProtocolSocketWithIsConnected({
+        isConnected,
+        retryTransientErrors: Schedule.fixed(1000),
+        pingSchedule: Schedule.once.pipe(Schedule.andThen(Schedule.fixed(pingInterval))),
+        url: wsUrl,
+    }).pipe(Layer.provide(Socket.layerWebSocket(wsUrl)), Layer.provide(Socket.layerWebSocketConstructorGlobal), Layer.provide(RpcSerialization.layerJson));
+    // Warning: we need to build the layer here eagerly to tie it to the scope
+    // instead of using `Effect.provide(ProtocolLive)` which would close the layer scope too early
+    const ctx = yield* Layer.build(ProtocolLive);
+    const rpcClient = yield* RpcClient.make(SyncWsRpc).pipe(Effect.provide(ctx));
+    const pingTimeout = options.ping?.requestTimeout ?? 10_000;
+    const ping = Effect.gen(function* () {
+        const pinger = yield* RpcClient.SocketPinger.pipe(Effect.provide(ctx));
+        yield* pinger.ping;
+        yield* SubscriptionRef.set(isConnected, true);
+    }).pipe(Effect.timeout(pingTimeout), Effect.catchTag('TimeoutException', () => SubscriptionRef.set(isConnected, false)), UnknownError.mapToUnknownError, Effect.withSpan('ping'));
+    const backendIdHelper = yield* SyncBackend.makeBackendIdHelper;
+    return SyncBackend.of({
+        isConnected,
+        connect: ping,
+        pull: (cursor, options) => rpcClient.SyncWsRpc.Pull({
+            storeId,
+            payload,
+            cursor: cursor.pipe(Option.map((a) => ({
+                eventSequenceNumber: a.eventSequenceNumber,
+                backendId: backendIdHelper.get().pipe(Option.getOrThrow),
+            }))),
+            live: options?.live ?? false,
+        }).pipe(Stream.tap((res) => backendIdHelper.lazySet(res.backendId)), Stream.map((res) => omit(res, ['backendId'])), Stream.mapError((cause) => cause._tag === 'RpcClientError' && Socket.isSocketError(cause.cause)
+            ? new IsOfflineError({ cause: cause.cause })
+            : cause._tag === 'InvalidPullError'
+                ? cause
+                : InvalidPullError.make({ cause })), Stream.withSpan('pull')),
+        push: (batch) => Effect.gen(function* () {
+            if (batch.length === 0)
+                return;
+            const encodePayload = (batch) => ({
+                storeId,
+                payload,
+                batch,
+                backendId: backendIdHelper.get(),
+            });
+            const chunksChunk = yield* Chunk.fromIterable(batch).pipe(splitChunkBySize({
+                maxItems: MAX_PUSH_EVENTS_PER_REQUEST,
+                maxBytes: MAX_WS_MESSAGE_BYTES,
+                encode: encodePayload,
+            }), Effect.mapError((cause) => new InvalidPushError({ cause: new UnknownError({ cause }) })));
+            for (const sub of chunksChunk) {
+                yield* rpcClient.SyncWsRpc.Push({
+                    storeId,
+                    payload,
+                    batch: Chunk.toReadonlyArray(sub),
+                    backendId: backendIdHelper.get(),
+                }).pipe(Effect.mapError((cause) => cause._tag === 'InvalidPushError'
+                    ? cause
+                    : new InvalidPushError({ cause: new UnknownError({ cause }) })));
+            }
+        }).pipe(Effect.withSpan('push')),
+        ping,
+        metadata: {
+            name: '@livestore/cf-sync',
+            description: 'LiveStore sync backend implementation using Cloudflare Workers & Durable Objects',
+            protocol: 'ws',
+            url: options.url,
+        },
+        supports: {
+            pullPageInfoKnown: true,
+            pullLive: true,
+        },
+    });
+});
+//# sourceMappingURL=ws-rpc-client.js.map

package/dist/client/transport/ws-rpc-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-rpc-client.js","sourceRoot":"","sources":["../../../src/client/transport/ws-rpc-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEjH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AACvC,OAAO,EACL,KAAK,EAEL,MAAM,EACN,KAAK,EACL,MAAM,EACN,SAAS,EACT,gBAAgB,EAChB,QAAQ,EACR,MAAM,EAEN,MAAM,EACN,MAAM,EACN,eAAe,EACf,SAAS,GACV,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAC7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAExD,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAA;AAkCzD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GACrB,CAAC,OAAsB,EAAoD,EAAE,CAC7E,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CACvB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC7D,OAAO;QACP,OAAO;QACP,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAA;IAEvC,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IACpD,MAAM,KAAK,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAA;IAE/D,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAEtD,+CAA+C;IAC/C,4FAA4F;IAC5F,+FAA+F;IAC/F,2EAA2E;IAC3E,8BAA8B;IAC9B,IAAI;IACJ,+CAA+C;IAC/C,oCAAoC;IACpC,wFAAwF;IACxF,IAAI;IAEJ,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,EAAE,eAAe,IAAI,MAAM,CAAA;IAE5D,MAAM,YAAY,GAAG,SAAS,CAAC,kCAAkC,CAAC;QAChE,WAAW;QACX,oBAAoB,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;QAC1C,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAChF,GAAG,EAAE,KAAK;KACX,CAAC,CAAC,IAAI,CACL,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,EAC3C,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,EACrD,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAC1C,CAAA;IAED,0EAA0E;IAC1E,8FAA8F;IAC9F,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;IAE5C,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;IAE5E,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,EAAE,cAAc,IAAI,MAAM,CAAA;IAE1D,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;QACtE,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAA;QAClB,KAAK,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAC,IAAI,CACL,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAC3B,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EAClF,YAAY,CAAC,iBAAiB,EAC9B,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CACxB,CAAA;IAED,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC,mBAAmB,CAAA;IAE9D,OAAO,WAAW,CAAC,EAAE,CAAe;QAClC,WAAW;QACX,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CACxB,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC;YACvB,OAAO;YACP,OAAO;YACP,MAAM,EAAE,MAAM,CAAC,IAAI,CACjB,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACjB,mBAAmB,EAAE,CAAC,CAAC,mBAAmB;gBAC1C,SAAS,EAAE,eAAe,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;aACzD,CAAC,CAAC,CACJ;YACD,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,KAAK;SAC7B,CAAC,CAAC,IAAI,CACL,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAC3D,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,EAC7C,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,KAAK,CAAC,IAAI,KAAK,gBAAgB,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC;YAClE,CAAC,CAAC,IAAI,cAAc,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;YAC5C,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,kBAAkB;gBACjC,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CACvC,EACD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CACxB;QAEH,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CACd,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAM;YAE9B,MAAM,aAAa,GAAG,CAAC,KAAmD,EAAE,EAAE,CAAC,CAAC;gBAC9E,OAAO;gBACP,OAAO;gBACP,KAAK;gBACL,SAAS,EAAE,eAAe,CAAC,GAAG,EAAE;aACjC,CAAC,CAAA;YAEF,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,IAAI,CACvD,gBAAgB,CAAC;gBACf,QAAQ,EAAE,2BAA2B;gBACrC,QAAQ,EAAE,oBAAoB;gBAC9B,MAAM,EAAE,aAAa;aACtB,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC,EAAE,KAAK,EAAE,IAAI,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CACzF,CAAA;YAED,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;gBAC9B,KAAK,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC;oBAC9B,OAAO;oBACP,OAAO;oBACP,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC;oBACjC,SAAS,EAAE,eAAe,CAAC,GAAG,EAAE;iBACjC,CAAC,CAAC,IAAI,CACL,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,KAAK,CAAC,IAAI,KAAK,kBAAkB;oBAC/B,CAAC,CAAC,KAAK;oBACP,CAAC,CAAC,IAAI,gBAAgB,CAAC,EAAE,KAAK,EAAE,IAAI,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CACjE,CACF,CAAA;YACH,CAAC;QACH,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI;QACJ,QAAQ,EAAE;YACR,IAAI,EAAE,oBAAoB;YAC1B,WAAW,EAAE,kFAAkF;YAC/F,QAAQ,EAAE,IAAI;YACd,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB;QACD,QAAQ,EAAE;YACR,iBAAiB,EAAE,IAAI;YACvB,QAAQ,EAAE,IAAI;SACf;KACF,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/common/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const MAX_TRANSPORT_PAYLOAD_BYTES = 900000;
+export declare const MAX_WS_MESSAGE_BYTES = 900000;
+export declare const MAX_DO_RPC_REQUEST_BYTES = 900000;
+export declare const MAX_HTTP_REQUEST_BYTES = 900000;
+export declare const MAX_PULL_EVENTS_PER_MESSAGE = 100;
+export declare const MAX_PUSH_EVENTS_PER_REQUEST = 100;
+//# sourceMappingURL=constants.d.ts.map

package/dist/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,2BAA2B,SAAU,CAAA;AAElD,eAAO,MAAM,oBAAoB,SAA8B,CAAA;AAC/D,eAAO,MAAM,wBAAwB,SAA8B,CAAA;AACnE,eAAO,MAAM,sBAAsB,SAA8B,CAAA;AAIjE,eAAO,MAAM,2BAA2B,MAAM,CAAA;AAC9C,eAAO,MAAM,2BAA2B,MAAM,CAAA"}

package/dist/common/constants.js

@@ -0,0 +1,17 @@
+// Shared transport limits for Cloudflare sync provider
+// Keep payloads comfortably below ~1MB frame caps across Cloudflare transports.
+// References:
+// - Durable Objects WebSockets + hibernation best practices:
+//   https://developers.cloudflare.com/durable-objects/best-practices/websockets/
+// - Workers platform limits (general context):
+//   https://developers.cloudflare.com/workers/platform/limits/
+// Empirically, frames just below 1MB can fail on hibernated DO WebSockets; we use 900_000 bytes to keep a safety margin.
+export const MAX_TRANSPORT_PAYLOAD_BYTES = 900_000;
+export const MAX_WS_MESSAGE_BYTES = MAX_TRANSPORT_PAYLOAD_BYTES;
+export const MAX_DO_RPC_REQUEST_BYTES = MAX_TRANSPORT_PAYLOAD_BYTES;
+export const MAX_HTTP_REQUEST_BYTES = MAX_TRANSPORT_PAYLOAD_BYTES;
+// Upper bound for items per message/request. Mirrors server broadcast chunking.
+// Not Cloudflare-enforced; chosen to balance payload size and latency.
+export const MAX_PULL_EVENTS_PER_MESSAGE = 100;
+export const MAX_PUSH_EVENTS_PER_REQUEST = 100;
+//# sourceMappingURL=constants.js.map

package/dist/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,gFAAgF;AAChF,cAAc;AACd,6DAA6D;AAC7D,iFAAiF;AACjF,+CAA+C;AAC/C,+DAA+D;AAC/D,yHAAyH;AACzH,MAAM,CAAC,MAAM,2BAA2B,GAAG,OAAO,CAAA;AAElD,MAAM,CAAC,MAAM,oBAAoB,GAAG,2BAA2B,CAAA;AAC/D,MAAM,CAAC,MAAM,wBAAwB,GAAG,2BAA2B,CAAA;AACnE,MAAM,CAAC,MAAM,sBAAsB,GAAG,2BAA2B,CAAA;AAEjE,gFAAgF;AAChF,uEAAuE;AACvE,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,CAAA;AAC9C,MAAM,CAAC,MAAM,2BAA2B,GAAG,GAAG,CAAA"}

package/dist/common/do-rpc-schema.d.ts

@@ -0,0 +1,76 @@
+import { InvalidPullError, InvalidPushError } from '@livestore/common';
+import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect';
+declare const SyncDoRpc_base: RpcGroup.RpcGroup<Rpc.Rpc<"SyncDoRpc.Pull", Schema.Struct<{
+    /**
+     * While the storeId is already implied by the durable object, we still need the explicit storeId
+     * since a DO doesn't know its own id.name value. 🫠
+     * https://community.cloudflare.com/t/how-can-i-get-the-name-of-a-durable-object-from-itself/505961/8
+     */
+    storeId: typeof Schema.String;
+    /** Needed for various reasons (e.g. auth) */
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+    /** Omitting the cursor will start from the beginning */
+    cursor: Schema.Option<Schema.Struct<{
+        backendId: Schema.SchemaClass<string, string, never>;
+        eventSequenceNumber: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+    }>>;
+    /** Whether to keep the pull stream alive and wait for more events */
+    rpcContext: Schema.optional<Schema.Struct<{
+        callerContext: Schema.Struct<{
+            bindingName: typeof Schema.String;
+            durableObjectId: typeof Schema.String;
+        }>;
+    }>>;
+}>, import("@effect/rpc/RpcSchema").Stream<Schema.Struct<{
+    batch: Schema.Array$<Schema.Struct<{
+        eventEncoded: Schema.Struct<{
+            name: typeof Schema.String;
+            args: typeof Schema.Any;
+            seqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+            parentSeqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+            clientId: typeof Schema.String;
+            sessionId: typeof Schema.String;
+        }>;
+        metadata: Schema.Option<Schema.Struct<{
+            _tag: Schema.tag<"SyncMessage.SyncMetadata">;
+        } & {
+            createdAt: typeof Schema.String;
+        }>>;
+    }>>;
+    pageInfo: Schema.Union<[Schema.TaggedStruct<"MoreUnknown", {}>, Schema.TaggedStruct<"MoreKnown", {
+        remaining: typeof Schema.Number;
+    }>, Schema.TaggedStruct<"NoMore", {}>]>;
+    backendId: Schema.SchemaClass<string, string, never>;
+    rpcRequestId: typeof Schema.String;
+}>, typeof InvalidPullError>, typeof Schema.Never, never> | Rpc.Rpc<"SyncDoRpc.Push", Schema.Struct<{
+    /**
+     * While the storeId is already implied by the durable object, we still need the explicit storeId
+     * since a DO doesn't know its own id.name value. 🫠
+     * https://community.cloudflare.com/t/how-can-i-get-the-name-of-a-durable-object-from-itself/505961/8
+     */
+    storeId: typeof Schema.String;
+    /** Needed for various reasons (e.g. auth) */
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+    batch: Schema.Array$<Schema.Struct<{
+        name: typeof Schema.String;
+        args: typeof Schema.Any;
+        seqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+        parentSeqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+        clientId: typeof Schema.String;
+        sessionId: typeof Schema.String;
+    }>>;
+    backendId: Schema.Option<Schema.SchemaClass<string, string, never>>;
+}>, Schema.Struct<{}>, typeof InvalidPushError, never> | Rpc.Rpc<"SyncDoRpc.Ping", Schema.Struct<{
+    /**
+     * While the storeId is already implied by the durable object, we still need the explicit storeId
+     * since a DO doesn't know its own id.name value. 🫠
+     * https://community.cloudflare.com/t/how-can-i-get-the-name-of-a-durable-object-from-itself/505961/8
+     */
+    storeId: typeof Schema.String;
+    /** Needed for various reasons (e.g. auth) */
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+}>, typeof Schema.Void, typeof Schema.Never, never>>;
+export declare class SyncDoRpc extends SyncDoRpc_base {
+}
+export {};
+//# sourceMappingURL=do-rpc-schema.d.ts.map

package/dist/common/do-rpc-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"do-rpc-schema.d.ts","sourceRoot":"","sources":["../../src/common/do-rpc-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;;IAI7D;;;;OAIG;;IAEH,6CAA6C;;IAOzC,wDAAwD;;;;;IAGxD,qEAAqE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAhBzE;;;;OAIG;;IAEH,6CAA6C;;;;;;;;;;;;IAN7C;;;;OAIG;;IAEH,6CAA6C;;;AAI/C,qBAAa,SAAU,SAAQ,cAsC9B;CAAG"}

package/dist/common/do-rpc-schema.js

@@ -0,0 +1,48 @@
+import { InvalidPullError, InvalidPushError } from '@livestore/common';
+import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect';
+import * as SyncMessage from "./sync-message-types.js";
+const commonPayloadFields = {
+    /**
+     * While the storeId is already implied by the durable object, we still need the explicit storeId
+     * since a DO doesn't know its own id.name value. 🫠
+     * https://community.cloudflare.com/t/how-can-i-get-the-name-of-a-durable-object-from-itself/505961/8
+     */
+    storeId: Schema.String,
+    /** Needed for various reasons (e.g. auth) */
+    payload: Schema.optional(Schema.JsonValue),
+};
+export class SyncDoRpc extends RpcGroup.make(Rpc.make('SyncDoRpc.Pull', {
+    payload: {
+        /** Omitting the cursor will start from the beginning */
+        cursor: SyncMessage.PullRequest.fields.cursor,
+        // TODO rename
+        /** Whether to keep the pull stream alive and wait for more events */
+        rpcContext: Schema.optional(Schema.Struct({
+            callerContext: Schema.Struct({
+                bindingName: Schema.String,
+                durableObjectId: Schema.String,
+            }),
+        })),
+        ...commonPayloadFields,
+    },
+    success: Schema.Struct({
+        rpcRequestId: Schema.String,
+        ...SyncMessage.PullResponse.fields,
+    }),
+    error: InvalidPullError,
+    stream: true,
+}), Rpc.make('SyncDoRpc.Push', {
+    payload: {
+        ...SyncMessage.PushRequest.fields,
+        ...commonPayloadFields,
+    },
+    success: SyncMessage.PushAck,
+    error: InvalidPushError,
+}), Rpc.make('SyncDoRpc.Ping', {
+    payload: {
+        ...commonPayloadFields,
+    },
+    success: Schema.Void,
+})) {
+}
+//# sourceMappingURL=do-rpc-schema.js.map

package/dist/common/do-rpc-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"do-rpc-schema.js","sourceRoot":"","sources":["../../src/common/do-rpc-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACtE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAA;AAEtD,MAAM,mBAAmB,GAAG;IAC1B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;CAC3C,CAAA;AAED,MAAM,OAAO,SAAU,SAAQ,QAAQ,CAAC,IAAI,CAC1C,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE;IACzB,OAAO,EAAE;QACP,wDAAwD;QACxD,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM;QAC7C,cAAc;QACd,qEAAqE;QACrE,UAAU,EAAE,MAAM,CAAC,QAAQ,CACzB,MAAM,CAAC,MAAM,CAAC;YACZ,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC;gBAC3B,WAAW,EAAE,MAAM,CAAC,MAAM;gBAC1B,eAAe,EAAE,MAAM,CAAC,MAAM;aAC/B,CAAC;SACH,CAAC,CACH;QACD,GAAG,mBAAmB;KACvB;IACD,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC,MAAM;QAC3B,GAAG,WAAW,CAAC,YAAY,CAAC,MAAM;KACnC,CAAC;IACF,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,IAAI;CACb,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE;IACzB,OAAO,EAAE;QACP,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM;QACjC,GAAG,mBAAmB;KACvB;IACD,OAAO,EAAE,WAAW,CAAC,OAAO;IAC5B,KAAK,EAAE,gBAAgB;CACxB,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE;IACzB,OAAO,EAAE;QACP,GAAG,mBAAmB;KACvB;IACD,OAAO,EAAE,MAAM,CAAC,IAAI;CACrB,CAAC,CACH;CAAG"}

package/dist/common/http-rpc-schema.d.ts

@@ -0,0 +1,58 @@
+import { InvalidPullError, InvalidPushError, UnknownError } from '@livestore/common';
+import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect';
+declare const SyncHttpRpc_base: RpcGroup.RpcGroup<Rpc.Rpc<"SyncHttpRpc.Pull", Schema.Struct<{
+    cursor: Schema.Option<Schema.Struct<{
+        backendId: Schema.SchemaClass<string, string, never>;
+        eventSequenceNumber: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+    }>>;
+    storeId: typeof Schema.String;
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+}>, import("@effect/rpc/RpcSchema").Stream<Schema.Struct<{
+    batch: Schema.Array$<Schema.Struct<{
+        eventEncoded: Schema.Struct<{
+            name: typeof Schema.String;
+            args: typeof Schema.Any;
+            seqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+            parentSeqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+            clientId: typeof Schema.String;
+            sessionId: typeof Schema.String;
+        }>;
+        metadata: Schema.Option<Schema.Struct<{
+            _tag: Schema.tag<"SyncMessage.SyncMetadata">;
+        } & {
+            createdAt: typeof Schema.String;
+        }>>;
+    }>>;
+    pageInfo: Schema.Union<[Schema.TaggedStruct<"MoreUnknown", {}>, Schema.TaggedStruct<"MoreKnown", {
+        remaining: typeof Schema.Number;
+    }>, Schema.TaggedStruct<"NoMore", {}>]>;
+    backendId: Schema.SchemaClass<string, string, never>;
+}>, typeof InvalidPullError>, typeof Schema.Never, never> | Rpc.Rpc<"SyncHttpRpc.Push", Schema.Struct<{
+    batch: Schema.Array$<Schema.Struct<{
+        name: typeof Schema.String;
+        args: typeof Schema.Any;
+        seqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+        parentSeqNum: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
+        clientId: typeof Schema.String;
+        sessionId: typeof Schema.String;
+    }>>;
+    backendId: Schema.Option<Schema.SchemaClass<string, string, never>>;
+    storeId: typeof Schema.String;
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+}>, Schema.Struct<{}>, typeof InvalidPushError, never> | Rpc.Rpc<"SyncHttpRpc.Ping", Schema.Struct<{
+    storeId: typeof Schema.String;
+    payload: Schema.optional<Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>;
+}>, Schema.Struct<{
+    _tag: Schema.tag<"SyncMessage.Pong">;
+}>, typeof UnknownError, never>>;
+/**
+ * HTTP RPC Schema for LiveStore CF Sync Provider
+ *
+ * This defines the RPC endpoints available over HTTP transport.
+ * Unlike WebSocket transport which maintains persistent connections,
+ * HTTP transport uses request/response patterns for each operation.
+ */
+export declare class SyncHttpRpc extends SyncHttpRpc_base {
+}
+export {};
+//# sourceMappingURL=http-rpc-schema.d.ts.map

package/dist/common/http-rpc-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-rpc-schema.d.ts","sourceRoot":"","sources":["../../src/common/http-rpc-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACpF,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAG/D;;;;;;GAMG;AACH,qBAAa,WAAY,SAAQ,gBA4BhC;CAAG"}

package/dist/common/http-rpc-schema.js

@@ -0,0 +1,37 @@
+import { InvalidPullError, InvalidPushError, UnknownError } from '@livestore/common';
+import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect';
+import * as SyncMessage from "./sync-message-types.js";
+/**
+ * HTTP RPC Schema for LiveStore CF Sync Provider
+ *
+ * This defines the RPC endpoints available over HTTP transport.
+ * Unlike WebSocket transport which maintains persistent connections,
+ * HTTP transport uses request/response patterns for each operation.
+ */
+export class SyncHttpRpc extends RpcGroup.make(Rpc.make('SyncHttpRpc.Pull', {
+    payload: Schema.Struct({
+        storeId: Schema.String,
+        payload: Schema.optional(Schema.JsonValue),
+        ...SyncMessage.PullRequest.fields,
+    }),
+    success: SyncMessage.PullResponse,
+    error: InvalidPullError,
+    stream: true,
+}), Rpc.make('SyncHttpRpc.Push', {
+    payload: Schema.Struct({
+        storeId: Schema.String,
+        payload: Schema.optional(Schema.JsonValue),
+        ...SyncMessage.PushRequest.fields,
+    }),
+    success: SyncMessage.PushAck,
+    error: InvalidPushError,
+}), Rpc.make('SyncHttpRpc.Ping', {
+    payload: Schema.Struct({
+        storeId: Schema.String,
+        payload: Schema.optional(Schema.JsonValue),
+    }),
+    success: SyncMessage.Pong,
+    error: UnknownError,
+})) {
+}
+//# sourceMappingURL=http-rpc-schema.js.map

package/dist/common/http-rpc-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-rpc-schema.js","sourceRoot":"","sources":["../../src/common/http-rpc-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACpF,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAA;AAEtD;;;;;;GAMG;AACH,MAAM,OAAO,WAAY,SAAQ,QAAQ,CAAC,IAAI,CAC5C,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC,MAAM;QACtB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM;KAClC,CAAC;IACF,OAAO,EAAE,WAAW,CAAC,YAAY;IACjC,KAAK,EAAE,gBAAgB;IACvB,MAAM,EAAE,IAAI;CACb,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC,MAAM;QACtB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1C,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM;KAClC,CAAC;IACF,OAAO,EAAE,WAAW,CAAC,OAAO;IAC5B,KAAK,EAAE,gBAAgB;CACxB,CAAC,EACF,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC,MAAM;QACtB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;KAC3C,CAAC;IACF,OAAO,EAAE,WAAW,CAAC,IAAI;IACzB,KAAK,EAAE,YAAY;CACpB,CAAC,CACH;CAAG"}

package/dist/common/mod.d.ts

@@ -1,7 +1,14 @@
+import { OversizeChunkItemError, splitChunkBySize } from '@livestore/common/sync';
 import { Schema } from '@livestore/utils/effect';
-export * as WSMessage from './ws-message-types.ts';
+export type { CfTypes } from '@livestore/common-cf';
+export * from './constants.ts';
+export { SyncHttpRpc } from './http-rpc-schema.ts';
+export * as SyncMessage from './sync-message-types.ts';
+export { OversizeChunkItemError, splitChunkBySize };
 export declare const SearchParamsSchema: Schema.Struct<{
     storeId: typeof Schema.String;
     payload: Schema.UndefinedOr<Schema.transform<Schema.transformOrFail<Schema.SchemaClass<string, string, never>, typeof Schema.String, never>, Schema.transform<Schema.SchemaClass<unknown, string, never>, Schema.Schema<Schema.JsonValue, Schema.JsonValue, never>>>>;
+    transport: Schema.Literal<["http", "ws"]>;
 }>;
+export type SearchParams = typeof SearchParamsSchema.Type;
 //# sourceMappingURL=mod.d.ts.map

package/dist/common/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/common/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAA;AAElD,eAAO,MAAM,kBAAkB;;;EAG7B,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/common/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,YAAY,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,cAAc,gBAAgB,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,CAAA;AAEnD,eAAO,MAAM,kBAAkB;;;;EAK7B,CAAA;AAEF,MAAM,MAAM,YAAY,GAAG,OAAO,kBAAkB,CAAC,IAAI,CAAA"}

package/dist/common/mod.js

@@ -1,7 +1,13 @@
+import { OversizeChunkItemError, splitChunkBySize } from '@livestore/common/sync';
 import { Schema } from '@livestore/utils/effect';
-export * as WSMessage from "./ws-message-types.js";
+export * from "./constants.js";
+export { SyncHttpRpc } from "./http-rpc-schema.js";
+export * as SyncMessage from "./sync-message-types.js";
+export { OversizeChunkItemError, splitChunkBySize };
 export const SearchParamsSchema = Schema.Struct({
     storeId: Schema.String,
     payload: Schema.compose(Schema.StringFromUriComponent, Schema.parseJson(Schema.JsonValue)).pipe(Schema.UndefinedOr),
+    // NOTE `do-rpc` is handled differently
+    transport: Schema.Literal('http', 'ws'),
 });
 //# sourceMappingURL=mod.js.map

package/dist/common/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../src/common/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAA;AAElD,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;CACpH,CAAC,CAAA"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../src/common/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACjF,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAGhD,cAAc,gBAAgB,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,KAAK,WAAW,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,CAAA;AAEnD,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9C,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IACnH,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC;CACxC,CAAC,CAAA"}