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

package/dist/query.d.ts

@@ -0,0 +1,41 @@
+/**
+ * The bounds of a range filter (`date-range`), both inclusive. An open end is left out. Sent as
+ * `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31`.
+ */
+export interface FilterRange {
+    from?: string | number;
+    to?: string | number;
+}
+/**
+ * The value of a filter: one value (`filter[status]=draft`), a list that matches any of its values
+ * (`filter[tags][]=a&filter[tags][]=b`), or the bounds of a range.
+ */
+export type FilterValue = string | number | boolean | Array<string | number | boolean> | FilterRange;
+/** Whether a filter value is the bounds of a range, and not one value or a list of values. */
+export declare function isFilterRange(value: unknown): value is FilterRange;
+/**
+ * Whether a value is within the bounds of a range filter, both inclusive: the reference of how a
+ * backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of
+ * the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).
+ * An empty value is never in a range.
+ */
+export declare function matchesFilterRange(value: unknown, range: FilterRange): boolean;
+/** Query of a list request (`GET /resources/{resource}`). */
+export interface ListQuery {
+    page?: number;
+    perPage?: number;
+    /** Fields to sort by, in order. A `-` prefix sorts descending. */
+    sort?: string[];
+    filter?: Record<string, FilterValue>;
+    q?: string;
+    /** Fields to include in each item. */
+    fields?: string[];
+}
+/** Serializes a list query to the protocol's query string format. */
+export declare function toSearchParams(query: ListQuery): URLSearchParams;
+/**
+ * Parses a list query from the protocol's query string format. Filter values stay strings, and the
+ * bounds of a range (`filter[id][from]`, `filter[id][to]`) become a `FilterRange`.
+ */
+export declare function fromSearchParams(params: URLSearchParams): ListQuery;
+//# sourceMappingURL=query.d.ts.map

package/dist/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,WAAW,CAAC;AAE/E,8FAA8F;AAC9F,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAID;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAe9E;AAED,6DAA6D;AAC7D,MAAM,WAAW,SAAS;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACrC,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,qEAAqE;AACrE,wBAAgB,cAAc,CAAC,KAAK,EAAE,SAAS,GAAG,eAAe,CAgChE;AAID;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAkDnE"}

package/dist/query.js

@@ -0,0 +1,80 @@
+//#region src/query.ts
+/** Whether a filter value is the bounds of a range, and not one value or a list of values. */
+function isFilterRange(value) {
+	return value !== null && typeof value === "object" && !Array.isArray(value);
+}
+var RANGE_BOUNDS = ["from", "to"];
+/**
+* Whether a value is within the bounds of a range filter, both inclusive: the reference of how a
+* backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of
+* the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).
+* An empty value is never in a range.
+*/
+function matchesFilterRange(value, range) {
+	if (value === null || value === void 0 || value === "") return false;
+	const compare = (bound) => {
+		if (typeof value === "number" || typeof bound === "number") return Number(value) - Number(bound);
+		const prefix = String(value).slice(0, bound.length);
+		return prefix < bound ? -1 : prefix > bound ? 1 : 0;
+	};
+	return (range.from === void 0 || range.from === "" || compare(range.from) >= 0) && (range.to === void 0 || range.to === "" || compare(range.to) <= 0);
+}
+/** Serializes a list query to the protocol's query string format. */
+function toSearchParams(query) {
+	const params = new URLSearchParams();
+	if (query.page !== void 0) params.set("page", String(query.page));
+	if (query.perPage !== void 0) params.set("perPage", String(query.perPage));
+	if (query.sort !== void 0 && query.sort.length > 0) params.set("sort", query.sort.join(","));
+	Object.entries(query.filter ?? {}).forEach(([key, value]) => {
+		if (Array.isArray(value)) value.forEach((item) => params.append(`filter[${key}][]`, String(item)));
+		else if (isFilterRange(value)) RANGE_BOUNDS.forEach((bound) => {
+			const limit = value[bound];
+			if (limit !== void 0 && limit !== "") params.set(`filter[${key}][${bound}]`, String(limit));
+		});
+		else params.set(`filter[${key}]`, String(value));
+	});
+	if (query.q !== void 0 && query.q !== "") params.set("q", query.q);
+	if (query.fields !== void 0 && query.fields.length > 0) params.set("fields", query.fields.join(","));
+	return params;
+}
+var FILTER_KEY = /^filter\[([^\]]+)\](?:\[(|from|to)\])?$/;
+/**
+* Parses a list query from the protocol's query string format. Filter values stay strings, and the
+* bounds of a range (`filter[id][from]`, `filter[id][to]`) become a `FilterRange`.
+*/
+function fromSearchParams(params) {
+	const query = {};
+	const integer = (value) => {
+		if (value === null || !/^\d+$/.test(value)) return;
+		return Number.parseInt(value, 10);
+	};
+	const page = integer(params.get("page"));
+	if (page !== void 0) query.page = page;
+	const perPage = integer(params.get("perPage"));
+	if (perPage !== void 0) query.perPage = perPage;
+	const sort = params.get("sort");
+	if (sort !== null && sort !== "") query.sort = sort.split(",").filter((part) => part !== "");
+	const q = params.get("q");
+	if (q !== null && q !== "") query.q = q;
+	const fields = params.get("fields");
+	if (fields !== null && fields !== "") query.fields = fields.split(",").filter((part) => part !== "");
+	params.forEach((value, key) => {
+		const match = FILTER_KEY.exec(key);
+		if (match?.[1] === void 0) return;
+		query.filter ??= {};
+		const name = match[1];
+		const current = query.filter[name];
+		if (match[2] === "") query.filter[name] = [...Array.isArray(current) ? current : [], value];
+		else if (match[2] !== void 0) {
+			if (value !== "") query.filter[name] = {
+				...isFilterRange(current) ? current : {},
+				[match[2]]: value
+			};
+		} else query.filter[name] = value;
+	});
+	return query;
+}
+//#endregion
+export { fromSearchParams, isFilterRange, matchesFilterRange, toSearchParams };
+
+//# sourceMappingURL=query.js.map

