@panneau/core 4.1.1 → 5.0.0-alpha.1

package/dist/list/list.js

@@ -0,0 +1,191 @@
+import { isEqual } from "../values.js";
+import { fromSearchParams, isFilterRange, toSearchParams } from "@panneau/protocol/runtime";
+//#region src/list/list.ts
+var EMPTY_SELECTION = {
+	mode: "ids",
+	ids: []
+};
+var LIST_PARAM = /^(page|perPage|sort|q|fields|filter\[.+)$/;
+/** Removes the values that are the defaults, so the URL only keeps what the user changed. */
+function normalize(query, defaults) {
+	const result = {};
+	if (query.page !== void 0 && query.page > 1) result.page = query.page;
+	if (query.perPage !== void 0 && query.perPage !== defaults.perPage) result.perPage = query.perPage;
+	if (query.sort !== void 0 && !isEqual(query.sort, defaults.sort)) result.sort = [...query.sort];
+	const filter = Object.fromEntries(Object.entries(query.filter ?? {}).filter(([, value]) => value !== "" && !(Array.isArray(value) && value.length === 0) && !(isFilterRange(value) && Object.keys(value).length === 0)));
+	if (Object.keys(filter).length > 0) result.filter = filter;
+	if (query.q !== void 0 && query.q !== "") result.q = query.q;
+	if (query.fields !== void 0) result.fields = query.fields;
+	return result;
+}
+/** Creates a headless list. */
+function createList(options = {}) {
+	const defaults = {
+		perPage: options.defaults?.perPage ?? options.list?.perPage ?? 20,
+		sort: options.defaults?.sort ?? options.list?.defaultSort ?? []
+	};
+	const router = options.router ?? null;
+	const readRouter = () => router !== null ? normalize(fromSearchParams(new URLSearchParams(router.getSearch())), defaults) : {};
+	let params = router !== null ? readRouter() : normalize(options.query ?? {}, defaults);
+	let selection = EMPTY_SELECTION;
+	const compute = () => ({
+		query: {
+			...params,
+			page: params.page ?? 1,
+			perPage: params.perPage ?? defaults.perPage,
+			...params.sort !== void 0 || defaults.sort.length > 0 ? { sort: params.sort ?? defaults.sort } : {}
+		},
+		selection
+	});
+	let state = compute();
+	const listeners = /* @__PURE__ */ new Set();
+	const notify = () => {
+		state = compute();
+		listeners.forEach((listener) => listener());
+	};
+	const writeRouter = (replace) => {
+		if (router === null) return;
+		const search = new URLSearchParams(router.getSearch());
+		[...search.keys()].filter((key) => LIST_PARAM.test(key)).forEach((key) => search.delete(key));
+		toSearchParams(params).forEach((value, key) => search.append(key, value));
+		const next = search.toString();
+		if (next !== router.getSearch()) router.setSearch(next, { replace });
+	};
+	const setParams = (next, { replace = false } = {}) => {
+		const normalized = normalize(next, defaults);
+		if (isEqual(normalized, params)) return;
+		const scopeChanged = !isEqual(normalized.filter, params.filter) || normalized.q !== params.q;
+		params = normalized;
+		if (scopeChanged) selection = EMPTY_SELECTION;
+		writeRouter(replace);
+		notify();
+	};
+	const setSelection = (next) => {
+		selection = next;
+		notify();
+	};
+	let unsubscribeRouter = null;
+	const onRouterChange = () => {
+		const next = readRouter();
+		if (isEqual(next, params)) return;
+		if (!isEqual(next.filter, params.filter) || next.q !== params.q) selection = EMPTY_SELECTION;
+		params = next;
+		notify();
+	};
+	const list = {
+		getState() {
+			if (router !== null && unsubscribeRouter === null) onRouterChange();
+			return state;
+		},
+		subscribe(listener) {
+			listeners.add(listener);
+			if (router !== null && unsubscribeRouter === null) {
+				unsubscribeRouter = router.subscribe(onRouterChange);
+				onRouterChange();
+			}
+			return () => {
+				listeners.delete(listener);
+				if (listeners.size === 0 && unsubscribeRouter !== null) {
+					unsubscribeRouter();
+					unsubscribeRouter = null;
+				}
+			};
+		},
+		setPage: (page) => setParams({
+			...params,
+			page
+		}),
+		setPerPage: (perPage) => setParams({
+			...params,
+			perPage,
+			page: 1
+		}),
+		setSort: (sort) => setParams({
+			...params,
+			sort: [...sort],
+			page: 1
+		}),
+		toggleSort(field) {
+			const sort = state.query.sort ?? [];
+			if (sort[0] === field) setParams({
+				...params,
+				sort: [`-${field}`],
+				page: 1
+			});
+			else if (sort[0] === `-${field}` && params.sort !== void 0) {
+				const { sort: _sort, ...rest } = params;
+				setParams({
+					...rest,
+					page: 1
+				});
+			} else setParams({
+				...params,
+				sort: [field],
+				page: 1
+			});
+		},
+		setFilter(id, value) {
+			const { [id]: _removed, ...filter } = params.filter ?? {};
+			setParams({
+				...params,
+				filter: value === void 0 ? filter : {
+					...filter,
+					[id]: value
+				},
+				page: 1
+			});
+		},
+		setSearch: (q) => setParams({
+			...params,
+			q,
+			page: 1
+		}, { replace: true }),
+		resetQuery: () => setParams({}),
+		select(ids) {
+			if (selection.mode === "all") setSelection({
+				mode: "all",
+				except: selection.except.filter((id) => !ids.includes(id))
+			});
+			else setSelection({
+				mode: "ids",
+				ids: [.../* @__PURE__ */ new Set([...selection.ids, ...ids])]
+			});
+		},
+		deselect(ids) {
+			if (selection.mode === "all") setSelection({
+				mode: "all",
+				except: [.../* @__PURE__ */ new Set([...selection.except, ...ids])]
+			});
+			else setSelection({
+				mode: "ids",
+				ids: selection.ids.filter((id) => !ids.includes(id))
+			});
+		},
+		toggle(id) {
+			if (list.isSelected(id)) list.deselect([id]);
+			else list.select([id]);
+		},
+		selectAllMatching: () => setSelection({
+			mode: "all",
+			except: []
+		}),
+		clearSelection: () => setSelection(EMPTY_SELECTION),
+		isSelected: (id) => selection.mode === "all" ? !selection.except.includes(id) : selection.ids.includes(id),
+		getSelectedCount: (total) => selection.mode === "all" ? Math.max(0, total - selection.except.length) : selection.ids.length,
+		getSelection() {
+			if (selection.mode === "ids") return selection.ids.length > 0 ? { ids: [...selection.ids] } : null;
+			const query = {};
+			if (params.filter !== void 0) query.filter = params.filter;
+			if (params.q !== void 0) query.q = params.q;
+			return selection.except.length > 0 ? {
+				query,
+				except: [...selection.except]
+			} : { query };
+		}
+	};
+	return list;
+}
+//#endregion
+export { createList };
+
+//# sourceMappingURL=list.js.map

package/dist/list/list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list.js","names":[],"sources":["../../src/list/list.ts"],"sourcesContent":["import type { FilterValue, ListQuery, Selection } from '@panneau/protocol';\nimport { fromSearchParams, isFilterRange, toSearchParams } from '@panneau/protocol/runtime';\n\nimport type { ResolvedList } from '../definition/list';\nimport { isEqual } from '../values';\nimport type { Router } from './router';\n\n/**\n * Selected items: some ids, or every item matching the list query (filters and search) except\n * some ids. \"All matching\" covers the items of every page.\n */\nexport type ListSelection =\n    { mode: 'ids'; ids: readonly string[] } | { mode: 'all'; except: readonly string[] };\n\nexport interface ListState {\n    /** The query to fetch: the list's defaults, overridden by the current state. */\n    query: ListQuery;\n    selection: ListSelection;\n}\n\nexport interface ListDefaults {\n    perPage?: number;\n    /** Default sort, as `sort` query values (`['-published_at']`). */\n    sort?: string[];\n}\n\nexport interface ListOptions {\n    /** A resolved list, for the defaults (`perPage`, `defaultSort`). */\n    list?: ResolvedList;\n    /** Defaults, over those of `list`. Default values are not written to the URL. */\n    defaults?: ListDefaults;\n    /** The starting query, when there is no router. */\n    query?: ListQuery;\n    /** Keeps the query in the URL. The router's query string wins over `query`. */\n    router?: Router | null;\n}\n\n/** A headless list: query and selection. React components use `useList()`. */\nexport interface List {\n    getState(): ListState;\n    subscribe(listener: () => void): () => void;\n    setPage(page: number): void;\n    /** Sets the page size, and goes back to the first page. */\n    setPerPage(perPage: number): void;\n    /** Sets the sort (`['-published_at', 'title']`), and goes back to the first page. */\n    setSort(sort: readonly string[]): void;\n    /** Sorts by a field: ascending, then descending, then back to the default sort. */\n    toggleSort(field: string): void;\n    /** Sets or removes (`undefined`) a filter, goes back to the first page, and clears the selection. */\n    setFilter(id: string, value: FilterValue | undefined): void;\n    /** Sets the search, goes back to the first page, and clears the selection. */\n    setSearch(q: string): void;\n    /** Removes the page, filters, search and sort: back to the defaults. */\n    resetQuery(): void;\n    /** Adds ids to the selection (removes them from the exceptions in \"all matching\" mode). */\n    select(ids: readonly string[]): void;\n    /** Removes ids from the selection (adds them to the exceptions in \"all matching\" mode). */\n    deselect(ids: readonly string[]): void;\n    toggle(id: string): void;\n    /** Selects every item matching the query, on every page. */\n    selectAllMatching(): void;\n    clearSelection(): void;\n    isSelected(id: string): boolean;\n    /** How many items are selected, given the total of the list. */\n    getSelectedCount(total: number): number;\n    /** The selection to send with an action, or `null` when nothing is selected. */\n    getSelection(): Selection | null;\n}\n\nconst EMPTY_SELECTION: ListSelection = { mode: 'ids', ids: [] };\nconst LIST_PARAM = /^(page|perPage|sort|q|fields|filter\\[.+)$/;\n\n/** Removes the values that are the defaults, so the URL only keeps what the user changed. */\nfunction normalize(query: ListQuery, defaults: Required<ListDefaults>): ListQuery {\n    const result: ListQuery = {};\n    if (query.page !== undefined && query.page > 1) {\n        result.page = query.page;\n    }\n    if (query.perPage !== undefined && query.perPage !== defaults.perPage) {\n        result.perPage = query.perPage;\n    }\n    if (query.sort !== undefined && !isEqual(query.sort, defaults.sort)) {\n        result.sort = [...query.sort];\n    }\n    const filter = Object.fromEntries(\n        Object.entries(query.filter ?? {}).filter(\n            ([, value]) =>\n                value !== '' &&\n                !(Array.isArray(value) && value.length === 0) &&\n                !(isFilterRange(value) && Object.keys(value).length === 0),\n        ),\n    );\n    if (Object.keys(filter).length > 0) {\n        result.filter = filter;\n    }\n    if (query.q !== undefined && query.q !== '') {\n        result.q = query.q;\n    }\n    if (query.fields !== undefined) {\n        result.fields = query.fields;\n    }\n    return result;\n}\n\n/** Creates a headless list. */\nexport function createList(options: ListOptions = {}): List {\n    const defaults: Required<ListDefaults> = {\n        perPage: options.defaults?.perPage ?? options.list?.perPage ?? 20,\n        sort: options.defaults?.sort ?? options.list?.defaultSort ?? [],\n    };\n    const router = options.router ?? null;\n    const readRouter = (): ListQuery =>\n        router !== null\n            ? normalize(fromSearchParams(new URLSearchParams(router.getSearch())), defaults)\n            : {};\n\n    let params: ListQuery =\n        router !== null ? readRouter() : normalize(options.query ?? {}, defaults);\n    let selection: ListSelection = EMPTY_SELECTION;\n\n    const compute = (): ListState => ({\n        query: {\n            ...params,\n            page: params.page ?? 1,\n            perPage: params.perPage ?? defaults.perPage,\n            ...(params.sort !== undefined || defaults.sort.length > 0\n                ? { sort: params.sort ?? defaults.sort }\n                : {}),\n        },\n        selection,\n    });\n\n    let state = compute();\n    const listeners = new Set<() => void>();\n    const notify = () => {\n        state = compute();\n        listeners.forEach((listener) => listener());\n    };\n\n    const writeRouter = (replace: boolean) => {\n        if (router === null) {\n            return;\n        }\n        const search = new URLSearchParams(router.getSearch());\n        [...search.keys()]\n            .filter((key) => LIST_PARAM.test(key))\n            .forEach((key) => search.delete(key));\n        toSearchParams(params).forEach((value, key) => search.append(key, value));\n        const next = search.toString();\n        if (next !== router.getSearch()) {\n            router.setSearch(next, { replace });\n        }\n    };\n\n    const setParams = (next: ListQuery, { replace = false } = {}) => {\n        const normalized = normalize(next, defaults);\n        if (isEqual(normalized, params)) {\n            return;\n        }\n        const scopeChanged =\n            !isEqual(normalized.filter, params.filter) || normalized.q !== params.q;\n        params = normalized;\n        if (scopeChanged) {\n            selection = EMPTY_SELECTION;\n        }\n        writeRouter(replace);\n        notify();\n    };\n\n    const setSelection = (next: ListSelection) => {\n        selection = next;\n        notify();\n    };\n\n    let unsubscribeRouter: (() => void) | null = null;\n    const onRouterChange = () => {\n        const next = readRouter();\n        if (isEqual(next, params)) {\n            return;\n        }\n        if (!isEqual(next.filter, params.filter) || next.q !== params.q) {\n            selection = EMPTY_SELECTION;\n        }\n        params = next;\n        notify();\n    };\n\n    const list: List = {\n        getState() {\n            if (router !== null && unsubscribeRouter === null) {\n                onRouterChange();\n            }\n            return state;\n        },\n        subscribe(listener) {\n            listeners.add(listener);\n            if (router !== null && unsubscribeRouter === null) {\n                unsubscribeRouter = router.subscribe(onRouterChange);\n                onRouterChange();\n            }\n            return () => {\n                listeners.delete(listener);\n                if (listeners.size === 0 && unsubscribeRouter !== null) {\n                    unsubscribeRouter();\n                    unsubscribeRouter = null;\n                }\n            };\n        },\n        setPage: (page) => setParams({ ...params, page }),\n        setPerPage: (perPage) => setParams({ ...params, perPage, page: 1 }),\n        setSort: (sort) => setParams({ ...params, sort: [...sort], page: 1 }),\n        toggleSort(field) {\n            const sort = state.query.sort ?? [];\n            if (sort[0] === field) {\n                setParams({ ...params, sort: [`-${field}`], page: 1 });\n            } else if (sort[0] === `-${field}` && params.sort !== undefined) {\n                const { sort: _sort, ...rest } = params;\n                setParams({ ...rest, page: 1 });\n            } else {\n                setParams({ ...params, sort: [field], page: 1 });\n            }\n        },\n        setFilter(id, value) {\n            const { [id]: _removed, ...filter } = params.filter ?? {};\n            setParams({\n                ...params,\n                filter: value === undefined ? filter : { ...filter, [id]: value },\n                page: 1,\n            });\n        },\n        setSearch: (q) => setParams({ ...params, q, page: 1 }, { replace: true }),\n        resetQuery: () => setParams({}),\n        select(ids) {\n            if (selection.mode === 'all') {\n                setSelection({\n                    mode: 'all',\n                    except: selection.except.filter((id) => !ids.includes(id)),\n                });\n            } else {\n                setSelection({ mode: 'ids', ids: [...new Set([...selection.ids, ...ids])] });\n            }\n        },\n        deselect(ids) {\n            if (selection.mode === 'all') {\n                setSelection({ mode: 'all', except: [...new Set([...selection.except, ...ids])] });\n            } else {\n                setSelection({ mode: 'ids', ids: selection.ids.filter((id) => !ids.includes(id)) });\n            }\n        },\n        toggle(id) {\n            if (list.isSelected(id)) {\n                list.deselect([id]);\n            } else {\n                list.select([id]);\n            }\n        },\n        selectAllMatching: () => setSelection({ mode: 'all', except: [] }),\n        clearSelection: () => setSelection(EMPTY_SELECTION),\n        isSelected: (id) =>\n            selection.mode === 'all' ? !selection.except.includes(id) : selection.ids.includes(id),\n        getSelectedCount: (total) =>\n            selection.mode === 'all'\n                ? Math.max(0, total - selection.except.length)\n                : selection.ids.length,\n        getSelection() {\n            if (selection.mode === 'ids') {\n                return selection.ids.length > 0 ? { ids: [...selection.ids] } : null;\n            }\n            const query: { filter?: Record<string, unknown>; q?: string } = {};\n            if (params.filter !== undefined) {\n                query.filter = params.filter;\n            }\n            if (params.q !== undefined) {\n                query.q = params.q;\n            }\n            return selection.except.length > 0\n                ? { query, except: [...selection.except] }\n                : { query };\n        },\n    };\n    return list;\n}\n"],"mappings":";;;AAqEA,IAAM,kBAAiC;CAAE,MAAM;CAAO,KAAK,CAAA;AAAG;AAC9D,IAAM,aAAa;;AAGnB,SAAS,UAAU,OAAkB,UAA6C;CAC9E,MAAM,SAAoB,CAAC;CAC3B,IAAI,MAAM,SAAS,KAAA,KAAa,MAAM,OAAO,GACzC,OAAO,OAAO,MAAM;CAExB,IAAI,MAAM,YAAY,KAAA,KAAa,MAAM,YAAY,SAAS,SAC1D,OAAO,UAAU,MAAM;CAE3B,IAAI,MAAM,SAAS,KAAA,KAAa,CAAC,QAAQ,MAAM,MAAM,SAAS,IAAI,GAC9D,OAAO,OAAO,CAAC,GAAG,MAAM,IAAI;CAEhC,MAAM,SAAS,OAAO,YAClB,OAAO,QAAQ,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC,QAC9B,GAAG,WACA,UAAU,MACV,EAAE,MAAM,QAAQ,KAAK,KAAK,MAAM,WAAW,MAC3C,EAAE,cAAc,KAAK,KAAK,OAAO,KAAK,KAAK,CAAC,CAAC,WAAW,EAChE,CACJ;CACA,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC,SAAS,GAC7B,OAAO,SAAS;CAEpB,IAAI,MAAM,MAAM,KAAA,KAAa,MAAM,MAAM,IACrC,OAAO,IAAI,MAAM;CAErB,IAAI,MAAM,WAAW,KAAA,GACjB,OAAO,SAAS,MAAM;CAE1B,OAAO;AACX;;AAGA,SAAgB,WAAW,UAAuB,CAAC,GAAS;CACxD,MAAM,WAAmC;EACrC,SAAS,QAAQ,UAAU,WAAW,QAAQ,MAAM,WAAW;EAC/D,MAAM,QAAQ,UAAU,QAAQ,QAAQ,MAAM,eAAe,CAAA;CACjE;CACA,MAAM,SAAS,QAAQ,UAAU;CACjC,MAAM,mBACF,WAAW,OACL,UAAU,iBAAiB,IAAI,gBAAgB,OAAO,UAAU,CAAC,CAAC,GAAG,QAAQ,IAC7E,CAAC;CAEX,IAAI,SACA,WAAW,OAAO,WAAW,IAAI,UAAU,QAAQ,SAAS,CAAC,GAAG,QAAQ;CAC5E,IAAI,YAA2B;CAE/B,MAAM,iBAA4B;EAC9B,OAAO;GACH,GAAG;GACH,MAAM,OAAO,QAAQ;GACrB,SAAS,OAAO,WAAW,SAAS;GACpC,GAAI,OAAO,SAAS,KAAA,KAAa,SAAS,KAAK,SAAS,IAClD,EAAE,MAAM,OAAO,QAAQ,SAAS,KAAK,IACrC,CAAC;EACX;EACA;CACJ;CAEA,IAAI,QAAQ,QAAQ;CACpB,MAAM,4BAAY,IAAI,IAAgB;CACtC,MAAM,eAAe;EACjB,QAAQ,QAAQ;EAChB,UAAU,SAAS,aAAa,SAAS,CAAC;CAC9C;CAEA,MAAM,eAAe,YAAqB;EACtC,IAAI,WAAW,MACX;EAEJ,MAAM,SAAS,IAAI,gBAAgB,OAAO,UAAU,CAAC;EACrD,CAAC,GAAG,OAAO,KAAK,CAAC,CAAC,CACb,QAAQ,QAAQ,WAAW,KAAK,GAAG,CAAC,CAAC,CACrC,SAAS,QAAQ,OAAO,OAAO,GAAG,CAAC;EACxC,eAAe,MAAM,CAAC,CAAC,SAAS,OAAO,QAAQ,OAAO,OAAO,KAAK,KAAK,CAAC;EACxE,MAAM,OAAO,OAAO,SAAS;EAC7B,IAAI,SAAS,OAAO,UAAU,GAC1B,OAAO,UAAU,MAAM,EAAE,QAAQ,CAAC;CAE1C;CAEA,MAAM,aAAa,MAAiB,EAAE,UAAU,UAAU,CAAC,MAAM;EAC7D,MAAM,aAAa,UAAU,MAAM,QAAQ;EAC3C,IAAI,QAAQ,YAAY,MAAM,GAC1B;EAEJ,MAAM,eACF,CAAC,QAAQ,WAAW,QAAQ,OAAO,MAAM,KAAK,WAAW,MAAM,OAAO;EAC1E,SAAS;EACT,IAAI,cACA,YAAY;EAEhB,YAAY,OAAO;EACnB,OAAO;CACX;CAEA,MAAM,gBAAgB,SAAwB;EAC1C,YAAY;EACZ,OAAO;CACX;CAEA,IAAI,oBAAyC;CAC7C,MAAM,uBAAuB;EACzB,MAAM,OAAO,WAAW;EACxB,IAAI,QAAQ,MAAM,MAAM,GACpB;EAEJ,IAAI,CAAC,QAAQ,KAAK,QAAQ,OAAO,MAAM,KAAK,KAAK,MAAM,OAAO,GAC1D,YAAY;EAEhB,SAAS;EACT,OAAO;CACX;CAEA,MAAM,OAAa;EACf,WAAW;GACP,IAAI,WAAW,QAAQ,sBAAsB,MACzC,eAAe;GAEnB,OAAO;EACX;EACA,UAAU,UAAU;GAChB,UAAU,IAAI,QAAQ;GACtB,IAAI,WAAW,QAAQ,sBAAsB,MAAM;IAC/C,oBAAoB,OAAO,UAAU,cAAc;IACnD,eAAe;GACnB;GACA,aAAa;IACT,UAAU,OAAO,QAAQ;IACzB,IAAI,UAAU,SAAS,KAAK,sBAAsB,MAAM;KACpD,kBAAkB;KAClB,oBAAoB;IACxB;GACJ;EACJ;EACA,UAAU,SAAS,UAAU;GAAE,GAAG;GAAQ;EAAK,CAAC;EAChD,aAAa,YAAY,UAAU;GAAE,GAAG;GAAQ;GAAS,MAAM;EAAE,CAAC;EAClE,UAAU,SAAS,UAAU;GAAE,GAAG;GAAQ,MAAM,CAAC,GAAG,IAAI;GAAG,MAAM;EAAE,CAAC;EACpE,WAAW,OAAO;GACd,MAAM,OAAO,MAAM,MAAM,QAAQ,CAAA;GACjC,IAAI,KAAK,OAAO,OACZ,UAAU;IAAE,GAAG;IAAQ,MAAM,CAAC,IAAI,OAAO;IAAG,MAAM;GAAE,CAAC;QAClD,IAAI,KAAK,OAAO,IAAI,WAAW,OAAO,SAAS,KAAA,GAAW;IAC7D,MAAM,EAAE,MAAM,OAAO,GAAG,SAAS;IACjC,UAAU;KAAE,GAAG;KAAM,MAAM;IAAE,CAAC;GAClC,OACI,UAAU;IAAE,GAAG;IAAQ,MAAM,CAAC,KAAK;IAAG,MAAM;GAAE,CAAC;EAEvD;EACA,UAAU,IAAI,OAAO;GACjB,MAAM,GAAG,KAAK,UAAU,GAAG,WAAW,OAAO,UAAU,CAAC;GACxD,UAAU;IACN,GAAG;IACH,QAAQ,UAAU,KAAA,IAAY,SAAS;KAAE,GAAG;MAAS,KAAK;IAAM;IAChE,MAAM;GACV,CAAC;EACL;EACA,YAAY,MAAM,UAAU;GAAE,GAAG;GAAQ;GAAG,MAAM;EAAE,GAAG,EAAE,SAAS,KAAK,CAAC;EACxE,kBAAkB,UAAU,CAAC,CAAC;EAC9B,OAAO,KAAK;GACR,IAAI,UAAU,SAAS,OACnB,aAAa;IACT,MAAM;IACN,QAAQ,UAAU,OAAO,QAAQ,OAAO,CAAC,IAAI,SAAS,EAAE,CAAC;GAC7D,CAAC;QAED,aAAa;IAAE,MAAM;IAAO,KAAK,CAAC,mBAAG,IAAI,IAAI,CAAC,GAAG,UAAU,KAAK,GAAG,GAAG,CAAC,CAAC;GAAE,CAAC;EAEnF;EACA,SAAS,KAAK;GACV,IAAI,UAAU,SAAS,OACnB,aAAa;IAAE,MAAM;IAAO,QAAQ,CAAC,mBAAG,IAAI,IAAI,CAAC,GAAG,UAAU,QAAQ,GAAG,GAAG,CAAC,CAAC;GAAE,CAAC;QAEjF,aAAa;IAAE,MAAM;IAAO,KAAK,UAAU,IAAI,QAAQ,OAAO,CAAC,IAAI,SAAS,EAAE,CAAC;GAAE,CAAC;EAE1F;EACA,OAAO,IAAI;GACP,IAAI,KAAK,WAAW,EAAE,GAClB,KAAK,SAAS,CAAC,EAAE,CAAC;QAElB,KAAK,OAAO,CAAC,EAAE,CAAC;EAExB;EACA,yBAAyB,aAAa;GAAE,MAAM;GAAO,QAAQ,CAAA;EAAG,CAAC;EACjE,sBAAsB,aAAa,eAAe;EAClD,aAAa,OACT,UAAU,SAAS,QAAQ,CAAC,UAAU,OAAO,SAAS,EAAE,IAAI,UAAU,IAAI,SAAS,EAAE;EACzF,mBAAmB,UACf,UAAU,SAAS,QACb,KAAK,IAAI,GAAG,QAAQ,UAAU,OAAO,MAAM,IAC3C,UAAU,IAAI;EACxB,eAAe;GACX,IAAI,UAAU,SAAS,OACnB,OAAO,UAAU,IAAI,SAAS,IAAI,EAAE,KAAK,CAAC,GAAG,UAAU,GAAG,EAAE,IAAI;GAEpE,MAAM,QAA0D,CAAC;GACjE,IAAI,OAAO,WAAW,KAAA,GAClB,MAAM,SAAS,OAAO;GAE1B,IAAI,OAAO,MAAM,KAAA,GACb,MAAM,IAAI,OAAO;GAErB,OAAO,UAAU,OAAO,SAAS,IAC3B;IAAE;IAAO,QAAQ,CAAC,GAAG,UAAU,MAAM;GAAE,IACvC,EAAE,MAAM;EAClB;CACJ;CACA,OAAO;AACX"}

package/dist/list/router.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The part of a router that lists need: read and write the query string, and know when it
+ * changes (back and forward). An app adapts its own router to it.
+ */
+export interface Router {
+    /** The current query string, without `?`. */
+    getSearch(): string;
+    /** Navigates to the same path with another query string. `replace` doesn't add a history entry. */
+    setSearch(search: string, options?: {
+        replace?: boolean;
+    }): void;
+    /** Calls `listener` when the query string changes. Returns a function that unsubscribes. */
+    subscribe(listener: () => void): () => void;
+}
+/** A router over `window.history` and `window.location`. */
+export declare function createHistoryRouter(target?: Window): Router;
+/** A router that keeps the query string in memory, for tests and embedded lists. */
+export interface MemoryRouter extends Router {
+    /** Query strings of the history entries, the last one being the current one. */
+    history: string[];
+    /** Goes back to the previous entry, like the browser's back button. */
+    back(): void;
+}
+/** Creates a router that keeps the query string in memory. */
+export declare function createMemoryRouter(initialSearch?: string): MemoryRouter;
+//# sourceMappingURL=router.d.ts.map

package/dist/list/router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.d.ts","sourceRoot":"","sources":["../../src/list/router.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,MAAM;IACnB,6CAA6C;IAC7C,SAAS,IAAI,MAAM,CAAC;IACpB,mGAAmG;IACnG,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IACjE,4FAA4F;IAC5F,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;CAC/C;AAED,4DAA4D;AAC5D,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,MAAe,GAAG,MAAM,CAuBnE;AAED,oFAAoF;AACpF,MAAM,WAAW,YAAa,SAAQ,MAAM;IACxC,gFAAgF;IAChF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,uEAAuE;IACvE,IAAI,IAAI,IAAI,CAAC;CAChB;AAED,8DAA8D;AAC9D,wBAAgB,kBAAkB,CAAC,aAAa,SAAK,GAAG,YAAY,CA4BnE"}

package/dist/list/router.js

@@ -0,0 +1,54 @@
+//#region src/list/router.ts
+/** A router over `window.history` and `window.location`. */
+function createHistoryRouter(target = window) {
+	const listeners = /* @__PURE__ */ new Set();
+	const notify = () => listeners.forEach((listener) => listener());
+	return {
+		getSearch: () => target.location.search.replace(/^\?/, ""),
+		setSearch(search, { replace = false } = {}) {
+			const url = `${target.location.pathname}${search !== "" ? `?${search}` : ""}${target.location.hash}`;
+			if (replace) target.history.replaceState(target.history.state, "", url);
+			else target.history.pushState(target.history.state, "", url);
+			notify();
+		},
+		subscribe(listener) {
+			listeners.add(listener);
+			target.addEventListener("popstate", listener);
+			return () => {
+				listeners.delete(listener);
+				target.removeEventListener("popstate", listener);
+			};
+		}
+	};
+}
+/** Creates a router that keeps the query string in memory. */
+function createMemoryRouter(initialSearch = "") {
+	const history = [initialSearch];
+	const listeners = /* @__PURE__ */ new Set();
+	const notify = () => listeners.forEach((listener) => listener());
+	return {
+		history,
+		getSearch: () => history.at(-1) ?? "",
+		back() {
+			if (history.length > 1) {
+				history.pop();
+				notify();
+			}
+		},
+		setSearch(search, { replace = false } = {}) {
+			if (replace) history[history.length - 1] = search;
+			else history.push(search);
+			notify();
+		},
+		subscribe(listener) {
+			listeners.add(listener);
+			return () => {
+				listeners.delete(listener);
+			};
+		}
+	};
+}
+//#endregion
+export { createHistoryRouter, createMemoryRouter };
+
+//# sourceMappingURL=router.js.map

package/dist/list/router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.js","names":[],"sources":["../../src/list/router.ts"],"sourcesContent":["/**\n * The part of a router that lists need: read and write the query string, and know when it\n * changes (back and forward). An app adapts its own router to it.\n */\nexport interface Router {\n    /** The current query string, without `?`. */\n    getSearch(): string;\n    /** Navigates to the same path with another query string. `replace` doesn't add a history entry. */\n    setSearch(search: string, options?: { replace?: boolean }): void;\n    /** Calls `listener` when the query string changes. Returns a function that unsubscribes. */\n    subscribe(listener: () => void): () => void;\n}\n\n/** A router over `window.history` and `window.location`. */\nexport function createHistoryRouter(target: Window = window): Router {\n    const listeners = new Set<() => void>();\n    const notify = () => listeners.forEach((listener) => listener());\n    return {\n        getSearch: () => target.location.search.replace(/^\\?/, ''),\n        setSearch(search, { replace = false } = {}) {\n            const url = `${target.location.pathname}${search !== '' ? `?${search}` : ''}${target.location.hash}`;\n            if (replace) {\n                target.history.replaceState(target.history.state, '', url);\n            } else {\n                target.history.pushState(target.history.state, '', url);\n            }\n            notify();\n        },\n        subscribe(listener) {\n            listeners.add(listener);\n            target.addEventListener('popstate', listener);\n            return () => {\n                listeners.delete(listener);\n                target.removeEventListener('popstate', listener);\n            };\n        },\n    };\n}\n\n/** A router that keeps the query string in memory, for tests and embedded lists. */\nexport interface MemoryRouter extends Router {\n    /** Query strings of the history entries, the last one being the current one. */\n    history: string[];\n    /** Goes back to the previous entry, like the browser's back button. */\n    back(): void;\n}\n\n/** Creates a router that keeps the query string in memory. */\nexport function createMemoryRouter(initialSearch = ''): MemoryRouter {\n    const history = [initialSearch];\n    const listeners = new Set<() => void>();\n    const notify = () => listeners.forEach((listener) => listener());\n    return {\n        history,\n        getSearch: () => history.at(-1) ?? '',\n        back() {\n            if (history.length > 1) {\n                history.pop();\n                notify();\n            }\n        },\n        setSearch(search, { replace = false } = {}) {\n            if (replace) {\n                history[history.length - 1] = search;\n            } else {\n                history.push(search);\n            }\n            notify();\n        },\n        subscribe(listener) {\n            listeners.add(listener);\n            return () => {\n                listeners.delete(listener);\n            };\n        },\n    };\n}\n"],"mappings":";;AAcA,SAAgB,oBAAoB,SAAiB,QAAgB;CACjE,MAAM,4BAAY,IAAI,IAAgB;CACtC,MAAM,eAAe,UAAU,SAAS,aAAa,SAAS,CAAC;CAC/D,OAAO;EACH,iBAAiB,OAAO,SAAS,OAAO,QAAQ,OAAO,EAAE;EACzD,UAAU,QAAQ,EAAE,UAAU,UAAU,CAAC,GAAG;GACxC,MAAM,MAAM,GAAG,OAAO,SAAS,WAAW,WAAW,KAAK,IAAI,WAAW,KAAK,OAAO,SAAS;GAC9F,IAAI,SACA,OAAO,QAAQ,aAAa,OAAO,QAAQ,OAAO,IAAI,GAAG;QAEzD,OAAO,QAAQ,UAAU,OAAO,QAAQ,OAAO,IAAI,GAAG;GAE1D,OAAO;EACX;EACA,UAAU,UAAU;GAChB,UAAU,IAAI,QAAQ;GACtB,OAAO,iBAAiB,YAAY,QAAQ;GAC5C,aAAa;IACT,UAAU,OAAO,QAAQ;IACzB,OAAO,oBAAoB,YAAY,QAAQ;GACnD;EACJ;CACJ;AACJ;;AAWA,SAAgB,mBAAmB,gBAAgB,IAAkB;CACjE,MAAM,UAAU,CAAC,aAAa;CAC9B,MAAM,4BAAY,IAAI,IAAgB;CACtC,MAAM,eAAe,UAAU,SAAS,aAAa,SAAS,CAAC;CAC/D,OAAO;EACH;EACA,iBAAiB,QAAQ,GAAG,EAAE,KAAK;EACnC,OAAO;GACH,IAAI,QAAQ,SAAS,GAAG;IACpB,QAAQ,IAAI;IACZ,OAAO;GACX;EACJ;EACA,UAAU,QAAQ,EAAE,UAAU,UAAU,CAAC,GAAG;GACxC,IAAI,SACA,QAAQ,QAAQ,SAAS,KAAK;QAE9B,QAAQ,KAAK,MAAM;GAEvB,OAAO;EACX;EACA,UAAU,UAAU;GAChB,UAAU,IAAI,QAAQ;GACtB,aAAa;IACT,UAAU,OAAO,QAAQ;GAC7B;EACJ;CACJ;AACJ"}

package/dist/plugins.d.ts

@@ -0,0 +1,73 @@
+import type { ComponentType } from 'react';
+/**
+ * A component provided by a plugin. Its props are defined by the package that renders it (fields,
+ * lists, app), so the registry stores it as given.
+ */
+export type PluginComponent = ComponentType<any>;
+/** UI messages of a locale, keyed by message id. */
+export type Messages = Record<string, string>;
+/** Messages, or a function that loads them (`() => import('./lang/fr.json')`). */
+export type MessagesLoader = Messages | (() => Promise<Messages | {
+    default: Messages;
+}>);
+/** A theme: design tokens (CSS variables without `--`), with optional dark scheme overrides. */
+export interface Theme {
+    label?: string;
+    /** Tokens of the light scheme, or of both schemes without `dark`: `{ 'panneau-color-accent': '#05f' }`. */
+    tokens: Record<string, string>;
+    /** Tokens that change in the dark scheme. */
+    dark?: Record<string, string>;
+}
+/** What a plugin adds to Panneau. Every part is keyed by the name the definition uses. */
+export interface PanneauPlugin {
+    /** Unique id of the plugin. */
+    id: string;
+    /** Field components, by field type (`text`, `page-slug`). */
+    fields?: Record<string, PluginComponent>;
+    /** Components that display a value in lists, by display (`date`, `page-slug`). */
+    displays?: Record<string, PluginComponent>;
+    /** List layouts, by id (`table`, `cards`). */
+    listLayouts?: Record<string, PluginComponent>;
+    /** Handlers of `client` actions, by the action's `component`. */
+    actions?: Record<string, PluginComponent>;
+    /** Pages, by component name (`dashboard`). */
+    pages?: Record<string, PluginComponent>;
+    /** Dashboard widgets, by widget type (`stat`). */
+    widgets?: Record<string, PluginComponent>;
+    /** Layout node components, for `component` nodes of form layouts. */
+    components?: Record<string, PluginComponent>;
+    /** UI messages, by locale. Messages of later plugins override earlier ones. */
+    locales?: Record<string, MessagesLoader>;
+    /** Themes, by id. */
+    themes?: Record<string, Theme>;
+}
+/** The kinds of components a plugin can provide. */
+export type PluginComponentKind = 'fields' | 'displays' | 'listLayouts' | 'actions' | 'pages' | 'widgets' | 'components';
+/** Everything the plugins provide, merged. A later plugin overrides an earlier one. */
+export interface PluginRegistry {
+    /** The plugins, in order. */
+    plugins: readonly PanneauPlugin[];
+    fields: ReadonlyMap<string, PluginComponent>;
+    displays: ReadonlyMap<string, PluginComponent>;
+    listLayouts: ReadonlyMap<string, PluginComponent>;
+    actions: ReadonlyMap<string, PluginComponent>;
+    pages: ReadonlyMap<string, PluginComponent>;
+    widgets: ReadonlyMap<string, PluginComponent>;
+    components: ReadonlyMap<string, PluginComponent>;
+    /** Message loaders of each locale, in plugin order. */
+    locales: ReadonlyMap<string, readonly MessagesLoader[]>;
+    themes: ReadonlyMap<string, Theme>;
+}
+/** Declares a plugin. It returns the plugin as is, with its type checked. */
+export declare function definePlugin(plugin: PanneauPlugin): PanneauPlugin;
+/**
+ * Merges plugins into a registry. Later plugins override the components and themes of earlier
+ * ones, so a project can replace a built-in field. Plugin ids must be unique.
+ */
+export declare function createPluginRegistry(plugins: readonly PanneauPlugin[]): PluginRegistry;
+/**
+ * Loads the messages of a locale from every plugin that provides it, merged in plugin order. A
+ * regional locale (`fr-CA`) falls back to its language (`fr`) for missing messages.
+ */
+export declare function loadMessages(registry: PluginRegistry, locale: string): Promise<Messages>;
+//# sourceMappingURL=plugins.d.ts.map

package/dist/plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C;;;GAGG;AAEH,MAAM,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AAEjD,oDAAoD;AACpD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9C,kFAAkF;AAClF,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,CAAC,MAAM,OAAO,CAAC,QAAQ,GAAG;IAAE,OAAO,EAAE,QAAQ,CAAA;CAAE,CAAC,CAAC,CAAC;AAE1F,gGAAgG;AAChG,MAAM,WAAW,KAAK;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2GAA2G;IAC3G,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,0FAA0F;AAC1F,MAAM,WAAW,aAAa;IAC1B,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACzC,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC3C,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC9C,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC1C,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACxC,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC1C,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzC,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClC;AAED,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,YAAY,CAAC;AAY3F,uFAAuF;AACvF,MAAM,WAAW,cAAc;IAC3B,6BAA6B;IAC7B,OAAO,EAAE,SAAS,aAAa,EAAE,CAAC;IAClC,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC/C,WAAW,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClD,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC9C,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC5C,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC9C,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACjD,uDAAuD;IACvD,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAC,CAAC;IACxD,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CACtC;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAEjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,SAAS,aAAa,EAAE,GAAG,cAAc,CA0BtF;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAkB9F"}

package/dist/plugins.js

@@ -0,0 +1,54 @@
+//#region src/plugins.ts
+var COMPONENT_KINDS = [
+	"fields",
+	"displays",
+	"listLayouts",
+	"actions",
+	"pages",
+	"widgets",
+	"components"
+];
+/** Declares a plugin. It returns the plugin as is, with its type checked. */
+function definePlugin(plugin) {
+	return plugin;
+}
+/**
+* Merges plugins into a registry. Later plugins override the components and themes of earlier
+* ones, so a project can replace a built-in field. Plugin ids must be unique.
+*/
+function createPluginRegistry(plugins) {
+	const ids = /* @__PURE__ */ new Set();
+	plugins.forEach((plugin) => {
+		if (ids.has(plugin.id)) throw new Error(`Two plugins have the id \`${plugin.id}\`.`);
+		ids.add(plugin.id);
+	});
+	const components = Object.fromEntries(COMPONENT_KINDS.map((kind) => [kind, new Map(plugins.flatMap((plugin) => Object.entries(plugin[kind] ?? {})))]));
+	const locales = /* @__PURE__ */ new Map();
+	plugins.forEach((plugin) => Object.entries(plugin.locales ?? {}).forEach(([locale, loader]) => {
+		locales.set(locale, [...locales.get(locale) ?? [], loader]);
+	}));
+	return {
+		plugins: [...plugins],
+		...components,
+		locales,
+		themes: new Map(plugins.flatMap((plugin) => Object.entries(plugin.themes ?? {})))
+	};
+}
+/**
+* Loads the messages of a locale from every plugin that provides it, merged in plugin order. A
+* regional locale (`fr-CA`) falls back to its language (`fr`) for missing messages.
+*/
+async function loadMessages(registry, locale) {
+	const language = locale.split("-")[0] ?? locale;
+	const loaders = [...language !== locale ? registry.locales.get(language) ?? [] : [], ...registry.locales.get(locale) ?? []];
+	const loaded = await Promise.all(loaders.map(async (loader) => {
+		if (typeof loader !== "function") return loader;
+		const result = await loader();
+		return "default" in result && typeof result.default === "object" ? result.default : result;
+	}));
+	return Object.assign({}, ...loaded);
+}
+//#endregion
+export { createPluginRegistry, definePlugin, loadMessages };
+
+//# sourceMappingURL=plugins.js.map

package/dist/plugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.js","names":[],"sources":["../src/plugins.ts"],"sourcesContent":["import type { ComponentType } from 'react';\n\n/**\n * A component provided by a plugin. Its props are defined by the package that renders it (fields,\n * lists, app), so the registry stores it as given.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any -- see above\nexport type PluginComponent = ComponentType<any>;\n\n/** UI messages of a locale, keyed by message id. */\nexport type Messages = Record<string, string>;\n\n/** Messages, or a function that loads them (`() => import('./lang/fr.json')`). */\nexport type MessagesLoader = Messages | (() => Promise<Messages | { default: Messages }>);\n\n/** A theme: design tokens (CSS variables without `--`), with optional dark scheme overrides. */\nexport interface Theme {\n    label?: string;\n    /** Tokens of the light scheme, or of both schemes without `dark`: `{ 'panneau-color-accent': '#05f' }`. */\n    tokens: Record<string, string>;\n    /** Tokens that change in the dark scheme. */\n    dark?: Record<string, string>;\n}\n\n/** What a plugin adds to Panneau. Every part is keyed by the name the definition uses. */\nexport interface PanneauPlugin {\n    /** Unique id of the plugin. */\n    id: string;\n    /** Field components, by field type (`text`, `page-slug`). */\n    fields?: Record<string, PluginComponent>;\n    /** Components that display a value in lists, by display (`date`, `page-slug`). */\n    displays?: Record<string, PluginComponent>;\n    /** List layouts, by id (`table`, `cards`). */\n    listLayouts?: Record<string, PluginComponent>;\n    /** Handlers of `client` actions, by the action's `component`. */\n    actions?: Record<string, PluginComponent>;\n    /** Pages, by component name (`dashboard`). */\n    pages?: Record<string, PluginComponent>;\n    /** Dashboard widgets, by widget type (`stat`). */\n    widgets?: Record<string, PluginComponent>;\n    /** Layout node components, for `component` nodes of form layouts. */\n    components?: Record<string, PluginComponent>;\n    /** UI messages, by locale. Messages of later plugins override earlier ones. */\n    locales?: Record<string, MessagesLoader>;\n    /** Themes, by id. */\n    themes?: Record<string, Theme>;\n}\n\n/** The kinds of components a plugin can provide. */\nexport type PluginComponentKind =\n    'fields' | 'displays' | 'listLayouts' | 'actions' | 'pages' | 'widgets' | 'components';\n\nconst COMPONENT_KINDS: PluginComponentKind[] = [\n    'fields',\n    'displays',\n    'listLayouts',\n    'actions',\n    'pages',\n    'widgets',\n    'components',\n];\n\n/** Everything the plugins provide, merged. A later plugin overrides an earlier one. */\nexport interface PluginRegistry {\n    /** The plugins, in order. */\n    plugins: readonly PanneauPlugin[];\n    fields: ReadonlyMap<string, PluginComponent>;\n    displays: ReadonlyMap<string, PluginComponent>;\n    listLayouts: ReadonlyMap<string, PluginComponent>;\n    actions: ReadonlyMap<string, PluginComponent>;\n    pages: ReadonlyMap<string, PluginComponent>;\n    widgets: ReadonlyMap<string, PluginComponent>;\n    components: ReadonlyMap<string, PluginComponent>;\n    /** Message loaders of each locale, in plugin order. */\n    locales: ReadonlyMap<string, readonly MessagesLoader[]>;\n    themes: ReadonlyMap<string, Theme>;\n}\n\n/** Declares a plugin. It returns the plugin as is, with its type checked. */\nexport function definePlugin(plugin: PanneauPlugin): PanneauPlugin {\n    return plugin;\n}\n\n/**\n * Merges plugins into a registry. Later plugins override the components and themes of earlier\n * ones, so a project can replace a built-in field. Plugin ids must be unique.\n */\nexport function createPluginRegistry(plugins: readonly PanneauPlugin[]): PluginRegistry {\n    const ids = new Set<string>();\n    plugins.forEach((plugin) => {\n        if (ids.has(plugin.id)) {\n            throw new Error(`Two plugins have the id \\`${plugin.id}\\`.`);\n        }\n        ids.add(plugin.id);\n    });\n    const components = Object.fromEntries(\n        COMPONENT_KINDS.map((kind) => [\n            kind,\n            new Map(plugins.flatMap((plugin) => Object.entries(plugin[kind] ?? {}))),\n        ]),\n    ) as Record<PluginComponentKind, Map<string, PluginComponent>>;\n    const locales = new Map<string, MessagesLoader[]>();\n    plugins.forEach((plugin) =>\n        Object.entries(plugin.locales ?? {}).forEach(([locale, loader]) => {\n            locales.set(locale, [...(locales.get(locale) ?? []), loader]);\n        }),\n    );\n    return {\n        plugins: [...plugins],\n        ...components,\n        locales,\n        themes: new Map(plugins.flatMap((plugin) => Object.entries(plugin.themes ?? {}))),\n    };\n}\n\n/**\n * Loads the messages of a locale from every plugin that provides it, merged in plugin order. A\n * regional locale (`fr-CA`) falls back to its language (`fr`) for missing messages.\n */\nexport async function loadMessages(registry: PluginRegistry, locale: string): Promise<Messages> {\n    const language = locale.split('-')[0] ?? locale;\n    const loaders = [\n        ...(language !== locale ? (registry.locales.get(language) ?? []) : []),\n        ...(registry.locales.get(locale) ?? []),\n    ];\n    const loaded = await Promise.all(\n        loaders.map(async (loader) => {\n            if (typeof loader !== 'function') {\n                return loader;\n            }\n            const result = await loader();\n            return 'default' in result && typeof result.default === 'object'\n                ? (result.default as Messages)\n                : (result as Messages);\n        }),\n    );\n    return Object.assign({}, ...loaded) as Messages;\n}\n"],"mappings":";AAoDA,IAAM,kBAAyC;CAC3C;CACA;CACA;CACA;CACA;CACA;CACA;AAAY;;AAoBhB,SAAgB,aAAa,QAAsC;CAC/D,OAAO;AACX;;;;;AAMA,SAAgB,qBAAqB,SAAmD;CACpF,MAAM,sBAAM,IAAI,IAAY;CAC5B,QAAQ,SAAS,WAAW;EACxB,IAAI,IAAI,IAAI,OAAO,EAAE,GACjB,MAAM,IAAI,MAAM,6BAA6B,OAAO,GAAE,IAAK;EAE/D,IAAI,IAAI,OAAO,EAAE;CACrB,CAAC;CACD,MAAM,aAAa,OAAO,YACtB,gBAAgB,KAAK,SAAS,CAC1B,MACA,IAAI,IAAI,QAAQ,SAAS,WAAW,OAAO,QAAQ,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAC3E,CACL;CACA,MAAM,0BAAU,IAAI,IAA8B;CAClD,QAAQ,SAAS,WACb,OAAO,QAAQ,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,YAAY;EAC/D,QAAQ,IAAI,QAAQ,CAAC,GAAI,QAAQ,IAAI,MAAM,KAAK,CAAA,GAAK,MAAM,CAAC;CAChE,CAAC,CACL;CACA,OAAO;EACH,SAAS,CAAC,GAAG,OAAO;EACpB,GAAG;EACH;EACA,QAAQ,IAAI,IAAI,QAAQ,SAAS,WAAW,OAAO,QAAQ,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC;CACpF;AACJ;;;;;AAMA,eAAsB,aAAa,UAA0B,QAAmC;CAC5F,MAAM,WAAW,OAAO,MAAM,GAAG,CAAC,CAAC,MAAM;CACzC,MAAM,UAAU,CACZ,GAAI,aAAa,SAAU,SAAS,QAAQ,IAAI,QAAQ,KAAK,CAAA,IAAM,CAAA,GACnE,GAAI,SAAS,QAAQ,IAAI,MAAM,KAAK,CAAA,CAAG;CAE3C,MAAM,SAAS,MAAM,QAAQ,IACzB,QAAQ,IAAI,OAAO,WAAW;EAC1B,IAAI,OAAO,WAAW,YAClB,OAAO;EAEX,MAAM,SAAS,MAAM,OAAO;EAC5B,OAAO,aAAa,UAAU,OAAO,OAAO,YAAY,WACjD,OAAO,UACP;CACX,CAAC,CACL;CACA,OAAO,OAAO,OAAO,CAAC,GAAG,GAAG,MAAM;AACtC"}

package/dist/react/provider.d.ts

@@ -0,0 +1,38 @@
+import { type ReactNode } from 'react';
+import type { Definition } from '@panneau/protocol';
+import { type ResolveFormOptions } from '../definition/form';
+import { type ResolvedResource } from '../definition/resource';
+import type { Router } from '../list/router';
+import { type PanneauPlugin, type PluginRegistry } from '../plugins';
+/** What `PanneauProvider` gives to the hooks below it. */
+export interface PanneauContextValue {
+    plugins: PluginRegistry;
+    /** The plugins as passed, including those of parent providers. */
+    pluginList: readonly PanneauPlugin[];
+    definition: Definition | null;
+    router: Router | null;
+}
+export interface PanneauProviderProps {
+    /** Plugins, added after those of a parent provider (so they override them). */
+    plugins?: readonly PanneauPlugin[];
+    /** The definition, for `useResource()`. Defaults to the parent provider's. */
+    definition?: Definition | null;
+    /** The router that lists keep their query in. Defaults to the parent provider's. */
+    router?: Router | null;
+    children?: ReactNode;
+}
+/**
+ * Provides plugins, the definition and the router to the hooks of `@panneau/core`. Providers can
+ * be nested: a nested provider adds its plugins to those of its parent.
+ */
+export declare function PanneauProvider({ plugins, definition, router, children, }: PanneauProviderProps): import("react").JSX.Element;
+/** The context of the closest `PanneauProvider`, or an empty one without a provider. */
+export declare function usePanneau(): PanneauContextValue;
+/** The plugins of the closest `PanneauProvider`, merged. */
+export declare function usePlugins(): PluginRegistry;
+/**
+ * A resource of the definition, with its form, list and abilities resolved. Throws when there is
+ * no definition or no such resource.
+ */
+export declare function useResource(id: string, formOptions?: ResolveFormOptions): ResolvedResource;
+//# sourceMappingURL=provider.d.ts.map

package/dist/react/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/react/provider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAsB,MAAM,OAAO,CAAC;AAE3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,KAAK,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,wBAAwB,CAAC;AAC9F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,cAAc,EAAwB,MAAM,YAAY,CAAC;AAE3F,0DAA0D;AAC1D,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,cAAc,CAAC;IACxB,kEAAkE;IAClE,UAAU,EAAE,SAAS,aAAa,EAAE,CAAC;IACrC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAID,MAAM,WAAW,oBAAoB;IACjC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC;IACnC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAC;IAC/B,oFAAoF;IACpF,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACxB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,EAC5B,OAAY,EACZ,UAAU,EACV,MAAM,EACN,QAAQ,GACX,EAAE,oBAAoB,+BAUtB;AASD,wFAAwF;AACxF,wBAAgB,UAAU,IAAI,mBAAmB,CAEhD;AAED,4DAA4D;AAC5D,wBAAgB,UAAU,IAAI,cAAc,CAE3C;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,kBAAkB,GAAG,gBAAgB,CAU1F"}

package/dist/react/provider.js

@@ -0,0 +1,63 @@
+import { findResource, resolveResource } from "../definition/resource.js";
+import { createPluginRegistry } from "../plugins.js";
+import { c } from "react/compiler-runtime";
+import { createContext, use } from "react";
+import { jsx } from "react/jsx-runtime";
+//#region src/react/provider.tsx
+var PanneauContext = createContext(null);
+/**
+* Provides plugins, the definition and the router to the hooks of `@panneau/core`. Providers can
+* be nested: a nested provider adds its plugins to those of its parent.
+*/
+function PanneauProvider({ plugins = [], definition, router, children }) {
+	const parent = use(PanneauContext);
+	const pluginList = [...parent?.pluginList ?? [], ...plugins];
+	const value = {
+		plugins: createPluginRegistry(pluginList),
+		pluginList,
+		definition: definition === void 0 ? parent?.definition ?? null : definition,
+		router: router === void 0 ? parent?.router ?? null : router
+	};
+	return /* @__PURE__ */ jsx(PanneauContext, {
+		value,
+		children
+	});
+}
+var EMPTY = {
+	plugins: createPluginRegistry([]),
+	pluginList: [],
+	definition: null,
+	router: null
+};
+/** The context of the closest `PanneauProvider`, or an empty one without a provider. */
+function usePanneau() {
+	return use(PanneauContext) ?? EMPTY;
+}
+/** The plugins of the closest `PanneauProvider`, merged. */
+function usePlugins() {
+	return usePanneau().plugins;
+}
+/**
+* A resource of the definition, with its form, list and abilities resolved. Throws when there is
+* no definition or no such resource.
+*/
+function useResource(id, formOptions) {
+	const $ = c(4);
+	const { definition } = usePanneau();
+	if (definition === null) throw new Error("useResource() needs a definition: pass one to <PanneauProvider>.");
+	let t0;
+	if ($[0] !== definition || $[1] !== formOptions || $[2] !== id) {
+		const resource = findResource(definition, id);
+		if (resource === void 0) throw new Error(`The definition has no resource \`${id}\`.`);
+		t0 = resolveResource(resource, formOptions);
+		$[0] = definition;
+		$[1] = formOptions;
+		$[2] = id;
+		$[3] = t0;
+	} else t0 = $[3];
+	return t0;
+}
+//#endregion
+export { PanneauProvider, usePanneau, usePlugins, useResource };
+
+//# sourceMappingURL=provider.js.map

package/dist/react/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","names":["_c"],"sources":["../../src/react/provider.tsx"],"sourcesContent":["import { type ReactNode, createContext, use } from 'react';\n\nimport type { Definition } from '@panneau/protocol';\n\nimport { type ResolveFormOptions } from '../definition/form';\nimport { type ResolvedResource, findResource, resolveResource } from '../definition/resource';\nimport type { Router } from '../list/router';\nimport { type PanneauPlugin, type PluginRegistry, createPluginRegistry } from '../plugins';\n\n/** What `PanneauProvider` gives to the hooks below it. */\nexport interface PanneauContextValue {\n    plugins: PluginRegistry;\n    /** The plugins as passed, including those of parent providers. */\n    pluginList: readonly PanneauPlugin[];\n    definition: Definition | null;\n    router: Router | null;\n}\n\nconst PanneauContext = createContext<PanneauContextValue | null>(null);\n\nexport interface PanneauProviderProps {\n    /** Plugins, added after those of a parent provider (so they override them). */\n    plugins?: readonly PanneauPlugin[];\n    /** The definition, for `useResource()`. Defaults to the parent provider's. */\n    definition?: Definition | null;\n    /** The router that lists keep their query in. Defaults to the parent provider's. */\n    router?: Router | null;\n    children?: ReactNode;\n}\n\n/**\n * Provides plugins, the definition and the router to the hooks of `@panneau/core`. Providers can\n * be nested: a nested provider adds its plugins to those of its parent.\n */\nexport function PanneauProvider({\n    plugins = [],\n    definition,\n    router,\n    children,\n}: PanneauProviderProps) {\n    const parent = use(PanneauContext);\n    const pluginList = [...(parent?.pluginList ?? []), ...plugins];\n    const value: PanneauContextValue = {\n        plugins: createPluginRegistry(pluginList),\n        pluginList,\n        definition: definition === undefined ? (parent?.definition ?? null) : definition,\n        router: router === undefined ? (parent?.router ?? null) : router,\n    };\n    return <PanneauContext value={value}>{children}</PanneauContext>;\n}\n\nconst EMPTY: PanneauContextValue = {\n    plugins: createPluginRegistry([]),\n    pluginList: [],\n    definition: null,\n    router: null,\n};\n\n/** The context of the closest `PanneauProvider`, or an empty one without a provider. */\nexport function usePanneau(): PanneauContextValue {\n    return use(PanneauContext) ?? EMPTY;\n}\n\n/** The plugins of the closest `PanneauProvider`, merged. */\nexport function usePlugins(): PluginRegistry {\n    return usePanneau().plugins;\n}\n\n/**\n * A resource of the definition, with its form, list and abilities resolved. Throws when there is\n * no definition or no such resource.\n */\nexport function useResource(id: string, formOptions?: ResolveFormOptions): ResolvedResource {\n    const { definition } = usePanneau();\n    if (definition === null) {\n        throw new Error('useResource() needs a definition: pass one to <PanneauProvider>.');\n    }\n    const resource = findResource(definition, id);\n    if (resource === undefined) {\n        throw new Error(`The definition has no resource \\`${id}\\`.`);\n    }\n    return resolveResource(resource, formOptions);\n}\n"],"mappings":";;;;;;AAkBA,IAAM,iBAAiB,cAA0C,IAAI;;;;;AAgBrE,SAAgB,gBAAgB,EAC5B,UAAU,CAAA,GACV,YACA,QACA,YACqB;CACrB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,aAAa,CAAC,GAAI,QAAQ,cAAc,CAAA,GAAK,GAAG,OAAO;CAC7D,MAAM,QAA6B;EAC/B,SAAS,qBAAqB,UAAU;EACxC;EACA,YAAY,eAAe,KAAA,IAAa,QAAQ,cAAc,OAAQ;EACtE,QAAQ,WAAW,KAAA,IAAa,QAAQ,UAAU,OAAQ;CAC9D;CACA,OAAO,oBAAC,gBAAD;EAAuB;EAAQ;CAAyB,CAAA;AACnE;AAEA,IAAM,QAA6B;CAC/B,SAAS,qBAAqB,CAAA,CAAE;CAChC,YAAY,CAAA;CACZ,YAAY;CACZ,QAAQ;AACZ;;AAGA,SAAgB,aAAkC;CAC9C,OAAO,IAAI,cAAc,KAAK;AAClC;;AAGA,SAAO,aAAA;CAAA,OACI,WAAW,CAAC,CAAA;AAAQ;;;;;AAO/B,SAAO,YAAA,IAAA,aAAA;CAAA,MAAA,IAAAA,EAAA,CAAA;CACH,MAAA,EAAA,eAAuB,WAAW;CAClC,IAAI,eAAe,MACf,MAAM,IAAI,MAAM,kEAAkE;CACrF,IAAA;CAAA,IAAA,EAAA,OAAA,cAAA,EAAA,OAAA,eAAA,EAAA,OAAA,IAAA;EACD,MAAA,WAAiB,aAAa,YAAY,EAAE;EAC5C,IAAI,aAAa,KAAA,GACb,MAAM,IAAI,MAAM,oCAAoC,GAAE,IAAK;EAExD,KAAA,gBAAgB,UAAU,WAAW;EAAC,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;EAAA,EAAA,KAAA;CAAA,OAAA,KAAA,EAAA;CAAA,OAAtC;AAAsC"}

package/dist/react/useForm.d.ts

@@ -0,0 +1,26 @@
+import { type Form, type FormOptions, type FormState } from '../form/form';
+export interface UseFormResult extends FormState {
+    /** The form, to change values, submit, reset or resolve a conflict. */
+    form: Form;
+}
+/**
+ * Creates a form for the life of the component. `fields`, `locales`, `formatError` and `onSubmit`
+ * follow the latest render; initial values and the version don't: call `form.reset()`, or give
+ * the component a new `key`, to start from another item.
+ *
+ * Read the returned state with the selectors (`selectErrors(state, path)`,
+ * `selectVisible(state, field)`…), not with the form's reading methods, which go stale with the
+ * React Compiler (see {@link Form}).
+ */
+export declare function useForm(options: FormOptions): UseFormResult;
+export interface UseFormFieldResult {
+    value: unknown;
+    onChange: (value: unknown) => void;
+    onBlur: () => void;
+    /** Errors at the path, and at nested paths (`title.fr` for `title`). */
+    errors: string[];
+    touched: boolean;
+}
+/** Props for a controlled field at a dot path of a form. */
+export declare function useFormField(form: Form, path: string): UseFormFieldResult;
+//# sourceMappingURL=useForm.d.ts.map

package/dist/react/useForm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../src/react/useForm.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAc,MAAM,cAAc,CAAC;AAGvF,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC5C,uEAAuE;IACvE,IAAI,EAAE,IAAI,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,CAQ3D;AAED,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,wEAAwE;IACxE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,4DAA4D;AAC5D,wBAAgB,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,kBAAkB,CASzE"}