@livestore/solid 0.4.0-dev.22 → 0.4.0-dev.23

package/dist/StoreRegistryContext.d.ts

@@ -0,0 +1,56 @@
+import * as Solid from 'solid-js';
+import type { StoreRegistry } from '@livestore/livestore';
+export declare const StoreRegistryContext: Solid.Context<StoreRegistry | undefined>;
+export type StoreRegistryProviderProps = {
+    storeRegistry: StoreRegistry;
+    children: Solid.JSX.Element;
+};
+/**
+ * Solid context provider that makes a {@link StoreRegistry} available to descendant components.
+ *
+ * Wrap your application (or a subtree) with this provider to enable {@link useStore} and
+ * {@link useStoreRegistry} hooks within that tree.
+ *
+ * @example
+ * ```tsx
+ * import { StoreRegistry } from '@livestore/livestore'
+ * import { StoreRegistryProvider } from '@livestore/solid'
+ * import { batch } from 'solid-js'
+ *
+ * const storeRegistry = new StoreRegistry({
+ *   defaultOptions: { batchUpdates: batch }
+ * })
+ *
+ * function App() {
+ *   return (
+ *     <StoreRegistryProvider storeRegistry={storeRegistry}>
+ *       <MyComponent />
+ *     </StoreRegistryProvider>
+ *   )
+ * }
+ * ```
+ */
+export declare const StoreRegistryProvider: (props: StoreRegistryProviderProps) => Solid.JSX.Element;
+/**
+ * Hook to access the {@link StoreRegistry} from context. Useful for advanced operations like preloading.
+ *
+ * @param override - Optional registry to use instead of the context value.
+ *   When provided, skips context lookup entirely.
+ * @returns The registry provided by the nearest {@link StoreRegistryProvider} ancestor, or the `override` if provided.
+ * @throws Error if called outside a {@link StoreRegistryProvider} and no override is provided
+ *
+ * @example
+ * ```tsx
+ * function PreloadButton(props: { issueId: string }) {
+ *   const storeRegistry = useStoreRegistry()
+ *
+ *   const handleMouseEnter = () => {
+ *     storeRegistry.preload(issueStoreOptions(props.issueId))
+ *   }
+ *
+ *   return <button onMouseEnter={handleMouseEnter}>View Issue</button>
+ * }
+ * ```
+ */
+export declare const useStoreRegistry: (override?: StoreRegistry) => StoreRegistry;
+//# sourceMappingURL=StoreRegistryContext.d.ts.map

package/dist/StoreRegistryContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreRegistryContext.d.ts","sourceRoot":"","sources":["../src/StoreRegistryContext.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,UAAU,CAAA;AAEjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAEzD,eAAO,MAAM,oBAAoB,0CAA4D,CAAA;AAE7F,MAAM,MAAM,0BAA0B,GAAG;IACvC,aAAa,EAAE,aAAa,CAAA;IAC5B,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,qBAAqB,GAAI,OAAO,0BAA0B,KAAG,KAAK,CAAC,GAAG,CAAC,OAEnF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB,GAAI,WAAW,aAAa,KAAG,aAQ3D,CAAA"}

package/dist/StoreRegistryContext.jsx

@@ -0,0 +1,60 @@
+import * as Solid from 'solid-js';
+export const StoreRegistryContext = Solid.createContext(undefined);
+/**
+ * Solid context provider that makes a {@link StoreRegistry} available to descendant components.
+ *
+ * Wrap your application (or a subtree) with this provider to enable {@link useStore} and
+ * {@link useStoreRegistry} hooks within that tree.
+ *
+ * @example
+ * ```tsx
+ * import { StoreRegistry } from '@livestore/livestore'
+ * import { StoreRegistryProvider } from '@livestore/solid'
+ * import { batch } from 'solid-js'
+ *
+ * const storeRegistry = new StoreRegistry({
+ *   defaultOptions: { batchUpdates: batch }
+ * })
+ *
+ * function App() {
+ *   return (
+ *     <StoreRegistryProvider storeRegistry={storeRegistry}>
+ *       <MyComponent />
+ *     </StoreRegistryProvider>
+ *   )
+ * }
+ * ```
+ */
+export const StoreRegistryProvider = (props) => {
+    return <StoreRegistryContext.Provider value={props.storeRegistry}>{props.children}</StoreRegistryContext.Provider>;
+};
+/**
+ * Hook to access the {@link StoreRegistry} from context. Useful for advanced operations like preloading.
+ *
+ * @param override - Optional registry to use instead of the context value.
+ *   When provided, skips context lookup entirely.
+ * @returns The registry provided by the nearest {@link StoreRegistryProvider} ancestor, or the `override` if provided.
+ * @throws Error if called outside a {@link StoreRegistryProvider} and no override is provided
+ *
+ * @example
+ * ```tsx
+ * function PreloadButton(props: { issueId: string }) {
+ *   const storeRegistry = useStoreRegistry()
+ *
+ *   const handleMouseEnter = () => {
+ *     storeRegistry.preload(issueStoreOptions(props.issueId))
+ *   }
+ *
+ *   return <button onMouseEnter={handleMouseEnter}>View Issue</button>
+ * }
+ * ```
+ */
+export const useStoreRegistry = (override) => {
+    if (override !== undefined)
+        return override;
+    const storeRegistry = Solid.useContext(StoreRegistryContext);
+    if (storeRegistry == null)
+        throw new Error('useStoreRegistry() must be used within <StoreRegistryProvider>');
+    return storeRegistry;
+};
+//# sourceMappingURL=StoreRegistryContext.jsx.map