package/dist/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","names":[],"sources":["../src/query.ts"],"sourcesContent":["/**\n * The bounds of a range filter (`date-range`), both inclusive. An open end is left out. Sent as\n * `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31`.\n */\nexport interface FilterRange {\n    from?: string | number;\n    to?: string | number;\n}\n\n/**\n * The value of a filter: one value (`filter[status]=draft`), a list that matches any of its values\n * (`filter[tags][]=a&filter[tags][]=b`), or the bounds of a range.\n */\nexport type FilterValue =\n    string | number | boolean | Array<string | number | boolean> | FilterRange;\n\n/** Whether a filter value is the bounds of a range, and not one value or a list of values. */\nexport function isFilterRange(value: unknown): value is FilterRange {\n    return value !== null && typeof value === 'object' && !Array.isArray(value);\n}\n\nconst RANGE_BOUNDS = ['from', 'to'] as const;\n\n/**\n * Whether a value is within the bounds of a range filter, both inclusive: the reference of how a\n * backend reads them. Numbers compare as numbers. Other values compare as strings, on the length of\n * the bound, so that a day (`2026-01-31`) includes the times of that day (`2026-01-31T18:00:00Z`).\n * An empty value is never in a range.\n */\nexport function matchesFilterRange(value: unknown, range: FilterRange): boolean {\n    if (value === null || value === undefined || value === '') {\n        return false;\n    }\n    const compare = (bound: string | number): number => {\n        if (typeof value === 'number' || typeof bound === 'number') {\n            return Number(value) - Number(bound);\n        }\n        const prefix = String(value).slice(0, bound.length);\n        return prefix < bound ? -1 : prefix > bound ? 1 : 0;\n    };\n    return (\n        (range.from === undefined || range.from === '' || compare(range.from) >= 0) &&\n        (range.to === undefined || range.to === '' || compare(range.to) <= 0)\n    );\n}\n\n/** Query of a list request (`GET /resources/{resource}`). */\nexport interface ListQuery {\n    page?: number;\n    perPage?: number;\n    /** Fields to sort by, in order. A `-` prefix sorts descending. */\n    sort?: string[];\n    filter?: Record<string, FilterValue>;\n    q?: string;\n    /** Fields to include in each item. */\n    fields?: string[];\n}\n\n/** Serializes a list query to the protocol's query string format. */\nexport function toSearchParams(query: ListQuery): URLSearchParams {\n    const params = new URLSearchParams();\n    if (query.page !== undefined) {\n        params.set('page', String(query.page));\n    }\n    if (query.perPage !== undefined) {\n        params.set('perPage', String(query.perPage));\n    }\n    if (query.sort !== undefined && query.sort.length > 0) {\n        params.set('sort', query.sort.join(','));\n    }\n    Object.entries(query.filter ?? {}).forEach(([key, value]) => {\n        if (Array.isArray(value)) {\n            value.forEach((item) => params.append(`filter[${key}][]`, String(item)));\n        } else if (isFilterRange(value)) {\n            RANGE_BOUNDS.forEach((bound) => {\n                const limit = value[bound];\n                if (limit !== undefined && limit !== '') {\n                    params.set(`filter[${key}][${bound}]`, String(limit));\n                }\n            });\n        } else {\n            params.set(`filter[${key}]`, String(value));\n        }\n    });\n    if (query.q !== undefined && query.q !== '') {\n        params.set('q', query.q);\n    }\n    if (query.fields !== undefined && query.fields.length > 0) {\n        params.set('fields', query.fields.join(','));\n    }\n    return params;\n}\n\nconst FILTER_KEY = /^filter\\[([^\\]]+)\\](?:\\[(|from|to)\\])?$/;\n\n/**\n * Parses a list query from the protocol's query string format. Filter values stay strings, and the\n * bounds of a range (`filter[id][from]`, `filter[id][to]`) become a `FilterRange`.\n */\nexport function fromSearchParams(params: URLSearchParams): ListQuery {\n    const query: ListQuery = {};\n    const integer = (value: string | null): number | undefined => {\n        if (value === null || !/^\\d+$/.test(value)) {\n            return undefined;\n        }\n        return Number.parseInt(value, 10);\n    };\n    const page = integer(params.get('page'));\n    if (page !== undefined) {\n        query.page = page;\n    }\n    const perPage = integer(params.get('perPage'));\n    if (perPage !== undefined) {\n        query.perPage = perPage;\n    }\n    const sort = params.get('sort');\n    if (sort !== null && sort !== '') {\n        query.sort = sort.split(',').filter((part) => part !== '');\n    }\n    const q = params.get('q');\n    if (q !== null && q !== '') {\n        query.q = q;\n    }\n    const fields = params.get('fields');\n    if (fields !== null && fields !== '') {\n        query.fields = fields.split(',').filter((part) => part !== '');\n    }\n    params.forEach((value, key) => {\n        const match = FILTER_KEY.exec(key);\n        if (match?.[1] === undefined) {\n            return;\n        }\n        query.filter ??= {};\n        const name = match[1];\n        const current = query.filter[name];\n        if (match[2] === '') {\n            query.filter[name] = [...(Array.isArray(current) ? current : []), value];\n        } else if (match[2] !== undefined) {\n            if (value !== '') {\n                query.filter[name] = {\n                    ...(isFilterRange(current) ? current : {}),\n                    [match[2]]: value,\n                };\n            }\n        } else {\n            query.filter[name] = value;\n        }\n    });\n    return query;\n}\n"],"mappings":";;AAiBA,SAAgB,cAAc,OAAsC;CAChE,OAAO,UAAU,QAAQ,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;AAC9E;AAEA,IAAM,eAAe,CAAC,QAAQ,IAAI;;;;;;;AAQlC,SAAgB,mBAAmB,OAAgB,OAA6B;CAC5E,IAAI,UAAU,QAAQ,UAAU,KAAA,KAAa,UAAU,IACnD,OAAO;CAEX,MAAM,WAAW,UAAmC;EAChD,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO,OAAO,KAAK,IAAI,OAAO,KAAK;EAEvC,MAAM,SAAS,OAAO,KAAK,CAAC,CAAC,MAAM,GAAG,MAAM,MAAM;EAClD,OAAO,SAAS,QAAQ,KAAK,SAAS,QAAQ,IAAI;CACtD;CACA,QACK,MAAM,SAAS,KAAA,KAAa,MAAM,SAAS,MAAM,QAAQ,MAAM,IAAI,KAAK,OACxE,MAAM,OAAO,KAAA,KAAa,MAAM,OAAO,MAAM,QAAQ,MAAM,EAAE,KAAK;AAE3E;;AAeA,SAAgB,eAAe,OAAmC;CAC9D,MAAM,SAAS,IAAI,gBAAgB;CACnC,IAAI,MAAM,SAAS,KAAA,GACf,OAAO,IAAI,QAAQ,OAAO,MAAM,IAAI,CAAC;CAEzC,IAAI,MAAM,YAAY,KAAA,GAClB,OAAO,IAAI,WAAW,OAAO,MAAM,OAAO,CAAC;CAE/C,IAAI,MAAM,SAAS,KAAA,KAAa,MAAM,KAAK,SAAS,GAChD,OAAO,IAAI,QAAQ,MAAM,KAAK,KAAK,GAAG,CAAC;CAE3C,OAAO,QAAQ,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EACzD,IAAI,MAAM,QAAQ,KAAK,GACnB,MAAM,SAAS,SAAS,OAAO,OAAO,UAAU,IAAI,MAAM,OAAO,IAAI,CAAC,CAAC;OACpE,IAAI,cAAc,KAAK,GAC1B,aAAa,SAAS,UAAU;GAC5B,MAAM,QAAQ,MAAM;GACpB,IAAI,UAAU,KAAA,KAAa,UAAU,IACjC,OAAO,IAAI,UAAU,IAAI,IAAI,MAAM,IAAI,OAAO,KAAK,CAAC;EAE5D,CAAC;OAED,OAAO,IAAI,UAAU,IAAI,IAAI,OAAO,KAAK,CAAC;CAElD,CAAC;CACD,IAAI,MAAM,MAAM,KAAA,KAAa,MAAM,MAAM,IACrC,OAAO,IAAI,KAAK,MAAM,CAAC;CAE3B,IAAI,MAAM,WAAW,KAAA,KAAa,MAAM,OAAO,SAAS,GACpD,OAAO,IAAI,UAAU,MAAM,OAAO,KAAK,GAAG,CAAC;CAE/C,OAAO;AACX;AAEA,IAAM,aAAa;;;;;AAMnB,SAAgB,iBAAiB,QAAoC;CACjE,MAAM,QAAmB,CAAC;CAC1B,MAAM,WAAW,UAA6C;EAC1D,IAAI,UAAU,QAAQ,CAAC,QAAQ,KAAK,KAAK,GACrC;EAEJ,OAAO,OAAO,SAAS,OAAO,EAAE;CACpC;CACA,MAAM,OAAO,QAAQ,OAAO,IAAI,MAAM,CAAC;CACvC,IAAI,SAAS,KAAA,GACT,MAAM,OAAO;CAEjB,MAAM,UAAU,QAAQ,OAAO,IAAI,SAAS,CAAC;CAC7C,IAAI,YAAY,KAAA,GACZ,MAAM,UAAU;CAEpB,MAAM,OAAO,OAAO,IAAI,MAAM;CAC9B,IAAI,SAAS,QAAQ,SAAS,IAC1B,MAAM,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC,QAAQ,SAAS,SAAS,EAAE;CAE7D,MAAM,IAAI,OAAO,IAAI,GAAG;CACxB,IAAI,MAAM,QAAQ,MAAM,IACpB,MAAM,IAAI;CAEd,MAAM,SAAS,OAAO,IAAI,QAAQ;CAClC,IAAI,WAAW,QAAQ,WAAW,IAC9B,MAAM,SAAS,OAAO,MAAM,GAAG,CAAC,CAAC,QAAQ,SAAS,SAAS,EAAE;CAEjE,OAAO,SAAS,OAAO,QAAQ;EAC3B,MAAM,QAAQ,WAAW,KAAK,GAAG;EACjC,IAAI,QAAQ,OAAO,KAAA,GACf;EAEJ,MAAM,WAAW,CAAC;EAClB,MAAM,OAAO,MAAM;EACnB,MAAM,UAAU,MAAM,OAAO;EAC7B,IAAI,MAAM,OAAO,IACb,MAAM,OAAO,QAAQ,CAAC,GAAI,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,GAAI,KAAK;OACpE,IAAI,MAAM,OAAO,KAAA,GAChB;OAAA,UAAU,IACV,MAAM,OAAO,QAAQ;IACjB,GAAI,cAAc,OAAO,IAAI,UAAU,CAAC;KACvC,MAAM,KAAK;GAChB;EAAA,OAGJ,MAAM,OAAO,QAAQ;CAE7B,CAAC;CACD,OAAO;AACX"}

