@livestore/common 0.4.0-dev.3 → 0.4.0-dev.5

package/dist/sync/sync-backend.d.ts

@@ -0,0 +1,85 @@
+import { type Cause, type Effect, type HttpClient, type KeyValueStore, Option, Schema, type Scope, type Stream, type SubscriptionRef } from '@livestore/utils/effect';
+import type { UnexpectedError } from '../adapter-types.ts';
+import type * as LiveStoreEvent from '../schema/LiveStoreEvent.ts';
+import type { EventSequenceNumber } from '../schema/mod.ts';
+import type { InvalidPullError, InvalidPushError, IsOfflineError } from './errors.ts';
+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 = {
+    storeId: string;
+    clientId: string;
+    payload: Schema.JsonValue | undefined;
+};
+export type SyncBackendConstructor<TSyncMetadata = Schema.JsonValue> = (args: MakeBackendArgs) => Effect.Effect<SyncBackend<TSyncMetadata>, UnexpectedError, Scope.Scope | HttpClient.HttpClient | KeyValueStore.KeyValueStore>;
+export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
+    /**
+     * Can be implemented to prepare a connection to the sync backend to speed up the first pull/push.
+     */
+    connect: Effect.Effect<void, IsOfflineError | UnexpectedError, Scope.Scope>;
+    pull: (cursor: Option.Option<{
+        eventSequenceNumber: EventSequenceNumber.GlobalEventSequenceNumber;
+        /** Metadata is needed by some sync backends */
+        metadata: Option.Option<TSyncMetadata>;
+    }>, options?: {
+        /**
+         * If true, the sync backend will return a stream of events that have been pushed after the cursor.
+         *
+         * @default false
+         */
+        live?: boolean;
+    }) => Stream.Stream<PullResItem<TSyncMetadata>, IsOfflineError | InvalidPullError>;
+    push: (
+    /**
+     * Constraints for batch:
+     * - Number of events: 1-100
+     * - sequence numbers must be in ascending order
+     * */
+    batch: ReadonlyArray<LiveStoreEvent.AnyEncodedGlobal>) => Effect.Effect<void, IsOfflineError | InvalidPushError>;
+    ping: Effect.Effect<void, IsOfflineError | UnexpectedError | Cause.TimeoutException>;
+    isConnected: SubscriptionRef.SubscriptionRef<boolean>;
+    /**
+     * Metadata describing the sync backend. (Currently only used by devtools.)
+     */
+    metadata: {
+        name: string;
+        description: string;
+    } & Record<string, Schema.JsonValue>;
+    /** Information about the sync backend capabilities. */
+    supports: {
+        /**
+         * Whether the sync backend supports the `hasMore` field in the pull response.
+         */
+        pullPageInfoKnown: boolean;
+        /**
+         * Whether the sync backend supports the `live` option for the pull method and thus
+         * long-lived, reactive pull streams.
+         */
+        pullLive: boolean;
+    };
+};
+export declare const PullResPageInfo: Schema.Union<[Schema.TaggedStruct<"MoreUnknown", {}>, Schema.TaggedStruct<"MoreKnown", {
+    remaining: typeof Schema.Number;
+}>, Schema.TaggedStruct<"NoMore", {}>]>;
+export type PullResPageInfo = typeof PullResPageInfo.Type;
+export declare const pageInfoNoMore: PullResPageInfo;
+export declare const pageInfoMoreUnknown: PullResPageInfo;
+export declare const pageInfoMoreKnown: (remaining: number) => PullResPageInfo;
+export declare const pullResItemEmpty: <TSyncMetadata = Schema.JsonValue>() => PullResItem<TSyncMetadata>;
+export interface PullResItem<TSyncMetadata = Schema.JsonValue> {
+    batch: ReadonlyArray<{
+        eventEncoded: LiveStoreEvent.AnyEncodedGlobal;
+        metadata: Option.Option<TSyncMetadata>;
+    }>;
+    pageInfo: PullResPageInfo;
+}
+export declare const of: <TSyncMetadata = Schema.JsonValue>(obj: SyncBackend<TSyncMetadata>) => SyncBackend<TSyncMetadata>;
+/**
+ * Useful to continue pulling from the last event in the batch.
+ */
+export declare const cursorFromPullResItem: <TSyncMetadata = Schema.JsonValue>(item: PullResItem<TSyncMetadata>) => Option.Option<{
+    eventSequenceNumber: EventSequenceNumber.GlobalEventSequenceNumber;
+    metadata: Option.Option<TSyncMetadata>;
+}>;
+//# sourceMappingURL=sync-backend.d.ts.map

