@panneau/protocol 0.0.0-stage → 5.0.0-alpha.0

package/dist/mock/example.js

@@ -0,0 +1,186 @@
+//#region src/mock/example.ts
+/**
+* A small but complete definition: pages with localized titles, a status, a publication date shown
+* for published pages, an author and typed blocks, in tabs and a sidebar, plus authors. For tests
+* and stories, with `createMockBackend()`.
+*/
+function createExampleDefinition() {
+	return {
+		protocol: 1,
+		name: "Test site",
+		locale: "fr",
+		locales: ["fr", "en"],
+		api: { baseUrl: "/panneau/api" },
+		resources: [{
+			id: "pages",
+			label: {
+				singular: "page",
+				plural: "pages"
+			},
+			itemTitle: "title",
+			fields: [
+				{
+					name: "title",
+					type: "text",
+					label: "Titre",
+					localized: true,
+					rules: [{ rule: "required" }, {
+						rule: "max",
+						value: 120
+					}]
+				},
+				{
+					name: "status",
+					type: "select",
+					options: [{
+						value: "draft",
+						label: "Brouillon"
+					}, {
+						value: "published",
+						label: "Publiée"
+					}],
+					rules: [{ rule: "required" }, {
+						rule: "in",
+						value: ["draft", "published"]
+					}]
+				},
+				{
+					name: "published_at",
+					type: "datetime",
+					visibleWhen: {
+						field: "status",
+						equals: "published"
+					},
+					rules: [{ rule: "required" }]
+				},
+				{
+					name: "author",
+					type: "relation",
+					resource: "authors"
+				},
+				{
+					name: "blocks",
+					type: "repeater",
+					types: [{
+						id: "text",
+						label: "Texte",
+						fields: [{
+							name: "body",
+							type: "richtext",
+							rules: [{ rule: "required" }]
+						}]
+					}, {
+						id: "image",
+						label: "Image",
+						fields: [{
+							name: "image",
+							type: "media",
+							rules: [{
+								rule: "accept",
+								value: ["image/*"]
+							}, {
+								rule: "maxSize",
+								value: 1e3
+							}]
+						}]
+					}]
+				}
+			],
+			form: { layout: [{
+				type: "tabs",
+				children: [{
+					type: "tab",
+					label: "Contenu",
+					children: [{
+						type: "row",
+						children: [{
+							type: "field",
+							name: "title",
+							width: 8
+						}, {
+							type: "field",
+							name: "status",
+							width: 4
+						}]
+					}, {
+						type: "field",
+						name: "blocks"
+					}]
+				}]
+			}, {
+				type: "sidebar",
+				children: [{
+					type: "field",
+					name: "published_at"
+				}]
+			}] },
+			list: {
+				columns: [
+					{
+						field: "title",
+						sortable: true
+					},
+					{ field: "status" },
+					{ id: "updated" }
+				],
+				filters: [{
+					id: "status",
+					type: "select"
+				}],
+				sorts: ["title", "published_at"],
+				defaultSort: "title",
+				perPage: 20,
+				search: true
+			},
+			actions: [{
+				id: "publish",
+				label: "Publier",
+				scope: ["item", "selection"],
+				placement: ["row", "toolbar"],
+				confirm: { message: "Publier {count} pages ?" },
+				fields: [{
+					name: "notify",
+					type: "boolean"
+				}]
+			}, {
+				id: "edit",
+				label: "Modifier",
+				kind: "link",
+				url: "/pages/{id}/edit",
+				scope: ["item"]
+			}],
+			abilities: {
+				viewAny: true,
+				create: true
+			}
+		}, {
+			id: "authors",
+			label: {
+				singular: "auteur",
+				plural: "auteurs"
+			},
+			fields: [{
+				name: "name",
+				type: "text",
+				rules: [{ rule: "required" }]
+			}]
+		}],
+		menus: { main: [{ type: "resources" }, {
+			type: "link",
+			label: "Site",
+			url: "/"
+		}] },
+		auth: {
+			mode: "panneau",
+			password: true,
+			providers: [{
+				id: "google",
+				label: "Google"
+			}]
+		}
+	};
+}
+//#endregion
+export { createExampleDefinition };
+
+//# sourceMappingURL=example.js.map

