@next-buildr/payload 0.0.0-stage → 2.0.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/next/index.ts"],"names":[],"mappings":"AAEA,YAAY,EACV,mBAAmB,EACnB,SAAS,EACT,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACzD,YAAY,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EACL,aAAa,EACb,MAAM,EACN,SAAS,EACT,SAAS,EACT,OAAO,EACP,WAAW,GACZ,MAAM,WAAW,CAAC"}

package/dist/next/index.js

@@ -0,0 +1,4 @@
+export { getBuildrDocument, listPublishedSlugs } from './get-document.js';
+export { revalidateHooks } from './revalidate.js';
+export { alternatesOf, seoFromDocument } from './seo.js';
+export { collectionTag, docTag, globalTag, THEME_TAG, tagsFor, templateTag, } from './tags.js';

package/dist/next/next-helpers.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=next-helpers.test.d.ts.map

package/dist/next/next-helpers.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"next-helpers.test.d.ts","sourceRoot":"","sources":["../../src/next/next-helpers.test.ts"],"names":[],"mappings":""}

package/dist/next/next-helpers.test.js

@@ -0,0 +1,122 @@
+import { describe, expect, it } from 'vitest';
+import { alternatesOf, revalidateHooks, seoFromDocument, tagsFor } from './index.js';
+describe('tagsFor', () => {
+    it('lists every dependency of a page once, sorted', () => {
+        expect(tagsFor({
+            collection: 'posts',
+            id: 3,
+            layoutRef: 'buildr-templates:9',
+            collectionsUsed: ['posts', 'products'],
+            globals: ['site-settings'],
+        })).toEqual([
+            'buildr:col:posts',
+            'buildr:col:products',
+            'buildr:doc:posts:3',
+            'buildr:global:site-settings',
+            'buildr:template:9',
+            'buildr:theme',
+        ]);
+    });
+    it('tags an own layout as the document and needs no id for a slug lookup', () => {
+        expect(tagsFor({ collection: 'pages', layoutRef: 'pages:5' })).toEqual([
+            'buildr:col:pages',
+            'buildr:doc:pages:5',
+            'buildr:theme',
+        ]);
+        expect(tagsFor({ collection: 'pages', layoutRef: null })).toEqual([
+            'buildr:col:pages',
+            'buildr:theme',
+        ]);
+    });
+});
+describe('revalidateHooks', () => {
+    const run = () => {
+        const tags = [];
+        return { hooks: revalidateHooks((tag) => tags.push(tag)), tags };
+    };
+    const page = { collection: { slug: 'pages' } };
+    it('revalidates a published page and its collection', () => {
+        const { hooks, tags } = run();
+        hooks.collection.afterChange[0]({ ...page, doc: { id: 1, _status: 'published' } });
+        expect(tags).toEqual(['buildr:doc:pages:1', 'buildr:col:pages']);
+    });
+    it('revalidates an unpublish (it was published) but not a draft of a never-published page', () => {
+        const { hooks, tags } = run();
+        hooks.collection.afterChange[0]({
+            ...page,
+            doc: { id: 1, _status: 'draft' },
+            previousDoc: { id: 1, _status: 'published' },
+        });
+        expect(tags).toHaveLength(2);
+        tags.length = 0;
+        hooks.collection.afterChange[0]({
+            ...page,
+            doc: { id: 2, _status: 'draft' },
+            previousDoc: { id: 2, _status: 'draft' },
+        });
+        expect(tags).toEqual([]);
+    });
+    it('revalidates on delete, a global change and a template change (and the collection it targets)', () => {
+        const { hooks, tags } = run();
+        hooks.collection.afterDelete[0]({ ...page, doc: { id: 4 } });
+        hooks.global.afterChange[0]({ global: { slug: 'site-settings' } });
+        hooks.templates.afterChange[0]({
+            collection: { slug: 'buildr-templates' },
+            doc: { id: 8, targetCollection: 'pages', _status: 'published' },
+            previousDoc: { id: 8, targetCollection: 'posts' },
+        });
+        expect(tags).toEqual([
+            'buildr:doc:pages:4',
+            'buildr:col:pages',
+            'buildr:global:site-settings',
+            'buildr:template:8',
+            'buildr:col:pages',
+            'buildr:col:posts',
+        ]);
+    });
+});
+describe('seoFromDocument', () => {
+    it('maps plugin-seo fields and populated images', () => {
+        expect(seoFromDocument({
+            title: 'Doc',
+            excerpt: 'Short',
+            featuredImage: { url: '/f.png' },
+            meta: { title: 'SEO', description: 'Desc', image: { url: '/o.png' }, noIndex: true },
+        }, { locale: 'pl', draft: true })).toEqual({
+            title: 'Doc',
+            excerpt: 'Short',
+            featuredImage: '/f.png',
+            meta: { title: 'SEO', description: 'Desc', image: '/o.png', noIndex: true, canonical: null },
+            locale: 'pl',
+            draft: true,
+        });
+    });
+    it('ignores an image that is only an id and empty strings', () => {
+        const out = seoFromDocument({ title: '', featuredImage: 12, meta: { image: 3 } });
+        expect(out.title).toBeNull();
+        expect(out.featuredImage).toBeNull();
+        expect(out.meta?.image).toBeNull();
+    });
+});
+describe('alternatesOf', () => {
+    it('is empty without localization', async () => {
+        const payload = { config: { localization: false } };
+        expect(await alternatesOf({ payload, collection: 'pages', id: 1, path: () => '/x' })).toEqual({});
+    });
+    it('collects the path in every language that has the document', async () => {
+        const payload = {
+            config: { localization: { localeCodes: ['pl', 'en', 'de'] } },
+            findByID: async ({ locale }) => {
+                if (locale === 'de')
+                    throw new Error('missing');
+                return { slug: `slug-${locale}` };
+            },
+        };
+        expect(await alternatesOf({
+            payload,
+            collection: 'pages',
+            id: 1,
+            path: (doc, locale) => `/${locale}/${String(doc['slug'])}`,
+        })).toEqual({ pl: '/pl/slug-pl', en: '/en/slug-en' });
+    });
+});

