@rsc-kit/press 0.0.0-stage → 0.30.43

package/dist/memory.js

@@ -0,0 +1,50 @@
+/**
+ * Rows held in memory, searched, filtered, sorted and paged the way a database
+ * adapter would. For a prototype, a demo or a test: the rows last as long as
+ * the process.
+ */
+export function memorySource(rows, key, make) {
+    let next = rows.length + 1;
+    const get = (row, name) => row[name];
+    const at = (id) => rows.findIndex((row) => String(get(row, key)) === id);
+    return {
+        async list({ q, sort, dir, page, perPage, filters, searchable }) {
+            let found = rows.filter((row) => Object.entries(filters).every(([name, value]) => String(get(row, name)) === value));
+            if (q) {
+                const needle = q.toLowerCase();
+                found = found.filter((row) => searchable.some((name) => String(get(row, name) ?? '').toLowerCase().includes(needle)));
+            }
+            if (sort) {
+                found = [...found].sort((a, b) => {
+                    const [x, y] = [get(a, sort), get(b, sort)];
+                    const order = typeof x === 'number' && typeof y === 'number' ? x - y : String(x ?? '').localeCompare(String(y ?? ''));
+                    return dir === 'desc' ? -order : order;
+                });
+            }
+            if (perPage === null)
+                return { rows: found, total: found.length };
+            return { rows: found.slice((page - 1) * perPage, page * perPage), total: found.length };
+        },
+        async find(id) {
+            return rows[at(id)] ?? null;
+        },
+        async create(values) {
+            const row = make(next++, values);
+            rows.push(row);
+            return row;
+        },
+        async update(id, values) {
+            const index = at(id);
+            if (index === -1)
+                throw new Error(`[admin] no row ${id} to update`);
+            rows[index] = { ...rows[index], ...values };
+            return rows[index];
+        },
+        async delete(id) {
+            const index = at(id);
+            if (index !== -1)
+                rows.splice(index, 1);
+        },
+    };
+}
+//# sourceMappingURL=memory.js.map

package/dist/memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","sourceRoot":"","sources":["../src/memory.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAW,EACX,GAAuB,EACvB,IAAyC;IAEzC,IAAI,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAA;IAC1B,MAAM,GAAG,GAAG,CAAC,GAAQ,EAAE,IAAY,EAAE,EAAE,CAAE,GAA+B,CAAC,IAAI,CAAC,CAAA;IAC9E,MAAM,EAAE,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAA;IAEhF,OAAO;QACL,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE;YAC7D,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAA;YAEpH,IAAI,CAAC,EAAE,CAAC;gBACN,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,EAAE,CAAA;gBAE9B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YACvH,CAAC;YAED,IAAI,IAAI,EAAE,CAAC;gBACT,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC/B,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;oBAC3C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;oBAErH,OAAO,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;gBACxC,CAAC,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,OAAO,KAAK,IAAI;gBAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;YAEjE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;QACzF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE;YACX,OAAO,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAA;QAC7B,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,MAAM;YACjB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAA;YAEhC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAEd,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM;YACrB,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;YAEpB,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAA;YAEnE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAE,EAAE,GAAG,MAAM,EAAE,CAAA;YAE5C,OAAO,IAAI,CAAC,KAAK,CAAE,CAAA;QACrB,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,EAAE;YACb,MAAM,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;YAEpB,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACzC,CAAC;KACF,CAAA;AACH,CAAC","sourcesContent":["import type { DataSource } from './resource.js'\n\n/**\n * Rows held in memory, searched, filtered, sorted and paged the way a database\n * adapter would. For a prototype, a demo or a test: the rows last as long as\n * the process.\n */\nexport function memorySource<Row extends object, Values>(\n  rows: Row[],\n  key: keyof Row & string,\n  make: (id: number, values: Values) => Row,\n): DataSource<Row, Values> {\n  let next = rows.length + 1\n  const get = (row: Row, name: string) => (row as Record<string, unknown>)[name]\n  const at = (id: string) => rows.findIndex((row) => String(get(row, key)) === id)\n\n  return {\n    async list({ q, sort, dir, page, perPage, filters, searchable }) {\n      let found = rows.filter((row) => Object.entries(filters).every(([name, value]) => String(get(row, name)) === value))\n\n      if (q) {\n        const needle = q.toLowerCase()\n\n        found = found.filter((row) => searchable.some((name) => String(get(row, name) ?? '').toLowerCase().includes(needle)))\n      }\n\n      if (sort) {\n        found = [...found].sort((a, b) => {\n          const [x, y] = [get(a, sort), get(b, sort)]\n          const order = typeof x === 'number' && typeof y === 'number' ? x - y : String(x ?? '').localeCompare(String(y ?? ''))\n\n          return dir === 'desc' ? -order : order\n        })\n      }\n\n      if (perPage === null) return { rows: found, total: found.length }\n\n      return { rows: found.slice((page - 1) * perPage, page * perPage), total: found.length }\n    },\n    async find(id) {\n      return rows[at(id)] ?? null\n    },\n    async create(values) {\n      const row = make(next++, values)\n\n      rows.push(row)\n\n      return row\n    },\n    async update(id, values) {\n      const index = at(id)\n\n      if (index === -1) throw new Error(`[admin] no row ${id} to update`)\n\n      rows[index] = { ...rows[index]!, ...values }\n\n      return rows[index]!\n    },\n    async delete(id) {\n      const index = at(id)\n\n      if (index !== -1) rows.splice(index, 1)\n    },\n  }\n}\n"]}