package/dist/mock/example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","names":[],"sources":["../../src/mock/example.ts"],"sourcesContent":["import type { DefinitionInput } from '../schemas';\n\n/**\n * A small but complete definition: pages with localized titles, a status, a publication date shown\n * for published pages, an author and typed blocks, in tabs and a sidebar, plus authors. For tests\n * and stories, with `createMockBackend()`.\n */\nexport function createExampleDefinition(): DefinitionInput {\n    return {\n        protocol: 1,\n        name: 'Test site',\n        locale: 'fr',\n        locales: ['fr', 'en'],\n        api: { baseUrl: '/panneau/api' },\n        resources: [\n            {\n                id: 'pages',\n                label: { singular: 'page', plural: 'pages' },\n                itemTitle: 'title',\n                fields: [\n                    {\n                        name: 'title',\n                        type: 'text',\n                        label: 'Titre',\n                        localized: true,\n                        rules: [{ rule: 'required' }, { rule: 'max', value: 120 }],\n                    },\n                    {\n                        name: 'status',\n                        type: 'select',\n                        options: [\n                            { value: 'draft', label: 'Brouillon' },\n                            { value: 'published', label: 'Publiée' },\n                        ],\n                        rules: [\n                            { rule: 'required' },\n                            { rule: 'in', value: ['draft', 'published'] },\n                        ],\n                    },\n                    {\n                        name: 'published_at',\n                        type: 'datetime',\n                        visibleWhen: { field: 'status', equals: 'published' },\n                        rules: [{ rule: 'required' }],\n                    },\n                    { name: 'author', type: 'relation', resource: 'authors' },\n                    {\n                        name: 'blocks',\n                        type: 'repeater',\n                        types: [\n                            {\n                                id: 'text',\n                                label: 'Texte',\n                                fields: [\n                                    {\n                                        name: 'body',\n                                        type: 'richtext',\n                                        rules: [{ rule: 'required' }],\n                                    },\n                                ],\n                            },\n                            {\n                                id: 'image',\n                                label: 'Image',\n                                fields: [\n                                    {\n                                        name: 'image',\n                                        type: 'media',\n                                        rules: [\n                                            { rule: 'accept', value: ['image/*'] },\n                                            { rule: 'maxSize', value: 1000 },\n                                        ],\n                                    },\n                                ],\n                            },\n                        ],\n                    },\n                ],\n                form: {\n                    layout: [\n                        {\n                            type: 'tabs',\n                            children: [\n                                {\n                                    type: 'tab',\n                                    label: 'Contenu',\n                                    children: [\n                                        {\n                                            type: 'row',\n                                            children: [\n                                                { type: 'field', name: 'title', width: 8 },\n                                                { type: 'field', name: 'status', width: 4 },\n                                            ],\n                                        },\n                                        { type: 'field', name: 'blocks' },\n                                    ],\n                                },\n                            ],\n                        },\n                        { type: 'sidebar', children: [{ type: 'field', name: 'published_at' }] },\n                    ],\n                },\n                list: {\n                    columns: [\n                        { field: 'title', sortable: true },\n                        { field: 'status' },\n                        { id: 'updated' },\n                    ],\n                    filters: [{ id: 'status', type: 'select' }],\n                    sorts: ['title', 'published_at'],\n                    defaultSort: 'title',\n                    perPage: 20,\n                    search: true,\n                },\n                actions: [\n                    {\n                        id: 'publish',\n                        label: 'Publier',\n                        scope: ['item', 'selection'],\n                        placement: ['row', 'toolbar'],\n                        confirm: { message: 'Publier {count} pages ?' },\n                        fields: [{ name: 'notify', type: 'boolean' }],\n                    },\n                    {\n                        id: 'edit',\n                        label: 'Modifier',\n                        kind: 'link',\n                        url: '/pages/{id}/edit',\n                        scope: ['item'],\n                    },\n                ],\n                abilities: { viewAny: true, create: true },\n            },\n            {\n                id: 'authors',\n                label: { singular: 'auteur', plural: 'auteurs' },\n                fields: [{ name: 'name', type: 'text', rules: [{ rule: 'required' }] }],\n            },\n        ],\n        menus: { main: [{ type: 'resources' }, { type: 'link', label: 'Site', url: '/' }] },\n        auth: { mode: 'panneau', password: true, providers: [{ id: 'google', label: 'Google' }] },\n    };\n}\n"],"mappings":";;;;;;AAOA,SAAgB,0BAA2C;CACvD,OAAO;EACH,UAAU;EACV,MAAM;EACN,QAAQ;EACR,SAAS,CAAC,MAAM,IAAI;EACpB,KAAK,EAAE,SAAS,eAAe;EAC/B,WAAW,CACP;GACI,IAAI;GACJ,OAAO;IAAE,UAAU;IAAQ,QAAQ;GAAQ;GAC3C,WAAW;GACX,QAAQ;IACJ;KACI,MAAM;KACN,MAAM;KACN,OAAO;KACP,WAAW;KACX,OAAO,CAAC,EAAE,MAAM,WAAW,GAAG;MAAE,MAAM;MAAO,OAAO;KAAI,CAAC;IAC7D;IACA;KACI,MAAM;KACN,MAAM;KACN,SAAS,CACL;MAAE,OAAO;MAAS,OAAO;KAAY,GACrC;MAAE,OAAO;MAAa,OAAO;KAAU,CAC3C;KACA,OAAO,CACH,EAAE,MAAM,WAAW,GACnB;MAAE,MAAM;MAAM,OAAO,CAAC,SAAS,WAAW;KAAE,CAChD;IACJ;IACA;KACI,MAAM;KACN,MAAM;KACN,aAAa;MAAE,OAAO;MAAU,QAAQ;KAAY;KACpD,OAAO,CAAC,EAAE,MAAM,WAAW,CAAC;IAChC;IACA;KAAE,MAAM;KAAU,MAAM;KAAY,UAAU;IAAU;IACxD;KACI,MAAM;KACN,MAAM;KACN,OAAO,CACH;MACI,IAAI;MACJ,OAAO;MACP,QAAQ,CACJ;OACI,MAAM;OACN,MAAM;OACN,OAAO,CAAC,EAAE,MAAM,WAAW,CAAC;MAChC,CACJ;KACJ,GACA;MACI,IAAI;MACJ,OAAO;MACP,QAAQ,CACJ;OACI,MAAM;OACN,MAAM;OACN,OAAO,CACH;QAAE,MAAM;QAAU,OAAO,CAAC,SAAS;OAAE,GACrC;QAAE,MAAM;QAAW,OAAO;OAAK,CACnC;MACJ,CACJ;KACJ,CACJ;IACJ;GACJ;GACA,MAAM,EACF,QAAQ,CACJ;IACI,MAAM;IACN,UAAU,CACN;KACI,MAAM;KACN,OAAO;KACP,UAAU,CACN;MACI,MAAM;MACN,UAAU,CACN;OAAE,MAAM;OAAS,MAAM;OAAS,OAAO;MAAE,GACzC;OAAE,MAAM;OAAS,MAAM;OAAU,OAAO;MAAE,CAC9C;KACJ,GACA;MAAE,MAAM;MAAS,MAAM;KAAS,CACpC;IACJ,CACJ;GACJ,GACA;IAAE,MAAM;IAAW,UAAU,CAAC;KAAE,MAAM;KAAS,MAAM;IAAe,CAAC;GAAE,CAC3E,EACJ;GACA,MAAM;IACF,SAAS;KACL;MAAE,OAAO;MAAS,UAAU;KAAK;KACjC,EAAE,OAAO,SAAS;KAClB,EAAE,IAAI,UAAU;IACpB;IACA,SAAS,CAAC;KAAE,IAAI;KAAU,MAAM;IAAS,CAAC;IAC1C,OAAO,CAAC,SAAS,cAAc;IAC/B,aAAa;IACb,SAAS;IACT,QAAQ;GACZ;GACA,SAAS,CACL;IACI,IAAI;IACJ,OAAO;IACP,OAAO,CAAC,QAAQ,WAAW;IAC3B,WAAW,CAAC,OAAO,SAAS;IAC5B,SAAS,EAAE,SAAS,0BAA0B;IAC9C,QAAQ,CAAC;KAAE,MAAM;KAAU,MAAM;IAAU,CAAC;GAChD,GACA;IACI,IAAI;IACJ,OAAO;IACP,MAAM;IACN,KAAK;IACL,OAAO,CAAC,MAAM;GAClB,CACJ;GACA,WAAW;IAAE,SAAS;IAAM,QAAQ;GAAK;EAC7C,GACA;GACI,IAAI;GACJ,OAAO;IAAE,UAAU;IAAU,QAAQ;GAAU;GAC/C,QAAQ,CAAC;IAAE,MAAM;IAAQ,MAAM;IAAQ,OAAO,CAAC,EAAE,MAAM,WAAW,CAAC;GAAE,CAAC;EAC1E,CACJ;EACA,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,YAAY,GAAG;GAAE,MAAM;GAAQ,OAAO;GAAQ,KAAK;EAAI,CAAC,EAAE;EAClF,MAAM;GAAE,MAAM;GAAW,UAAU;GAAM,WAAW,CAAC;IAAE,IAAI;IAAU,OAAO;GAAS,CAAC;EAAE;CAC5F;AACJ"}

package/dist/mock/index.d.ts