package/dist/rules.d.ts

@@ -0,0 +1,29 @@
+import type { Field, Rule } from './schemas/field';
+/** A rule that a value doesn't satisfy. */
+export interface RuleFailure {
+    rule: string;
+    /** The rule's parameter (`max: 120` gives `120`). */
+    value?: unknown;
+    /** The message set on the rule, if any. */
+    message?: string;
+}
+export interface CheckOptions {
+    /**
+     * Locales a `required` localized field must be filled in. Without it, one filled locale is
+     * enough.
+     */
+    locales?: string[];
+    /** `create` skips `updateOnly` fields; `update` skips `createOnly` fields. */
+    mode?: 'create' | 'update';
+    /** Only check the fields present in the values (partial updates). */
+    partial?: boolean;
+}
+/** Checks one value against a field's rules. Returns the rules that fail. */
+export declare function checkRules(rules: Rule[], value: unknown, root?: Record<string, unknown>): RuleFailure[];
+/**
+ * Checks form values against the portable rules of their fields. Returns the failures keyed by
+ * the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.
+ * Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.
+ */
+export declare function checkValues(fields: Field[], values: Record<string, unknown>, options?: CheckOptions): Record<string, RuleFailure[]>;
+//# sourceMappingURL=rules.d.ts.map

package/dist/rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAGnD,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAyDD,6EAA6E;AAC7E,wBAAgB,UAAU,CACtB,KAAK,EAAE,IAAI,EAAE,EACb,KAAK,EAAE,OAAO,EACd,IAAI,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACnC,WAAW,EAAE,CAwEf;AAuFD;;;;GAIG;AACH,wBAAgB,WAAW,CACvB,MAAM,EAAE,KAAK,EAAE,EACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,GAAE,YAAiB,GAC3B,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAI/B"}

package/dist/rules.js