package/dist/pages/index.d.ts

@@ -0,0 +1,2 @@
+export { definePages } from './pages.js';
+export type { PageRow, PageValues, Pages, PagesDefinition } from './pages.js';

package/dist/pages/index.js

@@ -0,0 +1,2 @@
+export { definePages } from './pages.js';
+//# sourceMappingURL=index.js.map

package/dist/pages/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA","sourcesContent":["export { definePages } from './pages.js'\nexport type { PageRow, PageValues, Pages, PagesDefinition } from './pages.js'\n"]}

package/dist/pages/pages.d.ts

@@ -0,0 +1,78 @@
+import type { ComponentType, ReactNode } from 'react';
+import type { GenerateMetadata } from '@rsc-kit/core/metadata';
+import type { StandardSchemaV1 } from '@rsc-kit/core/standardSchema';
+import type { Block, BlockValue } from '../blocks.js';
+import type { DataSource } from '../resource.js';
+/** A page as it is stored. */
+export interface PageRow {
+    id: string | number;
+    title: string;
+    /** Its address without the leading slash: about, pricing/teams. */
+    slug: string;
+    description?: string;
+    published: boolean;
+    blocks: BlockValue[];
+}
+/** What an editor saves. */
+export type PageValues = Omit<PageRow, 'id'>;
+export interface PagesDefinition {
+    /** The resource's name in the panel, and its url segment there. pages by default. */
+    name?: string;
+    /** The kinds of block a page is built from, in the order an editor is offered them. */
+    blocks: Block<any>[];
+    /**
+     * Where pages are kept. Its list() is also how a page is found by its
+     * address: it is asked for filters: { slug }, and must honour it.
+     */
+    source: DataSource<PageRow, PageValues>;
+    /** The slug served at the catch-all's root - the site's home page. home by default. */
+    home?: string;
+    /** The sidebar's icon in the panel. */
+    icon?: ComponentType;
+    /** What shows while a page is looked up. Nothing by default. */
+    fallback?: ReactNode;
+    /**
+     * Seconds a page, once looked up, is served without asking the source
+     * again: 60 by default, false to ask on every request. A save in the panel
+     * is live on the next visit either way; this bounds a change made around
+     * the panel - straight in the database - and one made on another instance
+     * when versions are not shared.
+     */
+    revalidate?: number | false;
+}
+/**
+ * Pages an editor builds in the panel from the app's blocks - a landing
+ * page, an about page, a pricing page - served by one catch-all route:
+ *
+ *     // src/app/[...path]/page.tsx
+ *     export default site.Page
+ *     export const generateMetadata = site.generateMetadata
+ *
+ *     // src/app/[...path]/middleware.ts
+ *     export default site.middleware
+ *
+ *     // the panel
+ *     resources: [site.resource, ...]
+ *
+ * A page is looked up once and kept for `revalidate` seconds (60), in the
+ * store installCacheStore() names - memory unless the app says otherwise. A
+ * save in the panel is live on the next visit all the same; nothing is
+ * rebuilt.
+ */
+export declare function definePages(definition: PagesDefinition): {
+    resource: import("../resource.js").Resource<PageRow, StandardSchemaV1<Record<string, unknown>, PageValues> & {
+        '~standard': {
+            jsonSchema: {
+                input: () => unknown;
+            };
+        };
+    }>;
+    Page: ({ params }: {
+        params: Promise<Record<string, string | undefined>>;
+    }) => import("react").JSX.Element;
+    generateMetadata: GenerateMetadata<Record<string, string | undefined>>;
+    middleware: (params: Record<string, string | undefined>) => Promise<void>;
+    find: (path: string) => Promise<PageRow | null>;
+    blocks: Block<any>[];
+};
+export type Pages = ReturnType<typeof definePages>;

package/dist/pages/pages.js

