syncorejs 0.2.2 → 0.2.4

package/dist/_vendor/svelte/index.d.ts

@@ -19,42 +19,242 @@ type PaginatedQueryArgs<TReference extends FunctionReference<"query">> = Functio
 } ? Omit<FunctionArgs<TReference>, "paginationOpts"> : never;
 type PaginatedQueryItem<TReference extends FunctionReference<"query">> = FunctionResult<TReference> extends PaginationResult<infer TItem> ? TItem : never;
 /**
- * The reactive query state shape exposed by Syncore's Svelte stores.
+ * The reactive query state shape emitted by Syncore's Svelte store factories.
+ *
+ * Extends SyncoreQueryState with the same fields (`data`, `error`,
+ * `status`, `runtimeStatus`, `isLoading`, `isError`, `isReady`). Returned as
+ * the value of stores created by {@link createQueryStore} and
+ * {@link createClientQueryStore}.
  */
 interface SyncoreQueryStoreState<TResult> extends SyncoreQueryState<TResult> {}
+/**
+ * A sentinel value that tells Syncore store factories to skip the query.
+ *
+ * Use `skip` in place of a query’s `args` argument to avoid firing the query
+ * while some required data is not yet available (e.g. a user ID that loads
+ * asynchronously). The store will remain in a `"loading"` / skipped state
+ * until a non-skip value is provided.
+ *
+ * ```svelte
+ * <script>
+ *   import { createQueryValueStore, skip } from "syncorejs/svelte";
+ *   import { api } from "../syncore/_generated/api";
+ *
+ *   export let userId: string | undefined;
+ *
+ *   $: profile = createQueryValueStore(
+ *     api.users.get,
+ *     userId ? { id: userId } : skip
+ *   );
+ * </script>
+ * ```
+ */
 declare const skip: "skip";
 type Skip = typeof skip;
 /**
- * Stores a Syncore client in Svelte component context and returns it.
+ * Store the Syncore client in Svelte’s component context.
+ *
+ * Call this once at the root of your component tree (e.g. in a layout or
+ * root `+layout.svelte`) so that the context-aware store factories
+ * (`createQueryStore`, `createQueriesStore`, etc.) can retrieve it
+ * automatically without prop-drilling.
+ *
+ * ```svelte
+ * <!-- +layout.svelte -->
+ * <script>
+ *   import { setSyncoreClient } from "syncorejs/svelte";
+ *   export let data; // { client } from +layout.ts
+ *   setSyncoreClient(data.client);
+ * </script>
+ * <slot />
+ * ```
+ *
+ * @param client - The ready Syncore client to store in context.
+ * @returns The same `client` for convenience.
  */
 declare function setSyncoreClient(client: SyncoreClient): SyncoreClient;
 /**
- * Reads the Syncore client previously stored in Svelte component context.
+ * Retrieve the Syncore client from Svelte’s component context.
+ *
+ * Throws if {@link setSyncoreClient} has not been called by an ancestor
+ * component. Only use this inside Svelte components; for standalone scripts
+ * keep an explicit reference to the client instead.
+ *
+ * @throws `Error` when no client is found in the component context.
  */
 declare function getSyncoreClient(): SyncoreClient;
+/**
+ * Create a reactive Svelte store that tracks the Syncore runtime status.
+ *
+ * Uses the client from Svelte context (set via {@link setSyncoreClient}).
+ * Subscribe to gate your UI on `"ready"` before rendering data-dependent
+ * components.
+ *
+ * ```svelte
+ * <script>
+ *   import { createSyncoreStatusStore } from "syncorejs/svelte";
+ *   const status = createSyncoreStatusStore();
+ * </script>
+ *
+ * {#if $status.kind === "ready"}
+ *   <App />
+ * {:else}
+ *   <Loading />
+ * {/if}
+ * ```
+ */
 declare function createSyncoreStatusStore(): Readable<SyncoreRuntimeStatus>;