package/dist/StoreRegistryContext.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreRegistryContext.jsx","sourceRoot":"","sources":["../src/StoreRegistryContext.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,UAAU,CAAA;AAIjC,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,CAAC,aAAa,CAA4B,SAAS,CAAC,CAAA;AAO7F;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,KAAiC,EAAqB,EAAE;IAC5F,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AACpH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,QAAwB,EAAiB,EAAE;IAC1E,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAA;IAE3C,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAA;IAE5D,IAAI,aAAa,IAAI,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IAE5G,OAAO,aAAa,CAAA;AACtB,CAAC,CAAA"}

package/dist/__tests__/fixture.d.ts

@@ -0,0 +1,14 @@
+import type * as Solid from 'solid-js';
+import type { UnknownError } from '@livestore/common';
+import { type AppState, type CreateTodoMvcStoreOptions, events, type Filter, schema, type Todo, tables } from '@livestore/framework-toolkit/testing';
+import type { Store } from '@livestore/livestore';
+import { StoreInternalsSymbol } from '@livestore/livestore';
+import { Effect, type Scope } from '@livestore/utils/effect';
+import * as LiveStoreSolid from '../mod.ts';
+export { events, schema, StoreInternalsSymbol, tables };
+export type { AppState, Filter, Todo };
+export declare const makeTodoMvcSolid: (opts?: CreateTodoMvcStoreOptions) => Effect.Effect<{
+    wrapper: ({ children }: any) => Solid.JSX.Element;
+    store: Store<typeof schema> & LiveStoreSolid.SolidApi;
+}, UnknownError, Scope.Scope>;
+//# sourceMappingURL=fixture.d.ts.map

package/dist/__tests__/fixture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixture.d.ts","sourceRoot":"","sources":["../../src/__tests__/fixture.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,KAAK,MAAM,UAAU,CAAA;AAEtC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AACrD,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,yBAAyB,EAE9B,MAAM,EACN,KAAK,MAAM,EACX,MAAM,EACN,KAAK,IAAI,EACT,MAAM,EACP,MAAM,sCAAsC,CAAA;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAE5D,OAAO,KAAK,cAAc,MAAM,WAAW,CAAA;AAG3C,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAA;AACvD,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;AAEtC,eAAO,MAAM,gBAAgB,GAC3B,OAAM,yBAA8B,KACnC,MAAM,CAAC,MAAM,CACd;IACE,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACjD,KAAK,EAAE,KAAK,CAAC,OAAO,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAA;CACtD,EACD,YAAY,EACZ,KAAK,CAAC,KAAK,CAUT,CAAA"}

package/dist/__tests__/fixture.jsx

@@ -0,0 +1,13 @@
+import { createTodoMvcStore, events, schema, tables, } from '@livestore/framework-toolkit/testing';
+import { StoreInternalsSymbol } from '@livestore/livestore';
+import { Effect } from '@livestore/utils/effect';
+import * as LiveStoreSolid from "../mod.js";
+// Re-export shared types, schema, and StoreInternalsSymbol for tests
+export { events, schema, StoreInternalsSymbol, tables };
+export const makeTodoMvcSolid = (opts = {}) => Effect.gen(function* () {
+    const store = yield* createTodoMvcStore(opts);
+    const storeWithSolidApi = LiveStoreSolid.withSolidApi(store);
+    const wrapper = (props) => <>{props.children}</>;
+    return { wrapper, store: storeWithSolidApi };
+});
+//# sourceMappingURL=fixture.jsx.map

package/dist/__tests__/fixture.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixture.jsx","sourceRoot":"","sources":["../../src/__tests__/fixture.tsx"],"names":[],"mappings":"AAGA,OAAO,EAGL,kBAAkB,EAClB,MAAM,EAEN,MAAM,EAEN,MAAM,GACP,MAAM,sCAAsC,CAAA;AAE7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAc,MAAM,yBAAyB,CAAA;AAE5D,OAAO,KAAK,cAAc,MAAM,WAAW,CAAA;AAE3C,qEAAqE;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAA;AAGvD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,OAAkC,EAAE,EAQpC,EAAE,CACF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAA;IAE7C,MAAM,iBAAiB,GAAG,cAAc,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;IAE5D,MAAM,OAAO,GAAG,CAAC,KAAwB,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAA;IAEnE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAA;AAC9C,CAAC,CAAC,CAAA"}

package/dist/experimental/components/LiveList.d.ts

