@livestore/sync-cf 0.4.0-dev.9 → 0.5.0-dev.0

package/src/common/do-rpc-schema.ts

@@ -1,16 +1,17 @@
-import { InvalidPullError, InvalidPushError } from '@livestore/common'
+import { BackendIdMismatchError, ServerAheadError, UnknownError } from '@livestore/common'
 import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect'
+
 import * as SyncMessage from './sync-message-types.ts'
 
 const commonPayloadFields = {
   /**
-   * While the storeId is already implied by the durable object, we still need the explicit storeId
+   * 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),
+  payload: Schema.optional(Schema.Json),
 }
 
 export class SyncDoRpc extends RpcGroup.make(
@@ -34,7 +35,7 @@ export class SyncDoRpc extends RpcGroup.make(
       rpcRequestId: Schema.String,
       ...SyncMessage.PullResponse.fields,
     }),
-    error: InvalidPullError,
+    error: Schema.Union([UnknownError, BackendIdMismatchError]),
     stream: true,
   }),
   Rpc.make('SyncDoRpc.Push', {
@@ -43,7 +44,7 @@ export class SyncDoRpc extends RpcGroup.make(
       ...commonPayloadFields,
     },
     success: SyncMessage.PushAck,
-    error: InvalidPushError,
+    error: Schema.Union([UnknownError, ServerAheadError, BackendIdMismatchError]),
   }),
   Rpc.make('SyncDoRpc.Ping', {
     payload: {

package/src/common/http-rpc-schema.ts

@@ -1,5 +1,6 @@
-import { InvalidPullError, InvalidPushError, UnexpectedError } from '@livestore/common'
+import { BackendIdMismatchError, ServerAheadError, UnknownError } from '@livestore/common'
 import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect'
+
 import * as SyncMessage from './sync-message-types.ts'
 
 /**
@@ -13,28 +14,28 @@ export class SyncHttpRpc extends RpcGroup.make(
   Rpc.make('SyncHttpRpc.Pull', {
     payload: Schema.Struct({
       storeId: Schema.String,
-      payload: Schema.optional(Schema.JsonValue),
+      payload: Schema.optional(Schema.Json),
       ...SyncMessage.PullRequest.fields,
     }),
     success: SyncMessage.PullResponse,
-    error: InvalidPullError,
+    error: Schema.Union([UnknownError, BackendIdMismatchError]),
     stream: true,
   }),
   Rpc.make('SyncHttpRpc.Push', {
     payload: Schema.Struct({
       storeId: Schema.String,
-      payload: Schema.optional(Schema.JsonValue),
+      payload: Schema.optional(Schema.Json),
       ...SyncMessage.PushRequest.fields,
     }),
     success: SyncMessage.PushAck,
-    error: InvalidPushError,
+    error: Schema.Union([UnknownError, ServerAheadError, BackendIdMismatchError]),
   }),
   Rpc.make('SyncHttpRpc.Ping', {
     payload: Schema.Struct({
       storeId: Schema.String,
-      payload: Schema.optional(Schema.JsonValue),
+      payload: Schema.optional(Schema.Json),
     }),
     success: SyncMessage.Pong,
-    error: UnexpectedError,
+    error: UnknownError,
   }),
 ) {}

package/src/common/mod.ts

@@ -1,15 +1,16 @@
+export { OversizeChunkItemError, splitArrayBySize } from '@livestore/common/sync'
 import { Schema } from '@livestore/utils/effect'
 
 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 const SearchParamsSchema = Schema.Struct({
   storeId: Schema.String,
-  payload: Schema.compose(Schema.StringFromUriComponent, Schema.parseJson(Schema.JsonValue)).pipe(Schema.UndefinedOr),
+  payload: Schema.optional(Schema.StringFromUriComponent.pipe(Schema.decodeTo(Schema.fromJsonString(Schema.Json)))),
   // NOTE `do-rpc` is handled differently
-  transport: Schema.Union(Schema.Literal('http'), Schema.Literal('ws')),
+  transport: Schema.Literals(['http', 'ws']),
 })
 
 export type SearchParams = typeof SearchParamsSchema.Type

package/src/common/sync-message-types.ts

@@ -11,7 +11,7 @@ import { Schema } from '@livestore/utils/effect'
 export const SyncMetadata = Schema.TaggedStruct('SyncMessage.SyncMetadata', {
   /** ISO date format */
   createdAt: Schema.String,
-}).annotations({ title: '@livestore/sync-cf:SyncMetadata' })
+}).annotate({ title: '@livestore/sync-cf:SyncMetadata' })
 
 export type SyncMetadata = typeof SyncMetadata.Type
 