+/**
+ * Create a reactive Svelte store that tracks the Syncore runtime status.
+ *
+ * Accepts an explicit `client` rather than reading from Svelte context,
+ * making it usable outside component trees (e.g. in module-level code or
+ * SvelteKit `load` functions).
+ *
+ * @param client - The Syncore client to observe.
+ */
 declare function createClientSyncoreStatusStore(client: SyncoreClient): Readable<SyncoreRuntimeStatus>;
 /**
- * Creates a reactive store for a Syncore query result using the contextual client.
+ * Create a reactive Svelte store that emits the current value of a Syncore
+ * query, or `undefined` while loading.
+ *
+ * Uses the client from Svelte context (set via {@link setSyncoreClient}).
+ * Pass `skip` as `args` to pause the query.
+ *
+ * ```svelte
+ * <script>
+ *   import { createQueryValueStore } from "syncorejs/svelte";
+ *   import { api } from "../syncore/_generated/api";
+ *
+ *   const todos = createQueryValueStore(api.todos.list);
+ * </script>
+ *
+ * {#each $todos ?? [] as todo}
+ *   <p>{todo.text}</p>
+ * {/each}
+ * ```
  */
 declare function createQueryValueStore<TReference extends FunctionReference<"query">>(reference: TReference, ...args: OptionalArgsTuple<FunctionArgs<TReference>> | [Skip]): Readable<FunctionResult<TReference> | undefined>;
 /**
- * Creates a reactive store for a Syncore query result using an explicit client.
+ * Create a reactive Svelte store that emits the current value of a Syncore
+ * query, or `undefined` while loading.
+ *
+ * Accepts an explicit `client` instead of reading from Svelte context.
+ *
+ * @param client - The Syncore client to query against.
  */
 declare function createClientQueryValueStore<TReference extends FunctionReference<"query">>(client: SyncoreClient, reference: TReference, ...args: OptionalArgsTuple<FunctionArgs<TReference>> | [Skip]): Readable<FunctionResult<TReference> | undefined>;
 /**
- * Creates a reactive store with the full Syncore query state.
+ * Create a reactive Svelte store that emits the full SyncoreQueryState
+ * for a query, including `data`, `error`, `status`, and `isPending`.
+ *
+ * Uses the client from Svelte context (set via {@link setSyncoreClient}).
+ *
+ * ```svelte
+ * <script>
+ *   import { createQueryStore } from "syncorejs/svelte";
+ *   import { api } from "../syncore/_generated/api";
+ *
+ *   const state = createQueryStore(api.todos.list);
+ * </script>
+ *
+ * {#if $state.isPending}
+ *   <Spinner />
+ * {:else if $state.error}
+ *   <Error message={$state.error.message} />
+ * {:else}
+ *   {#each $state.data as todo}<p>{todo.text}</p>{/each}
+ * {/if}
+ * ```
  */
 declare function createQueryStore<TReference extends FunctionReference<"query">>(reference: TReference, ...args: OptionalArgsTuple<FunctionArgs<TReference>> | [Skip]): Readable<SyncoreQueryStoreState<FunctionResult<TReference>>>;
 /**
- * Creates a reactive store with the full Syncore query state for an explicit client.
+ * Create a reactive Svelte store that emits the full SyncoreQueryState
+ * for a query, including `data`, `error`, `status`, and `isPending`.
+ *
+ * Accepts an explicit `client` instead of reading from Svelte context.
+ *
+ * @param client - The Syncore client to query against.
  */
 declare function createClientQueryStore<TReference extends FunctionReference<"query">>(client: SyncoreClient, reference: TReference, ...args: OptionalArgsTuple<FunctionArgs<TReference>> | [Skip]): Readable<SyncoreQueryStoreState<FunctionResult<TReference>>>;
+/**
+ * Create a reactive Svelte store that simultaneously observes multiple
+ * Syncore queries.
+ *
+ * Uses the client from Svelte context (set via {@link setSyncoreClient}).
+ * Each key in `entries` corresponds to a key in the emitted result object.
+ *
+ * ```svelte
+ * <script>
+ *   import { createQueriesStore } from "syncorejs/svelte";
+ *   import { api } from "../syncore/_generated/api";
+ *
+ *   const stores = createQueriesStore({
+ *     todos: { query: api.todos.list },
+ *     user: { query: api.users.me },
+ *   });
+ * </script>
+ *
+ * <p>{$stores.user.data?.name} has {$stores.todos.data?.length} todos</p>
+ * ```
+ */
 declare function createQueriesStore<TEntries extends QueriesRequestInput>(entries: TEntries): Readable<CreateQueriesStoreResult<TEntries>>;