@@ -0,0 +1,24 @@
+import type { Accessor, JSX } from 'solid-js';
+import type { LiveQueryDef, Store } from '@livestore/livestore';
+export type LiveListProps<TItem> = {
+    items$: LiveQueryDef<ReadonlyArray<TItem>>;
+    renderItem: (item: Accessor<TItem>, index: Accessor<number>) => JSX.Element;
+    /** Needs to be unique across all list items */
+    getKey: (item: TItem, index: number) => string | number;
+    /** The store instance to use for queries */
+    store: Store<any, any>;
+};
+/**
+ * This component is a helper component for rendering a list of items for a LiveQuery of an array of items.
+ * The idea is that instead of letting Solid handle the rendering of the items array directly,
+ * we derive a item LiveQuery for each item which moves the reactivity to the item level when a single item changes.
+ *
+ * In the future we want to make this component even more efficient by using incremental rendering (https://github.com/livestorejs/livestore/pull/55)
+ * e.g. when an item is added/removed/moved to only re-render the affected DOM nodes.
+ */
+export declare const LiveList: <TItem>(props: LiveListProps<TItem>) => JSX.Element;
+export declare const ItemWrapper: <TItem>(props: {
+    key: string | number;
+    index: Accessor<number>;
+} & LiveListProps<TItem>) => JSX.Element;
+//# sourceMappingURL=LiveList.d.ts.map

package/dist/experimental/components/LiveList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveList.d.ts","sourceRoot":"","sources":["../../../src/experimental/components/LiveList.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAG7C,OAAO,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAW/D,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI;IACjC,MAAM,EAAE,YAAY,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;IAE1C,UAAU,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,OAAO,CAAA;IAC3E,+CAA+C;IAC/C,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAAA;IACvD,4CAA4C;IAC5C,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACvB,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,GAAI,KAAK,EAAG,OAAO,aAAa,CAAC,KAAK,CAAC,KAAG,GAAG,CAAC,OAOlE,CAAA;AAED,eAAO,MAAM,WAAW,GAAI,KAAK,EAC/B,OAAO;IAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;CAAE,GAAG,aAAa,CAAC,KAAK,CAAC,gBAWhF,CAAA"}

package/dist/experimental/components/LiveList.jsx

@@ -0,0 +1,24 @@
+import * as Solid from 'solid-js';
+import { computed } from '@livestore/livestore';
+import { useQuery } from "../../useQuery.js";
+/**
+ * This component is a helper component for rendering a list of items for a LiveQuery of an array of items.
+ * The idea is that instead of letting Solid handle the rendering of the items array directly,
+ * we derive a item LiveQuery for each item which moves the reactivity to the item level when a single item changes.
+ *
+ * In the future we want to make this component even more efficient by using incremental rendering (https://github.com/livestorejs/livestore/pull/55)
+ * e.g. when an item is added/removed/moved to only re-render the affected DOM nodes.
+ */
+export const LiveList = (props) => {
+    const [config] = Solid.splitProps(props, ['store']);
+    const keys = useQuery(() => computed((get) => get(props.items$).map((item, index) => props.getKey(item, index))), config);
+    return <Solid.For each={keys()}>{(key, index) => <ItemWrapper {...props} key={key} index={index}/>}</Solid.For>;
+};
+export const ItemWrapper = (props) => {
+    const [config] = Solid.splitProps(props, ['store']);
+    const item = useQuery(() => computed((get) => get(props.items$).find((item, index) => props.getKey(item, index) === props.key), {
+        deps: [props.key],
+    }), config);
+    return <>{props.renderItem(item, props.index)}</>;
+};
+//# sourceMappingURL=LiveList.jsx.map

package/dist/experimental/components/LiveList.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"LiveList.jsx","sourceRoot":"","sources":["../../../src/experimental/components/LiveList.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,KAAK,MAAM,UAAU,CAAA;AAGjC,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAE/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAkB5C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAS,KAA2B,EAAe,EAAE;IAC3E,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA;IACnD,MAAM,IAAI,GAAG,QAAQ,CACnB,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAC1F,MAAM,CACP,CAAA;IACD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;AAClH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,KAA+E,EAC/E,EAAE;IACF,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA;IACnD,MAAM,IAAI,GAAG,QAAQ,CACnB,GAAG,EAAE,CACH,QAAQ,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,KAAK,CAAC,GAAG,CAAE,EAAE;QACnG,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC;KAClB,CAAC,EACJ,MAAM,CACP,CAAA;IACD,OAAO,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAA;AACnD,CAAC,CAAA"}

package/dist/experimental/mod.d.ts

@@ -0,0 +1,2 @@
+export { LiveList, type LiveListProps } from './components/LiveList.tsx';
+//# sourceMappingURL=mod.d.ts.map

package/dist/experimental/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/experimental/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,2BAA2B,CAAA"}

package/dist/experimental/mod.js

@@ -0,0 +1,2 @@
+export { LiveList } from "./components/LiveList.jsx";
+//# sourceMappingURL=mod.js.map

package/dist/experimental/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../src/experimental/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAsB,MAAM,2BAA2B,CAAA"}

package/dist/mod.d.ts