@@ -0,0 +1,143 @@
+import { PORTABLE_RULES } from "./constants.js";
+import { getValue, isFilled, isRecord } from "./values.js";
+import { evaluateCondition } from "./conditions.js";
+//#region src/rules.ts
+var EMAIL = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+function isKnownRule(rule) {
+	return PORTABLE_RULES.includes(rule.rule);
+}
+function failure(rule) {
+	const result = { rule: rule.rule };
+	if ("value" in rule && rule.value !== void 0) result.value = rule.value;
+	if (rule.message !== void 0) result.message = rule.message;
+	return result;
+}
+function sizeOf(value) {
+	if (typeof value === "number") return value;
+	if (typeof value === "string" || Array.isArray(value)) return value.length;
+	return null;
+}
+function matchesMime(mime, patterns) {
+	return patterns.some((pattern) => {
+		if (pattern.endsWith("/*")) return mime.startsWith(pattern.slice(0, -1));
+		return mime === pattern;
+	});
+}
+function mediaList(value) {
+	return (Array.isArray(value) ? value : [value]).filter(isRecord);
+}
+function toTime(value) {
+	if (typeof value !== "string" && typeof value !== "number") return null;
+	const time = new Date(value).getTime();
+	return Number.isNaN(time) ? null : time;
+}
+/** Checks one value against a field's rules. Returns the rules that fail. */
+function checkRules(rules, value, root = {}) {
+	const failures = [];
+	const filled = isFilled(value);
+	rules.filter(isKnownRule).forEach((rule) => {
+		if (rule.rule === "required") {
+			if (!filled) failures.push(failure(rule));
+			return;
+		}
+		if (!filled) return;
+		let valid = true;
+		switch (rule.rule) {
+			case "min":
+			case "max": {
+				const size = sizeOf(value);
+				const limit = rule.value;
+				valid = size === null || (rule.rule === "min" ? size >= limit : size <= limit);
+				break;
+			}
+			case "pattern":
+				valid = typeof value !== "string" || new RegExp(rule.value, rule.flags).test(value);
+				break;
+			case "email":
+				valid = typeof value !== "string" || EMAIL.test(value);
+				break;
+			case "url":
+				valid = typeof value !== "string" || URL.canParse(value);
+				break;
+			case "in": {
+				const allowed = rule.value;
+				valid = (Array.isArray(value) ? value : [value]).every((item) => allowed.includes(item));
+				break;
+			}
+			case "accept":
+				valid = mediaList(value).every((media) => typeof media.mime !== "string" || matchesMime(media.mime, rule.value));
+				break;
+			case "maxSize":
+				valid = mediaList(value).every((media) => typeof media.size !== "number" || media.size <= rule.value);
+				break;
+			case "before":
+			case "after": {
+				const bound = rule.value;
+				const boundTime = toTime(typeof bound === "string" ? bound : getValue(root, bound.field));
+				const time = toTime(value);
+				if (boundTime !== null && time !== null) valid = rule.rule === "before" ? time < boundTime : time > boundTime;
+				break;
+			}
+		}
+		if (!valid) failures.push(failure(rule));
+	});
+	return failures;
+}
+function addFailures(context, path, failures) {
+	if (failures.length > 0) context.failures[path] = [...context.failures[path] ?? [], ...failures];
+}
+function checkFieldValue(field, value, path, context) {
+	const rules = field.rules ?? [];
+	if (field.localized === true) {
+		const localized = isRecord(value) ? value : {};
+		const required = rules.filter((rule) => rule.rule === "required");
+		const others = rules.filter((rule) => rule.rule !== "required");
+		if (required.length > 0) {
+			const locales = context.locales;
+			if (locales === void 0 || locales.length === 0) {
+				if (!Object.values(localized).some(isFilled)) addFailures(context, path, required.map(failure));
+			} else locales.forEach((locale) => {
+				addFailures(context, `${path}.${locale}`, checkRules(required, localized[locale], context.root));
+			});
+		}
+		Object.entries(localized).forEach(([locale, localeValue]) => {
+			addFailures(context, `${path}.${locale}`, checkRules(others, localeValue, context.root));
+		});
+		return;
+	}
+	addFailures(context, path, checkRules(rules, value, context.root));
+	if (field.type === "group" && field.fields !== void 0 && isRecord(value)) checkFields(field.fields, value, `${path}.`, context);
+	if (field.type === "repeater" && Array.isArray(value)) value.forEach((item, index) => {
+		if (!isRecord(item)) return;
+		const blockFields = field.types !== void 0 ? field.types.find((type) => type.id === item.type)?.fields : field.fields;
+		if (blockFields !== void 0) checkFields(blockFields, item, `${path}.${index}.`, context);
+	});
+}
+function checkFields(fields, values, prefix, context) {
+	fields.forEach((field) => {
+		if (field.readOnly === true) return;
+		if (context.mode === "create" && field.updateOnly === true) return;
+		if (context.mode === "update" && field.createOnly === true) return;
+		if (field.visibleWhen !== void 0 && !evaluateCondition(field.visibleWhen, values)) return;
+		if (context.partial === true && prefix === "" && !(field.name in values)) return;
+		checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);
+	});
+}
+/**
+* Checks form values against the portable rules of their fields. Returns the failures keyed by
+* the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.
+* Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.
+*/
+function checkValues(fields, values, options = {}) {
+	const context = {
+		...options,
+		root: values,
+		failures: {}
+	};
+	checkFields(fields, values, "", context);
+	return context.failures;
+}
+//#endregion
+export { checkRules, checkValues };
+
+//# sourceMappingURL=rules.js.map