@@ -0,0 +1,24 @@
+import type { DefinitionInput } from '../schemas';
+import type { Item } from '../schemas/api';
+type Values = Record<string, unknown>;
+export interface MockBackendOptions {
+    /** The definition served by `GET /definition`. Its `api.baseUrl` is the prefix of every route. */
+    definition: DefinitionInput;
+    /** Initial values of the items, per resource id. Items without an `id` get one. */
+    items?: Record<string, Values[]>;
+}
+export interface MockBackend {
+    /** A `fetch`-compatible function that answers protocol requests. */
+    fetch: (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+    /** The current items of a resource. */
+    items: (resource: string) => Item[];
+}
+/**
+ * An in-memory backend that implements the protocol's resource routes: definition, list, show,
+ * create, update (with `If-Match`), delete and the built-in `delete` action. Values are checked
+ * with the portable rules. Used to test the conformance kit, and to develop frontends without a
+ * real backend.
+ */
+export declare function createMockBackend({ definition, items }: MockBackendOptions): MockBackend;
+export { createExampleDefinition } from './example';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mock/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAiB,MAAM,YAAY,CAAC;AACjE,OAAO,KAAK,EAAgB,IAAI,EAAsB,MAAM,gBAAgB,CAAC;AAI7E,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEtC,MAAM,WAAW,kBAAkB;IAC/B,kGAAkG;IAClG,UAAU,EAAE,eAAe,CAAC;IAC5B,mFAAmF;IACnF,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,WAAW;IACxB,oEAAoE;IACpE,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAChF,uCAAuC;IACvC,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,EAAE,CAAC;CACvC;AAyGD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,UAAU,EAAE,KAAU,EAAE,EAAE,kBAAkB,GAAG,WAAW,CAyN7F;AAED,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC"}

package/dist/mock/index.js

@@ -0,0 +1,250 @@
+import { PROBLEM_CONTENT_TYPE } from "../version.js";
+import { isRecord } from "../values.js";
+import { checkValues } from "../rules.js";
+import { fromSearchParams } from "../query.js";
+import { createExampleDefinition } from "./example.js";
+//#region src/mock/index.ts
+var RESERVED_KEYS = /* @__PURE__ */ new Set([
+	"id",
+	"version",
+	"abilities"
+]);
+var DEFAULT_MESSAGES = {
+	required: () => "This field is required.",
+	min: (failure) => `This value must be at least ${String(failure.value)}.`,
+	max: (failure) => `This value must be at most ${String(failure.value)}.`,
+	pattern: () => "This value has an invalid format.",
+	email: () => "This value must be an email address.",
+	url: () => "This value must be a URL.",
+	in: () => "This value is not one of the choices.",
+	accept: () => "This file type is not accepted.",
+	maxSize: () => "This file is too large.",
+	before: () => "This date is too late.",
+	after: () => "This date is too early."
+};
+function message(failure) {
+	return failure.message ?? DEFAULT_MESSAGES[failure.rule]?.(failure) ?? "This value is invalid.";
+}
+function json(status, body, headers = {}) {
+	return new Response(status === 204 ? null : JSON.stringify(body), {
+		status,
+		headers: status === 204 ? headers : {
+			"Content-Type": "application/json",
+			...headers
+		}
+	});
+}
+function problem(status, title, extra = {}) {
+	const body = {
+		type: "about:blank",
+		title,
+		status,
+		...extra
+	};
+	return new Response(JSON.stringify(body), {
+		status,
+		headers: { "Content-Type": PROBLEM_CONTENT_TYPE }
+	});
+}
+function etag(item) {
+	return item.version === null ? {} : { ETag: `"${item.version}"` };
+}
+function parseEtag(value) {
+	return value.replace(/^W\//, "").replace(/^"(.*)"$/, "$1");
+}
+function searchableText(value) {
+	if (typeof value === "string") return value;
+	if (isRecord(value)) return Object.values(value).map(searchableText).join(" ");
+	return "";
+}
+function compare(a, b) {
+	const left = isRecord(a) ? searchableText(a) : a;
+	const right = isRecord(b) ? searchableText(b) : b;
+	if (left === right) return 0;
+	if (left === void 0 || left === null) return 1;
+	if (right === void 0 || right === null) return -1;
+	return String(left).localeCompare(String(right), void 0, { numeric: true });
+}
+function applyQuery(items, query) {
+	let result = items;
+	Object.entries(query.filter ?? {}).forEach(([key, expected]) => {
+		const accepted = (Array.isArray(expected) ? expected : [expected]).map(String);
+		result = result.filter((item) => {
+			const value = item[key];
+			return (Array.isArray(value) ? value : [value]).some((candidate) => accepted.includes(String(candidate)));
+		});
+	});
+	if (query.q !== void 0 && query.q !== "") {
+		const terms = query.q.toLowerCase();
+		result = result.filter((item) => Object.entries(item).filter(([key]) => !RESERVED_KEYS.has(key)).some(([, value]) => searchableText(value).toLowerCase().includes(terms)));
+	}
+	const sort = query.sort ?? [];
+	if (sort.length > 0) result = [...result].sort((a, b) => {
+		for (const part of sort) {
+			const descending = part.startsWith("-");
+			const key = descending ? part.slice(1) : part;
+			const order = compare(a[key], b[key]);
+			if (order !== 0) return descending ? -order : order;
+		}
+		return 0;
+	});
+	return result;
+}
+/**
+* An in-memory backend that implements the protocol's resource routes: definition, list, show,
+* create, update (with `If-Match`), delete and the built-in `delete` action. Values are checked
+* with the portable rules. Used to test the conformance kit, and to develop frontends without a
+* real backend.
+*/
+function createMockBackend({ definition, items = {} }) {
+	const store = /* @__PURE__ */ new Map();
+	let nextId = 1;
+	const abilitiesFor = (resource) => Object.fromEntries([
+		["update", true],
+		["delete", true],
+		...(resource.actions ?? []).map((action) => [action.id, true])
+	]);
+	const makeItem = (resource, values) => {
+		const id = typeof values.id === "string" || typeof values.id === "number" ? String(values.id) : String(nextId++);
+		return {
+			...Object.fromEntries(Object.entries(values).filter(([key]) => !RESERVED_KEYS.has(key))),
+			id,
+			version: "1",
+			abilities: abilitiesFor(resource)
+		};
+	};
+	definition.resources.forEach((resource) => {
+		store.set(resource.id, (items[resource.id] ?? []).map((values) => makeItem(resource, values)));
+	});
+	const basePath = new URL(definition.api.baseUrl, "http://panneau.test").pathname.replace(/\/$/, "");
+	const validationProblem = (resource, values, mode) => {
+		const failures = checkValues(resource.fields, values, {
+			mode,
+			partial: mode === "update",
+			locales: definition.locales
+		});
+		const paths = Object.keys(failures);
+		if (paths.length === 0) return null;
+		return problem(422, "The given data was invalid.", {
+			type: "urn:panneau:problem:validation",
+			errors: Object.fromEntries(paths.map((path) => [path, (failures[path] ?? []).map(message)]))
+		});
+	};
+	const selectItems = (list, selection) => {
+		if (selection === void 0) return [];
+		if ("ids" in selection) {
+			const ids = selection.ids;
+			return list.filter((item) => ids.includes(item.id));
+		}
+		const except = selection.except ?? [];
+		const { filter, q } = selection.query;
+		const query = {};
+		if (filter !== void 0) query.filter = filter;
+		if (q !== void 0) query.q = q;
+		return applyQuery(list, query).filter((item) => !except.includes(item.id));
+	};
+	const handle = async (request) => {
+		const url = new URL(request.url, "http://panneau.test");
+		if (!url.pathname.startsWith(basePath)) return problem(404, "Not found.");
+		const segments = url.pathname.slice(basePath.length).split("/").filter((segment) => segment !== "").map(decodeURIComponent);
+		const method = request.method.toUpperCase();
+		const readBody = async () => {
+			const body = await request.json().catch(() => null);
+			return isRecord(body) ? body : {};
+		};
+		if (segments.length === 1 && segments[0] === "definition" && method === "GET") return json(200, definition);
+		if (segments[0] !== "resources" || segments[1] === void 0) return problem(404, "Not found.");
+		const resource = definition.resources.find((candidate) => candidate.id === segments[1]);
+		const list = resource !== void 0 ? store.get(resource.id) : void 0;
+		if (resource === void 0 || list === void 0) return problem(404, "Resource not found.");
+		if (segments.length === 2) {
+			if (method === "GET") {
+				const query = fromSearchParams(url.searchParams);
+				const perPage = query.perPage ?? resource.list?.perPage ?? 20;
+				const page = query.page ?? 1;
+				const sort = query.sort ?? resource.list?.defaultSort?.split(",");
+				const matching = applyQuery(list, {
+					...query,
+					...sort !== void 0 ? { sort } : {}
+				});
+				return json(200, {
+					data: matching.slice((page - 1) * perPage, page * perPage),
+					meta: {
+						page,
+						perPage,
+						total: matching.length,
+						lastPage: Math.max(1, Math.ceil(matching.length / perPage))
+					}
+				});
+			}
+			if (method === "POST") {
+				const values = await readBody();
+				const invalid = validationProblem(resource, values, "create");
+				if (invalid !== null) return invalid;
+				const item = makeItem(resource, {
+					...values,
+					id: void 0
+				});
+				list.push(item);
+				return json(201, { data: item }, etag(item));
+			}
+			return problem(405, "Method not allowed.");
+		}
+		if (segments[2] === "actions" && segments[3] !== void 0 && segments.length === 4) {
+			if (method !== "POST") return problem(405, "Method not allowed.");
+			if (segments[3] !== "delete") return problem(404, "Action not found.");
+			const body = await readBody();
+			const selected = selectItems(list, body.selection);
+			store.set(resource.id, list.filter((item) => !selected.includes(item)));
+			return json(200, {
+				message: `${selected.length} deleted.`,
+				summary: {
+					succeeded: selected.length,
+					failed: 0,
+					skipped: 0
+				},
+				refresh: "list"
+			});
+		}
+		if (segments.length !== 3 || segments[2] === void 0) return problem(404, "Not found.");
+		const id = segments[2];
+		const index = list.findIndex((item) => item.id === id);
+		const current = list[index];
+		if (current === void 0) return problem(404, "Item not found.");
+		if (method === "GET") return json(200, { data: current }, etag(current));
+		if (method === "PATCH") {
+			const ifMatch = request.headers.get("If-Match");
+			if (ifMatch !== null && current.version !== null && parseEtag(ifMatch) !== current.version) return problem(412, "The item was changed by someone else.", {
+				type: "urn:panneau:problem:version-conflict",
+				current
+			});
+			const values = await readBody();
+			const invalid = validationProblem(resource, values, "update");
+			if (invalid !== null) return invalid;
+			const updates = Object.fromEntries(Object.entries(values).filter(([key]) => !RESERVED_KEYS.has(key)));
+			const updated = {
+				...current,
+				...updates,
+				version: current.version === null ? null : String(Number(current.version) + 1)
+			};
+			list[index] = updated;
+			return json(200, { data: updated }, etag(updated));
+		}
+		if (method === "DELETE") {
+			list.splice(index, 1);
+			return json(204, null);
+		}
+		return problem(405, "Method not allowed.");
+	};
+	return {
+		fetch: (input, init) => {
+			if (input instanceof Request) return handle(input);
+			return handle(new Request(new URL(input, "http://panneau.test"), init));
+		},
+		items: (resource) => [...store.get(resource) ?? []]
+	};
+}
+//#endregion
+export { createExampleDefinition, createMockBackend };
+
+//# sourceMappingURL=index.js.map

package/dist/mock/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/mock/index.ts"],"sourcesContent":["import { type ListQuery, fromSearchParams } from '../query';\nimport { type RuleFailure, checkValues } from '../rules';\nimport type { DefinitionInput, ResourceInput } from '../schemas';\nimport type { ActionResult, Item, Problem, Selection } from '../schemas/api';\nimport { isRecord } from '../values';\nimport { PROBLEM_CONTENT_TYPE } from '../version';\n\ntype Values = Record<string, unknown>;\n\nexport interface MockBackendOptions {\n    /** The definition served by `GET /definition`. Its `api.baseUrl` is the prefix of every route. */\n    definition: DefinitionInput;\n    /** Initial values of the items, per resource id. Items without an `id` get one. */\n    items?: Record<string, Values[]>;\n}\n\nexport interface MockBackend {\n    /** A `fetch`-compatible function that answers protocol requests. */\n    fetch: (input: string | URL | Request, init?: RequestInit) => Promise<Response>;\n    /** The current items of a resource. */\n    items: (resource: string) => Item[];\n}\n\nconst RESERVED_KEYS = new Set(['id', 'version', 'abilities']);\n\nconst DEFAULT_MESSAGES: Record<string, (failure: RuleFailure) => string> = {\n    required: () => 'This field is required.',\n    min: (failure) => `This value must be at least ${String(failure.value)}.`,\n    max: (failure) => `This value must be at most ${String(failure.value)}.`,\n    pattern: () => 'This value has an invalid format.',\n    email: () => 'This value must be an email address.',\n    url: () => 'This value must be a URL.',\n    in: () => 'This value is not one of the choices.',\n    accept: () => 'This file type is not accepted.',\n    maxSize: () => 'This file is too large.',\n    before: () => 'This date is too late.',\n    after: () => 'This date is too early.',\n};\n\nfunction message(failure: RuleFailure): string {\n    return failure.message ?? DEFAULT_MESSAGES[failure.rule]?.(failure) ?? 'This value is invalid.';\n}\n\nfunction json(status: number, body: unknown, headers: Record<string, string> = {}): Response {\n    return new Response(status === 204 ? null : JSON.stringify(body), {\n        status,\n        headers: status === 204 ? headers : { 'Content-Type': 'application/json', ...headers },\n    });\n}\n\nfunction problem(status: number, title: string, extra: Partial<Problem> = {}): Response {\n    const body: Problem = { type: 'about:blank', title, status, ...extra };\n    return new Response(JSON.stringify(body), {\n        status,\n        headers: { 'Content-Type': PROBLEM_CONTENT_TYPE },\n    });\n}\n\nfunction etag(item: Item): Record<string, string> {\n    return item.version === null ? {} : { ETag: `\"${item.version}\"` };\n}\n\nfunction parseEtag(value: string): string {\n    return value.replace(/^W\\//, '').replace(/^\"(.*)\"$/, '$1');\n}\n\nfunction searchableText(value: unknown): string {\n    if (typeof value === 'string') {\n        return value;\n    }\n    if (isRecord(value)) {\n        return Object.values(value).map(searchableText).join(' ');\n    }\n    return '';\n}\n\nfunction compare(a: unknown, b: unknown): number {\n    const left = isRecord(a) ? searchableText(a) : a;\n    const right = isRecord(b) ? searchableText(b) : b;\n    if (left === right) {\n        return 0;\n    }\n    if (left === undefined || left === null) {\n        return 1;\n    }\n    if (right === undefined || right === null) {\n        return -1;\n    }\n    return String(left).localeCompare(String(right), undefined, { numeric: true });\n}\n\nfunction applyQuery(items: Item[], query: Pick<ListQuery, 'filter' | 'q' | 'sort'>): Item[] {\n    let result = items;\n    Object.entries(query.filter ?? {}).forEach(([key, expected]) => {\n        const accepted = (Array.isArray(expected) ? expected : [expected]).map(String);\n        result = result.filter((item) => {\n            const value = item[key];\n            const values = Array.isArray(value) ? value : [value];\n            return values.some((candidate) => accepted.includes(String(candidate)));\n        });\n    });\n    if (query.q !== undefined && query.q !== '') {\n        const terms = query.q.toLowerCase();\n        result = result.filter((item) =>\n            Object.entries(item)\n                .filter(([key]) => !RESERVED_KEYS.has(key))\n                .some(([, value]) => searchableText(value).toLowerCase().includes(terms)),\n        );\n    }\n    const sort = query.sort ?? [];\n    if (sort.length > 0) {\n        result = [...result].sort((a, b) => {\n            for (const part of sort) {\n                const descending = part.startsWith('-');\n                const key = descending ? part.slice(1) : part;\n                const order = compare(a[key], b[key]);\n                if (order !== 0) {\n                    return descending ? -order : order;\n                }\n            }\n            return 0;\n        });\n    }\n    return result;\n}\n\n/**\n * An in-memory backend that implements the protocol's resource routes: definition, list, show,\n * create, update (with `If-Match`), delete and the built-in `delete` action. Values are checked\n * with the portable rules. Used to test the conformance kit, and to develop frontends without a\n * real backend.\n */\nexport function createMockBackend({ definition, items = {} }: MockBackendOptions): MockBackend {\n    const store = new Map<string, Item[]>();\n    let nextId = 1;\n\n    const abilitiesFor = (resource: ResourceInput) =>\n        Object.fromEntries([\n            ['update', true],\n            ['delete', true],\n            ...(resource.actions ?? []).map((action) => [action.id, true]),\n        ]);\n\n    const makeItem = (resource: ResourceInput, values: Values): Item => {\n        const id =\n            typeof values.id === 'string' || typeof values.id === 'number'\n                ? String(values.id)\n                : String(nextId++);\n        const rest = Object.fromEntries(\n            Object.entries(values).filter(([key]) => !RESERVED_KEYS.has(key)),\n        );\n        return { ...rest, id, version: '1', abilities: abilitiesFor(resource) };\n    };\n\n    definition.resources.forEach((resource) => {\n        store.set(\n            resource.id,\n            (items[resource.id] ?? []).map((values) => makeItem(resource, values)),\n        );\n    });\n\n    const basePath = new URL(definition.api.baseUrl, 'http://panneau.test').pathname.replace(\n        /\\/$/,\n        '',\n    );\n\n    const validationProblem = (\n        resource: ResourceInput,\n        values: Values,\n        mode: 'create' | 'update',\n    ) => {\n        const failures = checkValues(resource.fields, values, {\n            mode,\n            partial: mode === 'update',\n            locales: definition.locales,\n        });\n        const paths = Object.keys(failures);\n        if (paths.length === 0) {\n            return null;\n        }\n        return problem(422, 'The given data was invalid.', {\n            type: 'urn:panneau:problem:validation',\n            errors: Object.fromEntries(\n                paths.map((path) => [path, (failures[path] ?? []).map(message)]),\n            ),\n        });\n    };\n\n    const selectItems = (list: Item[], selection: Selection | undefined): Item[] => {\n        if (selection === undefined) {\n            return [];\n        }\n        if ('ids' in selection) {\n            const ids = selection.ids as string[];\n            return list.filter((item) => ids.includes(item.id));\n        }\n        const except = selection.except ?? [];\n        const { filter, q } = selection.query;\n        const query: Pick<ListQuery, 'filter' | 'q'> = {};\n        if (filter !== undefined) {\n            query.filter = filter as NonNullable<ListQuery['filter']>;\n        }\n        if (q !== undefined) {\n            query.q = q;\n        }\n        return applyQuery(list, query).filter((item) => !except.includes(item.id));\n    };\n\n    const handle = async (request: Request): Promise<Response> => {\n        const url = new URL(request.url, 'http://panneau.test');\n        if (!url.pathname.startsWith(basePath)) {\n            return problem(404, 'Not found.');\n        }\n        const segments = url.pathname\n            .slice(basePath.length)\n            .split('/')\n            .filter((segment) => segment !== '')\n            .map(decodeURIComponent);\n        const method = request.method.toUpperCase();\n        const readBody = async (): Promise<Values> => {\n            const body: unknown = await request.json().catch(() => null);\n            return isRecord(body) ? body : {};\n        };\n\n        if (segments.length === 1 && segments[0] === 'definition' && method === 'GET') {\n            return json(200, definition);\n        }\n        if (segments[0] !== 'resources' || segments[1] === undefined) {\n            return problem(404, 'Not found.');\n        }\n\n        const resource = definition.resources.find((candidate) => candidate.id === segments[1]);\n        const list = resource !== undefined ? store.get(resource.id) : undefined;\n        if (resource === undefined || list === undefined) {\n            return problem(404, 'Resource not found.');\n        }\n\n        if (segments.length === 2) {\n            if (method === 'GET') {\n                const query = fromSearchParams(url.searchParams);\n                const perPage = query.perPage ?? resource.list?.perPage ?? 20;\n                const page = query.page ?? 1;\n                const sort = query.sort ?? resource.list?.defaultSort?.split(',');\n                const matching = applyQuery(list, {\n                    ...query,\n                    ...(sort !== undefined ? { sort } : {}),\n                });\n                return json(200, {\n                    data: matching.slice((page - 1) * perPage, page * perPage),\n                    meta: {\n                        page,\n                        perPage,\n                        total: matching.length,\n                        lastPage: Math.max(1, Math.ceil(matching.length / perPage)),\n                    },\n                });\n            }\n            if (method === 'POST') {\n                const values = await readBody();\n                const invalid = validationProblem(resource, values, 'create');\n                if (invalid !== null) {\n                    return invalid;\n                }\n                const item = makeItem(resource, { ...values, id: undefined });\n                list.push(item);\n                return json(201, { data: item }, etag(item));\n            }\n            return problem(405, 'Method not allowed.');\n        }\n\n        if (segments[2] === 'actions' && segments[3] !== undefined && segments.length === 4) {\n            if (method !== 'POST') {\n                return problem(405, 'Method not allowed.');\n            }\n            if (segments[3] !== 'delete') {\n                return problem(404, 'Action not found.');\n            }\n            const body = await readBody();\n            const selected = selectItems(list, body.selection as Selection | undefined);\n            store.set(\n                resource.id,\n                list.filter((item) => !selected.includes(item)),\n            );\n            const result: ActionResult = {\n                message: `${selected.length} deleted.`,\n                summary: { succeeded: selected.length, failed: 0, skipped: 0 },\n                refresh: 'list',\n            };\n            return json(200, result);\n        }\n\n        if (segments.length !== 3 || segments[2] === undefined) {\n            return problem(404, 'Not found.');\n        }\n        const id = segments[2];\n        const index = list.findIndex((item) => item.id === id);\n        const current = list[index];\n        if (current === undefined) {\n            return problem(404, 'Item not found.');\n        }\n\n        if (method === 'GET') {\n            return json(200, { data: current }, etag(current));\n        }\n        if (method === 'PATCH') {\n            const ifMatch = request.headers.get('If-Match');\n            if (\n                ifMatch !== null &&\n                current.version !== null &&\n                parseEtag(ifMatch) !== current.version\n            ) {\n                return problem(412, 'The item was changed by someone else.', {\n                    type: 'urn:panneau:problem:version-conflict',\n                    current,\n                });\n            }\n            const values = await readBody();\n            const invalid = validationProblem(resource, values, 'update');\n            if (invalid !== null) {\n                return invalid;\n            }\n            const updates = Object.fromEntries(\n                Object.entries(values).filter(([key]) => !RESERVED_KEYS.has(key)),\n            );\n            const updated: Item = {\n                ...current,\n                ...updates,\n                version: current.version === null ? null : String(Number(current.version) + 1),\n            };\n            list[index] = updated;\n            return json(200, { data: updated }, etag(updated));\n        }\n        if (method === 'DELETE') {\n            list.splice(index, 1);\n            return json(204, null);\n        }\n        return problem(405, 'Method not allowed.');\n    };\n\n    return {\n        fetch: (input, init) => {\n            if (input instanceof Request) {\n                return handle(input);\n            }\n            // Relative URLs are accepted, as a browser would resolve them.\n            return handle(new Request(new URL(input, 'http://panneau.test'), init));\n        },\n        items: (resource) => [...(store.get(resource) ?? [])],\n    };\n}\n\nexport { createExampleDefinition } from './example';\n"],"mappings":";;;;;;AAuBA,IAAM,gCAAgB,IAAI,IAAI;CAAC;CAAM;CAAW;AAAW,CAAC;AAE5D,IAAM,mBAAqE;CACvE,gBAAgB;CAChB,MAAM,YAAY,+BAA+B,OAAO,QAAQ,KAAK,EAAE;CACvE,MAAM,YAAY,8BAA8B,OAAO,QAAQ,KAAK,EAAE;CACtE,eAAe;CACf,aAAa;CACb,WAAW;CACX,UAAU;CACV,cAAc;CACd,eAAe;CACf,cAAc;CACd,aAAa;AACjB;AAEA,SAAS,QAAQ,SAA8B;CAC3C,OAAO,QAAQ,WAAW,iBAAiB,QAAQ,KAAK,GAAG,OAAO,KAAK;AAC3E;AAEA,SAAS,KAAK,QAAgB,MAAe,UAAkC,CAAC,GAAa;CACzF,OAAO,IAAI,SAAS,WAAW,MAAM,OAAO,KAAK,UAAU,IAAI,GAAG;EAC9D;EACA,SAAS,WAAW,MAAM,UAAU;GAAE,gBAAgB;GAAoB,GAAG;EAAQ;CACzF,CAAC;AACL;AAEA,SAAS,QAAQ,QAAgB,OAAe,QAA0B,CAAC,GAAa;CACpF,MAAM,OAAgB;EAAE,MAAM;EAAe;EAAO;EAAQ,GAAG;CAAM;CACrE,OAAO,IAAI,SAAS,KAAK,UAAU,IAAI,GAAG;EACtC;EACA,SAAS,EAAE,gBAAgB,qBAAqB;CACpD,CAAC;AACL;AAEA,SAAS,KAAK,MAAoC;CAC9C,OAAO,KAAK,YAAY,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,QAAQ,GAAG;AACpE;AAEA,SAAS,UAAU,OAAuB;CACtC,OAAO,MAAM,QAAQ,QAAQ,EAAE,CAAC,CAAC,QAAQ,YAAY,IAAI;AAC7D;AAEA,SAAS,eAAe,OAAwB;CAC5C,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,IAAI,SAAS,KAAK,GACd,OAAO,OAAO,OAAO,KAAK,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,KAAK,GAAG;CAE5D,OAAO;AACX;AAEA,SAAS,QAAQ,GAAY,GAAoB;CAC7C,MAAM,OAAO,SAAS,CAAC,IAAI,eAAe,CAAC,IAAI;CAC/C,MAAM,QAAQ,SAAS,CAAC,IAAI,eAAe,CAAC,IAAI;CAChD,IAAI,SAAS,OACT,OAAO;CAEX,IAAI,SAAS,KAAA,KAAa,SAAS,MAC/B,OAAO;CAEX,IAAI,UAAU,KAAA,KAAa,UAAU,MACjC,OAAO;CAEX,OAAO,OAAO,IAAI,CAAC,CAAC,cAAc,OAAO,KAAK,GAAG,KAAA,GAAW,EAAE,SAAS,KAAK,CAAC;AACjF;AAEA,SAAS,WAAW,OAAe,OAAyD;CACxF,IAAI,SAAS;CACb,OAAO,QAAQ,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,cAAc;EAC5D,MAAM,YAAY,MAAM,QAAQ,QAAQ,IAAI,WAAW,CAAC,QAAQ,EAAA,CAAG,IAAI,MAAM;EAC7E,SAAS,OAAO,QAAQ,SAAS;GAC7B,MAAM,QAAQ,KAAK;GAEnB,QADe,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACtC,MAAM,cAAc,SAAS,SAAS,OAAO,SAAS,CAAC,CAAC;EAC1E,CAAC;CACL,CAAC;CACD,IAAI,MAAM,MAAM,KAAA,KAAa,MAAM,MAAM,IAAI;EACzC,MAAM,QAAQ,MAAM,EAAE,YAAY;EAClC,SAAS,OAAO,QAAQ,SACpB,OAAO,QAAQ,IAAI,CAAC,CACf,QAAQ,CAAC,SAAS,CAAC,cAAc,IAAI,GAAG,CAAC,CAAC,CAC1C,MAAM,GAAG,WAAW,eAAe,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,SAAS,KAAK,CAAC,CAChF;CACJ;CACA,MAAM,OAAO,MAAM,QAAQ,CAAC;CAC5B,IAAI,KAAK,SAAS,GACd,SAAS,CAAC,GAAG,MAAM,CAAC,CAAC,MAAM,GAAG,MAAM;EAChC,KAAK,MAAM,QAAQ,MAAM;GACrB,MAAM,aAAa,KAAK,WAAW,GAAG;GACtC,MAAM,MAAM,aAAa,KAAK,MAAM,CAAC,IAAI;GACzC,MAAM,QAAQ,QAAQ,EAAE,MAAM,EAAE,IAAI;GACpC,IAAI,UAAU,GACV,OAAO,aAAa,CAAC,QAAQ;EAErC;EACA,OAAO;CACX,CAAC;CAEL,OAAO;AACX;;;;;;;AAQA,SAAgB,kBAAkB,EAAE,YAAY,QAAQ,CAAC,KAAsC;CAC3F,MAAM,wBAAQ,IAAI,IAAoB;CACtC,IAAI,SAAS;CAEb,MAAM,gBAAgB,aAClB,OAAO,YAAY;EACf,CAAC,UAAU,IAAI;EACf,CAAC,UAAU,IAAI;EACf,IAAI,SAAS,WAAW,CAAC,EAAA,CAAG,KAAK,WAAW,CAAC,OAAO,IAAI,IAAI,CAAC;CACjE,CAAC;CAEL,MAAM,YAAY,UAAyB,WAAyB;EAChE,MAAM,KACF,OAAO,OAAO,OAAO,YAAY,OAAO,OAAO,OAAO,WAChD,OAAO,OAAO,EAAE,IAChB,OAAO,QAAQ;EAIzB,OAAO;GAAE,GAHI,OAAO,YAChB,OAAO,QAAQ,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,IAAI,GAAG,CAAC,CAExD;GAAM;GAAI,SAAS;GAAK,WAAW,aAAa,QAAQ;EAAE;CAC1E;CAEA,WAAW,UAAU,SAAS,aAAa;EACvC,MAAM,IACF,SAAS,KACR,MAAM,SAAS,OAAO,CAAC,EAAA,CAAG,KAAK,WAAW,SAAS,UAAU,MAAM,CAAC,CACzE;CACJ,CAAC;CAED,MAAM,WAAW,IAAI,IAAI,WAAW,IAAI,SAAS,qBAAqB,CAAC,CAAC,SAAS,QAC7E,OACA,EACJ;CAEA,MAAM,qBACF,UACA,QACA,SACC;EACD,MAAM,WAAW,YAAY,SAAS,QAAQ,QAAQ;GAClD;GACA,SAAS,SAAS;GAClB,SAAS,WAAW;EACxB,CAAC;EACD,MAAM,QAAQ,OAAO,KAAK,QAAQ;EAClC,IAAI,MAAM,WAAW,GACjB,OAAO;EAEX,OAAO,QAAQ,KAAK,+BAA+B;GAC/C,MAAM;GACN,QAAQ,OAAO,YACX,MAAM,KAAK,SAAS,CAAC,OAAO,SAAS,SAAS,CAAC,EAAA,CAAG,IAAI,OAAO,CAAC,CAAC,CACnE;EACJ,CAAC;CACL;CAEA,MAAM,eAAe,MAAc,cAA6C;EAC5E,IAAI,cAAc,KAAA,GACd,OAAO,CAAC;EAEZ,IAAI,SAAS,WAAW;GACpB,MAAM,MAAM,UAAU;GACtB,OAAO,KAAK,QAAQ,SAAS,IAAI,SAAS,KAAK,EAAE,CAAC;EACtD;EACA,MAAM,SAAS,UAAU,UAAU,CAAC;EACpC,MAAM,EAAE,QAAQ,MAAM,UAAU;EAChC,MAAM,QAAyC,CAAC;EAChD,IAAI,WAAW,KAAA,GACX,MAAM,SAAS;EAEnB,IAAI,MAAM,KAAA,GACN,MAAM,IAAI;EAEd,OAAO,WAAW,MAAM,KAAK,CAAC,CAAC,QAAQ,SAAS,CAAC,OAAO,SAAS,KAAK,EAAE,CAAC;CAC7E;CAEA,MAAM,SAAS,OAAO,YAAwC;EAC1D,MAAM,MAAM,IAAI,IAAI,QAAQ,KAAK,qBAAqB;EACtD,IAAI,CAAC,IAAI,SAAS,WAAW,QAAQ,GACjC,OAAO,QAAQ,KAAK,YAAY;EAEpC,MAAM,WAAW,IAAI,SAChB,MAAM,SAAS,MAAM,CAAC,CACtB,MAAM,GAAG,CAAC,CACV,QAAQ,YAAY,YAAY,EAAE,CAAC,CACnC,IAAI,kBAAkB;EAC3B,MAAM,SAAS,QAAQ,OAAO,YAAY;EAC1C,MAAM,WAAW,YAA6B;GAC1C,MAAM,OAAgB,MAAM,QAAQ,KAAK,CAAC,CAAC,YAAY,IAAI;GAC3D,OAAO,SAAS,IAAI,IAAI,OAAO,CAAC;EACpC;EAEA,IAAI,SAAS,WAAW,KAAK,SAAS,OAAO,gBAAgB,WAAW,OACpE,OAAO,KAAK,KAAK,UAAU;EAE/B,IAAI,SAAS,OAAO,eAAe,SAAS,OAAO,KAAA,GAC/C,OAAO,QAAQ,KAAK,YAAY;EAGpC,MAAM,WAAW,WAAW,UAAU,MAAM,cAAc,UAAU,OAAO,SAAS,EAAE;EACtF,MAAM,OAAO,aAAa,KAAA,IAAY,MAAM,IAAI,SAAS,EAAE,IAAI,KAAA;EAC/D,IAAI,aAAa,KAAA,KAAa,SAAS,KAAA,GACnC,OAAO,QAAQ,KAAK,qBAAqB;EAG7C,IAAI,SAAS,WAAW,GAAG;GACvB,IAAI,WAAW,OAAO;IAClB,MAAM,QAAQ,iBAAiB,IAAI,YAAY;IAC/C,MAAM,UAAU,MAAM,WAAW,SAAS,MAAM,WAAW;IAC3D,MAAM,OAAO,MAAM,QAAQ;IAC3B,MAAM,OAAO,MAAM,QAAQ,SAAS,MAAM,aAAa,MAAM,GAAG;IAChE,MAAM,WAAW,WAAW,MAAM;KAC9B,GAAG;KACH,GAAI,SAAS,KAAA,IAAY,EAAE,KAAK,IAAI,CAAC;IACzC,CAAC;IACD,OAAO,KAAK,KAAK;KACb,MAAM,SAAS,OAAO,OAAO,KAAK,SAAS,OAAO,OAAO;KACzD,MAAM;MACF;MACA;MACA,OAAO,SAAS;MAChB,UAAU,KAAK,IAAI,GAAG,KAAK,KAAK,SAAS,SAAS,OAAO,CAAC;KAC9D;IACJ,CAAC;GACL;GACA,IAAI,WAAW,QAAQ;IACnB,MAAM,SAAS,MAAM,SAAS;IAC9B,MAAM,UAAU,kBAAkB,UAAU,QAAQ,QAAQ;IAC5D,IAAI,YAAY,MACZ,OAAO;IAEX,MAAM,OAAO,SAAS,UAAU;KAAE,GAAG;KAAQ,IAAI,KAAA;IAAU,CAAC;IAC5D,KAAK,KAAK,IAAI;IACd,OAAO,KAAK,KAAK,EAAE,MAAM,KAAK,GAAG,KAAK,IAAI,CAAC;GAC/C;GACA,OAAO,QAAQ,KAAK,qBAAqB;EAC7C;EAEA,IAAI,SAAS,OAAO,aAAa,SAAS,OAAO,KAAA,KAAa,SAAS,WAAW,GAAG;GACjF,IAAI,WAAW,QACX,OAAO,QAAQ,KAAK,qBAAqB;GAE7C,IAAI,SAAS,OAAO,UAChB,OAAO,QAAQ,KAAK,mBAAmB;GAE3C,MAAM,OAAO,MAAM,SAAS;GAC5B,MAAM,WAAW,YAAY,MAAM,KAAK,SAAkC;GAC1E,MAAM,IACF,SAAS,IACT,KAAK,QAAQ,SAAS,CAAC,SAAS,SAAS,IAAI,CAAC,CAClD;GAMA,OAAO,KAAK,KAAK;IAJb,SAAS,GAAG,SAAS,OAAO;IAC5B,SAAS;KAAE,WAAW,SAAS;KAAQ,QAAQ;KAAG,SAAS;IAAE;IAC7D,SAAS;GAEI,CAAM;EAC3B;EAEA,IAAI,SAAS,WAAW,KAAK,SAAS,OAAO,KAAA,GACzC,OAAO,QAAQ,KAAK,YAAY;EAEpC,MAAM,KAAK,SAAS;EACpB,MAAM,QAAQ,KAAK,WAAW,SAAS,KAAK,OAAO,EAAE;EACrD,MAAM,UAAU,KAAK;EACrB,IAAI,YAAY,KAAA,GACZ,OAAO,QAAQ,KAAK,iBAAiB;EAGzC,IAAI,WAAW,OACX,OAAO,KAAK,KAAK,EAAE,MAAM,QAAQ,GAAG,KAAK,OAAO,CAAC;EAErD,IAAI,WAAW,SAAS;GACpB,MAAM,UAAU,QAAQ,QAAQ,IAAI,UAAU;GAC9C,IACI,YAAY,QACZ,QAAQ,YAAY,QACpB,UAAU,OAAO,MAAM,QAAQ,SAE/B,OAAO,QAAQ,KAAK,yCAAyC;IACzD,MAAM;IACN;GACJ,CAAC;GAEL,MAAM,SAAS,MAAM,SAAS;GAC9B,MAAM,UAAU,kBAAkB,UAAU,QAAQ,QAAQ;GAC5D,IAAI,YAAY,MACZ,OAAO;GAEX,MAAM,UAAU,OAAO,YACnB,OAAO,QAAQ,MAAM,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,IAAI,GAAG,CAAC,CACpE;GACA,MAAM,UAAgB;IAClB,GAAG;IACH,GAAG;IACH,SAAS,QAAQ,YAAY,OAAO,OAAO,OAAO,OAAO,QAAQ,OAAO,IAAI,CAAC;GACjF;GACA,KAAK,SAAS;GACd,OAAO,KAAK,KAAK,EAAE,MAAM,QAAQ,GAAG,KAAK,OAAO,CAAC;EACrD;EACA,IAAI,WAAW,UAAU;GACrB,KAAK,OAAO,OAAO,CAAC;GACpB,OAAO,KAAK,KAAK,IAAI;EACzB;EACA,OAAO,QAAQ,KAAK,qBAAqB;CAC7C;CAEA,OAAO;EACH,QAAQ,OAAO,SAAS;GACpB,IAAI,iBAAiB,SACjB,OAAO,OAAO,KAAK;GAGvB,OAAO,OAAO,IAAI,QAAQ,IAAI,IAAI,OAAO,qBAAqB,GAAG,IAAI,CAAC;EAC1E;EACA,QAAQ,aAAa,CAAC,GAAI,MAAM,IAAI,QAAQ,KAAK,CAAC,CAAE;CACxD;AACJ"}

package/dist/openapi.d.ts

@@ -0,0 +1,11 @@
+type JsonObject = Record<string, unknown>;
+/** Component schemas, generated from the protocol's Zod schemas. */
+export declare function createComponentSchemas(): Record<string, JsonObject>;
+/** The JSON Schema of the definition (`GET /definition`). */
+export declare function createDefinitionJsonSchema(): JsonObject;
+/** The JSON Schema of the boot config, which a server writes in the page of the app. */
+export declare function createBootConfigJsonSchema(): JsonObject;
+/** The OpenAPI 3.1 document of the Panneau HTTP API. */
+export declare function createOpenApiDocument(): JsonObject;
+export {};
+//# sourceMappingURL=openapi.d.ts.map

package/dist/openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../src/openapi.ts"],"names":[],"mappings":"AAOA,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AA0E1C,oEAAoE;AACpE,wBAAgB,sBAAsB,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAWnE;AAED,6DAA6D;AAC7D,wBAAgB,0BAA0B,IAAI,UAAU,CAQvD;AAED,wFAAwF;AACxF,wBAAgB,0BAA0B,IAAI,UAAU,CAQvD;AAED,wDAAwD;AACxD,wBAAgB,qBAAqB,IAAI,UAAU,CAialD"}