+/**
+ * Create a reactive Svelte store that simultaneously observes multiple
+ * Syncore queries.
+ *
+ * Accepts an explicit `client` instead of reading from Svelte context.
+ *
+ * @param client - The Syncore client to query against.
+ */
 declare function createClientQueriesStore<TEntries extends QueriesRequestInput>(client: SyncoreClient, entries: TEntries): Readable<CreateQueriesStoreResult<TEntries>>;
+/**
+ * Create a reactive Svelte store for cursor-based paginated Syncore queries.
+ *
+ * Uses the client from Svelte context (set via {@link setSyncoreClient}).
+ * The store handles page tracking and exposes a `loadMore()` function so you
+ * can implement “Load More” UIs without manual cursor management.
+ *
+ * The query referenced by `reference` must accept a `paginationOpts`
+ * argument and return a PaginationResult.
+ *
+ * ```svelte
+ * <script>
+ *   import { createPaginatedQueryStore } from "syncorejs/svelte";
+ *   import { api } from "../syncore/_generated/api";
+ *
+ *   const result = createPaginatedQueryStore(
+ *     api.todos.listPaginated,
+ *     {},
+ *     { initialNumItems: 10 }
+ *   );
+ * </script>
+ *
+ * {#each $result.results as todo}<p>{todo.text}</p>{/each}
+ * {#if $result.canLoadMore}
+ *   <button on:click={() => $result.loadMore(10)}>Load more</button>
+ * {/if}
+ * ```
+ *
+ * @param reference - A paginated query function reference.
+ * @param args - Query arguments excluding `paginationOpts`, or `skip`.
+ * @param options - Pagination options. `initialNumItems` controls the number
+ *   of items to fetch on the first page.
+ */
 declare function createPaginatedQueryStore<TReference extends PaginatedQueryReference>(reference: TReference, args: PaginatedQueryArgs<TReference> | Skip, options: {
   initialNumItems: number;
 }): Readable<UsePaginatedQueryResult<PaginatedQueryItem<TReference>>>;
+/**
+ * Create a reactive Svelte store for cursor-based paginated Syncore queries.
+ *
+ * Accepts an explicit `client` instead of reading from Svelte context.
+ *
+ * @param client - The Syncore client to query against.
+ * @param reference - A paginated query function reference.
+ * @param args - Query arguments excluding `paginationOpts`, or `skip`.
+ * @param options - Pagination options. `initialNumItems` controls the number
+ *   of items to fetch on the first page.
+ */
 declare function createClientPaginatedQueryStore<TReference extends PaginatedQueryReference>(client: SyncoreClient, reference: TReference, args: PaginatedQueryArgs<TReference> | Skip, options: {
   initialNumItems: number;
 }): Readable<UsePaginatedQueryResult<PaginatedQueryItem<TReference>>>;

