@livestore/livestore 0.0.12 → 0.0.15

package/dist/util.d.ts

@@ -0,0 +1,28 @@
+/// <reference lib="es2022" />
+import type { Brand } from '@livestore/utils/effect';
+export type ParamsObject = Record<string, SqlValue>;
+export type SqlValue = string | number | Uint8Array | null;
+export type Bindable = SqlValue[] | ParamsObject;
+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 declare const sql: (template: TemplateStringsArray, ...args: unknown[]) => string;
+/** 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
+**/
+export declare const prepareBindValues: (values: Bindable, statement: string) => PreparedBindValues;
+/**
+ * Use this to make assertion at end of if-else chain that all members of a
+ * union have been accounted for.
+ */
+export declare function casesHandled(x: never): never;
+export declare const objectToString: (error: any) => string;
+export declare const isPromise: (value: any) => value is Promise<unknown>;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAEpD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;AACnD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAA;AAE1D,MAAM,MAAM,QAAQ,GAAG,QAAQ,EAAE,GAAG,YAAY,CAAA;AAEhD,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAA;AAE9E;;;;;GAKG;AACH,eAAO,MAAM,GAAG,aAAc,oBAAoB,WAAW,OAAO,EAAE,KAAG,MAMxE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,WAAY,QAAQ,aAAa,MAAM,KAAG,kBAWvE,CAAA;AAED;;;GAGG;AAEH,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,GAAG,KAAK,CAE5C;AAED,eAAO,MAAM,cAAc,UAAW,GAAG,KAAG,MAa3C,CAAA;AAED,eAAO,MAAM,SAAS,UAAW,GAAG,8BAAiE,CAAA"}

package/dist/util.js

@@ -0,0 +1,55 @@
+/// <reference lib="es2022" />
+/**
+ * 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, ...args) => {
+    let str = '';
+    for (const [i, arg] of args.entries()) {
+        str += template[i] + String(arg);
+    }
+    return str + template.at(-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
+**/
+export const prepareBindValues = (values, statement) => {
+    if (Array.isArray(values))
+        return values;
+    const result = {};
+    for (const [key, value] of Object.entries(values)) {
+        if (statement.includes(key)) {
+            result[`$${key}`] = value;
+        }
+    }
+    return result;
+};
+/**
+ * Use this to make assertion at end of if-else chain that all members of a
+ * union have been accounted for.
+ */
+/* eslint-disable-next-line prefer-arrow/prefer-arrow-functions */
+export function casesHandled(x) {
+    throw new Error(`A case was not handled for value: ${objectToString(x)}`);
+}
+export const objectToString = (error) => {
+    const stack = typeof process !== 'undefined' && process.env.CL_DEBUG ? error.stack : undefined;
+    const str = error.toString();
+    const stackStr = stack ? `\n${stack}` : '';
+    if (str !== '[object Object]')
+        return str + stackStr;
+    try {
+        return JSON.stringify({ ...error, stack }, null, 2);
+    }
+    catch (e) {
+        console.log(error);
+        return 'Error while printing error: ' + e;
+    }
+};
+export const isPromise = (value) => typeof value?.then === 'function';
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAW9B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,QAA8B,EAAE,GAAG,IAAe,EAAU,EAAE;IAChF,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,KAAK,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;QACrC,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;KACjC;IACD,OAAO,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;AAC9B,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAAgB,EAAE,SAAiB,EAAsB,EAAE;IAC3F,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,MAA4B,CAAA;IAE9D,MAAM,MAAM,GAAiB,EAAE,CAAA;IAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACjD,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC3B,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,KAAK,CAAA;SAC1B;KACF;IAED,OAAO,MAA4B,CAAA;AACrC,CAAC,CAAA;AAED;;;GAGG;AACH,kEAAkE;AAClE,MAAM,UAAU,YAAY,CAAC,CAAQ;IACnC,MAAM,IAAI,KAAK,CAAC,qCAAqC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;AAC3E,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAU,EAAU,EAAE;IACnD,MAAM,KAAK,GAAG,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IAC9F,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;IAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IAC1C,IAAI,GAAG,KAAK,iBAAiB;QAAE,OAAO,GAAG,GAAG,QAAQ,CAAA;IAEpD,IAAI;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;KACpD;IAAC,OAAO,CAAM,EAAE;QACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAElB,OAAO,8BAA8B,GAAG,CAAC,CAAA;KAC1C;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAU,EAA6B,EAAE,CAAC,OAAO,KAAK,EAAE,IAAI,KAAK,UAAU,CAAA"}

package/package.json