package/dist/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","names":[],"sources":["../src/rules.ts"],"sourcesContent":["import { evaluateCondition } from './conditions';\nimport { PORTABLE_RULES } from './constants';\nimport type { Field, Rule } from './schemas/field';\nimport { getValue, isFilled, isRecord } from './values';\n\n/** A rule that a value doesn't satisfy. */\nexport interface RuleFailure {\n    rule: string;\n    /** The rule's parameter (`max: 120` gives `120`). */\n    value?: unknown;\n    /** The message set on the rule, if any. */\n    message?: string;\n}\n\nexport interface CheckOptions {\n    /**\n     * Locales a `required` localized field must be filled in. Without it, one filled locale is\n     * enough.\n     */\n    locales?: string[];\n    /** `create` skips `updateOnly` fields; `update` skips `createOnly` fields. */\n    mode?: 'create' | 'update';\n    /** Only check the fields present in the values (partial updates). */\n    partial?: boolean;\n}\n\ninterface Context extends CheckOptions {\n    /** The whole form, for `visibleWhen` and date rules that reference other fields. */\n    root: Record<string, unknown>;\n    failures: Record<string, RuleFailure[]>;\n}\n\nconst EMAIL = /^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$/;\n\nfunction isKnownRule(rule: Rule): boolean {\n    return (PORTABLE_RULES as readonly string[]).includes(rule.rule);\n}\n\nfunction failure(rule: Rule): RuleFailure {\n    const result: RuleFailure = { rule: rule.rule };\n    if ('value' in rule && rule.value !== undefined) {\n        result.value = rule.value;\n    }\n    if (rule.message !== undefined) {\n        result.message = rule.message;\n    }\n    return result;\n}\n\nfunction sizeOf(value: unknown): number | null {\n    if (typeof value === 'number') {\n        return value;\n    }\n    if (typeof value === 'string' || Array.isArray(value)) {\n        return value.length;\n    }\n    return null;\n}\n\nfunction matchesMime(mime: string, patterns: string[]): boolean {\n    return patterns.some((pattern) => {\n        if (pattern.endsWith('/*')) {\n            return mime.startsWith(pattern.slice(0, -1));\n        }\n        return mime === pattern;\n    });\n}\n\nfunction mediaList(value: unknown): Record<string, unknown>[] {\n    const list = Array.isArray(value) ? value : [value];\n    return list.filter(isRecord);\n}\n\nfunction toTime(value: unknown): number | null {\n    if (typeof value !== 'string' && typeof value !== 'number') {\n        return null;\n    }\n    const time = new Date(value).getTime();\n    return Number.isNaN(time) ? null : time;\n}\n\n/** Checks one value against a field's rules. Returns the rules that fail. */\nexport function checkRules(\n    rules: Rule[],\n    value: unknown,\n    root: Record<string, unknown> = {},\n): RuleFailure[] {\n    const failures: RuleFailure[] = [];\n    const filled = isFilled(value);\n    rules.filter(isKnownRule).forEach((rule) => {\n        if (rule.rule === 'required') {\n            if (!filled) {\n                failures.push(failure(rule));\n            }\n            return;\n        }\n        if (!filled) {\n            return;\n        }\n        let valid = true;\n        switch (rule.rule) {\n            case 'min':\n            case 'max': {\n                const size = sizeOf(value);\n                const limit = rule.value as number;\n                valid = size === null || (rule.rule === 'min' ? size >= limit : size <= limit);\n                break;\n            }\n            case 'pattern':\n                valid =\n                    typeof value !== 'string' ||\n                    new RegExp(rule.value as string, (rule as { flags?: string }).flags).test(\n                        value,\n                    );\n                break;\n            case 'email':\n                valid = typeof value !== 'string' || EMAIL.test(value);\n                break;\n            case 'url':\n                valid = typeof value !== 'string' || URL.canParse(value);\n                break;\n            case 'in': {\n                const allowed = rule.value as unknown[];\n                const values = Array.isArray(value) ? value : [value];\n                valid = values.every((item) => allowed.includes(item));\n                break;\n            }\n            case 'accept':\n                valid = mediaList(value).every(\n                    (media) =>\n                        typeof media.mime !== 'string' ||\n                        matchesMime(media.mime, rule.value as string[]),\n                );\n                break;\n            case 'maxSize':\n                valid = mediaList(value).every(\n                    (media) =>\n                        typeof media.size !== 'number' || media.size <= (rule.value as number),\n                );\n                break;\n            case 'before':\n            case 'after': {\n                const bound = rule.value as string | { field: string };\n                const boundTime = toTime(\n                    typeof bound === 'string' ? bound : getValue(root, bound.field),\n                );\n                const time = toTime(value);\n                if (boundTime !== null && time !== null) {\n                    valid = rule.rule === 'before' ? time < boundTime : time > boundTime;\n                }\n                break;\n            }\n        }\n        if (!valid) {\n            failures.push(failure(rule));\n        }\n    });\n    return failures;\n}\n\nfunction addFailures(context: Context, path: string, failures: RuleFailure[]) {\n    if (failures.length > 0) {\n        context.failures[path] = [...(context.failures[path] ?? []), ...failures];\n    }\n}\n\nfunction checkFieldValue(field: Field, value: unknown, path: string, context: Context) {\n    const rules = field.rules ?? [];\n    if (field.localized === true) {\n        const localized = isRecord(value) ? value : {};\n        const required = rules.filter((rule) => rule.rule === 'required');\n        const others = rules.filter((rule) => rule.rule !== 'required');\n        if (required.length > 0) {\n            const locales = context.locales;\n            if (locales === undefined || locales.length === 0) {\n                if (!Object.values(localized).some(isFilled)) {\n                    addFailures(context, path, required.map(failure));\n                }\n            } else {\n                locales.forEach((locale) => {\n                    addFailures(\n                        context,\n                        `${path}.${locale}`,\n                        checkRules(required, localized[locale], context.root),\n                    );\n                });\n            }\n        }\n        Object.entries(localized).forEach(([locale, localeValue]) => {\n            addFailures(\n                context,\n                `${path}.${locale}`,\n                checkRules(others, localeValue, context.root),\n            );\n        });\n        return;\n    }\n\n    addFailures(context, path, checkRules(rules, value, context.root));\n\n    if (field.type === 'group' && field.fields !== undefined && isRecord(value)) {\n        checkFields(field.fields, value, `${path}.`, context);\n    }\n    if (field.type === 'repeater' && Array.isArray(value)) {\n        value.forEach((item, index) => {\n            if (!isRecord(item)) {\n                return;\n            }\n            const blockFields =\n                field.types !== undefined\n                    ? field.types.find((type) => type.id === item.type)?.fields\n                    : field.fields;\n            if (blockFields !== undefined) {\n                checkFields(blockFields, item, `${path}.${index}.`, context);\n            }\n        });\n    }\n}\n\nfunction checkFields(\n    fields: Field[],\n    values: Record<string, unknown>,\n    prefix: string,\n    context: Context,\n) {\n    fields.forEach((field) => {\n        if (field.readOnly === true) {\n            return;\n        }\n        if (context.mode === 'create' && field.updateOnly === true) {\n            return;\n        }\n        if (context.mode === 'update' && field.createOnly === true) {\n            return;\n        }\n        if (field.visibleWhen !== undefined && !evaluateCondition(field.visibleWhen, values)) {\n            return;\n        }\n        if (context.partial === true && prefix === '' && !(field.name in values)) {\n            return;\n        }\n        checkFieldValue(field, values[field.name], `${prefix}${field.name}`, context);\n    });\n}\n\n/**\n * Checks form values against the portable rules of their fields. Returns the failures keyed by\n * the dot path of the value (`title.fr`, `blocks.2.image`), the same keys as validation errors.\n * Hidden and read-only fields are skipped. Rules this version doesn't know are ignored.\n */\nexport function checkValues(\n    fields: Field[],\n    values: Record<string, unknown>,\n    options: CheckOptions = {},\n): Record<string, RuleFailure[]> {\n    const context: Context = { ...options, root: values, failures: {} };\n    checkFields(fields, values, '', context);\n    return context.failures;\n}\n"],"mappings":";;;;AAgCA,IAAM,QAAQ;AAEd,SAAS,YAAY,MAAqB;CACtC,OAAQ,eAAqC,SAAS,KAAK,IAAI;AACnE;AAEA,SAAS,QAAQ,MAAyB;CACtC,MAAM,SAAsB,EAAE,MAAM,KAAK,KAAK;CAC9C,IAAI,WAAW,QAAQ,KAAK,UAAU,KAAA,GAClC,OAAO,QAAQ,KAAK;CAExB,IAAI,KAAK,YAAY,KAAA,GACjB,OAAO,UAAU,KAAK;CAE1B,OAAO;AACX;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,UACjB,OAAO;CAEX,IAAI,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAChD,OAAO,MAAM;CAEjB,OAAO;AACX;AAEA,SAAS,YAAY,MAAc,UAA6B;CAC5D,OAAO,SAAS,MAAM,YAAY;EAC9B,IAAI,QAAQ,SAAS,IAAI,GACrB,OAAO,KAAK,WAAW,QAAQ,MAAM,GAAG,EAAE,CAAC;EAE/C,OAAO,SAAS;CACpB,CAAC;AACL;AAEA,SAAS,UAAU,OAA2C;CAE1D,QADa,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACtC,OAAO,QAAQ;AAC/B;AAEA,SAAS,OAAO,OAA+B;CAC3C,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAC9C,OAAO;CAEX,MAAM,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,QAAQ;CACrC,OAAO,OAAO,MAAM,IAAI,IAAI,OAAO;AACvC;;AAGA,SAAgB,WACZ,OACA,OACA,OAAgC,CAAC,GACpB;CACb,MAAM,WAA0B,CAAC;CACjC,MAAM,SAAS,SAAS,KAAK;CAC7B,MAAM,OAAO,WAAW,CAAC,CAAC,SAAS,SAAS;EACxC,IAAI,KAAK,SAAS,YAAY;GAC1B,IAAI,CAAC,QACD,SAAS,KAAK,QAAQ,IAAI,CAAC;GAE/B;EACJ;EACA,IAAI,CAAC,QACD;EAEJ,IAAI,QAAQ;EACZ,QAAQ,KAAK,MAAb;GACI,KAAK;GACL,KAAK,OAAO;IACR,MAAM,OAAO,OAAO,KAAK;IACzB,MAAM,QAAQ,KAAK;IACnB,QAAQ,SAAS,SAAS,KAAK,SAAS,QAAQ,QAAQ,QAAQ,QAAQ;IACxE;GACJ;GACA,KAAK;IACD,QACI,OAAO,UAAU,YACjB,IAAI,OAAO,KAAK,OAAkB,KAA4B,KAAK,CAAC,CAAC,KACjE,KACJ;IACJ;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,MAAM,KAAK,KAAK;IACrD;GACJ,KAAK;IACD,QAAQ,OAAO,UAAU,YAAY,IAAI,SAAS,KAAK;IACvD;GACJ,KAAK,MAAM;IACP,MAAM,UAAU,KAAK;IAErB,SADe,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,EAAA,CACrC,OAAO,SAAS,QAAQ,SAAS,IAAI,CAAC;IACrD;GACJ;GACA,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YACtB,YAAY,MAAM,MAAM,KAAK,KAAiB,CACtD;IACA;GACJ,KAAK;IACD,QAAQ,UAAU,KAAK,CAAC,CAAC,OACpB,UACG,OAAO,MAAM,SAAS,YAAY,MAAM,QAAS,KAAK,KAC9D;IACA;GACJ,KAAK;GACL,KAAK,SAAS;IACV,MAAM,QAAQ,KAAK;IACnB,MAAM,YAAY,OACd,OAAO,UAAU,WAAW,QAAQ,SAAS,MAAM,MAAM,KAAK,CAClE;IACA,MAAM,OAAO,OAAO,KAAK;IACzB,IAAI,cAAc,QAAQ,SAAS,MAC/B,QAAQ,KAAK,SAAS,WAAW,OAAO,YAAY,OAAO;IAE/D;GACJ;EACJ;EACA,IAAI,CAAC,OACD,SAAS,KAAK,QAAQ,IAAI,CAAC;CAEnC,CAAC;CACD,OAAO;AACX;AAEA,SAAS,YAAY,SAAkB,MAAc,UAAyB;CAC1E,IAAI,SAAS,SAAS,GAClB,QAAQ,SAAS,QAAQ,CAAC,GAAI,QAAQ,SAAS,SAAS,CAAC,GAAI,GAAG,QAAQ;AAEhF;AAEA,SAAS,gBAAgB,OAAc,OAAgB,MAAc,SAAkB;CACnF,MAAM,QAAQ,MAAM,SAAS,CAAC;CAC9B,IAAI,MAAM,cAAc,MAAM;EAC1B,MAAM,YAAY,SAAS,KAAK,IAAI,QAAQ,CAAC;EAC7C,MAAM,WAAW,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAChE,MAAM,SAAS,MAAM,QAAQ,SAAS,KAAK,SAAS,UAAU;EAC9D,IAAI,SAAS,SAAS,GAAG;GACrB,MAAM,UAAU,QAAQ;GACxB,IAAI,YAAY,KAAA,KAAa,QAAQ,WAAW,GACxC;QAAA,CAAC,OAAO,OAAO,SAAS,CAAC,CAAC,KAAK,QAAQ,GACvC,YAAY,SAAS,MAAM,SAAS,IAAI,OAAO,CAAC;GAAA,OAGpD,QAAQ,SAAS,WAAW;IACxB,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,UAAU,UAAU,SAAS,QAAQ,IAAI,CACxD;GACJ,CAAC;EAET;EACA,OAAO,QAAQ,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,iBAAiB;GACzD,YACI,SACA,GAAG,KAAK,GAAG,UACX,WAAW,QAAQ,aAAa,QAAQ,IAAI,CAChD;EACJ,CAAC;EACD;CACJ;CAEA,YAAY,SAAS,MAAM,WAAW,OAAO,OAAO,QAAQ,IAAI,CAAC;CAEjE,IAAI,MAAM,SAAS,WAAW,MAAM,WAAW,KAAA,KAAa,SAAS,KAAK,GACtE,YAAY,MAAM,QAAQ,OAAO,GAAG,KAAK,IAAI,OAAO;CAExD,IAAI,MAAM,SAAS,cAAc,MAAM,QAAQ,KAAK,GAChD,MAAM,SAAS,MAAM,UAAU;EAC3B,IAAI,CAAC,SAAS,IAAI,GACd;EAEJ,MAAM,cACF,MAAM,UAAU,KAAA,IACV,MAAM,MAAM,MAAM,SAAS,KAAK,OAAO,KAAK,IAAI,CAAC,EAAE,SACnD,MAAM;EAChB,IAAI,gBAAgB,KAAA,GAChB,YAAY,aAAa,MAAM,GAAG,KAAK,GAAG,MAAM,IAAI,OAAO;CAEnE,CAAC;AAET;AAEA,SAAS,YACL,QACA,QACA,QACA,SACF;CACE,OAAO,SAAS,UAAU;EACtB,IAAI,MAAM,aAAa,MACnB;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,QAAQ,SAAS,YAAY,MAAM,eAAe,MAClD;EAEJ,IAAI,MAAM,gBAAgB,KAAA,KAAa,CAAC,kBAAkB,MAAM,aAAa,MAAM,GAC/E;EAEJ,IAAI,QAAQ,YAAY,QAAQ,WAAW,MAAM,EAAE,MAAM,QAAQ,SAC7D;EAEJ,gBAAgB,OAAO,OAAO,MAAM,OAAO,GAAG,SAAS,MAAM,QAAQ,OAAO;CAChF,CAAC;AACL;;;;;;AAOA,SAAgB,YACZ,QACA,QACA,UAAwB,CAAC,GACI;CAC7B,MAAM,UAAmB;EAAE,GAAG;EAAS,MAAM;EAAQ,UAAU,CAAC;CAAE;CAClE,YAAY,QAAQ,QAAQ,IAAI,OAAO;CACvC,OAAO,QAAQ;AACnB"}

