handleSyncRequest

handleSyncRequest<TEnv, TDurableObjectRpc, CFHostMetada, TSyncPayload>(__namedParameters): Promise<Response>

Defined in: packages/@livestore/sync-cf/src/cf-worker/worker.ts:156

Handles LiveStore sync requests (e.g. with search params ?storeId=...&transport=...).

Type Parameters

TEnv

TEnv extends Env = Env

TDurableObjectRpc

TDurableObjectRpc extends undefined | DurableObjectBranded = undefined

CFHostMetada

CFHostMetada = unknown

TSyncPayload

TSyncPayload = JsonValue

Parameters

__namedParameters

ctx

ExecutionContext

Only there for type-level reasons

env?

TEnv

headers?

HeadersInit

request

Request<CFHostMetada>

searchParams

{ payload: undefined | JsonValue; storeId: string; transport: "http" | "ws"; }

searchParams.payload

undefined | JsonValue = ...

searchParams.storeId

string = Schema.String

searchParams.transport

"http" | "ws" = ...

syncBackendBinding

ExtractDurableObjectKeys<TEnv>

Binding name of the sync backend Durable Object

syncPayloadSchema?

Schema<TSyncPayload, TSyncPayload, never>

validatePayload?

(payload, context) => void | Promise<void>

Returns

Promise<Response>

Example

const validatePayload = (payload: Schema.JsonValue | undefined, context: { storeId: string }) => {
  console.log(`Validating connection for store: ${context.storeId}`)
  if (payload?.authToken !== 'insecure-token-change-me') {
    throw new Error('Invalid auth token')
  }
}

export default {
  fetch: async (request, env, ctx) => {
    const searchParams = matchSyncRequest(request)

    // Is LiveStore sync request
    if (searchParams !== undefined) {
      return handleSyncRequest({
        request,
        searchParams,
        env,
        ctx,
        syncBackendBinding: 'SYNC_BACKEND_DO',
        headers: {},
        validatePayload,
      })
    }

    return new Response('Invalid path', { status: 400 })
  }
}

Throws

If the payload is invalid