@@ -20,23 +20,23 @@ export const PullRequest = Schema.Struct({
   cursor: Schema.Option(
     Schema.Struct({
       backendId: BackendId,
-      eventSequenceNumber: EventSequenceNumber.GlobalEventSequenceNumber,
+      eventSequenceNumber: EventSequenceNumber.Global.Schema,
     }),
   ),
-}).annotations({ title: '@livestore/sync-cf:PullRequest' })
+}).annotate({ title: '@livestore/sync-cf:PullRequest' })
 
 export type PullRequest = typeof PullRequest.Type
 
 export const PullResponse = Schema.Struct({
   batch: Schema.Array(
     Schema.Struct({
-      eventEncoded: LiveStoreEvent.AnyEncodedGlobal,
+      eventEncoded: LiveStoreEvent.Global.Encoded,
       metadata: Schema.Option(SyncMetadata),
     }),
   ),
   pageInfo: SyncBackend.PullResPageInfo,
   backendId: BackendId,
-}).annotations({ title: '@livestore/sync-cf:PullResponse' })
+}).annotate({ title: '@livestore/sync-cf:PullResponse' })
 
 export const emptyPullResponse = (backendId: string) =>
   PullResponse.make({
@@ -48,34 +48,34 @@ export const emptyPullResponse = (backendId: string) =>
 export type PullResponse = typeof PullResponse.Type
 
 export const PushRequest = Schema.Struct({
-  batch: Schema.Array(LiveStoreEvent.AnyEncodedGlobal),
+  batch: Schema.Array(LiveStoreEvent.Global.Encoded),
   backendId: Schema.Option(BackendId),
-}).annotations({ title: '@livestore/sync-cf:PushRequest' })
+}).annotate({ title: '@livestore/sync-cf:PushRequest' })
 
 export type PushRequest = typeof PushRequest.Type
 
-export const PushAck = Schema.Struct({}).annotations({
+export const PushAck = Schema.Struct({}).annotate({
   title: '@livestore/sync-cf:PushAck',
 })
 
 export type PushAck = typeof PushAck.Type
 
-export const Ping = Schema.TaggedStruct('SyncMessage.Ping', {}).annotations({ title: '@livestore/sync-cf:Ping' })
+export const Ping = Schema.TaggedStruct('SyncMessage.Ping', {}).annotate({ title: '@livestore/sync-cf:Ping' })
 
 export type Ping = typeof Ping.Type
 
-export const Pong = Schema.TaggedStruct('SyncMessage.Pong', {}).annotations({ title: '@livestore/sync-cf:Pong' })
+export const Pong = Schema.TaggedStruct('SyncMessage.Pong', {}).annotate({ title: '@livestore/sync-cf:Pong' })
 
 export type Pong = typeof Pong.Type
 
 // Admin operations
 export const AdminResetRoomRequest = Schema.TaggedStruct('SyncMessage.AdminResetRoomRequest', {
   adminSecret: Schema.String,
-}).annotations({ title: '@livestore/sync-cf:AdminResetRoomRequest' })
+}).annotate({ title: '@livestore/sync-cf:AdminResetRoomRequest' })
 
 export type AdminResetRoomRequest = typeof AdminResetRoomRequest.Type
 