package/dist/runtime/index.d.ts

@@ -0,0 +1,10 @@
+export { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from '../version';
+export * from '../constants';
+export { type CheckOptions, type RuleFailure, checkRules, checkValues } from '../rules';
+export { evaluateCondition } from '../conditions';
+export { lintDefinition } from '../lint';
+export type { ValidationIssue } from '../validate';
+export { type FilterRange, type FilterValue, type ListQuery, fromSearchParams, isFilterRange, matchesFilterRange, toSearchParams, } from '../query';
+export { getValue, isFilled } from '../values';
+export { isProblem } from '../problem';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/runtime/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACpE,cAAc,cAAc,CAAC;AAC7B,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACxF,OAAO,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,cAAc,GACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}

package/dist/runtime/index.js

@@ -0,0 +1,9 @@
+import { PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION } from "../version.js";
+import { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LIST_LAYOUTS, PORTABLE_RULES } from "../constants.js";
+import { getValue, isFilled } from "../values.js";
+import { evaluateCondition } from "../conditions.js";
+import { checkRules, checkValues } from "../rules.js";
+import { lintDefinition } from "../lint.js";
+import { fromSearchParams, isFilterRange, matchesFilterRange, toSearchParams } from "../query.js";
+import { isProblem } from "../problem.js";
+export { BOOT_CONFIG_ELEMENT_ID, BUILT_IN_ACTIONS, BUILT_IN_FIELD_TYPES, BUILT_IN_LAYOUT_NODE_TYPES, BUILT_IN_LIST_LAYOUTS, PORTABLE_RULES, PROBLEM_CONTENT_TYPE, PROTOCOL_VERSION, checkRules, checkValues, evaluateCondition, fromSearchParams, getValue, isFilled, isFilterRange, isProblem, lintDefinition, matchesFilterRange, toSearchParams };

