@panneau/data 4.1.0 → 5.0.0-alpha.0

package/dist/query/options.js

@@ -0,0 +1,30 @@
+import { queryKeys } from "./keys.js";
+import { keepPreviousData, queryOptions } from "@tanstack/react-query";
+//#region src/query/options.ts
+/** Query options of the definition, for `useQuery()`, prefetching or route loaders. */
+function definitionQueryOptions(adapter) {
+	return queryOptions({
+		queryKey: queryKeys.definition(),
+		queryFn: ({ signal }) => adapter.getDefinition({ signal }),
+		staleTime: Infinity
+	});
+}
+/** Query options of a page of items. The previous page stays shown while the next one loads. */
+function resourceListQueryOptions(adapter, resource, query = {}) {
+	return queryOptions({
+		queryKey: queryKeys.list(resource, query),
+		queryFn: ({ signal }) => adapter.list(resource, query, { signal }),
+		placeholderData: keepPreviousData
+	});
+}
+/** Query options of one item. */
+function resourceItemQueryOptions(adapter, resource, id) {
+	return queryOptions({
+		queryKey: queryKeys.item(resource, id),
+		queryFn: ({ signal }) => adapter.get(resource, id, { signal })
+	});
+}
+//#endregion
+export { definitionQueryOptions, resourceItemQueryOptions, resourceListQueryOptions };
+
+//# sourceMappingURL=options.js.map