-export const AdminResetRoomResponse = Schema.TaggedStruct('SyncMessage.AdminResetRoomResponse', {}).annotations({
+export const AdminResetRoomResponse = Schema.TaggedStruct('SyncMessage.AdminResetRoomResponse', {}).annotate({
   title: '@livestore/sync-cf:AdminResetRoomResponse',
 })
 
@@ -83,7 +83,7 @@ export type AdminResetRoomResponse = typeof AdminResetRoomResponse.Type
 
 export const AdminInfoRequest = Schema.TaggedStruct('SyncMessage.AdminInfoRequest', {
   adminSecret: Schema.String,
-}).annotations({ title: '@livestore/sync-cf:AdminInfoRequest' })
+}).annotate({ title: '@livestore/sync-cf:AdminInfoRequest' })
 
 export type AdminInfoRequest = typeof AdminInfoRequest.Type
 
@@ -91,27 +91,27 @@ export const AdminInfoResponse = Schema.TaggedStruct('SyncMessage.AdminInfoRespo
   info: Schema.Struct({
     durableObjectId: Schema.String,
   }),
-}).annotations({ title: '@livestore/sync-cf:AdminInfoResponse' })
+}).annotate({ title: '@livestore/sync-cf:AdminInfoResponse' })
 
 export type AdminInfoResponse = typeof AdminInfoResponse.Type
 
-export const BackendToClientMessage = Schema.Union(
+export const BackendToClientMessage = Schema.Union([
   PullResponse,
   PushAck,
   Pong,
   AdminResetRoomResponse,
   AdminInfoResponse,
-)
+])
 export type BackendToClientMessage = typeof BackendToClientMessage.Type
 
-export const ClientToBackendMessage = Schema.Union(
+export const ClientToBackendMessage = Schema.Union([
   PullRequest,
   PushRequest,
   Ping,
   AdminResetRoomRequest,
   AdminInfoRequest,
-)
+])
 export type ClientToBackendMessage = typeof ClientToBackendMessage.Type
 
-export const Message = Schema.Union(BackendToClientMessage, ClientToBackendMessage)
+export const Message = Schema.Union([BackendToClientMessage, ClientToBackendMessage])
 export type Message = typeof Message.Type

package/src/common/ws-rpc-schema.ts

@@ -1,5 +1,6 @@
-import { InvalidPullError, InvalidPushError } from '@livestore/common'
+import { BackendIdMismatchError, ServerAheadError, UnknownError } from '@livestore/common'
 import { Rpc, RpcGroup, Schema } from '@livestore/utils/effect'
+
 import * as SyncMessage from './sync-message-types.ts'
 
 /**
@@ -13,23 +14,23 @@ export class SyncWsRpc extends RpcGroup.make(
   Rpc.make('SyncWsRpc.Pull', {
     payload: Schema.Struct({
       storeId: Schema.String,
-      payload: Schema.optional(Schema.JsonValue),
+      payload: Schema.optional(Schema.Json),
       /** Whether to keep the pull stream alive and wait for more events */
       live: Schema.Boolean,
       ...SyncMessage.PullRequest.fields,
     }),
     success: SyncMessage.PullResponse,
-    error: InvalidPullError,
+    error: Schema.Union([UnknownError, BackendIdMismatchError]),
     stream: true,
   }),
   Rpc.make('SyncWsRpc.Push', {
     payload: Schema.Struct({
       storeId: Schema.String,
-      payload: Schema.optional(Schema.JsonValue),
+      payload: Schema.optional(Schema.Json),
       ...SyncMessage.PushRequest.fields,
     }),
     success: SyncMessage.PushAck,
-    error: InvalidPushError,
+    error: Schema.Union([UnknownError, ServerAheadError, BackendIdMismatchError]),
   }),
   // Ping <> Pong is handled by DO WS auto-response
   // TODO add admin RPCs

package/dist/cf-worker/do/ws-chunking.d.ts

