Vitrail Web — Payload plugins

pnpm monorepo of Payload CMS plugins.

Package	Version	Description
@vitrailweb/payload-plugin-articles	1.2.0	Articles and categories collections with drafts, live preview, and SEO
@vitrailweb/payload-plugin-axiom	0.2.1	Axiom plugin
@vitrailweb/payload-plugin-custom-panel	0.1.2	Configurable panel (site title, message, link buttons) above the admin dashboard
@vitrailweb/payload-plugin-health	0.1.1	Health check endpoint with optional custom checks
@vitrailweb/payload-plugin-home-nav	0.1.2	Translated "Home" label next to the admin navbar icon and a Home link at the top of the nav sidebar
@vitrailweb/payload-plugin-media	0.1.1	Configurable media uploads collection (access, unique filenames, storage prefix, image sizes)
@vitrailweb/payload-plugin-menus	0.3.2	Menus collection
@vitrailweb/payload-plugin-pages	0.1.1	Pages collection with drafts, live preview, and SEO
@vitrailweb/payload-plugin-umami	0.3.1	Umami widget
@vitrailweb/payload-plugin-shared-components	0.1.0 (private)	Private — editor features, SEO field, and access defaults inlined into the plugins at build time

Layout

• packages/* — the publishable plugins. Each one exports its source (src/index.ts) during development and swaps to dist/ on publish via publishConfig. payload-plugin-shared-components is private: articles and pages bundle it into their own dist/ with tsup, so it is never published.
• dev/ — a single shared Next + Payload dev app. dev/payload.config.ts picks a per-plugin config from dev/configs/<suite>/config.ts based on the required DEV_SUITE env var.

Development

pnpm install

pnpm dev:articles   # dev app with the articles plugin → http://localhost:3000/admin
pnpm dev:menus      # dev app with the menus plugin
pnpm dev:pages      # dev app with the pages plugin

pnpm build          # build every package to dist/
pnpm test:unit      # unit tests (packages/*/test)
pnpm test:int       # integration tests (dev/configs/*/int.spec.ts)
pnpm test:e2e       # playwright (articles suite)
pnpm lint

Regenerate Payload artifacts per suite:

pnpm generate:types:articles
pnpm generate:types:menus
pnpm generate:types:pages
pnpm generate:importmap:articles
pnpm generate:importmap:pages

Adding a plugin

1. Copy an existing package under packages/payload-plugin-<name> (package.json name/version, src/, test/).
2. Add dev/configs/<name>/{config.ts,seed.ts,int.spec.ts} using buildDevConfig() from dev/configs/shared.ts.
3. Register the suite in the loaders map of dev/payload.config.ts.
4. Add dev:<name> and generate:types:<name> scripts to the root package.json, plus workspace:* devDependency on the new package.
5. Add the short name to the package choices in .github/workflows/publish.yml.
6. Add the code and commit.
7. For publishing for the first time, login to npm npm login and run pnpm --filter @vitrailweb/payload-plugin-<name> publish --access public --no-git-checks.
8. Go to npmjs.com and in the packages of the account, go to Settings and add a Trusted Publisher.
9. Continue with the next section, as local publish is not trusted. And for local testing in another project run npm logout first.

Publish

Each package is released independently.

First commit everthing, then:

# Run release.sh script with the short name of the plugin and patch|minor|major
# The first time do:
# chmod +x release.sh
./release.sh articles patch
./release.sh pages patch
./release.sh media patch
./release.sh menus patch
./release.sh axiom patch
./release.sh umami patch
./release.sh custom-panel patch
./release.sh home-nav patch
./release.sh health patch

Test a package locally

pnpm --filter @vitrailweb/payload-plugin-<name> build
cd packages/payload-plugin-<name> && pnpm pack