@panneau/data 4.1.1 → 5.0.0-alpha.0

package/dist/laravel/index.d.ts

@@ -0,0 +1,17 @@
+import type { DataAdapter } from '../adapter';
+import { type RestAdapterOptions } from '../rest';
+export interface LaravelAdapterOptions extends RestAdapterOptions {
+    /** Name of the cookie that holds the CSRF token. Defaults to Laravel's `XSRF-TOKEN`. */
+    xsrfCookie?: string;
+    /** Header that sends the CSRF token. Defaults to `X-XSRF-TOKEN`. */
+    xsrfHeader?: string;
+    /** Reads the cookies. Defaults to `document.cookie`, or no cookies outside a browser. */
+    cookies?: () => string;
+}
+/**
+ * The REST adapter set up for `laravel-panneau` with Laravel's session authentication: it sends
+ * cookies, adds the CSRF token from the `XSRF-TOKEN` cookie to every request, and treats `419`
+ * (expired CSRF token or session) as unauthorized.
+ */
+export declare function createLaravelAdapter({ xsrfCookie, xsrfHeader, cookies, headers, credentials, createError, ...options }: LaravelAdapterOptions): DataAdapter;
+//# sourceMappingURL=index.d.ts.map

package/dist/laravel/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/laravel/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,OAAO,EAAE,KAAK,kBAAkB,EAAqB,MAAM,SAAS,CAAC;AAErE,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC7D,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oEAAoE;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,MAAM,CAAC;CAC1B;AAgBD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,EACjC,UAAyB,EACzB,UAA2B,EAC3B,OAAwE,EACxE,OAAO,EACP,WAAuB,EACvB,WAAW,EACX,GAAG,OAAO,EACb,EAAE,qBAAqB,GAAG,WAAW,CAiBrC"}

package/dist/laravel/index.js

@@ -0,0 +1,37 @@
+import { UnauthorizedError } from "../errors.js";
+import { createRestAdapter } from "../rest.js";
+//#region src/laravel/index.ts
+function readCookie(cookies, name) {
+	for (const part of cookies.split(";")) {
+		const [key, ...value] = part.trim().split("=");
+		if (key === name) try {
+			return decodeURIComponent(value.join("="));
+		} catch {
+			return value.join("=");
+		}
+	}
+	return null;
+}
+/**
+* The REST adapter set up for `laravel-panneau` with Laravel's session authentication: it sends
+* cookies, adds the CSRF token from the `XSRF-TOKEN` cookie to every request, and treats `419`
+* (expired CSRF token or session) as unauthorized.
+*/
+function createLaravelAdapter({ xsrfCookie = "XSRF-TOKEN", xsrfHeader = "X-XSRF-TOKEN", cookies = () => typeof document === "undefined" ? "" : document.cookie, headers, credentials = "include", createError, ...options }) {
+	return createRestAdapter({
+		...options,
+		credentials,
+		headers: async () => {
+			const result = new Headers(typeof headers === "function" ? await headers() : headers);
+			result.set("X-Requested-With", "XMLHttpRequest");
+			const token = readCookie(cookies(), xsrfCookie);
+			if (token !== null) result.set(xsrfHeader, token);
+			return result;
+		},
+		createError: (problem, response) => createError?.(problem, response) ?? (problem.status === 419 ? new UnauthorizedError(problem) : void 0)
+	});
+}
+//#endregion
+export { createLaravelAdapter };
+
+//# sourceMappingURL=index.js.map

package/dist/laravel/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/laravel/index.ts"],"sourcesContent":["import type { DataAdapter } from '../adapter';\nimport { UnauthorizedError } from '../errors';\nimport { type RestAdapterOptions, createRestAdapter } from '../rest';\n\nexport interface LaravelAdapterOptions extends RestAdapterOptions {\n    /** Name of the cookie that holds the CSRF token. Defaults to Laravel's `XSRF-TOKEN`. */\n    xsrfCookie?: string;\n    /** Header that sends the CSRF token. Defaults to `X-XSRF-TOKEN`. */\n    xsrfHeader?: string;\n    /** Reads the cookies. Defaults to `document.cookie`, or no cookies outside a browser. */\n    cookies?: () => string;\n}\n\nfunction readCookie(cookies: string, name: string): string | null {\n    for (const part of cookies.split(';')) {\n        const [key, ...value] = part.trim().split('=');\n        if (key === name) {\n            try {\n                return decodeURIComponent(value.join('='));\n            } catch {\n                return value.join('=');\n            }\n        }\n    }\n    return null;\n}\n\n/**\n * The REST adapter set up for `laravel-panneau` with Laravel's session authentication: it sends\n * cookies, adds the CSRF token from the `XSRF-TOKEN` cookie to every request, and treats `419`\n * (expired CSRF token or session) as unauthorized.\n */\nexport function createLaravelAdapter({\n    xsrfCookie = 'XSRF-TOKEN',\n    xsrfHeader = 'X-XSRF-TOKEN',\n    cookies = () => (typeof document === 'undefined' ? '' : document.cookie),\n    headers,\n    credentials = 'include',\n    createError,\n    ...options\n}: LaravelAdapterOptions): DataAdapter {\n    return createRestAdapter({\n        ...options,\n        credentials,\n        headers: async () => {\n            const result = new Headers(typeof headers === 'function' ? await headers() : headers);\n            result.set('X-Requested-With', 'XMLHttpRequest');\n            const token = readCookie(cookies(), xsrfCookie);\n            if (token !== null) {\n                result.set(xsrfHeader, token);\n            }\n            return result;\n        },\n        createError: (problem, response) =>\n            createError?.(problem, response) ??\n            (problem.status === 419 ? new UnauthorizedError(problem) : undefined),\n    });\n}\n"],"mappings":";;;AAaA,SAAS,WAAW,SAAiB,MAA6B;CAC9D,KAAK,MAAM,QAAQ,QAAQ,MAAM,GAAG,GAAG;EACnC,MAAM,CAAC,KAAK,GAAG,SAAS,KAAK,KAAK,CAAC,CAAC,MAAM,GAAG;EAC7C,IAAI,QAAQ,MACR,IAAI;GACA,OAAO,mBAAmB,MAAM,KAAK,GAAG,CAAC;EAC7C,QAAQ;GACJ,OAAO,MAAM,KAAK,GAAG;EACzB;CAER;CACA,OAAO;AACX;;;;;;AAOA,SAAgB,qBAAqB,EACjC,aAAa,cACb,aAAa,gBACb,gBAAiB,OAAO,aAAa,cAAc,KAAK,SAAS,QACjE,SACA,cAAc,WACd,aACA,GAAG,WACgC;CACnC,OAAO,kBAAkB;EACrB,GAAG;EACH;EACA,SAAS,YAAY;GACjB,MAAM,SAAS,IAAI,QAAQ,OAAO,YAAY,aAAa,MAAM,QAAQ,IAAI,OAAO;GACpF,OAAO,IAAI,oBAAoB,gBAAgB;GAC/C,MAAM,QAAQ,WAAW,QAAQ,GAAG,UAAU;GAC9C,IAAI,UAAU,MACV,OAAO,IAAI,YAAY,KAAK;GAEhC,OAAO;EACX;EACA,cAAc,SAAS,aACnB,cAAc,SAAS,QAAQ,MAC9B,QAAQ,WAAW,MAAM,IAAI,kBAAkB,OAAO,IAAI,KAAA;CACnE,CAAC;AACL"}