package/dist/next/revalidate.d.ts

@@ -0,0 +1,44 @@
+/** Marks a tag stale. The default is `revalidateTag`; a test (or a host with its own cache) passes another. */
+export type Revalidate = (tag: string) => void;
+interface DocLike {
+    readonly id?: string | number;
+    readonly _status?: string;
+    readonly targetCollection?: string;
+}
+export interface HookArgs {
+    readonly doc: DocLike;
+    readonly previousDoc?: DocLike;
+    readonly collection: {
+        readonly slug: string;
+    };
+}
+export interface GlobalHookArgs {
+    readonly global: {
+        readonly slug: string;
+    };
+}
+export interface RevalidateHooks {
+    /** For a page collection: `hooks: { afterChange: [...], afterDelete: [...] }`. */
+    readonly collection: {
+        readonly afterChange: readonly [(args: HookArgs) => void];
+        readonly afterDelete: readonly [(args: HookArgs) => void];
+    };
+    /** For a global such as `site-settings`. */
+    readonly global: {
+        readonly afterChange: readonly [(args: GlobalHookArgs) => void];
+    };
+    /** For `buildr-templates`. */
+    readonly templates: {
+        readonly afterChange: readonly [(args: HookArgs) => void];
+        readonly afterDelete: readonly [(args: HookArgs) => void];
+    };
+}
+/**
+ * The Payload hooks that keep the cache honest (docs/payload.md#preview-url-and-revalidation).
+ * A change counts when the document is published, or was (an unpublish, an edit of a live page);
+ * a draft of a document that was never published changes nothing visitors see. A template change
+ * also revalidates the collection it targets, since every page on it may have changed.
+ */
+export declare function revalidateHooks(revalidate?: Revalidate): RevalidateHooks;
+export {};
+//# sourceMappingURL=revalidate.d.ts.map

package/dist/next/revalidate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revalidate.d.ts","sourceRoot":"","sources":["../../src/next/revalidate.ts"],"names":[],"mappings":"AAGA,+GAA+G;AAC/G,MAAM,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;AAW/C,UAAU,OAAO;IACf,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAChD;AACD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5C;AAED,MAAM,WAAW,eAAe;IAC9B,kFAAkF;IAClF,QAAQ,CAAC,UAAU,EAAE;QACnB,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC;QAC1D,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC;KAC3D,CAAC;IACF,4CAA4C;IAC5C,QAAQ,CAAC,MAAM,EAAE;QAAE,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC,CAAA;KAAE,CAAC;IACrF,8BAA8B;IAC9B,QAAQ,CAAC,SAAS,EAAE;QAClB,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC;QAC1D,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC;KAC3D,CAAC;CACH;AAID;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,UAAU,GAAE,UAA8B,GAAG,eAAe,CAsB3F"}