@@ -1,15 +1,36 @@
 {
   "name": "@livestore/livestore",
-  "version": "0.0.12",
+  "version": "0.0.15",
   "type": "module",
-  "publishConfig": {
-    "access": "public"
-  },
   "exports": {
-    ".": "./dist/index.js",
-    "./react": "./dist/react/index.js",
-    "./effect": "./dist/effect/index.js",
-    "./util": "./dist/util.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./storage/web-worker": {
+      "types": "./dist/storage/web-worker/index.d.ts",
+      "default": "./dist/storage/web-worker/index.js"
+    },
+    "./storage/in-memory": {
+      "types": "./dist/storage/in-memory/index.d.ts",
+      "default": "./dist/storage/in-memory/index.js"
+    },
+    "./storage/tauri": {
+      "types": "./dist/storage/tauri/index.d.ts",
+      "default": "./dist/storage/tauri/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "default": "./dist/react/index.js"
+    },
+    "./effect": {
+      "types": "./dist/effect/index.d.ts",
+      "default": "./dist/effect/index.js"
+    },
+    "./util": {
+      "types": "./dist/util.d.ts",
+      "default": "./dist/util.js"
+    }
   },
   "types": "./dist/index.d.ts",
   "typesVersions": {
@@ -34,11 +55,26 @@
     "@livestore/utils": "workspace:*",
     "@opentelemetry/api": "^1.6.0",
     "comlink": "^4.4.1",
+    "effect-db-schema": "workspace:*",
     "graphql": "^16.8.1",
     "lodash-es": "^4.17.21",
     "sqlite-esm": "3.42.0-build6",
     "uuid": "^9.0.1"
   },
+  "devDependencies": {
+    "@tauri-apps/api": "^1.5.0",
+    "@testing-library/react": "^14.0.0",
+    "@types/lodash-es": "^4.17.9",
+    "@types/react": "^18.2.28",
+    "@types/react-dom": "^18.2.13",
+    "@types/uuid": "^9.0.5",
+    "jsdom": "^22.1.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "typescript": "5.2.2",
+    "vite": "4.4.11",
+    "vitest": "^0.34.6"
+  },
   "peerDependencies": {
     "@tauri-apps/api": "^1.4.0",
     "react": "^18",
@@ -49,16 +85,7 @@
       "optional": true
     }
   },
-  "devDependencies": {
-    "@tauri-apps/api": "^1.4.0",
-    "@testing-library/react": "^14.0.0",
-    "@types/lodash-es": "^4.17.9",
-    "@types/uuid": "^9.0.4",
-    "jsdom": "^22.1.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "typescript": "5.2.2",
-    "vite": "4.4.9",
-    "vitest": "^0.34.6"
+  "publishConfig": {
+    "access": "public"
   }
 }

package/src/__tests__/react/fixture.tsx

@@ -1,9 +1,10 @@
-import { mapObjectValues } from '@livestore/utils'
 import React from 'react'
+import initSqlite3Wasm from 'sqlite-esm'
 
 import * as LiveStore from '../../index.js'
 import { sql } from '../../index.js'
 import * as LiveStoreReact from '../../react/index.js'