package/dist/query/context.d.ts

@@ -0,0 +1,15 @@
+import { type ReactNode } from 'react';
+import type { DataAdapter } from '../adapter';
+export interface DataAdapterProviderProps {
+    /** The adapter of the hooks below: `createRestAdapter()`, a preset or a custom adapter. */
+    adapter: DataAdapter;
+    children?: ReactNode;
+}
+/**
+ * Provides the adapter used by the query hooks. The hooks also need TanStack Query's
+ * `QueryClientProvider` above them.
+ */
+export declare function DataAdapterProvider({ adapter, children }: DataAdapterProviderProps): import("react").JSX.Element;
+/** The adapter of the closest `DataAdapterProvider`. */
+export declare function useDataAdapter(): DataAdapter;
+//# sourceMappingURL=context.d.ts.map

package/dist/query/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/query/context.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAsB,MAAM,OAAO,CAAC;AAE3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAI9C,MAAM,WAAW,wBAAwB;IACrC,2FAA2F;IAC3F,OAAO,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,wBAAwB,+BAElF;AAED,wDAAwD;AACxD,wBAAgB,cAAc,IAAI,WAAW,CAM5C"}

package/dist/query/context.js

@@ -0,0 +1,34 @@
+import { c } from "react/compiler-runtime";
+import { createContext, use } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/query/context.tsx
+var DataAdapterContext = createContext(null);
+/**
+* Provides the adapter used by the query hooks. The hooks also need TanStack Query's
+* `QueryClientProvider` above them.
+*/
+function DataAdapterProvider(t0) {
+	const $ = c(3);
+	const { adapter, children } = t0;
+	let t1;
+	if ($[0] !== adapter || $[1] !== children) {
+		t1 = /* @__PURE__ */ jsx(DataAdapterContext, {
+			value: adapter,
+			children
+		});
+		$[0] = adapter;
+		$[1] = children;
+		$[2] = t1;
+	} else t1 = $[2];
+	return t1;
+}
+/** The adapter of the closest `DataAdapterProvider`. */
+function useDataAdapter() {
+	const adapter = use(DataAdapterContext);
+	if (adapter === null) throw new Error("useDataAdapter() needs a <DataAdapterProvider> above it.");
+	return adapter;
+}
+//#endregion
+export { DataAdapterProvider, useDataAdapter };
+
+//# sourceMappingURL=context.js.map

package/dist/query/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","names":["adapter","children","_c"],"sources":["../../src/query/context.tsx"],"sourcesContent":["import { type ReactNode, createContext, use } from 'react';\n\nimport type { DataAdapter } from '../adapter';\n\nconst DataAdapterContext = createContext<DataAdapter | null>(null);\n\nexport interface DataAdapterProviderProps {\n    /** The adapter of the hooks below: `createRestAdapter()`, a preset or a custom adapter. */\n    adapter: DataAdapter;\n    children?: ReactNode;\n}\n\n/**\n * Provides the adapter used by the query hooks. The hooks also need TanStack Query's\n * `QueryClientProvider` above them.\n */\nexport function DataAdapterProvider({ adapter, children }: DataAdapterProviderProps) {\n    return <DataAdapterContext value={adapter}>{children}</DataAdapterContext>;\n}\n\n/** The adapter of the closest `DataAdapterProvider`. */\nexport function useDataAdapter(): DataAdapter {\n    const adapter = use(DataAdapterContext);\n    if (adapter === null) {\n        throw new Error('useDataAdapter() needs a <DataAdapterProvider> above it.');\n    }\n    return adapter;\n}\n"],"mappings":";;;;AAIA,IAAM,qBAAqB,cAAkC,IAAI;;;;;AAYjE,SAAO,oBAAA,IAAA;CAAA,MAAA,IAAAE,EAAA,CAAA;CAA6B,MAAA,EAAA,SAAA,aAAA;CAA+C,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,UAAA;EACxE,KAAA,oBAAC,oBAAD;GAA2BF,OAAA;GAAU;EAAlB,CAAA;EAAgD,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAAnE;AAAmE;;AAI9E,SAAgB,iBAA8B;CAC1C,MAAM,UAAU,IAAI,kBAAkB;CACtC,IAAI,YAAY,MACZ,MAAM,IAAI,MAAM,0DAA0D;CAE9E,OAAO;AACX"}

package/dist/query/hooks.d.ts