package/dist/sync/sync-backend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-backend.d.ts","sourceRoot":"","sources":["../../src/sync/sync-backend.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,KAAK,EACV,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,MAAM,EACN,MAAM,EACN,KAAK,KAAK,EACV,KAAK,MAAM,EACX,KAAK,eAAe,EACrB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAClE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAErF,cAAc,sBAAsB,CAAA;AAEpC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAA;CACtC,CAAA;AAGD,MAAM,MAAM,sBAAsB,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS,IAAI,CACrE,IAAI,EAAE,eAAe,KAClB,MAAM,CAAC,MAAM,CAChB,WAAW,CAAC,aAAa,CAAC,EAC1B,eAAe,EACf,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,UAAU,GAAG,aAAa,CAAC,aAAa,CAClE,CAAA;AASD,MAAM,MAAM,WAAW,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS,IAAI;IAC1D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IAC3E,IAAI,EAAE,CACJ,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;QACpB,mBAAmB,EAAE,mBAAmB,CAAC,yBAAyB,CAAA;QAClE,+CAA+C;QAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;KACvC,CAAC,EACF,OAAO,CAAC,EAAE;QACR;;;;WAIG;QACH,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,KACE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,cAAc,GAAG,gBAAgB,CAAC,CAAA;IAEjF,IAAI,EAAE;IACJ;;;;SAIK;IACL,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,KAClD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,gBAAgB,CAAC,CAAA;IAC3D,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,eAAe,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAA;IAEpF,WAAW,EAAE,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;IACrD;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;IAClF,uDAAuD;IACvD,QAAQ,EAAE;QACR;;WAEG;QACH,iBAAiB,EAAE,OAAO,CAAA;QAC1B;;;WAGG;QACH,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAA;CACF,CAAA;AAED,eAAO,MAAM,eAAe;;uCAM3B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD,eAAO,MAAM,cAAc,EAAE,eAA6C,CAAA;AAC1E,eAAO,MAAM,mBAAmB,EAAE,eAAkD,CAAA;AACpF,eAAO,MAAM,iBAAiB,GAAI,WAAW,MAAM,KAAG,eAAqD,CAAA;AAE3G,eAAO,MAAM,gBAAgB,GAAI,aAAa,GAAG,MAAM,CAAC,SAAS,OAAK,WAAW,CAAC,aAAa,CAG7F,CAAA;AAEF,MAAM,WAAW,WAAW,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS;IAC3D,KAAK,EAAE,aAAa,CAAC;QACnB,YAAY,EAAE,cAAc,CAAC,gBAAgB,CAAA;QAC7C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;KACvC,CAAC,CAAA;IACF,QAAQ,EAAE,eAAe,CAAA;CAC1B;AAED,eAAO,MAAM,EAAE,GAAI,aAAa,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,WAAW,CAAC,aAAa,CAAC,+BAAQ,CAAA;AAE5F;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAAI,aAAa,GAAG,MAAM,CAAC,SAAS,EACpE,MAAM,WAAW,CAAC,aAAa,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC;IACf,mBAAmB,EAAE,mBAAmB,CAAC,yBAAyB,CAAA;IAClE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;CACvC,CAMA,CAAA"}

