@panneau/data 4.1.0 → 5.0.0-alpha.0

package/README.md

@@ -0,0 +1,65 @@
+# @panneau/data
+
+The data layer of Panneau: the `DataAdapter` interface, the REST adapter of the [protocol](../../docs/protocol.md), its Laravel preset and TanStack Query hooks.
+
+```ts
+import { ConflictError, ValidationError, createRestAdapter } from '@panneau/data';
+
+const adapter = createRestAdapter({ baseUrl: '/panneau/api' });
+
+try {
+    await adapter.update('pages', item.id, { title: { fr: 'Accueil' } }, { version: item.version });
+} catch (error) {
+    if (error instanceof ConflictError) {
+        // Someone else saved the item: error.current is the current version.
+    } else if (error instanceof ValidationError) {
+        // error.errors: { 'title.en': ['This field is required.'] }
+    }
+}
+```
+
+| Export                  | Content                                                                                                                                                                                      |
+| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@panneau/data`         | The `DataAdapter` interface, `createRestAdapter()`, and the errors: `ApiError`, `ValidationError`, `ConflictError`, `UnauthorizedError`, `ForbiddenError`, `NotFoundError`                   |
+| `@panneau/data/laravel` | `createLaravelAdapter()`: the REST adapter with credentials, the `X-XSRF-TOKEN` header from Laravel's cookie, and `419` as unauthorized                                                      |
+| `@panneau/data/query`   | `DataAdapterProvider` and the TanStack Query hooks: `useDefinition`, `useResourceList`, `useResourceItem`, `useCreateItem`, `useUpdateItem`, `useDeleteItem`, `useRunAction`, `useActionRun` |
+
+## Adapters
+
+A `DataAdapter` is everything the engine and the app need from a backend: the definition, resources (list, get, create, update, delete), actions and their runs, media, the auth session, search and widget data. Methods reject with an `ApiError` when the backend answers with an error.
+
+- **`createRestAdapter({ baseUrl, fetch, headers, credentials })`** implements the HTTP API of the protocol:
+    - `application/problem+json` errors become typed errors, by status: `401` `UnauthorizedError`, `403` `ForbiddenError`, `404` `NotFoundError`, `412` `ConflictError` (with `current`), `422` `ValidationError` (with `errors` keyed by dot path), others `ApiError`. Responses that are not problems get a problem built from their status;
+    - `update()` sends `If-Match` from the `version` it is given;
+    - list queries use `toSearchParams()` from `@panneau/protocol`;
+    - values that contain a `Blob` (imports, uploads) are sent as `multipart/form-data`.
+- **`createLaravelAdapter()`** is the preset for `laravel-panneau` with session authentication. Laravel specifics stay there, not in the protocol.
+- **A custom adapter** implements `DataAdapter` over another API. A product that only needs a few resources can throw from the methods it doesn't support.
+
+## Query hooks
+
+The hooks need TanStack Query v5 and React (optional peer dependencies, only for this entry point), with a `QueryClientProvider` and a `DataAdapterProvider` above them.
+
+```tsx
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+
+import { DataAdapterProvider, useResourceList, useUpdateItem } from '@panneau/data/query';
+
+<QueryClientProvider client={queryClient}>
+    <DataAdapterProvider adapter={adapter}>
+        <Pages />
+    </DataAdapterProvider>
+</QueryClientProvider>;
+
+function Pages() {
+    const { data } = useResourceList('pages', { sort: ['-published_at'], page: 1 });
+    const update = useUpdateItem('pages');
+    // update.mutate({ id, values, version })
+}
+```
+
+- Mutations update the cache: create and update cache the item and refetch the lists of the resource; delete removes the item and refetches the lists.
+- `useRunAction()` refreshes what the action result asks (`refresh`: `none`, `items` or `list`, the default). A queued action returns a run instead: `useActionRun(run.id)` follows it until it finishes, then refreshes.
+- `queryKeys` and the `*QueryOptions()` functions give the keys and options of the hooks, to prefetch or invalidate their data.
+
+The package layout, scripts and API reports are explained in [`docs/packages.md`](../../docs/packages.md).

package/dist/adapter.d.ts

@@ -0,0 +1,84 @@
+import type { ActionRequest, ActionResult, ActionRun, Definition, Item, ListQuery, ListResponse, Media, MediaListResponse, SearchResponse, Session } from '@panneau/protocol';
+/** Values of an item's fields, keyed by field name. */
+export type Values = Record<string, unknown>;
+export interface RequestOptions {
+    /** Aborts the request. TanStack Query passes one to cancel queries. */
+    signal?: AbortSignal;
+}
+export interface UpdateOptions extends RequestOptions {
+    /**
+     * The version of the item the values were edited from. The update fails with a
+     * `ConflictError` when the item changed since. `null` or omitted: no check.
+     */
+    version?: string | null;
+}
+/** Answer of an action: its result, or a run when the backend queued it (`202`). */
+export type ActionResponse = {
+    result: ActionResult;
+    run?: undefined;
+} | {
+    run: ActionRun;
+    result?: undefined;
+};
+/** Query of the media list: a list query whose filters include `type` and `tags`. */
+export type MediaQuery = ListQuery;
+/** Credentials of a password login. */
+export interface LoginCredentials {
+    email: string;
+    password: string;
+    remember?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Everything Panneau needs from a backend. `createRestAdapter()` implements it over the HTTP API of
+ * the protocol. A product with its own API implements it to use the engine and the app.
+ *
+ * Methods reject with an `ApiError` (or one of its subclasses) when the backend answers with an
+ * error.
+ */
+export interface DataAdapter {
+    /** The definition for the current user (`GET /definition`), with defaults applied. */
+    getDefinition(options?: RequestOptions): Promise<Definition>;
+    /** A page of items of a resource. */
+    list(resource: string, query?: ListQuery, options?: RequestOptions): Promise<ListResponse>;
+    /** One item. */
+    get(resource: string, id: string, options?: RequestOptions): Promise<Item>;
+    /** Creates an item. Rejects with a `ValidationError` when values are invalid. */
+    create(resource: string, values: Values, options?: RequestOptions): Promise<Item>;
+    /**
+     * Updates some values of an item. With a `version`, rejects with a `ConflictError` when the
+     * item changed since that version.
+     */
+    update(resource: string, id: string, values: Values, options?: UpdateOptions): Promise<Item>;
+    /** Deletes an item. */
+    delete(resource: string, id: string, options?: RequestOptions): Promise<void>;
+    /** Runs an action on a selection, or on the whole resource without a selection. */
+    runAction(resource: string, action: string, request: ActionRequest, options?: RequestOptions): Promise<ActionResponse>;
+    /** A run of a queued action, with its progress and, once finished, its result. */
+    getActionRun(id: string, options?: RequestOptions): Promise<ActionRun>;
+    /** The current user's recent runs. */
+    listActionRuns(options?: RequestOptions): Promise<ActionRun[]>;
+    /** Cancels a run that hasn't finished. */
+    cancelActionRun(id: string, options?: RequestOptions): Promise<void>;
+    /** A page of the media library. */
+    listMedia(query?: MediaQuery, options?: RequestOptions): Promise<MediaListResponse>;
+    /** One media item. */
+    getMedia(id: string, options?: RequestOptions): Promise<Media>;
+    /** Uploads a file, with optional metadata. */
+    uploadMedia(file: Blob, values?: Values, options?: RequestOptions): Promise<Media>;
+    /** Updates the metadata or the transform of a media item. */
+    updateMedia(id: string, values: Values, options?: RequestOptions): Promise<Media>;
+    /** Deletes a media item. */
+    deleteMedia(id: string, options?: RequestOptions): Promise<void>;
+    /** The current session. Rejects with an `UnauthorizedError` without one. */
+    getSession(options?: RequestOptions): Promise<Session>;
+    /** Logs in with a password. */
+    login(credentials: LoginCredentials, options?: RequestOptions): Promise<Session>;
+    /** Logs out. */
+    logout(options?: RequestOptions): Promise<void>;
+    /** Searches every searchable resource. */
+    search(q: string, options?: RequestOptions): Promise<SearchResponse>;
+    /** Data of a dashboard widget, in the shape its type defines. */
+    getWidgetData(widget: string, options?: RequestOptions): Promise<unknown>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,aAAa,EACb,YAAY,EACZ,SAAS,EACT,UAAU,EACV,IAAI,EACJ,SAAS,EACT,YAAY,EACZ,KAAK,EACL,iBAAiB,EACjB,cAAc,EACd,OAAO,EACV,MAAM,mBAAmB,CAAC;AAE3B,uDAAuD;AACvD,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE7C,MAAM,WAAW,cAAc;IAC3B,uEAAuE;IACvE,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,WAAW,aAAc,SAAQ,cAAc;IACjD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,oFAAoF;AACpF,MAAM,MAAM,cAAc,GACtB;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,GAAG,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,SAAS,CAAA;CAAE,CAAC;AAEvF,qFAAqF;AACrF,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC;AAEnC,uCAAuC;AACvC,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IACxB,sFAAsF;IACtF,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7D,qCAAqC;IACrC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC3F,gBAAgB;IAChB,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3E,iFAAiF;IACjF,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7F,uBAAuB;IACvB,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E,mFAAmF;IACnF,SAAS,CACL,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,EACtB,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,cAAc,CAAC,CAAC;IAC3B,kFAAkF;IAClF,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACvE,sCAAsC;IACtC,cAAc,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAC/D,0CAA0C;IAC1C,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE,mCAAmC;IACnC,SAAS,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACpF,sBAAsB;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/D,8CAA8C;IAC9C,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACnF,6DAA6D;IAC7D,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IAClF,4BAA4B;IAC5B,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE,4EAA4E;IAC5E,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,+BAA+B;IAC/B,KAAK,CAAC,WAAW,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjF,gBAAgB;IAChB,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD,0CAA0C;IAC1C,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACrE,iEAAiE;IACjE,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC7E"}

package/dist/errors.d.ts

@@ -0,0 +1,51 @@
+import type { Item, Problem, ValidationIssue } from '@panneau/protocol';
+/**
+ * An error response of the API, parsed from `application/problem+json`. Subclasses cover the
+ * statuses a client handles differently. Other statuses (`409`, `429`, `5xx`…) are an `ApiError`.
+ */
+export declare class ApiError extends Error {
+    readonly name: string;
+    /** The HTTP status. */
+    readonly status: number;
+    /** The problem details sent by the backend, or built from the status when it sent none. */
+    readonly problem: Problem;
+    constructor(problem: Problem, options?: ErrorOptions);
+}
+/** `422`: the submitted values are invalid. */
+export declare class ValidationError extends ApiError {
+    readonly name: string;
+    /** Messages keyed by the dot path of the invalid value (`title.fr`, `blocks.2.image`). */
+    readonly errors: Record<string, string[]>;
+    constructor(problem: Problem, options?: ErrorOptions);
+}
+/** `412`: the item changed since the version sent in `If-Match`. */
+export declare class ConflictError extends ApiError {
+    readonly name: string;
+    /** The current version of the item, when the backend sent it. */
+    readonly current: Item | null;
+    constructor(problem: Problem, options?: ErrorOptions);
+}
+/** `401` (or `419` with the Laravel preset): the user is not authenticated. */
+export declare class UnauthorizedError extends ApiError {
+    readonly name: string;
+}
+/** `403`: the user is not allowed to do this. */
+export declare class ForbiddenError extends ApiError {
+    readonly name: string;
+}
+/** `404`: the resource, item or route doesn't exist. */
+export declare class NotFoundError extends ApiError {
+    readonly name: string;
+}
+/** A successful response whose body doesn't match the protocol. */
+export declare class InvalidResponseError extends Error {
+    readonly name: string;
+    /** What doesn't match, with dot paths into the body. */
+    readonly issues: ValidationIssue[];
+    constructor(message: string, issues: ValidationIssue[]);
+}
+/** Creates the error that matches the status of a problem. */
+export declare function createApiError(problem: Problem, options?: ErrorOptions): ApiError;
+/** Whether a value is an error of the API. */
+export declare function isApiError(error: unknown): error is ApiError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAExE;;;GAGG;AACH,qBAAa,QAAS,SAAQ,KAAK;IAC/B,SAAkB,IAAI,EAAE,MAAM,CAAc;IAC5C,uBAAuB;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY;CAKvD;AAED,+CAA+C;AAC/C,qBAAa,eAAgB,SAAQ,QAAQ;IACzC,SAAkB,IAAI,EAAE,MAAM,CAAqB;IACnD,0FAA0F;IAC1F,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;gBAE9B,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY;CAIvD;AAED,oEAAoE;AACpE,qBAAa,aAAc,SAAQ,QAAQ;IACvC,SAAkB,IAAI,EAAE,MAAM,CAAmB;IACjD,iEAAiE;IACjE,QAAQ,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,CAAC;gBAElB,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY;CAIvD;AAED,+EAA+E;AAC/E,qBAAa,iBAAkB,SAAQ,QAAQ;IAC3C,SAAkB,IAAI,EAAE,MAAM,CAAuB;CACxD;AAED,iDAAiD;AACjD,qBAAa,cAAe,SAAQ,QAAQ;IACxC,SAAkB,IAAI,EAAE,MAAM,CAAoB;CACrD;AAED,wDAAwD;AACxD,qBAAa,aAAc,SAAQ,QAAQ;IACvC,SAAkB,IAAI,EAAE,MAAM,CAAmB;CACpD;AAED,mEAAmE;AACnE,qBAAa,oBAAqB,SAAQ,KAAK;IAC3C,SAAkB,IAAI,EAAE,MAAM,CAA0B;IACxD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,CAAC;gBAEvB,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE;CAIzD;AAED,8DAA8D;AAC9D,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,QAAQ,CAejF;AAED,8CAA8C;AAC9C,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAE5D"}

package/dist/errors.js

@@ -0,0 +1,78 @@
+//#region src/errors.ts
+/**
+* An error response of the API, parsed from `application/problem+json`. Subclasses cover the
+* statuses a client handles differently. Other statuses (`409`, `429`, `5xx`…) are an `ApiError`.
+*/
+var ApiError = class extends Error {
+	name = "ApiError";
+	/** The HTTP status. */
+	status;
+	/** The problem details sent by the backend, or built from the status when it sent none. */
+	problem;
+	constructor(problem, options) {
+		super(problem.detail ?? problem.title, options);
+		this.status = problem.status;
+		this.problem = problem;
+	}
+};
+/** `422`: the submitted values are invalid. */
+var ValidationError = class extends ApiError {
+	name = "ValidationError";
+	/** Messages keyed by the dot path of the invalid value (`title.fr`, `blocks.2.image`). */
+	errors;
+	constructor(problem, options) {
+		super(problem, options);
+		this.errors = problem.errors ?? {};
+	}
+};
+/** `412`: the item changed since the version sent in `If-Match`. */
+var ConflictError = class extends ApiError {
+	name = "ConflictError";
+	/** The current version of the item, when the backend sent it. */
+	current;
+	constructor(problem, options) {
+		super(problem, options);
+		this.current = problem.current ?? null;
+	}
+};
+/** `401` (or `419` with the Laravel preset): the user is not authenticated. */
+var UnauthorizedError = class extends ApiError {
+	name = "UnauthorizedError";
+};
+/** `403`: the user is not allowed to do this. */
+var ForbiddenError = class extends ApiError {
+	name = "ForbiddenError";
+};
+/** `404`: the resource, item or route doesn't exist. */
+var NotFoundError = class extends ApiError {
+	name = "NotFoundError";
+};
+/** A successful response whose body doesn't match the protocol. */
+var InvalidResponseError = class extends Error {
+	name = "InvalidResponseError";
+	/** What doesn't match, with dot paths into the body. */
+	issues;
+	constructor(message, issues) {
+		super(message);
+		this.issues = issues;
+	}
+};
+/** Creates the error that matches the status of a problem. */
+function createApiError(problem, options) {
+	switch (problem.status) {
+		case 401: return new UnauthorizedError(problem, options);
+		case 403: return new ForbiddenError(problem, options);
+		case 404: return new NotFoundError(problem, options);
+		case 412: return new ConflictError(problem, options);
+		case 422: return new ValidationError(problem, options);
+		default: return new ApiError(problem, options);
+	}
+}
+/** Whether a value is an error of the API. */
+function isApiError(error) {
+	return error instanceof ApiError;
+}
+//#endregion
+export { ApiError, ConflictError, ForbiddenError, InvalidResponseError, NotFoundError, UnauthorizedError, ValidationError, createApiError, isApiError };
+
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","names":[],"sources":["../src/errors.ts"],"sourcesContent":["import type { Item, Problem, ValidationIssue } from '@panneau/protocol';\n\n/**\n * An error response of the API, parsed from `application/problem+json`. Subclasses cover the\n * statuses a client handles differently. Other statuses (`409`, `429`, `5xx`…) are an `ApiError`.\n */\nexport class ApiError extends Error {\n    override readonly name: string = 'ApiError';\n    /** The HTTP status. */\n    readonly status: number;\n    /** The problem details sent by the backend, or built from the status when it sent none. */\n    readonly problem: Problem;\n\n    constructor(problem: Problem, options?: ErrorOptions) {\n        super(problem.detail ?? problem.title, options);\n        this.status = problem.status;\n        this.problem = problem;\n    }\n}\n\n/** `422`: the submitted values are invalid. */\nexport class ValidationError extends ApiError {\n    override readonly name: string = 'ValidationError';\n    /** Messages keyed by the dot path of the invalid value (`title.fr`, `blocks.2.image`). */\n    readonly errors: Record<string, string[]>;\n\n    constructor(problem: Problem, options?: ErrorOptions) {\n        super(problem, options);\n        this.errors = problem.errors ?? {};\n    }\n}\n\n/** `412`: the item changed since the version sent in `If-Match`. */\nexport class ConflictError extends ApiError {\n    override readonly name: string = 'ConflictError';\n    /** The current version of the item, when the backend sent it. */\n    readonly current: Item | null;\n\n    constructor(problem: Problem, options?: ErrorOptions) {\n        super(problem, options);\n        this.current = problem.current ?? null;\n    }\n}\n\n/** `401` (or `419` with the Laravel preset): the user is not authenticated. */\nexport class UnauthorizedError extends ApiError {\n    override readonly name: string = 'UnauthorizedError';\n}\n\n/** `403`: the user is not allowed to do this. */\nexport class ForbiddenError extends ApiError {\n    override readonly name: string = 'ForbiddenError';\n}\n\n/** `404`: the resource, item or route doesn't exist. */\nexport class NotFoundError extends ApiError {\n    override readonly name: string = 'NotFoundError';\n}\n\n/** A successful response whose body doesn't match the protocol. */\nexport class InvalidResponseError extends Error {\n    override readonly name: string = 'InvalidResponseError';\n    /** What doesn't match, with dot paths into the body. */\n    readonly issues: ValidationIssue[];\n\n    constructor(message: string, issues: ValidationIssue[]) {\n        super(message);\n        this.issues = issues;\n    }\n}\n\n/** Creates the error that matches the status of a problem. */\nexport function createApiError(problem: Problem, options?: ErrorOptions): ApiError {\n    switch (problem.status) {\n        case 401:\n            return new UnauthorizedError(problem, options);\n        case 403:\n            return new ForbiddenError(problem, options);\n        case 404:\n            return new NotFoundError(problem, options);\n        case 412:\n            return new ConflictError(problem, options);\n        case 422:\n            return new ValidationError(problem, options);\n        default:\n            return new ApiError(problem, options);\n    }\n}\n\n/** Whether a value is an error of the API. */\nexport function isApiError(error: unknown): error is ApiError {\n    return error instanceof ApiError;\n}\n"],"mappings":";;;;;AAMA,IAAa,WAAb,cAA8B,MAAM;CAChC,OAAiC;;CAEjC;;CAEA;CAEA,YAAY,SAAkB,SAAwB;EAClD,MAAM,QAAQ,UAAU,QAAQ,OAAO,OAAO;EAC9C,KAAK,SAAS,QAAQ;EACtB,KAAK,UAAU;CACnB;AACJ;;AAGA,IAAa,kBAAb,cAAqC,SAAS;CAC1C,OAAiC;;CAEjC;CAEA,YAAY,SAAkB,SAAwB;EAClD,MAAM,SAAS,OAAO;EACtB,KAAK,SAAS,QAAQ,UAAU,CAAC;CACrC;AACJ;;AAGA,IAAa,gBAAb,cAAmC,SAAS;CACxC,OAAiC;;CAEjC;CAEA,YAAY,SAAkB,SAAwB;EAClD,MAAM,SAAS,OAAO;EACtB,KAAK,UAAU,QAAQ,WAAW;CACtC;AACJ;;AAGA,IAAa,oBAAb,cAAuC,SAAS;CAC5C,OAAiC;AACrC;;AAGA,IAAa,iBAAb,cAAoC,SAAS;CACzC,OAAiC;AACrC;;AAGA,IAAa,gBAAb,cAAmC,SAAS;CACxC,OAAiC;AACrC;;AAGA,IAAa,uBAAb,cAA0C,MAAM;CAC5C,OAAiC;;CAEjC;CAEA,YAAY,SAAiB,QAA2B;EACpD,MAAM,OAAO;EACb,KAAK,SAAS;CAClB;AACJ;;AAGA,SAAgB,eAAe,SAAkB,SAAkC;CAC/E,QAAQ,QAAQ,QAAhB;EACI,KAAK,KACD,OAAO,IAAI,kBAAkB,SAAS,OAAO;EACjD,KAAK,KACD,OAAO,IAAI,eAAe,SAAS,OAAO;EAC9C,KAAK,KACD,OAAO,IAAI,cAAc,SAAS,OAAO;EAC7C,KAAK,KACD,OAAO,IAAI,cAAc,SAAS,OAAO;EAC7C,KAAK,KACD,OAAO,IAAI,gBAAgB,SAAS,OAAO;EAC/C,SACI,OAAO,IAAI,SAAS,SAAS,OAAO;CAC5C;AACJ;;AAGA,SAAgB,WAAW,OAAmC;CAC1D,OAAO,iBAAiB;AAC5B"}