package/dist/_vendor/svelte/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;;KAoBY,iBAAA,UACV,MAAA,uBAA6B,KAAA,IAAS,IAAA,GAAO,KAAA,KAAU,IAAA,EAAM,KAAA;AAAA,KAM1D,iBAAA,oBACgB,iBAAA,YAA6B,iBAAA,aAC9C,MAAA,uBAA6B,YAAA,CAAa,UAAA;EAExC,KAAA,EAAO,UAAA;EACP,IAAA,GAAO,YAAA,CAAa,UAAA,IAAc,IAAA;AAAA;EAGlC,KAAA,EAAO,UAAA;EACP,IAAA,EAAM,YAAA,CAAa,UAAA,IAAc,IAAA;AAAA;AAAA,KAGlC,mBAAA,GAAsB,MAAA,SAAe,iBAAA;AAAA,KAErC,kBAAA,WAA6B,MAAA,SAAe,iBAAA,qBAG7C,iBAAA,CAAkB,cAAA,CAAe,UAAA;AAAA,KAGzB,wBAAA,kBAA0C,mBAAA,qBACrC,QAAA,GAAW,kBAAA,CAAmB,QAAA,CAAS,IAAA;AAAA,KAGnD,uBAAA,GAA0B,iBAAA,UAE7B,MAAA,mBACA,gBAAA;AAAA,KAGG,kBAAA,oBAAsC,iBAAA,aACzC,YAAA,CAAa,UAAA;EAAsB,cAAA,EAAgB,iBAAA;AAAA,IAC/C,IAAA,CAAK,YAAA,CAAa,UAAA;AAAA,KAGnB,kBAAA,oBAAsC,iBAAA,aACzC,cAAA,CAAe,UAAA,UAAoB,gBAAA,gBAC/B,KAAA;;;AA3CgE;UA0DrD,sBAAA,kBACP,iBAAA,CAAkB,OAAA;AAAA,cAEf,IAAA;AAAA,KACR,IAAA,UAAc,IAAA;;;;iBAYH,gBAAA,CAAiB,MAAA,EAAQ,aAAA,GAAgB,aAAA;;;;iBAQzC,gBAAA,CAAA,GAAoB,aAAA;AAAA,iBAUpB,wBAAA,CAAA,GAA4B,QAAA,CAAS,oBAAA;AAAA,iBAIrC,8BAAA,CACd,MAAA,EAAQ,aAAA,GACP,QAAA,CAAS,oBAAA;;;;iBAUI,qBAAA,oBACK,iBAAA,UAAA,CAEnB,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,cAAA,CAAe,UAAA;;;;iBAOX,2BAAA,oBACK,iBAAA,UAAA,CAEnB,MAAA,EAAQ,aAAA,EACR,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,cAAA,CAAe,UAAA;;;;iBAYX,gBAAA,oBAAoC,iBAAA,UAAA,CAClD,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,sBAAA,CAAuB,cAAA,CAAe,UAAA;;;;iBAOlC,sBAAA,oBACK,iBAAA,UAAA,CAEnB,MAAA,EAAQ,aAAA,EACR,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,sBAAA,CAAuB,cAAA,CAAe,UAAA;AAAA,iBAkBlC,kBAAA,kBAAoC,mBAAA,CAAA,CAClD,OAAA,EAAS,QAAA,GACR,QAAA,CAAS,wBAAA,CAAyB,QAAA;AAAA,iBAIrB,wBAAA,kBAA0C,mBAAA,CAAA,CACxD,MAAA,EAAQ,aAAA,EACR,OAAA,EAAS,QAAA,GACR,QAAA,CAAS,wBAAA,CAAyB,QAAA;AAAA,iBAoErB,yBAAA,oBACK,uBAAA,CAAA,CAEnB,SAAA,EAAW,UAAA,EACX,IAAA,EAAM,kBAAA,CAAmB,UAAA,IAAc,IAAA,EACvC,OAAA;EACE,eAAA;AAAA,IAED,QAAA,CAAS,uBAAA,CAAwB,kBAAA,CAAmB,UAAA;AAAA,iBASvC,+BAAA,oBACK,uBAAA,CAAA,CAEnB,MAAA,EAAQ,aAAA,EACR,SAAA,EAAW,UAAA,EACX,IAAA,EAAM,kBAAA,CAAmB,UAAA,IAAc,IAAA,EACvC,OAAA;EACE,eAAA;AAAA,IAED,QAAA,CAAS,uBAAA,CAAwB,kBAAA,CAAmB,UAAA;;;;iBA0LvC,cAAA,oBACK,iBAAA,aAAA,CAEnB,SAAA,EAAW,UAAA,OAER,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,OACrC,OAAA,CAAQ,cAAA,CAAe,UAAA;AAjc+B;;;AAAA,iBA4c3C,YAAA,oBAAgC,iBAAA,WAAA,CAC9C,SAAA,EAAW,UAAA,OAER,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,OACrC,OAAA,CAAQ,cAAA,CAAe,UAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;;KAoBY,iBAAA,UACV,MAAA,uBAA6B,KAAA,IAAS,IAAA,GAAO,KAAA,KAAU,IAAA,EAAM,KAAA;AAAA,KAM1D,iBAAA,oBACgB,iBAAA,YAA6B,iBAAA,aAC9C,MAAA,uBAA6B,YAAA,CAAa,UAAA;EAExC,KAAA,EAAO,UAAA;EACP,IAAA,GAAO,YAAA,CAAa,UAAA,IAAc,IAAA;AAAA;EAGlC,KAAA,EAAO,UAAA;EACP,IAAA,EAAM,YAAA,CAAa,UAAA,IAAc,IAAA;AAAA;AAAA,KAGlC,mBAAA,GAAsB,MAAM,SAAS,iBAAA;AAAA,KAErC,kBAAA,WAA6B,MAAA,SAAe,iBAAA,qBAG7C,iBAAA,CAAkB,cAAA,CAAe,UAAA;AAAA,KAGzB,wBAAA,kBAA0C,mBAAA,qBACrC,QAAA,GAAW,kBAAA,CAAmB,QAAA,CAAS,IAAA;AAAA,KAGnD,uBAAA,GAA0B,iBAAA,UAE7B,MAAA,mBACA,gBAAA;AAAA,KAGG,kBAAA,oBAAsC,iBAAA,aACzC,YAAA,CAAa,UAAA;EAAsB,cAAA,EAAgB,iBAAA;AAAA,IAC/C,IAAA,CAAK,YAAA,CAAa,UAAA;AAAA,KAGnB,kBAAA,oBAAsC,iBAAA,aACzC,cAAA,CAAe,UAAA,UAAoB,gBAAA,gBAC/B,KAAA;;AA3C8D;AAAE;;;;;;UA+DrD,sBAAA,kBACP,iBAAiB,CAAC,OAAA;;;;;;;;;;;;;;;;;;;;;;;cAwBf,IAAA;AAAA,KACR,IAAA,UAAc,IAAI;;;;;;AA1EoB;AAAA;;;;AAGgB;AAAA;;;;;;;;;;iBAqG3C,gBAAA,CAAiB,MAAA,EAAQ,aAAA,GAAgB,aAAa;;;;;;;;AAhGvB;AAG/C;iBA2GgB,gBAAA,CAAA,GAAoB,aAAa;;;;;;;;;;;;;;;;;AA1GW;AAC1D;;;iBAuIc,wBAAA,CAAA,GAA4B,QAAQ,CAAC,oBAAA;;;;;;;;;AAlInC;iBA+IF,8BAAA,CACd,MAAA,EAAQ,aAAA,GACP,QAAA,CAAS,oBAAA;;;;;;;;;;;;;;;;;;;;;iBA2BI,qBAAA,oBACK,iBAAA,UAAA,CAEnB,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,cAAA,CAAe,UAAA;AA5KO;AAAA;;;;;;;AAAA,iBAwLlB,2BAAA,oBACK,iBAAA,UAAA,CAEnB,MAAA,EAAQ,aAAA,EACR,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,cAAA,CAAe,UAAA;;;;;;;;;;AAzLhB;AAoBX;;;;;;;;AACmC;AAwBnC;;;;iBA4KgB,gBAAA,oBAAoC,iBAAA,UAAA,CAClD,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,sBAAA,CAAuB,cAAA,CAAe,UAAA;AA/Kd;;;;AACb;AA8BvB;;;AA/BoC,iBA2LpB,sBAAA,oBACK,iBAAA,UAAA,CAEnB,MAAA,EAAQ,aAAA,EACR,SAAA,EAAW,UAAA,KACR,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,MAAgB,IAAA,IACvD,QAAA,CAAS,sBAAA,CAAuB,cAAA,CAAe,UAAA;;;;;AAlKoB;AActE;;;;AAAiD;AA8BjD;;;;AAAyE;AAazE;;;;;;iBAgJgB,kBAAA,kBAAoC,mBAAA,CAAA,CAClD,OAAA,EAAS,QAAA,GACR,QAAA,CAAS,wBAAA,CAAyB,QAAA;;;;;;;AAhJL;AA2BhC;iBAiIgB,wBAAA,kBAA0C,mBAAA,CAAA,CACxD,MAAA,EAAQ,aAAA,EACR,OAAA,EAAS,QAAA,GACR,QAAA,CAAS,wBAAA,CAAyB,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;AA/HA;AAYrC;;;;;;;iBAwNgB,yBAAA,oBACK,uBAAA,CAAA,CAEnB,SAAA,EAAW,UAAA,EACX,IAAA,EAAM,kBAAA,CAAmB,UAAA,IAAc,IAAA,EACvC,OAAA;EACE,eAAA;AAAA,IAED,QAAA,CAAS,uBAAA,CAAwB,kBAAA,CAAmB,UAAA;;;;;;;;;;;;iBAoBvC,+BAAA,oBACK,uBAAA,CAAA,CAEnB,MAAA,EAAQ,aAAA,EACR,SAAA,EAAW,UAAA,EACX,IAAA,EAAM,kBAAA,CAAmB,UAAA,IAAc,IAAA,EACvC,OAAA;EACE,eAAA;AAAA,IAED,QAAA,CAAS,uBAAA,CAAwB,kBAAA,CAAmB,UAAA;;;;iBA0LvC,cAAA,oBACK,iBAAA,aAAA,CAEnB,SAAA,EAAW,UAAA,OAER,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,OACrC,OAAA,CAAQ,cAAA,CAAe,UAAA;;;AAvbS;iBAkcrB,YAAA,oBAAgC,iBAAA,WAAA,CAC9C,SAAA,EAAW,UAAA,OAER,IAAA,EAAM,iBAAA,CAAkB,YAAA,CAAa,UAAA,OACrC,OAAA,CAAQ,cAAA,CAAe,UAAA"}