package/dist/sync/sync-backend.js

@@ -0,0 +1,24 @@
+import { Option, Schema, } from '@livestore/utils/effect';
+export * from "./sync-backend-kv.js";
+export const PullResPageInfo = Schema.Union(Schema.TaggedStruct('MoreUnknown', {}), Schema.TaggedStruct('MoreKnown', {
+    remaining: Schema.Number,
+}), Schema.TaggedStruct('NoMore', {}));
+export const pageInfoNoMore = { _tag: 'NoMore' };
+export const pageInfoMoreUnknown = { _tag: 'MoreUnknown' };
+export const pageInfoMoreKnown = (remaining) => ({ _tag: 'MoreKnown', remaining });
+export const pullResItemEmpty = () => ({
+    batch: [],
+    pageInfo: pageInfoNoMore,
+});
+export const of = (obj) => obj;
+/**
+ * Useful to continue pulling from the last event in the batch.
+ */
+export const cursorFromPullResItem = (item) => {
+    const lastEvent = item.batch.at(-1);
+    if (!lastEvent) {
+        return Option.none();
+    }
+    return Option.some({ eventSequenceNumber: lastEvent.eventEncoded.seqNum, metadata: lastEvent.metadata });
+};
+//# sourceMappingURL=sync-backend.js.map

package/dist/sync/sync-backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-backend.js","sourceRoot":"","sources":["../../src/sync/sync-backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,MAAM,EACN,MAAM,GAIP,MAAM,yBAAyB,CAAA;AAMhC,cAAc,sBAAsB,CAAA;AA6EpC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CACzC,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC,EACtC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE;IAC/B,SAAS,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,EACF,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAClC,CAAA;AAID,MAAM,CAAC,MAAM,cAAc,GAAoB,EAAE,IAAI,EAAE,QAAQ,EAAW,CAAA;AAC1E,MAAM,CAAC,MAAM,mBAAmB,GAAoB,EAAE,IAAI,EAAE,aAAa,EAAW,CAAA;AACpF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAmB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAA;AAE3G,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAiE,EAAE,CAAC,CAAC;IACnG,KAAK,EAAE,EAAE;IACT,QAAQ,EAAE,cAAc;CACzB,CAAC,CAAA;AAUF,MAAM,CAAC,MAAM,EAAE,GAAG,CAAmC,GAA+B,EAAE,EAAE,CAAC,GAAG,CAAA;AAE5F;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,IAAgC,EAI/B,EAAE;IACH,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IACnC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,MAAM,CAAC,IAAI,EAAE,CAAA;IACtB,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,mBAAmB,EAAE,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;AAC1G,CAAC,CAAA"}

package/dist/sync/sync.d.ts

@@ -1,17 +1,7 @@
-import type { Effect, HttpClient, Option, Scope, Stream, SubscriptionRef } from '@livestore/utils/effect';
-import { Schema } from '@livestore/utils/effect';
-import type { UnexpectedError } from '../adapter-types.ts';
+export * from './errors.ts';
+export * as SyncBackend from './sync-backend.ts';
 import type { InitialSyncOptions } from '../leader-thread/types.ts';