@@ -1,22 +0,0 @@
-import { Chunk } from '@livestore/utils/effect';
-/**
- * Configuration describing how to break a chunk into smaller payload-safe chunks.
- */
-export interface ChunkingOptions<A> {
-    /** Maximum number of items that may appear in any emitted chunk. */
-    readonly maxItems: number;
-    /** Maximum encoded byte size allowed for any emitted chunk. */
-    readonly maxBytes: number;
-    /**
-     * Callback that produces a JSON-serialisable structure whose byte size should
-     * fit within {@link maxBytes}. This lets callers control framing overhead.
-     */
-    readonly encode: (items: ReadonlyArray<A>) => unknown;
-}
-/**
- * Derives a function that splits an input chunk into sub-chunks confined by
- * both item count and encoded byte size limits. Designed for transports with
- * strict frame caps (e.g. Cloudflare hibernated WebSockets).
- */
-export declare const splitChunkBySize: <A>(options: ChunkingOptions<A>) => (chunk: Chunk.Chunk<A>) => Chunk.Chunk<Chunk.Chunk<A>>;
-//# sourceMappingURL=ws-chunking.d.ts.map

package/dist/cf-worker/do/ws-chunking.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ws-chunking.d.ts","sourceRoot":"","sources":["../../../src/cf-worker/do/ws-chunking.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAI/C;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,oEAAoE;IACpE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,OAAO,CAAA;CACtD;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC1B,CAAC,EAAE,SAAS,eAAe,CAAC,CAAC,CAAC,MAC9B,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAiDlD,CAAA"}

package/dist/cf-worker/do/ws-chunking.js

@@ -1,49 +0,0 @@
-import { Chunk } from '@livestore/utils/effect';
-const textEncoder = new TextEncoder();
-/**
- * Derives a function that splits an input chunk into sub-chunks confined by
- * both item count and encoded byte size limits. Designed for transports with
- * strict frame caps (e.g. Cloudflare hibernated WebSockets).
- */
-export const splitChunkBySize = (options) => (chunk) => {
-    const maxItems = Math.max(1, options.maxItems);
-    const maxBytes = Math.max(1, options.maxBytes);
-    const encode = options.encode;
-    const measure = (items) => {
-        const encoded = encode(items);
-        return textEncoder.encode(JSON.stringify(encoded)).byteLength;
-    };
-    const items = Chunk.toReadonlyArray(chunk);
-    if (items.length === 0) {
-        return Chunk.fromIterable([]);
-    }
-    const result = [];
-    let current = [];
-    const flushCurrent = () => {
-        if (current.length > 0) {
-            result.push(Chunk.fromIterable(current));
-            current = [];
-        }
-    };
-    for (const item of items) {
-        current.push(item);
-        const exceedsLimit = current.length > maxItems || measure(current) > maxBytes;
-        if (exceedsLimit) {
-            // remove the item we just added and emit the previous chunk if it exists
-            const last = current.pop();
-            flushCurrent();
-            if (last !== undefined) {
-                current = [last];
-                const singleItemTooLarge = measure(current) > maxBytes;
-                if (singleItemTooLarge || current.length > maxItems) {
-                    // Emit the oversized item on its own; downstream can decide how to handle it.
-                    result.push(Chunk.of(last));
-                    current = [];
-                }
-            }
-        }
-    }
-    flushCurrent();
-    return Chunk.fromIterable(result);
-};
-//# sourceMappingURL=ws-chunking.js.map