@@ -0,0 +1,183 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { Suspense } from 'react';
+import { cache } from '@rsc-kit/core/cache';
+import { fieldErrors } from '@rsc-kit/core/action';
+import { changed } from '@rsc-kit/core/changed';
+import { notFound } from '@rsc-kit/core/not-found';
+import { Blocks } from '../blocks.js';
+import { defineResource } from '../resource.js';
+const SLUG = /^[a-z0-9-]+(\/[a-z0-9-]+)*$/;
+const issue = (field, message) => ({ message, path: [field] });
+/**
+ * A page's schema, written out rather than taken from a validation library,
+ * which press does not depend on. It says what it is as JSON Schema too, so
+ * the form gets the same browser checks a zod schema's would.
+ */
+const pageSchema = {
+    '~standard': {
+        version: 1,
+        vendor: '@rsc-kit/press',
+        validate(input) {
+            const value = (input ?? {});
+            const issues = [];
+            const title = typeof value.title === 'string' ? value.title.trim() : '';
+            const slug = typeof value.slug === 'string' ? value.slug : '';
+            const description = typeof value.description === 'string' ? value.description : undefined;
+            if (title === '')
+                issues.push(issue('title', 'A page needs a title.'));
+            else if (title.length > 200)
+                issues.push(issue('title', 'Keep the title under 200 characters.'));
+            if (!SLUG.test(slug))
+                issues.push(issue('slug', 'Lowercase letters, digits and dashes, with / between parts: pricing/teams.'));
+            if (description !== undefined && description.length > 300)
+                issues.push(issue('description', 'Keep the description under 300 characters.'));
+            if (!Array.isArray(value.blocks))
+                issues.push(issue('blocks', 'A page is a list of blocks.'));
+            if (issues.length > 0)
+                return { issues };
+            return {
+                value: {
+                    title,
+                    slug,
+                    ...(description ? { description } : {}),
+                    published: value.published === true,
+                    blocks: value.blocks,
+                },
+            };
+        },
+        jsonSchema: {
+            input: () => ({
+                type: 'object',
+                properties: {
+                    title: { type: 'string', minLength: 1, maxLength: 200 },
+                    slug: { type: 'string', pattern: SLUG.source },
+                    description: { type: 'string', maxLength: 300 },
+                    published: { type: 'boolean' },
+                    blocks: { type: 'array' },
+                },
+                required: ['title', 'slug', 'published', 'blocks'],
+            }),
+        },
+    },
+};
+/**
+ * Pages an editor builds in the panel from the app's blocks - a landing
+ * page, an about page, a pricing page - served by one catch-all route:
+ *
+ *     // src/app/[...path]/page.tsx
+ *     export default site.Page
+ *     export const generateMetadata = site.generateMetadata
+ *
+ *     // src/app/[...path]/middleware.ts
+ *     export default site.middleware
+ *
+ *     // the panel
+ *     resources: [site.resource, ...]
+ *
+ * A page is looked up once and kept for `revalidate` seconds (60), in the
+ * store installCacheStore() names - memory unless the app says otherwise. A
+ * save in the panel is live on the next visit all the same; nothing is
+ * rebuilt.
+ */
+export function definePages(definition) {
+    const home = definition.home ?? 'home';
+    const blocks = definition.blocks;
+    const source = definition.source;
+    const everywhere = { tenant: null };
+    if (!SLUG.test(home))
+        throw new Error(`[press] home is a slug: ${JSON.stringify(home)}`);
+    for (const [index, block] of blocks.entries()) {
+        if (blocks.findIndex((candidate) => candidate.name === block.name) !== index)
+            throw new Error(`[press] two blocks are named ${block.name}`);
+    }
+    const bySlug = async (slug) => (await source.list({ dir: 'asc', page: 1, perPage: 1, filters: { slug }, searchable: [] }, everywhere)).rows.find((row) => row.slug === slug) ?? null;
+    // An address is one page's. Checked here, so a memory or rpc source need
+    // not, and refused under the field like the schema's own refusals.
+    const unique = async (slug, id) => {
+        const taken = await bySlug(slug);
+        if (taken && String(taken.id) !== id)
+            fieldErrors({ slug: `${taken.title} is already at /${slug}.` });
+    };
+    const name = definition.name ?? 'pages';
+    // One name for every page: a save can move a page's address or unpublish
+    // it, so it is not only its own lookup that goes stale.
+    const tag = `press:${name}`;
+    /** Run a write, then say pages changed, so the next lookup asks the source. */
+    const saving = async (write) => {
+        const done = await write;
+        await changed(tag);
+        return done;
+    };
+    const guarded = {
+        list: (query, context) => source.list(query, context),
+        find: (id, context) => source.find(id, context),
+        create: async (values, context) => {
+            await unique(values.slug, null);
+            return saving(source.create(values, context));
+        },
+        update: async (id, values, context) => {
+            await unique(values.slug, id);
+            return saving(source.update(id, values, context));
+        },
+        delete: (id, context) => saving(source.delete(id, context)),
+    };
+    const resource = defineResource()({
+        name,
+        key: 'id',
+        title: 'title',
+        ...(definition.icon ? { icon: definition.icon } : {}),
+        description: 'Built from blocks, and live at their address once published.',
+        source: guarded,
+        table: (col) => [col.text('title').searchable().sortable(), col.text('slug').searchable().sortable(), col.boolean('published').sortable()],
+        form: pageSchema,
+        fields: {
+            slug: { description: `Its address, without the leading slash. ${home} is the home page.` },
+            description: { type: 'textarea', description: 'For search engines and link previews.' },
+            blocks: { label: 'Content', blocks },
+        },
+    });
+    const lookup = async (path) => {
+        // The home page lives at the root, not also at /home.
+        if (path === home)
+            return null;
+        const page = await bySlug(path === '' ? home : path);
+        return page?.published ? page : null;
+    };
+    const revalidate = definition.revalidate ?? 60;
+    if (revalidate !== false && !(revalidate > 0))
+        throw new Error(`[press] revalidate is seconds above 0, or false: ${revalidate}`);
+    /**
+     * The page at a catch-all's path, published, or null. Once per request
+     * however many ask, and kept between requests for `revalidate` seconds or
+     * until a page is saved - so a visit does not ask the source at all.
+     */
+    const find = revalidate === false ? cache(lookup) : cache(lookup, { key: `press.pages.${name}`, revalidate, tags: [tag] });
+    const pathOf = async (params) => String(Object.values(await params)[0] ?? '');
+    async function Content({ params }) {
+        const page = await find(await pathOf(params));
+        if (!page)
+            notFound();
+        return _jsx(Blocks, { blocks: blocks, value: page.blocks });
+    }
+    /** The catch-all route's page. Its param may have any name. */
+    function Page({ params }) {
+        return (_jsx(Suspense, { fallback: definition.fallback ?? null, children: _jsx(Content, { params: params }) }));
+    }
+    /**
+     * The same lookup before anything is sent, so an address with no page is
+     * a real 404. The page's own notFound() is under the shell, which a stored
+     * route sends with a 200 before the lookup has answered.
+     */
+    async function middleware(params) {
+        if (!(await find(String(Object.values(params ?? {})[0] ?? ''))))
+            notFound();
+    }
+    const generateMetadata = async ({ params }) => {
+        const page = await find(await pathOf(params));
+        if (!page)
+            return {};
+        return { title: page.title, ...(page.description ? { description: page.description } : {}) };
+    };
+    return { resource, Page, generateMetadata, middleware, find, blocks };
+}
+//# sourceMappingURL=pages.js.map