package/dist/next/revalidate.js

@@ -0,0 +1,45 @@
+import { revalidateTag } from 'next/cache';
+import { collectionTag, docTag, globalTag, templateTag } from './tags.js';
+const defaultRevalidate = (tag) => {
+    try {
+        // Next 16 takes a cache profile as the second argument, Next 15 ignores it.
+        revalidateTag(tag, { expire: 0 });
+    }
+    catch {
+        // Outside a Next.js request (a seed script, a test) there is no cache to invalidate.
+    }
+};
+const published = (doc) => doc?._status === 'published';
+/**
+ * The Payload hooks that keep the cache honest (docs/payload.md#preview-url-and-revalidation).
+ * A change counts when the document is published, or was (an unpublish, an edit of a live page);
+ * a draft of a document that was never published changes nothing visitors see. A template change
+ * also revalidates the collection it targets, since every page on it may have changed.
+ */
+export function revalidateHooks(revalidate = defaultRevalidate) {
+    const pageChanged = (args) => {
+        if (!(published(args.doc) || published(args.previousDoc)) || args.doc.id === undefined)
+            return;
+        revalidate(docTag(args.collection.slug, args.doc.id));
+        revalidate(collectionTag(args.collection.slug));
+    };
+    const pageDeleted = (args) => {
+        if (args.doc.id !== undefined)
+            revalidate(docTag(args.collection.slug, args.doc.id));
+        revalidate(collectionTag(args.collection.slug));
+    };
+    const templateChanged = (args) => {
+        if (args.doc.id === undefined)
+            return;
+        revalidate(templateTag(args.doc.id));
+        for (const target of [args.doc.targetCollection, args.previousDoc?.targetCollection]) {
+            if (typeof target === 'string')
+                revalidate(collectionTag(target));
+        }
+    };
+    return {
+        collection: { afterChange: [pageChanged], afterDelete: [pageDeleted] },
+        global: { afterChange: [({ global }) => revalidate(globalTag(global.slug))] },
+        templates: { afterChange: [templateChanged], afterDelete: [templateChanged] },
+    };
+}

package/dist/next/seo.d.ts

@@ -0,0 +1,43 @@
+import type { Payload } from 'payload';
+/** What `buildrMetadata` (`@next-buildr/next`) takes; declared here so this package needs no runtime import of it. */
+export interface SeoEntry {
+    readonly title?: string | null;
+    readonly excerpt?: string | null;
+    readonly featuredImage?: string | null;
+    readonly meta?: {
+        readonly title?: string | null;
+        readonly description?: string | null;
+        readonly image?: string | null;
+        readonly noIndex?: boolean | null;
+        readonly canonical?: string | null;
+    } | null;
+    readonly locale?: string;
+    readonly alternates?: Readonly<Record<string, string>>;
+    readonly draft?: boolean;
+}
+export interface SeoOptions {
+    readonly locale?: string;
+    readonly draft?: boolean;
+    /** The field holding a short summary. Default `excerpt`. */
+    readonly excerptField?: string;
+    /** The field holding the featured image (a populated upload). Default `featuredImage`. */
+    readonly imageField?: string;
+    readonly alternates?: Readonly<Record<string, string>>;
+}
+/**
+ * Maps a Payload document onto the shape `buildrMetadata` takes. Reads the fields of
+ * `@payloadcms/plugin-seo` (`meta.title`, `meta.description`, `meta.image`) plus `meta.noIndex` and
+ * `meta.canonical` when the application defines them. Images must be populated (`depth >= 1`).
+ */
+export declare function seoFromDocument(doc: Readonly<Record<string, unknown>>, options?: SeoOptions): SeoEntry;
+/**
+ * The path of a document in every configured language (hreflang): one read per locale, so a
+ * localized slug gives each language its own URL. A language without the document is left out.
+ */
+export declare function alternatesOf(input: {
+    readonly payload: Payload;
+    readonly collection: string;
+    readonly id: string | number;
+    readonly path: (doc: Record<string, unknown>, locale: string) => string;
+}): Promise<Record<string, string>>;
+//# sourceMappingURL=seo.d.ts.map

