@gettersethya/mira-tanstack-adapter 0.1.0-alpha.17 → 0.1.0-alpha.20

package/README.md

@@ -28,7 +28,6 @@ npm install @gettersethya/mira-tanstack-adapter @tanstack/solid-query
 ```typescript
 import { createMiraClient } from "@gettersethya/mira-client"
 import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/react"
-// import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/svelte"
 // import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/solid"
 import { Posts } from "./collections.js"
 
@@ -36,6 +35,26 @@ const mira     = createMiraClient("/api").withCollections({ posts: Posts })
 const postsApi = collectionAdapter(mira, "posts")
 ```
 
+Svelte uses a small factory instead of a pre-built adapter (its v6 option
+types cannot be re-exported from another package's declarations):
+
+```typescript
+import { mutationOptions, queryOptions } from "@tanstack/svelte-query"
+import { createSvelteCollectionAdapter } from "@gettersethya/mira-tanstack-adapter/svelte"
+
+const collectionAdapter = createSvelteCollectionAdapter(queryOptions, mutationOptions)
+const postsApi = collectionAdapter(mira, "posts")
+```
+
+The framework-agnostic factory also lives at the package root for custom setups:
+
+```typescript
+import { queryOptions, mutationOptions } from "@tanstack/react-query"
+import { createCollectionAdapter } from "@gettersethya/mira-tanstack-adapter"
+
+const collectionAdapter = createCollectionAdapter(queryOptions, mutationOptions)
+```
+
 ## Queries
 
 ```tsx
@@ -94,12 +113,15 @@ function PostActions() {
 
 ## Svelte and Solid
 
-The API is identical across all three frameworks. Only the import path changes.
+React and Solid expose a pre-built `collectionAdapter`. Svelte exposes a
+`createSvelteCollectionAdapter(queryOptions, mutationOptions)` factory instead
+(see Setup above). Svelte v6 reads options through reactive getters:
 
 ```typescript
 // Svelte
-import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/svelte"
+import { createSvelteCollectionAdapter } from "@gettersethya/mira-tanstack-adapter/svelte"
 // use with createQuery / createMutation from @tanstack/svelte-query
+const query = createQuery(() => api.getList({ limit: 10 }).queryOptions)
 
 // Solid
 import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/solid"

package/dist/{src/_core.d.ts → _core.d.ts}

@@ -30,14 +30,18 @@ export type MutationOptionsShape<TData, TInput> = {
  * Signature for the framework-provided `queryOptions` factory.
  * TanStack Query in each framework exports a `queryOptions` function that accepts
  * a {@link QueryOptionsShape} and returns a framework-specific options object.
+ * The return type is intentionally `unknown`: each framework returns its own
+ * options shape, which callers narrow via `ReturnType` in {@link enrichQuery}.
  */
-export type MakeQueryOptions = <T>(opts: QueryOptionsShape<T>) => QueryOptionsShape<T>;
+export type MakeQueryOptions = <T>(opts: QueryOptionsShape<T>) => unknown;
 /**
  * Signature for the framework-provided `mutationOptions` factory.
  * TanStack Query in each framework exports a `mutationOptions` function that accepts
  * a {@link MutationOptionsShape} and returns a framework-specific options object.
+ * The return type is intentionally `unknown`: each framework returns its own
+ * options shape, which callers narrow via `ReturnType` in {@link enrichMutation}.
  */
-export type MakeMutationOptions = <TData, TInput>(opts: MutationOptionsShape<TData, TInput>) => MutationOptionsShape<TData, TInput>;
+export type MakeMutationOptions = <TData, TInput>(opts: MutationOptionsShape<TData, TInput>) => unknown;
 /**
  * A map of human-readable action names to their string key values.
  * Used internally to build structured query keys that include the action being performed.
@@ -68,6 +72,8 @@ export type ActionKey = (typeof ActionKeys)[keyof typeof ActionKeys];
  *
  * @template T - The data type returned by the underlying handler.
  * @template H - The handler type, constrained to objects with a zero-arg `raw()` method returning `Promise<T>`.
+ * @template F - The framework `queryOptions` factory. Its return type is preserved
+ *   via `ReturnType`, so framework-specific option fields survive.
  * @param handler - The original handler (e.g. from `client.getList()`).
  * @param key - The query key array to associate with this query.
  * @param makeQueryOptions - Framework-specific `queryOptions` factory.
@@ -76,9 +82,9 @@ export type ActionKey = (typeof ActionKeys)[keyof typeof ActionKeys];
  */
 export declare function enrichQuery<T, H extends {
     raw(): Promise<T>;
-}>(handler: H, key: QueryKey, makeQueryOptions: MakeQueryOptions): H & {
+}, F extends (opts: QueryOptionsShape<T>) => unknown>(handler: H, key: QueryKey, makeQueryOptions: F): H & {
     queryKey: QueryKey;
-    queryOptions: QueryOptionsShape<T>;
+    queryOptions: ReturnType<F>;
 };
 /**
  * Extends a mutation handler with a pre-built `mutationOptions` object.
@@ -90,6 +96,8 @@ export declare function enrichQuery<T, H extends {
  * @template TData - The data type returned by the mutation handler.
  * @template TInput - The input data type consumed by the mutation handler.
  * @template H - The handler type, constrained to objects with a single-arg `raw(input)` method returning `Promise<TData>`.
+ * @template F - The framework `mutationOptions` factory. Its return type is preserved
+ *   via `ReturnType`, so framework-specific option fields survive.
  * @param handler - The original handler (e.g. from `client.create()`).
  * @param makeMutationOptions - Framework-specific `mutationOptions` factory.
  * @returns The original handler augmented with `mutationOptions`.
@@ -97,8 +105,8 @@ export declare function enrichQuery<T, H extends {
  */
 export declare function enrichMutation<TData, TInput, H extends {
     raw(input: TInput): Promise<TData>;
-}>(handler: H, makeMutationOptions: MakeMutationOptions): H & {
-    mutationOptions: MutationOptionsShape<TData, TInput>;
+}, F extends (opts: MutationOptionsShape<TData, TInput>) => unknown>(handler: H, makeMutationOptions: F): H & {
+    mutationOptions: ReturnType<F>;
 };
 /**
  * Creates a TanStack Query adapter for any {@link CollectionClient}.
@@ -145,77 +153,95 @@ export declare function enrichMutation<TData, TInput, H extends {
  * @see MakeQueryOptions
  * @see MakeMutationOptions
  */
-export declare function createCollectionAdapter(makeQueryOptions: MakeQueryOptions, makeMutationOptions: MakeMutationOptions): <F extends FieldsMap>(client: CollectionClient<F>, name: string) => {
+export declare function createCollectionAdapter<FQ extends MakeQueryOptions, FM extends MakeMutationOptions>(makeQueryOptions: FQ, makeMutationOptions: FM): <F extends FieldsMap>(client: CollectionClient<F>, name: string) => {
+    /**
+     * Invalidates all cached queries for this collection.
+     * Calls `queryClient.invalidateQueries` with key prefix `[name]`.
+     *
+     * @param queryClient - Any TanStack Query client with `invalidateQueries`.
+     */
+    invalidateAll: (queryClient: {
+        invalidateQueries(opts: {
+            queryKey: QueryKey;
+        }): unknown;
+    }) => unknown;
+    /**
+     * Invalidates only the `getOne` cache entry for a specific record.
+     * Calls `queryClient.invalidateQueries` with key `[name, "getOne", id]`.
+     *
+     * @param queryClient - Any TanStack Query client with `invalidateQueries`.
+     * @param id - The record ID whose cached `getOne` entry should be invalidated.
+     */
+    invalidateOne: (queryClient: {
+        invalidateQueries(opts: {
+            queryKey: QueryKey;
+        }): unknown;
+    }, id: string) => unknown;
+    register?: (() => import("@gettersethya/mira-client").ClientHandler<import("@gettersethya/mira-collection").InferRecord<F>, import("@gettersethya/mira-collection").RegisterInput<F>>) | undefined;
     /**
      * Enriched version of `getList` that also returns `queryKey` and `queryOptions`.
      * Query key: `[name, "getList", options]`.
      */
     getList: (options?: Parameters<CollectionClient<F>["getList"]>[0]) => {
         raw(): Promise<{
-            items: import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>[];
+            items: import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[];
             nextCursor: number | null;
         }>;
         toEffect(): import("effect/Effect").Effect<{
-            items: import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>[];
+            items: import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[];
             nextCursor: number | null;
         }, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     } & {
         queryKey: QueryKey;
-        queryOptions: QueryOptionsShape<unknown>;
+        queryOptions: ReturnType<FQ>;
     };
     /**
      * Enriched version of `getOne` that also returns `queryKey` and `queryOptions`.
      * Query key: `[name, "getOne", id, options]`.
      */
     getOne: (id: string, options?: Parameters<CollectionClient<F>["getOne"]>[1]) => {
-        raw(): Promise<import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>>;
-        toEffect(): import("effect/Effect").Effect<import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+        raw(): Promise<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>>;
+        toEffect(): import("effect/Effect").Effect<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     } & {
         queryKey: QueryKey;
-        queryOptions: QueryOptionsShape<unknown>;
+        queryOptions: ReturnType<FQ>;
     };
     /**
      * Enriched version of `getFirstOrNone` that also returns `queryKey` and `queryOptions`.
      * Query key: `[name, "getFirstOrNone", options]`.
      */
     getFirstOrNone: (filter: (f: FilterBuilder<F>) => FilterNode, options?: Parameters<CollectionClient<F>["getFirstOrNone"]>[1]) => {
-        raw(): Promise<import("effect/Option").Option<import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>>>;
-        toEffect(): import("effect/Effect").Effect<import("effect/Option").Option<import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+        raw(): Promise<import("effect/Option").Option<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>>>;
+        toEffect(): import("effect/Effect").Effect<import("effect/Option").Option<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     } & {
         queryKey: QueryKey;
-        queryOptions: QueryOptionsShape<unknown>;
+        queryOptions: ReturnType<FQ>;
     };
     /**
      * Enriched version of `getFullList` that also returns `queryKey` and `queryOptions`.
      * Query key: `[name, "getFullList", options]`.
      */
     getFullList: (options?: Parameters<CollectionClient<F>["getFullList"]>[0]) => {
-        raw(): Promise<import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>[]>;
-        toEffect(): import("effect/Effect").Effect<import("@gettersethya/mira-client").WithExpand<F, readonly import("@gettersethya/mira-client").RelationKeys<F>[]>[], import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+        raw(): Promise<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[]>;
+        toEffect(): import("effect/Effect").Effect<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[], import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     } & {
         queryKey: QueryKey;
-        queryOptions: QueryOptionsShape<unknown>;
+        queryOptions: ReturnType<FQ>;
     };
     /**
      * Enriched mutation for creating records. Call `raw(input)` to execute.
      */
-    create: () => import("@gettersethya/mira-client").ClientHandler<import("@gettersethya/mira-client").InferRecord<F>, import("@gettersethya/mira-client").InferMutationInput<F>> & {
-        mutationOptions: MutationOptionsShape<unknown, unknown>;
+    create: () => import("@gettersethya/mira-client").ClientHandler<import("@gettersethya/mira-collection").InferRecord<F>, Omit<import("@gettersethya/mira-collection").InferMutationInput<F>, "emailVerified">> & {
+        mutationOptions: ReturnType<FM>;
     };
     /**
      * Enriched mutation for updating records. Call `raw(input)` to execute.
      */
     update: () => {
-        raw(input: {
-            id: string;
-            data: Partial<import("@gettersethya/mira-client").InferMutationInput<F>>;
-        }): Promise<import("@gettersethya/mira-client").InferRecord<F>>;
-        toEffect(input: {
-            id: string;
-            data: Partial<import("@gettersethya/mira-client").InferMutationInput<F>>;
-        }): import("effect/Effect").Effect<import("@gettersethya/mira-client").InferRecord<F>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+        raw(input: import("@gettersethya/mira-collection").UpdateInput<F, "base">): Promise<import("@gettersethya/mira-collection").InferRecord<F>>;
+        toEffect(input: import("@gettersethya/mira-collection").UpdateInput<F, "base">): import("effect/Effect").Effect<import("@gettersethya/mira-collection").InferRecord<F>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     } & {
-        mutationOptions: MutationOptionsShape<unknown, unknown>;
+        mutationOptions: ReturnType<FM>;
     };
     /**
      * Enriched mutation for deleting records. Call `raw(input)` to execute.
@@ -224,45 +250,22 @@ export declare function createCollectionAdapter(makeQueryOptions: MakeQueryOptio
         raw(input: string): Promise<void>;
         toEffect(input: string): import("effect/Effect").Effect<void, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     } & {
-        mutationOptions: MutationOptionsShape<unknown, unknown>;
+        mutationOptions: ReturnType<FM>;
     };
-    /**
-     * Invalidates all cached queries for this collection.
-     * Calls `queryClient.invalidateQueries` with key prefix `[name]`.
-     *
-     * @param queryClient - Any TanStack Query client with `invalidateQueries`.
-     */
-    invalidateAll: (queryClient: {
-        invalidateQueries(opts: {
-            queryKey: QueryKey;
-        }): unknown;
-    }) => unknown;
-    /**
-     * Invalidates only the `getOne` cache entry for a specific record.
-     * Calls `queryClient.invalidateQueries` with key `[name, "getOne", id]`.
-     *
-     * @param queryClient - Any TanStack Query client with `invalidateQueries`.
-     * @param id - The record ID whose cached `getOne` entry should be invalidated.
-     */
-    invalidateOne: (queryClient: {
-        invalidateQueries(opts: {
-            queryKey: QueryKey;
-        }): unknown;
-    }, id: string) => unknown;
     authWithPassword?(): {
         raw(input: {
             email: string;
             password: string;
         }): Promise<{
             token: string;
-            record: import("@gettersethya/mira-client").InferRecord<F>;
+            record: import("@gettersethya/mira-collection").InferRecord<F>;
         }>;
         toEffect(input: {
             email: string;
             password: string;
         }): import("effect/Effect").Effect<{
             token: string;
-            record: import("@gettersethya/mira-client").InferRecord<F>;
+            record: import("@gettersethya/mira-collection").InferRecord<F>;
         }, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
     };
     fields: import("@gettersethya/mira-client").CollectionFileFields<F>;

package/dist/_core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_core.d.ts","sourceRoot":"","sources":["../src/_core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAEvG;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;AAE7C;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;CAC1B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,KAAK,EAAE,MAAM,IAAI;IAChD,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,KAAK,CAAC,CAAA;CAC9C,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAA;AAEzE;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,EAAE,MAAM,EAC9C,IAAI,EAAE,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,KACtC,OAAO,CAAA;AAEZ;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU;;;;;CAKb,CAAA;AAEV;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAEpE;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS;IAAE,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,CAAA;CAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,EAC/G,OAAO,EAAE,CAAC,EACV,GAAG,EAAE,QAAQ,EACb,gBAAgB,EAAE,CAAC,GAClB,CAAC,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAAE,CAAA;AAY1D;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,SAAS;IAAE,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;CAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,OAAO,EAC9J,OAAO,EAAE,CAAC,EACV,mBAAmB,EAAE,CAAC,GACrB,CAAC,GAAG;IAAE,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAAE,CAAA;AAYzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,wBAAgB,uBAAuB,CACrC,EAAE,SAAS,gBAAgB,EAC3B,EAAE,SAAS,mBAAmB,EAE9B,gBAAgB,EAAE,EAAE,EACpB,mBAAmB,EAAE,EAAE,IAEe,CAAC,SAAS,SAAS,EACvD,QAAQ,gBAAgB,CAAC,CAAC,CAAC,EAC3B,MAAM,MAAM;IAuEV;;;;;OAKG;iCAC0B;QAAE,iBAAiB,CAAC,IAAI,EAAE;YAAE,QAAQ,EAAE,QAAQ,CAAA;SAAE,GAAG,OAAO,CAAA;KAAE;IAGzF;;;;;;OAMG;iCAC0B;QAAE,iBAAiB,CAAC,IAAI,EAAE;YAAE,QAAQ,EAAE,QAAQ,CAAA;SAAE,GAAG,OAAO,CAAA;KAAE,MAAM,MAAM;;IAjFrG;;;OAGG;wBACiB,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;;;;;;;;;;kBA5GpD,QAAQ;;;IAmHrB;;;OAGG;iBACU,MAAM,YAAY,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;;;;kBAvH9D,QAAQ;;;IA8HrB;;;OAGG;6BACsB,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,UAAU,YAAY,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;;;;kBAlI/G,QAAQ;;;IAyIrB;;;OAGG;4BACqB,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;;;;kBA7I5D,QAAQ;;;IAoJrB;;OAEG;;;;IAGH;;OAEG;;;;;;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;EA6BR"}

package/dist/{src/_core.js → _core.js}

@@ -14,43 +14,12 @@ export const ActionKeys = {
     GetFirstOrNone: "getFirstOrNone",
     GetFullList: "getFullList",
 };
-/**
- * Extends a query handler with a `queryKey` and pre-built `queryOptions` object.
- *
- * Uses the provided {@link MakeQueryOptions} factory to convert the handler into
- * a TanStack Query-compatible options object. The returned handler retains all
- * original methods (e.g. `raw()`, `toEffect()`) with `queryKey` and `queryOptions`
- * added as extra properties via `Object.assign`.
- *
- * @template T - The data type returned by the underlying handler.
- * @template H - The handler type, constrained to objects with a zero-arg `raw()` method returning `Promise<T>`.
- * @param handler - The original handler (e.g. from `client.getList()`).
- * @param key - The query key array to associate with this query.
- * @param makeQueryOptions - Framework-specific `queryOptions` factory.
- * @returns The original handler augmented with `queryKey` and `queryOptions`.
- * @see enrichMutation For the mutation equivalent.
- */
 export function enrichQuery(handler, key, makeQueryOptions) {
     return Object.assign(handler, {
         queryKey: key,
         queryOptions: makeQueryOptions({ queryKey: key, queryFn: () => handler.raw() }),
     });
 }
-/**
- * Extends a mutation handler with a pre-built `mutationOptions` object.
- *
- * Uses the provided {@link MakeMutationOptions} factory to convert the handler into
- * a TanStack Query-compatible mutation options object. The returned handler retains all
- * original methods with `mutationOptions` added as an extra property via `Object.assign`.
- *
- * @template TData - The data type returned by the mutation handler.
- * @template TInput - The input data type consumed by the mutation handler.
- * @template H - The handler type, constrained to objects with a single-arg `raw(input)` method returning `Promise<TData>`.
- * @param handler - The original handler (e.g. from `client.create()`).
- * @param makeMutationOptions - Framework-specific `mutationOptions` factory.
- * @returns The original handler augmented with `mutationOptions`.
- * @see enrichQuery For the query equivalent.
- */
 export function enrichMutation(handler, makeMutationOptions) {
     return Object.assign(handler, {
         mutationOptions: makeMutationOptions({
@@ -105,6 +74,7 @@ export function enrichMutation(handler, makeMutationOptions) {
  */
 export function createCollectionAdapter(makeQueryOptions, makeMutationOptions) {
     return function adaptCollectionClient(client, name) {
+        const registerFn = client.register;
         return {
             ...client,
             /**
@@ -139,6 +109,11 @@ export function createCollectionAdapter(makeQueryOptions, makeMutationOptions) {
              * Enriched mutation for deleting records. Call `raw(input)` to execute.
              */
             delete: () => enrichMutation(client.delete(), makeMutationOptions),
+            /**
+             * Enriched mutation for registering a new auth-collection record.
+             * Only present when the underlying collection client exposes `register`.
+             */
+            ...(registerFn ? { register: () => enrichMutation(registerFn(), makeMutationOptions) } : {}),
             /**
              * Invalidates all cached queries for this collection.
              * Calls `queryClient.invalidateQueries` with key prefix `[name]`.

package/dist/_core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_core.js","sourceRoot":"","sources":["../src/_core.ts"],"names":[],"mappings":"AAoDA;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,OAAO,EAAS,SAAS;IACzB,MAAM,EAAU,QAAQ;IACxB,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAK,aAAa;CACrB,CAAA;AA8BV,MAAM,UAAU,WAAW,CACzB,OAAoC,EACpC,GAAa,EACb,gBAAkC;IAElC,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;QAC5B,QAAQ,EAAE,GAAG;QACb,YAAY,EAAE,gBAAgB,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;KAChF,CAAC,CAAA;AACJ,CAAC;AAuBD,MAAM,UAAU,cAAc,CAC5B,OAAkD,EAClD,mBAAwC;IAExC,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE;QAC5B,eAAe,EAAE,mBAAmB,CAAC;YACnC,UAAU,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;SACnD,CAAC;KACH,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,UAAU,uBAAuB,CAIrC,gBAAoB,EACpB,mBAAuB;IAEvB,OAAO,SAAS,qBAAqB,CACnC,MAA2B,EAC3B,IAAY;QAEZ,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAA;QAClC,OAAO;YACL,GAAG,MAAM;YAET;;;eAGG;YACH,OAAO,EAAE,CAAC,OAAuD,EAAE,EAAE,CACnE,WAAW,CACT,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EACvB,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC,EACzC,gBAAgB,CACjB;YAEH;;;eAGG;YACH,MAAM,EAAE,CAAC,EAAU,EAAE,OAAsD,EAAE,EAAE,CAC7E,WAAW,CACT,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,EAC1B,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,IAAI,EAAE,CAAC,EAC5C,gBAAgB,CACjB;YAEH;;;eAGG;YACH,cAAc,EAAE,CAAC,MAA2C,EAAE,OAA8D,EAAE,EAAE,CAC9H,WAAW,CACT,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,CAAC,IAAI,EAAE,UAAU,CAAC,cAAc,EAAE,OAAO,IAAI,EAAE,CAAC,EAChD,gBAAgB,CACjB;YAEH;;;eAGG;YACH,WAAW,EAAE,CAAC,OAA2D,EAAE,EAAE,CAC3E,WAAW,CACT,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,EAC3B,CAAC,IAAI,EAAE,UAAU,CAAC,WAAW,EAAE,OAAO,IAAI,EAAE,CAAC,EAC7C,gBAAgB,CACjB;YAEH;;eAEG;YACH,MAAM,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC;YAElE;;eAEG;YACH,MAAM,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC;YAElE;;eAEG;YACH,MAAM,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC;YAElE;;;eAGG;YACH,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,UAAU,EAAE,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAE5F;;;;;eAKG;YACH,aAAa,EAAE,CAAC,WAAyE,EAAE,EAAE,CAC3F,WAAW,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAErD;;;;;;eAMG;YACH,aAAa,EAAE,CAAC,WAAyE,EAAE,EAAU,EAAE,EAAE,CACvG,WAAW,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;SAC7E,CAAA;IACH,CAAC,CAAA;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { ActionKeys, createCollectionAdapter, enrichMutation, enrichQuery, } from "./_core.js";
+export type { ActionKey, MakeMutationOptions, MakeQueryOptions, MutationOptionsShape, QueryKey, QueryOptionsShape, } from "./_core.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,uBAAuB,EACvB,cAAc,EACd,WAAW,GACZ,MAAM,YAAY,CAAA;AACnB,YAAY,EACV,SAAS,EACT,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,QAAQ,EACR,iBAAiB,GAClB,MAAM,YAAY,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { ActionKeys, createCollectionAdapter, enrichMutation, enrichQuery, } from "./_core.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,uBAAuB,EACvB,cAAc,EACd,WAAW,GACZ,MAAM,YAAY,CAAA"}

package/dist/react.d.ts

@@ -0,0 +1,173 @@
+import { ActionKeys } from "./_core.js";
+/**
+ * A pre-built {@link createCollectionAdapter | collection adapter} for **TanStack React Query**.
+ *
+ * Uses `queryOptions` and `mutationOptions` from `@tanstack/react-query` to produce
+ * options objects compatible with `useQuery` and `useMutation`.
+ *
+ * @example
+ * ```tsx
+ * import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query"
+ * import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/react"
+ * import { createMiraClient } from "@gettersethya/mira-client"
+ *
+ * const client = createMiraClient({ url: "/api" }).withCollections({ posts: PostCollection })
+ * const api = collectionAdapter(client, "posts")
+ *
+ * function PostList() {
+ *   const { data } = useQuery(api.getList({ limit: 10 }).queryOptions)
+ *   const queryClient = useQueryClient()
+ *
+ *   const mutation = useMutation({
+ *     ...api.create().mutationOptions,
+ *     onSuccess: () => api.invalidateAll(queryClient),
+ *   })
+ *
+ *   if (!data) return <div>Loading...</div>
+ *   return <ul>{data.items.map(p => <li key={p.id}>{p.title}</li>)}</ul>
+ * }
+ * ```
+ */
+export declare const collectionAdapter: <F extends import("@gettersethya/mira-collection").FieldsMap>(client: import("@gettersethya/mira-client").CollectionClient<F>, name: string) => {
+    invalidateAll: (queryClient: {
+        invalidateQueries(opts: {
+            queryKey: import("./_core.js").QueryKey;
+        }): unknown;
+    }) => unknown;
+    invalidateOne: (queryClient: {
+        invalidateQueries(opts: {
+            queryKey: import("./_core.js").QueryKey;
+        }): unknown;
+    }, id: string) => unknown;
+    register?: (() => import("@gettersethya/mira-client").ClientHandler<import("@gettersethya/mira-collection").InferRecord<F>, import("@gettersethya/mira-collection").RegisterInput<F>>) | undefined;
+    getList: (options?: {
+        filter?: ((f: import("@gettersethya/mira-client").FilterBuilder<F>) => import("@gettersethya/mira-collection").FilterNode) | undefined;
+        sort?: (keyof F & string) | undefined;
+        order?: "asc" | "desc";
+        cursor?: number | null;
+        limit?: number;
+        select?: readonly (keyof F & string)[] | undefined;
+        expand?: readonly import("@gettersethya/mira-collection").RelationKeys<F>[] | undefined;
+        retryOptions?: import("@gettersethya/mira-client").RetryOptions;
+    } | undefined) => {
+        raw(): Promise<{
+            items: import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[];
+            nextCursor: number | null;
+        }>;
+        toEffect(): import("effect/Effect").Effect<{
+            items: import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[];
+            nextCursor: number | null;
+        }, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    } & {
+        queryKey: import("./_core.js").QueryKey;
+        queryOptions: import("@tanstack/react-query").UseQueryOptions<unknown, unknown, unknown, readonly unknown[]> & {
+            initialData?: unknown;
+        } & {
+            queryKey: readonly unknown[] & {
+                [dataTagSymbol]: unknown;
+                [dataTagErrorSymbol]: unknown;
+            };
+        };
+    };
+    getOne: (id: string, options?: {
+        select?: readonly (keyof F & string)[] | undefined;
+        expand?: readonly import("@gettersethya/mira-collection").RelationKeys<F>[] | undefined;
+        retryOptions?: import("@gettersethya/mira-client").RetryOptions;
+    } | undefined) => {
+        raw(): Promise<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>>;
+        toEffect(): import("effect/Effect").Effect<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    } & {
+        queryKey: import("./_core.js").QueryKey;
+        queryOptions: import("@tanstack/react-query").UseQueryOptions<unknown, unknown, unknown, readonly unknown[]> & {
+            initialData?: unknown;
+        } & {
+            queryKey: readonly unknown[] & {
+                [dataTagSymbol]: unknown;
+                [dataTagErrorSymbol]: unknown;
+            };
+        };
+    };
+    getFirstOrNone: (filter: (f: import("@gettersethya/mira-client").FilterBuilder<F>) => import("@gettersethya/mira-collection").FilterNode, options?: Omit<{
+        filter?: ((f: import("@gettersethya/mira-client").FilterBuilder<F>) => import("@gettersethya/mira-collection").FilterNode) | undefined;
+        sort?: (keyof F & string) | undefined;
+        order?: "asc" | "desc";
+        cursor?: number | null;
+        limit?: number;
+        select?: readonly (keyof F & string)[] | undefined;
+        expand?: readonly import("@gettersethya/mira-collection").RelationKeys<F>[] | undefined;
+        retryOptions?: import("@gettersethya/mira-client").RetryOptions;
+    }, "filter" | "limit" | "cursor"> | undefined) => {
+        raw(): Promise<import("effect/Option").Option<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>>>;
+        toEffect(): import("effect/Effect").Effect<import("effect/Option").Option<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    } & {
+        queryKey: import("./_core.js").QueryKey;
+        queryOptions: import("@tanstack/react-query").UseQueryOptions<unknown, unknown, unknown, readonly unknown[]> & {
+            initialData?: unknown;
+        } & {
+            queryKey: readonly unknown[] & {
+                [dataTagSymbol]: unknown;
+                [dataTagErrorSymbol]: unknown;
+            };
+        };
+    };
+    getFullList: (options?: (Omit<{
+        filter?: ((f: import("@gettersethya/mira-client").FilterBuilder<F>) => import("@gettersethya/mira-collection").FilterNode) | undefined;
+        sort?: (keyof F & string) | undefined;
+        order?: "asc" | "desc";
+        cursor?: number | null;
+        limit?: number;
+        select?: readonly (keyof F & string)[] | undefined;
+        expand?: readonly import("@gettersethya/mira-collection").RelationKeys<F>[] | undefined;
+        retryOptions?: import("@gettersethya/mira-client").RetryOptions;
+    }, "limit" | "cursor"> & {
+        limit?: number;
+    }) | undefined) => {
+        raw(): Promise<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[]>;
+        toEffect(): import("effect/Effect").Effect<import("@gettersethya/mira-collection").WithExpand<F, readonly import("@gettersethya/mira-collection").RelationKeys<F>[]>[], import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    } & {
+        queryKey: import("./_core.js").QueryKey;
+        queryOptions: import("@tanstack/react-query").UseQueryOptions<unknown, unknown, unknown, readonly unknown[]> & {
+            initialData?: unknown;
+        } & {
+            queryKey: readonly unknown[] & {
+                [dataTagSymbol]: unknown;
+                [dataTagErrorSymbol]: unknown;
+            };
+        };
+    };
+    create: () => import("@gettersethya/mira-client").ClientHandler<import("@gettersethya/mira-collection").InferRecord<F>, Omit<import("@gettersethya/mira-collection").InferMutationInput<F>, "emailVerified">> & {
+        mutationOptions: Omit<import("@tanstack/react-query").UseMutationOptions<unknown, unknown, unknown, unknown>, "mutationKey">;
+    };
+    update: () => {
+        raw(input: import("@gettersethya/mira-collection").UpdateInput<F, "base">): Promise<import("@gettersethya/mira-collection").InferRecord<F>>;
+        toEffect(input: import("@gettersethya/mira-collection").UpdateInput<F, "base">): import("effect/Effect").Effect<import("@gettersethya/mira-collection").InferRecord<F>, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    } & {
+        mutationOptions: Omit<import("@tanstack/react-query").UseMutationOptions<unknown, unknown, unknown, unknown>, "mutationKey">;
+    };
+    delete: () => {
+        raw(input: string): Promise<void>;
+        toEffect(input: string): import("effect/Effect").Effect<void, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    } & {
+        mutationOptions: Omit<import("@tanstack/react-query").UseMutationOptions<unknown, unknown, unknown, unknown>, "mutationKey">;
+    };
+    authWithPassword?(): {
+        raw(input: {
+            email: string;
+            password: string;
+        }): Promise<{
+            token: string;
+            record: import("@gettersethya/mira-collection").InferRecord<F>;
+        }>;
+        toEffect(input: {
+            email: string;
+            password: string;
+        }): import("effect/Effect").Effect<{
+            token: string;
+            record: import("@gettersethya/mira-collection").InferRecord<F>;
+        }, import("@gettersethya/mira-client").MiraError, import("effect/http/HttpClient").HttpClient>;
+    };
+    fields: import("@gettersethya/mira-client").CollectionFileFields<F>;
+};
+export { ActionKeys };
+export type { ActionKey } from "./_core.js";
+//# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,UAAU,EAAE,MAAM,YAAY,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAAyD,CAAA;AACvF,OAAO,EAAE,UAAU,EAAE,CAAA;AACrB,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA"}

package/dist/react.js

@@ -0,0 +1,34 @@
+import { mutationOptions, queryOptions } from "@tanstack/react-query";
+import { createCollectionAdapter, ActionKeys } from "./_core.js";
+/**
+ * A pre-built {@link createCollectionAdapter | collection adapter} for **TanStack React Query**.
+ *
+ * Uses `queryOptions` and `mutationOptions` from `@tanstack/react-query` to produce
+ * options objects compatible with `useQuery` and `useMutation`.
+ *
+ * @example
+ * ```tsx
+ * import { useQuery, useMutation, useQueryClient } from "@tanstack/react-query"
+ * import { collectionAdapter } from "@gettersethya/mira-tanstack-adapter/react"
+ * import { createMiraClient } from "@gettersethya/mira-client"
+ *
+ * const client = createMiraClient({ url: "/api" }).withCollections({ posts: PostCollection })
+ * const api = collectionAdapter(client, "posts")
+ *
+ * function PostList() {
+ *   const { data } = useQuery(api.getList({ limit: 10 }).queryOptions)
+ *   const queryClient = useQueryClient()
+ *
+ *   const mutation = useMutation({
+ *     ...api.create().mutationOptions,
+ *     onSuccess: () => api.invalidateAll(queryClient),
+ *   })
+ *
+ *   if (!data) return <div>Loading...</div>
+ *   return <ul>{data.items.map(p => <li key={p.id}>{p.title}</li>)}</ul>
+ * }
+ * ```
+ */
+export const collectionAdapter = createCollectionAdapter(queryOptions, mutationOptions);
+export { ActionKeys };
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACrE,OAAO,EAAE,uBAAuB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;AACvF,OAAO,EAAE,UAAU,EAAE,CAAA"}