@livestore/livestore 0.2.0 → 0.3.0-dev.11

package/dist/store/store.d.ts

@@ -1,17 +1,20 @@
-import type { ClientSession, ParamsObject, QueryBuilder } from '@livestore/common';
-import type { LiveStoreSchema, MutationEvent } from '@livestore/common/schema';
-import { Inspectable } from '@livestore/utils/effect';
+import type { ClientSession, ParamsObject, QueryBuilder, UnexpectedError } from '@livestore/common';
+import type { LiveStoreSchema } from '@livestore/common/schema';
+import { MutationEvent } from '@livestore/common/schema';
+import type { Scope } from '@livestore/utils/effect';
+import { Effect, Inspectable, Stream } from '@livestore/utils/effect';
 import * as otel from '@opentelemetry/api';
-import type { GraphQLSchema } from 'graphql';
-import type { LiveQuery, QueryContext, ReactivityGraph } from '../live-queries/base-class.js';
+import { type GraphQLSchema } from 'graphql';
+import type { ILiveQueryRefDef, LiveQuery, LiveQueryDef, ReactivityGraph, ReactivityGraphContext } from '../live-queries/base-class.js';
 import type { Ref } from '../reactive.js';
-import { SynchronousDatabaseWrapper } from '../SynchronousDatabaseWrapper.js';
+import { SqliteDbWrapper } from '../SqliteDbWrapper.js';
 import { ReferenceCountedSet } from '../utils/data-structures.js';