@@ -0,0 +1,52 @@
+import { type UseMutationResult, type UseQueryOptions, type UseQueryResult } from '@tanstack/react-query';
+import type { ActionRequest, ActionRun, Definition, Item, ListQuery, ListResponse } from '@panneau/protocol';
+import type { ActionResponse, Values } from '../adapter';
+import { queryKeys } from './keys';
+/** Options of a query hook: TanStack Query's options, without the key and the function. */
+export type QueryHookOptions<TData, TKey extends readonly unknown[]> = Omit<UseQueryOptions<TData, Error, TData, TKey>, 'queryKey' | 'queryFn'>;
+/**
+ * The definition for the current user. Pass `initialData` when the server inlines it in the page.
+ */
+export declare function useDefinition(options?: QueryHookOptions<Definition, ReturnType<typeof queryKeys.definition>>): UseQueryResult<Definition>;
+/** A page of items of a resource. */
+export declare function useResourceList(resource: string, query?: ListQuery, options?: QueryHookOptions<ListResponse, ReturnType<typeof queryKeys.list>>): UseQueryResult<ListResponse>;
+/** One item of a resource. Nothing is fetched while `id` is `null` or `undefined`. */
+export declare function useResourceItem(resource: string, id: string | null | undefined, options?: QueryHookOptions<Item, ReturnType<typeof queryKeys.item>>): UseQueryResult<Item>;
+/** Creates an item, then refetches the lists of the resource. */
+export declare function useCreateItem(resource: string): UseMutationResult<Item, Error, Values>;
+export interface UpdateItemVariables {
+    /** Id of the item. */
+    id: string;
+    /** The values to change, keyed by field name. */
+    values: Values;
+    /** The version the values were edited from, sent as `If-Match`. */
+    version?: string | null;
+}
+/**
+ * Updates an item, then caches the updated item and refetches the lists of the resource. Fails
+ * with a `ConflictError` when the item changed since `version`.
+ */
+export declare function useUpdateItem(resource: string): UseMutationResult<Item, Error, UpdateItemVariables>;
+/** Deletes an item, then removes it from the cache and refetches the lists of the resource. */
+export declare function useDeleteItem(resource: string): UseMutationResult<void, Error, string>;
+export interface RunActionVariables extends ActionRequest {
+    /** Id of the action. */
+    action: string;
+}
+/**
+ * Runs an action of a resource. When it finishes right away, the cache is refreshed as its
+ * result asks (`refresh`). When the backend queues it, follow the run with `useActionRun()`.
+ */
+export declare function useRunAction(resource: string): UseMutationResult<ActionResponse, Error, RunActionVariables>;
+/** Whether a run has finished, successfully or not. */
+export declare function isRunFinished(run: ActionRun): boolean;
+export interface UseActionRunOptions {
+    /** Milliseconds between two checks while the run is not finished. Defaults to 2 seconds. */
+    interval?: number;
+}
+/**
+ * Follows a queued action run until it finishes. When it does, the cache is refreshed as its
+ * result asks. Nothing is fetched while `id` is `null` or `undefined`.
+ */
+export declare function useActionRun(id: string | null | undefined, { interval }?: UseActionRunOptions): UseQueryResult<ActionRun>;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/query/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/query/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EAKtB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EACR,aAAa,EACb,SAAS,EACT,UAAU,EACV,IAAI,EACJ,SAAS,EACT,YAAY,EACf,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzD,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAQnC,2FAA2F;AAC3F,MAAM,MAAM,gBAAgB,CAAC,KAAK,EAAE,IAAI,SAAS,SAAS,OAAO,EAAE,IAAI,IAAI,CACvE,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAC1C,UAAU,GAAG,SAAS,CACzB,CAAC;AAEF;;GAEG;AACH,wBAAgB,aAAa,CACzB,OAAO,GAAE,gBAAgB,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAM,GACpF,cAAc,CAAC,UAAU,CAAC,CAG5B;AAED,qCAAqC;AACrC,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,SAAc,EACrB,OAAO,GAAE,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAM,GAChF,cAAc,CAAC,YAAY,CAAC,CAG9B;AAED,sFAAsF;AACtF,wBAAgB,eAAe,CAC3B,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC7B,OAAO,GAAE,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAM,GACxE,cAAc,CAAC,IAAI,CAAC,CAItB;AAED,iEAAiE;AACjE,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAUtF;AAED,MAAM,WAAW,mBAAmB;IAChC,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,wBAAgB,aAAa,CACzB,QAAQ,EAAE,MAAM,GACjB,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,mBAAmB,CAAC,CAWrD;AAED,+FAA+F;AAC/F,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAUtF;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACrD,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CACxB,QAAQ,EAAE,MAAM,GACjB,iBAAiB,CAAC,cAAc,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAc9D;AASD,uDAAuD;AACvD,wBAAgB,aAAa,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAErD;AAED,MAAM,WAAW,mBAAmB;IAChC,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CACxB,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAC7B,EAAE,QAAe,EAAE,GAAE,mBAAwB,GAC9C,cAAc,CAAC,SAAS,CAAC,CAsB3B"}

package/dist/query/hooks.js