package/dist/next/seo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seo.d.ts","sourceRoot":"","sources":["../../src/next/seo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,sHAAsH;AACtH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACd,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAClC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC,GAAG,IAAI,CAAC;IACT,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CAC1B;AAUD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,4DAA4D;IAC5D,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,0FAA0F;IAC1F,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACxD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EACtC,OAAO,GAAE,UAAe,GACvB,QAAQ,CAiBV;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE;IACxC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;CACzE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAmBlC"}

package/dist/next/seo.js

@@ -0,0 +1,53 @@
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const text = (value) => typeof value === 'string' && value !== '' ? value : null;
+/** The URL of an upload field: a populated media document, or nothing when it is only an id. */
+const urlOf = (value) => (isRecord(value) ? text(value['url']) : null);
+/**
+ * Maps a Payload document onto the shape `buildrMetadata` takes. Reads the fields of
+ * `@payloadcms/plugin-seo` (`meta.title`, `meta.description`, `meta.image`) plus `meta.noIndex` and
+ * `meta.canonical` when the application defines them. Images must be populated (`depth >= 1`).
+ */
+export function seoFromDocument(doc, options = {}) {
+    const meta = isRecord(doc['meta']) ? doc['meta'] : {};
+    return {
+        title: text(doc['title']),
+        excerpt: text(doc[options.excerptField ?? 'excerpt']),
+        featuredImage: urlOf(doc[options.imageField ?? 'featuredImage']),
+        meta: {
+            title: text(meta['title']),
+            description: text(meta['description']),
+            image: urlOf(meta['image']),
+            noIndex: meta['noIndex'] === true,
+            canonical: text(meta['canonical']),
+        },
+        ...(options.locale === undefined ? {} : { locale: options.locale }),
+        ...(options.alternates === undefined ? {} : { alternates: options.alternates }),
+        ...(options.draft === true ? { draft: true } : {}),
+    };
+}
+/**
+ * The path of a document in every configured language (hreflang): one read per locale, so a
+ * localized slug gives each language its own URL. A language without the document is left out.
+ */
+export async function alternatesOf(input) {
+    const localization = input.payload.config.localization;
+    if (localization === false || localization === undefined)
+        return {};
+    const result = {};
+    for (const locale of localization.localeCodes) {
+        try {
+            const doc = await input.payload.findByID({
+                collection: input.collection,
+                id: input.id,
+                locale,
+                fallbackLocale: false,
+                depth: 0,
+            });
+            result[locale] = input.path(doc, locale);
+        }
+        catch {
+            // not published (or not readable) in this language
+        }
+    }
+    return result;
+}

package/dist/next/tags.d.ts

@@ -0,0 +1,23 @@
+/** The cache tag convention (docs/nextjs.md#preview--draft-mode-caching-revalidation-errors). */
+export declare const THEME_TAG = "buildr:theme";
+export declare const docTag: (collection: string, id: string | number) => string;
+export declare const collectionTag: (collection: string) => string;
+export declare const globalTag: (slug: string) => string;
+export declare const templateTag: (id: string | number) => string;
+export interface TagInput {
+    readonly collection: string;
+    readonly id?: string | number | undefined;
+    /** `{collection}:{id}` of the document the layout came from; a template adds its own tag. */
+    readonly layoutRef?: string | null | undefined;
+    /** The collections a Loop or query read (`collectionsUsed` of the render). */
+    readonly collectionsUsed?: readonly string[] | undefined;
+    /** Globals the page reads (`site-settings`). */
+    readonly globals?: readonly string[] | undefined;
+}
+/**
+ * Every tag a rendered page depends on: its document, its collection (a slug lookup may resolve
+ * to another document after any change), the template its layout came from, the collections its
+ * queries read, the globals it reads and the theme. Sorted and free of duplicates.
+ */
+export declare function tagsFor(input: TagInput): string[];
+//# sourceMappingURL=tags.d.ts.map

package/dist/next/tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.d.ts","sourceRoot":"","sources":["../../src/next/tags.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,eAAO,MAAM,SAAS,iBAAiB,CAAC;AAExC,eAAO,MAAM,MAAM,eAAgB,MAAM,MAAM,MAAM,GAAG,MAAM,KAAG,MACvB,CAAC;AAC3C,eAAO,MAAM,aAAa,eAAgB,MAAM,KAAG,MAAoC,CAAC;AACxF,eAAO,MAAM,SAAS,SAAU,MAAM,KAAG,MAAiC,CAAC;AAC3E,eAAO,MAAM,WAAW,OAAQ,MAAM,GAAG,MAAM,KAAG,MAAyC,CAAC;AAE5F,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAC1C,6FAA6F;IAC7F,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/C,8EAA8E;IAC9E,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACzD,gDAAgD;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CAClD;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,EAAE,CAcjD"}