package/dist/schemas/action.d.ts

@@ -0,0 +1,163 @@
+import { z } from 'zod';
+import { Field } from './field';
+import { LayoutNode } from './layout';
+export declare const ActionScope: z.ZodEnum<{
+    resource: "resource";
+    item: "item";
+    selection: "selection";
+}>;
+export declare const ActionPlacement: z.ZodEnum<{
+    row: "row";
+    toolbar: "toolbar";
+    form: "form";
+    menu: "menu";
+}>;
+export declare const ActionConfirm: z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+    confirmLabel: z.ZodOptional<z.ZodString>;
+    cancelLabel: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>]>;
+export declare const Action: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+    icon: z.ZodOptional<z.ZodString>;
+    kind: z.ZodDefault<z.ZodEnum<{
+        link: "link";
+        server: "server";
+        client: "client";
+    }>>;
+    scope: z.ZodArray<z.ZodEnum<{
+        resource: "resource";
+        item: "item";
+        selection: "selection";
+    }>>;
+    placement: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        row: "row";
+        toolbar: "toolbar";
+        form: "form";
+        menu: "menu";
+    }>>>;
+    destructive: z.ZodOptional<z.ZodBoolean>;
+    confirm: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        message: z.ZodOptional<z.ZodString>;
+        confirmLabel: z.ZodOptional<z.ZodString>;
+        cancelLabel: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>]>>;
+    fields: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+        help: z.ZodOptional<z.ZodString>;
+        placeholder: z.ZodOptional<z.ZodString>;
+        default: z.ZodOptional<z.ZodUnknown>;
+        localized: z.ZodOptional<z.ZodBoolean>;
+        readOnly: z.ZodOptional<z.ZodBoolean>;
+        createOnly: z.ZodOptional<z.ZodBoolean>;
+        updateOnly: z.ZodOptional<z.ZodBoolean>;
+        rules: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            rule: z.ZodLiteral<"required">;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodEnum<{
+                min: "min";
+                max: "max";
+            }>;
+            value: z.ZodNumber;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodLiteral<"pattern">;
+            value: z.ZodString;
+            flags: z.ZodOptional<z.ZodString>;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodEnum<{
+                email: "email";
+                url: "url";
+            }>;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodLiteral<"in">;
+            value: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodLiteral<"accept">;
+            value: z.ZodArray<z.ZodString>;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodLiteral<"maxSize">;
+            value: z.ZodNumber;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodEnum<{
+                before: "before";
+                after: "after";
+            }>;
+            value: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+                field: z.ZodString;
+            }, z.core.$loose>]>;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>, z.ZodObject<{
+            rule: z.ZodString;
+            message: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>]>>>;
+        visibleWhen: z.ZodOptional<z.ZodObject<{
+            field: z.ZodOptional<z.ZodString>;
+            equals: z.ZodOptional<z.ZodUnknown>;
+            in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+            notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+            filled: z.ZodOptional<z.ZodBoolean>;
+            all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+            any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+        }, z.core.$loose>>;
+        options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+            label: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            disabled: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$loose>>>;
+        multiple: z.ZodOptional<z.ZodBoolean>;
+        resource: z.ZodOptional<z.ZodString>;
+        accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        from: z.ZodOptional<z.ZodString>;
+        display: z.ZodOptional<z.ZodString>;
+        fields: z.ZodOptional<z.ZodArray<typeof Field>>;
+        types: z.ZodOptional<z.ZodArray<typeof import("./field").BlockType>>;
+        settings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$loose>>>;
+    layout: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        label: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        component: z.ZodOptional<z.ZodString>;
+        props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        width: z.ZodOptional<z.ZodNumber>;
+        collapsible: z.ZodOptional<z.ZodBoolean>;
+        collapsed: z.ZodOptional<z.ZodBoolean>;
+        visibleWhen: z.ZodOptional<z.ZodObject<{
+            field: z.ZodOptional<z.ZodString>;
+            equals: z.ZodOptional<z.ZodUnknown>;
+            in: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+            notIn: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
+            filled: z.ZodOptional<z.ZodBoolean>;
+            all: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+            any: z.ZodOptional<z.ZodArray<typeof import("./common").Condition>>;
+        }, z.core.$loose>>;
+        children: z.ZodOptional<z.ZodArray<typeof LayoutNode>>;
+    }, z.core.$loose>>>;
+    queued: z.ZodOptional<z.ZodBoolean>;
+    url: z.ZodOptional<z.ZodString>;
+    route: z.ZodOptional<z.ZodString>;
+    component: z.ZodOptional<z.ZodString>;
+    abilities: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodBoolean>>;
+}, z.core.$loose>;
+export type ActionScope = z.infer<typeof ActionScope>;
+export type ActionPlacement = z.infer<typeof ActionPlacement>;
+export type ActionConfirm = z.infer<typeof ActionConfirm>;
+export type Action = z.infer<typeof Action>;
+/** An action as a backend writes it: `kind` defaults to `server`. */
+export type ActionInput = z.input<typeof Action>;
+//# sourceMappingURL=action.d.ts.map

package/dist/schemas/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/schemas/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,eAAO,MAAM,WAAW;;;;EAA4C,CAAC;AAErE,eAAO,MAAM,eAAe;;;;;EAA6C,CAAC;AAE1E,eAAO,MAAM,aAAa;;;;;mBAWxB,CAAC;AAEH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2CwE,CAAC;AAE5F,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AACtD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAC1D,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC;AAC5C,qEAAqE;AACrE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC"}

package/dist/schemas/action.js