-import type { BaseGraphQLContext, RefreshReason, StoreMutateOptions, StoreOptions, StoreOtel } from './store-types.js';
+import type { StackInfo } from '../utils/stack-info.js';
+import type { BaseGraphQLContext, RefreshReason, StoreMutateOptions, StoreOptions, StoreOtel, Unsubscribe } from './store-types.js';
 export declare class Store<TGraphQLContext extends BaseGraphQLContext = BaseGraphQLContext, TSchema extends LiveStoreSchema = LiveStoreSchema> extends Inspectable.Class {
     readonly storeId: string;
     reactivityGraph: ReactivityGraph;
-    syncDbWrapper: SynchronousDatabaseWrapper;
+    sqliteDbWrapper: SqliteDbWrapper;
     clientSession: ClientSession;
     schema: LiveStoreSchema;
     graphQLSchema?: GraphQLSchema;
@@ -22,32 +25,69 @@ export declare class Store<TGraphQLContext extends BaseGraphQLContext = BaseGrap
      * This only works in combination with `equal: () => false` which will always trigger a refresh.
      */
     tableRefs: {
-        [key: string]: Ref<null, QueryContext, RefreshReason>;
+        [key: string]: Ref<null, ReactivityGraphContext, RefreshReason>;
     };
-    private fiberSet;
     private runtime;
     /** RC-based set to see which queries are currently subscribed to */
     activeQueries: ReferenceCountedSet<LiveQuery<any>>;
-    readonly __mutationEventSchema: import("@livestore/common/schema").MutationEventSchema<TSchema["_MutationDefMapType"]>;
+    readonly __mutationEventSchema: MutationEvent.ForMutationDefRecord<TSchema["_MutationDefMapType"]>;
     private unsyncedMutationEvents;
-    private constructor();
-    static createStore: <TGraphQLContext_1 extends BaseGraphQLContext, TSchema_1 extends LiveStoreSchema = LiveStoreSchema>(storeOptions: StoreOptions<TGraphQLContext_1, TSchema_1>, parentSpan: otel.Span) => Store<TGraphQLContext_1, TSchema_1>;
+    private syncProcessor;
+    readonly lifetimeScope: Scope.Scope;
+    readonly boot: Effect.Effect<void, UnexpectedError, Scope.Scope>;
+    constructor({ clientSession, schema, graphQLOptions, otelOptions, disableDevtools, batchUpdates, unsyncedMutationEvents, storeId, lifetimeScope, runtime, }: StoreOptions<TGraphQLContext, TSchema>);
     get sessionId(): string;
     /**
      * Subscribe to the results of a query
      * Returns a function to cancel the subscription.
+     *
+     * @example
+     * ```ts
+     * const unsubscribe = store.subscribe(query$, { onUpdate: (result) => console.log(result) })
+     * ```
      */
-    subscribe: <TResult>(query$: LiveQuery<TResult, any>, onNewValue: (value: TResult) => void, onUnsubsubscribe?: () => void, options?: {
+    subscribe: <TResult>(query: LiveQueryDef<TResult, any> | LiveQuery<TResult, any>, options: {
+        /** Called when the query result has changed */
+        onUpdate: (value: TResult) => void;
+        onSubscribe?: (query$: LiveQuery<TResult, any>) => void;
+        /** Gets called after the query subscription has been removed */
+        onUnsubsubscribe?: () => void;
         label?: string;
+        /**
+         * Skips the initial `onUpdate` callback
+         * @default false
+         */
+        skipInitialRun?: boolean;
         otelContext?: otel.Context;
+        /** If provided, the stack info will be added to the `activeSubscriptions` set of the query */
+        stackInfo?: StackInfo;
+    }) => Unsubscribe;
+    subscribeStream: <TResult>(query$: LiveQueryDef<TResult, any>, options?: {
+        label?: string;
         skipInitialRun?: boolean;
-    } | undefined) => (() => void);
-    query: <TResult>(query: QueryBuilder<TResult, any, any> | LiveQuery<TResult, any> | {
+    } | undefined) => Stream.Stream<TResult>;
+    /**
+     * Synchronously queries the database without creating a LiveQuery.
+     * This is useful for queries that don't need to be reactive.
+     *
+     * Example: Query builder
+     * ```ts
+     * const completedTodos = store.query(tables.todo.where({ complete: true }))
+     * ```
+     *
+     * Example: Raw SQL query
+     * ```ts
+     * const completedTodos = store.query({ query: 'SELECT * FROM todo WHERE complete = 1', bindValues: {} })
+     * ```
+     */
+    query: <TResult>(query: QueryBuilder<TResult, any, any> | LiveQuery<TResult, any> | LiveQueryDef<TResult, any> | {
         query: string;
         bindValues: ParamsObject;
     }, options?: {
         otelContext?: otel.Context;
+        debugRefreshReason?: RefreshReason;
     }) => TResult;
+    setRef: <T>(refDef: ILiveQueryRefDef<T>, value: T) => void;
     mutate: {
         <const TMutationArg extends ReadonlyArray<MutationEvent.PartialForSchema<TSchema>>>(...list: TMutationArg): void;
         (txn: <const TMutationArg extends ReadonlyArray<MutationEvent.PartialForSchema<TSchema>>>(...list: TMutationArg) => void): void;
@@ -61,33 +101,12 @@ export declare class Store<TGraphQLContext extends BaseGraphQLContext = BaseGrap
     manualRefresh: (options?: {
         label?: string;
     }) => void;
-    /**
-     * Apply a mutation to the store.
-     * Returns the tables that were affected by the event.
-     * This is an internal method that doesn't trigger a refresh;
-     * the caller must refresh queries after calling this method.
-     */
-    mutateWithoutRefresh: (mutationEventDecoded_: MutationEvent.ForSchema<TSchema> | MutationEvent.PartialForSchema<TSchema>, options: {
-        otelContext: otel.Context;
-        coordinatorMode: "default" | "skip-coordinator" | "skip-persist";
-    }) => {
-        writeTables: ReadonlySet<string>;
-        durationMs: number;
-    };
-    /**
-     * Directly execute a SQL query on the Store.
-     * This should only be used for framework-internal purposes;
-     * all app writes should go through mutate.
-     */
-    __execute: (query: string, params?: ParamsObject, writeTables?: ReadonlySet<string>, otelContext?: otel.Context) => void;
     private makeTableRef;
-    __devDownloadDb: () => void;
-    __devDownloadMutationLogDb: () => import("effect/Fiber").RuntimeFiber<import("effect/Fiber").RuntimeFiber<void, import("@livestore/common").UnexpectedError>, never>;
-    __devCurrentMutationEventId: () => import("@livestore/common").EventId;
     toJSON: () => {
         _tag: string;
         reactivityGraph: import("../reactive.js").ReactiveGraphSnapshot;
     };
     private runEffectFork;
+    private getMutateArgs;
 }
 //# sourceMappingURL=store.d.ts.map

package/dist/store/store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAsB,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAStG,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAU9E,OAAO,EAA0B,WAAW,EAA2C,MAAM,yBAAyB,CAAA;AACtH,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC7F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAA;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAGjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAMtH,qBAAa,KAAK,CAChB,eAAe,SAAS,kBAAkB,GAAG,kBAAkB,EAC/D,OAAO,SAAS,eAAe,GAAG,eAAe,CACjD,SAAQ,WAAW,CAAC,KAAK;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,eAAe,CAAA;IAChC,aAAa,EAAE,0BAA0B,CAAA;IACzC,aAAa,EAAE,aAAa,CAAA;IAC5B,MAAM,EAAE,eAAe,CAAA;IACvB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,cAAc,CAAC,EAAE,eAAe,CAAA;IAChC,IAAI,EAAE,SAAS,CAAA;IACf;;;OAGG;IACH,SAAS,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,YAAY,EAAE,aAAa,CAAC,CAAA;KAAE,CAAA;IAEpE,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,OAAO,CAA8B;IAE7C,oEAAoE;IACpE,aAAa,EAAE,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;IAGlD,QAAQ,CAAC,qBAAqB,yFAAA;IAC9B,OAAO,CAAC,sBAAsB,CAAA;IAG9B,OAAO;IAsHP,MAAM,CAAC,WAAW,6BAA4B,kBAAkB,oBAAkB,eAAe,kCACjF,YAAY,CAAC,iBAAe,EAAE,SAAO,CAAC,cACxC,IAAI,CAAC,IAAI,KACpB,KAAK,CAAC,iBAAe,EAAE,SAAO,CAAC,CASjC;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,SAAS,GAAI,OAAO,UACV,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,cACnB,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,qBACjB,MAAM,IAAI,YACnB;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,KAC7F,CAAC,MAAM,IAAI,CAAC,CAgCZ;IAEH,KAAK,GAAI,OAAO,SACP,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,YAAY,CAAA;KAAE,YACpG;QAAE,WAAW,CAAC,EAAE,IAAI,CAAC,OAAO,CAAA;KAAE,KACvC,OAAO,CA4BT;IAGD,MAAM,EAAE;QACN,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,YAAY,GAAG,IAAI,CAAA;QAChH,CACE,GAAG,EAAE,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EACrF,GAAG,IAAI,EAAE,YAAY,KAClB,IAAI,GACR,IAAI,CAAA;QACP,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAChF,OAAO,EAAE,kBAAkB,EAC3B,GAAG,IAAI,EAAE,YAAY,GACpB,IAAI,CAAA;QACP,CACE,OAAO,EAAE,kBAAkB,EAC3B,GAAG,EAAE,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EACrF,GAAG,IAAI,EAAE,YAAY,KAClB,IAAI,GACR,IAAI,CAAA;KACR,CAsIA;IAGD;;;OAGG;IACH,aAAa,aAAc;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,UAY5C;IAGD;;;;;OAKG;IACH,oBAAoB,0BACK,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,WACxF;QACP,WAAW,EAAE,IAAI,CAAC,OAAO,CAAA;QAEzB,eAAe,EAAE,SAAS,GAAG,kBAAkB,GAAG,cAAc,CAAA;KACjE,KACA;QAAE,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CA8E1D;IAGD;;;;OAIG;IACH,SAAS,UACA,MAAM,WACL,YAAY,gBACN,WAAW,CAAC,MAAM,CAAC,gBACnB,IAAI,CAAC,OAAO,UAK3B;IAED,OAAO,CAAC,YAAY,CAKhB;IAEJ,eAAe,aAGd;IAED,0BAA0B,2IAIG;IAE7B,2BAA2B,4CAAsF;IAGjH,MAAM;;;MAKL;IAED,OAAO,CAAC,aAAa,CAC8E;CACpG"}
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../src/store/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,YAAY,EAEZ,YAAY,EACZ,eAAe,EAChB,MAAM,mBAAmB,CAAA;AAa1B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,EACL,aAAa,EAId,MAAM,0BAA0B,CAAA;AAEjC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAGL,MAAM,EACN,WAAW,EAKX,MAAM,EACP,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAA;AAC1C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,SAAS,CAAA;AAE5C,OAAO,KAAK,EACV,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,eAAe,EACf,sBAAsB,EACvB,MAAM,+BAA+B,CAAA;AAEtC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAGjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EACV,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,SAAS,EACT,WAAW,EACZ,MAAM,kBAAkB,CAAA;AAMzB,qBAAa,KAAK,CAChB,eAAe,SAAS,kBAAkB,GAAG,kBAAkB,EAC/D,OAAO,SAAS,eAAe,GAAG,eAAe,CACjD,SAAQ,WAAW,CAAC,KAAK;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,eAAe,EAAE,eAAe,CAAA;IAChC,eAAe,EAAE,eAAe,CAAA;IAChC,aAAa,EAAE,aAAa,CAAA;IAC5B,MAAM,EAAE,eAAe,CAAA;IACvB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,cAAc,CAAC,EAAE,eAAe,CAAA;IAChC,IAAI,EAAE,SAAS,CAAA;IACf;;;OAGG;IACH,SAAS,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,sBAAsB,EAAE,aAAa,CAAC,CAAA;KAAE,CAAA;IAE9E,OAAO,CAAC,OAAO,CAA8B;IAE7C,oEAAoE;IACpE,aAAa,EAAE,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;IAGlD,QAAQ,CAAC,qBAAqB,qEAAA;IAC9B,OAAO,CAAC,sBAAsB,CAAA;IAC9B,OAAO,CAAC,aAAa,CAA4B;IACjD,QAAQ,CAAC,aAAa,EAAE,KAAK,CAAC,KAAK,CAAA;IAEnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;gBAGpD,EACV,aAAa,EACb,MAAM,EACN,cAAc,EACd,WAAW,EACX,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,OAAO,EACP,aAAa,EACb,OAAO,GACR,EAAE,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC;IAiJzC,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;;;;;OAQG;IACH,SAAS,GAAI,OAAO,SACX,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,WAClD;QACP,+CAA+C;QAC/C,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;QAClC,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,IAAI,CAAA;QACvD,gEAAgE;QAChE,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAA;QAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;QACd;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,WAAW,CAAC,EAAE,IAAI,CAAC,OAAO,CAAA;QAC1B,8FAA8F;QAC9F,SAAS,CAAC,EAAE,SAAS,CAAA;KACtB,KACA,WAAW,CA0DX;IAEH,eAAe,GAAI,OAAO,UAChB,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,YACxB;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,SAAS,KACjE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAmBtB;IAEH;;;;;;;;;;;;;OAaG;IACH,KAAK,GAAI,OAAO,SAEV,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,GAC/B,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,GACvB,YAAY,CAAC,OAAO,EAAE,GAAG,CAAC,GAC1B;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,YAAY,CAAA;KAAE,YACrC;QAAE,WAAW,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;QAAC,kBAAkB,CAAC,EAAE,aAAa,CAAA;KAAE,KAC3E,OAAO,CA+BT;IAaD,MAAM,GAAI,CAAC,UAAU,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,KAAG,IAAI,CAIxD;IAGD,MAAM,EAAE;QACN,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,YAAY,GAAG,IAAI,CAAA;QAChH,CACE,GAAG,EAAE,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EACrF,GAAG,IAAI,EAAE,YAAY,KAClB,IAAI,GACR,IAAI,CAAA;QACP,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EAChF,OAAO,EAAE,kBAAkB,EAC3B,GAAG,IAAI,EAAE,YAAY,GACpB,IAAI,CAAA;QACP,CACE,OAAO,EAAE,kBAAkB,EAC3B,GAAG,EAAE,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,EACrF,GAAG,IAAI,EAAE,YAAY,KAClB,IAAI,GACR,IAAI,CAAA;KACR,CAkFA;IAGD;;;OAGG;IACH,aAAa,aAAc;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,UAY5C;IAED,OAAO,CAAC,YAAY,CAKhB;IA+CJ,MAAM;;;MAGJ;IAEF,OAAO,CAAC,aAAa,CACoF;IAEzG,OAAO,CAAC,aAAa,CAkCpB;CACF"}