package/dist/next/tags.js

@@ -0,0 +1,31 @@
+/** The cache tag convention (docs/nextjs.md#preview--draft-mode-caching-revalidation-errors). */
+export const THEME_TAG = 'buildr:theme';
+export const docTag = (collection, id) => `buildr:doc:${collection}:${String(id)}`;
+export const collectionTag = (collection) => `buildr:col:${collection}`;
+export const globalTag = (slug) => `buildr:global:${slug}`;
+export const templateTag = (id) => `buildr:template:${String(id)}`;
+/**
+ * Every tag a rendered page depends on: its document, its collection (a slug lookup may resolve
+ * to another document after any change), the template its layout came from, the collections its
+ * queries read, the globals it reads and the theme. Sorted and free of duplicates.
+ */
+export function tagsFor(input) {
+    const tags = new Set([THEME_TAG, collectionTag(input.collection)]);
+    if (input.id !== undefined)
+        tags.add(docTag(input.collection, input.id));
+    const ref = input.layoutRef;
+    if (typeof ref === 'string') {
+        const at = ref.indexOf(':');
+        const owner = ref.slice(0, at);
+        const id = ref.slice(at + 1);
+        if (owner === 'buildr-templates')
+            tags.add(templateTag(id));
+        else if (at > 0)
+            tags.add(docTag(owner, id));
+    }
+    for (const used of input.collectionsUsed ?? [])
+        tags.add(collectionTag(used));
+    for (const slug of input.globals ?? [])
+        tags.add(globalTag(slug));
+    return [...tags].sort();
+}

package/dist/plugin/access.d.ts

@@ -0,0 +1,19 @@
+import type { PayloadRequest } from 'payload';
+import type { ResolvedOptions } from './options.ts';
+export type Action = 'edit' | 'publish' | 'unlockTemplates';
+export interface Permissions {
+    readonly canEdit: boolean;
+    readonly canPublish: boolean;
+    readonly canUnlockTemplates: boolean;
+}
+/** Whether the request was authenticated by a Payload API key (`user._strategy`, set by Payload). */
+export declare const isApiKeyRequest: (req: PayloadRequest) => boolean;
+/**
+ * Whether the user of `req` may `action`. Nobody without a user may do anything; for an
+ * authenticated user the plugin `access` function decides (any authenticated user when there is
+ * none). Payload's own collection access still applies on top: every Local API call the endpoints
+ * make uses the caller's `req` with `overrideAccess: false`.
+ */
+export declare function allowed(options: Pick<ResolvedOptions, 'access' | 'mcp'>, action: Action, req: PayloadRequest): Promise<boolean>;
+export declare function permissionsOf(options: Pick<ResolvedOptions, 'access' | 'mcp'>, req: PayloadRequest): Promise<Permissions>;
+//# sourceMappingURL=access.d.ts.map

package/dist/plugin/access.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.d.ts","sourceRoot":"","sources":["../../src/plugin/access.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAE5D,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;CACtC;AAED,qGAAqG;AACrG,eAAO,MAAM,eAAe,QAAS,cAAc,KAAG,OAC4B,CAAC;AAKnF;;;;;GAKG;AACH,wBAAsB,OAAO,CAC3B,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,KAAK,CAAC,EAChD,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,cAAc,GAClB,OAAO,CAAC,OAAO,CAAC,CAUlB;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,KAAK,CAAC,EAChD,GAAG,EAAE,cAAc,GAClB,OAAO,CAAC,WAAW,CAAC,CAOtB"}

package/dist/plugin/access.js