package/dist/_vendor/svelte/index.js

@@ -1,6 +1,28 @@
 import { derived, readable } from "svelte/store";
 import { getContext, setContext } from "svelte";
 //#region src/index.ts
+/**
+* A sentinel value that tells Syncore store factories to skip the query.
+*
+* Use `skip` in place of a query’s `args` argument to avoid firing the query
+* while some required data is not yet available (e.g. a user ID that loads
+* asynchronously). The store will remain in a `"loading"` / skipped state
+* until a non-skip value is provided.
+*
+* ```svelte
+* <script>
+*   import { createQueryValueStore, skip } from "syncorejs/svelte";
+*   import { api } from "../syncore/_generated/api";
+*
+*   export let userId: string | undefined;
+*
+*   $: profile = createQueryValueStore(
+*     api.users.get,
+*     userId ? { id: userId } : skip
+*   );
+* <\/script>
+* ```
+*/
 const skip = "skip";
 const defaultRuntimeStatus = {
 	kind: "starting",
@@ -8,46 +30,146 @@ const defaultRuntimeStatus = {
 };
 const SYNCORE_CLIENT_CONTEXT = Symbol("syncore.client");
 /**
-* Stores a Syncore client in Svelte component context and returns it.
+* Store the Syncore client in Svelte’s component context.
+*
+* Call this once at the root of your component tree (e.g. in a layout or
+* root `+layout.svelte`) so that the context-aware store factories
+* (`createQueryStore`, `createQueriesStore`, etc.) can retrieve it
+* automatically without prop-drilling.
+*
+* ```svelte
+* <!-- +layout.svelte -->
+* <script>
+*   import { setSyncoreClient } from "syncorejs/svelte";
+*   export let data; // { client } from +layout.ts
+*   setSyncoreClient(data.client);
+* <\/script>
+* <slot />
+* ```
+*
+* @param client - The ready Syncore client to store in context.
+* @returns The same `client` for convenience.
 */
 function setSyncoreClient(client) {
 	setContext(SYNCORE_CLIENT_CONTEXT, client);
 	return client;
 }
 /**
-* Reads the Syncore client previously stored in Svelte component context.
+* Retrieve the Syncore client from Svelte’s component context.
+*
+* Throws if {@link setSyncoreClient} has not been called by an ancestor
+* component. Only use this inside Svelte components; for standalone scripts
+* keep an explicit reference to the client instead.
+*
+* @throws `Error` when no client is found in the component context.
 */
 function getSyncoreClient() {
 	const client = getContext(SYNCORE_CLIENT_CONTEXT);
 	if (!client) throw new Error("Syncore client is missing from the Svelte component context.");
 	return client;
 }
+/**
+* Create a reactive Svelte store that tracks the Syncore runtime status.
+*
+* Uses the client from Svelte context (set via {@link setSyncoreClient}).
+* Subscribe to gate your UI on `"ready"` before rendering data-dependent
+* components.
+*
+* ```svelte
+* <script>
+*   import { createSyncoreStatusStore } from "syncorejs/svelte";
+*   const status = createSyncoreStatusStore();
+* <\/script>
+*
+* {#if $status.kind === "ready"}
+*   <App />
+* {:else}
+*   <Loading />
+* {/if}
+* ```
+*/
 function createSyncoreStatusStore() {
 	return createClientSyncoreStatusStore(getSyncoreClient());
 }
+/**
+* Create a reactive Svelte store that tracks the Syncore runtime status.
+*
+* Accepts an explicit `client` rather than reading from Svelte context,
+* making it usable outside component trees (e.g. in module-level code or
+* SvelteKit `load` functions).
+*
+* @param client - The Syncore client to observe.
+*/
 function createClientSyncoreStatusStore(client) {
 	return readable(defaultRuntimeStatus, createStatusStoreStart(client));
 }
 /**
-* Creates a reactive store for a Syncore query result using the contextual client.
+* Create a reactive Svelte store that emits the current value of a Syncore
+* query, or `undefined` while loading.
+*
+* Uses the client from Svelte context (set via {@link setSyncoreClient}).
+* Pass `skip` as `args` to pause the query.
+*
+* ```svelte
+* <script>
+*   import { createQueryValueStore } from "syncorejs/svelte";
+*   import { api } from "../syncore/_generated/api";
+*
+*   const todos = createQueryValueStore(api.todos.list);
+* <\/script>
+*
+* {#each $todos ?? [] as todo}
+*   <p>{todo.text}</p>
+* {/each}
+* ```
 */
 function createQueryValueStore(reference, ...args) {
 	return createClientQueryValueStore(getSyncoreClient(), reference, ...args);
 }
 /**
-* Creates a reactive store for a Syncore query result using an explicit client.
+* Create a reactive Svelte store that emits the current value of a Syncore
+* query, or `undefined` while loading.
+*
+* Accepts an explicit `client` instead of reading from Svelte context.
+*
+* @param client - The Syncore client to query against.
 */
 function createClientQueryValueStore(client, reference, ...args) {
 	return derived(createClientQueryStore(client, reference, ...args), ($state) => $state.data);
 }
 /**
-* Creates a reactive store with the full Syncore query state.
+* Create a reactive Svelte store that emits the full SyncoreQueryState
+* for a query, including `data`, `error`, `status`, and `isPending`.
+*
+* Uses the client from Svelte context (set via {@link setSyncoreClient}).
+*
+* ```svelte
+* <script>
+*   import { createQueryStore } from "syncorejs/svelte";
+*   import { api } from "../syncore/_generated/api";
+*
+*   const state = createQueryStore(api.todos.list);
+* <\/script>
+*
+* {#if $state.isPending}
+*   <Spinner />
+* {:else if $state.error}
+*   <Error message={$state.error.message} />
+* {:else}
+*   {#each $state.data as todo}<p>{todo.text}</p>{/each}
+* {/if}
+* ```
 */
 function createQueryStore(reference, ...args) {
 	return createClientQueryStore(getSyncoreClient(), reference, ...args);
 }
 /**
-* Creates a reactive store with the full Syncore query state for an explicit client.
+* Create a reactive Svelte store that emits the full SyncoreQueryState
+* for a query, including `data`, `error`, `status`, and `isPending`.
+*
+* Accepts an explicit `client` instead of reading from Svelte context.
+*
+* @param client - The Syncore client to query against.
 */
 function createClientQueryStore(client, reference, ...args) {
 	const isSkipped = args[0] === skip;
@@ -57,9 +179,38 @@ function createClientQueryStore(client, reference, ...args) {
 		error: void 0
 	}, defaultRuntimeStatus, isSkipped), createQueryStoreStart(client, reference, normalizedArgs, isSkipped));
 }
