@livestore/common 0.3.0-dev.34 → 0.3.0-dev.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livestore/common",
-  "version": "0.3.0-dev.34",
+  "version": "0.3.0-dev.37",
   "type": "module",
   "sideEffects": false,
   "exports": {
@@ -54,11 +54,11 @@
     "graphology": "0.26.0-alpha1",
     "graphology-dag": "0.4.1",
     "graphology-types": "0.24.8",
-    "@livestore/utils": "0.3.0-dev.34"
+    "@livestore/utils": "0.3.0-dev.37"
   },
   "devDependencies": {
     "vitest": "^3.1.1",
-    "@livestore/utils-dev": "0.3.0-dev.34"
+    "@livestore/utils-dev": "0.3.0-dev.37"
   },
   "files": [
     "package.json",

package/src/devtools/devtools-sessioninfo.ts

@@ -19,6 +19,7 @@ export const SessionInfo = Schema.TaggedStruct('SessionInfo', {
   storeId: Schema.String,
   clientId: Schema.String,
   sessionId: Schema.String,
+  schemaAlias: Schema.String,
 })
 export type SessionInfo = typeof SessionInfo.Type
 

package/src/leader-thread/LeaderSyncProcessor.ts

@@ -107,8 +107,8 @@ export const makeLeaderSyncProcessor = ({
     const syncStateSref = yield* SubscriptionRef.make<SyncState.SyncState | undefined>(undefined)
 
     const isClientEvent = (eventEncoded: LiveStoreEvent.EncodedWithMeta) => {
-      const eventDef = getEventDef(schema, eventEncoded.name)
-      return eventDef.eventDef.options.clientOnly
+      const { eventDef } = getEventDef(schema, eventEncoded.name)
+      return eventDef.options.clientOnly
     }
 
     const connectedClientSessionPullQueues = yield* makePullQueueSet
@@ -196,14 +196,14 @@ export const makeLeaderSyncProcessor = ({
         const syncState = yield* syncStateSref
         if (syncState === undefined) return shouldNeverHappen('Not initialized')
 
-        const eventDef = getEventDef(schema, name)
+        const { eventDef } = getEventDef(schema, name)
 
         const eventEncoded = new LiveStoreEvent.EncodedWithMeta({
           name,
           args,
           clientId,
           sessionId,
-          ...EventId.nextPair(syncState.localHead, eventDef.eventDef.options.clientOnly),
+          ...EventId.nextPair(syncState.localHead, eventDef.options.clientOnly),
         })
 
         yield* push([eventEncoded])
@@ -251,8 +251,8 @@ export const makeLeaderSyncProcessor = ({
         const globalPendingEvents = pendingEvents
           // Don't sync clientOnly events
           .filter((eventEncoded) => {
-            const eventDef = getEventDef(schema, eventEncoded.name)
-            return eventDef.eventDef.options.clientOnly === false
+            const { eventDef } = getEventDef(schema, eventEncoded.name)
+            return eventDef.options.clientOnly === false
           })
 
         if (globalPendingEvents.length > 0) {
@@ -540,8 +540,8 @@ const backgroundApplyLocalPushes = ({
 
       // Don't sync clientOnly events
       const filteredBatch = mergeResult.newEvents.filter((eventEncoded) => {
-        const eventDef = getEventDef(schema, eventEncoded.name)
-        return eventDef.eventDef.options.clientOnly === false
+        const { eventDef } = getEventDef(schema, eventEncoded.name)
+        return eventDef.options.clientOnly === false
       })
 
       yield* BucketQueue.offerAll(syncBackendPushQueue, filteredBatch)
@@ -688,8 +688,8 @@ const backgroundBackendPulling = ({
           })
 
           const globalRebasedPendingEvents = mergeResult.newSyncState.pending.filter((event) => {
-            const eventDef = getEventDef(schema, event.name)
-            return eventDef.eventDef.options.clientOnly === false
+            const { eventDef } = getEventDef(schema, event.name)
+            return eventDef.options.clientOnly === false
           })
           yield* restartBackendPushing(globalRebasedPendingEvents)
 

package/src/leader-thread/materialize-event.ts

@@ -33,10 +33,12 @@ export const makeMaterializeEvent = ({
         const skipEventlog = options?.skipEventlog ?? false
 
         const eventName = eventEncoded.name
-        const eventDef = getEventDef(schema, eventName)
+        const { eventDef, materializer } = getEventDef(schema, eventName)
 
         const execArgsArr = getExecArgsFromEvent({
           eventDef,
+          materializer,
+          db,
           event: { decoded: undefined, encoded: eventEncoded },
         })
 

package/src/materializer-helper.ts

@@ -1,22 +1,26 @@
 import { isReadonlyArray } from '@livestore/utils'
 import { Schema } from '@livestore/utils/effect'
 
+import type { SqliteDb } from './adapter-types.js'
 import { SessionIdSymbol } from './adapter-types.js'
-import type { EventDef, Materializer, MaterializerResult } from './schema/EventDef.js'
+import type { EventDef, Materializer, MaterializerContextQuery, MaterializerResult } from './schema/EventDef.js'
 import type * as LiveStoreEvent from './schema/LiveStoreEvent.js'
+import type { QueryBuilder } from './schema/state/sqlite/query-builder/api.js'
 import { isQueryBuilder } from './schema/state/sqlite/query-builder/api.js'
-import type { BindValues } from './sql-queries/sql-queries.js'
-import type { PreparedBindValues } from './util.js'
+import { getResultSchema } from './schema/state/sqlite/query-builder/impl.js'
+import { type BindValues } from './sql-queries/sql-queries.js'
+import type { ParamsObject, PreparedBindValues } from './util.js'
 import { prepareBindValues } from './util.js'
 
 export const getExecArgsFromEvent = ({
-  eventDef: { eventDef, materializer },
+  eventDef,
+  materializer,
+  db,
   event,
 }: {
-  eventDef: {
-    eventDef: EventDef.AnyWithoutFn
-    materializer: Materializer
-  }
+  eventDef: EventDef.AnyWithoutFn
+  materializer: Materializer
+  db: SqliteDb
   /** Both encoded and decoded events are supported to reduce the number of times we need to decode/encode */
   event:
     | {
@@ -34,8 +38,28 @@ export const getExecArgsFromEvent = ({
 }> => {
   const eventArgsDecoded = event.decoded?.args ?? Schema.decodeUnknownSync(eventDef.schema)(event.encoded!.args)
 
+  const query: MaterializerContextQuery = (
+    rawQueryOrQueryBuilder:
+      | {
+          query: string
+          bindValues: ParamsObject
+        }
+      | QueryBuilder.Any,
+  ) => {
+    if (isQueryBuilder(rawQueryOrQueryBuilder)) {
+      const { query, bindValues } = rawQueryOrQueryBuilder.asSql()
+      const rawResults = db.select(query, prepareBindValues(bindValues, query))
+      const resultSchema = getResultSchema(rawQueryOrQueryBuilder)
+      return Schema.decodeSync(resultSchema)(rawResults)
+    } else {
+      const { query, bindValues } = rawQueryOrQueryBuilder
+      return db.select(query, prepareBindValues(bindValues, query))
+    }
+  }
+
   const res = materializer(eventArgsDecoded, {
-    clientOnly: eventDef.options.clientOnly,
+    eventDef,
+    query,
     // TODO properly implement this
     currentFacts: new Map(),
   })

package/src/schema/EventDef.ts

@@ -3,6 +3,7 @@ import { shouldNeverHappen } from '@livestore/utils'
 import { Schema } from '@livestore/utils/effect'
 
 import type { BindValues } from '../sql-queries/sql-queries.js'
+import type { ParamsObject } from '../util.js'
 import type { QueryBuilder } from './state/sqlite/query-builder/mod.js'
 
 export type EventDefMap = {
@@ -167,9 +168,19 @@ export type MaterializerResult =
   | QueryBuilder.Any
   | string
 
+export type MaterializerContextQuery = {
+  (args: { query: string; bindValues: ParamsObject }): ReadonlyArray<unknown>
+  <TResult>(qb: QueryBuilder<TResult, any, any>): TResult
+}
+
 export type Materializer<TEventDef extends EventDef.AnyWithoutFn = EventDef.AnyWithoutFn> = (
   event: TEventDef['schema']['Type'],
-  context: { currentFacts: EventDefFacts; clientOnly: boolean },
+  context: {
+    currentFacts: EventDefFacts
+    eventDef: TEventDef
+    /** Can be used to query the current state */
+    query: MaterializerContextQuery
+  },
 ) => SingleOrReadonlyArray<MaterializerResult>
 
 export const defineMaterializer = <TEventDef extends EventDef.AnyWithoutFn>(

package/src/schema/schema.ts

@@ -23,6 +23,10 @@ export type LiveStoreSchema<
 
   readonly state: State
   readonly eventsDefsMap: Map<string, EventDef.AnyWithoutFn>
+  readonly devtools: {
+    /** @default 'default' */
+    readonly alias: string
+  }
 }
 
 // TODO abstract this further away from sqlite/tables
@@ -39,6 +43,15 @@ export type State = {
 export type InputSchema = {
   readonly events: ReadonlyArray<EventDef.AnyWithoutFn> | Record<string, EventDef.AnyWithoutFn>
   readonly state: State
+  readonly devtools?: {
+    /**
+     * This alias value is used to disambiguate between multiple schemas in the devtools.
+     * Only needed when an app uses multiple schemas.
+     *
+     * @default 'default'
+     */
+    readonly alias?: string
+  }
 }
 
 export const makeSchema = <TInputSchema extends InputSchema>(
@@ -81,6 +94,9 @@ export const makeSchema = <TInputSchema extends InputSchema>(
     _EventDefMapType: Symbol.for('livestore.EventDefMapType') as any,
     state,
     eventsDefsMap,
+    devtools: {
+      alias: inputSchema.devtools?.alias ?? 'default',
+    },
   } satisfies LiveStoreSchema
 }
 

package/src/schema/state/sqlite/client-document-def.test.ts

@@ -5,11 +5,6 @@ import { tables } from '../../../__tests__/fixture.js'
 import type * as LiveStoreEvent from '../../LiveStoreEvent.js'
 import { clientDocument, ClientDocumentTableDefSymbol } from './client-document-def.js'
 
-const materializerContext = {
-  currentFacts: new Map(),
-  clientOnly: false,
-}
-
 describe('client document table', () => {
   test('set event', () => {
     expect(patchId(tables.UiState.set({ showSidebar: false }, 'session-1'))).toMatchInlineSnapshot(`
@@ -51,7 +46,11 @@ describe('client document table', () => {
 
       const materializer = Doc[ClientDocumentTableDefSymbol].derived.setMaterializer
 
-      return materializer(Doc.set(value, id as any).args, materializerContext)
+      return materializer(Doc.set(value, id as any).args, {
+        currentFacts: new Map(),
+        query: {} as any, // unused
+        eventDef: Doc[ClientDocumentTableDefSymbol].derived.setEventDef,
+      })
     }
 
     test('string value', () => {

package/src/schema/state/sqlite/query-builder/api.ts

@@ -19,7 +19,7 @@ export namespace QueryBuilderAst {
   export interface SelectQuery {
     readonly _tag: 'SelectQuery'
     readonly columns: string[]
-    readonly pickFirst: false | { fallback: () => any } | 'no-fallback'
+    readonly pickFirst: false | { fallback: () => any } | 'throws'
     readonly select: {
       columns: ReadonlyArray<string>
     }
@@ -288,10 +288,11 @@ export namespace QueryBuilder {
      * db.todos.where('id', '123').first()
      * ```
      *
-     * Query will fail if no rows are returned and no fallback is provided.
+     * Query will throw if no rows are returned and no fallback is provided.
      */
     readonly first: <TFallback = never>(options?: {
-      fallback?: () => TFallback | GetSingle<TResult>
+      /** @default 'throws' */
+      fallback?: (() => TFallback | GetSingle<TResult>) | 'throws'
     }) => QueryBuilder<
       TFallback | GetSingle<TResult>,
       TTableDef,

package/src/schema/state/sqlite/query-builder/impl.ts

@@ -143,7 +143,8 @@ export const makeQueryBuilder = <TResult, TTableDef extends TableDefBase>(
       return makeQueryBuilder(tableDef, {
         ...ast,
         limit: Option.some(1),
-        pickFirst: options?.fallback ? { fallback: options.fallback } : 'no-fallback',
+        pickFirst:
+          options?.fallback !== undefined && options.fallback !== 'throws' ? { fallback: options.fallback } : 'throws',
       })
     },
     // // eslint-disable-next-line prefer-arrow/prefer-arrow-functions
@@ -309,7 +310,7 @@ export const getResultSchema = (qb: QueryBuilder<any, any, any>): Schema.Schema<
       const arraySchema = Schema.Array(queryAst.resultSchemaSingle)
       if (queryAst.pickFirst === false) {
         return arraySchema
-      } else if (queryAst.pickFirst === 'no-fallback') {
+      } else if (queryAst.pickFirst === 'throws') {
         // Will throw if the array is empty
         return arraySchema.pipe(Schema.headOrElse())
       } else {

package/src/version.ts

@@ -2,7 +2,7 @@
 // import packageJson from '../package.json' with { type: 'json' }
 // export const liveStoreVersion = packageJson.version
 
-export const liveStoreVersion = '0.3.0-dev.34' as const
+export const liveStoreVersion = '0.3.0-dev.37' as const
 
 /**
  * This version number is incremented whenever the internal storage format changes in a breaking way.