@livestore/common 0.4.0 → 0.5.0-dev.0

package/src/sync/sync-backend-kv.ts

@@ -6,11 +6,13 @@ export const makeBackendIdHelper = Effect.gen(function* () {
   const kv = yield* KeyValueStore.KeyValueStore
 
   const backendIdKey = `backendId`
-  const backendIdRef = { current: yield* kv.get(backendIdKey).pipe(UnknownError.mapToUnknownError) }
+  const backendIdRef = {
+    current: Option.fromUndefinedOr(yield* kv.get(backendIdKey).pipe(UnknownError.mapToUnknownError)),
+  }
 
   const setBackendId = (backendId: string) =>
     Effect.gen(function* () {
-      if (backendIdRef.current._tag === 'None' || backendIdRef.current.value !== backendId) {
+      if (Option.getOrUndefined(backendIdRef.current) !== backendId) {
         backendIdRef.current = Option.some(backendId)
         yield* kv.set(backendIdKey, backendId)
       }

package/src/sync/sync-backend.ts

@@ -20,14 +20,14 @@ export * from './sync-backend-kv.ts'
 /**
  * Those arguments can be used to implement multi-tenancy etc and are passed in from the store.
  */
-export type MakeBackendArgs<TPayload = Schema.JsonValue> = {
+export type MakeBackendArgs<TPayload = Schema.Json> = {
   storeId: string
   clientId: string
   payload: TPayload | undefined
 }
 
 // TODO rename to `SyncProviderClientConstructor`
-export type SyncBackendConstructor<TSyncMetadata = Schema.JsonValue, TPayload = Schema.JsonValue> = (
+export type SyncBackendConstructor<TSyncMetadata = Schema.Json, TPayload = Schema.Json> = (
   args: MakeBackendArgs<TPayload>,
 ) => Effect.Effect<
   SyncBackend<TSyncMetadata>,
@@ -42,7 +42,7 @@ export type SyncBackendConstructor<TSyncMetadata = Schema.JsonValue, TPayload =
 //   - data center location (e.g. colo on CF workers)
 
 // TODO rename to `SyncProviderClient`
-export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
+export type SyncBackend<TSyncMetadata = Schema.Json> = {
   /**
    * Can be implemented to prepare a connection to the sync backend to speed up the first pull/push.
    */
@@ -61,7 +61,7 @@ export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
        */
       live?: boolean
     },
-  ) => Stream.Stream<PullResItem<TSyncMetadata>, IsOfflineError | BackendIdMismatchError | UnknownError >
+  ) => Stream.Stream<PullResItem<TSyncMetadata>, IsOfflineError | BackendIdMismatchError | UnknownError>
   // TODO support transactions (i.e. group of mutation events which need to be applied together)
   push: (
     /**
@@ -71,13 +71,13 @@ export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
      * */
     batch: ReadonlyArray<LiveStoreEvent.Global.Encoded>,
   ) => Effect.Effect<void, IsOfflineError | BackendIdMismatchError | UnknownError | ServerAheadError>
-  ping: Effect.Effect<void, IsOfflineError | UnknownError | Cause.TimeoutException>
+  ping: Effect.Effect<void, IsOfflineError | UnknownError | Cause.TimeoutError>
   // TODO also expose latency information additionally to whether the backend is connected
   isConnected: SubscriptionRef.SubscriptionRef<boolean>
   /**
    * Metadata describing the sync backend. (Currently only used by devtools.)
    */
-  metadata: { name: string; description: string } & Record<string, Schema.JsonValue>
+  metadata: { name: string; description: string } & Record<string, Schema.Json>
   /** Information about the sync backend capabilities. */
   supports: {
     /**
@@ -99,13 +99,13 @@ export const NetworkStatus = Schema.Struct({
   /** True when the upstream sync backend is reachable and responding to health checks. */
   isConnected: Schema.Boolean,
   /** Unix epoch timestamp (ms) of the latest connectivity state transition. */
-  timestampMs: Schema.Number,
+  timestampMs: Schema.Finite,
   /** Devtools specific metadata describing simulator overrides. */
   devtools: Schema.Struct({
     /** Indicates whether the devtools latch forced the client into an offline state. */
     latchClosed: Schema.Boolean,
   }),
-}).annotations({ title: 'NetworkStatus' })
+}).annotate({ title: 'NetworkStatus' })
 
 export type NetworkStatus = typeof NetworkStatus.Type
 
@@ -140,13 +140,13 @@ export const isSyncBackend = (value: unknown): value is SyncBackend<any> => {
   return hasCoreFns && hasSupports && hasMetadata && hasIsConnected
 }
 
-export const PullResPageInfo = Schema.Union(
+export const PullResPageInfo = Schema.Union([
   Schema.TaggedStruct('MoreUnknown', {}),
   Schema.TaggedStruct('MoreKnown', {
-    remaining: Schema.Number,
+    remaining: Schema.Finite,
   }),
   Schema.TaggedStruct('NoMore', {}),
-)
+])
 
 export type PullResPageInfo = typeof PullResPageInfo.Type
 
@@ -154,12 +154,12 @@ export const pageInfoNoMore: PullResPageInfo = { _tag: 'NoMore' } as const
 export const pageInfoMoreUnknown: PullResPageInfo = { _tag: 'MoreUnknown' } as const
 export const pageInfoMoreKnown = (remaining: number): PullResPageInfo => ({ _tag: 'MoreKnown', remaining })
 
-export const pullResItemEmpty = <TSyncMetadata = Schema.JsonValue>(): PullResItem<TSyncMetadata> => ({
+export const pullResItemEmpty = <TSyncMetadata = Schema.Json>(): PullResItem<TSyncMetadata> => ({
   batch: [],
   pageInfo: pageInfoNoMore,
 })
 
-export interface PullResItem<TSyncMetadata = Schema.JsonValue> {
+export interface PullResItem<TSyncMetadata = Schema.Json> {
   batch: ReadonlyArray<{
     eventEncoded: LiveStoreEvent.Global.Encoded
     metadata: Option.Option<TSyncMetadata>
@@ -167,12 +167,12 @@ export interface PullResItem<TSyncMetadata = Schema.JsonValue> {
   pageInfo: PullResPageInfo
 }
 
-export const of = <TSyncMetadata = Schema.JsonValue>(obj: SyncBackend<TSyncMetadata>) => obj
+export const of = <TSyncMetadata = Schema.Json>(obj: SyncBackend<TSyncMetadata>) => obj
 
 /**
  * Useful to continue pulling from the last event in the batch.
  */
-export const cursorFromPullResItem = <TSyncMetadata = Schema.JsonValue>(
+export const cursorFromPullResItem = <TSyncMetadata = Schema.Json>(
   item: PullResItem<TSyncMetadata>,
 ): Option.Option<{
   eventSequenceNumber: EventSequenceNumber.Global.Type

package/src/sync/sync.ts

@@ -6,7 +6,7 @@ import type { Schema } from '@livestore/utils/effect'
 import type { InitialSyncOptions } from '../leader-thread/types.ts'
 import type { SyncBackendConstructor } from './sync-backend.ts'
 
-export type SyncOptions<TPayload = Schema.JsonValue> = {
+export type SyncOptions<TPayload = Schema.Json> = {
   backend?: SyncBackendConstructor<any, TPayload>
   /** @default { _tag: 'Skip' } */
   initialSyncOptions?: InitialSyncOptions