package/dist/query/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","names":[],"sources":["../../src/query/options.ts"],"sourcesContent":["import {\n    type DataTag,\n    type QueryKey,\n    type UseQueryOptions,\n    keepPreviousData,\n    queryOptions,\n} from '@tanstack/react-query';\n\nimport type { Definition, Item, ListQuery, ListResponse } from '@panneau/protocol';\n\nimport type { DataAdapter } from '../adapter';\nimport { queryKeys } from './keys';\n\n/**\n * Query options made by the `*QueryOptions()` functions. Their key is tagged with the type of the\n * data, so `queryClient.getQueryData(options.queryKey)` is typed.\n */\nexport type DataQueryOptions<TData, TKey extends QueryKey> = UseQueryOptions<\n    TData,\n    Error,\n    TData,\n    TKey\n> & { queryKey: DataTag<TKey, TData, Error> };\n\n/** Query options of the definition, for `useQuery()`, prefetching or route loaders. */\nexport function definitionQueryOptions(\n    adapter: DataAdapter,\n): DataQueryOptions<Definition, ReturnType<typeof queryKeys.definition>> {\n    return queryOptions({\n        queryKey: queryKeys.definition(),\n        queryFn: ({ signal }) => adapter.getDefinition({ signal }),\n        // The definition only changes with the user or the deployment.\n        staleTime: Infinity,\n    });\n}\n\n/** Query options of a page of items. The previous page stays shown while the next one loads. */\nexport function resourceListQueryOptions(\n    adapter: DataAdapter,\n    resource: string,\n    query: ListQuery = {},\n): DataQueryOptions<ListResponse, ReturnType<typeof queryKeys.list>> {\n    return queryOptions({\n        queryKey: queryKeys.list(resource, query),\n        queryFn: ({ signal }) => adapter.list(resource, query, { signal }),\n        placeholderData: keepPreviousData,\n    });\n}\n\n/** Query options of one item. */\nexport function resourceItemQueryOptions(\n    adapter: DataAdapter,\n    resource: string,\n    id: string,\n): DataQueryOptions<Item, ReturnType<typeof queryKeys.item>> {\n    return queryOptions({\n        queryKey: queryKeys.item(resource, id),\n        queryFn: ({ signal }) => adapter.get(resource, id, { signal }),\n    });\n}\n"],"mappings":";;;;AAyBA,SAAgB,uBACZ,SACqE;CACrE,OAAO,aAAa;EAChB,UAAU,UAAU,WAAW;EAC/B,UAAU,EAAE,aAAa,QAAQ,cAAc,EAAE,OAAO,CAAC;EAEzD,WAAW;CACf,CAAC;AACL;;AAGA,SAAgB,yBACZ,SACA,UACA,QAAmB,CAAC,GAC6C;CACjE,OAAO,aAAa;EAChB,UAAU,UAAU,KAAK,UAAU,KAAK;EACxC,UAAU,EAAE,aAAa,QAAQ,KAAK,UAAU,OAAO,EAAE,OAAO,CAAC;EACjE,iBAAiB;CACrB,CAAC;AACL;;AAGA,SAAgB,yBACZ,SACA,UACA,IACyD;CACzD,OAAO,aAAa;EAChB,UAAU,UAAU,KAAK,UAAU,EAAE;EACrC,UAAU,EAAE,aAAa,QAAQ,IAAI,UAAU,IAAI,EAAE,OAAO,CAAC;CACjE,CAAC;AACL"}

package/dist/query/refresh.d.ts

@@ -0,0 +1,12 @@
+import type { QueryClient } from '@tanstack/react-query';
+import type { ActionResult, Selection } from '@panneau/protocol';
+/**
+ * Invalidates the cached data that an action result asks to refresh:
+ *
+ * - `none`: nothing;
+ * - `items`: the affected items (every item of the resource for a query selection), and the
+ *   lists, which show them;
+ * - `list` (the default): every list and item of the resource.
+ */
+export declare function invalidateActionResult(client: QueryClient, resource: string, result: ActionResult, selection?: Selection): Promise<void>;
+//# sourceMappingURL=refresh.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.d.ts","sourceRoot":"","sources":["../../src/query/refresh.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAIjE;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CACxC,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,YAAY,EACpB,SAAS,CAAC,EAAE,SAAS,GACtB,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/dist/query/refresh.js

@@ -0,0 +1,24 @@
+import { queryKeys } from "./keys.js";
+//#region src/query/refresh.ts
+/**
+* Invalidates the cached data that an action result asks to refresh:
+*
+* - `none`: nothing;
+* - `items`: the affected items (every item of the resource for a query selection), and the
+*   lists, which show them;
+* - `list` (the default): every list and item of the resource.
+*/
+async function invalidateActionResult(client, resource, result, selection) {
+	const refresh = result.refresh ?? "list";
+	if (refresh === "none") return;
+	if (refresh === "list") {
+		await client.invalidateQueries({ queryKey: queryKeys.resource(resource) });
+		return;
+	}
+	const ids = selection !== void 0 && "ids" in selection ? selection.ids : null;
+	await Promise.all([client.invalidateQueries({ queryKey: queryKeys.lists(resource) }), ...ids === null ? [client.invalidateQueries({ queryKey: queryKeys.items(resource) })] : ids.map((id) => client.invalidateQueries({ queryKey: queryKeys.item(resource, id) }))]);
+}
+//#endregion
+export { invalidateActionResult };
+
+//# sourceMappingURL=refresh.js.map

package/dist/query/refresh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.js","names":[],"sources":["../../src/query/refresh.ts"],"sourcesContent":["import type { QueryClient } from '@tanstack/react-query';\n\nimport type { ActionResult, Selection } from '@panneau/protocol';\n\nimport { queryKeys } from './keys';\n\n/**\n * Invalidates the cached data that an action result asks to refresh:\n *\n * - `none`: nothing;\n * - `items`: the affected items (every item of the resource for a query selection), and the\n *   lists, which show them;\n * - `list` (the default): every list and item of the resource.\n */\nexport async function invalidateActionResult(\n    client: QueryClient,\n    resource: string,\n    result: ActionResult,\n    selection?: Selection,\n): Promise<void> {\n    const refresh = result.refresh ?? 'list';\n    if (refresh === 'none') {\n        return;\n    }\n    if (refresh === 'list') {\n        await client.invalidateQueries({ queryKey: queryKeys.resource(resource) });\n        return;\n    }\n    const ids = selection !== undefined && 'ids' in selection ? (selection.ids as string[]) : null;\n    await Promise.all([\n        client.invalidateQueries({ queryKey: queryKeys.lists(resource) }),\n        ...(ids === null\n            ? [client.invalidateQueries({ queryKey: queryKeys.items(resource) })]\n            : ids.map((id) =>\n                  client.invalidateQueries({ queryKey: queryKeys.item(resource, id) }),\n              )),\n    ]);\n}\n"],"mappings":";;;;;;;;;;AAcA,eAAsB,uBAClB,QACA,UACA,QACA,WACa;CACb,MAAM,UAAU,OAAO,WAAW;CAClC,IAAI,YAAY,QACZ;CAEJ,IAAI,YAAY,QAAQ;EACpB,MAAM,OAAO,kBAAkB,EAAE,UAAU,UAAU,SAAS,QAAQ,EAAE,CAAC;EACzE;CACJ;CACA,MAAM,MAAM,cAAc,KAAA,KAAa,SAAS,YAAa,UAAU,MAAmB;CAC1F,MAAM,QAAQ,IAAI,CACd,OAAO,kBAAkB,EAAE,UAAU,UAAU,MAAM,QAAQ,EAAE,CAAC,GAChE,GAAI,QAAQ,OACN,CAAC,OAAO,kBAAkB,EAAE,UAAU,UAAU,MAAM,QAAQ,EAAE,CAAC,CAAC,IAClE,IAAI,KAAK,OACL,OAAO,kBAAkB,EAAE,UAAU,UAAU,KAAK,UAAU,EAAE,EAAE,CAAC,CACvE,CAAE,CACX;AACL"}

package/dist/rest.d.ts

@@ -0,0 +1,25 @@
+import { type Problem } from '@panneau/protocol';
+import type { DataAdapter } from './adapter';
+import { type ApiError } from './errors';
+export interface RestAdapterOptions {
+    /** URL of the API, as `api.baseUrl` in the definition (`/panneau/api`). */
+    baseUrl: string;
+    /** The `fetch` function to use. Defaults to the global one. */
+    fetch?: (input: string, init: RequestInit) => Promise<Response>;
+    /** Headers added to every request, or a function that returns them for each request. */
+    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
+    /** Whether requests send cookies (`fetch`'s `credentials`). */
+    credentials?: RequestCredentials;
+    /**
+     * Creates the error of a failed response. Return `undefined` to use the default mapping from
+     * the status (`createApiError()`). The Laravel preset uses it for `419`.
+     */
+    createError?: (problem: Problem, response: Response) => ApiError | undefined;
+}
+/**
+ * A `DataAdapter` over the HTTP API of the protocol. Errors (`application/problem+json`) reject
+ * with typed errors, updates send `If-Match` from the item version, and list queries use the
+ * protocol's query string format.
+ */
+export declare function createRestAdapter(options: RestAdapterOptions): DataAdapter;
+//# sourceMappingURL=rest.d.ts.map

package/dist/rest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.d.ts","sourceRoot":"","sources":["../src/rest.ts"],"names":[],"mappings":"AAAA,OAAO,EAMH,KAAK,OAAO,EAIf,MAAM,mBAAmB,CAAC;AAU3B,OAAO,KAAK,EAAkB,WAAW,EAAU,MAAM,WAAW,CAAC;AACrE,OAAO,EAAE,KAAK,QAAQ,EAAwC,MAAM,UAAU,CAAC;AAE/E,MAAM,WAAW,kBAAkB;IAC/B,2EAA2E;IAC3E,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAChE,wFAAwF;IACxF,OAAO,CAAC,EAAE,WAAW,GAAG,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IACnE,+DAA+D;IAC/D,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,KAAK,QAAQ,GAAG,SAAS,CAAC;CAChF;AAuFD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAiM1E"}

package/dist/rest.js

@@ -0,0 +1,243 @@
+import { InvalidResponseError, createApiError } from "./errors.js";
+import { ActionResult, ActionRun, Definition, PROBLEM_CONTENT_TYPE, isProblem, toSearchParams, validate } from "@panneau/protocol";
+//#region src/rest.ts
+var ACCEPT = `application/json, ${PROBLEM_CONTENT_TYPE}`;
+function isBlob(value) {
+	return typeof Blob !== "undefined" && value instanceof Blob;
+}
+function hasBlob(value) {
+	if (isBlob(value)) return true;
+	if (Array.isArray(value)) return value.some(hasBlob);
+	if (value !== null && typeof value === "object") return Object.values(value).some(hasBlob);
+	return false;
+}
+/** Appends a value to form data with bracket keys: `values[tags][]`, `selection[ids][]`. */
+function appendFormData(data, key, value) {
+	if (value === void 0) return;
+	if (isBlob(value)) data.append(key, value);
+	else if (Array.isArray(value)) value.forEach((item) => appendFormData(data, `${key}[]`, item));
+	else if (value !== null && typeof value === "object") Object.entries(value).forEach(([name, item]) => appendFormData(data, key === "" ? name : `${key}[${name}]`, item));
+	else if (typeof value === "boolean") data.append(key, value ? "1" : "0");
+	else data.append(key, value === null ? "" : String(value));
+}
+function encode(path) {
+	return encodeURIComponent(path);
+}
+/** Builds the problem of a failed response, from its body when it is one. */
+async function readProblem(response) {
+	const body = await response.clone().json().catch(() => null);
+	if (isProblem(body)) return body;
+	const record = body !== null && typeof body === "object" ? body : {};
+	const problem = {
+		type: "about:blank",
+		title: typeof record.title === "string" ? record.title : typeof record.message === "string" ? record.message : response.statusText || `HTTP ${response.status}`,
+		status: response.status
+	};
+	const errors = record.errors;
+	if (errors !== null && typeof errors === "object" && !Array.isArray(errors)) problem.errors = Object.fromEntries(Object.entries(errors).map(([path, messages]) => [path, (Array.isArray(messages) ? messages : [messages]).map(String)]));
+	return problem;
+}
+/**
+* A `DataAdapter` over the HTTP API of the protocol. Errors (`application/problem+json`) reject
+* with typed errors, updates send `If-Match` from the item version, and list queries use the
+* protocol's query string format.
+*/
+function createRestAdapter(options) {
+	const baseUrl = options.baseUrl.replace(/\/+$/, "");
+	const fetcher = options.fetch ?? ((input, init) => globalThis.fetch(input, init));
+	const send = async ({ method = "GET", path, query, body, headers: requestHeaders, signal }) => {
+		const headers = new Headers(typeof options.headers === "function" ? await options.headers() : options.headers);
+		headers.set("Accept", ACCEPT);
+		new Headers(requestHeaders).forEach((value, name) => headers.set(name, value));
+		let payload;
+		if (body !== void 0) {
+			if (hasBlob(body)) {
+				const data = new FormData();
+				appendFormData(data, "", body);
+				payload = data;
+			} else {
+				headers.set("Content-Type", "application/json");
+				payload = JSON.stringify(body);
+			}
+		}
+		const search = query?.toString() ?? "";
+		const init = {
+			method,
+			headers
+		};
+		if (payload !== void 0) init.body = payload;
+		if (options.credentials !== void 0) init.credentials = options.credentials;
+		if (signal !== void 0) init.signal = signal;
+		const response = await fetcher(`${baseUrl}${path}${search !== "" ? `?${search}` : ""}`, init);
+		if (!response.ok) {
+			const problem = await readProblem(response);
+			throw options.createError?.(problem, response) ?? createApiError(problem);
+		}
+		return response;
+	};
+	const json = async (request) => {
+		return await (await send(request)).json();
+	};
+	const data = async (request) => (await json(request)).data;
+	return {
+		async getDefinition({ signal } = {}) {
+			const body = await json({
+				path: "/definition",
+				signal
+			});
+			const result = validate(Definition, body);
+			if (!result.success) throw new InvalidResponseError("The definition is invalid.", result.issues);
+			return result.data;
+		},
+		list(resource, query = {}, { signal } = {}) {
+			return json({
+				path: `/resources/${encode(resource)}`,
+				query: toSearchParams(query),
+				signal
+			});
+		},
+		get(resource, id, { signal } = {}) {
+			return data({
+				path: `/resources/${encode(resource)}/${encode(id)}`,
+				signal
+			});
+		},
+		create(resource, values, { signal } = {}) {
+			return data({
+				method: "POST",
+				path: `/resources/${encode(resource)}`,
+				body: values,
+				signal
+			});
+		},
+		update(resource, id, values, { version, signal } = {}) {
+			return data({
+				method: "PATCH",
+				path: `/resources/${encode(resource)}/${encode(id)}`,
+				body: values,
+				headers: version !== void 0 && version !== null ? { "If-Match": `"${version}"` } : {},
+				signal
+			});
+		},
+		async delete(resource, id, { signal } = {}) {
+			await send({
+				method: "DELETE",
+				path: `/resources/${encode(resource)}/${encode(id)}`,
+				signal
+			});
+		},
+		async runAction(resource, action, request, { signal } = {}) {
+			const response = await send({
+				method: "POST",
+				path: `/resources/${encode(resource)}/actions/${encode(action)}`,
+				body: request,
+				signal
+			});
+			const body = response.status === 204 ? {} : await response.json();
+			if (response.status === 202) {
+				const run = validate(ActionRun, body.run);
+				if (!run.success) throw new InvalidResponseError("The action run is invalid.", run.issues);
+				return { run: run.data };
+			}
+			const result = validate(ActionResult, body);
+			if (!result.success) throw new InvalidResponseError("The action result is invalid.", result.issues);
+			return { result: result.data };
+		},
+		async getActionRun(id, { signal } = {}) {
+			return (await json({
+				path: `/actions/runs/${encode(id)}`,
+				signal
+			})).run;
+		},
+		listActionRuns({ signal } = {}) {
+			return data({
+				path: "/actions/runs",
+				signal
+			});
+		},
+		async cancelActionRun(id, { signal } = {}) {
+			await send({
+				method: "DELETE",
+				path: `/actions/runs/${encode(id)}`,
+				signal
+			});
+		},
+		listMedia(query = {}, { signal } = {}) {
+			return json({
+				path: "/media",
+				query: toSearchParams(query),
+				signal
+			});
+		},
+		getMedia(id, { signal } = {}) {
+			return data({
+				path: `/media/${encode(id)}`,
+				signal
+			});
+		},
+		uploadMedia(file, values = {}, { signal } = {}) {
+			return data({
+				method: "POST",
+				path: "/media",
+				body: {
+					...values,
+					file
+				},
+				signal
+			});
+		},
+		updateMedia(id, values, { signal } = {}) {
+			return data({
+				method: "PATCH",
+				path: `/media/${encode(id)}`,
+				body: values,
+				signal
+			});
+		},
+		async deleteMedia(id, { signal } = {}) {
+			await send({
+				method: "DELETE",
+				path: `/media/${encode(id)}`,
+				signal
+			});
+		},
+		getSession({ signal } = {}) {
+			return json({
+				path: "/auth/session",
+				signal
+			});
+		},
+		login(credentials, { signal } = {}) {
+			return json({
+				method: "POST",
+				path: "/auth/login",
+				body: credentials,
+				signal
+			});
+		},
+		async logout({ signal } = {}) {
+			await send({
+				method: "POST",
+				path: "/auth/logout",
+				signal
+			});
+		},
+		search(q, { signal } = {}) {
+			return json({
+				path: "/search",
+				query: new URLSearchParams({ q }),
+				signal
+			});
+		},
+		getWidgetData(widget, { signal } = {}) {
+			return json({
+				path: `/dashboard/widgets/${encode(widget)}`,
+				signal
+			});
+		}
+	};
+}
+//#endregion
+export { createRestAdapter };
+
+//# sourceMappingURL=rest.js.map

package/dist/rest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.js","names":[],"sources":["../src/rest.ts"],"sourcesContent":["import {\n    ActionResult,\n    ActionRun,\n    Definition,\n    type ListQuery,\n    PROBLEM_CONTENT_TYPE,\n    type Problem,\n    isProblem,\n    toSearchParams,\n    validate,\n} from '@panneau/protocol';\nimport type {\n    Item,\n    ListResponse,\n    Media,\n    MediaListResponse,\n    SearchResponse,\n    Session,\n} from '@panneau/protocol';\n\nimport type { ActionResponse, DataAdapter, Values } from './adapter';\nimport { type ApiError, InvalidResponseError, createApiError } from './errors';\n\nexport interface RestAdapterOptions {\n    /** URL of the API, as `api.baseUrl` in the definition (`/panneau/api`). */\n    baseUrl: string;\n    /** The `fetch` function to use. Defaults to the global one. */\n    fetch?: (input: string, init: RequestInit) => Promise<Response>;\n    /** Headers added to every request, or a function that returns them for each request. */\n    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);\n    /** Whether requests send cookies (`fetch`'s `credentials`). */\n    credentials?: RequestCredentials;\n    /**\n     * Creates the error of a failed response. Return `undefined` to use the default mapping from\n     * the status (`createApiError()`). The Laravel preset uses it for `419`.\n     */\n    createError?: (problem: Problem, response: Response) => ApiError | undefined;\n}\n\ninterface Request {\n    method?: string;\n    path: string;\n    query?: URLSearchParams;\n    body?: unknown;\n    headers?: HeadersInit;\n    signal?: AbortSignal | undefined;\n}\n\nconst ACCEPT = `application/json, ${PROBLEM_CONTENT_TYPE}`;\n\nfunction isBlob(value: unknown): value is Blob {\n    return typeof Blob !== 'undefined' && value instanceof Blob;\n}\n\nfunction hasBlob(value: unknown): boolean {\n    if (isBlob(value)) {\n        return true;\n    }\n    if (Array.isArray(value)) {\n        return value.some(hasBlob);\n    }\n    if (value !== null && typeof value === 'object') {\n        return Object.values(value).some(hasBlob);\n    }\n    return false;\n}\n\n/** Appends a value to form data with bracket keys: `values[tags][]`, `selection[ids][]`. */\nfunction appendFormData(data: FormData, key: string, value: unknown) {\n    if (value === undefined) {\n        return;\n    }\n    if (isBlob(value)) {\n        data.append(key, value);\n    } else if (Array.isArray(value)) {\n        value.forEach((item) => appendFormData(data, `${key}[]`, item));\n    } else if (value !== null && typeof value === 'object') {\n        Object.entries(value).forEach(([name, item]) =>\n            appendFormData(data, key === '' ? name : `${key}[${name}]`, item),\n        );\n    } else if (typeof value === 'boolean') {\n        data.append(key, value ? '1' : '0');\n    } else {\n        data.append(key, value === null ? '' : String(value));\n    }\n}\n\nfunction encode(path: string): string {\n    return encodeURIComponent(path);\n}\n\n/** Builds the problem of a failed response, from its body when it is one. */\nasync function readProblem(response: Response): Promise<Problem> {\n    const body: unknown = await response\n        .clone()\n        .json()\n        .catch(() => null);\n    if (isProblem(body)) {\n        return body;\n    }\n    const record =\n        body !== null && typeof body === 'object' ? (body as Record<string, unknown>) : {};\n    const problem: Problem = {\n        type: 'about:blank',\n        title:\n            typeof record.title === 'string'\n                ? record.title\n                : typeof record.message === 'string'\n                  ? record.message\n                  : response.statusText || `HTTP ${response.status}`,\n        status: response.status,\n    };\n    const errors = record.errors;\n    if (errors !== null && typeof errors === 'object' && !Array.isArray(errors)) {\n        problem.errors = Object.fromEntries(\n            Object.entries(errors).map(([path, messages]) => [\n                path,\n                (Array.isArray(messages) ? messages : [messages]).map(String),\n            ]),\n        );\n    }\n    return problem;\n}\n\n/**\n * A `DataAdapter` over the HTTP API of the protocol. Errors (`application/problem+json`) reject\n * with typed errors, updates send `If-Match` from the item version, and list queries use the\n * protocol's query string format.\n */\nexport function createRestAdapter(options: RestAdapterOptions): DataAdapter {\n    const baseUrl = options.baseUrl.replace(/\\/+$/, '');\n    const fetcher = options.fetch ?? ((input, init) => globalThis.fetch(input, init));\n\n    const send = async ({\n        method = 'GET',\n        path,\n        query,\n        body,\n        headers: requestHeaders,\n        signal,\n    }: Request): Promise<Response> => {\n        const headers = new Headers(\n            typeof options.headers === 'function' ? await options.headers() : options.headers,\n        );\n        headers.set('Accept', ACCEPT);\n        new Headers(requestHeaders).forEach((value, name) => headers.set(name, value));\n\n        let payload: BodyInit | undefined;\n        if (body !== undefined) {\n            if (hasBlob(body)) {\n                const data = new FormData();\n                appendFormData(data, '', body);\n                payload = data;\n            } else {\n                headers.set('Content-Type', 'application/json');\n                payload = JSON.stringify(body);\n            }\n        }\n\n        const search = query?.toString() ?? '';\n        const init: RequestInit = { method, headers };\n        if (payload !== undefined) {\n            init.body = payload;\n        }\n        if (options.credentials !== undefined) {\n            init.credentials = options.credentials;\n        }\n        if (signal !== undefined) {\n            init.signal = signal;\n        }\n        const response = await fetcher(\n            `${baseUrl}${path}${search !== '' ? `?${search}` : ''}`,\n            init,\n        );\n        if (!response.ok) {\n            const problem = await readProblem(response);\n            throw options.createError?.(problem, response) ?? createApiError(problem);\n        }\n        return response;\n    };\n\n    const json = async <T>(request: Request): Promise<T> => {\n        const response = await send(request);\n        return (await response.json()) as T;\n    };\n\n    const data = async <T>(request: Request): Promise<T> => (await json<{ data: T }>(request)).data;\n\n    return {\n        async getDefinition({ signal } = {}) {\n            const body = await json<unknown>({ path: '/definition', signal });\n            const result = validate(Definition, body);\n            if (!result.success) {\n                throw new InvalidResponseError('The definition is invalid.', result.issues);\n            }\n            return result.data;\n        },\n\n        list(resource, query: ListQuery = {}, { signal } = {}) {\n            return json<ListResponse>({\n                path: `/resources/${encode(resource)}`,\n                query: toSearchParams(query),\n                signal,\n            });\n        },\n        get(resource, id, { signal } = {}) {\n            return data<Item>({ path: `/resources/${encode(resource)}/${encode(id)}`, signal });\n        },\n        create(resource, values, { signal } = {}) {\n            return data<Item>({\n                method: 'POST',\n                path: `/resources/${encode(resource)}`,\n                body: values,\n                signal,\n            });\n        },\n        update(resource, id, values, { version, signal } = {}) {\n            return data<Item>({\n                method: 'PATCH',\n                path: `/resources/${encode(resource)}/${encode(id)}`,\n                body: values,\n                headers:\n                    version !== undefined && version !== null ? { 'If-Match': `\"${version}\"` } : {},\n                signal,\n            });\n        },\n        async delete(resource, id, { signal } = {}) {\n            await send({\n                method: 'DELETE',\n                path: `/resources/${encode(resource)}/${encode(id)}`,\n                signal,\n            });\n        },\n\n        async runAction(resource, action, request, { signal } = {}) {\n            const response = await send({\n                method: 'POST',\n                path: `/resources/${encode(resource)}/actions/${encode(action)}`,\n                body: request,\n                signal,\n            });\n            const body: unknown = response.status === 204 ? {} : await response.json();\n            if (response.status === 202) {\n                const run = validate(ActionRun, (body as { run?: unknown }).run);\n                if (!run.success) {\n                    throw new InvalidResponseError('The action run is invalid.', run.issues);\n                }\n                return { run: run.data } satisfies ActionResponse;\n            }\n            const result = validate(ActionResult, body);\n            if (!result.success) {\n                throw new InvalidResponseError('The action result is invalid.', result.issues);\n            }\n            return { result: result.data } satisfies ActionResponse;\n        },\n        async getActionRun(id, { signal } = {}) {\n            return (await json<{ run: ActionRun }>({ path: `/actions/runs/${encode(id)}`, signal }))\n                .run;\n        },\n        listActionRuns({ signal } = {}) {\n            return data<ActionRun[]>({ path: '/actions/runs', signal });\n        },\n        async cancelActionRun(id, { signal } = {}) {\n            await send({ method: 'DELETE', path: `/actions/runs/${encode(id)}`, signal });\n        },\n\n        listMedia(query: ListQuery = {}, { signal } = {}) {\n            return json<MediaListResponse>({\n                path: '/media',\n                query: toSearchParams(query),\n                signal,\n            });\n        },\n        getMedia(id, { signal } = {}) {\n            return data<Media>({ path: `/media/${encode(id)}`, signal });\n        },\n        uploadMedia(file, values: Values = {}, { signal } = {}) {\n            return data<Media>({\n                method: 'POST',\n                path: '/media',\n                body: { ...values, file },\n                signal,\n            });\n        },\n        updateMedia(id, values, { signal } = {}) {\n            return data<Media>({\n                method: 'PATCH',\n                path: `/media/${encode(id)}`,\n                body: values,\n                signal,\n            });\n        },\n        async deleteMedia(id, { signal } = {}) {\n            await send({ method: 'DELETE', path: `/media/${encode(id)}`, signal });\n        },\n\n        getSession({ signal } = {}) {\n            return json<Session>({ path: '/auth/session', signal });\n        },\n        login(credentials, { signal } = {}) {\n            return json<Session>({\n                method: 'POST',\n                path: '/auth/login',\n                body: credentials,\n                signal,\n            });\n        },\n        async logout({ signal } = {}) {\n            await send({ method: 'POST', path: '/auth/logout', signal });\n        },\n\n        search(q, { signal } = {}) {\n            return json<SearchResponse>({\n                path: '/search',\n                query: new URLSearchParams({ q }),\n                signal,\n            });\n        },\n        getWidgetData(widget, { signal } = {}) {\n            return json<unknown>({ path: `/dashboard/widgets/${encode(widget)}`, signal });\n        },\n    };\n}\n"],"mappings":";;;AAgDA,IAAM,SAAS,qBAAqB;AAEpC,SAAS,OAAO,OAA+B;CAC3C,OAAO,OAAO,SAAS,eAAe,iBAAiB;AAC3D;AAEA,SAAS,QAAQ,OAAyB;CACtC,IAAI,OAAO,KAAK,GACZ,OAAO;CAEX,IAAI,MAAM,QAAQ,KAAK,GACnB,OAAO,MAAM,KAAK,OAAO;CAE7B,IAAI,UAAU,QAAQ,OAAO,UAAU,UACnC,OAAO,OAAO,OAAO,KAAK,CAAC,CAAC,KAAK,OAAO;CAE5C,OAAO;AACX;;AAGA,SAAS,eAAe,MAAgB,KAAa,OAAgB;CACjE,IAAI,UAAU,KAAA,GACV;CAEJ,IAAI,OAAO,KAAK,GACZ,KAAK,OAAO,KAAK,KAAK;MACnB,IAAI,MAAM,QAAQ,KAAK,GAC1B,MAAM,SAAS,SAAS,eAAe,MAAM,GAAG,IAAG,KAAM,IAAI,CAAC;MAC3D,IAAI,UAAU,QAAQ,OAAO,UAAU,UAC1C,OAAO,QAAQ,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,UAClC,eAAe,MAAM,QAAQ,KAAK,OAAO,GAAG,IAAG,GAAI,KAAI,IAAK,IAAI,CACpE;MACG,IAAI,OAAO,UAAU,WACxB,KAAK,OAAO,KAAK,QAAQ,MAAM,GAAG;MAElC,KAAK,OAAO,KAAK,UAAU,OAAO,KAAK,OAAO,KAAK,CAAC;AAE5D;AAEA,SAAS,OAAO,MAAsB;CAClC,OAAO,mBAAmB,IAAI;AAClC;;AAGA,eAAe,YAAY,UAAsC;CAC7D,MAAM,OAAgB,MAAM,SACvB,MAAM,CAAC,CACP,KAAK,CAAC,CACN,YAAY,IAAI;CACrB,IAAI,UAAU,IAAI,GACd,OAAO;CAEX,MAAM,SACF,SAAS,QAAQ,OAAO,SAAS,WAAY,OAAmC,CAAC;CACrF,MAAM,UAAmB;EACrB,MAAM;EACN,OACI,OAAO,OAAO,UAAU,WAClB,OAAO,QACP,OAAO,OAAO,YAAY,WACxB,OAAO,UACP,SAAS,cAAc,QAAQ,SAAS;EACpD,QAAQ,SAAS;CACrB;CACA,MAAM,SAAS,OAAO;CACtB,IAAI,WAAW,QAAQ,OAAO,WAAW,YAAY,CAAC,MAAM,QAAQ,MAAM,GACtE,QAAQ,SAAS,OAAO,YACpB,OAAO,QAAQ,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,cAAc,CAC7C,OACC,MAAM,QAAQ,QAAQ,IAAI,WAAW,CAAC,QAAQ,EAAA,CAAG,IAAI,MAAM,CAAC,CAChE,CACL;CAEJ,OAAO;AACX;;;;;;AAOA,SAAgB,kBAAkB,SAA0C;CACxE,MAAM,UAAU,QAAQ,QAAQ,QAAQ,QAAQ,EAAE;CAClD,MAAM,UAAU,QAAQ,WAAW,OAAO,SAAS,WAAW,MAAM,OAAO,IAAI;CAE/E,MAAM,OAAO,OAAO,EAChB,SAAS,OACT,MACA,OACA,MACA,SAAS,gBACT,aAC8B;EAC9B,MAAM,UAAU,IAAI,QAChB,OAAO,QAAQ,YAAY,aAAa,MAAM,QAAQ,QAAQ,IAAI,QAAQ,OAC9E;EACA,QAAQ,IAAI,UAAU,MAAM;EAC5B,IAAI,QAAQ,cAAc,CAAC,CAAC,SAAS,OAAO,SAAS,QAAQ,IAAI,MAAM,KAAK,CAAC;EAE7E,IAAI;EACJ,IAAI,SAAS,KAAA,GAAW;GACpB,IAAI,QAAQ,IAAI,GAAG;IACf,MAAM,OAAO,IAAI,SAAS;IAC1B,eAAe,MAAM,IAAI,IAAI;IAC7B,UAAU;GACd,OAAO;IACH,QAAQ,IAAI,gBAAgB,kBAAkB;IAC9C,UAAU,KAAK,UAAU,IAAI;GACjC;EACJ;EAEA,MAAM,SAAS,OAAO,SAAS,KAAK;EACpC,MAAM,OAAoB;GAAE;GAAQ;EAAQ;EAC5C,IAAI,YAAY,KAAA,GACZ,KAAK,OAAO;EAEhB,IAAI,QAAQ,gBAAgB,KAAA,GACxB,KAAK,cAAc,QAAQ;EAE/B,IAAI,WAAW,KAAA,GACX,KAAK,SAAS;EAElB,MAAM,WAAW,MAAM,QACnB,GAAG,UAAU,OAAO,WAAW,KAAK,IAAI,WAAW,MACnD,IACJ;EACA,IAAI,CAAC,SAAS,IAAI;GACd,MAAM,UAAU,MAAM,YAAY,QAAQ;GAC1C,MAAM,QAAQ,cAAc,SAAS,QAAQ,KAAK,eAAe,OAAO;EAC5E;EACA,OAAO;CACX;CAEA,MAAM,OAAO,OAAU,YAAiC;EAEpD,OAAQ,OAAM,MADS,KAAK,OAAO,EAAA,CACZ,KAAK;CAChC;CAEA,MAAM,OAAO,OAAU,aAAkC,MAAM,KAAkB,OAAO,EAAA,CAAG;CAE3F,OAAO;EACH,MAAM,cAAc,EAAE,WAAW,CAAC,GAAG;GACjC,MAAM,OAAO,MAAM,KAAc;IAAE,MAAM;IAAe;GAAO,CAAC;GAChE,MAAM,SAAS,SAAS,YAAY,IAAI;GACxC,IAAI,CAAC,OAAO,SACR,MAAM,IAAI,qBAAqB,8BAA8B,OAAO,MAAM;GAE9E,OAAO,OAAO;EAClB;EAEA,KAAK,UAAU,QAAmB,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG;GACnD,OAAO,KAAmB;IACtB,MAAM,cAAc,OAAO,QAAQ;IACnC,OAAO,eAAe,KAAK;IAC3B;GACJ,CAAC;EACL;EACA,IAAI,UAAU,IAAI,EAAE,WAAW,CAAC,GAAG;GAC/B,OAAO,KAAW;IAAE,MAAM,cAAc,OAAO,QAAQ,EAAC,GAAI,OAAO,EAAE;IAAK;GAAO,CAAC;EACtF;EACA,OAAO,UAAU,QAAQ,EAAE,WAAW,CAAC,GAAG;GACtC,OAAO,KAAW;IACd,QAAQ;IACR,MAAM,cAAc,OAAO,QAAQ;IACnC,MAAM;IACN;GACJ,CAAC;EACL;EACA,OAAO,UAAU,IAAI,QAAQ,EAAE,SAAS,WAAW,CAAC,GAAG;GACnD,OAAO,KAAW;IACd,QAAQ;IACR,MAAM,cAAc,OAAO,QAAQ,EAAC,GAAI,OAAO,EAAE;IACjD,MAAM;IACN,SACI,YAAY,KAAA,KAAa,YAAY,OAAO,EAAE,YAAY,IAAI,QAAO,GAAI,IAAI,CAAC;IAClF;GACJ,CAAC;EACL;EACA,MAAM,OAAO,UAAU,IAAI,EAAE,WAAW,CAAC,GAAG;GACxC,MAAM,KAAK;IACP,QAAQ;IACR,MAAM,cAAc,OAAO,QAAQ,EAAC,GAAI,OAAO,EAAE;IACjD;GACJ,CAAC;EACL;EAEA,MAAM,UAAU,UAAU,QAAQ,SAAS,EAAE,WAAW,CAAC,GAAG;GACxD,MAAM,WAAW,MAAM,KAAK;IACxB,QAAQ;IACR,MAAM,cAAc,OAAO,QAAQ,EAAC,WAAY,OAAO,MAAM;IAC7D,MAAM;IACN;GACJ,CAAC;GACD,MAAM,OAAgB,SAAS,WAAW,MAAM,CAAC,IAAI,MAAM,SAAS,KAAK;GACzE,IAAI,SAAS,WAAW,KAAK;IACzB,MAAM,MAAM,SAAS,WAAY,KAA2B,GAAG;IAC/D,IAAI,CAAC,IAAI,SACL,MAAM,IAAI,qBAAqB,8BAA8B,IAAI,MAAM;IAE3E,OAAO,EAAE,KAAK,IAAI,KAAK;GAC3B;GACA,MAAM,SAAS,SAAS,cAAc,IAAI;GAC1C,IAAI,CAAC,OAAO,SACR,MAAM,IAAI,qBAAqB,iCAAiC,OAAO,MAAM;GAEjF,OAAO,EAAE,QAAQ,OAAO,KAAK;EACjC;EACA,MAAM,aAAa,IAAI,EAAE,WAAW,CAAC,GAAG;GACpC,QAAQ,MAAM,KAAyB;IAAE,MAAM,iBAAiB,OAAO,EAAE;IAAK;GAAO,CAAC,EAAA,CACjF;EACT;EACA,eAAe,EAAE,WAAW,CAAC,GAAG;GAC5B,OAAO,KAAkB;IAAE,MAAM;IAAiB;GAAO,CAAC;EAC9D;EACA,MAAM,gBAAgB,IAAI,EAAE,WAAW,CAAC,GAAG;GACvC,MAAM,KAAK;IAAE,QAAQ;IAAU,MAAM,iBAAiB,OAAO,EAAE;IAAK;GAAO,CAAC;EAChF;EAEA,UAAU,QAAmB,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG;GAC9C,OAAO,KAAwB;IAC3B,MAAM;IACN,OAAO,eAAe,KAAK;IAC3B;GACJ,CAAC;EACL;EACA,SAAS,IAAI,EAAE,WAAW,CAAC,GAAG;GAC1B,OAAO,KAAY;IAAE,MAAM,UAAU,OAAO,EAAE;IAAK;GAAO,CAAC;EAC/D;EACA,YAAY,MAAM,SAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG;GACpD,OAAO,KAAY;IACf,QAAQ;IACR,MAAM;IACN,MAAM;KAAE,GAAG;KAAQ;IAAK;IACxB;GACJ,CAAC;EACL;EACA,YAAY,IAAI,QAAQ,EAAE,WAAW,CAAC,GAAG;GACrC,OAAO,KAAY;IACf,QAAQ;IACR,MAAM,UAAU,OAAO,EAAE;IACzB,MAAM;IACN;GACJ,CAAC;EACL;EACA,MAAM,YAAY,IAAI,EAAE,WAAW,CAAC,GAAG;GACnC,MAAM,KAAK;IAAE,QAAQ;IAAU,MAAM,UAAU,OAAO,EAAE;IAAK;GAAO,CAAC;EACzE;EAEA,WAAW,EAAE,WAAW,CAAC,GAAG;GACxB,OAAO,KAAc;IAAE,MAAM;IAAiB;GAAO,CAAC;EAC1D;EACA,MAAM,aAAa,EAAE,WAAW,CAAC,GAAG;GAChC,OAAO,KAAc;IACjB,QAAQ;IACR,MAAM;IACN,MAAM;IACN;GACJ,CAAC;EACL;EACA,MAAM,OAAO,EAAE,WAAW,CAAC,GAAG;GAC1B,MAAM,KAAK;IAAE,QAAQ;IAAQ,MAAM;IAAgB;GAAO,CAAC;EAC/D;EAEA,OAAO,GAAG,EAAE,WAAW,CAAC,GAAG;GACvB,OAAO,KAAqB;IACxB,MAAM;IACN,OAAO,IAAI,gBAAgB,EAAE,EAAE,CAAC;IAChC;GACJ,CAAC;EACL;EACA,cAAc,QAAQ,EAAE,WAAW,CAAC,GAAG;GACnC,OAAO,KAAc;IAAE,MAAM,sBAAsB,OAAO,MAAM;IAAK;GAAO,CAAC;EACjF;CACJ;AACJ"}

package/package.json

@@ -1,75 +1,60 @@
 {
     "name": "@panneau/data",
-    "version": "4.1.0",
-    "description": "",
-    "keywords": [
-        "javascript"
-    ],
-    "homepage": "https://github.com/folkloreinc/panneau-js",
+    "version": "5.0.0-alpha.0",
+    "description": "The data layer of Panneau: the DataAdapter interface, the REST adapter of the protocol, its Laravel preset and TanStack Query hooks.",
+    "type": "module",
+    "license": "MIT",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/folkloreinc/panneau-js.git"
+        "url": "git+https://github.com/folkloreinc/panneau-js.git",
+        "directory": "packages/data"
     },
-    "license": "ISC",
-    "author": {
-        "name": "Folklore",
-        "email": "info@folklore.email"
-    },
-    "contributors": [
-        {
-            "name": "David Mongeau-Petitpas",
-            "email": "dmp@folklore.email"
-        },
-        {
-            "name": "Nicolas Roy-Bourdages",
-            "email": "nrb@folklore.email"
-        },
-        {
-            "name": "Julien Carignan",
-            "email": "jc@folklore.email"
-        },
-        {
-            "name": "Théo Gjini",
-            "email": "tg@folklore.email"
-        }
-    ],
     "sideEffects": false,
-    "type": "module",
     "exports": {
         ".": {
+            "@panneau/source": "./src/index.ts",
             "types": "./dist/index.d.ts",
             "default": "./dist/index.js"
-        }
+        },
+        "./laravel": {
+            "@panneau/source": "./src/laravel/index.ts",
+            "types": "./dist/laravel/index.d.ts",
+            "default": "./dist/laravel/index.js"
+        },
+        "./query": {
+            "@panneau/source": "./src/query/index.ts",
+            "types": "./dist/query/index.d.ts",
+            "default": "./dist/query/index.js"
+        },
+        "./package.json": "./package.json"
     },
-    "module": "dist/index.js",
-    "types": "dist/index.d.ts",
     "files": [
-        "dist",
-        "assets"
+        "dist"
     ],
     "scripts": {
-        "build": "../../scripts/prepare-package.sh --types",
-        "prepublishOnly": "npm run build"
+        "build": "vite build && tsc -p tsconfig.build.json",
+        "typecheck": "tsc --noEmit",
+        "api": "tsc -p tsconfig.build.json && node ../../scripts/api-report.js"
     },
-    "dependencies": {
-        "@babel/runtime": "^7.28.6",
-        "@folklore/fetch": "^0.1.21",
-        "@folklore/routes": "^0.4.11",
-        "@panneau/core": "^4.1.0",
-        "@tanstack/react-query": "^5.100.9",
-        "lodash-es": "^4.17.21",
-        "query-string": "^9.0.0"
-    },
-    "devDependencies": {
-        "react": "^19.2.0",
-        "react-dom": "^19.0.0"
+    "publishConfig": {
+        "access": "public"
     },
     "peerDependencies": {
-        "react": "^19.2.0",
-        "react-dom": "^19.0.0"
+        "@tanstack/react-query": "^5.0.0",
+        "react": "^19.2.0"
     },
-    "publishConfig": {
-        "access": "public"
+    "dependencies": {
+        "@panneau/protocol": "5.0.0-alpha.0"
+    },
+    "peerDependenciesMeta": {
+        "@tanstack/react-query": {
+            "optional": true
+        },
+        "react": {
+            "optional": true
+        }
     },
-    "gitHead": "8a6accc1aab59368bf546c83b9433dfe94ccf767"
+    "devDependencies": {
+        "@panneau/core": "5.0.0-alpha.0"
+    }
 }