+/**
+* Create a reactive Svelte store that simultaneously observes multiple
+* Syncore queries.
+*
+* Uses the client from Svelte context (set via {@link setSyncoreClient}).
+* Each key in `entries` corresponds to a key in the emitted result object.
+*
+* ```svelte
+* <script>
+*   import { createQueriesStore } from "syncorejs/svelte";
+*   import { api } from "../syncore/_generated/api";
+*
+*   const stores = createQueriesStore({
+*     todos: { query: api.todos.list },
+*     user: { query: api.users.me },
+*   });
+* <\/script>
+*
+* <p>{$stores.user.data?.name} has {$stores.todos.data?.length} todos</p>
+* ```
+*/
 function createQueriesStore(entries) {
 	return createClientQueriesStore(getSyncoreClient(), entries);
 }
+/**
+* Create a reactive Svelte store that simultaneously observes multiple
+* Syncore queries.
+*
+* Accepts an explicit `client` instead of reading from Svelte context.
+*
+* @param client - The Syncore client to query against.
+*/
 function createClientQueriesStore(client, entries) {
 	const normalizedEntries = Object.entries(entries).sort(([left], [right]) => left.localeCompare(right)).map(([key, entry]) => ({
 		key,
@@ -90,9 +241,53 @@ function createClientQueriesStore(client, entries) {
 		};
 	});
 }
+/**
+* Create a reactive Svelte store for cursor-based paginated Syncore queries.
+*
+* Uses the client from Svelte context (set via {@link setSyncoreClient}).
+* The store handles page tracking and exposes a `loadMore()` function so you
+* can implement “Load More” UIs without manual cursor management.
+*
+* The query referenced by `reference` must accept a `paginationOpts`
+* argument and return a PaginationResult.
+*
+* ```svelte
+* <script>
+*   import { createPaginatedQueryStore } from "syncorejs/svelte";
+*   import { api } from "../syncore/_generated/api";
+*
+*   const result = createPaginatedQueryStore(
+*     api.todos.listPaginated,
+*     {},
+*     { initialNumItems: 10 }
+*   );
+* <\/script>
+*
+* {#each $result.results as todo}<p>{todo.text}</p>{/each}
+* {#if $result.canLoadMore}
+*   <button on:click={() => $result.loadMore(10)}>Load more</button>
+* {/if}
+* ```
+*
+* @param reference - A paginated query function reference.
+* @param args - Query arguments excluding `paginationOpts`, or `skip`.
+* @param options - Pagination options. `initialNumItems` controls the number
+*   of items to fetch on the first page.
+*/
 function createPaginatedQueryStore(reference, args, options) {
 	return createClientPaginatedQueryStore(getSyncoreClient(), reference, args, options);
 }
+/**
+* Create a reactive Svelte store for cursor-based paginated Syncore queries.
+*
+* Accepts an explicit `client` instead of reading from Svelte context.
+*
+* @param client - The Syncore client to query against.
+* @param reference - A paginated query function reference.
+* @param args - Query arguments excluding `paginationOpts`, or `skip`.
+* @param options - Pagination options. `initialNumItems` controls the number
+*   of items to fetch on the first page.
+*/
 function createClientPaginatedQueryStore(client, reference, args, options) {
 	if (typeof options.initialNumItems !== "number" || options.initialNumItems <= 0) throw new Error(`options.initialNumItems must be a positive number. Received ${String(options.initialNumItems)}.`);
 	const isSkipped = args === skip;