@vitrailweb/payload-plugin-articles 1.0.1 → 1.0.4

package/README.md

@@ -64,7 +64,17 @@ pnpm build          # build to dist/
 
 ```bash
 # commit everything
-npm version patch  # or minor/major
+pnpm version patch  # or minor/major
 pnpm clean && pnpm build
 pnpm pack
 ```
+
+
+## Publish
+
+```bash
+# commit everything
+pnpm version patch  # or minor/major
+git push --follow-tags
+# create a release on Github
+```

package/dist/collections/Articles.js

@@ -1,5 +1,6 @@
 import { slugField } from 'payload';
 import { MetaDescriptionField, MetaImageField, MetaTitleField, OverviewField, PreviewField } from '@payloadcms/plugin-seo/fields';
+import { FixedToolbarFeature, lexicalEditor } from '@payloadcms/richtext-lexical';
 import { label } from '../translations/index.js';
 const seoField = (generators)=>({
         name: 'meta',
@@ -82,7 +83,13 @@ export const Articles = ({ access, articleUrl, seo })=>({
             {
                 name: 'content',
                 type: 'richText',
-                label: label((t)=>t.fields.content)
+                label: label((t)=>t.fields.content),
+                editor: lexicalEditor({
+                    features: ({ defaultFeatures })=>[
+                            ...defaultFeatures,
+                            FixedToolbarFeature()
+                        ]
+                })
             },
             {
                 name: 'publishedAt',

package/dist/collections/Articles.js.map

@@ -1 +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"}
+{"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 { FixedToolbarFeature, lexicalEditor } from '@payloadcms/richtext-lexical'\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      editor: lexicalEditor({\n        features: ({ defaultFeatures }) => [...defaultFeatures, FixedToolbarFeature()],\n      }),\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","FixedToolbarFeature","lexicalEditor","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","editor","features","defaultFeatures","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,mBAAmB,EAAEC,aAAa,QAAQ,+BAA8B;AACjF,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;YACNT,cAAc;gBACZc,WAAW;gBACXC,iBAAiB;gBACjBC,WAAW;YACb;YACAjB,eAAe;gBACbkB,eAAeX,WAAWY,gBAAgB;gBAC1CC,WAAW;oBACTf,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAACW,QAAQ;gBACvC;YACF;YACAtB,eAAe;gBACbuB,YAAY;gBACZJ,eAAeX,WAAWgB,gBAAgB;YAC5C;YACAzB,qBAAqB;gBACnBoB,eAAeX,WAAWiB,sBAAsB;YAClD;YACAtB,aAAa;gBACXgB,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;YACAlD;YACA;gBACEW,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;gBACpCC,QAAQ9C,cAAc;oBACpB+C,UAAU,CAAC,EAAEC,eAAe,EAAE,GAAK;+BAAIA;4BAAiBjD;yBAAsB;gBAChF;YACF;YACA;gBACEK,MAAM;gBACNI,MAAM;gBACNP,OAAOA,MAAM,CAACI,IAAMA,EAAEC,MAAM,CAAC2C,WAAW;gBACxCxC,OAAO;oBACLC,UAAU;oBACVwC,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;eACIhD,MAAM;gBAACL,SAASK;aAAK,GAAG,EAAE;SAC/B;IACH,CAAA,EAAE"}

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@vitrailweb/payload-plugin-articles",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "Payload plugin that adds an Articles collection",
   "license": "MIT",
   "author": {
     "name": "Vitrail Web"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Vitrail-Web/payload-plugin-articles"
+  },
   "type": "module",
   "exports": {
     ".": {
@@ -26,9 +30,9 @@
     "@payloadcms/db-sqlite": "3.84.1",
     "@payloadcms/eslint-config": "3.28.0",
     "@payloadcms/next": "3.84.1",
+    "@payloadcms/plugin-seo": "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",
@@ -56,8 +60,8 @@
     "vitest": "4.0.18"
   },
   "peerDependencies": {
-    "payload": "^3.84.1",
-    "@payloadcms/plugin-seo": "^3.84.1"
+    "@payloadcms/plugin-seo": "^3.84.1",
+    "payload": "^3.84.1"
   },
   "engines": {
     "node": "^18.20.2 || >=20.9.0",
@@ -67,7 +71,6 @@
     "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",
@@ -82,8 +85,9 @@
     "generate:types": "pnpm dev:generate-types",
     "lint": "eslint",
     "lint:fix": "eslint ./src --fix",
-    "test": "pnpm test:int && pnpm test:e2e",
+    "test": "pnpm test:unit && pnpm test:int && pnpm test:e2e",
     "test:e2e": "playwright test",
-    "test:int": "vitest"
+    "test:int": "vitest run dev/int.spec.ts",
+    "test:unit": "vitest run test/unit.spec.ts"
   }
 }