-import * as EventSequenceNumber from '../schema/EventSequenceNumber.ts';
-import type * as LiveStoreEvent from '../schema/LiveStoreEvent.ts';
-/**
- * Those arguments can be used to implement multi-tenancy etc and are passed in from the store.
- */
-export type MakeBackendArgs = {
-    storeId: string;
-    clientId: string;
-    payload: Schema.JsonValue | undefined;
-};
+import type { SyncBackendConstructor } from './sync-backend.ts';
 export type SyncOptions = {
     backend?: SyncBackendConstructor<any>;
     /** @default { _tag: 'Skip' } */
@@ -26,78 +16,10 @@ export type SyncOptions = {
      * @default 'ignore'
      * */
     onSyncError?: 'shutdown' | 'ignore';
-};
-export type SyncBackendConstructor<TSyncMetadata = Schema.JsonValue> = (args: MakeBackendArgs) => Effect.Effect<SyncBackend<TSyncMetadata>, UnexpectedError, Scope.Scope | HttpClient.HttpClient>;
-export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
-    /**
-     * Can be implemented to prepare a connection to the sync backend to speed up the first pull/push.
-     */
-    connect: Effect.Effect<void, IsOfflineError | UnexpectedError, HttpClient.HttpClient | Scope.Scope>;
-    pull: (args: Option.Option<{
-        cursor: EventSequenceNumber.EventSequenceNumber;
-        metadata: Option.Option<TSyncMetadata>;
-    }>) => Stream.Stream<{
-        batch: ReadonlyArray<{
-            eventEncoded: LiveStoreEvent.AnyEncodedGlobal;
-            metadata: Option.Option<TSyncMetadata>;
-        }>;
-        remaining: number;
-    }, IsOfflineError | InvalidPullError, HttpClient.HttpClient>;
-    push: (
-    /**
-     * Constraints for batch:
-     * - Number of events: 1-100
-     * - sequence numbers must be in ascending order
-     * */
-    batch: ReadonlyArray<LiveStoreEvent.AnyEncodedGlobal>) => Effect.Effect<void, IsOfflineError | InvalidPushError, HttpClient.HttpClient>;
-    isConnected: SubscriptionRef.SubscriptionRef<boolean>;
     /**
-     * Metadata describing the sync backend. (Currently only used by devtools.)
+     * Whether the sync backend should reactively pull new events from the sync backend
+     * @default true
      */
-    metadata: {
-        name: string;
-        description: string;
-    } & Record<string, Schema.JsonValue>;
+    livePull?: boolean;
 };
-declare const IsOfflineError_base: Schema.TaggedErrorClass<IsOfflineError, "IsOfflineError", {
-    readonly _tag: Schema.tag<"IsOfflineError">;
-}>;
-export declare class IsOfflineError extends IsOfflineError_base {
-}
-declare const InvalidPushError_base: Schema.TaggedErrorClass<InvalidPushError, "InvalidPushError", {
-    readonly _tag: Schema.tag<"InvalidPushError">;
-} & {
-    reason: Schema.Union<[Schema.TaggedStruct<"Unexpected", {
-        message: typeof Schema.String;
-    }>, Schema.TaggedStruct<"ServerAhead", {
-        minimumExpectedNum: typeof Schema.Number;
-        providedNum: typeof Schema.Number;
-    }>]>;
-}>;
-export declare class InvalidPushError extends InvalidPushError_base {
-}
-declare const InvalidPullError_base: Schema.TaggedErrorClass<InvalidPullError, "InvalidPullError", {
-    readonly _tag: Schema.tag<"InvalidPullError">;
-} & {
-    message: typeof Schema.String;
-}>;
-export declare class InvalidPullError extends InvalidPullError_base {
-}
-declare const LeaderAheadError_base: Schema.TaggedErrorClass<LeaderAheadError, "LeaderAheadError", {
-    readonly _tag: Schema.tag<"LeaderAheadError">;
-} & {
-    minimumExpectedNum: Schema.Struct<{
-        global: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
-        client: Schema.BrandSchema<number & import("effect/Brand").Brand<"ClientEventSequenceNumber">, number, never>;
-        rebaseGeneration: typeof Schema.Int;
-    }>;
-    providedNum: Schema.Struct<{
-        global: Schema.BrandSchema<number & import("effect/Brand").Brand<"GlobalEventSequenceNumber">, number, never>;
-        client: Schema.BrandSchema<number & import("effect/Brand").Brand<"ClientEventSequenceNumber">, number, never>;
-        rebaseGeneration: typeof Schema.Int;
-    }>;
-}>;
-export declare class LeaderAheadError extends LeaderAheadError_base {
-}
-export {};
 //# sourceMappingURL=sync.d.ts.map

