@livestore/livestore 0.4.0-dev.18 → 0.4.0-dev.19

package/docs/api/livestore/type-aliases/MutableDebugInfo-1/index.md

@@ -0,0 +1,5 @@
+# MutableDebugInfo
+
+> **MutableDebugInfo** = *typeof* `MutableDebugInfo.Type`
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/debug-info.d.ts:73

package/docs/api/livestore/type-aliases/OtelOptions/index.md

@@ -0,0 +1,21 @@
+# OtelOptions
+
+> **OtelOptions** = `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:58](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L58)
+
+## Properties
+
+### rootSpanContext
+
+> **rootSpanContext**: `otel.Context`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:60](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L60)
+
+***
+
+### tracer
+
+> **tracer**: `otel.Tracer`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:59](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L59)

package/docs/api/livestore/type-aliases/PreparedBindValues/index.md

@@ -0,0 +1,5 @@
+# PreparedBindValues
+
+> **PreparedBindValues** = `brand`\<`Union`\<\[`Array$`\<`Union`\<\[*typeof* `String$`, *typeof* `Number$`, `Schema`\<`Uint8Array`\<`ArrayBuffer`\>, `Uint8Array`\<`ArrayBuffer`\>, `never`\>, *typeof* `Null`\]\>\>, `Record$`\<*typeof* `String$`, `Union`\<\[*typeof* `String$`, *typeof* `Number$`, `Schema`\<`Uint8Array`\<`ArrayBuffer`\>, `Uint8Array`\<`ArrayBuffer`\>, `never`\>, *typeof* `Null`\]\>\>\]\>, `"PreparedBindValues"`\>
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/util.d.ts:7

package/docs/api/livestore/type-aliases/PreparedBindValues-1/index.md

@@ -0,0 +1,5 @@
+# PreparedBindValues
+
+> **PreparedBindValues** = `Brand.Branded`\<[`Bindable`](/api/livestore/type-aliases/bindable/), `"PreparedBindValues"`\>
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/util.d.ts:7

package/docs/api/livestore/type-aliases/QueryBuilder/index.md

@@ -0,0 +1,61 @@
+# QueryBuilder
+
+> **QueryBuilder**\<`TResult`, `TTableDef`, `TWithout`\> = `object` & `Omit`\<[`ApiFull`](/api/livestore/livestore/namespaces/querybuilder/type-aliases/apifull/)\<`TResult`, `TTableDef`, `TWithout`\>, `TWithout`\>
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/schema/state/sqlite/query-builder/api.d.ts:103
+
+## Type Declaration
+
+### \[QueryBuilderAstSymbol\]
+
+> `readonly` **\[QueryBuilderAstSymbol\]**: [`QueryBuilderAst`](/api/livestore/type-aliases/querybuilderast/)
+
+### \[QueryBuilderTypeId\]
+
+> `readonly` **\[QueryBuilderTypeId\]**: [`QueryBuilderTypeId`](/api/livestore/livestore/namespaces/state/type-aliases/querybuildertypeid/)
+
+### asSql()
+
+> `readonly` **asSql**: () => `object`
+
+#### Returns
+
+`object`
+
+##### bindValues
+
+> **bindValues**: `SqlValue`[]
+
+##### query
+
+> **query**: `string`
+
+##### usedTables
+
+> **usedTables**: `Set`\<`string`\>
+
+### ResultType
+
+> `readonly` **ResultType**: `TResult`
+
+### toString()
+
+> `readonly` **toString**: () => `string`
+
+#### Returns
+
+`string`
+
+## Type Parameters
+
+### TResult
+
+`TResult`
+
+### TTableDef
+
+`TTableDef` *extends* [`TableDefBase`](/api/livestore/livestore/namespaces/state/namespaces/sqlite/type-aliases/tabledefbase/)
+
+### TWithout
+
+`TWithout` *extends* [`ApiFeature`](/api/livestore/livestore/namespaces/querybuilder/type-aliases/apifeature/) = `never`

package/docs/api/livestore/type-aliases/QueryBuilderAst/index.md

@@ -0,0 +1,5 @@
+# QueryBuilderAst
+
+> **QueryBuilderAst** = [`SelectQuery`](/api/livestore/livestore/namespaces/querybuilderast/interfaces/selectquery/) \| [`CountQuery`](/api/livestore/livestore/namespaces/querybuilderast/interfaces/countquery/) \| [`RowQuery`](/api/livestore/livestore/namespaces/querybuilderast/interfaces/rowquery/) \| [`InsertQuery`](/api/livestore/livestore/namespaces/querybuilderast/interfaces/insertquery/) \| [`UpdateQuery`](/api/livestore/livestore/namespaces/querybuilderast/interfaces/updatequery/) \| [`DeleteQuery`](/api/livestore/livestore/namespaces/querybuilderast/interfaces/deletequery/)
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/schema/state/sqlite/query-builder/api.d.ts:8

package/docs/api/livestore/type-aliases/QueryDebugInfo/index.md

@@ -0,0 +1,37 @@
+# QueryDebugInfo
+
+> **QueryDebugInfo** = `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:200](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L200)
+
+## Properties
+
+### \_tag
+
+> **\_tag**: `string`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:201](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L201)
+
+***
+
+### durationMs
+
+> **durationMs**: `number`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:204](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L204)
+
+***
+
+### label
+
+> **label**: `string`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:202](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L202)
+
+***
+
+### query
+
+> **query**: `string`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:203](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L203)