@@ -0,0 +1,32 @@
+/** Whether the request was authenticated by a Payload API key (`user._strategy`, set by Payload). */
+export const isApiKeyRequest = (req) => req.user?._strategy === 'api-key';
+const isAuthenticated = (req) => req.user !== null && req.user !== undefined;
+/**
+ * Whether the user of `req` may `action`. Nobody without a user may do anything; for an
+ * authenticated user the plugin `access` function decides (any authenticated user when there is
+ * none). Payload's own collection access still applies on top: every Local API call the endpoints
+ * make uses the caller's `req` with `overrideAccess: false`.
+ */
+export async function allowed(options, action, req) {
+    if (!isAuthenticated(req))
+        return false;
+    if (isApiKeyRequest(req)) {
+        // An API key reaches the builder only through the opt-in `mcp` option; it publishes only with `mcp.allowPublish`.
+        if (!options.mcp.enabled)
+            return false;
+        if (action === 'publish' && !options.mcp.allowPublish)
+            return false;
+        if (action === 'unlockTemplates')
+            return false;
+    }
+    const check = options.access[action];
+    return check === undefined ? true : Boolean(await check({ req }));
+}
+export async function permissionsOf(options, req) {
+    const [canEdit, canPublish, canUnlockTemplates] = await Promise.all([
+        allowed(options, 'edit', req),
+        allowed(options, 'publish', req),
+        allowed(options, 'unlockTemplates', req),
+    ]);
+    return { canEdit, canPublish, canUnlockTemplates };
+}

package/dist/plugin/collections/form-submissions.d.ts

@@ -0,0 +1,10 @@
+import type { CollectionConfig } from 'payload';
+/** Where submitted forms are stored (`forms.enabled`). */
+export declare const FORM_SUBMISSIONS_COLLECTION = "buildr-form-submissions";
+/**
+ * `buildr-form-submissions`: one document per accepted submission. Only the plugin's endpoint
+ * creates them (through the Local API, past access control), so the collection accepts no writes
+ * from anyone else; signed-in users read and delete them (the data is personal).
+ */
+export declare function formSubmissionsCollection(): CollectionConfig;
+//# sourceMappingURL=form-submissions.d.ts.map

package/dist/plugin/collections/form-submissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-submissions.d.ts","sourceRoot":"","sources":["../../../src/plugin/collections/form-submissions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,0DAA0D;AAC1D,eAAO,MAAM,2BAA2B,4BAA4B,CAAC;AAErE;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,gBAAgB,CA6B5D"}

package/dist/plugin/collections/form-submissions.js

@@ -0,0 +1,37 @@
+/** Where submitted forms are stored (`forms.enabled`). */
+export const FORM_SUBMISSIONS_COLLECTION = 'buildr-form-submissions';
+/**
+ * `buildr-form-submissions`: one document per accepted submission. Only the plugin's endpoint
+ * creates them (through the Local API, past access control), so the collection accepts no writes
+ * from anyone else; signed-in users read and delete them (the data is personal).
+ */
+export function formSubmissionsCollection() {
+    const signedIn = ({ req }) => Boolean(req.user);
+    return {
+        slug: FORM_SUBMISSIONS_COLLECTION,
+        labels: { singular: 'Form submission', plural: 'Form submissions' },
+        admin: { defaultColumns: ['createdAt', 'form', 'locale'] },
+        access: { read: signedIn, delete: signedIn, create: () => false, update: () => false },
+        fields: [
+            {
+                name: 'form',
+                type: 'group',
+                fields: [
+                    { name: 'collection', type: 'text', required: true },
+                    { name: 'documentId', type: 'text', required: true },
+                    { name: 'nodeId', type: 'text', required: true },
+                ],
+            },
+            { name: 'data', type: 'json', required: true },
+            { name: 'locale', type: 'text' },
+            {
+                name: 'meta',
+                type: 'group',
+                fields: [
+                    { name: 'userAgent', type: 'text' },
+                    { name: 'ipHash', type: 'text' },
+                ],
+            },
+        ],
+    };
+}

package/dist/plugin/collections/templates.d.ts

@@ -0,0 +1,13 @@
+import { type CollectionConfig } from 'payload';
+import type { ResolvedOptions } from '../options.ts';
+/**
+ * `buildr-templates` (docs/payload.md): reusable layouts a collection's documents inherit. Anyone
+ * signed in reads them; visitors read the published ones (a rendered page needs its template);
+ * writing needs the builder's `edit` permission.
+ */
+export declare function templatesCollection(options: {
+    readonly resolved: ResolvedOptions;
+    /** The collections that take templates: what `targetCollection` can be. */
+    readonly targets: readonly string[];
+}): CollectionConfig;
+//# sourceMappingURL=templates.d.ts.map

