@livestore/livestore 0.0.0-snapshot-909cdd1ac2fd591945c2be2b0f53e14d87f3c9d4

package/dist/store.d.ts

@@ -0,0 +1,175 @@
+import type { Adapter, BootDb, BootStatus, ClientSession, EventId, ParamsObject } from '@livestore/common';
+import { UnexpectedError } from '@livestore/common';
+import type { LiveStoreSchema, MutationEvent } from '@livestore/common/schema';
+import { Effect, FiberSet, Inspectable, MutableHashMap, Runtime, Scope } from '@livestore/utils/effect';
+import * as otel from '@opentelemetry/api';
+import type { GraphQLSchema } from 'graphql';
+import type { DebugRefreshReasonBase, Ref } from './reactive.js';
+import type { LiveQuery, QueryContext, ReactivityGraph } from './reactiveQueries/base-class.js';
+import { SynchronousDatabaseWrapper } from './SynchronousDatabaseWrapper.js';
+import { ReferenceCountedSet } from './utils/data-structures.js';
+import type { StackInfo } from './utils/stack-info.js';
+export type BaseGraphQLContext = {
+    queriedTables: Set<string>;
+    /** Needed by Pothos Otel plugin for resolver tracing to work */
+    otelContext?: otel.Context;
+};
+export type GraphQLOptions<TContext> = {
+    schema: GraphQLSchema;
+    makeContext: (db: SynchronousDatabaseWrapper, tracer: otel.Tracer, sessionId: string) => TContext;
+};
+export type OtelOptions = {
+    tracer: otel.Tracer;
+    rootSpanContext: otel.Context;
+};
+export type StoreOptions<TGraphQLContext extends BaseGraphQLContext, TSchema extends LiveStoreSchema = LiveStoreSchema> = {
+    clientSession: ClientSession;
+    schema: TSchema;
+    storeId: string;
+    graphQLOptions?: GraphQLOptions<TGraphQLContext>;
+    otelOptions: OtelOptions;
+    reactivityGraph: ReactivityGraph;
+    disableDevtools?: boolean;
+    fiberSet: FiberSet.FiberSet;
+    runtime: Runtime.Runtime<Scope.Scope>;
+    batchUpdates: (runUpdates: () => void) => void;
+    currentMutationEventIdRef: {
+        current: EventId;
+    };
+    unsyncedMutationEvents: MutableHashMap.MutableHashMap<EventId, MutationEvent.ForSchema<TSchema>>;
+};
+export type RefreshReason = DebugRefreshReasonBase | {
+    _tag: 'mutate';
+    /** The mutations that were applied */
+    mutations: ReadonlyArray<MutationEvent.Any>;
+    /** The tables that were written to by the event */
+    writeTables: ReadonlyArray<string>;
+} | {
+    _tag: 'react';
+    api: string;
+    label?: string;
+    stackInfo?: StackInfo;
+} | {
+    _tag: 'manual';
+    label?: string;
+};
+export type QueryDebugInfo = {
+    _tag: 'graphql' | 'sql' | 'js' | 'unknown';
+    label: string;
+    query: string;
+    durationMs: number;
+};
+export type StoreOtel = {
+    tracer: otel.Tracer;
+    mutationsSpanContext: otel.Context;
+    queriesSpanContext: otel.Context;
+};
+export type StoreMutateOptions = {
+    label?: string;
+    skipRefresh?: boolean;
+    wasSyncMessage?: boolean;
+    /**
+     * When set to `false` the mutation won't be persisted in the mutation log and sync server (but still synced).
+     * This can be useful e.g. for fine-granular update events (e.g. position updates during drag & drop)
+     *
+     * @default true
+     */
+    persisted?: boolean;
+};
+export declare class Store<TGraphQLContext extends BaseGraphQLContext = BaseGraphQLContext, TSchema extends LiveStoreSchema = LiveStoreSchema> extends Inspectable.Class {
+    readonly storeId: string;
+    reactivityGraph: ReactivityGraph;
+    syncDbWrapper: SynchronousDatabaseWrapper;
+    clientSession: ClientSession;
+    schema: LiveStoreSchema;
+    graphQLSchema?: GraphQLSchema;
+    graphQLContext?: TGraphQLContext;
+    otel: StoreOtel;
+    /**
+     * Note we're using `Ref<null>` here as we don't care about the value but only about *that* something has changed.
+     * This only works in combination with `equal: () => false` which will always trigger a refresh.
+     */
+    tableRefs: {
+        [key: string]: Ref<null, QueryContext, 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"]>;
+    private currentMutationEventIdRef;
+    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>;
+    get sessionId(): string;
+    /**
+     * Subscribe to the results of a query
+     * Returns a function to cancel the subscription.
+     */
+    subscribe: <TResult>(query$: LiveQuery<TResult, any>, onNewValue: (value: TResult) => void, onUnsubsubscribe?: () => void, options?: {
+        label?: string;
+        otelContext?: otel.Context;
+        skipInitialRun?: boolean;
+    } | undefined) => (() => void);
+    mutate: {
+        <const TMutationArg extends ReadonlyArray<MutationEvent.PartialForSchema<TSchema>>>(...list: TMutationArg): void;
+        (txn: <const TMutationArg extends ReadonlyArray<MutationEvent.PartialForSchema<TSchema>>>(...list: TMutationArg) => void): void;
+        <const TMutationArg extends ReadonlyArray<MutationEvent.PartialForSchema<TSchema>>>(options: StoreMutateOptions, ...list: TMutationArg): void;
+        (options: StoreMutateOptions, txn: <const TMutationArg extends ReadonlyArray<MutationEvent.PartialForSchema<TSchema>>>(...list: TMutationArg) => void): void;
+    };
+    /**
+     * This can be used in combination with `skipRefresh` when applying mutations.
+     * We might need a better solution for this. Let's see.
+     */
+    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;
+    __select: (query: string, params?: ParamsObject) => readonly any[];
+    private makeTableRef;
+    __devDownloadDb: () => void;
+    __devDownloadMutationLogDb: () => import("effect/Fiber").RuntimeFiber<import("effect/Fiber").RuntimeFiber<void, UnexpectedError>, never>;
+    toJSON: () => {
+        _tag: string;
+        reactivityGraph: import("./reactive.js").ReactiveGraphSnapshot;
+    };
+    private runEffectFork;
+}
+export type CreateStoreOptions<TGraphQLContext extends BaseGraphQLContext, TSchema extends LiveStoreSchema> = {
+    schema: TSchema;
+    adapter: Adapter;
+    storeId: string;
+    reactivityGraph?: ReactivityGraph;
+    graphQLOptions?: GraphQLOptions<TGraphQLContext>;
+    otelOptions?: Partial<OtelOptions>;
+    boot?: (db: BootDb, parentSpan: otel.Span) => void | Promise<void> | Effect.Effect<void, unknown, otel.Tracer>;
+    batchUpdates?: (run: () => void) => void;
+    disableDevtools?: boolean;
+    onBootStatus?: (status: BootStatus) => void;
+};
+/** Create a new LiveStore Store */
+export declare const createStorePromise: <TGraphQLContext extends BaseGraphQLContext, TSchema extends LiveStoreSchema = LiveStoreSchema>({ signal, ...options }: CreateStoreOptions<TGraphQLContext, TSchema> & {
+    signal?: AbortSignal;
+}) => Promise<Store<TGraphQLContext, TSchema>>;
+export declare const createStore: <TGraphQLContext extends BaseGraphQLContext, TSchema extends LiveStoreSchema = LiveStoreSchema>({ schema, adapter, storeId, graphQLOptions, otelOptions, boot, reactivityGraph, batchUpdates, disableDevtools, onBootStatus, fiberSet, }: CreateStoreOptions<TGraphQLContext, TSchema> & {
+    fiberSet: FiberSet.FiberSet;
+}) => Effect.Effect<Store<TGraphQLContext, TSchema>, UnexpectedError, Scope.Scope>;
+//# sourceMappingURL=store.d.ts.map

package/dist/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,MAAM,EACN,UAAU,EACV,aAAa,EACb,OAAO,EAEP,YAAY,EAGb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAA8C,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAC/F,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAS9E,OAAO,EAKL,MAAM,EAEN,QAAQ,EACR,WAAW,EAIX,cAAc,EAGd,OAAO,EAEP,KAAK,EAEN,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAA;AAC1C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAG5C,OAAO,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAE/F,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAGhE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC1B,gEAAgE;IAChE,WAAW,CAAC,EAAE,IAAI,CAAC,OAAO,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,QAAQ,IAAI;IACrC,MAAM,EAAE,aAAa,CAAA;IACrB,WAAW,EAAE,CAAC,EAAE,EAAE,0BAA0B,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,QAAQ,CAAA;CAClG,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;IACnB,eAAe,EAAE,IAAI,CAAC,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,eAAe,SAAS,kBAAkB,EAC1C,OAAO,SAAS,eAAe,GAAG,eAAe,IAC/C;IACF,aAAa,EAAE,aAAa,CAAA;IAC5B,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IAEf,cAAc,CAAC,EAAE,cAAc,CAAC,eAAe,CAAC,CAAA;IAChD,WAAW,EAAE,WAAW,CAAA;IACxB,eAAe,EAAE,eAAe,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAA;IAC3B,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACrC,YAAY,EAAE,CAAC,UAAU,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;IAC9C,yBAAyB,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;IAC/C,sBAAsB,EAAE,cAAc,CAAC,cAAc,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;CACjG,CAAA;AAED,MAAM,MAAM,aAAa,GACrB,sBAAsB,GACtB;IACE,IAAI,EAAE,QAAQ,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;IAE3C,mDAAmD;IACnD,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CACnC,GACD;IAEE,IAAI,EAAE,OAAO,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,SAAS,CAAA;CACtB,GACD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtC,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,GAAG,KAAK,GAAG,IAAI,GAAG,SAAS,CAAA;IAC1C,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;IACnB,oBAAoB,EAAE,IAAI,CAAC,OAAO,CAAA;IAClC,kBAAkB,EAAE,IAAI,CAAC,OAAO,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAQD,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;IAE9B,OAAO,CAAC,yBAAyB,CAAA;IACjC,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;IAGH,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;IAED;;;OAGG;IACH,aAAa,aAAc;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,UAY5C;IAED;;;;;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,QAAQ,UAAW,MAAM,WAAU,YAAY,oBAE9C;IAED,OAAO,CAAC,YAAY,CAKhB;IAEJ,eAAe,aAGd;IAED,0BAA0B,+GAIG;IAG7B,MAAM;;;MAKL;IAED,OAAO,CAAC,aAAa,CAC8E;CACpG;AAED,MAAM,MAAM,kBAAkB,CAAC,eAAe,SAAS,kBAAkB,EAAE,OAAO,SAAS,eAAe,IAAI;IAC5G,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,cAAc,CAAC,EAAE,cAAc,CAAC,eAAe,CAAC,CAAA;IAChD,WAAW,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAClC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IAC9G,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;IACxC,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;CAC5C,CAAA;AAED,mCAAmC;AACnC,eAAO,MAAM,kBAAkB,GAC7B,eAAe,SAAS,kBAAkB,EAC1C,OAAO,SAAS,eAAe,4CAI9B,kBAAkB,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,KAAG,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,OAAO,CAAC,CAsBjH,CAAA;AAGH,eAAO,MAAM,WAAW,GACtB,eAAe,SAAS,kBAAkB,EAC1C,OAAO,SAAS,eAAe,8JAa9B,kBAAkB,CAAC,eAAe,EAAE,OAAO,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAA;CAAE,KAAG,MAAM,CAAC,MAAM,CAC/F,KAAK,CAAC,eAAe,EAAE,OAAO,CAAC,EAC/B,eAAe,EACf,KAAK,CAAC,KAAK,CA6LZ,CAAA"}