package/docs/api/livestore/type-aliases/Queryable/index.md

@@ -0,0 +1,13 @@
+# Queryable
+
+> **Queryable**\<`TResult`\> = [`LiveQueryDef`](/api/livestore/interfaces/livequerydef/)\<`TResult`\> \| [`SignalDef`](/api/livestore/interfaces/signaldef/)\<`TResult`\> \| [`LiveQuery`](/api/livestore/interfaces/livequery/)\<`TResult`\> \| [`QueryBuilder`](/api/livestore/type-aliases/querybuilder/)\<`TResult`, `any`, `any`\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:256](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L256)
+
+All query definitions or instances the store can execute or subscribe to.
+
+## Type Parameters
+
+### TResult
+
+`TResult`

package/docs/api/livestore/type-aliases/RefreshReason/index.md

@@ -0,0 +1,75 @@
+# RefreshReason
+
+> **RefreshReason** = `DebugRefreshReasonBase` \| \{ `_tag`: `"commit"`; `events`: `ReadonlyArray`\<[`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/client/type-aliases/decoded/) \| [`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/input/type-aliases/decoded/)\>; `writeTables`: `ReadonlyArray`\<`string`\>; \} \| \{ `_tag`: `"react"`; `api`: `string`; `label?`: `string`; `stackInfo?`: [`StackInfo`](/api/livestore/type-aliases/stackinfo/); \} \| \{ `_tag`: `"subscribe.initial"`; `label?`: `string`; \} \| \{ `_tag`: `"subscribe.update"`; `label?`: `string`; \} \| \{ `_tag`: `"manual"`; `label?`: `string`; \}
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:179](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L179)
+
+## Type Declaration
+
+`DebugRefreshReasonBase`
+
+\{ `_tag`: `"commit"`; `events`: `ReadonlyArray`\<[`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/client/type-aliases/decoded/) \| [`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/input/type-aliases/decoded/)\>; `writeTables`: `ReadonlyArray`\<`string`\>; \}
+
+### \_tag
+
+> **\_tag**: `"commit"`
+
+### events
+
+> **events**: `ReadonlyArray`\<[`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/client/type-aliases/decoded/) \| [`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/input/type-aliases/decoded/)\>
+
+The events that were applied
+
+### writeTables
+
+> **writeTables**: `ReadonlyArray`\<`string`\>
+
+The tables that were written to by the event
+
+\{ `_tag`: `"react"`; `api`: `string`; `label?`: `string`; `stackInfo?`: [`StackInfo`](/api/livestore/type-aliases/stackinfo/); \}
+
+### \_tag
+
+> **\_tag**: `"react"`
+
+### api
+
+> **api**: `string`
+
+### label?
+
+> `optional` **label**: `string`
+
+### stackInfo?
+
+> `optional` **stackInfo**: [`StackInfo`](/api/livestore/type-aliases/stackinfo/)
+
+\{ `_tag`: `"subscribe.initial"`; `label?`: `string`; \}
+
+### \_tag
+
+> **\_tag**: `"subscribe.initial"`
+
+### label?
+
+> `optional` **label**: `string`
+
+\{ `_tag`: `"subscribe.update"`; `label?`: `string`; \}
+
+### \_tag
+
+> **\_tag**: `"subscribe.update"`
+
+### label?
+
+> `optional` **label**: `string`
+
+\{ `_tag`: `"manual"`; `label?`: `string`; \}
+
+### \_tag
+
+> **\_tag**: `"manual"`
+
+### label?
+
+> `optional` **label**: `string`

