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

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @panneau/protocol
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The contract between Panneau frontends and backends: the definition format and the HTTP API, written as schemas, with the tools to check an implementation.
+
+The protocol is explained in [`docs/protocol.md`](../../docs/protocol.md).
+
+```ts
+import {
+    type Definition,
+    checkValues,
+    toSearchParams,
+    validateDefinition,
+} from '@panneau/protocol';
+import { runConformance } from '@panneau/protocol/conformance';
+import { createMockBackend } from '@panneau/protocol/mock';
+```
+
+| Export                                     | Content                                                                                                                                                                                                      |
+| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `@panneau/protocol`                        | Schemas (Zod) and types, `validateDefinition()`, `validateBootConfig()`, `lintDefinition()`, `checkValues()` (portable rules), `evaluateCondition()`, list query helpers, OpenAPI and JSON Schema generators |
+| `@panneau/protocol/mock`                   | `createMockBackend()`: an in-memory backend for tests and development                                                                                                                                        |
+| `@panneau/protocol/conformance`            | `runConformance()`: checks a live backend against the protocol                                                                                                                                               |
+| `@panneau/protocol/definition.schema.json` | JSON Schema of the definition                                                                                                                                                                                |
+| `@panneau/protocol/openapi.json`           | OpenAPI 3.1 document of the API                                                                                                                                                                              |
+| `@panneau/protocol/boot.schema.json`       | JSON Schema of the boot config, which a server writes in the page of the app                                                                                                                                 |
+
+## Changing the protocol
+
+1. Change the schemas in `src/schemas` (and the rules, mock or conformance checks they affect), with tests.
+2. Run `npm run build` in this package. It regenerates `schema/`, and a test fails if the files are out of date.
+3. Update `docs/protocol.md`.
+4. Within protocol version 1, changes are additive only: new optional properties, new endpoints, new rules (which older clients ignore).

package/dist/conditions.d.ts

@@ -0,0 +1,7 @@
+import type { Condition } from './schemas/common';
+/**
+ * Evaluates a `visibleWhen` condition against form values. An empty condition is true. Paths are
+ * relative to `values`.
+ */
+export declare function evaluateCondition(condition: Condition, values: unknown): boolean;
+//# sourceMappingURL=conditions.d.ts.map

package/dist/conditions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditions.d.ts","sourceRoot":"","sources":["../src/conditions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAGlD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAoChF"}

package/dist/conditions.js

@@ -0,0 +1,21 @@
+import { getValue, isEqual, isFilled } from "./values.js";
+//#region src/conditions.ts
+/**
+* Evaluates a `visibleWhen` condition against form values. An empty condition is true. Paths are
+* relative to `values`.
+*/
+function evaluateCondition(condition, values) {
+	if (condition.all !== void 0 && !condition.all.every((child) => evaluateCondition(child, values))) return false;
+	if (condition.any !== void 0 && !condition.any.some((child) => evaluateCondition(child, values))) return false;
+	if (condition.field === void 0) return true;
+	const value = getValue(values, condition.field);
+	if ("equals" in condition && !isEqual(value, condition.equals)) return false;
+	if (condition.in !== void 0 && !condition.in.some((candidate) => isEqual(value, candidate))) return false;
+	if (condition.notIn !== void 0 && condition.notIn.some((candidate) => isEqual(value, candidate))) return false;
+	if (condition.filled !== void 0 && isFilled(value) !== condition.filled) return false;
+	return true;
+}
+//#endregion
+export { evaluateCondition };
+
+//# sourceMappingURL=conditions.js.map

package/dist/conditions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditions.js","names":[],"sources":["../src/conditions.ts"],"sourcesContent":["import type { Condition } from './schemas/common';\nimport { getValue, isEqual, isFilled } from './values';\n\n/**\n * Evaluates a `visibleWhen` condition against form values. An empty condition is true. Paths are\n * relative to `values`.\n */\nexport function evaluateCondition(condition: Condition, values: unknown): boolean {\n    if (\n        condition.all !== undefined &&\n        !condition.all.every((child) => evaluateCondition(child, values))\n    ) {\n        return false;\n    }\n    if (\n        condition.any !== undefined &&\n        !condition.any.some((child) => evaluateCondition(child, values))\n    ) {\n        return false;\n    }\n    if (condition.field === undefined) {\n        return true;\n    }\n    const value = getValue(values, condition.field);\n    if ('equals' in condition && !isEqual(value, condition.equals)) {\n        return false;\n    }\n    if (\n        condition.in !== undefined &&\n        !condition.in.some((candidate) => isEqual(value, candidate))\n    ) {\n        return false;\n    }\n    if (\n        condition.notIn !== undefined &&\n        condition.notIn.some((candidate) => isEqual(value, candidate))\n    ) {\n        return false;\n    }\n    if (condition.filled !== undefined && isFilled(value) !== condition.filled) {\n        return false;\n    }\n    return true;\n}\n"],"mappings":";;;;;;AAOA,SAAgB,kBAAkB,WAAsB,QAA0B;CAC9E,IACI,UAAU,QAAQ,KAAA,KAClB,CAAC,UAAU,IAAI,OAAO,UAAU,kBAAkB,OAAO,MAAM,CAAC,GAEhE,OAAO;CAEX,IACI,UAAU,QAAQ,KAAA,KAClB,CAAC,UAAU,IAAI,MAAM,UAAU,kBAAkB,OAAO,MAAM,CAAC,GAE/D,OAAO;CAEX,IAAI,UAAU,UAAU,KAAA,GACpB,OAAO;CAEX,MAAM,QAAQ,SAAS,QAAQ,UAAU,KAAK;CAC9C,IAAI,YAAY,aAAa,CAAC,QAAQ,OAAO,UAAU,MAAM,GACzD,OAAO;CAEX,IACI,UAAU,OAAO,KAAA,KACjB,CAAC,UAAU,GAAG,MAAM,cAAc,QAAQ,OAAO,SAAS,CAAC,GAE3D,OAAO;CAEX,IACI,UAAU,UAAU,KAAA,KACpB,UAAU,MAAM,MAAM,cAAc,QAAQ,OAAO,SAAS,CAAC,GAE7D,OAAO;CAEX,IAAI,UAAU,WAAW,KAAA,KAAa,SAAS,KAAK,MAAM,UAAU,QAChE,OAAO;CAEX,OAAO;AACX"}

package/dist/conformance/index.d.ts

@@ -0,0 +1,42 @@
+export interface ConformanceOptions {
+    /** Base URL of the API, the same as `api.baseUrl` of the definition, but absolute. */
+    baseUrl: string;
+    /** The `fetch` to use. Defaults to the global one. */
+    fetch?: (input: string, init?: RequestInit) => Promise<Response>;
+    /** Merged into every request, for authentication headers or cookies. */
+    init?: RequestInit;
+    /** Resource to test. Defaults to the first resource of the definition. */
+    resource?: string;
+    /**
+     * Enables the checks that write data, on the tested resource. Use a test database: these
+     * checks create, update and delete an item.
+     */
+    writes?: {
+        /** Valid values for a new item. */
+        create: Record<string, unknown>;
+        /** Valid values for an update. */
+        update: Record<string, unknown>;
+        /** Values that must be refused with a `422`. Defaults to `{}` when a field is required. */
+        invalid?: Record<string, unknown>;
+    };
+}
+export type ConformanceStatus = 'passed' | 'failed' | 'skipped';
+export interface ConformanceCheck {
+    id: string;
+    title: string;
+    status: ConformanceStatus;
+    /** What went wrong, or why the check was skipped. */
+    issues: string[];
+}
+export interface ConformanceReport {
+    passed: boolean;
+    checks: ConformanceCheck[];
+}
+/**
+ * Runs the protocol's conformance checks against a live backend. Read-only checks always run;
+ * checks that write data run only with `writes`.
+ */
+export declare function runConformance(options: ConformanceOptions): Promise<ConformanceReport>;
+/** Formats a report as text, one line per check. */
+export declare function formatReport(report: ConformanceReport): string;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/conformance/index.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,kBAAkB;IAC/B,sFAAsF;IACtF,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,wEAAwE;IACxE,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,MAAM,CAAC,EAAE;QACL,mCAAmC;QACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,kCAAkC;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,2FAA2F;QAC3F,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACrC,CAAC;CACL;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEhE,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;IAC1B,qDAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAoED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAgR5F;AAED,oDAAoD;AACpD,wBAAgB,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAU9D"}