@@ -0,0 +1,56 @@
+import { Abilities } from "./common.js";
+import { Field } from "./field.js";
+import { LayoutNode } from "./layout.js";
+import { z } from "zod";
+//#region src/schemas/action.ts
+var ActionScope = z.enum([
+	"item",
+	"selection",
+	"resource"
+]);
+var ActionPlacement = z.enum([
+	"row",
+	"toolbar",
+	"form",
+	"menu"
+]);
+var ActionConfirm = z.union([z.boolean(), z.looseObject({
+	title: z.string().optional(),
+	message: z.string().optional().meta({ description: "ICU message. `{count}` is the number of items." }),
+	confirmLabel: z.string().optional(),
+	cancelLabel: z.string().optional()
+})]);
+var Action = z.looseObject({
+	id: z.string().min(1),
+	label: z.string(),
+	icon: z.string().optional(),
+	kind: z.enum([
+		"server",
+		"link",
+		"client"
+	]).default("server").meta({ description: "`server` calls the action endpoint; `link` navigates; `client` runs a plugin handler." }),
+	scope: z.array(ActionScope).min(1),
+	placement: z.array(ActionPlacement).optional(),
+	destructive: z.boolean().optional(),
+	confirm: ActionConfirm.optional(),
+	fields: z.array(Field).optional().meta({ description: "Parameters, shown in a modal." }),
+	layout: z.array(LayoutNode).optional(),
+	queued: z.boolean().optional().meta({ description: "The action always answers `202` with a run." }),
+	url: z.string().optional().meta({ description: "`link`: URL template, with `{id}` for the item." }),
+	route: z.string().optional().meta({ description: "`link`: name of a route in the definition." }),
+	component: z.string().optional().meta({ description: "`client`: the plugin handler." }),
+	abilities: Abilities.optional().meta({ description: "`run`: whether the current user can run the action on the resource." })
+}).superRefine((action, context) => {
+	if (action.kind === "link" && action.url === void 0 && action.route === void 0) context.addIssue({
+		code: "custom",
+		message: "A `link` action needs a `url` or a `route`."
+	});
+	if (action.kind === "client" && action.component === void 0) context.addIssue({
+		code: "custom",
+		message: "A `client` action needs a `component`."
+	});
+}).meta({ description: "An operation on one item, a selection, or the whole resource." });
+//#endregion
+export { Action, ActionConfirm, ActionPlacement, ActionScope };
+
+//# sourceMappingURL=action.js.map

package/dist/schemas/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","names":[],"sources":["../../src/schemas/action.ts"],"sourcesContent":["import { z } from 'zod';\n\nimport { Abilities } from './common';\nimport { Field } from './field';\nimport { LayoutNode } from './layout';\n\nexport const ActionScope = z.enum(['item', 'selection', 'resource']);\n\nexport const ActionPlacement = z.enum(['row', 'toolbar', 'form', 'menu']);\n\nexport const ActionConfirm = z.union([\n    z.boolean(),\n    z.looseObject({\n        title: z.string().optional(),\n        message: z\n            .string()\n            .optional()\n            .meta({ description: 'ICU message. `{count}` is the number of items.' }),\n        confirmLabel: z.string().optional(),\n        cancelLabel: z.string().optional(),\n    }),\n]);\n\nexport const Action = z\n    .looseObject({\n        id: z.string().min(1),\n        label: z.string(),\n        icon: z.string().optional(),\n        kind: z.enum(['server', 'link', 'client']).default('server').meta({\n            description:\n                '`server` calls the action endpoint; `link` navigates; `client` runs a plugin handler.',\n        }),\n        scope: z.array(ActionScope).min(1),\n        placement: z.array(ActionPlacement).optional(),\n        destructive: z.boolean().optional(),\n        confirm: ActionConfirm.optional(),\n        fields: z.array(Field).optional().meta({ description: 'Parameters, shown in a modal.' }),\n        layout: z.array(LayoutNode).optional(),\n        queued: z\n            .boolean()\n            .optional()\n            .meta({ description: 'The action always answers `202` with a run.' }),\n        url: z\n            .string()\n            .optional()\n            .meta({ description: '`link`: URL template, with `{id}` for the item.' }),\n        route: z\n            .string()\n            .optional()\n            .meta({ description: '`link`: name of a route in the definition.' }),\n        component: z.string().optional().meta({ description: '`client`: the plugin handler.' }),\n        abilities: Abilities.optional().meta({\n            description: '`run`: whether the current user can run the action on the resource.',\n        }),\n    })\n    .superRefine((action, context) => {\n        if (action.kind === 'link' && action.url === undefined && action.route === undefined) {\n            context.addIssue({\n                code: 'custom',\n                message: 'A `link` action needs a `url` or a `route`.',\n            });\n        }\n        if (action.kind === 'client' && action.component === undefined) {\n            context.addIssue({ code: 'custom', message: 'A `client` action needs a `component`.' });\n        }\n    })\n    .meta({ description: 'An operation on one item, a selection, or the whole resource.' });\n\nexport type ActionScope = z.infer<typeof ActionScope>;\nexport type ActionPlacement = z.infer<typeof ActionPlacement>;\nexport type ActionConfirm = z.infer<typeof ActionConfirm>;\nexport type Action = z.infer<typeof Action>;\n/** An action as a backend writes it: `kind` defaults to `server`. */\nexport type ActionInput = z.input<typeof Action>;\n"],"mappings":";;;;;AAMA,IAAa,cAAc,EAAE,KAAK;CAAC;CAAQ;CAAa;AAAU,CAAC;AAEnE,IAAa,kBAAkB,EAAE,KAAK;CAAC;CAAO;CAAW;CAAQ;AAAM,CAAC;AAExE,IAAa,gBAAgB,EAAE,MAAM,CACjC,EAAE,QAAQ,GACV,EAAE,YAAY;CACV,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS;CAC3B,SAAS,EACJ,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,iDAAiD,CAAC;CAC3E,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS;CAClC,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;AACrC,CAAC,CACL,CAAC;AAED,IAAa,SAAS,EACjB,YAAY;CACT,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC;CACpB,OAAO,EAAE,OAAO;CAChB,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS;CAC1B,MAAM,EAAE,KAAK;EAAC;EAAU;EAAQ;CAAQ,CAAC,CAAC,CAAC,QAAQ,QAAQ,CAAC,CAAC,KAAK,EAC9D,aACI,wFACR,CAAC;CACD,OAAO,EAAE,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC;CACjC,WAAW,EAAE,MAAM,eAAe,CAAC,CAAC,SAAS;CAC7C,aAAa,EAAE,QAAQ,CAAC,CAAC,SAAS;CAClC,SAAS,cAAc,SAAS;CAChC,QAAQ,EAAE,MAAM,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;CACvF,QAAQ,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CACrC,QAAQ,EACH,QAAQ,CAAC,CACT,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,8CAA8C,CAAC;CACxE,KAAK,EACA,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,kDAAkD,CAAC;CAC5E,OAAO,EACF,OAAO,CAAC,CACR,SAAS,CAAC,CACV,KAAK,EAAE,aAAa,6CAA6C,CAAC;CACvE,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,aAAa,gCAAgC,CAAC;CACtF,WAAW,UAAU,SAAS,CAAC,CAAC,KAAK,EACjC,aAAa,sEACjB,CAAC;AACL,CAAC,CAAC,CACD,aAAa,QAAQ,YAAY;CAC9B,IAAI,OAAO,SAAS,UAAU,OAAO,QAAQ,KAAA,KAAa,OAAO,UAAU,KAAA,GACvE,QAAQ,SAAS;EACb,MAAM;EACN,SAAS;CACb,CAAC;CAEL,IAAI,OAAO,SAAS,YAAY,OAAO,cAAc,KAAA,GACjD,QAAQ,SAAS;EAAE,MAAM;EAAU,SAAS;CAAyC,CAAC;AAE9F,CAAC,CAAC,CACD,KAAK,EAAE,aAAa,gEAAgE,CAAC"}