package/docs/api/livestore/type-aliases/SessionIdSymbol/index.md

@@ -0,0 +1,5 @@
+# SessionIdSymbol
+
+> **SessionIdSymbol** = *typeof* [`SessionIdSymbol`](/api/livestore/variables/sessionidsymbol/)
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/adapter-types.d.ts:88

package/docs/api/livestore/type-aliases/ShutdownDeferred/index.md

@@ -0,0 +1,5 @@
+# ShutdownDeferred
+
+> **ShutdownDeferred** = `Deferred.Deferred`\<[`IntentionalShutdownCause`](/api/livestore/classes/intentionalshutdowncause/), `UnknownError` \| `SyncError` \| [`StoreInterrupted`](/api/livestore/classes/storeinterrupted/) \| `MaterializeError` \| `InvalidPullError` \| `IsOfflineError`\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:44](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L44)

package/docs/api/livestore/type-aliases/StackFrame/index.md

@@ -0,0 +1,21 @@
+# StackFrame
+
+> **StackFrame** = `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/utils/stack-info.ts:5](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/utils/stack-info.ts#L5)
+
+## Properties
+
+### filePath
+
+> **filePath**: `string`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/utils/stack-info.ts:7](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/utils/stack-info.ts#L7)
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/utils/stack-info.ts:6](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/utils/stack-info.ts#L6)

package/docs/api/livestore/type-aliases/StackInfo/index.md

@@ -0,0 +1,13 @@
+# StackInfo
+
+> **StackInfo** = `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/utils/stack-info.ts:1](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/utils/stack-info.ts#L1)
+
+## Properties
+
+### frames
+
+> **frames**: [`StackFrame`](/api/livestore/type-aliases/stackframe/)[]
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/utils/stack-info.ts:2](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/utils/stack-info.ts#L2)

package/docs/api/livestore/type-aliases/StoreInternals/index.md

@@ -0,0 +1,156 @@
+# StoreInternals
+
+> **StoreInternals** = `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:73](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L73)
+
+Opaque bag containing the Store's implementation details.
+
+Not part of the public API — shapes and semantics may change without notice.
+Access only from within the @livestore/livestore package (and Devtools) via
+`StoreInternalsSymbol` to avoid accidental coupling in application code.
+
+## Properties
+
+### activeQueries
+
+> `readonly` **activeQueries**: `ReferenceCountedSet`\<[`LiveQuery`](/api/livestore/interfaces/livequery/)\<`any`\>\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:136](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L136)
+
+Set of currently subscribed LiveQuery instances (reference‑counted).
+Used for Devtools and diagnostics.
+
+***
+
+### boot
+
+> `readonly` **boot**: `Effect.Effect`\<`void`, `UnknownError`, `Scope.Scope`\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:149](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L149)
+
+Starts background fibers for sync and observation. Must be run exactly
+once per Store instance. Scoped; installs finalizers to end spans and
+detach reactive refs.
+
+***
+
+### clientSession
+
+> `readonly` **clientSession**: [`ClientSession`](/api/livestore/interfaces/clientsession/)
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:88](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L88)
+
+The active client session backing this Store. Provides access to the
+leader thread, network status, and shutdown signaling.
+
+Do not close or mutate directly — use `store.shutdown(...)`.
+
+***
+
+### effectContext
+
+> `readonly` **effectContext**: `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:102](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L102)
+
+Effect runtime and scope used to fork background fibers for the Store.
+
+- `runtime` executes effects from imperative Store APIs.
+- `lifetimeScope` owns forked fibers; closed during Store shutdown.
+
+#### lifetimeScope
+
+> `readonly` **lifetimeScope**: `Scope.Scope`
+
+Scope that owns all long‑lived fibers spawned by the Store.
+
+#### runtime
+
+> `readonly` **runtime**: `Runtime.Runtime`\<`Scope.Scope`\>
+
+Effect runtime to run Store effects with proper environment.
+
+***
+
+### eventSchema
+
+> `readonly` **eventSchema**: `Schema.Schema`\<[`Decoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/client/type-aliases/decoded/), [`Encoded`](/api/livestore/livestore/namespaces/livestoreevent/namespaces/client/type-aliases/encoded/)\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:80](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L80)
+
+Runtime event schema used for encoding/decoding events.
+
+Exposed primarily for Devtools (e.g. databrowser) to validate ad‑hoc
+event payloads. Application code should not depend on it directly.
+
+***
+
+### isShutdown
+
+> **isShutdown**: `boolean`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:155](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L155)
+
+Tracks whether the Store has been shut down. When true, mutating APIs
+should reject via `checkShutdown`.
+
+***
+
+### otel
+
+> `readonly` **otel**: `StoreOtel`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:113](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L113)
+
+OpenTelemetry primitives used for instrumentation of commits, queries,
+and Store boot lifecycle.
+
+***
+
+### reactivityGraph
+
+> `readonly` **reactivityGraph**: `ReactivityGraph`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:120](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L120)
+
+The Store's reactive graph instance used to model dependencies and
+propagate updates. Provides APIs to create refs/thunks/effects and to
+subscribe to refresh cycles.
+
+***
+
+### sqliteDbWrapper
+
+> `readonly` **sqliteDbWrapper**: [`SqliteDbWrapper`](/api/livestore/classes/sqlitedbwrapper/)
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:94](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L94)
+
+Wrapper around the local SQLite state database. Centralizes query
+planning, caching, and change tracking used by reads and materializers.
+
+***
+
+### syncProcessor
+
+> `readonly` **syncProcessor**: `ClientSessionSyncProcessor`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:142](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L142)
+
+Client‑session sync processor orchestrating push/pull and materialization
+of events into local state.
+
+***
+
+### tableRefs
+
+> `readonly` **tableRefs**: `Readonly`\<`Record`\<`string`, `Ref`\<`null`, `ReactivityGraphContext`, [`RefreshReason`](/api/livestore/type-aliases/refreshreason/)\>\>\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:130](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L130)
+
+Per‑table reactive refs used to broadcast invalidations when materializers
+write to tables. Values are always `null`; equality is intentionally
+`false` to force recomputation.
+
+Keys are SQLite table names (user tables; some system tables may be
+intentionally excluded from refresh).

package/docs/api/livestore/type-aliases/StoreInternalsSymbol/index.md

@@ -0,0 +1,5 @@
+# StoreInternalsSymbol
+
+> **StoreInternalsSymbol** = *typeof* [`StoreInternalsSymbol`](/api/livestore/variables/storeinternalssymbol/)
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:63](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L63)

package/docs/api/livestore/type-aliases/SubscribeOptions/index.md

@@ -0,0 +1,73 @@
+# SubscribeOptions
+
+> **SubscribeOptions**\<`TResult`\> = `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:246](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L246)
+
+## Type Parameters
+
+### TResult
+
+`TResult`
+
+## Properties
+
+### label?
+
+> `optional` **label**: `string`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:249](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L249)
+
+***
+
+### onSubscribe()?
+
+> `optional` **onSubscribe**: (`query$`) => `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:247](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L247)
+
+#### Parameters
+
+##### query$
+
+[`LiveQuery`](/api/livestore/interfaces/livequery/)\<`TResult`\>
+
+#### Returns
+
+`void`
+
+***
+
+### onUnsubsubscribe()?
+
+> `optional` **onUnsubsubscribe**: () => `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:248](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L248)
+
+#### Returns
+
+`void`
+
+***
+
+### otelContext?
+
+> `optional` **otelContext**: `otel.Context`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:251](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L251)
+
+***
+
+### skipInitialRun?
+
+> `optional` **skipInitialRun**: `boolean`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:250](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L250)
+
+***
+
+### stackInfo?
+
+> `optional` **stackInfo**: [`StackInfo`](/api/livestore/type-aliases/stackinfo/)
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:252](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L252)