package/dist/cf-worker/do/ws-chunking.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ws-chunking.js","sourceRoot":"","sources":["../../../src/cf-worker/do/ws-chunking.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAE/C,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAA;AAiBrC;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAC3B,CAAI,OAA2B,EAAE,EAAE,CACnC,CAAC,KAAqB,EAA+B,EAAE;IACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;IAE7B,MAAM,OAAO,GAAG,CAAC,KAAuB,EAAE,EAAE;QAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;QAC7B,OAAO,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAA;IAC/D,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;IAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,YAAY,CAAiB,EAAE,CAAC,CAAA;IAC/C,CAAC;IAED,MAAM,MAAM,GAA0B,EAAE,CAAA;IACxC,IAAI,OAAO,GAAa,EAAE,CAAA;IAE1B,MAAM,YAAY,GAAG,GAAG,EAAE;QACxB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;YACxC,OAAO,GAAG,EAAE,CAAA;QACd,CAAC;IACH,CAAC,CAAA;IAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClB,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAA;QAE7E,IAAI,YAAY,EAAE,CAAC;YACjB,yEAAyE;YACzE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAG,CAAA;YAC3B,YAAY,EAAE,CAAA;YAEd,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvB,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;gBAChB,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAA;gBACtD,IAAI,kBAAkB,IAAI,OAAO,CAAC,MAAM,GAAG,QAAQ,EAAE,CAAC;oBACpD,8EAA8E;oBAC9E,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAA;oBAC3B,OAAO,GAAG,EAAE,CAAA;gBACd,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,YAAY,EAAE,CAAA;IAEd,OAAO,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;AACnC,CAAC,CAAA"}

package/src/cf-worker/do/ws-chunking.ts

@@ -1,76 +0,0 @@
-import { Chunk } from '@livestore/utils/effect'
-
-const textEncoder = new TextEncoder()
-
-/**
- * Configuration describing how to break a chunk into smaller payload-safe chunks.
- */
-export interface ChunkingOptions<A> {
-  /** Maximum number of items that may appear in any emitted chunk. */
-  readonly maxItems: number
-  /** Maximum encoded byte size allowed for any emitted chunk. */
-  readonly maxBytes: number
-  /**
-   * Callback that produces a JSON-serialisable structure whose byte size should
-   * fit within {@link maxBytes}. This lets callers control framing overhead.
-   */
-  readonly encode: (items: ReadonlyArray<A>) => unknown
-}
-
-/**
- * Derives a function that splits an input chunk into sub-chunks confined by
- * both item count and encoded byte size limits. Designed for transports with
- * strict frame caps (e.g. Cloudflare hibernated WebSockets).
- */
-export const splitChunkBySize =
-  <A>(options: ChunkingOptions<A>) =>
-  (chunk: Chunk.Chunk<A>): Chunk.Chunk<Chunk.Chunk<A>> => {
-    const maxItems = Math.max(1, options.maxItems)
-    const maxBytes = Math.max(1, options.maxBytes)
-    const encode = options.encode
-
-    const measure = (items: ReadonlyArray<A>) => {
-      const encoded = encode(items)
-      return textEncoder.encode(JSON.stringify(encoded)).byteLength
-    }
-
-    const items = Chunk.toReadonlyArray(chunk)
-    if (items.length === 0) {
-      return Chunk.fromIterable<Chunk.Chunk<A>>([])
-    }
-
-    const result: Array<Chunk.Chunk<A>> = []
-    let current: Array<A> = []
-
-    const flushCurrent = () => {
-      if (current.length > 0) {
-        result.push(Chunk.fromIterable(current))
-        current = []
-      }
-    }
-
-    for (const item of items) {
-      current.push(item)
-      const exceedsLimit = current.length > maxItems || measure(current) > maxBytes
-
-      if (exceedsLimit) {
-        // remove the item we just added and emit the previous chunk if it exists
-        const last = current.pop()!
-        flushCurrent()
-
-        if (last !== undefined) {
-          current = [last]
-          const singleItemTooLarge = measure(current) > maxBytes
-          if (singleItemTooLarge || current.length > maxItems) {
-            // Emit the oversized item on its own; downstream can decide how to handle it.
-            result.push(Chunk.of(last))
-            current = []
-          }
-        }
-      }
-    }
-
-    flushCurrent()
-
-    return Chunk.fromIterable(result)
-  }