@vitrailweb/payload-plugin-articles 1.0.1

package/README.md

@@ -0,0 +1,70 @@
+# payload-vw-articles
+
+A [Payload CMS](https://payloadcms.com) plugin that adds an `articles` collection with drafts (autosave), live preview, and SEO fields from `@payloadcms/plugin-seo`.
+
+## Fields
+
+| Field         | Type       | Notes                                     |
+| ------------- | ---------- | ----------------------------------------- |
+| `title`       | `text`     | required, used as admin title             |
+| `slug`        | `text`     | auto-generated from title, unique         |
+| `coverImage`  | `upload`   | relates to `media`                        |
+| `content`     | `richText` |                                           |
+| `publishedAt` | `date`     | auto-set on first publish                 |
+| `meta`        | `group`    | SEO title/description/image/preview       |
+
+> Requires a `media` upload collection in the host config.
+
+## Usage
+
+```ts
+import { buildConfig } from 'payload'
+import { VWPayloadPluginArticles } from 'payload-vw-articles'
+
+export default buildConfig({
+  plugins: [VWPayloadPluginArticles()],
+  // ...
+})
+```
+
+## Options
+
+All optional — defaults shown as comments:
+
+```ts
+VWPayloadPluginArticles({
+  // Access per operation. Defaults: read = published or authenticated,
+  // create/update/delete = authenticated.
+  access: { read, create, update, delete },
+
+  // Front-end URL of an article, used for (live) preview and SEO.
+  // Default: `${NEXT_PUBLIC_SERVER_URL}/articles/${slug}`
+  articleUrl: (slug) => string,
+
+  // SEO meta group + generate endpoints. `true` (default) uses built-in
+  // generate functions; pass an object to override any of them; `false` disables.
+  seo: { generateTitle, generateDescription, generateImage, generateURL },
+
+  // Keeps the collection schema but disables runtime behavior (default: false).
+  disabled: false,
+})
+```
+
+## Development
+
+```bash
+pnpm install
+pnpm dev            # start the dev Payload app
+pnpm test:int       # integration tests (vitest)
+pnpm test:e2e       # e2e tests (playwright)
+pnpm build          # build to dist/
+```
+
+### Test locally
+
+```bash
+# commit everything
+npm version patch  # or minor/major
+pnpm clean && pnpm build
+pnpm pack
+```

package/dist/collections/Articles.d.ts

@@ -0,0 +1,18 @@
+import type { Access, CollectionConfig } from 'payload';
+export type ArticlesAccess = {
+    create?: Access;
+    delete?: Access;
+    read?: Access;
+    update?: Access;
+};
+export type ArticlesSeoGenerators = {
+    hasGenerateDescription: boolean;
+    hasGenerateImage: boolean;
+    hasGenerateTitle: boolean;
+};
+export type ArticlesOptions = {
+    access: Required<ArticlesAccess>;
+    articleUrl: (slug?: string | null) => string;
+    seo: false | ArticlesSeoGenerators;
+};
+export declare const Articles: ({ access, articleUrl, seo }: ArticlesOptions) => CollectionConfig;

package/dist/collections/Articles.js

@@ -0,0 +1,114 @@
+import { slugField } from 'payload';
+import { MetaDescriptionField, MetaImageField, MetaTitleField, OverviewField, PreviewField } from '@payloadcms/plugin-seo/fields';
+import { label } from '../translations/index.js';
+const seoField = (generators)=>({
+        name: 'meta',
+        label: label((t)=>t.fields.seo),
+        type: 'group',
+        admin: {
+            position: 'sidebar'
+        },
+        fields: [
+            OverviewField({
+                titlePath: 'meta.title',
+                descriptionPath: 'meta.description',
+                imagePath: 'meta.image'
+            }),
+            MetaTitleField({
+                hasGenerateFn: generators.hasGenerateTitle,
+                overrides: {
+                    label: label((t)=>t.fields.seoTitle)
+                }
+            }),
+            MetaImageField({
+                relationTo: 'media',
+                hasGenerateFn: generators.hasGenerateImage
+            }),
+            MetaDescriptionField({
+                hasGenerateFn: generators.hasGenerateDescription
+            }),
+            PreviewField({
+                hasGenerateFn: true,
+                titlePath: 'meta.title',
+                descriptionPath: 'meta.description'
+            })
+        ]
+    });
+export const Articles = ({ access, articleUrl, seo })=>({
+        slug: 'articles',
+        labels: {
+            singular: label((t)=>t.articles.singular),
+            plural: label((t)=>t.articles.plural)
+        },
+        admin: {
+            useAsTitle: 'title',
+            defaultColumns: [
+                'title',
+                'slug',
+                '_status',
+                'publishedAt',
+                'updatedAt'
+            ],
+            livePreview: {
+                url: ({ data })=>articleUrl(data?.slug)
+            },
+            preview: (data)=>articleUrl(data?.slug)
+        },
+        access: {
+            read: access.read,
+            create: access.create,
+            update: access.update,
+            delete: access.delete
+        },
+        versions: {
+            drafts: {
+                autosave: true
+            }
+        },
+        fields: [
+            {
+                name: 'title',
+                type: 'text',
+                label: label((t)=>t.fields.title),
+                required: true
+            },
+            slugField(),
+            {
+                name: 'coverImage',
+                type: 'upload',
+                label: label((t)=>t.fields.coverImage),
+                relationTo: 'media'
+            },
+            {
+                name: 'content',
+                type: 'richText',
+                label: label((t)=>t.fields.content)
+            },
+            {
+                name: 'publishedAt',
+                type: 'date',
+                label: label((t)=>t.fields.publishedAt),
+                admin: {
+                    position: 'sidebar',
+                    date: {
+                        pickerAppearance: 'dayAndTime'
+                    }
+                },
+                hooks: {
+                    beforeChange: [
+                        ({ siblingData, value })=>{
+                            if (siblingData._status === 'published' && !value) {
+                                return new Date();
+                            }
+                            return value;
+                        }
+                    ]
+                }
+            },
+            ...seo ? [
+                seoField(seo)
+            ] : []
+        ]
+    });
+
+//# sourceMappingURL=Articles.js.map

package/dist/collections/Articles.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/collections/Articles.ts"],"sourcesContent":["import type { Access, CollectionConfig, Field } from 'payload'\nimport { slugField } from 'payload'\nimport {\n  MetaDescriptionField,\n  MetaImageField,\n  MetaTitleField,\n  OverviewField,\n  PreviewField,\n} from '@payloadcms/plugin-seo/fields'\nimport { label } from '../translations/index.js'\n\nexport type ArticlesAccess = {\n  create?: Access\n  delete?: Access\n  read?: Access\n  update?: Access\n}\n\nexport type ArticlesSeoGenerators = {\n  hasGenerateDescription: boolean\n  hasGenerateImage: boolean\n  hasGenerateTitle: boolean\n}\n\nexport type ArticlesOptions = {\n  access: Required<ArticlesAccess>\n  articleUrl: (slug?: string | null) => string\n  seo: false | ArticlesSeoGenerators\n}\n\nconst seoField = (generators: ArticlesSeoGenerators): Field => ({\n  name: 'meta',\n  label: label((t) => t.fields.seo),\n  type: 'group',\n  admin: {\n    position: 'sidebar',\n  },\n  fields: [\n    OverviewField({\n      titlePath: 'meta.title',\n      descriptionPath: 'meta.description',\n      imagePath: 'meta.image',\n    }),\n    MetaTitleField({\n      hasGenerateFn: generators.hasGenerateTitle,\n      overrides: {\n        label: label((t) => t.fields.seoTitle),\n      },\n    }),\n    MetaImageField({\n      relationTo: 'media',\n      hasGenerateFn: generators.hasGenerateImage,\n    }),\n    MetaDescriptionField({\n      hasGenerateFn: generators.hasGenerateDescription,\n    }),\n    PreviewField({\n      hasGenerateFn: true,\n      titlePath: 'meta.title',\n      descriptionPath: 'meta.description',\n    }),\n  ],\n})\n\nexport const Articles = ({ access, articleUrl, seo }: ArticlesOptions): CollectionConfig => ({\n  slug: 'articles',\n  labels: {\n    singular: label((t) => t.articles.singular),\n    plural: label((t) => t.articles.plural),\n  },\n  admin: {\n    useAsTitle: 'title',\n    defaultColumns: ['title', 'slug', '_status', 'publishedAt', 'updatedAt'],\n    livePreview: {\n      url: ({ data }) => articleUrl(data?.slug as string | undefined),\n    },\n    preview: (data) => articleUrl(data?.slug as string | undefined),\n  },\n  access: {\n    read: access.read,\n    create: access.create,\n    update: access.update,\n    delete: access.delete,\n  },\n  versions: {\n    drafts: {\n      autosave: true,\n    },\n  },\n  fields: [\n    {\n      name: 'title',\n      type: 'text',\n      label: label((t) => t.fields.title),\n      required: true,\n    },\n    slugField(),\n    {\n      name: 'coverImage',\n      type: 'upload',\n      label: label((t) => t.fields.coverImage),\n      relationTo: 'media',\n    },\n    {\n      name: 'content',\n      type: 'richText',\n      label: label((t) => t.fields.content),\n    },\n    {\n      name: 'publishedAt',\n      type: 'date',\n      label: label((t) => t.fields.publishedAt),\n      admin: {\n        position: 'sidebar',\n        date: {\n          pickerAppearance: 'dayAndTime',\n        },\n      },\n      hooks: {\n        beforeChange: [\n          ({ siblingData, value }) => {\n            if (siblingData._status === 'published' && !value) {\n              return new Date()\n            }\n            return value\n          },\n        ],\n      },\n    },\n    ...(seo ? [seoField(seo)] : []),\n  ],\n})\n"],"names":["slugField","MetaDescriptionField","MetaImageField","MetaTitleField","OverviewField","PreviewField","label","seoField","generators","name","t","fields","seo","type","admin","position","titlePath","descriptionPath","imagePath","hasGenerateFn","hasGenerateTitle","overrides","seoTitle","relationTo","hasGenerateImage","hasGenerateDescription","Articles","access","articleUrl","slug","labels","singular","articles","plural","useAsTitle","defaultColumns","livePreview","url","data","preview","read","create","update","delete","versions","drafts","autosave","title","required","coverImage","content","publishedAt","date","pickerAppearance","hooks","beforeChange","siblingData","value","_status","Date"],"mappings":"AACA,SAASA,SAAS,QAAQ,UAAS;AACnC,SACEC,oBAAoB,EACpBC,cAAc,EACdC,cAAc,EACdC,aAAa,EACbC,YAAY,QACP,gCAA+B;AACtC,SAASC,KAAK,QAAQ,2BAA0B;AAqBhD,MAAMC,WAAW,CAACC,aAA8C,CAAA;QAC9DC,MAAM;QACNH,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACC,GAAG;QAChCC,MAAM;QACNC,OAAO;YACLC,UAAU;QACZ;QACAJ,QAAQ;YACNP,cAAc;gBACZY,WAAW;gBACXC,iBAAiB;gBACjBC,WAAW;YACb;YACAf,eAAe;gBACbgB,eAAeX,WAAWY,gBAAgB;gBAC1CC,WAAW;oBACTf,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACW,QAAQ;gBACvC;YACF;YACApB,eAAe;gBACbqB,YAAY;gBACZJ,eAAeX,WAAWgB,gBAAgB;YAC5C;YACAvB,qBAAqB;gBACnBkB,eAAeX,WAAWiB,sBAAsB;YAClD;YACApB,aAAa;gBACXc,eAAe;gBACfH,WAAW;gBACXC,iBAAiB;YACnB;SACD;IACH,CAAA;AAEA,OAAO,MAAMS,WAAW,CAAC,EAAEC,MAAM,EAAEC,UAAU,EAAEhB,GAAG,EAAmB,GAAwB,CAAA;QAC3FiB,MAAM;QACNC,QAAQ;YACNC,UAAUzB,MAAM,CAACI,IAAMA,EAAEsB,QAAQ,CAACD,QAAQ;YAC1CE,QAAQ3B,MAAM,CAACI,IAAMA,EAAEsB,QAAQ,CAACC,MAAM;QACxC;QACAnB,OAAO;YACLoB,YAAY;YACZC,gBAAgB;gBAAC;gBAAS;gBAAQ;gBAAW;gBAAe;aAAY;YACxEC,aAAa;gBACXC,KAAK,CAAC,EAAEC,IAAI,EAAE,GAAKV,WAAWU,MAAMT;YACtC;YACAU,SAAS,CAACD,OAASV,WAAWU,MAAMT;QACtC;QACAF,QAAQ;YACNa,MAAMb,OAAOa,IAAI;YACjBC,QAAQd,OAAOc,MAAM;YACrBC,QAAQf,OAAOe,MAAM;YACrBC,QAAQhB,OAAOgB,MAAM;QACvB;QACAC,UAAU;YACRC,QAAQ;gBACNC,UAAU;YACZ;QACF;QACAnC,QAAQ;YACN;gBACEF,MAAM;gBACNI,MAAM;gBACNP,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACoC,KAAK;gBAClCC,UAAU;YACZ;YACAhD;YACA;gBACES,MAAM;gBACNI,MAAM;gBACNP,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACsC,UAAU;gBACvC1B,YAAY;YACd;YACA;gBACEd,MAAM;gBACNI,MAAM;gBACNP,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACuC,OAAO;YACtC;YACA;gBACEzC,MAAM;gBACNI,MAAM;gBACNP,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACwC,WAAW;gBACxCrC,OAAO;oBACLC,UAAU;oBACVqC,MAAM;wBACJC,kBAAkB;oBACpB;gBACF;gBACAC,OAAO;oBACLC,cAAc;wBACZ,CAAC,EAAEC,WAAW,EAAEC,KAAK,EAAE;4BACrB,IAAID,YAAYE,OAAO,KAAK,eAAe,CAACD,OAAO;gCACjD,OAAO,IAAIE;4BACb;4BACA,OAAOF;wBACT;qBACD;gBACH;YACF;eACI7C,MAAM;gBAACL,SAASK;aAAK,GAAG,EAAE;SAC/B;IACH,CAAA,EAAE"}

package/dist/defaults.d.ts

@@ -0,0 +1,10 @@
+import type { Access } from 'payload';
+import type { GenerateDescription, GenerateImage, GenerateTitle, GenerateURL } from '@payloadcms/plugin-seo/types';
+export declare const SEO_DESCRIPTION_MAX_LENGTH = 160;
+export declare const authenticated: Access;
+export declare const authenticatedOrPublished: Access;
+export declare const defaultArticleUrl: (slug?: string | null) => string;
+export declare const defaultGenerateDescription: GenerateDescription;
+export declare const defaultGenerateImage: GenerateImage;
+export declare const defaultGenerateTitle: GenerateTitle;
+export declare const defaultGenerateURL: (articleUrl: (slug?: string | null) => string) => GenerateURL;

package/dist/defaults.js

@@ -0,0 +1,36 @@
+export const SEO_DESCRIPTION_MAX_LENGTH = 160;
+export const authenticated = ({ req: { user } })=>Boolean(user);
+export const authenticatedOrPublished = ({ req: { user } })=>{
+    if (user) {
+        return true;
+    }
+    return {
+        _status: {
+            equals: 'published'
+        }
+    };
+};
+export const defaultArticleUrl = (slug)=>`${process.env.NEXT_PUBLIC_SERVER_URL || 'http://localhost:3000'}/articles/${slug ?? ''}`;
+/** Collects the plain text of a lexical richText value, for the default meta description. */ const richTextToPlainText = (content)=>{
+    const texts = [];
+    const walk = (node)=>{
+        if (!node || typeof node !== 'object') {
+            return;
+        }
+        const { children, text } = node;
+        if (typeof text === 'string') {
+            texts.push(text);
+        }
+        if (Array.isArray(children)) {
+            children.forEach(walk);
+        }
+    };
+    walk(content?.root);
+    return texts.join(' ').replace(/\s+/g, ' ').trim();
+};
+export const defaultGenerateDescription = ({ doc })=>richTextToPlainText(doc?.content).slice(0, SEO_DESCRIPTION_MAX_LENGTH);
+export const defaultGenerateImage = ({ doc })=>(typeof doc?.coverImage === 'object' ? doc?.coverImage?.id : doc?.coverImage) ?? '';
+export const defaultGenerateTitle = ({ doc })=>doc?.title ?? '';
+export const defaultGenerateURL = (articleUrl)=>({ doc })=>articleUrl(doc?.slug);
+
+//# sourceMappingURL=defaults.js.map

package/dist/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/defaults.ts"],"sourcesContent":["import type { Access } from 'payload'\nimport type {\n  GenerateDescription,\n  GenerateImage,\n  GenerateTitle,\n  GenerateURL,\n} from '@payloadcms/plugin-seo/types'\n\nexport const SEO_DESCRIPTION_MAX_LENGTH = 160\n\nexport const authenticated: Access = ({ req: { user } }) => Boolean(user)\n\nexport const authenticatedOrPublished: Access = ({ req: { user } }) => {\n  if (user) {\n    return true\n  }\n\n  return {\n    _status: {\n      equals: 'published',\n    },\n  }\n}\n\nexport const defaultArticleUrl = (slug?: string | null) =>\n  `${process.env.NEXT_PUBLIC_SERVER_URL || 'http://localhost:3000'}/articles/${slug ?? ''}`\n\n/** Collects the plain text of a lexical richText value, for the default meta description. */\nconst richTextToPlainText = (content: unknown): string => {\n  const texts: string[] = []\n\n  const walk = (node: unknown) => {\n    if (!node || typeof node !== 'object') {\n      return\n    }\n    const { children, text } = node as { children?: unknown[]; text?: unknown }\n    if (typeof text === 'string') {\n      texts.push(text)\n    }\n    if (Array.isArray(children)) {\n      children.forEach(walk)\n    }\n  }\n\n  walk((content as { root?: unknown })?.root)\n\n  return texts.join(' ').replace(/\\s+/g, ' ').trim()\n}\n\nexport const defaultGenerateDescription: GenerateDescription = ({ doc }) =>\n  richTextToPlainText(doc?.content).slice(0, SEO_DESCRIPTION_MAX_LENGTH)\n\nexport const defaultGenerateImage: GenerateImage = ({ doc }) =>\n  (typeof doc?.coverImage === 'object' ? doc?.coverImage?.id : doc?.coverImage) ?? ''\n\nexport const defaultGenerateTitle: GenerateTitle = ({ doc }) => doc?.title ?? ''\n\nexport const defaultGenerateURL =\n  (articleUrl: (slug?: string | null) => string): GenerateURL =>\n  ({ doc }) =>\n    articleUrl(doc?.slug)\n"],"names":["SEO_DESCRIPTION_MAX_LENGTH","authenticated","req","user","Boolean","authenticatedOrPublished","_status","equals","defaultArticleUrl","slug","process","env","NEXT_PUBLIC_SERVER_URL","richTextToPlainText","content","texts","walk","node","children","text","push","Array","isArray","forEach","root","join","replace","trim","defaultGenerateDescription","doc","slice","defaultGenerateImage","coverImage","id","defaultGenerateTitle","title","defaultGenerateURL","articleUrl"],"mappings":"AAQA,OAAO,MAAMA,6BAA6B,IAAG;AAE7C,OAAO,MAAMC,gBAAwB,CAAC,EAAEC,KAAK,EAAEC,IAAI,EAAE,EAAE,GAAKC,QAAQD,MAAK;AAEzE,OAAO,MAAME,2BAAmC,CAAC,EAAEH,KAAK,EAAEC,IAAI,EAAE,EAAE;IAChE,IAAIA,MAAM;QACR,OAAO;IACT;IAEA,OAAO;QACLG,SAAS;YACPC,QAAQ;QACV;IACF;AACF,EAAC;AAED,OAAO,MAAMC,oBAAoB,CAACC,OAChC,GAAGC,QAAQC,GAAG,CAACC,sBAAsB,IAAI,wBAAwB,UAAU,EAAEH,QAAQ,IAAI,CAAA;AAE3F,2FAA2F,GAC3F,MAAMI,sBAAsB,CAACC;IAC3B,MAAMC,QAAkB,EAAE;IAE1B,MAAMC,OAAO,CAACC;QACZ,IAAI,CAACA,QAAQ,OAAOA,SAAS,UAAU;YACrC;QACF;QACA,MAAM,EAAEC,QAAQ,EAAEC,IAAI,EAAE,GAAGF;QAC3B,IAAI,OAAOE,SAAS,UAAU;YAC5BJ,MAAMK,IAAI,CAACD;QACb;QACA,IAAIE,MAAMC,OAAO,CAACJ,WAAW;YAC3BA,SAASK,OAAO,CAACP;QACnB;IACF;IAEAA,KAAMF,SAAgCU;IAEtC,OAAOT,MAAMU,IAAI,CAAC,KAAKC,OAAO,CAAC,QAAQ,KAAKC,IAAI;AAClD;AAEA,OAAO,MAAMC,6BAAkD,CAAC,EAAEC,GAAG,EAAE,GACrEhB,oBAAoBgB,KAAKf,SAASgB,KAAK,CAAC,GAAG9B,4BAA2B;AAExE,OAAO,MAAM+B,uBAAsC,CAAC,EAAEF,GAAG,EAAE,GACzD,AAAC,CAAA,OAAOA,KAAKG,eAAe,WAAWH,KAAKG,YAAYC,KAAKJ,KAAKG,UAAS,KAAM,GAAE;AAErF,OAAO,MAAME,uBAAsC,CAAC,EAAEL,GAAG,EAAE,GAAKA,KAAKM,SAAS,GAAE;AAEhF,OAAO,MAAMC,qBACX,CAACC,aACD,CAAC,EAAER,GAAG,EAAE,GACNQ,WAAWR,KAAKpB,MAAK"}

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import type { Config } from 'payload';
+import type { GenerateDescription, GenerateImage, GenerateTitle, GenerateURL } from '@payloadcms/plugin-seo/types';
+import type { ArticlesAccess } from './collections/Articles.js';
+export type VWPayloadPluginArticlesConfig = {
+    /**
+     * Access control for the articles collection, per operation.
+     * Defaults: `read` allows authenticated users or published documents,
+     * `create`/`update`/`delete` require an authenticated user.
+     */
+    access?: ArticlesAccess;
+    /**
+     * Builds the front-end URL of an article, used for admin preview and live preview.
+     * Defaults to `${NEXT_PUBLIC_SERVER_URL || 'http://localhost:3000'}/articles/${slug}`.
+     */
+    articleUrl?: (slug?: string | null) => string;
+    disabled?: boolean;
+    /**
+     * Adds an SEO `meta` group (title, description, image, preview) to the
+     * articles collection, built from `@payloadcms/plugin-seo` fields.
+     * `true` (the default) enables it with built-in generate functions
+     * (title from the article title, description from the content, image from
+     * the cover image, URL from `articleUrl`). Pass an object to override any
+     * of the generate functions, or `false` to disable SEO entirely.
+     * @default true
+     */
+    seo?: boolean | {
+        generateDescription?: GenerateDescription;
+        generateImage?: GenerateImage;
+        generateTitle?: GenerateTitle;
+        generateURL?: GenerateURL;
+    };
+};
+export declare const VWPayloadPluginArticles: (pluginOptions?: VWPayloadPluginArticlesConfig) => (config: Config) => Config;

package/dist/index.js

@@ -0,0 +1,49 @@
+import { seoPlugin } from '@payloadcms/plugin-seo';
+import { Articles } from './collections/Articles.js';
+import { authenticated, authenticatedOrPublished, defaultArticleUrl, defaultGenerateDescription, defaultGenerateImage, defaultGenerateTitle, defaultGenerateURL } from './defaults.js';
+export const VWPayloadPluginArticles = (pluginOptions = {})=>(config)=>{
+        if (!config.collections) {
+            config.collections = [];
+        }
+        const articleUrl = pluginOptions.articleUrl ?? defaultArticleUrl;
+        const access = {
+            create: pluginOptions.access?.create ?? authenticated,
+            delete: pluginOptions.access?.delete ?? authenticated,
+            read: pluginOptions.access?.read ?? authenticatedOrPublished,
+            update: pluginOptions.access?.update ?? authenticated
+        };
+        const seoEnabled = pluginOptions.seo !== false;
+        const seoOverrides = typeof pluginOptions.seo === 'object' ? pluginOptions.seo : {};
+        const generateDescription = seoOverrides.generateDescription ?? defaultGenerateDescription;
+        const generateImage = seoOverrides.generateImage ?? defaultGenerateImage;
+        const generateTitle = seoOverrides.generateTitle ?? defaultGenerateTitle;
+        const generateURL = seoOverrides.generateURL ?? defaultGenerateURL(articleUrl);
+        config.collections.push(Articles({
+            access,
+            articleUrl,
+            seo: seoEnabled ? {
+                hasGenerateDescription: true,
+                hasGenerateImage: true,
+                hasGenerateTitle: true
+            } : false
+        }));
+        /**
+     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.
+     */ if (pluginOptions.disabled) {
+            return config;
+        }
+        if (seoEnabled) {
+            // Registers the /plugin-seo/generate-* endpoints the field buttons call.
+            // No collections are passed: the meta fields are added by Articles itself.
+            config = seoPlugin({
+                collections: [],
+                generateDescription,
+                generateImage,
+                generateTitle,
+                generateURL
+            })(config);
+        }
+        return config;
+    };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Config } from 'payload'\nimport type {\n  GenerateDescription,\n  GenerateImage,\n  GenerateTitle,\n  GenerateURL,\n} from '@payloadcms/plugin-seo/types'\nimport { seoPlugin } from '@payloadcms/plugin-seo'\nimport type { ArticlesAccess } from './collections/Articles.js'\nimport { Articles } from './collections/Articles.js'\nimport {\n  authenticated,\n  authenticatedOrPublished,\n  defaultArticleUrl,\n  defaultGenerateDescription,\n  defaultGenerateImage,\n  defaultGenerateTitle,\n  defaultGenerateURL,\n} from './defaults.js'\n\nexport type VWPayloadPluginArticlesConfig = {\n  /**\n   * Access control for the articles collection, per operation.\n   * Defaults: `read` allows authenticated users or published documents,\n   * `create`/`update`/`delete` require an authenticated user.\n   */\n  access?: ArticlesAccess\n  /**\n   * Builds the front-end URL of an article, used for admin preview and live preview.\n   * Defaults to `${NEXT_PUBLIC_SERVER_URL || 'http://localhost:3000'}/articles/${slug}`.\n   */\n  articleUrl?: (slug?: string | null) => string\n  disabled?: boolean\n  /**\n   * Adds an SEO `meta` group (title, description, image, preview) to the\n   * articles collection, built from `@payloadcms/plugin-seo` fields.\n   * `true` (the default) enables it with built-in generate functions\n   * (title from the article title, description from the content, image from\n   * the cover image, URL from `articleUrl`). Pass an object to override any\n   * of the generate functions, or `false` to disable SEO entirely.\n   * @default true\n   */\n  seo?:\n    | boolean\n    | {\n        generateDescription?: GenerateDescription\n        generateImage?: GenerateImage\n        generateTitle?: GenerateTitle\n        generateURL?: GenerateURL\n      }\n}\n\nexport const VWPayloadPluginArticles =\n  (pluginOptions: VWPayloadPluginArticlesConfig = {}) =>\n  (config: Config): Config => {\n    if (!config.collections) {\n      config.collections = []\n    }\n\n    const articleUrl = pluginOptions.articleUrl ?? defaultArticleUrl\n\n    const access = {\n      create: pluginOptions.access?.create ?? authenticated,\n      delete: pluginOptions.access?.delete ?? authenticated,\n      read: pluginOptions.access?.read ?? authenticatedOrPublished,\n      update: pluginOptions.access?.update ?? authenticated,\n    }\n\n    const seoEnabled = pluginOptions.seo !== false\n    const seoOverrides = typeof pluginOptions.seo === 'object' ? pluginOptions.seo : {}\n\n    const generateDescription: GenerateDescription =\n      seoOverrides.generateDescription ?? defaultGenerateDescription\n    const generateImage: GenerateImage = seoOverrides.generateImage ?? defaultGenerateImage\n    const generateTitle: GenerateTitle = seoOverrides.generateTitle ?? defaultGenerateTitle\n    const generateURL: GenerateURL = seoOverrides.generateURL ?? defaultGenerateURL(articleUrl)\n\n    config.collections.push(\n      Articles({\n        access,\n        articleUrl,\n        seo: seoEnabled\n          ? {\n              hasGenerateDescription: true,\n              hasGenerateImage: true,\n              hasGenerateTitle: true,\n            }\n          : false,\n      }),\n    )\n\n    /**\n     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.\n     */\n    if (pluginOptions.disabled) {\n      return config\n    }\n\n    if (seoEnabled) {\n      // Registers the /plugin-seo/generate-* endpoints the field buttons call.\n      // No collections are passed: the meta fields are added by Articles itself.\n      config = seoPlugin({\n        collections: [],\n        generateDescription,\n        generateImage,\n        generateTitle,\n        generateURL,\n      })(config)\n    }\n\n    return config\n  }\n"],"names":["seoPlugin","Articles","authenticated","authenticatedOrPublished","defaultArticleUrl","defaultGenerateDescription","defaultGenerateImage","defaultGenerateTitle","defaultGenerateURL","VWPayloadPluginArticles","pluginOptions","config","collections","articleUrl","access","create","delete","read","update","seoEnabled","seo","seoOverrides","generateDescription","generateImage","generateTitle","generateURL","push","hasGenerateDescription","hasGenerateImage","hasGenerateTitle","disabled"],"mappings":"AAOA,SAASA,SAAS,QAAQ,yBAAwB;AAElD,SAASC,QAAQ,QAAQ,4BAA2B;AACpD,SACEC,aAAa,EACbC,wBAAwB,EACxBC,iBAAiB,EACjBC,0BAA0B,EAC1BC,oBAAoB,EACpBC,oBAAoB,EACpBC,kBAAkB,QACb,gBAAe;AAkCtB,OAAO,MAAMC,0BACX,CAACC,gBAA+C,CAAC,CAAC,GAClD,CAACC;QACC,IAAI,CAACA,OAAOC,WAAW,EAAE;YACvBD,OAAOC,WAAW,GAAG,EAAE;QACzB;QAEA,MAAMC,aAAaH,cAAcG,UAAU,IAAIT;QAE/C,MAAMU,SAAS;YACbC,QAAQL,cAAcI,MAAM,EAAEC,UAAUb;YACxCc,QAAQN,cAAcI,MAAM,EAAEE,UAAUd;YACxCe,MAAMP,cAAcI,MAAM,EAAEG,QAAQd;YACpCe,QAAQR,cAAcI,MAAM,EAAEI,UAAUhB;QAC1C;QAEA,MAAMiB,aAAaT,cAAcU,GAAG,KAAK;QACzC,MAAMC,eAAe,OAAOX,cAAcU,GAAG,KAAK,WAAWV,cAAcU,GAAG,GAAG,CAAC;QAElF,MAAME,sBACJD,aAAaC,mBAAmB,IAAIjB;QACtC,MAAMkB,gBAA+BF,aAAaE,aAAa,IAAIjB;QACnE,MAAMkB,gBAA+BH,aAAaG,aAAa,IAAIjB;QACnE,MAAMkB,cAA2BJ,aAAaI,WAAW,IAAIjB,mBAAmBK;QAEhFF,OAAOC,WAAW,CAACc,IAAI,CACrBzB,SAAS;YACPa;YACAD;YACAO,KAAKD,aACD;gBACEQ,wBAAwB;gBACxBC,kBAAkB;gBAClBC,kBAAkB;YACpB,IACA;QACN;QAGF;;KAEC,GACD,IAAInB,cAAcoB,QAAQ,EAAE;YAC1B,OAAOnB;QACT;QAEA,IAAIQ,YAAY;YACd,yEAAyE;YACzE,2EAA2E;YAC3ER,SAASX,UAAU;gBACjBY,aAAa,EAAE;gBACfU;gBACAC;gBACAC;gBACAC;YACF,GAAGd;QACL;QAEA,OAAOA;IACT,EAAC"}

package/dist/translations/en.d.ts

@@ -0,0 +1,14 @@
+export declare const en: {
+    articles: {
+        plural: string;
+        singular: string;
+    };
+    fields: {
+        content: string;
+        coverImage: string;
+        publishedAt: string;
+        seo: string;
+        seoTitle: string;
+        title: string;
+    };
+};

package/dist/translations/en.js

@@ -0,0 +1,16 @@
+export const en = {
+    articles: {
+        plural: 'Articles',
+        singular: 'Article'
+    },
+    fields: {
+        content: 'Content',
+        coverImage: 'Cover Image',
+        publishedAt: 'Published At',
+        seo: 'SEO',
+        seoTitle: 'Title',
+        title: 'Title'
+    }
+};
+
+//# sourceMappingURL=en.js.map

package/dist/translations/en.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/translations/en.ts"],"sourcesContent":["export const en = {\n  articles: {\n    plural: 'Articles',\n    singular: 'Article',\n  },\n  fields: {\n    content: 'Content',\n    coverImage: 'Cover Image',\n    publishedAt: 'Published At',\n    seo: 'SEO',\n    seoTitle: 'Title',\n    title: 'Title',\n  },\n}\n"],"names":["en","articles","plural","singular","fields","content","coverImage","publishedAt","seo","seoTitle","title"],"mappings":"AAAA,OAAO,MAAMA,KAAK;IAChBC,UAAU;QACRC,QAAQ;QACRC,UAAU;IACZ;IACAC,QAAQ;QACNC,SAAS;QACTC,YAAY;QACZC,aAAa;QACbC,KAAK;QACLC,UAAU;QACVC,OAAO;IACT;AACF,EAAC"}

package/dist/translations/fr.d.ts

@@ -0,0 +1,2 @@
+import type { Translation } from './index.js';
+export declare const fr: Translation;

package/dist/translations/fr.js

@@ -0,0 +1,16 @@
+export const fr = {
+    articles: {
+        plural: 'Articles',
+        singular: 'Article'
+    },
+    fields: {
+        content: 'Contenu',
+        coverImage: 'Image de couverture',
+        publishedAt: 'Publié le',
+        seo: 'SEO',
+        seoTitle: 'Titre',
+        title: 'Titre'
+    }
+};
+
+//# sourceMappingURL=fr.js.map

package/dist/translations/fr.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/translations/fr.ts"],"sourcesContent":["import type { Translation } from './index.js'\n\nexport const fr: Translation = {\n  articles: {\n    plural: 'Articles',\n    singular: 'Article',\n  },\n  fields: {\n    content: 'Contenu',\n    coverImage: 'Image de couverture',\n    publishedAt: 'Publié le',\n    seo: 'SEO',\n    seoTitle: 'Titre',\n    title: 'Titre',\n  },\n}\n"],"names":["fr","articles","plural","singular","fields","content","coverImage","publishedAt","seo","seoTitle","title"],"mappings":"AAEA,OAAO,MAAMA,KAAkB;IAC7BC,UAAU;QACRC,QAAQ;QACRC,UAAU;IACZ;IACAC,QAAQ;QACNC,SAAS;QACTC,YAAY;QACZC,aAAa;QACbC,KAAK;QACLC,UAAU;QACVC,OAAO;IACT;AACF,EAAC"}

package/dist/translations/index.d.ts

@@ -0,0 +1,4 @@
+import { en } from './en.js';
+export type Translation = typeof en;
+/** Builds a Payload label record ({ en, fr }) from a translation key selector. */
+export declare const label: (pick: (t: Translation) => string) => Record<string, string>;

package/dist/translations/index.js

@@ -0,0 +1,8 @@
+import { en } from './en.js';
+import { fr } from './fr.js';
+/** Builds a Payload label record ({ en, fr }) from a translation key selector. */ export const label = (pick)=>({
+        en: pick(en),
+        fr: pick(fr)
+    });
+
+//# sourceMappingURL=index.js.map

package/dist/translations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/translations/index.ts"],"sourcesContent":["import { en } from './en.js'\nimport { fr } from './fr.js'\n\nexport type Translation = typeof en\n\n/** Builds a Payload label record ({ en, fr }) from a translation key selector. */\nexport const label = (pick: (t: Translation) => string): Record<string, string> => ({\n  en: pick(en),\n  fr: pick(fr),\n})\n"],"names":["en","fr","label","pick"],"mappings":"AAAA,SAASA,EAAE,QAAQ,UAAS;AAC5B,SAASC,EAAE,QAAQ,UAAS;AAI5B,gFAAgF,GAChF,OAAO,MAAMC,QAAQ,CAACC,OAA8D,CAAA;QAClFH,IAAIG,KAAKH;QACTC,IAAIE,KAAKF;IACX,CAAA,EAAE"}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@vitrailweb/payload-plugin-articles",
+  "version": "1.0.1",
+  "description": "Payload plugin that adds an Articles collection",
+  "license": "MIT",
+  "author": {
+    "name": "Vitrail Web"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@payloadcms/db-mongodb": "3.84.1",
+    "@payloadcms/db-postgres": "3.84.1",
+    "@payloadcms/db-sqlite": "3.84.1",
+    "@payloadcms/eslint-config": "3.28.0",
+    "@payloadcms/next": "3.84.1",
+    "@payloadcms/richtext-lexical": "3.84.1",
+    "@payloadcms/ui": "3.84.1",
+    "@payloadcms/plugin-seo": "3.84.1",
+    "@playwright/test": "1.58.2",
+    "@swc-node/register": "1.10.9",
+    "@swc/cli": "0.6.0",
+    "@types/node": "22.19.9",
+    "@types/react": "19.2.14",
+    "@types/react-dom": "19.2.3",
+    "copyfiles": "2.4.1",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.23.0",
+    "eslint-config-next": "16.2.6",
+    "graphql": "^16.8.1",
+    "mongodb-memory-server": "10.1.4",
+    "next": "16.2.6",
+    "open": "^10.1.0",
+    "payload": "3.84.1",
+    "prettier": "^3.4.2",
+    "qs-esm": "8.0.1",
+    "react": "19.2.6",
+    "react-dom": "19.2.6",
+    "rimraf": "3.0.2",
+    "sharp": "0.34.2",
+    "sort-package-json": "^2.10.0",
+    "typescript": "5.7.3",
+    "vite-tsconfig-paths": "6.0.5",
+    "vitest": "4.0.18"
+  },
+  "peerDependencies": {
+    "payload": "^3.84.1",
+    "@payloadcms/plugin-seo": "^3.84.1"
+  },
+  "engines": {
+    "node": "^18.20.2 || >=20.9.0",
+    "pnpm": "^9 || ^10 || ^11"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {},
+  "scripts": {
+    "build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
+    "build:types": "tsc --outDir dist --rootDir ./src",
+    "clean": "rimraf {dist,*.tsbuildinfo}",
+    "copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
+    "dev": "next dev dev --turbo",
+    "dev:generate-importmap": "pnpm dev:payload generate:importmap",
+    "dev:generate-types": "pnpm dev:payload generate:types",
+    "dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
+    "generate:importmap": "pnpm dev:generate-importmap",
+    "generate:types": "pnpm dev:generate-types",
+    "lint": "eslint",
+    "lint:fix": "eslint ./src --fix",
+    "test": "pnpm test:int && pnpm test:e2e",
+    "test:e2e": "playwright test",
+    "test:int": "vitest"
+  }
+}