@@ -0,0 +1,299 @@
+import { useDataAdapter } from "./context.js";
+import { queryKeys } from "./keys.js";
+import { definitionQueryOptions, resourceItemQueryOptions, resourceListQueryOptions } from "./options.js";
+import { invalidateActionResult } from "./refresh.js";
+import { c } from "react/compiler-runtime";
+import { skipToken, useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+//#region src/query/hooks.ts
+/**
+* The definition for the current user. Pass `initialData` when the server inlines it in the page.
+*/
+function useDefinition(t0) {
+	const $ = c(7);
+	let t1;
+	if ($[0] !== t0) {
+		t1 = t0 === void 0 ? {} : t0;
+		$[0] = t0;
+		$[1] = t1;
+	} else t1 = $[1];
+	const options = t1;
+	const adapter = useDataAdapter();
+	let t2;
+	if ($[2] !== adapter) {
+		t2 = definitionQueryOptions(adapter);
+		$[2] = adapter;
+		$[3] = t2;
+	} else t2 = $[3];
+	let t3;
+	if ($[4] !== options || $[5] !== t2) {
+		t3 = {
+			...t2,
+			...options
+		};
+		$[4] = options;
+		$[5] = t2;
+		$[6] = t3;
+	} else t3 = $[6];
+	return useQuery(t3);
+}
+/** A page of items of a resource. */
+function useResourceList(resource, t0, t1) {
+	const $ = c(11);
+	let t2;
+	if ($[0] !== t0) {
+		t2 = t0 === void 0 ? {} : t0;
+		$[0] = t0;
+		$[1] = t2;
+	} else t2 = $[1];
+	const query = t2;
+	let t3;
+	if ($[2] !== t1) {
+		t3 = t1 === void 0 ? {} : t1;
+		$[2] = t1;
+		$[3] = t3;
+	} else t3 = $[3];
+	const options = t3;
+	const adapter = useDataAdapter();
+	let t4;
+	if ($[4] !== adapter || $[5] !== query || $[6] !== resource) {
+		t4 = resourceListQueryOptions(adapter, resource, query);
+		$[4] = adapter;
+		$[5] = query;
+		$[6] = resource;
+		$[7] = t4;
+	} else t4 = $[7];
+	let t5;
+	if ($[8] !== options || $[9] !== t4) {
+		t5 = {
+			...t4,
+			...options
+		};
+		$[8] = options;
+		$[9] = t4;
+		$[10] = t5;
+	} else t5 = $[10];
+	return useQuery(t5);
+}
+/** One item of a resource. Nothing is fetched while `id` is `null` or `undefined`. */
+function useResourceItem(resource, id, t0) {
+	const $ = c(10);
+	let t1;
+	if ($[0] !== t0) {
+		t1 = t0 === void 0 ? {} : t0;
+		$[0] = t0;
+		$[1] = t1;
+	} else t1 = $[1];
+	const options = t1;
+	const adapter = useDataAdapter();
+	const t2 = id ?? "";
+	let t3;
+	if ($[2] !== adapter || $[3] !== resource || $[4] !== t2) {
+		t3 = resourceItemQueryOptions(adapter, resource, t2);
+		$[2] = adapter;
+		$[3] = resource;
+		$[4] = t2;
+		$[5] = t3;
+	} else t3 = $[5];
+	const query = t3;
+	const t4 = id == null ? skipToken : query.queryFn;
+	let t5;
+	if ($[6] !== options || $[7] !== query || $[8] !== t4) {
+		t5 = {
+			...query,
+			queryFn: t4,
+			...options
+		};
+		$[6] = options;
+		$[7] = query;
+		$[8] = t4;
+		$[9] = t5;
+	} else t5 = $[9];
+	return useQuery(t5);
+}
+/** Creates an item, then refetches the lists of the resource. */
+function useCreateItem(resource) {
+	const $ = c(9);
+	const adapter = useDataAdapter();
+	const client = useQueryClient();
+	let t0;
+	if ($[0] !== adapter || $[1] !== resource) {
+		t0 = (values) => adapter.create(resource, values);
+		$[0] = adapter;
+		$[1] = resource;
+		$[2] = t0;
+	} else t0 = $[2];
+	let t1;
+	if ($[3] !== client || $[4] !== resource) {
+		t1 = (item) => {
+			client.setQueryData(queryKeys.item(resource, item.id), item);
+			return client.invalidateQueries({ queryKey: queryKeys.lists(resource) });
+		};
+		$[3] = client;
+		$[4] = resource;
+		$[5] = t1;
+	} else t1 = $[5];
+	let t2;
+	if ($[6] !== t0 || $[7] !== t1) {
+		t2 = {
+			mutationFn: t0,
+			onSuccess: t1
+		};
+		$[6] = t0;
+		$[7] = t1;
+		$[8] = t2;
+	} else t2 = $[8];
+	return useMutation(t2);
+}
+/**
+* Updates an item, then caches the updated item and refetches the lists of the resource. Fails
+* with a `ConflictError` when the item changed since `version`.
+*/
+function useUpdateItem(resource) {
+	const $ = c(9);
+	const adapter = useDataAdapter();
+	const client = useQueryClient();
+	let t0;
+	if ($[0] !== adapter || $[1] !== resource) {
+		t0 = (t1) => {
+			const { id, values, version } = t1;
+			return adapter.update(resource, id, values, { version });
+		};
+		$[0] = adapter;
+		$[1] = resource;
+		$[2] = t0;
+	} else t0 = $[2];
+	let t1;
+	if ($[3] !== client || $[4] !== resource) {
+		t1 = (item) => {
+			client.setQueryData(queryKeys.item(resource, item.id), item);
+			return client.invalidateQueries({ queryKey: queryKeys.lists(resource) });
+		};
+		$[3] = client;
+		$[4] = resource;
+		$[5] = t1;
+	} else t1 = $[5];
+	let t2;
+	if ($[6] !== t0 || $[7] !== t1) {
+		t2 = {
+			mutationFn: t0,
+			onSuccess: t1
+		};
+		$[6] = t0;
+		$[7] = t1;
+		$[8] = t2;
+	} else t2 = $[8];
+	return useMutation(t2);
+}
+/** Deletes an item, then removes it from the cache and refetches the lists of the resource. */
+function useDeleteItem(resource) {
+	const $ = c(9);
+	const adapter = useDataAdapter();
+	const client = useQueryClient();
+	let t0;
+	if ($[0] !== adapter || $[1] !== resource) {
+		t0 = (id) => adapter.delete(resource, id);
+		$[0] = adapter;
+		$[1] = resource;
+		$[2] = t0;
+	} else t0 = $[2];
+	let t1;
+	if ($[3] !== client || $[4] !== resource) {
+		t1 = (_result, id_0) => {
+			client.removeQueries({ queryKey: queryKeys.item(resource, id_0) });
+			return client.invalidateQueries({ queryKey: queryKeys.lists(resource) });
+		};
+		$[3] = client;
+		$[4] = resource;
+		$[5] = t1;
+	} else t1 = $[5];
+	let t2;
+	if ($[6] !== t0 || $[7] !== t1) {
+		t2 = {
+			mutationFn: t0,
+			onSuccess: t1
+		};
+		$[6] = t0;
+		$[7] = t1;
+		$[8] = t2;
+	} else t2 = $[8];
+	return useMutation(t2);
+}
+/**
+* Runs an action of a resource. When it finishes right away, the cache is refreshed as its
+* result asks (`refresh`). When the backend queues it, follow the run with `useActionRun()`.
+*/
+function useRunAction(resource) {
+	const $ = c(9);
+	const adapter = useDataAdapter();
+	const client = useQueryClient();
+	let t0;
+	if ($[0] !== adapter || $[1] !== resource) {
+		t0 = (t1) => {
+			const { action, ...request } = t1;
+			return adapter.runAction(resource, action, request);
+		};
+		$[0] = adapter;
+		$[1] = resource;
+		$[2] = t0;
+	} else t0 = $[2];
+	let t1;
+	if ($[3] !== client || $[4] !== resource) {
+		t1 = (response, t2) => {
+			const { selection } = t2;
+			if (response.run !== void 0) {
+				client.setQueryData(queryKeys.actionRun(response.run.id), response.run);
+				return client.invalidateQueries({
+					queryKey: queryKeys.actionRuns(),
+					exact: true
+				});
+			}
+			return invalidateActionResult(client, resource, response.result, selection);
+		};
+		$[3] = client;
+		$[4] = resource;
+		$[5] = t1;
+	} else t1 = $[5];
+	let t2;
+	if ($[6] !== t0 || $[7] !== t1) {
+		t2 = {
+			mutationFn: t0,
+			onSuccess: t1
+		};
+		$[6] = t0;
+		$[7] = t1;
+		$[8] = t2;
+	} else t2 = $[8];
+	return useMutation(t2);
+}
+var FINISHED_RUN_STATUSES = /* @__PURE__ */ new Set([
+	"succeeded",
+	"partial",
+	"failed",
+	"cancelled"
+]);
+/** Whether a run has finished, successfully or not. */
+function isRunFinished(run) {
+	return FINISHED_RUN_STATUSES.has(run.status);
+}
+/**
+* Follows a queued action run until it finishes. When it does, the cache is refreshed as its
+* result asks. Nothing is fetched while `id` is `null` or `undefined`.
+*/
+function useActionRun(id, { interval = 2e3 } = {}) {
+	const adapter = useDataAdapter();
+	const client = useQueryClient();
+	return useQuery({
+		queryKey: queryKeys.actionRun(id ?? ""),
+		queryFn: id == null ? skipToken : async ({ signal }) => {
+			const previous = client.getQueryData(queryKeys.actionRun(id));
+			const run = await adapter.getActionRun(id, { signal });
+			if (isRunFinished(run) && (previous === void 0 || !isRunFinished(previous)) && run.result !== void 0) await invalidateActionResult(client, run.resource, run.result);
+			return run;
+		},
+		refetchInterval: (query) => query.state.data !== void 0 && isRunFinished(query.state.data) ? false : interval
+	});
+}
+//#endregion
+export { isRunFinished, useActionRun, useCreateItem, useDefinition, useDeleteItem, useResourceItem, useResourceList, useRunAction, useUpdateItem };
+
+//# sourceMappingURL=hooks.js.map

package/dist/query/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","names":["id","_c"],"sources":["../../src/query/hooks.ts"],"sourcesContent":["import {\n    type UseMutationResult,\n    type UseQueryOptions,\n    type UseQueryResult,\n    skipToken,\n    useMutation,\n    useQuery,\n    useQueryClient,\n} from '@tanstack/react-query';\n\nimport type {\n    ActionRequest,\n    ActionRun,\n    Definition,\n    Item,\n    ListQuery,\n    ListResponse,\n} from '@panneau/protocol';\n\nimport type { ActionResponse, Values } from '../adapter';\nimport { useDataAdapter } from './context';\nimport { queryKeys } from './keys';\nimport {\n    definitionQueryOptions,\n    resourceItemQueryOptions,\n    resourceListQueryOptions,\n} from './options';\nimport { invalidateActionResult } from './refresh';\n\n/** Options of a query hook: TanStack Query's options, without the key and the function. */\nexport type QueryHookOptions<TData, TKey extends readonly unknown[]> = Omit<\n    UseQueryOptions<TData, Error, TData, TKey>,\n    'queryKey' | 'queryFn'\n>;\n\n/**\n * The definition for the current user. Pass `initialData` when the server inlines it in the page.\n */\nexport function useDefinition(\n    options: QueryHookOptions<Definition, ReturnType<typeof queryKeys.definition>> = {},\n): UseQueryResult<Definition> {\n    const adapter = useDataAdapter();\n    return useQuery({ ...definitionQueryOptions(adapter), ...options });\n}\n\n/** A page of items of a resource. */\nexport function useResourceList(\n    resource: string,\n    query: ListQuery = {},\n    options: QueryHookOptions<ListResponse, ReturnType<typeof queryKeys.list>> = {},\n): UseQueryResult<ListResponse> {\n    const adapter = useDataAdapter();\n    return useQuery({ ...resourceListQueryOptions(adapter, resource, query), ...options });\n}\n\n/** One item of a resource. Nothing is fetched while `id` is `null` or `undefined`. */\nexport function useResourceItem(\n    resource: string,\n    id: string | null | undefined,\n    options: QueryHookOptions<Item, ReturnType<typeof queryKeys.item>> = {},\n): UseQueryResult<Item> {\n    const adapter = useDataAdapter();\n    const query = resourceItemQueryOptions(adapter, resource, id ?? '');\n    return useQuery({ ...query, queryFn: id == null ? skipToken : query.queryFn, ...options });\n}\n\n/** Creates an item, then refetches the lists of the resource. */\nexport function useCreateItem(resource: string): UseMutationResult<Item, Error, Values> {\n    const adapter = useDataAdapter();\n    const client = useQueryClient();\n    return useMutation({\n        mutationFn: (values: Values) => adapter.create(resource, values),\n        onSuccess: (item) => {\n            client.setQueryData(queryKeys.item(resource, item.id), item);\n            return client.invalidateQueries({ queryKey: queryKeys.lists(resource) });\n        },\n    });\n}\n\nexport interface UpdateItemVariables {\n    /** Id of the item. */\n    id: string;\n    /** The values to change, keyed by field name. */\n    values: Values;\n    /** The version the values were edited from, sent as `If-Match`. */\n    version?: string | null;\n}\n\n/**\n * Updates an item, then caches the updated item and refetches the lists of the resource. Fails\n * with a `ConflictError` when the item changed since `version`.\n */\nexport function useUpdateItem(\n    resource: string,\n): UseMutationResult<Item, Error, UpdateItemVariables> {\n    const adapter = useDataAdapter();\n    const client = useQueryClient();\n    return useMutation({\n        mutationFn: ({ id, values, version }: UpdateItemVariables) =>\n            adapter.update(resource, id, values, { version }),\n        onSuccess: (item) => {\n            client.setQueryData(queryKeys.item(resource, item.id), item);\n            return client.invalidateQueries({ queryKey: queryKeys.lists(resource) });\n        },\n    });\n}\n\n/** Deletes an item, then removes it from the cache and refetches the lists of the resource. */\nexport function useDeleteItem(resource: string): UseMutationResult<void, Error, string> {\n    const adapter = useDataAdapter();\n    const client = useQueryClient();\n    return useMutation({\n        mutationFn: (id: string) => adapter.delete(resource, id),\n        onSuccess: (_result, id) => {\n            client.removeQueries({ queryKey: queryKeys.item(resource, id) });\n            return client.invalidateQueries({ queryKey: queryKeys.lists(resource) });\n        },\n    });\n}\n\nexport interface RunActionVariables extends ActionRequest {\n    /** Id of the action. */\n    action: string;\n}\n\n/**\n * Runs an action of a resource. When it finishes right away, the cache is refreshed as its\n * result asks (`refresh`). When the backend queues it, follow the run with `useActionRun()`.\n */\nexport function useRunAction(\n    resource: string,\n): UseMutationResult<ActionResponse, Error, RunActionVariables> {\n    const adapter = useDataAdapter();\n    const client = useQueryClient();\n    return useMutation({\n        mutationFn: ({ action, ...request }: RunActionVariables) =>\n            adapter.runAction(resource, action, request),\n        onSuccess: (response, { selection }) => {\n            if (response.run !== undefined) {\n                client.setQueryData(queryKeys.actionRun(response.run.id), response.run);\n                return client.invalidateQueries({ queryKey: queryKeys.actionRuns(), exact: true });\n            }\n            return invalidateActionResult(client, resource, response.result, selection);\n        },\n    });\n}\n\nconst FINISHED_RUN_STATUSES: ReadonlySet<ActionRun['status']> = new Set([\n    'succeeded',\n    'partial',\n    'failed',\n    'cancelled',\n]);\n\n/** Whether a run has finished, successfully or not. */\nexport function isRunFinished(run: ActionRun): boolean {\n    return FINISHED_RUN_STATUSES.has(run.status);\n}\n\nexport interface UseActionRunOptions {\n    /** Milliseconds between two checks while the run is not finished. Defaults to 2 seconds. */\n    interval?: number;\n}\n\n/**\n * Follows a queued action run until it finishes. When it does, the cache is refreshed as its\n * result asks. Nothing is fetched while `id` is `null` or `undefined`.\n */\nexport function useActionRun(\n    id: string | null | undefined,\n    { interval = 2000 }: UseActionRunOptions = {},\n): UseQueryResult<ActionRun> {\n    const adapter = useDataAdapter();\n    const client = useQueryClient();\n    return useQuery({\n        queryKey: queryKeys.actionRun(id ?? ''),\n        queryFn:\n            id == null\n                ? skipToken\n                : async ({ signal }) => {\n                      const previous = client.getQueryData<ActionRun>(queryKeys.actionRun(id));\n                      const run = await adapter.getActionRun(id, { signal });\n                      const justFinished =\n                          isRunFinished(run) &&\n                          (previous === undefined || !isRunFinished(previous));\n                      if (justFinished && run.result !== undefined) {\n                          await invalidateActionResult(client, run.resource, run.result);\n                      }\n                      return run;\n                  },\n        refetchInterval: (query) =>\n            query.state.data !== undefined && isRunFinished(query.state.data) ? false : interval,\n    });\n}\n"],"mappings":";;;;;;;;;;AAsCA,SAAO,cAAA,IAAA;CAAA,MAAA,IAAAC,EAAA,CAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,IAAA;EACH,KAAA,OAAA,KAAA,IAAA,CAAkF,IAAlF;EAAmF,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAnF,MAAA,UAAA;CAEA,MAAA,UAAgB,eAAe;CAAE,IAAA;CAAA,IAAA,EAAA,OAAA,SAAA;EACZ,KAAA,uBAAuB,OAAO;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,IAAA;EAApC,KAAA;GAAA,GAAK;GAA+B,GAAK;EAAQ;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAA3D,SAAS,EAAkD;AAAC;;AAIvE,SAAO,gBAAA,UAAA,IAAA,IAAA;CAAA,MAAA,IAAAA,EAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,IAAA;EAEH,KAAA,OAAA,KAAA,IAAA,CAAoB,IAApB;EAAqB,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAArB,MAAA,QAAA;CAAqB,IAAA;CAAA,IAAA,EAAA,OAAA,IAAA;EACrB,KAAA,OAAA,KAAA,IAAA,CAA8E,IAA9E;EAA+E,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAA/E,MAAA,UAAA;CAEA,MAAA,UAAgB,eAAe;CAAE,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,SAAA,EAAA,OAAA,UAAA;EACZ,KAAA,yBAAyB,SAAS,UAAU,KAAK;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,IAAA;EAAvD,KAAA;GAAA,GAAK;GAAkD,GAAK;EAAQ;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,MAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAA9E,SAAS,EAAqE;AAAC;;AAI1F,SAAO,gBAAA,UAAA,IAAA,IAAA;CAAA,MAAA,IAAAA,EAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,IAAA;EAGH,KAAA,OAAA,KAAA,IAAA,CAAsE,IAAtE;EAAuE,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAvE,MAAA,UAAA;CAEA,MAAA,UAAgB,eAAe;CAC2B,MAAA,KAAA,MAAA;CAAQ,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,YAAA,EAAA,OAAA,IAAA;EAApD,KAAA,yBAAyB,SAAS,UAAU,EAAQ;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAnE,MAAA,QAAc;CACuB,MAAA,KAAA,MAAM,OAAN,YAAyB,MAAK;CAAQ,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,SAAA,EAAA,OAAA,IAAA;EAA3D,KAAA;GAAA,GAAK;GAAK,SAAW;GAAsC,GAAK;EAAQ;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAAlF,SAAS,EAAyE;AAAC;;AAI9F,SAAO,cAAA,UAAA;CAAA,MAAA,IAAAA,EAAA,CAAA;CACH,MAAA,UAAgB,eAAe;CAC/B,MAAA,SAAe,eAAe;CAAE,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,UAAA;EAEhB,MAAA,WAAoB,QAAO,OAAQ,UAAU,MAAM;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,UAAA,EAAA,OAAA,UAAA;EACrD,MAAA,SAAA;GACP,OAAM,aAAc,UAAS,KAAM,UAAU,KAAI,EAAG,GAAG,IAAI;GAAC,OACrD,OAAM,kBAAmB,EAAA,UAAY,UAAS,MAAO,QAAQ,EAAE,CAAC;EAAC;EAC3E,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,MAAA,EAAA,OAAA,IAAA;EALc,KAAA;GAAA,YACH;GAAoD,WACrD;EAIf;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OANM,YAAY,EAMlB;AAAC;;;;;AAgBN,SAAO,cAAA,UAAA;CAAA,MAAA,IAAAA,EAAA,CAAA;CAGH,MAAA,UAAgB,eAAe;CAC/B,MAAA,SAAe,eAAe;CAAE,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,UAAA;EAEhB,MAAA,OAAA;GAAC,MAAA,EAAA,IAAA,QAAA,YAAA;GAA4C,OACrD,QAAO,OAAQ,UAAU,IAAI,QAAQ,EAAA,QAAU,CAAC;EAAC;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,UAAA,EAAA,OAAA,UAAA;EAC1C,MAAA,SAAA;GACP,OAAM,aAAc,UAAS,KAAM,UAAU,KAAI,EAAG,GAAG,IAAI;GAAC,OACrD,OAAM,kBAAmB,EAAA,UAAY,UAAS,MAAO,QAAQ,EAAE,CAAC;EAAC;EAC3E,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,MAAA,EAAA,OAAA,IAAA;EANc,KAAA;GAAA,YACH;GACyC,WAC1C;EAIf;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAPM,YAAY,EAOlB;AAAC;;AAIN,SAAO,cAAA,UAAA;CAAA,MAAA,IAAAA,EAAA,CAAA;CACH,MAAA,UAAgB,eAAe;CAC/B,MAAA,SAAe,eAAe;CAAE,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,UAAA;EAEhB,MAAA,OAAgB,QAAO,OAAQ,UAAU,EAAE;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,UAAA,EAAA,OAAA,UAAA;EAC7C,MAAA,SAAA,SAAA;GACP,OAAM,cAAe,EAAA,UAAY,UAAS,KAAM,UAAUD,IAAE,EAAE,CAAC;GAAC,OACzD,OAAM,kBAAmB,EAAA,UAAY,UAAS,MAAO,QAAQ,EAAE,CAAC;EAAC;EAC3E,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,MAAA,EAAA,OAAA,IAAA;EALc,KAAA;GAAA,YACH;GAA4C,WAC7C;EAIf;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OANM,YAAY,EAMlB;AAAC;;;;;AAYN,SAAO,aAAA,UAAA;CAAA,MAAA,IAAAC,EAAA,CAAA;CAGH,MAAA,UAAgB,eAAe;CAC/B,MAAA,SAAe,eAAe;CAAE,IAAA;CAAA,IAAA,EAAA,OAAA,WAAA,EAAA,OAAA,UAAA;EAEhB,MAAA,OAAA;GAAC,MAAA,EAAA,QAAA,GAAA,YAAA;GAA0C,OACnD,QAAO,UAAW,UAAU,QAAQ,OAAO;EAAC;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,UAAA,EAAA,OAAA,UAAA;EACrC,MAAA,UAAA,OAAA;GAAW,MAAA,EAAA,cAAA;GAClB,IAAI,SAAQ,QAAS,KAAA,GAAS;IAC1B,OAAM,aAAc,UAAS,UAAW,SAAQ,IAAI,EAAG,GAAG,SAAQ,GAAI;IAAC,OAChE,OAAM,kBAAmB;KAAA,UAAY,UAAS,WAAY;KAAC,OAAS;IAAK,CAAC;GAAC;GACrF,OACM,uBAAuB,QAAQ,UAAU,SAAQ,QAAS,SAAS;EAAC;EAC9E,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,IAAA;CAAA,IAAA,EAAA,OAAA,MAAA,EAAA,OAAA,IAAA;EATc,KAAA;GAAA,YACH;GACoC,WACrC;EAOf;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAVM,YAAY,EAUlB;AAAC;AAGN,IAAM,wCAA0D,IAAI,IAAI;CACpE;CACA;CACA;CACA;AAAW,CACd;;AAGD,SAAgB,cAAc,KAAyB;CACnD,OAAO,sBAAsB,IAAI,IAAI,MAAM;AAC/C;;;;;AAWA,SAAgB,aACZ,IACA,EAAE,WAAW,QAA8B,CAAC,GACnB;CACzB,MAAM,UAAU,eAAe;CAC/B,MAAM,SAAS,eAAe;CAC9B,OAAO,SAAS;EACZ,UAAU,UAAU,UAAU,MAAM,EAAE;EACtC,SACI,MAAM,OACA,YACA,OAAO,EAAE,aAAa;GAClB,MAAM,WAAW,OAAO,aAAwB,UAAU,UAAU,EAAE,CAAC;GACvE,MAAM,MAAM,MAAM,QAAQ,aAAa,IAAI,EAAE,OAAO,CAAC;GAIrD,IAFI,cAAc,GAAG,MAChB,aAAa,KAAA,KAAa,CAAC,cAAc,QAAQ,MAClC,IAAI,WAAW,KAAA,GAC/B,MAAM,uBAAuB,QAAQ,IAAI,UAAU,IAAI,MAAM;GAEjE,OAAO;EACX;EACV,kBAAkB,UACd,MAAM,MAAM,SAAS,KAAA,KAAa,cAAc,MAAM,MAAM,IAAI,IAAI,QAAQ;CACpF,CAAC;AACL"}

package/dist/query/index.d.ts

@@ -0,0 +1,6 @@
+export { DataAdapterProvider, type DataAdapterProviderProps, useDataAdapter } from './context';
+export { type QueryHookOptions, type RunActionVariables, type UpdateItemVariables, type UseActionRunOptions, isRunFinished, useActionRun, useCreateItem, useDefinition, useDeleteItem, useResourceItem, useResourceList, useRunAction, useUpdateItem, } from './hooks';
+export { queryKeys } from './keys';
+export { type DataQueryOptions, definitionQueryOptions, resourceItemQueryOptions, resourceListQueryOptions, } from './options';
+export { invalidateActionResult } from './refresh';
+//# sourceMappingURL=index.d.ts.map

package/dist/query/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/query/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,KAAK,wBAAwB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC/F,OAAO,EACH,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,aAAa,EACb,YAAY,EACZ,aAAa,EACb,aAAa,EACb,aAAa,EACb,eAAe,EACf,eAAe,EACf,YAAY,EACZ,aAAa,GAChB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EACH,KAAK,gBAAgB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,GAC3B,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC"}

package/dist/query/index.js

@@ -0,0 +1,6 @@
+import { DataAdapterProvider, useDataAdapter } from "./context.js";
+import { queryKeys } from "./keys.js";
+import { definitionQueryOptions, resourceItemQueryOptions, resourceListQueryOptions } from "./options.js";
+import { invalidateActionResult } from "./refresh.js";
+import { isRunFinished, useActionRun, useCreateItem, useDefinition, useDeleteItem, useResourceItem, useResourceList, useRunAction, useUpdateItem } from "./hooks.js";
+export { DataAdapterProvider, definitionQueryOptions, invalidateActionResult, isRunFinished, queryKeys, resourceItemQueryOptions, resourceListQueryOptions, useActionRun, useCreateItem, useDataAdapter, useDefinition, useDeleteItem, useResourceItem, useResourceList, useRunAction, useUpdateItem };

package/dist/query/keys.d.ts

@@ -0,0 +1,17 @@
+import type { ListQuery } from '@panneau/protocol';
+/**
+ * Query keys of the hooks, to read, prefetch or invalidate their data with the query client.
+ * Keys are nested: invalidating `queryKeys.resource('pages')` covers its lists and items.
+ */
+export declare const queryKeys: {
+    all: readonly ["panneau"];
+    definition: () => readonly ["panneau", "definition"];
+    resource: (resource: string) => readonly ["panneau", "resources", string];
+    lists: (resource: string) => readonly ["panneau", "resources", string, "list"];
+    list: (resource: string, query?: ListQuery) => readonly ["panneau", "resources", string, "list", ListQuery];
+    items: (resource: string) => readonly ["panneau", "resources", string, "item"];
+    item: (resource: string, id: string) => readonly ["panneau", "resources", string, "item", string];
+    actionRuns: () => readonly ["panneau", "actions", "runs"];
+    actionRun: (id: string) => readonly ["panneau", "actions", "runs", string];
+};
+//# sourceMappingURL=keys.d.ts.map

package/dist/query/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/query/keys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,SAAS;;;yBAGG,MAAM;sBACT,MAAM;qBACP,MAAM,UAAS,SAAS;sBAEvB,MAAM;qBACP,MAAM,MAAM,MAAM;;oBAEnB,MAAM;CACzB,CAAC"}

package/dist/query/keys.js

@@ -0,0 +1,55 @@
+//#region src/query/keys.ts
+/**
+* Query keys of the hooks, to read, prefetch or invalidate their data with the query client.
+* Keys are nested: invalidating `queryKeys.resource('pages')` covers its lists and items.
+*/
+var queryKeys = {
+	all: ["panneau"],
+	definition: () => ["panneau", "definition"],
+	resource: (resource) => [
+		"panneau",
+		"resources",
+		resource
+	],
+	lists: (resource) => [
+		"panneau",
+		"resources",
+		resource,
+		"list"
+	],
+	list: (resource, query = {}) => [
+		"panneau",
+		"resources",
+		resource,
+		"list",
+		query
+	],
+	items: (resource) => [
+		"panneau",
+		"resources",
+		resource,
+		"item"
+	],
+	item: (resource, id) => [
+		"panneau",
+		"resources",
+		resource,
+		"item",
+		id
+	],
+	actionRuns: () => [
+		"panneau",
+		"actions",
+		"runs"
+	],
+	actionRun: (id) => [
+		"panneau",
+		"actions",
+		"runs",
+		id
+	]
+};
+//#endregion
+export { queryKeys };
+
+//# sourceMappingURL=keys.js.map

package/dist/query/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","names":[],"sources":["../../src/query/keys.ts"],"sourcesContent":["import type { ListQuery } from '@panneau/protocol';\n\n/**\n * Query keys of the hooks, to read, prefetch or invalidate their data with the query client.\n * Keys are nested: invalidating `queryKeys.resource('pages')` covers its lists and items.\n */\nexport const queryKeys = {\n    all: ['panneau'] as const,\n    definition: () => ['panneau', 'definition'] as const,\n    resource: (resource: string) => ['panneau', 'resources', resource] as const,\n    lists: (resource: string) => ['panneau', 'resources', resource, 'list'] as const,\n    list: (resource: string, query: ListQuery = {}) =>\n        ['panneau', 'resources', resource, 'list', query] as const,\n    items: (resource: string) => ['panneau', 'resources', resource, 'item'] as const,\n    item: (resource: string, id: string) => ['panneau', 'resources', resource, 'item', id] as const,\n    actionRuns: () => ['panneau', 'actions', 'runs'] as const,\n    actionRun: (id: string) => ['panneau', 'actions', 'runs', id] as const,\n};\n"],"mappings":";;;;;AAMA,IAAa,YAAY;CACrB,KAAK,CAAC,SAAS;CACf,kBAAkB,CAAC,WAAW,YAAY;CAC1C,WAAW,aAAqB;EAAC;EAAW;EAAa;CAAQ;CACjE,QAAQ,aAAqB;EAAC;EAAW;EAAa;EAAU;CAAM;CACtE,OAAO,UAAkB,QAAmB,CAAC,MACzC;EAAC;EAAW;EAAa;EAAU;EAAQ;CAAK;CACpD,QAAQ,aAAqB;EAAC;EAAW;EAAa;EAAU;CAAM;CACtE,OAAO,UAAkB,OAAe;EAAC;EAAW;EAAa;EAAU;EAAQ;CAAE;CACrF,kBAAkB;EAAC;EAAW;EAAW;CAAM;CAC/C,YAAY,OAAe;EAAC;EAAW;EAAW;EAAQ;CAAE;AAChE"}

package/dist/query/options.d.ts

@@ -0,0 +1,18 @@
+import { type DataTag, type QueryKey, type UseQueryOptions } from '@tanstack/react-query';
+import type { Definition, Item, ListQuery, ListResponse } from '@panneau/protocol';
+import type { DataAdapter } from '../adapter';
+import { queryKeys } from './keys';
+/**
+ * Query options made by the `*QueryOptions()` functions. Their key is tagged with the type of the
+ * data, so `queryClient.getQueryData(options.queryKey)` is typed.
+ */
+export type DataQueryOptions<TData, TKey extends QueryKey> = UseQueryOptions<TData, Error, TData, TKey> & {
+    queryKey: DataTag<TKey, TData, Error>;
+};
+/** Query options of the definition, for `useQuery()`, prefetching or route loaders. */
+export declare function definitionQueryOptions(adapter: DataAdapter): DataQueryOptions<Definition, ReturnType<typeof queryKeys.definition>>;
+/** Query options of a page of items. The previous page stays shown while the next one loads. */
+export declare function resourceListQueryOptions(adapter: DataAdapter, resource: string, query?: ListQuery): DataQueryOptions<ListResponse, ReturnType<typeof queryKeys.list>>;
+/** Query options of one item. */
+export declare function resourceItemQueryOptions(adapter: DataAdapter, resource: string, id: string): DataQueryOptions<Item, ReturnType<typeof queryKeys.item>>;
+//# sourceMappingURL=options.d.ts.map

package/dist/query/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/query/options.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,KAAK,eAAe,EAGvB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEnF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,EAAE,IAAI,SAAS,QAAQ,IAAI,eAAe,CACxE,KAAK,EACL,KAAK,EACL,KAAK,EACL,IAAI,CACP,GAAG;IAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;CAAE,CAAC;AAE9C,uFAAuF;AACvF,wBAAgB,sBAAsB,CAClC,OAAO,EAAE,WAAW,GACrB,gBAAgB,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAOvE;AAED,gGAAgG;AAChG,wBAAgB,wBAAwB,CACpC,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,SAAc,GACtB,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAMnE;AAED,iCAAiC;AACjC,wBAAgB,wBAAwB,CACpC,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,GACX,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAK3D"}