@livestore/sync-s2 0.0.0-snapshot-446f5de211c4578498f20693bd2998869be3e796

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@livestore/sync-s2",
+  "version": "0.0.0-snapshot-446f5de211c4578498f20693bd2998869be3e796",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/mod.js",
+    "./s2-proxy-helpers": "./dist/s2-proxy-helpers.js"
+  },
+  "dependencies": {
+    "@livestore/common": "0.0.0-snapshot-446f5de211c4578498f20693bd2998869be3e796",
+    "@livestore/livestore": "0.0.0-snapshot-446f5de211c4578498f20693bd2998869be3e796",
+    "@livestore/utils": "0.0.0-snapshot-446f5de211c4578498f20693bd2998869be3e796"
+  },
+  "devDependencies": {},
+  "files": [
+    "package.json",
+    "src",
+    "dist"
+  ],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "",
+    "test": "echo 'No tests yet'"
+  }
+}

package/src/api-schema.test.ts

@@ -0,0 +1,21 @@
+import { Schema } from '@livestore/utils/effect'
+import { describe, expect, it } from 'vitest'
+import * as Api from './api-schema.ts'
+import { decodePullArgsFromSearchParams } from './make-s2-url.ts'
+import { s2SeqNum } from './types.ts'
+
+describe('ApiSchema', () => {
+  it('encodes and decodes PullArgs via args search param', () => {
+    const args = Api.PullArgs.make({ storeId: 'store-1', s2SeqNum: s2SeqNum(42), live: true, payload: { a: 1 } })
+    const encoded = Schema.encodeSync(Api.ArgsSchema)(args)
+    const sp = new URLSearchParams({ args: encoded })
+    const roundtrip = decodePullArgsFromSearchParams(sp)
+    expect(roundtrip).toEqual(args)
+  })
+
+  it('decodes PushPayload with typed events', () => {
+    const payload = Api.PushPayload.make({ storeId: 's', batch: [] })
+    const decoded = Schema.decodeUnknownEither(Api.PushPayload)(payload)
+    expect(decoded._tag).toBe('Right')
+  })
+})

package/src/api-schema.ts

@@ -0,0 +1,24 @@
+import { LiveStoreEvent } from '@livestore/common/schema'
+import { Schema } from '@livestore/utils/effect'
+import { S2SeqNum } from './types.ts'
+
+export const PullArgs = Schema.Struct({
+  storeId: Schema.String,
+  s2SeqNum: Schema.Union(S2SeqNum, Schema.Literal('from-start')),
+  live: Schema.Boolean,
+  payload: Schema.UndefinedOr(Schema.JsonValue),
+})
+
+export const PushPayload = Schema.Struct({
+  storeId: Schema.String,
+  batch: Schema.Array(LiveStoreEvent.AnyEncodedGlobal),
+})
+
+export type PullArgs = typeof PullArgs.Type
+export type PushPayload = typeof PushPayload.Type
+
+/** Encoded form for query parameter `args` */
+export const ArgsSchema = Schema.compose(Schema.StringFromUriComponent, Schema.parseJson(PullArgs))
+
+export const PushResponse = Schema.Struct({ success: Schema.Boolean })
+export type PushResponse = typeof PushResponse.Type

package/src/decode.ts

@@ -0,0 +1,28 @@
+import { LiveStoreEvent } from '@livestore/common/schema'
+import { Option, Schema } from '@livestore/utils/effect'
+import type * as HttpClientGenerated from './http-client-generated.ts'
+import { S2SeqNum } from './types.ts'
+
+const ReadBatchSchema = Schema.Struct({
+  records: Schema.Array(
+    Schema.Struct({
+      body: Schema.optional(Schema.parseJson(LiveStoreEvent.AnyEncodedGlobal)),
+      seq_num: S2SeqNum,
+    }),
+  ),
+}).annotations({ title: '@livestore/sync-s2:ReadBatchSchema' })
+
+export const decodeReadBatch = (
+  readBatch: typeof HttpClientGenerated.ReadBatch.Type,
+): ReadonlyArray<{
+  eventEncoded: LiveStoreEvent.AnyEncodedGlobal
+  metadata: Option.Option<{ s2SeqNum: S2SeqNum }>
+}> => {
+  const decoded = Schema.decodeSync(ReadBatchSchema)(readBatch)
+  return decoded.records
+    .filter((r): r is { body: LiveStoreEvent.AnyEncodedGlobal; seq_num: S2SeqNum } => r.body !== undefined)
+    .map((r) => ({
+      eventEncoded: r.body,
+      metadata: Option.some({ s2SeqNum: r.seq_num }),
+    }))
+}