package/dist/plugin/collections/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/plugin/collections/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,gBAAgB,EAGtB,MAAM,SAAS,CAAC;AAKjB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAmErD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE;IAC3C,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC,GAAG,gBAAgB,CA8CnB"}

package/dist/plugin/collections/templates.js

@@ -0,0 +1,118 @@
+import { ValidationError, } from 'payload';
+import { TEMPLATES_COLLECTION } from '../../data/resolve-layout.js';
+import { allowed } from '../access.js';
+import { describeDiagnostics, processLayout } from '../hooks/process-layout.js';
+import { configuredLocales } from '../locales.js';
+const isRecord = (value) => typeof value === 'object' && value !== null;
+/**
+ * At most one default template per target collection: saving a default when another one is already
+ * the default for the same collection is rejected (the author unmarks the other one first).
+ */
+const singleDefault = async ({ data, originalDoc, req }) => {
+    const original = isRecord(originalDoc) ? originalDoc : {};
+    const isDefault = data['isDefault'] ?? original['isDefault'];
+    if (isDefault !== true)
+        return data;
+    const target = data['targetCollection'] ?? original['targetCollection'];
+    if (typeof target !== 'string')
+        return data;
+    const ownId = original['id'];
+    const others = await req.payload.find({
+        collection: TEMPLATES_COLLECTION,
+        where: {
+            and: [
+                { targetCollection: { equals: target } },
+                { isDefault: { equals: true } },
+                ...(ownId === undefined ? [] : [{ id: { not_equals: ownId } }]),
+            ],
+        },
+        limit: 1,
+        depth: 0,
+        pagination: false,
+        draft: true,
+        req,
+        overrideAccess: true,
+    });
+    const other = others.docs[0];
+    if (other !== undefined) {
+        throw new ValidationError({
+            collection: TEMPLATES_COLLECTION,
+            errors: [
+                {
+                    path: 'isDefault',
+                    message: `"${String(other['title'])}" is already the default template for "${target}".`,
+                },
+            ],
+            req,
+        });
+    }
+    return data;
+};
+/** A stored layout is validated like the builder's: an invalid document never reaches the database. */
+const templateLayoutHook = (options) => ({ value, req }) => {
+    if (value === undefined || value === null)
+        return value;
+    const result = processLayout(value, {
+        ...options,
+        locales: configuredLocales(req.payload.config),
+    });
+    if (!result.ok) {
+        throw new ValidationError({
+            collection: TEMPLATES_COLLECTION,
+            errors: [{ path: 'layout', message: describeDiagnostics(result.diagnostics) }],
+            req,
+        });
+    }
+    return result.doc;
+};
+/**
+ * `buildr-templates` (docs/payload.md): reusable layouts a collection's documents inherit. Anyone
+ * signed in reads them; visitors read the published ones (a rendered page needs its template);
+ * writing needs the builder's `edit` permission.
+ */
+export function templatesCollection(options) {
+    const { resolved } = options;
+    const mayEdit = ({ req }) => allowed(resolved, 'edit', req);
+    return {
+        slug: TEMPLATES_COLLECTION,
+        labels: { singular: 'Template', plural: 'Templates' },
+        admin: { useAsTitle: 'title', defaultColumns: ['title', 'targetCollection', 'isDefault'] },
+        access: {
+            read: ({ req }) => (req.user ? true : { _status: { equals: 'published' } }),
+            create: mayEdit,
+            update: mayEdit,
+            delete: mayEdit,
+        },
+        versions: { drafts: { autosave: true }, maxPerDoc: 50 },
+        hooks: { beforeChange: [singleDefault] },
+        fields: [
+            { name: 'title', type: 'text', required: true },
+            {
+                name: 'targetCollection',
+                type: 'select',
+                required: true,
+                options: [...options.targets],
+                admin: { description: 'The collection whose documents can use this template.' },
+            },
+            {
+                name: 'isDefault',
+                type: 'checkbox',
+                defaultValue: false,
+                admin: {
+                    description: 'Used by documents of the collection that have no layout and no template.',
+                },
+            },
+            {
+                name: 'layout',
+                type: 'json',
+                hooks: { beforeChange: [templateLayoutHook(resolved)] },
+            },
+            {
+                name: 'buildrRevision',
+                type: 'number',
+                defaultValue: 0,
+                admin: { hidden: true, readOnly: true },
+            },
+        ],
+    };
+}

package/dist/plugin/endpoints/access.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=access.test.d.ts.map