+import { InMemoryStorage } from '../../storage/in-memory/index.js'
 
 export type Todo = {
   id: string
@@ -25,24 +26,19 @@ export const globalQueryDefs = {
   appState,
 }
 
-export const schema = LiveStore.defineSchema({
+export const schema = LiveStore.makeSchema({
   tables: {
-    todos: {
-      columns: {
-        id: { type: 'text', primaryKey: true },
-        text: { type: 'text', default: '', nullable: false },
-        completed: { type: 'boolean', default: false, nullable: false },
-      },
-    },
-    app: {
-      columns: {
-        id: { type: 'text', primaryKey: true },
-        newTodoText: { type: 'text', default: '', nullable: true },
-        filter: { type: 'text', default: 'all', nullable: false },
-      },
-    },
+    todos: LiveStore.DbSchema.table('todos', {
+      id: LiveStore.DbSchema.text({ primaryKey: true }),
+      text: LiveStore.DbSchema.text({ default: '', nullable: false }),
+      completed: LiveStore.DbSchema.boolean({ default: false, nullable: false }),
+    }),
+    app: LiveStore.DbSchema.table('app', {
+      id: LiveStore.DbSchema.text({ primaryKey: true }),
+      newTodoText: LiveStore.DbSchema.text({ default: '', nullable: true }),
+      filter: LiveStore.DbSchema.text({ default: 'all', nullable: false }),
+    }),
   },
-  materializedViews: {},
   actions: {
     // TODO: fix these actions to make them have write annotatinos
     addTodo: {
@@ -63,28 +59,23 @@ export const schema = LiveStore.defineSchema({
 })
 
 export const makeTodoMvc = async () => {
-  type UserInfoComponentState = { username: string }
+  const AppSchema = LiveStore.defineComponentStateSchema('UserInfo', {
+    username: LiveStore.DbSchema.text({ default: '' }),
+  })
 
-  const AppSchema = LiveStore.defineComponentStateSchema<UserInfoComponentState>({
-    componentType: 'UserInfo',
-    columns: {
-      username: { type: 'text', default: '' },
-    },
+  const sqlite3 = await initSqlite3Wasm({
+    print: (message) => console.log(`[livestore sqlite] ${message}`),
+    printErr: (message) => console.error(`[livestore sqlite] ${message}`),
   })
 
   const store = await LiveStore.createStore({
     schema,
-    backendOptions: { type: 'web-in-memory' },
-    boot: async (backend) => {
-      backend.execute(sql`INSERT INTO app (newTodoText, filter) VALUES ('', 'all');`)
-      // NOTE we can't insert into components__UserInfo yet because the table doesn't exist yet
-      // backend.execute(sql`INSERT INTO components__UserInfo (id, username) VALUES ('u1', 'username_u1');`)
-      // backend.execute(sql`INSERT INTO components__UserInfo (id, username) VALUES ('u2', 'username_u2');`)
-    },
+    loadStorage: () => InMemoryStorage.load(),
+    boot: (db) => db.execute(sql`INSERT OR IGNORE INTO app (id, newTodoText, filter) VALUES ('static', '', 'all');`),
+    sqlite3,
   })
 
-  const globalQueries = mapObjectValues(globalQueryDefs, (_, queryDef) => queryDef(store))
-  const storeContext: LiveStore.LiveStoreContext = { store, globalQueries }
+  const storeContext: LiveStore.LiveStoreContext = { store }
 
   const wrapper = ({ children }: any) => (
     <LiveStoreReact.LiveStoreContext.Provider value={storeContext}>{children}</LiveStoreReact.LiveStoreContext.Provider>

package/src/__tests__/reactive.test.ts

@@ -226,8 +226,7 @@ describe('a diamond shaped graph', () => {
   })
 })
 
-// TODO handle `undefined` in the graph
-describe.todo('a trivial graph with undefined', () => {
+describe('a trivial graph with undefined', () => {
   const makeGraph = () => {
     const graph = new ReactiveGraph({ otelTracer: makeNoopTracer() })
     const a = graph.makeRef(undefined)
@@ -260,7 +259,7 @@ describe.todo('a trivial graph with undefined', () => {
 
   it('has the right initial values', () => {
     const { c, e } = makeGraph()
-    expect(c.result).toBe(3)
-    expect(e.result).toBe(6)
+    expect(c.result).toBe(2)
+    expect(e.result).toBe(5)
   })
 })

package/src/effect/LiveStore.ts

@@ -2,31 +2,35 @@ import type { Scope } from '@livestore/utils/effect'
 import { Context, Deferred, Duration, Effect, Layer, OtelTracer, pipe, Runtime } from '@livestore/utils/effect'
 import * as otel from '@opentelemetry/api'
 import type { GraphQLSchema } from 'graphql'
-import { mapValues } from 'lodash-es'
+import initSqlite3Wasm from 'sqlite-esm'
 
-import type { Backend, BackendOptions } from '../backends/index.js'
 import type { InMemoryDatabase } from '../inMemoryDatabase.js'
 import type { Schema } from '../schema.js'
+import type { StorageInit } from '../storage/index.js'
 import type { BaseGraphQLContext, GraphQLOptions, LiveStoreQuery, Store } from '../store.js'
 import { createStore } from '../store.js'
 
+// NOTE we're starting to initialize the sqlite wasm binary here (already before calling `createStore`),
+// so that it's ready when we need it
+const sqlite3Promise = initSqlite3Wasm({
+  print: (message) => console.log(`[livestore sqlite] ${message}`),
+  printErr: (message) => console.error(`[livestore sqlite] ${message}`),
+})
+
 // TODO get rid of `LiveStoreContext` wrapper and only expose the `Store` directly
 export type LiveStoreContext = {
-  store: Store<any>
-  globalQueries: LiveStoreQueryTypes
+  store: Store
 }
 
-export type QueryDefinition = (store: Store<any>) => LiveStoreQuery
-export type GlobalQueryDefs = { [key: string]: QueryDefinition }
+export type QueryDefinition = (store: Store) => LiveStoreQuery
 
 export type LiveStoreCreateStoreOptions<GraphQLContext extends BaseGraphQLContext> = {
   schema: Schema
-  globalQueryDefs: GlobalQueryDefs
-  backendOptions: BackendOptions
+  loadStorage: () => StorageInit | Promise<StorageInit>
   graphQLOptions?: GraphQLOptions<GraphQLContext>
   otelTracer?: otel.Tracer
   otelRootSpanContext?: otel.Context
-  boot?: (backend: Backend, parentSpan: otel.Span) => Promise<void>
+  boot?: (db: InMemoryDatabase, parentSpan: otel.Span) => unknown | Promise<unknown>
 }
 
 export const LiveStoreContext = Context.Tag<LiveStoreContext>('@livestore/livestore/LiveStoreContext')
@@ -40,13 +44,12 @@ export const DeferredStoreContext = Context.Tag<DeferredStoreContext>(
 
 export type LiveStoreContextProps<GraphQLContext extends BaseGraphQLContext> = {
   schema: Schema
-  globalQueryDefs?: Effect.Effect<never, never, GlobalQueryDefs>
-  backendOptions: Effect.Effect<never, never, BackendOptions>
+  loadStorage: () => StorageInit | Promise<StorageInit>
   graphQLOptions?: {
     schema: Effect.Effect<otel.Tracer, never, GraphQLSchema>
     makeContext: (db: InMemoryDatabase) => GraphQLContext
   }
-  boot?: (backend: Backend) => Effect.Effect<never, never, void>
+  boot?: (db: InMemoryDatabase) => Effect.Effect<never, never, void>
 }
 
 export const LiveStoreContextLayer = <GraphQLContext extends BaseGraphQLContext>(
@@ -60,9 +63,8 @@ export const LiveStoreContextLayer = <GraphQLContext extends BaseGraphQLContext>
 export const LiveStoreContextDeferred = Layer.effect(DeferredStoreContext, Deferred.make<never, LiveStoreContext>())
 
 export const makeLiveStoreContext = <GraphQLContext extends BaseGraphQLContext>({
-  globalQueryDefs,
   schema,
-  backendOptions: backendOptions_,
+  loadStorage,
   graphQLOptions: graphQLOptions_,
   boot: boot_,
 }: LiveStoreContextProps<GraphQLContext>): Effect.Effect<
@@ -84,22 +86,23 @@ export const makeLiveStoreContext = <GraphQLContext extends BaseGraphQLContext>(
           : Effect.succeed(undefined),
       )
 
-      const backendOptions = yield* $(backendOptions_)
-
       const boot = boot_
-        ? (db: Backend) =>
+        ? (db: InMemoryDatabase) =>
             boot_(db).pipe(Effect.withSpan('boot'), Effect.tapCauseLogPretty, Runtime.runPromise(runtime))
         : undefined
 
+      const sqlite3 = yield* $(Effect.promise(() => sqlite3Promise))
+
       const store = yield* $(
         Effect.tryPromise(() =>
           createStore({
             schema,
-            backendOptions,
+            loadStorage,
             graphQLOptions,
             otelTracer,
             otelRootSpanContext,
             boot,
+            sqlite3,
           }),
         ),
         Effect.acquireRelease((store) => Effect.sync(() => store.destroy())),
@@ -107,19 +110,7 @@ export const makeLiveStoreContext = <GraphQLContext extends BaseGraphQLContext>(
 
       window.__debugLiveStore = store
 
-      // TODO remove global queries concept
-      const globalQueries = yield* $(
-        globalQueryDefs ?? Effect.succeed({} as GlobalQueryDefs),
-        Effect.map((defs) => mapValues(defs, (queryDef) => queryDef(store))),
-        Effect.withSpan('LiveStore:makeGlobalQueries', {
-          parent: OtelTracer.makeExternalSpan(otel.trace.getSpanContext(store.otel.queriesSpanContext)!),
-        }),
-      )
-
-      // NOTE give main thread a chance to render
-      yield* $(Effect.yieldNow())
-
-      return { store, globalQueries }
+      return { store }
     }),
     Effect.tap((storeCtx) => Effect.flatMap(DeferredStoreContext, (def) => Deferred.succeed(def, storeCtx))),
     Effect.timeoutFail({

package/src/events.ts

@@ -5,4 +5,4 @@ export type LiveStoreEvent = {
   args?: any
 }
 
-export const EVENTS_TABLE_NAME = '__events'
+export const EVENTS_TABLE_NAME = '__livestore_events'