package/dist/pages/pages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pages.js","sourceRoot":"","sources":["../../src/pages/pages.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAChC,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAE3C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAE/C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AAElD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AA2C/C,MAAM,IAAI,GAAG,6BAA6B,CAAA;AAI1C,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,OAAe,EAAS,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAErF;;;;GAIG;AACH,MAAM,UAAU,GAEZ;IACF,WAAW,EAAE;QACX,OAAO,EAAE,CAAC;QACV,MAAM,EAAE,gBAAgB;QACxB,QAAQ,CAAC,KAAK;YACZ,MAAM,KAAK,GAAG,CAAC,KAAK,IAAI,EAAE,CAA4B,CAAA;YACtD,MAAM,MAAM,GAAY,EAAE,CAAA;YAC1B,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;YACvE,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;YAC7D,MAAM,WAAW,GAAG,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAA;YAEzF,IAAI,KAAK,KAAK,EAAE;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAA;iBACjE,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,sCAAsC,CAAC,CAAC,CAAA;YAChG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,4EAA4E,CAAC,CAAC,CAAA;YAC9H,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,GAAG,GAAG;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,4CAA4C,CAAC,CAAC,CAAA;YAC1I,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,6BAA6B,CAAC,CAAC,CAAA;YAE7F,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,CAAA;YAExC,OAAO;gBACL,KAAK,EAAE;oBACL,KAAK;oBACL,IAAI;oBACJ,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvC,SAAS,EAAE,KAAK,CAAC,SAAS,KAAK,IAAI;oBACnC,MAAM,EAAE,KAAK,CAAC,MAAsB;iBACrC;aACF,CAAA;QACH,CAAC;QACD,UAAU,EAAE;YACV,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;gBACZ,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;oBACvD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE;oBAC9C,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,EAAE;oBAC/C,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBAC9B,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;iBAC1B;gBACD,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC;aACnD,CAAC;SACH;KACF;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,WAAW,CAAC,UAA2B;IACrD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,MAAM,CAAA;IACtC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;IAChC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;IAChC,MAAM,UAAU,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;IAEnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAExF,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9C,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IAC7I,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAA2B,EAAE,CAC7D,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,CAAA;IAEvJ,yEAAyE;IACzE,mEAAmE;IACnE,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAAE,EAAiB,EAAE,EAAE;QACvD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,CAAA;QAEhC,IAAI,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE;YAAE,WAAW,CAAC,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,KAAK,mBAAmB,IAAI,GAAG,EAAE,CAAC,CAAA;IACvG,CAAC,CAAA;IAED,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,OAAO,CAAA;IACvC,yEAAyE;IACzE,wDAAwD;IACxD,MAAM,GAAG,GAAG,SAAS,IAAI,EAAE,CAAA;IAE3B,+EAA+E;IAC/E,MAAM,MAAM,GAAG,KAAK,EAAM,KAAiB,EAAc,EAAE;QACzD,MAAM,IAAI,GAAG,MAAM,KAAK,CAAA;QAExB,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;QAElB,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,MAAM,OAAO,GAAoC;QAC/C,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;QACrD,IAAI,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC;QAC/C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAChC,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YAE/B,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;QAC/C,CAAC;QACD,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YACpC,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;YAE7B,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;QACnD,CAAC;QACD,MAAM,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;KAC5D,CAAA;IAED,MAAM,QAAQ,GAAG,cAAc,EAAW,CAAC;QACzC,IAAI;QACJ,GAAG,EAAE,IAAI;QACT,KAAK,EAAE,OAAO;QACd,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,WAAW,EAAE,8DAA8D;QAC3E,MAAM,EAAE,OAAO;QACf,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1I,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE;YACN,IAAI,EAAE,EAAE,WAAW,EAAE,2CAA2C,IAAI,oBAAoB,EAAE;YAC1F,WAAW,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,uCAAuC,EAAE;YACvF,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE;SACrC;KACF,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAA2B,EAAE;QAC7D,sDAAsD;QACtD,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,IAAI,CAAA;QAE9B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAEpD,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IACtC,CAAC,CAAA;IAED,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAA;IAE9C,IAAI,UAAU,KAAK,KAAK,IAAI,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,UAAU,EAAE,CAAC,CAAA;IAEhI;;;;OAIG;IACH,MAAM,IAAI,GAAG,UAAU,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,eAAe,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAE1H,MAAM,MAAM,GAAG,KAAK,EAAE,MAAmD,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;IAE1H,KAAK,UAAU,OAAO,CAAC,EAAE,MAAM,EAA2D;QACxF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QAE7C,IAAI,CAAC,IAAI;YAAE,QAAQ,EAAE,CAAA;QAErB,OAAO,KAAC,MAAM,IAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,GAAI,CAAA;IACvD,CAAC;IAED,+DAA+D;IAC/D,SAAS,IAAI,CAAC,EAAE,MAAM,EAA2D;QAC/E,OAAO,CACL,KAAC,QAAQ,IAAC,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,IAAI,YAC7C,KAAC,OAAO,IAAC,MAAM,EAAE,MAAM,GAAI,GAClB,CACZ,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,UAAU,UAAU,CAAC,MAA0C;QAClE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAAE,QAAQ,EAAE,CAAA;IAC7E,CAAC;IAED,MAAM,gBAAgB,GAAyD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;QAClG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;QAE7C,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAA;QAEpB,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAqB,CAAA;IACjH,CAAC,CAAA;IAED,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;AACvE,CAAC","sourcesContent":["import { Suspense } from 'react'\nimport { cache } from '@rsc-kit/core/cache'\nimport type { ComponentType, ReactNode } from 'react'\nimport { fieldErrors } from '@rsc-kit/core/action'\nimport { changed } from '@rsc-kit/core/changed'\nimport type { GenerateMetadata, Metadata } from '@rsc-kit/core/metadata'\nimport { notFound } from '@rsc-kit/core/not-found'\nimport type { StandardSchemaV1 } from '@rsc-kit/core/standardSchema'\nimport { Blocks } from '../blocks.js'\nimport type { Block, BlockValue } from '../blocks.js'\nimport { defineResource } from '../resource.js'\nimport type { DataSource } from '../resource.js'\n\n/** A page as it is stored. */\nexport interface PageRow {\n  id: string | number\n  title: string\n  /** Its address without the leading slash: about, pricing/teams. */\n  slug: string\n  description?: string\n  published: boolean\n  blocks: BlockValue[]\n}\n\n/** What an editor saves. */\nexport type PageValues = Omit<PageRow, 'id'>\n\nexport interface PagesDefinition {\n  /** The resource's name in the panel, and its url segment there. pages by default. */\n  name?: string\n  /** The kinds of block a page is built from, in the order an editor is offered them. */\n  blocks: Block<any>[]\n  /**\n   * Where pages are kept. Its list() is also how a page is found by its\n   * address: it is asked for filters: { slug }, and must honour it.\n   */\n  source: DataSource<PageRow, PageValues>\n  /** The slug served at the catch-all's root - the site's home page. home by default. */\n  home?: string\n  /** The sidebar's icon in the panel. */\n  icon?: ComponentType\n  /** What shows while a page is looked up. Nothing by default. */\n  fallback?: ReactNode\n  /**\n   * Seconds a page, once looked up, is served without asking the source\n   * again: 60 by default, false to ask on every request. A save in the panel\n   * is live on the next visit either way; this bounds a change made around\n   * the panel - straight in the database - and one made on another instance\n   * when versions are not shared.\n   */\n  revalidate?: number | false\n}\n\nconst SLUG = /^[a-z0-9-]+(\\/[a-z0-9-]+)*$/\n\ntype Issue = { message: string; path: string[] }\n\nconst issue = (field: string, message: string): Issue => ({ message, path: [field] })\n\n/**\n * A page's schema, written out rather than taken from a validation library,\n * which press does not depend on. It says what it is as JSON Schema too, so\n * the form gets the same browser checks a zod schema's would.\n */\nconst pageSchema: StandardSchemaV1<Record<string, unknown>, PageValues> & {\n  '~standard': { jsonSchema: { input: () => unknown } }\n} = {\n  '~standard': {\n    version: 1,\n    vendor: '@rsc-kit/press',\n    validate(input) {\n      const value = (input ?? {}) as Record<string, unknown>\n      const issues: Issue[] = []\n      const title = typeof value.title === 'string' ? value.title.trim() : ''\n      const slug = typeof value.slug === 'string' ? value.slug : ''\n      const description = typeof value.description === 'string' ? value.description : undefined\n\n      if (title === '') issues.push(issue('title', 'A page needs a title.'))\n      else if (title.length > 200) issues.push(issue('title', 'Keep the title under 200 characters.'))\n      if (!SLUG.test(slug)) issues.push(issue('slug', 'Lowercase letters, digits and dashes, with / between parts: pricing/teams.'))\n      if (description !== undefined && description.length > 300) issues.push(issue('description', 'Keep the description under 300 characters.'))\n      if (!Array.isArray(value.blocks)) issues.push(issue('blocks', 'A page is a list of blocks.'))\n\n      if (issues.length > 0) return { issues }\n\n      return {\n        value: {\n          title,\n          slug,\n          ...(description ? { description } : {}),\n          published: value.published === true,\n          blocks: value.blocks as BlockValue[],\n        },\n      }\n    },\n    jsonSchema: {\n      input: () => ({\n        type: 'object',\n        properties: {\n          title: { type: 'string', minLength: 1, maxLength: 200 },\n          slug: { type: 'string', pattern: SLUG.source },\n          description: { type: 'string', maxLength: 300 },\n          published: { type: 'boolean' },\n          blocks: { type: 'array' },\n        },\n        required: ['title', 'slug', 'published', 'blocks'],\n      }),\n    },\n  },\n}\n\n/**\n * Pages an editor builds in the panel from the app's blocks - a landing\n * page, an about page, a pricing page - served by one catch-all route:\n *\n *     // src/app/[...path]/page.tsx\n *     export default site.Page\n *     export const generateMetadata = site.generateMetadata\n *\n *     // src/app/[...path]/middleware.ts\n *     export default site.middleware\n *\n *     // the panel\n *     resources: [site.resource, ...]\n *\n * A page is looked up once and kept for `revalidate` seconds (60), in the\n * store installCacheStore() names - memory unless the app says otherwise. A\n * save in the panel is live on the next visit all the same; nothing is\n * rebuilt.\n */\nexport function definePages(definition: PagesDefinition) {\n  const home = definition.home ?? 'home'\n  const blocks = definition.blocks\n  const source = definition.source\n  const everywhere = { tenant: null }\n\n  if (!SLUG.test(home)) throw new Error(`[press] home is a slug: ${JSON.stringify(home)}`)\n\n  for (const [index, block] of blocks.entries()) {\n    if (blocks.findIndex((candidate) => candidate.name === block.name) !== index) throw new Error(`[press] two blocks are named ${block.name}`)\n  }\n\n  const bySlug = async (slug: string): Promise<PageRow | null> =>\n    (await source.list({ dir: 'asc', page: 1, perPage: 1, filters: { slug }, searchable: [] }, everywhere)).rows.find((row) => row.slug === slug) ?? null\n\n  // An address is one page's. Checked here, so a memory or rpc source need\n  // not, and refused under the field like the schema's own refusals.\n  const unique = async (slug: string, id: string | null) => {\n    const taken = await bySlug(slug)\n\n    if (taken && String(taken.id) !== id) fieldErrors({ slug: `${taken.title} is already at /${slug}.` })\n  }\n\n  const name = definition.name ?? 'pages'\n  // One name for every page: a save can move a page's address or unpublish\n  // it, so it is not only its own lookup that goes stale.\n  const tag = `press:${name}`\n\n  /** Run a write, then say pages changed, so the next lookup asks the source. */\n  const saving = async <T,>(write: Promise<T>): Promise<T> => {\n    const done = await write\n\n    await changed(tag)\n\n    return done\n  }\n\n  const guarded: DataSource<PageRow, PageValues> = {\n    list: (query, context) => source.list(query, context),\n    find: (id, context) => source.find(id, context),\n    create: async (values, context) => {\n      await unique(values.slug, null)\n\n      return saving(source.create(values, context))\n    },\n    update: async (id, values, context) => {\n      await unique(values.slug, id)\n\n      return saving(source.update(id, values, context))\n    },\n    delete: (id, context) => saving(source.delete(id, context)),\n  }\n\n  const resource = defineResource<PageRow>()({\n    name,\n    key: 'id',\n    title: 'title',\n    ...(definition.icon ? { icon: definition.icon } : {}),\n    description: 'Built from blocks, and live at their address once published.',\n    source: guarded,\n    table: (col) => [col.text('title').searchable().sortable(), col.text('slug').searchable().sortable(), col.boolean('published').sortable()],\n    form: pageSchema,\n    fields: {\n      slug: { description: `Its address, without the leading slash. ${home} is the home page.` },\n      description: { type: 'textarea', description: 'For search engines and link previews.' },\n      blocks: { label: 'Content', blocks },\n    },\n  })\n\n  const lookup = async (path: string): Promise<PageRow | null> => {\n    // The home page lives at the root, not also at /home.\n    if (path === home) return null\n\n    const page = await bySlug(path === '' ? home : path)\n\n    return page?.published ? page : null\n  }\n\n  const revalidate = definition.revalidate ?? 60\n\n  if (revalidate !== false && !(revalidate > 0)) throw new Error(`[press] revalidate is seconds above 0, or false: ${revalidate}`)\n\n  /**\n   * The page at a catch-all's path, published, or null. Once per request\n   * however many ask, and kept between requests for `revalidate` seconds or\n   * until a page is saved - so a visit does not ask the source at all.\n   */\n  const find = revalidate === false ? cache(lookup) : cache(lookup, { key: `press.pages.${name}`, revalidate, tags: [tag] })\n\n  const pathOf = async (params: Promise<Record<string, string | undefined>>) => String(Object.values(await params)[0] ?? '')\n\n  async function Content({ params }: { params: Promise<Record<string, string | undefined>> }) {\n    const page = await find(await pathOf(params))\n\n    if (!page) notFound()\n\n    return <Blocks blocks={blocks} value={page.blocks} />\n  }\n\n  /** The catch-all route's page. Its param may have any name. */\n  function Page({ params }: { params: Promise<Record<string, string | undefined>> }) {\n    return (\n      <Suspense fallback={definition.fallback ?? null}>\n        <Content params={params} />\n      </Suspense>\n    )\n  }\n\n  /**\n   * The same lookup before anything is sent, so an address with no page is\n   * a real 404. The page's own notFound() is under the shell, which a stored\n   * route sends with a 200 before the lookup has answered.\n   */\n  async function middleware(params: Record<string, string | undefined>) {\n    if (!(await find(String(Object.values(params ?? {})[0] ?? '')))) notFound()\n  }\n\n  const generateMetadata: GenerateMetadata<Record<string, string | undefined>> = async ({ params }) => {\n    const page = await find(await pathOf(params))\n\n    if (!page) return {}\n\n    return { title: page.title, ...(page.description ? { description: page.description } : {}) } satisfies Metadata\n  }\n\n  return { resource, Page, generateMetadata, middleware, find, blocks }\n}\n\nexport type Pages = ReturnType<typeof definePages>\n"]}

package/dist/plugin.d.ts

@@ -0,0 +1,51 @@
+import type { ComponentType } from 'react';
+import type { Resource, Tenant } from './resource.js';
+/** What happened to a record, told to every plugin after it happened. */
+export interface RecordChange {
+    /** The panel's path: '/admin'. */
+    panel: string;
+    resource: string;
+    id: string;
+    change: 'created' | 'updated' | 'deleted';
+    /** What was saved, as the schema parsed it. Absent for a delete. */
+    values?: Record<string, unknown>;
+    /** Whose record it was, in a panel with tenants. */
+    tenant: Tenant | null;
+}
+export interface Widget {
+    title: string;
+    description?: string;
+    component: ComponentType<{
+        tenant: Tenant | null;
+    }>;
+}
+/**
+ * A plugin adds to a panel; it never changes the panel's own code. Everything
+ * here is what an app could write itself - a plugin is the same thing in a
+ * package, so it can be installed, versioned and sold.
+ */
+export interface PanelPlugin {
+    /** Unique within a panel; a package's name is a good one. */
+    name: string;
+    /** Resources the panel shows as if the app had defined them. */
+    resources?: Resource[];
+    /**
+     * Server components rendered on the dashboard, each in a card, after the
+     * counts. A widget is told the tenant, so it shows that tenant's numbers.
+     */
+    widgets?: Widget[];
+    /**
+     * Called after a save or a delete has succeeded. A plugin that throws is
+     * logged and does not undo the change or fail the request: the record is
+     * already written, and the person saving it is not the plugin's audience.
+     */
+    onChange?: (change: RecordChange) => void | Promise<void>;
+}
+/**
+ * Typed, and nothing more: a plugin is a plain object. Export a function that
+ * takes the plugin's options and returns one, so an app writes
+ * plugins: [auditLog({ keep: 500 })].
+ */
+export declare function definePlugin<Plugin extends PanelPlugin>(plugin: Plugin): Plugin;
+/** Every plugin's onChange, in the order the plugins were given. */
+export declare function tell(plugins: PanelPlugin[], change: RecordChange): Promise<void>;

package/dist/plugin.js

@@ -0,0 +1,20 @@
+/**
+ * Typed, and nothing more: a plugin is a plain object. Export a function that
+ * takes the plugin's options and returns one, so an app writes
+ * plugins: [auditLog({ keep: 500 })].
+ */
+export function definePlugin(plugin) {
+    return plugin;
+}
+/** Every plugin's onChange, in the order the plugins were given. */
+export async function tell(plugins, change) {
+    for (const plugin of plugins) {
+        try {
+            await plugin.onChange?.(change);
+        }
+        catch (error) {
+            console.error(`[admin] the plugin ${plugin.name} failed on ${change.change} of ${change.resource} ${change.id}`, error);
+        }
+    }
+}
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AA6CA;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAA6B,MAAc;IACrE,OAAO,MAAM,CAAA;AACf,CAAC;AAED,oEAAoE;AACpE,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAsB,EAAE,MAAoB;IACrE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAA;QACjC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,sBAAsB,MAAM,CAAC,IAAI,cAAc,MAAM,CAAC,MAAM,OAAO,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;QACzH,CAAC;IACH,CAAC;AACH,CAAC","sourcesContent":["import type { ComponentType } from 'react'\nimport type { Resource, Tenant } from './resource.js'\n\n/** What happened to a record, told to every plugin after it happened. */\nexport interface RecordChange {\n  /** The panel's path: '/admin'. */\n  panel: string\n  resource: string\n  id: string\n  change: 'created' | 'updated' | 'deleted'\n  /** What was saved, as the schema parsed it. Absent for a delete. */\n  values?: Record<string, unknown>\n  /** Whose record it was, in a panel with tenants. */\n  tenant: Tenant | null\n}\n\nexport interface Widget {\n  title: string\n  description?: string\n  component: ComponentType<{ tenant: Tenant | null }>\n}\n\n/**\n * A plugin adds to a panel; it never changes the panel's own code. Everything\n * here is what an app could write itself - a plugin is the same thing in a\n * package, so it can be installed, versioned and sold.\n */\nexport interface PanelPlugin {\n  /** Unique within a panel; a package's name is a good one. */\n  name: string\n  /** Resources the panel shows as if the app had defined them. */\n  resources?: Resource[]\n  /**\n   * Server components rendered on the dashboard, each in a card, after the\n   * counts. A widget is told the tenant, so it shows that tenant's numbers.\n   */\n  widgets?: Widget[]\n  /**\n   * Called after a save or a delete has succeeded. A plugin that throws is\n   * logged and does not undo the change or fail the request: the record is\n   * already written, and the person saving it is not the plugin's audience.\n   */\n  onChange?: (change: RecordChange) => void | Promise<void>\n}\n\n/**\n * Typed, and nothing more: a plugin is a plain object. Export a function that\n * takes the plugin's options and returns one, so an app writes\n * plugins: [auditLog({ keep: 500 })].\n */\nexport function definePlugin<Plugin extends PanelPlugin>(plugin: Plugin): Plugin {\n  return plugin\n}\n\n/** Every plugin's onChange, in the order the plugins were given. */\nexport async function tell(plugins: PanelPlugin[], change: RecordChange): Promise<void> {\n  for (const plugin of plugins) {\n    try {\n      await plugin.onChange?.(change)\n    } catch (error) {\n      console.error(`[admin] the plugin ${plugin.name} failed on ${change.change} of ${change.resource} ${change.id}`, error)\n    }\n  }\n}\n"]}