package/dist/conformance/index.js

@@ -0,0 +1,243 @@
+import { PROBLEM_CONTENT_TYPE } from "../version.js";
+import { Definition } from "../schemas/definition.js";
+import { ItemResponse, ListResponse, Problem } from "../schemas/api.js";
+//#region src/conformance/index.ts
+var UNKNOWN = "__panneau_conformance_unknown__";
+function describeIssues(error) {
+	return error.issues.slice(0, 10).map((issue) => {
+		const path = issue.path.map(String).join(".");
+		return path === "" ? issue.message : `${path}: ${issue.message}`;
+	});
+}
+function normalizeEtag(value) {
+	return value.replace(/^W\//, "");
+}
+var Check = class {
+	issues = [];
+	skippedBecause = null;
+	expect(condition, issue) {
+		if (!condition) this.issues.push(issue);
+		return condition;
+	}
+	expectStatus(reply, status) {
+		return this.expect(reply.status === status, `Expected status ${status}, got ${reply.status}.`);
+	}
+	expectSchema(schema, value, label) {
+		const result = schema.safeParse(value);
+		if (result.success) return result.data;
+		this.issues.push(`${label} does not match the schema:`, ...describeIssues(result.error).map((issue) => `  ${issue}`));
+		return null;
+	}
+	expectProblem(reply, status) {
+		if (!this.expectStatus(reply, status)) return null;
+		this.expect(reply.contentType.startsWith(PROBLEM_CONTENT_TYPE), `Expected content type ${PROBLEM_CONTENT_TYPE}, got "${reply.contentType}".`);
+		return this.expectSchema(Problem, reply.body, "The error");
+	}
+	skip(reason) {
+		this.skippedBecause = reason;
+	}
+};
+/**
+* Runs the protocol's conformance checks against a live backend. Read-only checks always run;
+* checks that write data run only with `writes`.
+*/
+async function runConformance(options) {
+	const fetcher = options.fetch ?? ((input, init) => fetch(input, init));
+	const baseUrl = options.baseUrl.replace(/\/$/, "");
+	const checks = [];
+	const request = async (path, init = {}) => {
+		const headers = new Headers(options.init?.headers);
+		headers.set("Accept", "application/json");
+		new Headers(init.headers).forEach((value, key) => headers.set(key, value));
+		if (init.body !== void 0) headers.set("Content-Type", "application/json");
+		const response = await fetcher(`${baseUrl}${path}`, {
+			...options.init,
+			...init,
+			headers
+		});
+		const text = await response.text();
+		const parse = () => {
+			if (text === "") return null;
+			try {
+				return JSON.parse(text);
+			} catch {
+				return text;
+			}
+		};
+		const body = parse();
+		return {
+			status: response.status,
+			contentType: response.headers.get("Content-Type") ?? "",
+			etag: response.headers.get("ETag"),
+			body
+		};
+	};
+	const run = async (id, title, body) => {
+		const check = new Check();
+		try {
+			await body(check);
+		} catch (error) {
+			check.issues.push(`Request failed: ${error instanceof Error ? error.message : String(error)}`);
+		}
+		const status = check.issues.length > 0 ? "failed" : check.skippedBecause !== null ? "skipped" : "passed";
+		checks.push({
+			id,
+			title,
+			status,
+			issues: status === "skipped" && check.skippedBecause !== null ? [check.skippedBecause] : check.issues
+		});
+	};
+	let definition = null;
+	let resource = null;
+	let firstItemId = null;
+	await run("definition", "GET /definition returns a valid definition", async (check) => {
+		const reply = await request("/definition");
+		if (check.expectStatus(reply, 200)) definition = check.expectSchema(Definition, reply.body, "The definition");
+	});
+	await run("definition.resource", "The definition has the resource to test", async (check) => {
+		const current = definition;
+		if (current === null) {
+			check.skip("No valid definition.");
+			return;
+		}
+		resource = (options.resource !== void 0 ? current.resources.find((candidate) => candidate.id === options.resource) : current.resources[0]) ?? null;
+		check.expect(resource !== null, options.resource !== void 0 ? `The definition has no resource "${options.resource}".` : "The definition has no resources.");
+	});
+	const resourcePath = () => `/resources/${encodeURIComponent(resource?.id ?? "")}`;
+	await run("list", "GET /resources/{resource} returns a page of items", async (check) => {
+		if (resource === null) {
+			check.skip("No resource to test.");
+			return;
+		}
+		const reply = await request(`${resourcePath()}?page=1&perPage=2`);
+		if (!check.expectStatus(reply, 200)) return;
+		const list = check.expectSchema(ListResponse, reply.body, "The list");
+		if (list === null) return;
+		check.expect(list.data.length <= 2, `perPage=2 returned ${list.data.length} items.`);
+		check.expect(list.meta.page === 1, `meta.page is ${list.meta.page}, expected 1.`);
+		check.expect(list.meta.perPage === 2, `meta.perPage is ${list.meta.perPage}, expected 2.`);
+		firstItemId = list.data[0]?.id ?? null;
+	});
+	await run("list.sort", "GET /resources/{resource} accepts a sort", async (check) => {
+		const sort = resource?.list?.sorts?.[0];
+		if (sort === void 0) {
+			check.skip("The resource declares no sorts.");
+			return;
+		}
+		const reply = await request(`${resourcePath()}?sort=${encodeURIComponent(`-${sort}`)}`);
+		if (check.expectStatus(reply, 200)) check.expectSchema(ListResponse, reply.body, "The sorted list");
+	});
+	await run("list.unknown-resource", "An unknown resource is a 404 problem", async (check) => {
+		check.expectProblem(await request(`/resources/${UNKNOWN}`), 404);
+	});
+	await run("item", "GET /resources/{resource}/{id} returns the item with its ETag", async (check) => {
+		if (firstItemId === null) {
+			check.skip("The list has no items.");
+			return;
+		}
+		const reply = await request(`${resourcePath()}/${encodeURIComponent(firstItemId)}`);
+		if (!check.expectStatus(reply, 200)) return;
+		const item = check.expectSchema(ItemResponse, reply.body, "The item");
+		if (item === null) return;
+		check.expect(item.data.id === firstItemId, `Asked for item "${firstItemId}", got "${item.data.id}".`);
+		if (item.data.version !== null) check.expect(reply.etag !== null && normalizeEtag(reply.etag) === `"${item.data.version}"`, `Expected ETag "${item.data.version}" (quoted), got ${reply.etag ?? "none"}.`);
+	});
+	await run("item.missing", "A missing item is a 404 problem", async (check) => {
+		if (resource === null) {
+			check.skip("No resource to test.");
+			return;
+		}
+		check.expectProblem(await request(`${resourcePath()}/${UNKNOWN}`), 404);
+	});
+	const writes = options.writes;
+	let createdId = null;
+	let createdVersion = null;
+	await run("create.invalid", "Invalid values are refused with a 422 problem", async (check) => {
+		if (writes === void 0 || resource === null) {
+			check.skip("Write checks are disabled.");
+			return;
+		}
+		const hasRequired = resource.fields.some((field) => (field.rules ?? []).some((rule) => rule.rule === "required"));
+		if (writes.invalid === void 0 && !hasRequired) {
+			check.skip("No invalid values given, and the resource has no required field.");
+			return;
+		}
+		const reply = await request(resourcePath(), {
+			method: "POST",
+			body: JSON.stringify(writes.invalid ?? {})
+		});
+		const failure = check.expectProblem(reply, 422);
+		if (failure !== null) check.expect(failure.errors !== void 0 && Object.keys(failure.errors).length > 0, "A 422 problem must list the invalid values in `errors`.");
+	});
+	await run("create", "POST /resources/{resource} creates an item", async (check) => {
+		if (writes === void 0 || resource === null) {
+			check.skip("Write checks are disabled.");
+			return;
+		}
+		const reply = await request(resourcePath(), {
+			method: "POST",
+			body: JSON.stringify(writes.create)
+		});
+		if (!check.expectStatus(reply, 201)) return;
+		const item = check.expectSchema(ItemResponse, reply.body, "The created item");
+		createdId = item?.data.id ?? null;
+		createdVersion = item?.data.version ?? null;
+	});
+	const itemPath = () => `${resourcePath()}/${encodeURIComponent(createdId ?? "")}`;
+	await run("update", "PATCH /resources/{resource}/{id} updates the item", async (check) => {
+		if (createdId === null || writes === void 0) {
+			check.skip("No item was created.");
+			return;
+		}
+		const reply = await request(itemPath(), {
+			method: "PATCH",
+			body: JSON.stringify(writes.update),
+			headers: createdVersion !== null ? { "If-Match": `"${createdVersion}"` } : {}
+		});
+		if (!check.expectStatus(reply, 200)) return;
+		const item = check.expectSchema(ItemResponse, reply.body, "The updated item");
+		if (item !== null && createdVersion !== null) check.expect(item.data.version !== createdVersion, "The version did not change after an update.");
+	});
+	await run("update.conflict", "A stale If-Match is a 412 problem with the current item", async (check) => {
+		if (createdId === null || writes === void 0) {
+			check.skip("No item was created.");
+			return;
+		}
+		if (createdVersion === null) {
+			check.skip("The backend has no versions.");
+			return;
+		}
+		const reply = await request(itemPath(), {
+			method: "PATCH",
+			body: JSON.stringify(writes.update),
+			headers: { "If-Match": "\"__panneau_conformance_stale__\"" }
+		});
+		const failure = check.expectProblem(reply, 412);
+		if (failure !== null) check.expect(failure.current !== void 0, "A 412 problem must include the current item.");
+	});
+	await run("delete", "DELETE /resources/{resource}/{id} deletes the item", async (check) => {
+		if (createdId === null) {
+			check.skip("No item was created.");
+			return;
+		}
+		if (!check.expectStatus(await request(itemPath(), { method: "DELETE" }), 204)) return;
+		check.expectProblem(await request(itemPath()), 404);
+	});
+	return {
+		passed: checks.every((check) => check.status !== "failed"),
+		checks
+	};
+}
+/** Formats a report as text, one line per check. */
+function formatReport(report) {
+	const symbols = {
+		passed: "✓",
+		failed: "✗",
+		skipped: "-"
+	};
+	return report.checks.map((check) => [`${symbols[check.status]} ${check.title}`, ...check.issues.map((issue) => `    ${issue}`)].join("\n")).join("\n");
+}
+//#endregion
+export { formatReport, runConformance };
+
+//# sourceMappingURL=index.js.map

package/dist/conformance/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/conformance/index.ts"],"sourcesContent":["import type { z } from 'zod';\n\nimport { Definition, type Resource } from '../schemas';\nimport { ItemResponse, ListResponse, Problem } from '../schemas/api';\nimport { PROBLEM_CONTENT_TYPE } from '../version';\n\nexport interface ConformanceOptions {\n    /** Base URL of the API, the same as `api.baseUrl` of the definition, but absolute. */\n    baseUrl: string;\n    /** The `fetch` to use. Defaults to the global one. */\n    fetch?: (input: string, init?: RequestInit) => Promise<Response>;\n    /** Merged into every request, for authentication headers or cookies. */\n    init?: RequestInit;\n    /** Resource to test. Defaults to the first resource of the definition. */\n    resource?: string;\n    /**\n     * Enables the checks that write data, on the tested resource. Use a test database: these\n     * checks create, update and delete an item.\n     */\n    writes?: {\n        /** Valid values for a new item. */\n        create: Record<string, unknown>;\n        /** Valid values for an update. */\n        update: Record<string, unknown>;\n        /** Values that must be refused with a `422`. Defaults to `{}` when a field is required. */\n        invalid?: Record<string, unknown>;\n    };\n}\n\nexport type ConformanceStatus = 'passed' | 'failed' | 'skipped';\n\nexport interface ConformanceCheck {\n    id: string;\n    title: string;\n    status: ConformanceStatus;\n    /** What went wrong, or why the check was skipped. */\n    issues: string[];\n}\n\nexport interface ConformanceReport {\n    passed: boolean;\n    checks: ConformanceCheck[];\n}\n\ninterface Reply {\n    status: number;\n    contentType: string;\n    etag: string | null;\n    body: unknown;\n}\n\nconst UNKNOWN = '__panneau_conformance_unknown__';\n\nfunction describeIssues(error: z.ZodError): string[] {\n    return error.issues.slice(0, 10).map((issue) => {\n        const path = issue.path.map(String).join('.');\n        return path === '' ? issue.message : `${path}: ${issue.message}`;\n    });\n}\n\nfunction normalizeEtag(value: string): string {\n    return value.replace(/^W\\//, '');\n}\n\nclass Check {\n    issues: string[] = [];\n    skippedBecause: string | null = null;\n\n    expect(condition: boolean, issue: string): boolean {\n        if (!condition) {\n            this.issues.push(issue);\n        }\n        return condition;\n    }\n\n    expectStatus(reply: Reply, status: number): boolean {\n        return this.expect(\n            reply.status === status,\n            `Expected status ${status}, got ${reply.status}.`,\n        );\n    }\n\n    expectSchema<T extends z.ZodType>(schema: T, value: unknown, label: string): z.infer<T> | null {\n        const result = schema.safeParse(value);\n        if (result.success) {\n            return result.data;\n        }\n        this.issues.push(\n            `${label} does not match the schema:`,\n            ...describeIssues(result.error).map((issue) => `  ${issue}`),\n        );\n        return null;\n    }\n\n    expectProblem(reply: Reply, status: number): Problem | null {\n        if (!this.expectStatus(reply, status)) {\n            return null;\n        }\n        this.expect(\n            reply.contentType.startsWith(PROBLEM_CONTENT_TYPE),\n            `Expected content type ${PROBLEM_CONTENT_TYPE}, got \"${reply.contentType}\".`,\n        );\n        return this.expectSchema(Problem, reply.body, 'The error');\n    }\n\n    skip(reason: string) {\n        this.skippedBecause = reason;\n    }\n}\n\n/**\n * Runs the protocol's conformance checks against a live backend. Read-only checks always run;\n * checks that write data run only with `writes`.\n */\nexport async function runConformance(options: ConformanceOptions): Promise<ConformanceReport> {\n    const fetcher = options.fetch ?? ((input: string, init?: RequestInit) => fetch(input, init));\n    const baseUrl = options.baseUrl.replace(/\\/$/, '');\n    const checks: ConformanceCheck[] = [];\n\n    const request = async (path: string, init: RequestInit = {}): Promise<Reply> => {\n        const headers = new Headers(options.init?.headers);\n        headers.set('Accept', 'application/json');\n        new Headers(init.headers).forEach((value, key) => headers.set(key, value));\n        if (init.body !== undefined) {\n            headers.set('Content-Type', 'application/json');\n        }\n        const response = await fetcher(`${baseUrl}${path}`, { ...options.init, ...init, headers });\n        const text = await response.text();\n        const parse = (): unknown => {\n            if (text === '') {\n                return null;\n            }\n            try {\n                return JSON.parse(text);\n            } catch {\n                return text;\n            }\n        };\n        const body = parse();\n        return {\n            status: response.status,\n            contentType: response.headers.get('Content-Type') ?? '',\n            etag: response.headers.get('ETag'),\n            body,\n        };\n    };\n\n    const run = async (id: string, title: string, body: (check: Check) => Promise<void>) => {\n        const check = new Check();\n        try {\n            await body(check);\n        } catch (error) {\n            check.issues.push(\n                `Request failed: ${error instanceof Error ? error.message : String(error)}`,\n            );\n        }\n        const status: ConformanceStatus =\n            check.issues.length > 0\n                ? 'failed'\n                : check.skippedBecause !== null\n                  ? 'skipped'\n                  : 'passed';\n        checks.push({\n            id,\n            title,\n            status,\n            issues:\n                status === 'skipped' && check.skippedBecause !== null\n                    ? [check.skippedBecause]\n                    : check.issues,\n        });\n    };\n\n    let definition: Definition | null = null;\n    let resource: Resource | null = null;\n    let firstItemId: string | null = null;\n\n    await run('definition', 'GET /definition returns a valid definition', async (check) => {\n        const reply = await request('/definition');\n        if (check.expectStatus(reply, 200)) {\n            definition = check.expectSchema(Definition, reply.body, 'The definition');\n        }\n    });\n\n    await run('definition.resource', 'The definition has the resource to test', async (check) => {\n        const current = definition as Definition | null;\n        if (current === null) {\n            check.skip('No valid definition.');\n            return;\n        }\n        resource =\n            (options.resource !== undefined\n                ? current.resources.find((candidate) => candidate.id === options.resource)\n                : current.resources[0]) ?? null;\n        check.expect(\n            resource !== null,\n            options.resource !== undefined\n                ? `The definition has no resource \"${options.resource}\".`\n                : 'The definition has no resources.',\n        );\n    });\n\n    const resourcePath = () =>\n        `/resources/${encodeURIComponent((resource as Resource | null)?.id ?? '')}`;\n\n    await run('list', 'GET /resources/{resource} returns a page of items', async (check) => {\n        if (resource === null) {\n            check.skip('No resource to test.');\n            return;\n        }\n        const reply = await request(`${resourcePath()}?page=1&perPage=2`);\n        if (!check.expectStatus(reply, 200)) {\n            return;\n        }\n        const list = check.expectSchema(ListResponse, reply.body, 'The list');\n        if (list === null) {\n            return;\n        }\n        check.expect(list.data.length <= 2, `perPage=2 returned ${list.data.length} items.`);\n        check.expect(list.meta.page === 1, `meta.page is ${list.meta.page}, expected 1.`);\n        check.expect(list.meta.perPage === 2, `meta.perPage is ${list.meta.perPage}, expected 2.`);\n        firstItemId = list.data[0]?.id ?? null;\n    });\n\n    await run('list.sort', 'GET /resources/{resource} accepts a sort', async (check) => {\n        const sort = (resource as Resource | null)?.list?.sorts?.[0];\n        if (sort === undefined) {\n            check.skip('The resource declares no sorts.');\n            return;\n        }\n        const reply = await request(`${resourcePath()}?sort=${encodeURIComponent(`-${sort}`)}`);\n        if (check.expectStatus(reply, 200)) {\n            check.expectSchema(ListResponse, reply.body, 'The sorted list');\n        }\n    });\n\n    await run('list.unknown-resource', 'An unknown resource is a 404 problem', async (check) => {\n        check.expectProblem(await request(`/resources/${UNKNOWN}`), 404);\n    });\n\n    await run(\n        'item',\n        'GET /resources/{resource}/{id} returns the item with its ETag',\n        async (check) => {\n            if (firstItemId === null) {\n                check.skip('The list has no items.');\n                return;\n            }\n            const reply = await request(`${resourcePath()}/${encodeURIComponent(firstItemId)}`);\n            if (!check.expectStatus(reply, 200)) {\n                return;\n            }\n            const item = check.expectSchema(ItemResponse, reply.body, 'The item');\n            if (item === null) {\n                return;\n            }\n            check.expect(\n                item.data.id === firstItemId,\n                `Asked for item \"${firstItemId}\", got \"${item.data.id}\".`,\n            );\n            if (item.data.version !== null) {\n                check.expect(\n                    reply.etag !== null && normalizeEtag(reply.etag) === `\"${item.data.version}\"`,\n                    `Expected ETag \"${item.data.version}\" (quoted), got ${reply.etag ?? 'none'}.`,\n                );\n            }\n        },\n    );\n\n    await run('item.missing', 'A missing item is a 404 problem', async (check) => {\n        if (resource === null) {\n            check.skip('No resource to test.');\n            return;\n        }\n        check.expectProblem(await request(`${resourcePath()}/${UNKNOWN}`), 404);\n    });\n\n    const writes = options.writes;\n    let createdId: string | null = null;\n    let createdVersion: string | null = null;\n\n    await run('create.invalid', 'Invalid values are refused with a 422 problem', async (check) => {\n        if (writes === undefined || resource === null) {\n            check.skip('Write checks are disabled.');\n            return;\n        }\n        const hasRequired = resource.fields.some((field) =>\n            (field.rules ?? []).some((rule) => rule.rule === 'required'),\n        );\n        if (writes.invalid === undefined && !hasRequired) {\n            check.skip('No invalid values given, and the resource has no required field.');\n            return;\n        }\n        const reply = await request(resourcePath(), {\n            method: 'POST',\n            body: JSON.stringify(writes.invalid ?? {}),\n        });\n        const failure = check.expectProblem(reply, 422);\n        if (failure !== null) {\n            check.expect(\n                failure.errors !== undefined && Object.keys(failure.errors).length > 0,\n                'A 422 problem must list the invalid values in `errors`.',\n            );\n        }\n    });\n\n    await run('create', 'POST /resources/{resource} creates an item', async (check) => {\n        if (writes === undefined || resource === null) {\n            check.skip('Write checks are disabled.');\n            return;\n        }\n        const reply = await request(resourcePath(), {\n            method: 'POST',\n            body: JSON.stringify(writes.create),\n        });\n        if (!check.expectStatus(reply, 201)) {\n            return;\n        }\n        const item = check.expectSchema(ItemResponse, reply.body, 'The created item');\n        createdId = item?.data.id ?? null;\n        createdVersion = item?.data.version ?? null;\n    });\n\n    const itemPath = () => `${resourcePath()}/${encodeURIComponent(createdId ?? '')}`;\n\n    await run('update', 'PATCH /resources/{resource}/{id} updates the item', async (check) => {\n        if (createdId === null || writes === undefined) {\n            check.skip('No item was created.');\n            return;\n        }\n        const reply = await request(itemPath(), {\n            method: 'PATCH',\n            body: JSON.stringify(writes.update),\n            headers: createdVersion !== null ? { 'If-Match': `\"${createdVersion}\"` } : {},\n        });\n        if (!check.expectStatus(reply, 200)) {\n            return;\n        }\n        const item = check.expectSchema(ItemResponse, reply.body, 'The updated item');\n        if (item !== null && createdVersion !== null) {\n            check.expect(\n                item.data.version !== createdVersion,\n                'The version did not change after an update.',\n            );\n        }\n    });\n\n    await run(\n        'update.conflict',\n        'A stale If-Match is a 412 problem with the current item',\n        async (check) => {\n            if (createdId === null || writes === undefined) {\n                check.skip('No item was created.');\n                return;\n            }\n            if (createdVersion === null) {\n                check.skip('The backend has no versions.');\n                return;\n            }\n            const reply = await request(itemPath(), {\n                method: 'PATCH',\n                body: JSON.stringify(writes.update),\n                headers: { 'If-Match': '\"__panneau_conformance_stale__\"' },\n            });\n            const failure = check.expectProblem(reply, 412);\n            if (failure !== null) {\n                check.expect(\n                    failure.current !== undefined,\n                    'A 412 problem must include the current item.',\n                );\n            }\n        },\n    );\n\n    await run('delete', 'DELETE /resources/{resource}/{id} deletes the item', async (check) => {\n        if (createdId === null) {\n            check.skip('No item was created.');\n            return;\n        }\n        if (!check.expectStatus(await request(itemPath(), { method: 'DELETE' }), 204)) {\n            return;\n        }\n        check.expectProblem(await request(itemPath()), 404);\n    });\n\n    return { passed: checks.every((check) => check.status !== 'failed'), checks };\n}\n\n/** Formats a report as text, one line per check. */\nexport function formatReport(report: ConformanceReport): string {\n    const symbols: Record<ConformanceStatus, string> = { passed: '✓', failed: '✗', skipped: '-' };\n    return report.checks\n        .map((check) =>\n            [\n                `${symbols[check.status]} ${check.title}`,\n                ...check.issues.map((issue) => `    ${issue}`),\n            ].join('\\n'),\n        )\n        .join('\\n');\n}\n"],"mappings":";;;;AAmDA,IAAM,UAAU;AAEhB,SAAS,eAAe,OAA6B;CACjD,OAAO,MAAM,OAAO,MAAM,GAAG,EAAE,CAAC,CAAC,KAAK,UAAU;EAC5C,MAAM,OAAO,MAAM,KAAK,IAAI,MAAM,CAAC,CAAC,KAAK,GAAG;EAC5C,OAAO,SAAS,KAAK,MAAM,UAAU,GAAG,KAAK,IAAI,MAAM;CAC3D,CAAC;AACL;AAEA,SAAS,cAAc,OAAuB;CAC1C,OAAO,MAAM,QAAQ,QAAQ,EAAE;AACnC;AAEA,IAAM,QAAN,MAAY;CACR,SAAmB,CAAC;CACpB,iBAAgC;CAEhC,OAAO,WAAoB,OAAwB;EAC/C,IAAI,CAAC,WACD,KAAK,OAAO,KAAK,KAAK;EAE1B,OAAO;CACX;CAEA,aAAa,OAAc,QAAyB;EAChD,OAAO,KAAK,OACR,MAAM,WAAW,QACjB,mBAAmB,OAAO,QAAQ,MAAM,OAAO,EACnD;CACJ;CAEA,aAAkC,QAAW,OAAgB,OAAkC;EAC3F,MAAM,SAAS,OAAO,UAAU,KAAK;EACrC,IAAI,OAAO,SACP,OAAO,OAAO;EAElB,KAAK,OAAO,KACR,GAAG,MAAM,8BACT,GAAG,eAAe,OAAO,KAAK,CAAC,CAAC,KAAK,UAAU,KAAK,OAAO,CAC/D;EACA,OAAO;CACX;CAEA,cAAc,OAAc,QAAgC;EACxD,IAAI,CAAC,KAAK,aAAa,OAAO,MAAM,GAChC,OAAO;EAEX,KAAK,OACD,MAAM,YAAY,WAAW,oBAAoB,GACjD,yBAAyB,qBAAqB,SAAS,MAAM,YAAY,GAC7E;EACA,OAAO,KAAK,aAAa,SAAS,MAAM,MAAM,WAAW;CAC7D;CAEA,KAAK,QAAgB;EACjB,KAAK,iBAAiB;CAC1B;AACJ;;;;;AAMA,eAAsB,eAAe,SAAyD;CAC1F,MAAM,UAAU,QAAQ,WAAW,OAAe,SAAuB,MAAM,OAAO,IAAI;CAC1F,MAAM,UAAU,QAAQ,QAAQ,QAAQ,OAAO,EAAE;CACjD,MAAM,SAA6B,CAAC;CAEpC,MAAM,UAAU,OAAO,MAAc,OAAoB,CAAC,MAAsB;EAC5E,MAAM,UAAU,IAAI,QAAQ,QAAQ,MAAM,OAAO;EACjD,QAAQ,IAAI,UAAU,kBAAkB;EACxC,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC,SAAS,OAAO,QAAQ,QAAQ,IAAI,KAAK,KAAK,CAAC;EACzE,IAAI,KAAK,SAAS,KAAA,GACd,QAAQ,IAAI,gBAAgB,kBAAkB;EAElD,MAAM,WAAW,MAAM,QAAQ,GAAG,UAAU,QAAQ;GAAE,GAAG,QAAQ;GAAM,GAAG;GAAM;EAAQ,CAAC;EACzF,MAAM,OAAO,MAAM,SAAS,KAAK;EACjC,MAAM,cAAuB;GACzB,IAAI,SAAS,IACT,OAAO;GAEX,IAAI;IACA,OAAO,KAAK,MAAM,IAAI;GAC1B,QAAQ;IACJ,OAAO;GACX;EACJ;EACA,MAAM,OAAO,MAAM;EACnB,OAAO;GACH,QAAQ,SAAS;GACjB,aAAa,SAAS,QAAQ,IAAI,cAAc,KAAK;GACrD,MAAM,SAAS,QAAQ,IAAI,MAAM;GACjC;EACJ;CACJ;CAEA,MAAM,MAAM,OAAO,IAAY,OAAe,SAA0C;EACpF,MAAM,QAAQ,IAAI,MAAM;EACxB,IAAI;GACA,MAAM,KAAK,KAAK;EACpB,SAAS,OAAO;GACZ,MAAM,OAAO,KACT,mBAAmB,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,GAC5E;EACJ;EACA,MAAM,SACF,MAAM,OAAO,SAAS,IAChB,WACA,MAAM,mBAAmB,OACvB,YACA;EACZ,OAAO,KAAK;GACR;GACA;GACA;GACA,QACI,WAAW,aAAa,MAAM,mBAAmB,OAC3C,CAAC,MAAM,cAAc,IACrB,MAAM;EACpB,CAAC;CACL;CAEA,IAAI,aAAgC;CACpC,IAAI,WAA4B;CAChC,IAAI,cAA6B;CAEjC,MAAM,IAAI,cAAc,8CAA8C,OAAO,UAAU;EACnF,MAAM,QAAQ,MAAM,QAAQ,aAAa;EACzC,IAAI,MAAM,aAAa,OAAO,GAAG,GAC7B,aAAa,MAAM,aAAa,YAAY,MAAM,MAAM,gBAAgB;CAEhF,CAAC;CAED,MAAM,IAAI,uBAAuB,2CAA2C,OAAO,UAAU;EACzF,MAAM,UAAU;EAChB,IAAI,YAAY,MAAM;GAClB,MAAM,KAAK,sBAAsB;GACjC;EACJ;EACA,YACK,QAAQ,aAAa,KAAA,IAChB,QAAQ,UAAU,MAAM,cAAc,UAAU,OAAO,QAAQ,QAAQ,IACvE,QAAQ,UAAU,OAAO;EACnC,MAAM,OACF,aAAa,MACb,QAAQ,aAAa,KAAA,IACf,mCAAmC,QAAQ,SAAS,MACpD,kCACV;CACJ,CAAC;CAED,MAAM,qBACF,cAAc,mBAAoB,UAA8B,MAAM,EAAE;CAE5E,MAAM,IAAI,QAAQ,qDAAqD,OAAO,UAAU;EACpF,IAAI,aAAa,MAAM;GACnB,MAAM,KAAK,sBAAsB;GACjC;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,GAAG,aAAa,EAAE,kBAAkB;EAChE,IAAI,CAAC,MAAM,aAAa,OAAO,GAAG,GAC9B;EAEJ,MAAM,OAAO,MAAM,aAAa,cAAc,MAAM,MAAM,UAAU;EACpE,IAAI,SAAS,MACT;EAEJ,MAAM,OAAO,KAAK,KAAK,UAAU,GAAG,sBAAsB,KAAK,KAAK,OAAO,QAAQ;EACnF,MAAM,OAAO,KAAK,KAAK,SAAS,GAAG,gBAAgB,KAAK,KAAK,KAAK,cAAc;EAChF,MAAM,OAAO,KAAK,KAAK,YAAY,GAAG,mBAAmB,KAAK,KAAK,QAAQ,cAAc;EACzF,cAAc,KAAK,KAAK,EAAE,EAAE,MAAM;CACtC,CAAC;CAED,MAAM,IAAI,aAAa,4CAA4C,OAAO,UAAU;EAChF,MAAM,OAAQ,UAA8B,MAAM,QAAQ;EAC1D,IAAI,SAAS,KAAA,GAAW;GACpB,MAAM,KAAK,iCAAiC;GAC5C;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,GAAG,aAAa,EAAE,QAAQ,mBAAmB,IAAI,MAAM,GAAG;EACtF,IAAI,MAAM,aAAa,OAAO,GAAG,GAC7B,MAAM,aAAa,cAAc,MAAM,MAAM,iBAAiB;CAEtE,CAAC;CAED,MAAM,IAAI,yBAAyB,wCAAwC,OAAO,UAAU;EACxF,MAAM,cAAc,MAAM,QAAQ,cAAc,SAAS,GAAG,GAAG;CACnE,CAAC;CAED,MAAM,IACF,QACA,iEACA,OAAO,UAAU;EACb,IAAI,gBAAgB,MAAM;GACtB,MAAM,KAAK,wBAAwB;GACnC;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,GAAG,aAAa,EAAE,GAAG,mBAAmB,WAAW,GAAG;EAClF,IAAI,CAAC,MAAM,aAAa,OAAO,GAAG,GAC9B;EAEJ,MAAM,OAAO,MAAM,aAAa,cAAc,MAAM,MAAM,UAAU;EACpE,IAAI,SAAS,MACT;EAEJ,MAAM,OACF,KAAK,KAAK,OAAO,aACjB,mBAAmB,YAAY,UAAU,KAAK,KAAK,GAAG,GAC1D;EACA,IAAI,KAAK,KAAK,YAAY,MACtB,MAAM,OACF,MAAM,SAAS,QAAQ,cAAc,MAAM,IAAI,MAAM,IAAI,KAAK,KAAK,QAAQ,IAC3E,kBAAkB,KAAK,KAAK,QAAQ,kBAAkB,MAAM,QAAQ,OAAO,EAC/E;CAER,CACJ;CAEA,MAAM,IAAI,gBAAgB,mCAAmC,OAAO,UAAU;EAC1E,IAAI,aAAa,MAAM;GACnB,MAAM,KAAK,sBAAsB;GACjC;EACJ;EACA,MAAM,cAAc,MAAM,QAAQ,GAAG,aAAa,EAAE,GAAG,SAAS,GAAG,GAAG;CAC1E,CAAC;CAED,MAAM,SAAS,QAAQ;CACvB,IAAI,YAA2B;CAC/B,IAAI,iBAAgC;CAEpC,MAAM,IAAI,kBAAkB,iDAAiD,OAAO,UAAU;EAC1F,IAAI,WAAW,KAAA,KAAa,aAAa,MAAM;GAC3C,MAAM,KAAK,4BAA4B;GACvC;EACJ;EACA,MAAM,cAAc,SAAS,OAAO,MAAM,WACrC,MAAM,SAAS,CAAC,EAAA,CAAG,MAAM,SAAS,KAAK,SAAS,UAAU,CAC/D;EACA,IAAI,OAAO,YAAY,KAAA,KAAa,CAAC,aAAa;GAC9C,MAAM,KAAK,kEAAkE;GAC7E;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,aAAa,GAAG;GACxC,QAAQ;GACR,MAAM,KAAK,UAAU,OAAO,WAAW,CAAC,CAAC;EAC7C,CAAC;EACD,MAAM,UAAU,MAAM,cAAc,OAAO,GAAG;EAC9C,IAAI,YAAY,MACZ,MAAM,OACF,QAAQ,WAAW,KAAA,KAAa,OAAO,KAAK,QAAQ,MAAM,CAAC,CAAC,SAAS,GACrE,yDACJ;CAER,CAAC;CAED,MAAM,IAAI,UAAU,8CAA8C,OAAO,UAAU;EAC/E,IAAI,WAAW,KAAA,KAAa,aAAa,MAAM;GAC3C,MAAM,KAAK,4BAA4B;GACvC;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,aAAa,GAAG;GACxC,QAAQ;GACR,MAAM,KAAK,UAAU,OAAO,MAAM;EACtC,CAAC;EACD,IAAI,CAAC,MAAM,aAAa,OAAO,GAAG,GAC9B;EAEJ,MAAM,OAAO,MAAM,aAAa,cAAc,MAAM,MAAM,kBAAkB;EAC5E,YAAY,MAAM,KAAK,MAAM;EAC7B,iBAAiB,MAAM,KAAK,WAAW;CAC3C,CAAC;CAED,MAAM,iBAAiB,GAAG,aAAa,EAAE,GAAG,mBAAmB,aAAa,EAAE;CAE9E,MAAM,IAAI,UAAU,qDAAqD,OAAO,UAAU;EACtF,IAAI,cAAc,QAAQ,WAAW,KAAA,GAAW;GAC5C,MAAM,KAAK,sBAAsB;GACjC;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,SAAS,GAAG;GACpC,QAAQ;GACR,MAAM,KAAK,UAAU,OAAO,MAAM;GAClC,SAAS,mBAAmB,OAAO,EAAE,YAAY,IAAI,eAAe,GAAG,IAAI,CAAC;EAChF,CAAC;EACD,IAAI,CAAC,MAAM,aAAa,OAAO,GAAG,GAC9B;EAEJ,MAAM,OAAO,MAAM,aAAa,cAAc,MAAM,MAAM,kBAAkB;EAC5E,IAAI,SAAS,QAAQ,mBAAmB,MACpC,MAAM,OACF,KAAK,KAAK,YAAY,gBACtB,6CACJ;CAER,CAAC;CAED,MAAM,IACF,mBACA,2DACA,OAAO,UAAU;EACb,IAAI,cAAc,QAAQ,WAAW,KAAA,GAAW;GAC5C,MAAM,KAAK,sBAAsB;GACjC;EACJ;EACA,IAAI,mBAAmB,MAAM;GACzB,MAAM,KAAK,8BAA8B;GACzC;EACJ;EACA,MAAM,QAAQ,MAAM,QAAQ,SAAS,GAAG;GACpC,QAAQ;GACR,MAAM,KAAK,UAAU,OAAO,MAAM;GAClC,SAAS,EAAE,YAAY,oCAAkC;EAC7D,CAAC;EACD,MAAM,UAAU,MAAM,cAAc,OAAO,GAAG;EAC9C,IAAI,YAAY,MACZ,MAAM,OACF,QAAQ,YAAY,KAAA,GACpB,8CACJ;CAER,CACJ;CAEA,MAAM,IAAI,UAAU,sDAAsD,OAAO,UAAU;EACvF,IAAI,cAAc,MAAM;GACpB,MAAM,KAAK,sBAAsB;GACjC;EACJ;EACA,IAAI,CAAC,MAAM,aAAa,MAAM,QAAQ,SAAS,GAAG,EAAE,QAAQ,SAAS,CAAC,GAAG,GAAG,GACxE;EAEJ,MAAM,cAAc,MAAM,QAAQ,SAAS,CAAC,GAAG,GAAG;CACtD,CAAC;CAED,OAAO;EAAE,QAAQ,OAAO,OAAO,UAAU,MAAM,WAAW,QAAQ;EAAG;CAAO;AAChF;;AAGA,SAAgB,aAAa,QAAmC;CAC5D,MAAM,UAA6C;EAAE,QAAQ;EAAK,QAAQ;EAAK,SAAS;CAAI;CAC5F,OAAO,OAAO,OACT,KAAK,UACF,CACI,GAAG,QAAQ,MAAM,QAAQ,GAAG,MAAM,SAClC,GAAG,MAAM,OAAO,KAAK,UAAU,OAAO,OAAO,CACjD,CAAC,CAAC,KAAK,IAAI,CACf,CAAC,CACA,KAAK,IAAI;AAClB"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from './version';
+export * from './schemas';
+export { type ValidationIssue, type ValidationResult, isProblem, validate, validateBootConfig, validateDefinition, } from './validate';
+export { type CheckOptions, type RuleFailure, checkRules, checkValues } from './rules';
+export { evaluateCondition } from './conditions';
+export { lintDefinition } from './lint';
+export { type FilterValue, type ListQuery, fromSearchParams, toSearchParams } from './query';
+export { getValue, isFilled } from './values';
+export { createBootConfigJsonSchema, createComponentSchemas, createDefinitionJsonSchema, createOpenApiDocument, } from './openapi';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACnE,cAAc,WAAW,CAAC;AAC1B,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,SAAS,EACT,QAAQ,EACR,kBAAkB,EAClB,kBAAkB,GACrB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC7F,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EACH,0BAA0B,EAC1B,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,GACxB,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+import { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from "./version.js";
+import { Abilities, Condition, Id, Option, RouteReference } from "./schemas/common.js";
+import { BUILT_IN_FIELD_TYPES, BlockType, Field, PORTABLE_RULES, Rule } from "./schemas/field.js";
+import { BUILT_IN_LAYOUT_NODE_TYPES, LayoutNode } from "./schemas/layout.js";
+import { Action, ActionConfirm, ActionPlacement, ActionScope, BUILT_IN_ACTIONS } from "./schemas/action.js";
+import { BUILT_IN_LIST_LAYOUTS, Column, Filter, ListDefinition } from "./schemas/list.js";
+import { Resource, ResourceFeatures } from "./schemas/resource.js";
+import { Auth, AuthProvider, Definition, MenuItem, Page, Uploads, User, Widget } from "./schemas/definition.js";
+import { ActionItemResult, ActionRequest, ActionResult, ActionRun, ActionRunResponse, Item, ItemResponse, ListResponse, Media, MediaListResponse, MediaResponse, MediaTransform, Pagination, PreviewResponse, Problem, SearchResponse, Selection, Session } from "./schemas/api.js";
+import { BOOT_CONFIG_ELEMENT_ID, BootConfig } from "./schemas/boot.js";
+import { createSchemaRegistry, namedSchemas } from "./schemas/index.js";
+import { lintDefinition } from "./lint.js";
+import { isProblem, validate, validateBootConfig, validateDefinition } from "./validate.js";
+import { getValue, isFilled } from "./values.js";
+import { evaluateCondition } from "./conditions.js";
+import { checkRules, checkValues } from "./rules.js";
+import { fromSearchParams, toSearchParams } from "./query.js";
+import { createBootConfigJsonSchema, createComponentSchemas, createDefinitionJsonSchema, createOpenApiDocument } from "./openapi.js";
+export { Abilities, Action, ActionConfirm, ActionItemResult, ActionPlacement, ActionRequest, ActionResult, ActionRun, ActionRunResponse, ActionScope, Auth, AuthProvider, BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LIST_LAYOUTS, BlockType, BootConfig, Column, Condition, Definition, Field, Filter, Id, Item, ItemResponse, LayoutNode, ListDefinition, ListResponse, Media, MediaListResponse, MediaResponse, MediaTransform, MenuItem, Option, PORTABLE_RULES, PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION, Page, Pagination, PreviewResponse, Problem, Resource, ResourceFeatures, RouteReference, Rule, SearchResponse, Selection, Session, Uploads, User, Widget, checkRules, checkValues, createBootConfigJsonSchema, createComponentSchemas, createDefinitionJsonSchema, createOpenApiDocument, createSchemaRegistry, evaluateCondition, fromSearchParams, getValue, isFilled, isProblem, lintDefinition, namedSchemas, toSearchParams, validate, validateBootConfig, validateDefinition };

package/dist/lint.d.ts

@@ -0,0 +1,8 @@
+import type { DefinitionInput } from './schemas';
+import type { ValidationIssue } from './validate';
+/**
+ * Checks what the schema can't: references between parts of a definition (layout nodes and
+ * columns that name existing fields, relations that name a resource, unique names).
+ */
+export declare function lintDefinition(definition: DefinitionInput): ValidationIssue[];
+//# sourceMappingURL=lint.d.ts.map

package/dist/lint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.d.ts","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAoC,MAAM,WAAW,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AA2ElD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,eAAe,GAAG,eAAe,EAAE,CAmB7E"}

package/dist/lint.js

@@ -0,0 +1,73 @@
+//#region src/lint.ts
+function fieldNames(fields) {
+	return new Set(fields.map((field) => field.name));
+}
+function checkLayout(nodes, names, path, issues) {
+	nodes.forEach((node, index) => {
+		const nodePath = `${path}.${index}`;
+		if (node.type === "field") {
+			if (node.name === void 0) issues.push({
+				path: nodePath,
+				message: "A `field` node needs a `name`."
+			});
+			else if (!names.has(node.name)) issues.push({
+				path: `${nodePath}.name`,
+				message: `No field named \`${node.name}\`.`
+			});
+		}
+		if (node.type === "component" && node.component === void 0) issues.push({
+			path: nodePath,
+			message: "A `component` node needs a `component`."
+		});
+		if (node.type === "tabs" && node.children?.some((child) => child.type !== "tab")) issues.push({
+			path: `${nodePath}.children`,
+			message: "The children of `tabs` must be `tab` nodes."
+		});
+		if (node.children !== void 0) checkLayout(node.children, names, `${nodePath}.children`, issues);
+	});
+}
+function checkResource(resource, path, issues) {
+	const names = fieldNames(resource.fields);
+	if (names.size !== resource.fields.length) issues.push({
+		path: `${path}.fields`,
+		message: "Field names must be unique."
+	});
+	if (resource.form?.layout !== void 0) checkLayout(resource.form.layout, names, `${path}.form.layout`, issues);
+	(resource.list?.columns ?? []).forEach((column, index) => {
+		if (column.field !== void 0 && !names.has(column.field)) issues.push({
+			path: `${path}.list.columns.${index}.field`,
+			message: `No field named \`${column.field}\`.`
+		});
+	});
+	(resource.actions ?? []).forEach((action, index) => {
+		if (action.layout !== void 0) checkLayout(action.layout, fieldNames(action.fields ?? []), `${path}.actions.${index}.layout`, issues);
+	});
+	resource.fields.forEach((field, index) => {
+		if (field.type === "relation" && field.resource === void 0) issues.push({
+			path: `${path}.fields.${index}.resource`,
+			message: "A `relation` field needs a `resource`."
+		});
+	});
+}
+/**
+* Checks what the schema can't: references between parts of a definition (layout nodes and
+* columns that name existing fields, relations that name a resource, unique names).
+*/
+function lintDefinition(definition) {
+	const issues = [];
+	const resourceIds = new Set(definition.resources.map((resource) => resource.id));
+	definition.resources.forEach((resource, index) => {
+		checkResource(resource, `resources.${index}`, issues);
+		resource.fields.forEach((field, fieldIndex) => {
+			if (field.type === "relation" && field.resource !== void 0 && !resourceIds.has(field.resource)) issues.push({
+				path: `resources.${index}.fields.${fieldIndex}.resource`,
+				message: `No resource \`${field.resource}\`.`
+			});
+		});
+	});
+	return issues;
+}
+//#endregion
+export { lintDefinition };
+
+//# sourceMappingURL=lint.js.map

package/dist/lint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.js","names":[],"sources":["../src/lint.ts"],"sourcesContent":["import type { DefinitionInput, Field, LayoutNode, ResourceInput } from './schemas';\nimport type { ValidationIssue } from './validate';\n\nfunction fieldNames(fields: Field[]): Set<string> {\n    return new Set(fields.map((field) => field.name));\n}\n\nfunction checkLayout(\n    nodes: LayoutNode[],\n    names: Set<string>,\n    path: string,\n    issues: ValidationIssue[],\n) {\n    nodes.forEach((node, index) => {\n        const nodePath = `${path}.${index}`;\n        if (node.type === 'field') {\n            if (node.name === undefined) {\n                issues.push({ path: nodePath, message: 'A `field` node needs a `name`.' });\n            } else if (!names.has(node.name)) {\n                issues.push({\n                    path: `${nodePath}.name`,\n                    message: `No field named \\`${node.name}\\`.`,\n                });\n            }\n        }\n        if (node.type === 'component' && node.component === undefined) {\n            issues.push({ path: nodePath, message: 'A `component` node needs a `component`.' });\n        }\n        if (node.type === 'tabs' && node.children?.some((child) => child.type !== 'tab')) {\n            issues.push({\n                path: `${nodePath}.children`,\n                message: 'The children of `tabs` must be `tab` nodes.',\n            });\n        }\n        if (node.children !== undefined) {\n            checkLayout(node.children, names, `${nodePath}.children`, issues);\n        }\n    });\n}\n\nfunction checkResource(resource: ResourceInput, path: string, issues: ValidationIssue[]) {\n    const names = fieldNames(resource.fields);\n    if (names.size !== resource.fields.length) {\n        issues.push({ path: `${path}.fields`, message: 'Field names must be unique.' });\n    }\n    if (resource.form?.layout !== undefined) {\n        checkLayout(resource.form.layout, names, `${path}.form.layout`, issues);\n    }\n    (resource.list?.columns ?? []).forEach((column, index) => {\n        if (column.field !== undefined && !names.has(column.field)) {\n            issues.push({\n                path: `${path}.list.columns.${index}.field`,\n                message: `No field named \\`${column.field}\\`.`,\n            });\n        }\n    });\n    (resource.actions ?? []).forEach((action, index) => {\n        if (action.layout !== undefined) {\n            checkLayout(\n                action.layout,\n                fieldNames(action.fields ?? []),\n                `${path}.actions.${index}.layout`,\n                issues,\n            );\n        }\n    });\n    resource.fields.forEach((field, index) => {\n        if (field.type === 'relation' && field.resource === undefined) {\n            issues.push({\n                path: `${path}.fields.${index}.resource`,\n                message: 'A `relation` field needs a `resource`.',\n            });\n        }\n    });\n}\n\n/**\n * Checks what the schema can't: references between parts of a definition (layout nodes and\n * columns that name existing fields, relations that name a resource, unique names).\n */\nexport function lintDefinition(definition: DefinitionInput): ValidationIssue[] {\n    const issues: ValidationIssue[] = [];\n    const resourceIds = new Set(definition.resources.map((resource) => resource.id));\n    definition.resources.forEach((resource, index) => {\n        checkResource(resource, `resources.${index}`, issues);\n        resource.fields.forEach((field, fieldIndex) => {\n            if (\n                field.type === 'relation' &&\n                field.resource !== undefined &&\n                !resourceIds.has(field.resource)\n            ) {\n                issues.push({\n                    path: `resources.${index}.fields.${fieldIndex}.resource`,\n                    message: `No resource \\`${field.resource}\\`.`,\n                });\n            }\n        });\n    });\n    return issues;\n}\n"],"mappings":";AAGA,SAAS,WAAW,QAA8B;CAC9C,OAAO,IAAI,IAAI,OAAO,KAAK,UAAU,MAAM,IAAI,CAAC;AACpD;AAEA,SAAS,YACL,OACA,OACA,MACA,QACF;CACE,MAAM,SAAS,MAAM,UAAU;EAC3B,MAAM,WAAW,GAAG,KAAK,GAAG;EAC5B,IAAI,KAAK,SAAS,SAAS;GACvB,IAAI,KAAK,SAAS,KAAA,GACd,OAAO,KAAK;IAAE,MAAM;IAAU,SAAS;GAAiC,CAAC;QACtE,IAAI,CAAC,MAAM,IAAI,KAAK,IAAI,GAC3B,OAAO,KAAK;IACR,MAAM,GAAG,SAAS;IAClB,SAAS,oBAAoB,KAAK,KAAK;GAC3C,CAAC;EAET;EACA,IAAI,KAAK,SAAS,eAAe,KAAK,cAAc,KAAA,GAChD,OAAO,KAAK;GAAE,MAAM;GAAU,SAAS;EAA0C,CAAC;EAEtF,IAAI,KAAK,SAAS,UAAU,KAAK,UAAU,MAAM,UAAU,MAAM,SAAS,KAAK,GAC3E,OAAO,KAAK;GACR,MAAM,GAAG,SAAS;GAClB,SAAS;EACb,CAAC;EAEL,IAAI,KAAK,aAAa,KAAA,GAClB,YAAY,KAAK,UAAU,OAAO,GAAG,SAAS,YAAY,MAAM;CAExE,CAAC;AACL;AAEA,SAAS,cAAc,UAAyB,MAAc,QAA2B;CACrF,MAAM,QAAQ,WAAW,SAAS,MAAM;CACxC,IAAI,MAAM,SAAS,SAAS,OAAO,QAC/B,OAAO,KAAK;EAAE,MAAM,GAAG,KAAK;EAAU,SAAS;CAA8B,CAAC;CAElF,IAAI,SAAS,MAAM,WAAW,KAAA,GAC1B,YAAY,SAAS,KAAK,QAAQ,OAAO,GAAG,KAAK,eAAe,MAAM;CAE1E,CAAC,SAAS,MAAM,WAAW,CAAC,EAAA,CAAG,SAAS,QAAQ,UAAU;EACtD,IAAI,OAAO,UAAU,KAAA,KAAa,CAAC,MAAM,IAAI,OAAO,KAAK,GACrD,OAAO,KAAK;GACR,MAAM,GAAG,KAAK,gBAAgB,MAAM;GACpC,SAAS,oBAAoB,OAAO,MAAM;EAC9C,CAAC;CAET,CAAC;CACD,CAAC,SAAS,WAAW,CAAC,EAAA,CAAG,SAAS,QAAQ,UAAU;EAChD,IAAI,OAAO,WAAW,KAAA,GAClB,YACI,OAAO,QACP,WAAW,OAAO,UAAU,CAAC,CAAC,GAC9B,GAAG,KAAK,WAAW,MAAM,UACzB,MACJ;CAER,CAAC;CACD,SAAS,OAAO,SAAS,OAAO,UAAU;EACtC,IAAI,MAAM,SAAS,cAAc,MAAM,aAAa,KAAA,GAChD,OAAO,KAAK;GACR,MAAM,GAAG,KAAK,UAAU,MAAM;GAC9B,SAAS;EACb,CAAC;CAET,CAAC;AACL;;;;;AAMA,SAAgB,eAAe,YAAgD;CAC3E,MAAM,SAA4B,CAAC;CACnC,MAAM,cAAc,IAAI,IAAI,WAAW,UAAU,KAAK,aAAa,SAAS,EAAE,CAAC;CAC/E,WAAW,UAAU,SAAS,UAAU,UAAU;EAC9C,cAAc,UAAU,aAAa,SAAS,MAAM;EACpD,SAAS,OAAO,SAAS,OAAO,eAAe;GAC3C,IACI,MAAM,SAAS,cACf,MAAM,aAAa,KAAA,KACnB,CAAC,YAAY,IAAI,MAAM,QAAQ,GAE/B,OAAO,KAAK;IACR,MAAM,aAAa,MAAM,UAAU,WAAW;IAC9C,SAAS,iBAAiB,MAAM,SAAS;GAC7C,CAAC;EAET,CAAC;CACL,CAAC;CACD,OAAO;AACX"}

package/dist/mock/example.d.ts

@@ -0,0 +1,8 @@
+import type { DefinitionInput } from '../schemas';
+/**
+ * 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()`.
+ */
+export declare function createExampleDefinition(): DefinitionInput;
+//# sourceMappingURL=example.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../src/mock/example.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,eAAe,CAuIzD"}