package/docs/api/livestore/type-aliases/Unsubscribe/index.md

@@ -0,0 +1,9 @@
+# Unsubscribe
+
+> **Unsubscribe** = () => `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:244](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L244)
+
+## Returns
+
+`void`

package/docs/api/livestore/variables/LiveStoreSchemaSymbol/index.md

@@ -0,0 +1,5 @@
+# LiveStoreSchemaSymbol
+
+> `const` **LiveStoreSchemaSymbol**: unique `symbol`
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/schema/schema.d.ts:6

package/docs/api/livestore/variables/SessionIdSymbol/index.md

@@ -0,0 +1,26 @@
+# SessionIdSymbol
+
+> `const` **SessionIdSymbol**: unique `symbol`
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/adapter-types.d.ts:88
+
+Can be used in queries to refer to the current session id.
+Will be replaced with the actual session id at runtime
+
+In client document table:
+```ts
+const uiState = State.SQLite.clientDocument({
+  name: 'ui_state',
+  schema: Schema.Struct({
+    theme: Schema.Literal('dark', 'light', 'system'),
+    user: Schema.String,
+    showToolbar: Schema.Boolean,
+  }),
+  default: { value: defaultFrontendState, id: SessionIdSymbol },
+})
+```
+
+Or in a client document query:
+```ts
+const query$ = queryDb(tables.uiState.get(SessionIdSymbol))
+```

package/docs/api/livestore/variables/StoreInternalsSymbol/index.md

@@ -0,0 +1,5 @@
+# StoreInternalsSymbol
+
+> `const` **StoreInternalsSymbol**: *typeof* `StoreInternalsSymbol`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/store/store-types.ts:63](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/store/store-types.ts#L63)

package/docs/api/livestore/variables/UNKNOWN_EVENT_SCHEMA_HASH/index.md

@@ -0,0 +1,5 @@
+# UNKNOWN_EVENT_SCHEMA_HASH
+
+> `const` **UNKNOWN\_EVENT\_SCHEMA\_HASH**: `-1` = `-1`
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/schema/schema.d.ts:8

package/docs/api/livestore/variables/clientOnly/index.md

@@ -0,0 +1,54 @@
+# clientOnly
+
+> `const` **clientOnly**: \<`TName`, `TType`, `TEncoded`\>(`args`) => [`EventDef`](/api/livestore/type-aliases/eventdef/)\<`TName`, `TType`, `TEncoded`\>
+
+Defined in: submodules/livestore/packages/@livestore/common/dist/schema/EventDef/define.d.ts:143
+
+Creates a client-only event definition.
+
+Client-only events are synced within the same client's sessions (e.g., across
+browser tabs) but are never sent to the sync backend. Use this for local UI
+state like selected items, filter settings, or draft content.
+
+Note: Client-only events still require materializers and are stored in the
+local eventlog, they just don't participate in server-side sync.
+
+## Type Parameters
+
+### TName
+
+`TName` *extends* `string`
+
+### TType
+
+`TType`
+
+### TEncoded
+
+`TEncoded` = `TType`
+
+## Parameters
+
+### args
+
+`object` & `Omit`\<[`DefineEventOptions`](/api/livestore/type-aliases/defineeventoptions/)\<`TType`, `false`\>, `"derived"` \| `"clientOnly"`\>
+
+## Returns
+
+[`EventDef`](/api/livestore/type-aliases/eventdef/)\<`TName`, `TType`, `TEncoded`\>
+
+## Example
+
+```ts
+
+const uiStateSet = Events.clientOnly({
+  name: 'UiStateSet',
+  schema: Schema.Struct({
+    selectedTodoId: Schema.NullOr(Schema.String),
+    filterMode: Schema.Literal('all', 'active', 'completed'),
+  }),
+})
+
+// Update local UI state
+store.commit(uiStateSet({ selectedTodoId: 'abc', filterMode: 'active' }))
+```