@@ -1,3 +1,7 @@
-export { query } from './query.ts';
-export { getStore } from './store.ts';
+export type { Dispatch, SetStateAction, SetStateActionPartial, StateSetters } from '@livestore/framework-toolkit';
+export { StoreRegistry, storeOptions } from '@livestore/livestore';
+export { LiveList, type LiveListProps } from './experimental/components/LiveList.tsx';
+export * from './StoreRegistryContext.tsx';
+export type { UseClientDocumentResult } from './useClientDocument.ts';
+export { type SolidApi, useStore, withSolidApi } from './useStore.ts';
 //# sourceMappingURL=mod.d.ts.map

package/dist/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AACjH,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,wCAAwC,CAAA;AACrF,cAAc,4BAA4B,CAAA;AAC1C,YAAY,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAA;AACrE,OAAO,EAAE,KAAK,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA"}

package/dist/mod.js

@@ -1,3 +1,5 @@
-export { query } from "./query.js";
-export { getStore } from "./store.js";
+export { StoreRegistry, storeOptions } from '@livestore/livestore';
+export { LiveList } from "./experimental/components/LiveList.jsx";
+export * from "./StoreRegistryContext.jsx";
+export { useStore, withSolidApi } from "./useStore.js";
 //# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -1 +1 @@
-{"version":3,"file":"mod.js","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,EAAE,QAAQ,EAAsB,MAAM,wCAAwC,CAAA;AACrF,cAAc,4BAA4B,CAAA;AAE1C,OAAO,EAAiB,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA"}

package/dist/useClientDocument.client.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useClientDocument.client.test.d.ts.map

package/dist/useClientDocument.client.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClientDocument.client.test.d.ts","sourceRoot":"","sources":["../src/useClientDocument.client.test.tsx"],"names":[],"mappings":""}

package/dist/useClientDocument.client.test.jsx

