@livestore/common 0.0.58-dev.1 → 0.0.58-dev.10

package/src/sync/sync.ts

@@ -1,15 +1,39 @@
-import { type Effect, Schema, type Stream, type SubscriptionRef } from '@livestore/utils/effect'
+import type { Effect, HttpClient, Option, Stream, SubscriptionRef } from '@livestore/utils/effect'
+import { Schema } from '@livestore/utils/effect'
 
+import type { EventId } from '../adapter-types.js'
 import type { MutationEvent } from '../schema/mutations.js'
 
-export type SyncImpl = {
-  // TODO consider unifying `pull` and `pushed` into a single stream with a "marker event" after the initial loading is completed
-  pull: (cursor: string | undefined) => Stream.Stream<MutationEvent.AnyEncoded, IsOfflineError | InvalidPullError>
-  pushes: Stream.Stream<{ mutationEventEncoded: MutationEvent.AnyEncoded; persisted: boolean }>
+export interface SyncBackendOptionsBase {
+  type: string
+  [key: string]: Schema.JsonValue
+}
+
+export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
+  pull: (
+    args: Option.Option<{
+      cursor: EventId
+      metadata: Option.Option<TSyncMetadata>
+    }>,
+    options: { listenForNew: boolean },
+  ) => Stream.Stream<
+    {
+      mutationEventEncoded: MutationEvent.AnyEncoded
+      metadata: Option.Option<TSyncMetadata>
+      persisted: boolean
+    },
+    IsOfflineError | InvalidPullError,
+    HttpClient.HttpClient
+  >
+  // TODO support batching
   push: (
     mutationEventEncoded: MutationEvent.AnyEncoded,
     persisted: boolean,
-  ) => Effect.Effect<void, IsOfflineError | InvalidPushError>
+  ) => Effect.Effect<
+    { metadata: Option.Option<TSyncMetadata> },
+    IsOfflineError | InvalidPushError,
+    HttpClient.HttpClient
+  >
   isConnected: SubscriptionRef.SubscriptionRef<boolean>
 }
 

package/src/version.ts

@@ -1,3 +1,13 @@
 import packageJson from '../package.json' with { type: 'json' }
+// import packageJson from '../package.json' assert { type: 'json' }
 
 export const liveStoreVersion = packageJson.version
+
+/**
+ * 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.
+ *
+ * While LiveStore is in alpha, 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 = 2

package/tsconfig.json

@@ -7,5 +7,5 @@
     "tsBuildInfoFile": "./dist/.tsbuildinfo"
   },
   "include": ["./src"],
-  "references": [{ "path": "../../effect-db-schema" }, { "path": "../utils" }]
+  "references": [{ "path": "../db-schema" }, { "path": "../utils" }]
 }