package/dist/sync/sync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../src/sync/sync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AACzG,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,KAAK,mBAAmB,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAElE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC,CAAA;IACrC,gCAAgC;IAChC,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC;;;;;;;;SAQK;IACL,WAAW,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAA;CACpC,CAAA;AAGD,MAAM,MAAM,sBAAsB,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS,IAAI,CACrE,IAAI,EAAE,eAAe,KAClB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,eAAe,EAAE,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,CAAA;AASpG,MAAM,MAAM,WAAW,CAAC,aAAa,GAAG,MAAM,CAAC,SAAS,IAAI;IAC1D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,eAAe,EAAE,UAAU,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;IACnG,IAAI,EAAE,CACJ,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC;QAClB,MAAM,EAAE,mBAAmB,CAAC,mBAAmB,CAAA;QAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;KACvC,CAAC,KACC,MAAM,CAAC,MAAM,CAChB;QACE,KAAK,EAAE,aAAa,CAAC;YACnB,YAAY,EAAE,cAAc,CAAC,gBAAgB,CAAA;YAC7C,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;SACvC,CAAC,CAAA;QACF,SAAS,EAAE,MAAM,CAAA;KAClB,EACD,cAAc,GAAG,gBAAgB,EACjC,UAAU,CAAC,UAAU,CACtB,CAAA;IAED,IAAI,EAAE;IACJ;;;;SAIK;IACL,KAAK,EAAE,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,KAClD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,gBAAgB,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;IAClF,WAAW,EAAE,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;IACrD;;OAEG;IACH,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;CACnF,CAAA;;;;AAED,qBAAa,cAAe,SAAQ,mBAA0D;CAAG;;;;;;;;;;;AAGjG,qBAAa,gBAAiB,SAAQ,qBAUpC;CAAG;;;;;;AAGL,qBAAa,gBAAiB,SAAQ,qBAEpC;CAAG;;;;;;;;;;;;;;;AAGL,qBAAa,gBAAiB,SAAQ,qBAKpC;CAAG"}
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../src/sync/sync.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,OAAO,KAAK,WAAW,MAAM,mBAAmB,CAAA;AAEhD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAE/D,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC,CAAA;IACrC,gCAAgC;IAChC,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC;;;;;;;;SAQK;IACL,WAAW,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAA;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA"}

package/dist/sync/sync.js

@@ -1,28 +1,3 @@
-import { Schema } from '@livestore/utils/effect';
-import * as EventSequenceNumber from "../schema/EventSequenceNumber.js";
-export class IsOfflineError extends Schema.TaggedError()('IsOfflineError', {}) {
-}
-// TODO gt rid of this error in favour of SyncError
-export class InvalidPushError extends Schema.TaggedError()('InvalidPushError', {
-    reason: Schema.Union(Schema.TaggedStruct('Unexpected', {
-        message: Schema.String,
-    }), Schema.TaggedStruct('ServerAhead', {
-        minimumExpectedNum: Schema.Number,
-        providedNum: Schema.Number,
-    })),
-}) {
-}
-// TODO gt rid of this error in favour of SyncError
-export class InvalidPullError extends Schema.TaggedError()('InvalidPullError', {
-    message: Schema.String,
-}) {
-}
-// TODO gt rid of this error in favour of SyncError
-export class LeaderAheadError extends Schema.TaggedError()('LeaderAheadError', {
-    minimumExpectedNum: EventSequenceNumber.EventSequenceNumber,
-    providedNum: EventSequenceNumber.EventSequenceNumber,
-    /** Generation number the client session should use for subsequent pushes */
-    // nextGeneration: Schema.Number,
-}) {
-}
+export * from "./errors.js";
+export * as SyncBackend from "./sync-backend.js";
 //# sourceMappingURL=sync.js.map