@@ -0,0 +1,177 @@
+/** biome-ignore-all lint/a11y/useValidAriaRole: not needed for testing */
+/** biome-ignore-all lint/a11y/noStaticElementInteractions: not needed for testing */
+import * as LiveStore from '@livestore/livestore';
+import { getAllSimplifiedRootSpans, getSimplifiedRootSpan } from '@livestore/livestore/internal/testing-utils';
+import { Effect, ReadonlyRecord, Schema } from '@livestore/utils/effect';
+import { Vitest } from '@livestore/utils-dev/node-vitest';
+import * as otel from '@opentelemetry/api';
+import { BasicTracerProvider, InMemorySpanExporter, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import * as SolidTesting from '@solidjs/testing-library';
+import * as Solid from 'solid-js';
+import { events, makeTodoMvcSolid, StoreInternalsSymbol, tables } from "./__tests__/fixture.jsx";
+// const strictMode = process.env.REACT_STRICT_MODE !== undefined
+// NOTE running tests concurrently doesn't work with the default global db graph
+Vitest.describe('useClientDocument', () => {
+    Vitest.scopedLive('should update the data based on component key', () => Effect.gen(function* () {
+        const { wrapper, store } = yield* makeTodoMvcSolid({});
+        const [userId, setUserId] = Solid.createSignal('u1');
+        const { result } = SolidTesting.renderHook(() => {
+            const [state, setState, id] = store.useClientDocument(tables.userInfo, userId);
+            return { state, setState, id };
+        }, { wrapper });
+        Vitest.expect(result.id()).toBe('u1');
+        Vitest.expect(result.state().username).toBe('');
+        Vitest.expect(store[StoreInternalsSymbol].reactivityGraph.getSnapshot({ includeResults: true })).toMatchSnapshot();
+        store.commit(tables.userInfo.set({ username: 'username_u2' }, 'u2'));
+        setUserId('u2');
+        Vitest.expect(store[StoreInternalsSymbol].reactivityGraph.getSnapshot({ includeResults: true })).toMatchSnapshot();
+        Vitest.expect(result.id()).toBe('u2');
+        Vitest.expect(result.state().username).toBe('username_u2');
+    }));
+    // TODO add a test that makes sure Solid doesn't re-render when a setter is used to set the same value
+    Vitest.scopedLive('should update the data reactively - via setState', () => Effect.gen(function* () {
+        const { wrapper, store } = yield* makeTodoMvcSolid({});
+        const { result } = SolidTesting.renderHook(() => {
+            const [state, setState, id] = store.useClientDocument(tables.userInfo, 'u1');
+            return { state, setState, id };
+        }, { wrapper });
+        Vitest.expect(result.id()).toBe('u1');
+        Vitest.expect(result.state().username).toBe('');
+        result.setState({ username: 'username_u1_hello' });
+        Vitest.expect(result.id()).toBe('u1');
+        Vitest.expect(result.state().username).toBe('username_u1_hello');
+    }));
+    Vitest.scopedLive('should update the data reactively - via raw store commit', () => Effect.gen(function* () {
+        const { wrapper, store } = yield* makeTodoMvcSolid({});
+        const { result } = SolidTesting.renderHook(() => {
+            const [state, setState, id] = store.useClientDocument(tables.userInfo, 'u1');
+            return { state, setState, id };
+        }, { wrapper });
+        Vitest.expect(result.id()).toBe('u1');
+        Vitest.expect(result.state().username).toBe('');
+        store.commit(events.UserInfoSet({ username: 'username_u1_hello' }, 'u1'));
+        Vitest.expect(result.id()).toBe('u1');
+        Vitest.expect(result.state().username).toBe('username_u1_hello');
+    }));
+    Vitest.scopedLive('should work for a larger app', () => Effect.gen(function* () {
+        const { wrapper, store } = yield* makeTodoMvcSolid({});
+        const allTodos$ = LiveStore.queryDb({ query: `select * from todos`, schema: Schema.Array(tables.todos.rowSchema) }, { label: 'allTodos' });
+        let globalSetState;
+        const AppRouter = () => {
+            const [state, setState] = store.useClientDocument(() => tables.AppRouterSchema, () => 'singleton');
+            globalSetState = setState;
+            return (<div>
+            <TasksList />
+            <div role={'current-id'}>Current Task Id: {state().currentTaskId ?? '-'}</div>
+            <Solid.Show when={state().currentTaskId} fallback={'Click on a task to see details'}>
+              {(id) => <TaskDetails id={id()}/>}
+            </Solid.Show>
+          </div>);
+        };
+        const TasksList = () => {
+            const allTodos = store.useQuery(() => allTodos$);
+            return (<div>
+            <Solid.For each={allTodos()}>{(todo) => <div>{todo.id}</div>}</Solid.For>
+          </div>);
+        };
+        const TaskDetails = (props) => {
+            const todo = store.useQuery(() => LiveStore.queryDb(tables.todos.where({ id: props.id }).first(), { deps: props.id }));
+            return <div role={'content'}>{JSON.stringify(todo())}</div>;
+        };
+        const { getByRole } = SolidTesting.render(() => <AppRouter />, { wrapper });
+        store.commit(events.todoCreated({ id: 't1', text: 'buy milk', completed: false }));
+        Vitest.expect(getByRole('current-id').innerHTML).toMatchInlineSnapshot('"Current Task Id: -"');
+        globalSetState({ currentTaskId: 't1' });
+        Vitest.expect(getByRole('content').innerHTML).toMatchInlineSnapshot(`"{"id":"t1","text":"buy milk","completed":false}"`);
+        Vitest.expect(getByRole('current-id').innerHTML).toMatchInlineSnapshot('"Current Task Id: t1"');
+        store.commit(events.todoCreated({ id: 't2', text: 'buy eggs', completed: false }), events.AppRouterSet({ currentTaskId: 't2' }), events.todoCreated({ id: 't3', text: 'buy bread', completed: false }));
+        Vitest.expect(getByRole('current-id').innerHTML).toMatchInlineSnapshot('"Current Task Id: t2"');
+    }));
+    Vitest.scopedLive('should work for a useClientDocument query chained with a useTemporary query', () => Effect.gen(function* () {
+        const { store, wrapper } = yield* makeTodoMvcSolid({});
+        store.commit(events.todoCreated({ id: 't1', text: 'buy milk', completed: false }), events.todoCreated({ id: 't2', text: 'buy bread', completed: false }));
+        const [userId, setUserId] = Solid.createSignal('u1');
+        const { result } = SolidTesting.renderHook(() => {
+            const [_row, _setRow, _id, rowState$] = store.useClientDocument(tables.userInfo, userId);
+            const todos = store.useQuery(() => LiveStore.queryDb((get) => tables.todos.where('text', 'LIKE', `%${get(rowState$()).text}%`), 
+            // TODO find a way where explicit `userId` is not needed here
+            // possibly by automatically understanding the `get(rowState$)` dependency
+            { label: 'todosFiltered', deps: userId() }));
+            return { todos };
+        }, { wrapper });
+        Vitest.expect(result.todos()?.length).toBe(2);
+        // Set text filter for u2 and test with second user
+        store.commit(events.UserInfoSet({ username: 'username_u2', text: 'milk' }, 'u2'));
+        setUserId('u2');
+        Vitest.expect(result.todos()?.length).toBe(1);
+    }));
+    Vitest.scopedLive('kv client document overwrites value (Schema.Any, no partial merge)', () => Effect.gen(function* () {
+        const { wrapper, store } = yield* makeTodoMvcSolid({});
+        const { result } = SolidTesting.renderHook(() => {
+            const [state, setState] = store.useClientDocument(tables.kv, 'k1');
+            return { state, setState };
+        }, { wrapper });
+        Vitest.expect(result.state()).toBe(null);
+        result.setState(1);
+        Vitest.expect(result.state()).toEqual(1);
+        result.setState({ b: 2 });
+        Vitest.expect(result.state()).toEqual({ b: 2 });
+    }));
+    Vitest.describe('otel', () => {
+        Vitest.it('should update the data based on component key', async () => {
+            const exporter = new InMemorySpanExporter();
+            const provider = new BasicTracerProvider({
+                spanProcessors: [new SimpleSpanProcessor(exporter)],
+            });
+            const otelTracer = provider.getTracer(`testing-solid`);
+            const span = otelTracer.startSpan('test-root');
+            const otelContext = otel.trace.setSpan(otel.context.active(), span);
+            await Effect.gen(function* () {
+                const { wrapper, store } = yield* makeTodoMvcSolid({
+                    otelContext,
+                    otelTracer,
+                });
+                const [userId, setUserId] = Solid.createSignal('u1');
+                // Test with first user
+                const { result } = SolidTesting.renderHook(() => {
+                    const [state, setState, id] = store.useClientDocument(tables.userInfo, userId);
+                    return { state, setState, id };
+                }, { wrapper });
+                Vitest.expect(result.id()).toBe('u1');
+                Vitest.expect(result.state().username).toBe('');
+                // For u2 we'll make sure that the row already exists,
+                // so the lazy `insert` will be skipped
+                store.commit(events.UserInfoSet({ username: 'username_u2' }, 'u2'));
+                // Test with second user (new hook instance)
+                setUserId('u2');
+                Vitest.expect(result.id()).toBe('u2');
+                Vitest.expect(result.state().username).toBe('username_u2');
+                span.end();
+            }).pipe(Effect.scoped, Effect.tapCauseLogPretty, Effect.runPromise);
+            await provider.forceFlush();
+            const mapAttributes = (attributes) => {
+                return ReadonlyRecord.map(attributes, (val, key) => {
+                    if (key === 'code.stacktrace') {
+                        return '<STACKTRACE>';
+                    }
+                    else if (key === 'firstStackInfo') {
+                        const stackInfo = JSON.parse(val);
+                        // stackInfo.frames.shift() // Removes `renderHook.wrapper` from the stack
+                        stackInfo.frames.forEach((_) => {
+                            if (_.name.includes('renderHook.wrapper') === true) {
+                                _.name = 'renderHook.wrapper';
+                            }
+                            _.filePath = '__REPLACED_FOR_SNAPSHOT__';
+                        });
+                        return JSON.stringify(stackInfo);
+                    }
+                    return val;
+                });
+            };
+            Vitest.expect(getSimplifiedRootSpan(exporter, 'createStore', mapAttributes)).toMatchSnapshot();
+            Vitest.expect(getAllSimplifiedRootSpans(exporter, 'LiveStore:commit', mapAttributes)).toMatchSnapshot();
+            await provider.shutdown();
+        });
+    });
+});
+//# sourceMappingURL=useClientDocument.client.test.jsx.map

package/dist/useClientDocument.client.test.jsx.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClientDocument.client.test.jsx","sourceRoot":"","sources":["../src/useClientDocument.client.test.tsx"],"names":[],"mappings":"AAAA,0EAA0E;AAC1E,qFAAqF;AACrF,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAA;AAC9G,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAA;AACzD,OAAO,KAAK,IAAI,MAAM,oBAAoB,CAAA;AAC1C,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AAC9G,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAA;AACxD,OAAO,KAAK,KAAK,MAAM,UAAU,CAAA;AAEjC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAGhG,iEAAiE;AAEjE,gFAAgF;AAChF,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACxC,MAAM,CAAC,UAAU,CAAC,+CAA+C,EAAE,GAAG,EAAE,CACtE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAEtD,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAEpD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CACxC,GAAG,EAAE;YACH,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC9E,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QAChC,CAAC,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC/C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAClH,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;QAEpE,SAAS,CAAC,IAAI,CAAC,CAAA;QAEf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAClH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;IAC5D,CAAC,CAAC,CACH,CAAA;IAED,sGAAsG;IAEtG,MAAM,CAAC,UAAU,CAAC,kDAAkD,EAAE,GAAG,EAAE,CACzE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAEtD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CACxC,GAAG,EAAE;YACH,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC5E,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QAChC,CAAC,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAE/C,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,CAAC,CAAA;QAElD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;IAClE,CAAC,CAAC,CACH,CAAA;IAED,MAAM,CAAC,UAAU,CAAC,0DAA0D,EAAE,GAAG,EAAE,CACjF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAEtD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CACxC,GAAG,EAAE;YACH,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC5E,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QAChC,CAAC,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAE/C,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;QAEzE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;IAClE,CAAC,CAAC,CACH,CAAA;IAED,MAAM,CAAC,UAAU,CAAC,8BAA8B,EAAE,GAAG,EAAE,CACrD,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAEtD,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CACjC,EAAE,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,EAC9E,EAAE,KAAK,EAAE,UAAU,EAAE,CACtB,CAAA;QAED,IAAI,cAAsF,CAAA;QAC1F,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAC/C,GAAG,EAAE,CAAC,MAAM,CAAC,eAAe,EAC5B,GAAG,EAAE,CAAC,WAAW,CAClB,CAAA;YAED,cAAc,GAAG,QAAQ,CAAA;YAEzB,OAAO,CACL,CAAC,GAAG,CACF;YAAA,CAAC,SAAS,CAAC,AAAD,EACV;YAAA,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,YAAmB,CAAC,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC,aAAa,IAAI,GAAG,CAAC,EAAE,GAAG,CACpF;YAAA,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,CAAC,gCAAgC,CAAC,CAClF;cAAA,CAAC,CAAC,EAA0B,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAG,CAC5D;YAAA,EAAE,KAAK,CAAC,IAAI,CACd;UAAA,EAAE,GAAG,CAAC,CACP,CAAA;QACH,CAAC,CAAA;QAED,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAA;YAEhD,OAAO,CACL,CAAC,GAAG,CACF;YAAA,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAC1E;UAAA,EAAE,GAAG,CAAC,CACP,CAAA;QACH,CAAC,CAAA;QAED,MAAM,WAAW,GAAG,CAAC,KAAqB,EAAE,EAAE;YAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAC/B,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CACpF,CAAA;YAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,SAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;QACpE,CAAC,CAAA;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,AAAD,EAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;QAE3E,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAElF,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAA;QAE9F,cAAe,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;QAExC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,qBAAqB,CACjE,mDAAmD,CACpD,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAA;QAE/F,KAAK,CAAC,MAAM,CACV,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EACpE,MAAM,CAAC,YAAY,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAC5C,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CACtE,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,uBAAuB,CAAC,CAAA;IACjG,CAAC,CAAC,CACH,CAAA;IAED,MAAM,CAAC,UAAU,CAAC,6EAA6E,EAAE,GAAG,EAAE,CACpG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAEtD,KAAK,CAAC,MAAM,CACV,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EACpE,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CACtE,CAAA;QAED,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAEpD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CACxC,GAAG,EAAE;YACH,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YACxF,MAAM,KAAK,GAAG,KAAK,CAAC,QAAQ,CAC1B,GAAG,EAAE,CACH,SAAS,CAAC,OAAO,CACf,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC;YACzE,6DAA6D;YAC7D,0EAA0E;YAC1E,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAC3C,CAEJ,CAAA;YAED,OAAO,EAAE,KAAK,EAAE,CAAA;QAClB,CAAC,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAE7C,mDAAmD;QACnD,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;QAEjF,SAAS,CAAC,IAAI,CAAC,CAAA;QAEf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC/C,CAAC,CAAC,CACH,CAAA;IAED,MAAM,CAAC,UAAU,CAAC,oEAAoE,EAAE,GAAG,EAAE,CAC3F,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAEtD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CACxC,GAAG,EAAE;YACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;YAClE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAA;QAC5B,CAAC,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;QAED,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAExC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAClB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAExC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;QACzB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;IACjD,CAAC,CAAC,CACH,CAAA;IAED,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QAC3B,MAAM,CAAC,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAA;YAE3C,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CAAC;gBACvC,cAAc,EAAE,CAAC,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAC;aACpD,CAAC,CAAA;YAEF,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,eAAe,CAAC,CAAA;YAEtD,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;YAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,CAAA;YAEnE,MAAM,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;gBACxB,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,gBAAgB,CAAC;oBACjD,WAAW;oBACX,UAAU;iBACX,CAAC,CAAA;gBAEF,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;gBAEpD,uBAAuB;gBACvB,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,UAAU,CACxC,GAAG,EAAE;oBACH,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;oBAC9E,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;gBAChC,CAAC,EACD,EAAE,OAAO,EAAE,CACZ,CAAA;gBAED,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAE/C,sDAAsD;gBACtD,uCAAuC;gBACvC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;gBAEnE,4CAA4C;gBAC5C,SAAS,CAAC,IAAI,CAAC,CAAA;gBAEf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACrC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;gBAE1D,IAAI,CAAC,GAAG,EAAE,CAAA;YACZ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA;YAEnE,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAA;YAE3B,MAAM,aAAa,GAAG,CAAC,UAA2B,EAAE,EAAE;gBACpD,OAAO,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;oBACjD,IAAI,GAAG,KAAK,iBAAiB,EAAE,CAAC;wBAC9B,OAAO,cAAc,CAAA;oBACvB,CAAC;yBAAM,IAAI,GAAG,KAAK,gBAAgB,EAAE,CAAC;wBACpC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAa,CAAwB,CAAA;wBAClE,0EAA0E;wBAC1E,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;4BAC7B,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,KAAK,IAAI,EAAE,CAAC;gCACnD,CAAC,CAAC,IAAI,GAAG,oBAAoB,CAAA;4BAC/B,CAAC;4BACD,CAAC,CAAC,QAAQ,GAAG,2BAA2B,CAAA;wBAC1C,CAAC,CAAC,CAAA;wBACF,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;oBAClC,CAAC;oBACD,OAAO,GAAG,CAAA;gBACZ,CAAC,CAAC,CAAA;YACJ,CAAC,CAAA;YAED,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;YAC9F,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,aAAa,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;YAEvG,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAA;QAC3B,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/useClientDocument.d.ts

@@ -0,0 +1,71 @@
+import * as Solid from 'solid-js';
+import type { RowQuery } from '@livestore/common';
+import { SessionIdSymbol } from '@livestore/common';
+import { State } from '@livestore/common/schema';
+import { type StateSetters } from '@livestore/framework-toolkit';
+import type { LiveQuery, Store } from '@livestore/livestore';
+import { type AccessorMaybe } from './utils.ts';
+export type UseClientDocumentResult<TTableDef extends State.SQLite.ClientDocumentTableDef.TraitAny> = [
+    row: Solid.Accessor<TTableDef['Value']>,
+    setRow: StateSetters<TTableDef>,
+    id: Solid.Accessor<string>,
+    query$: Solid.Accessor<LiveQuery<TTableDef['Value']>>
+];
+/**
+ * Type for useClientDocument that enforces id requirement based on table definition.
+ * If table has a default id → id parameter is optional.
+ * If table has no default id → id parameter is required.
+ */
+export interface UseClientDocument {
+    <TTableDef extends State.SQLite.ClientDocumentTableDef.Trait<any, any, any, {
+        partialSet: boolean;
+        default: {
+            id: string | SessionIdSymbol;
+            value: any;
+        };
+    }>>(table: AccessorMaybe<TTableDef>, id: AccessorMaybe<State.SQLite.ClientDocumentTableDef.DefaultIdType<TTableDef> | SessionIdSymbol> | undefined, options: Partial<RowQuery.GetOrCreateOptions<TTableDef>> | undefined, config: {
+        store: Store<any, any>;
+    }): UseClientDocumentResult<TTableDef>;
+    <TTableDef extends State.SQLite.ClientDocumentTableDef.Trait<any, any, any, {
+        partialSet: boolean;
+        default: {
+            id: undefined;
+            value: any;
+        };
+    }>>(table: AccessorMaybe<TTableDef>, id: AccessorMaybe<string | SessionIdSymbol>, options: Partial<RowQuery.GetOrCreateOptions<TTableDef>> | undefined, config: {
+        store: Store<any, any>;
+    }): UseClientDocumentResult<TTableDef>;
+}
+/**
+ * Similar to `Solid.createSignal` but returns a tuple of `[state, setState, id, query$]` for a given table where ...
+ *
+ *   - `state` is the current value of the row (fully decoded according to the table schema)
+ *   - `setState` is a function that can be used to update the document
+ *   - `id` is the id of the document
+ *   - `query$` is a `LiveQuery` that e.g. can be used to subscribe to changes to the document
+ *
+ * `useClientDocument` only works for client-document tables:
+ *
+ * ```tsx
+ * const MyState = State.SQLite.clientDocument({
+ *   name: 'MyState',
+ *   schema: Schema.Struct({
+ *     showSidebar: Schema.Boolean,
+ *   }),
+ *   default: { id: SessionIdSymbol, value: { showSidebar: true } },
+ * })
+ *
+ * const MyComponent = () => {
+ *   const [{ showSidebar }, setState] = useClientDocument(MyState)
+ *   return (
+ *     <div onClick={() => setState({ showSidebar: !showSidebar })}>
+ *       {showSidebar ? 'Sidebar is open' : 'Sidebar is closed'}
+ *     </div>
+ *   )
+ * }
+ * ```
+ *
+ * If the table has a default id, `useClientDocument` can be called without an `id` argument. Otherwise, the `id` argument is required.
+ */
+export declare const useClientDocument: UseClientDocument;
+//# sourceMappingURL=useClientDocument.d.ts.map

package/dist/useClientDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClientDocument.d.ts","sourceRoot":"","sources":["../src/useClientDocument.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,UAAU,CAAA;AAEjC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAA;AAChD,OAAO,EAAyB,KAAK,YAAY,EAAwB,MAAM,8BAA8B,CAAA;AAC7G,OAAO,KAAK,EAAE,SAAS,EAAgB,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAI1E,OAAO,EAAE,KAAK,aAAa,EAAW,MAAM,YAAY,CAAA;AAExD,MAAM,MAAM,uBAAuB,CAAC,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,QAAQ,IAAI;IACpG,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC;IAC/B,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC1B,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;CACtD,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAEhC,CACE,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAK,CACzD,GAAG,EACH,GAAG,EACH,GAAG,EACH;QACE,UAAU,EAAE,OAAO,CAAA;QACnB,OAAO,EAAE;YAAE,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC;YAAC,KAAK,EAAE,GAAG,CAAA;SAAE,CAAA;KACtD,CACF,EAED,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,EAC/B,EAAE,EAAE,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,GAAG,SAAS,EAC7G,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,EACpE,MAAM,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;KAAE,GACjC,uBAAuB,CAAC,SAAS,CAAC,CAAA;IAGrC,CACE,SAAS,SAAS,KAAK,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAK,CACzD,GAAG,EACH,GAAG,EACH,GAAG,EACH;QAAE,UAAU,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE;YAAE,EAAE,EAAE,SAAS,CAAC;YAAC,KAAK,EAAE,GAAG,CAAA;SAAE,CAAA;KAAE,CAChE,EAED,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,EAC/B,EAAE,EAAE,aAAa,CAAC,MAAM,GAAG,eAAe,CAAC,EAC3C,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,EACpE,MAAM,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;KAAE,GACjC,uBAAuB,CAAC,SAAS,CAAC,CAAA;CACtC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,iBAAiB,EAAE,iBAuD/B,CAAA"}