@livestore/common 0.0.0-snapshot-909cdd1ac2fd591945c2be2b0f53e14d87f3c9d4

package/src/sync/sync.ts

@@ -0,0 +1,46 @@
+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 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<
+    { metadata: Option.Option<TSyncMetadata> },
+    IsOfflineError | InvalidPushError,
+    HttpClient.HttpClient
+  >
+  isConnected: SubscriptionRef.SubscriptionRef<boolean>
+}
+
+export class IsOfflineError extends Schema.TaggedError<IsOfflineError>()('IsOfflineError', {}) {}
+export class InvalidPushError extends Schema.TaggedError<InvalidPushError>()('InvalidPushError', {
+  message: Schema.String,
+}) {}
+export class InvalidPullError extends Schema.TaggedError<InvalidPullError>()('InvalidPullError', {
+  message: Schema.String,
+}) {}

package/src/util.ts

@@ -0,0 +1,56 @@
+/// <reference lib="es2022" />
+
+import type { Brand } from '@livestore/utils/effect'
+import { Schema } from '@livestore/utils/effect'
+
+export type ParamsObject = Record<string, SqlValue>
+export type SqlValue = string | number | Uint8Array | null
+
+export type Bindable = ReadonlyArray<SqlValue> | ParamsObject
+
+export const SqlValueSchema = Schema.Union(Schema.String, Schema.Number, Schema.Uint8Array, Schema.Null)
+
+export const PreparedBindValues = Schema.Union(
+  Schema.Array(SqlValueSchema),
+  Schema.Record({ key: Schema.String, value: SqlValueSchema }),
+).pipe(Schema.brand('PreparedBindValues'))
+
+export type PreparedBindValues = Brand.Branded<Bindable, 'PreparedBindValues'>
+
+/**
+ * This is a tag function for tagged literals.
+ * it lets us get syntax highlighting on SQL queries in VSCode, but
+ * doesn't do anything at runtime.
+ * Code copied from: https://esdiscuss.org/topic/string-identity-template-tag
+ */
+export const sql = (template: TemplateStringsArray, ...args: unknown[]): string => {
+  let str = ''
+
+  for (const [i, arg] of args.entries()) {
+    str += template[i] + String(arg)
+  }
+
+  // eslint-disable-next-line unicorn/prefer-at
+  return str + template[template.length - 1]
+}
+
+/**
+ * Prepare bind values to send to SQLite
+ * Add $ to the beginning of keys; which we use as our interpolation syntax
+ * We also strip out any params that aren't used in the statement,
+ * because rusqlite doesn't allow unused named params
+ * TODO: Search for unused params via proper parsing, not string search
+ * TODO: Also make sure that the SQLite binding limit of 1000 is respected
+ */
+export const prepareBindValues = (values: Bindable, statement: string): PreparedBindValues => {
+  if (Array.isArray(values)) return values as any as PreparedBindValues
+
+  const result: ParamsObject = {}
+  for (const [key, value] of Object.entries(values)) {
+    if (statement.includes(key)) {
+      result[`$${key}`] = value
+    }
+  }
+
+  return result as PreparedBindValues
+}

package/src/version.ts

@@ -0,0 +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

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "resolveJsonModule": true,
+    "tsBuildInfoFile": "./dist/.tsbuildinfo"
+  },
+  "include": ["./src"],
+  "references": [{ "path": "../db-schema" }, { "path": "../utils" }]
+}