package/dist/sync/sync.js.map

@@ -1 +1 @@
-{"version":3,"file":"sync.js","sourceRoot":"","sources":["../../src/sync/sync.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAIhD,OAAO,KAAK,mBAAmB,MAAM,kCAAkC,CAAA;AA6EvE,MAAM,OAAO,cAAe,SAAQ,MAAM,CAAC,WAAW,EAAkB,CAAC,gBAAgB,EAAE,EAAE,CAAC;CAAG;AAEjG,mDAAmD;AACnD,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAAC,kBAAkB,EAAE;IAC/F,MAAM,EAAE,MAAM,CAAC,KAAK,CAClB,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE;QAChC,OAAO,EAAE,MAAM,CAAC,MAAM;KACvB,CAAC,EACF,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE;QACjC,kBAAkB,EAAE,MAAM,CAAC,MAAM;QACjC,WAAW,EAAE,MAAM,CAAC,MAAM;KAC3B,CAAC,CACH;CACF,CAAC;CAAG;AAEL,mDAAmD;AACnD,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAAC,kBAAkB,EAAE;IAC/F,OAAO,EAAE,MAAM,CAAC,MAAM;CACvB,CAAC;CAAG;AAEL,mDAAmD;AACnD,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAAC,kBAAkB,EAAE;IAC/F,kBAAkB,EAAE,mBAAmB,CAAC,mBAAmB;IAC3D,WAAW,EAAE,mBAAmB,CAAC,mBAAmB;IACpD,4EAA4E;IAC5E,iCAAiC;CAClC,CAAC;CAAG"}
+{"version":3,"file":"sync.js","sourceRoot":"","sources":["../../src/sync/sync.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,OAAO,KAAK,WAAW,MAAM,mBAAmB,CAAA"}

package/dist/sync/validate-push-payload.d.ts

@@ -1,5 +1,5 @@
 import { Effect } from '@livestore/utils/effect';
-import type { EventSequenceNumber, LiveStoreEvent } from '../schema/mod.ts';
+import { EventSequenceNumber, type LiveStoreEvent } from '../schema/mod.ts';
 import { InvalidPushError } from './sync.ts';
 export declare const validatePushPayload: (batch: ReadonlyArray<LiveStoreEvent.AnyEncodedGlobal>, currentEventSequenceNumber: EventSequenceNumber.GlobalEventSequenceNumber) => Effect.Effect<undefined, InvalidPushError, never>;
 //# sourceMappingURL=validate-push-payload.d.ts.map

package/dist/sync/validate-push-payload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validate-push-payload.d.ts","sourceRoot":"","sources":["../../src/sync/validate-push-payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAG5C,eAAO,MAAM,mBAAmB,GAC9B,OAAO,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,EACrD,4BAA4B,mBAAmB,CAAC,yBAAyB,sDAYvE,CAAA"}
+{"version":3,"file":"validate-push-payload.d.ts","sourceRoot":"","sources":["../../src/sync/validate-push-payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,OAAO,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,gBAAgB,EAAoB,MAAM,WAAW,CAAA;AAG9D,eAAO,MAAM,mBAAmB,GAC9B,OAAO,aAAa,CAAC,cAAc,CAAC,gBAAgB,CAAC,EACrD,4BAA4B,mBAAmB,CAAC,yBAAyB,sDAWvE,CAAA"}

package/dist/sync/validate-push-payload.js

@@ -1,14 +1,14 @@
 import { Effect } from '@livestore/utils/effect';
-import { InvalidPushError } from "./sync.js";
+import { EventSequenceNumber } from "../schema/mod.js";
+import { InvalidPushError, ServerAheadError } from "./sync.js";
 // TODO proper batch validation
 export const validatePushPayload = (batch, currentEventSequenceNumber) => Effect.gen(function* () {
     if (batch[0].seqNum <= currentEventSequenceNumber) {
         return yield* InvalidPushError.make({
-            reason: {
-                _tag: 'ServerAhead',
-                minimumExpectedNum: currentEventSequenceNumber + 1,
-                providedNum: batch[0].seqNum,
-            },
+            cause: new ServerAheadError({
+                minimumExpectedNum: EventSequenceNumber.globalEventSequenceNumber(currentEventSequenceNumber + 1),
+                providedNum: EventSequenceNumber.globalEventSequenceNumber(batch[0].seqNum),
+            }),
         });
     }
 });

package/dist/sync/validate-push-payload.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate-push-payload.js","sourceRoot":"","sources":["../../src/sync/validate-push-payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAGhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAE5C,+BAA+B;AAC/B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAqD,EACrD,0BAAyE,EACzE,EAAE,CACF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAClC,MAAM,EAAE;gBACN,IAAI,EAAE,aAAa;gBACnB,kBAAkB,EAAE,0BAA0B,GAAG,CAAC;gBAClD,WAAW,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,MAAM;aAC9B;SACF,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAC,CAAA"}
+{"version":3,"file":"validate-push-payload.js","sourceRoot":"","sources":["../../src/sync/validate-push-payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,OAAO,EAAE,mBAAmB,EAAuB,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAE9D,+BAA+B;AAC/B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,KAAqD,EACrD,0BAAyE,EACzE,EAAE,CACF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,MAAM,IAAI,0BAA0B,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAClC,KAAK,EAAE,IAAI,gBAAgB,CAAC;gBAC1B,kBAAkB,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,0BAA0B,GAAG,CAAC,CAAC;gBACjG,WAAW,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,MAAM,CAAC;aAC7E,CAAC;SACH,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAC,CAAA"}

package/dist/version.d.ts

@@ -1,4 +1,4 @@
-export declare const liveStoreVersion: "0.4.0-dev.3";
+export declare const liveStoreVersion: "0.4.0-dev.5";
 /**
  * This version number is incremented whenever the internal storage format changes in a breaking way.
  * Whenever this version changes, LiveStore will start with fresh database files. Old database files are not deleted.
@@ -6,5 +6,5 @@ export declare const liveStoreVersion: "0.4.0-dev.3";
  * While LiveStore is in beta, this might happen more frequently.
  * In the future, LiveStore will provide a migration path for older database files to avoid the impression of data loss.
  */
-export declare const liveStoreStorageFormatVersion = 5;
+export declare const liveStoreStorageFormatVersion = 6;
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,7 +1,7 @@
 // TODO bring back when Expo and Playwright supports `with` imports
 // import packageJson from '../package.json' with { type: 'json' }
 // export const liveStoreVersion = packageJson.version
-export const liveStoreVersion = '0.4.0-dev.3';
+export const liveStoreVersion = '0.4.0-dev.5';
 /**
  * This version number is incremented whenever the internal storage format changes in a breaking way.
  * Whenever this version changes, LiveStore will start with fresh database files. Old database files are not deleted.
@@ -9,5 +9,5 @@ export const liveStoreVersion = '0.4.0-dev.3';
  * While LiveStore is in beta, this might happen more frequently.
  * In the future, LiveStore will provide a migration path for older database files to avoid the impression of data loss.
  */
-export const liveStoreStorageFormatVersion = 5;
+export const liveStoreStorageFormatVersion = 6;
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livestore/common",
-  "version": "0.4.0-dev.3",
+  "version": "0.4.0-dev.5",
   "type": "module",
   "sideEffects": false,
   "exports": {
@@ -16,12 +16,12 @@
     "graphology": "0.26.0-alpha1",
     "graphology-dag": "0.4.1",
     "graphology-types": "0.24.8",
-    "@livestore/utils": "0.4.0-dev.3",
-    "@livestore/webmesh": "0.4.0-dev.3"
+    "@livestore/utils": "0.4.0-dev.5",
+    "@livestore/webmesh": "0.4.0-dev.5"
   },
   "devDependencies": {
     "vitest": "3.2.4",
-    "@livestore/utils-dev": "0.4.0-dev.3"
+    "@livestore/utils-dev": "0.4.0-dev.5"
   },
   "files": [
     "package.json",

package/src/adapter-types.ts

@@ -10,9 +10,10 @@ import {
 
 import type { ClientSessionLeaderThreadProxy } from './ClientSessionLeaderThreadProxy.ts'
 import type * as Devtools from './devtools/mod.ts'
-import type { IntentionalShutdownCause, SyncError, UnexpectedError } from './errors.ts'
+import type { IntentionalShutdownCause, MaterializeError, UnexpectedError } from './errors.ts'
 import type { LiveStoreSchema } from './schema/mod.ts'
 import type { SqliteDb } from './sqlite-types.ts'
+import type { IsOfflineError, SyncError } from './sync/index.js'
 
 export * as ClientSessionLeaderThreadProxy from './ClientSessionLeaderThreadProxy.ts'
 export * from './defs.ts'
@@ -27,7 +28,9 @@ export interface ClientSession {
   sessionId: string
   /** Status info whether current session is leader or not */
   lockStatus: SubscriptionRef.SubscriptionRef<LockStatus>
-  shutdown: (cause: Exit.Exit<IntentionalShutdownCause, UnexpectedError | SyncError>) => Effect.Effect<void>
+  shutdown: (
+    cause: Exit.Exit<IntentionalShutdownCause, UnexpectedError | SyncError | MaterializeError>,
+  ) => Effect.Effect<void>
   /** A proxy API to communicate with the leader thread */
   leaderThread: ClientSessionLeaderThreadProxy
   /** A unique identifier for the current instance of the client session. Used for debugging purposes. */
@@ -121,7 +124,9 @@ export interface AdapterArgs {
   devtoolsEnabled: boolean
   debugInstanceId: string
   bootStatusQueue: Queue.Queue<BootStatus>
-  shutdown: (exit: Exit.Exit<IntentionalShutdownCause, UnexpectedError | SyncError>) => Effect.Effect<void>
+  shutdown: (
+    exit: Exit.Exit<IntentionalShutdownCause, UnexpectedError | SyncError | MaterializeError | IsOfflineError>,
+  ) => Effect.Effect<void>
   connectDevtoolsToStore: ConnectDevtoolsToStore
   /**
    * Payload that will be passed to the sync backend when connecting

package/src/errors.ts

@@ -17,9 +17,15 @@ export class UnexpectedError extends Schema.TaggedError<UnexpectedError>()('Live
     )
 }
 
-export class SyncError extends Schema.TaggedError<SyncError>()('LiveStore.SyncError', {
-  cause: Schema.Defect,
-}) {}
+export class MaterializerHashMismatchError extends Schema.TaggedError<MaterializerHashMismatchError>()(
+  'LiveStore.MaterializerHashMismatchError',
+  {
+    eventName: Schema.String,
+    note: Schema.optionalWith(Schema.String, {
+      default: () => 'Please make sure your event materializer is a pure function without side effects.',
+    }),
+  },
+) {}
 
 export class IntentionalShutdownCause extends Schema.TaggedError<IntentionalShutdownCause>()(
   'LiveStore.IntentionalShutdownCause',
@@ -47,3 +53,8 @@ export class SqliteError extends Schema.TaggedError<SqliteError>()('LiveStore.Sq
   cause: Schema.Defect,
   note: Schema.optional(Schema.String),
 }) {}
+
+export class MaterializeError extends Schema.TaggedError<MaterializeError>()('LiveStore.MaterializeError', {
+  cause: Schema.Union(MaterializerHashMismatchError, SqliteError),
+  note: Schema.optional(Schema.String),
+}) {}