skills/payloadcms__payload
1
0
Fork 0
mirror of https://github.com/payloadcms/payload.git synced 2026-09-14 20:07:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
2b10973fd3390da6b901e66ff59ea6042c9d4188
payloadcms__payload/templates/plugin/package.json
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

119 lines
3.4 KiB
JSON
Raw Normal View History

feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
{
feat(templates): added int and e2e tests to blank and website templates (#12866) This PR adds int tests with vitest and e2e tests with playwright directly into our templates. The following are also updated: - bumps core turbo to 2.5.4 in monorepo - blank and website templates moved up to be part of the monorepo workspace - this means we now have thes templates filtered out in pnpm commands in package.json - they will now by default use workspace packages which we can use for manual testing and int and e2e tests - note that turbo doesnt work with these for dev in monorepo context - CPA script will fetch latest version and then replace `workspace:*` or the pinned version in the package.json before installation - blank template no longer uses _template as a base, this is to simplify management for workspace - updated the generate template variations script
2025-06-26 10:55:28 -07:00
"name": "plugin",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"version": "1.0.0",
"description": "A blank template to get started with Payload 3.0",
"license": "MIT",
"type": "module",
"exports": {
".": {
fix(templates): plugin template correct paths for exports (#13427) When using plugin template , initial package.json settings is wrong. They point to non-existing files in exports folder ( index.ts , index.js, index.d.ts ) , which results in broken package if published (can't import your plugin from package) Fixes #13426
2025-08-19 16:10:18 +03:00
"import": "./src/index.ts",
"types": "./src/index.ts",
"default": "./src/index.ts"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
},
"./client": {
templates: use `publishConfig` for the plugin template (#10196) Separates `exports`, `main`, `types` for publish / dev with `publishConfig` for the plugin template. Previously, you needed a `dist` folder to run payload bin scripts.
2024-12-27 17:22:25 +02:00
"import": "./src/exports/client.ts",
"types": "./src/exports/client.ts",
"default": "./src/exports/client.ts"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
},
"./rsc": {
templates: use `publishConfig` for the plugin template (#10196) Separates `exports`, `main`, `types` for publish / dev with `publishConfig` for the plugin template. Previously, you needed a `dist` folder to run payload bin scripts.
2024-12-27 17:22:25 +02:00
"import": "./src/exports/rsc.ts",
"types": "./src/exports/rsc.ts",
"default": "./src/exports/rsc.ts"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
}
},
fix(templates): plugin template correct paths for exports (#13427) When using plugin template , initial package.json settings is wrong. They point to non-existing files in exports folder ( index.ts , index.js, index.d.ts ) , which results in broken package if published (can't import your plugin from package) Fixes #13426
2025-08-19 16:10:18 +03:00
"main": "./src/index.ts",
"types": "./src/index.ts",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"files": [
"dist"
],
"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/",
templates: bump to 3.82.0, remove --no-server-fast-refresh flag (#16212) - bumps templates to Payload 3.82.0 - removes the --no-server-fast-refresh flag from templates dev script, as [it is no longer needed with Payload 3.82.0 and Next.js 16.2.2](https://github.com/payloadcms/payload/pull/16202) --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1213983836266021
2026-04-08 12:29:40 -07:00
"dev": "next dev dev --turbo",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"dev:generate-importmap": "pnpm dev:payload generate:importmap",
"dev:generate-types": "pnpm dev:payload generate:types",
templates: use `cross-env` in the plugin template to achieve compatibility with Windows (#10390) ### What? Uses `cross-env` for the `dev:payload` script in the plugin template. ### Why? To achieve compatibility with Windows. ### How? Adds `cross-env` as a dev dependency and modifies the `dev:payload` script.
2025-01-06 18:00:12 +02:00
"dev:payload": "cross-env PAYLOAD_CONFIG_PATH=./dev/payload.config.ts payload",
ci: template errors not being caught due. fix: error due to updated generated-types User type (#12973) This PR consists of two separate changes. One change cannot pass CI without the other, so both are included in this single PR. ## CI - ensure types are generated Our website template is currently failing to build due to a type error. This error was introduced by a change in our generated types. Our CI did not catch this issue because it wasn't generating types / import map before attempting to build the templates. This PR updates the CI to generate types first. It also updates some CI step names for improved clarity. ## Fix: type error ![Screenshot 2025-06-29 at 12 53 49@2x](https://github.com/user-attachments/assets/962f1513-bc6c-4e12-9b74-9b891c49900b) This fixes the type error by ensuring we consistently use the _same_ generated `TypedUser` object within payload, instead of `BaseUser`. Previously, we sometimes used the generated-types user and sometimes the base user, which was causing type conflicts depending on what the generated user type was. It also deprecates the `User` type (which was essentially just `BaseUser`), as consumers should use `TypedUser` instead. `TypedUser` will automatically fall back to `BaseUser` if no generated types exists, but will accept passing it a generated-types User. Without this change, additional properties added to the user via generated-types may cause the user object to not be accepted by functions that only accept a `User` instead of a `TypedUser`, which is what failed here. ## Templates: re-generate templates to update generated types --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1210668927737258
2025-06-29 14:27:50 -07:00
"generate:importmap": "pnpm dev:generate-importmap",
chore(deps): bump deps to resolve all high severity (#13002) Bumps dependencies to resolve all `high` severity vulnerabilities
2025-07-08 11:42:41 -04:00
"generate:types": "pnpm dev:generate-types",
chore(templates): fix eslint errors in plugin template (#10770) Additionally, the scope of `pnpm eslint` has been expanded to cover the entire project, not only src.
2025-01-23 18:01:54 -03:00
"lint": "eslint",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"lint:fix": "eslint ./src --fix",
fix(templates): update template/plugin and fix import map issue (#12305) ### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
2025-05-27 22:33:23 +01:00
"test": "pnpm test:int && pnpm test:e2e",
"test:e2e": "playwright test",
"test:int": "vitest"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
},
"devDependencies": {
"@eslint/eslintrc": "^3.2.0",
fix(templates): update template/plugin and fix import map issue (#12305) ### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
2025-05-27 22:33:23 +01:00
"@payloadcms/db-mongodb": "3.37.0",
"@payloadcms/db-postgres": "3.37.0",
"@payloadcms/db-sqlite": "3.37.0",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"@payloadcms/eslint-config": "3.9.0",
fix(templates): update template/plugin and fix import map issue (#12305) ### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
2025-05-27 22:33:23 +01:00
"@payloadcms/next": "3.37.0",
"@payloadcms/richtext-lexical": "3.37.0",
"@payloadcms/ui": "3.37.0",
chore: bump playwright to fix vscode run test indicators (#15626) Bumps playwright in monorepo and templates and fixes duplicatively installed playwright packages (no longer necessary since we moved to the rest API in our e2e tests). This fixes an issue where e2e test run buttons do not display at the correct position in the vscode sidebar
2026-02-13 10:10:54 -08:00
"@playwright/test": "1.58.2",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"@swc-node/register": "1.10.9",
chore(deps): bump packages used to build payload (#10950) Bumps all babel/esbuild/swc/react compiler packages
2025-02-03 09:53:42 -07:00
"@swc/cli": "0.6.0",
templates: fix deprecation warnings during install (#15536) Fixes deprecation warnings during fresh install of our templates. ## Website Template Before ```bash alessio@alessiogravilismacbookpro16inch2024m4max v1 % rm -rf node_modules pnpm-lock.yaml && pnpm i  WARN  3 deprecated subdependencies found: glob@7.2.3, inflight@1.0.6, whatwg-encoding@3.1.1  WARN  Issues with peer dependencies found . ├─┬ vite 7.3.1 │ └── ✕ unmet peer @types/node@"^20.19.0 || >=22.12.0": found 22.5.4 ├─┬ lucide-react 0.378.0 │ └── ✕ unmet peer react@"^16.5.1 || ^17.0.0 || ^18.0.0": found 19.2.4 └─┬ react-hook-form 7.45.4 └── ✕ unmet peer react@"^16.8.0 || ^17 || ^18": found 19.2.4 Packages: +795 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Progress: resolved 936, reused 800, downloaded 0, added 795, done ``` ## Website Template After ```bash alessio@alessiogravilismacbookpro16inch2024m4max v1 % rm -rf node_modules pnpm-lock.yaml && pnpm i Packages: +795 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Progress: resolved 936, reused 800, downloaded 0, added 795, done ```
2026-02-05 14:09:12 -08:00
"@types/node": "22.19.9",
templates: bump templates to Next.js 16.2.0 (#16003) This PR bumps all our templates to use Next.js 16.2.0. As part of that process, we're renaming the next.config.mjs files to next.config.ts. --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1213725260670238
2026-03-20 10:34:10 -07:00
"@types/react": "19.2.14",
templates(deps): bump Next.js versions (#15365) - Bumps templates Next.js versions to latest 15.4.x version not affected by [recent CVE](https://vercel.com/changelog/summaries-of-cve-) - Bumps monorepo Next.js versions to latest canary not affected by CVE - Misc react and react types version bumps
2026-01-27 09:53:18 -08:00
"@types/react-dom": "19.2.3",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"copyfiles": "2.4.1",
templates: use `cross-env` in the plugin template to achieve compatibility with Windows (#10390) ### What? Uses `cross-env` for the `dev:payload` script in the plugin template. ### Why? To achieve compatibility with Windows. ### How? Adds `cross-env` as a dev dependency and modifies the `dev:payload` script.
2025-01-06 18:00:12 +02:00
"cross-env": "^7.0.3",
feat!: bump minimum next version to 15.2.3 (#11823) **BREAKING CHANGE:** This bumps the **minimum required Next.js** version from 15.0.0 to 15.2.3. This update is necessary due to a critical security vulnerability found in earlier Next.js versions, which requires an exception to our standard semantic versioning process. Additionally, this bumps all templates to the latest Next.js and Payload versions.
2025-03-24 07:41:33 -06:00
"eslint": "^9.23.0",
templates: bump payload and next.js versions (#16229) - Bumps payload version in templates from 3.82.0 to 3.82.1 - Bumps Next.js version in monorepo and templates from 16.2.2 to 16.2.3
2026-04-09 11:47:04 -07:00
"eslint-config-next": "16.2.3",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"graphql": "^16.8.1",
chore: fix various e2e test setup issues (#12670) I noticed a few issues when running e2e tests that will be resolved by this PR: - Most important: for some test suites (fields, fields-relationship, versions, queues, lexical), the database was cleared and seeded **twice** in between each test run. This is because the onInit function was running the clear and seed script, when it should only have been running the seed script. Clearing the database / the snapshot workflow is being done by the reInit endpoint, which then calls onInit to seed the actual data. - The slowest part of `clearAndSeedEverything` is recreating indexes on mongodb. This PR slightly improves performance here by: - Skipping this process for the built-in `['payload-migrations', 'payload-preferences', 'payload-locked-documents']` collections - Previously we were calling both `createIndexes` and `ensureIndexes`. This was unnecessary - `ensureIndexes` is a deprecated alias of `createIndexes`. This PR changes it to only call `createIndexes` - Makes the reinit endpoint accept GET requests instead of POST requests - this makes it easier to debug right in the browser - Some typescript fixes - Adds a `dev:memorydb` script to the package.json. For some reason, `dev` is super unreliable on mongodb locally when running e2e tests - it frequently fails during index creation. Using the memorydb fixes this issue, with the bonus of more closely resembling the CI environment - Previously, you were unable to run test suites using turbopack + postgres. This fixes it, by explicitly installing `pg` as devDependency in our monorepo - Fixes jest open handles warning
2025-06-04 13:34:37 -07:00
"mongodb-memory-server": "10.1.4",
templates: bump payload and next.js versions (#16229) - Bumps payload version in templates from 3.82.0 to 3.82.1 - Bumps Next.js version in monorepo and templates from 16.2.2 to 16.2.3
2026-04-09 11:47:04 -07:00
"next": "16.2.3",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"open": "^10.1.0",
fix(templates): update template/plugin and fix import map issue (#12305) ### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
2025-05-27 22:33:23 +01:00
"payload": "3.37.0",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"prettier": "^3.4.2",
chore(deps): bump qs-esm from 7.0.2 to 8.0.1 (#16110) Bumps qs-esm from 7.0.2 to 8.0.1. [qs-esm 8 removes some legacy code that is not used in payload](https://github.com/payloadcms/qs-esm/pull/5), making the package a bit smaller.
2026-03-31 07:42:35 -07:00
"qs-esm": "8.0.1",
templates: bump templates to Next.js 16.2.0 (#16003) This PR bumps all our templates to use Next.js 16.2.0. As part of that process, we're renaming the next.config.mjs files to next.config.ts. --- - To see the specific tasks where the Asana app for GitHub is being used, see below: - https://app.asana.com/0/0/1213725260670238
2026-03-20 10:34:10 -07:00
"react": "19.2.4",
"react-dom": "19.2.4",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"rimraf": "3.0.2",
chore(deps): bump deps to resolve all high severity (#13002) Bumps dependencies to resolve all `high` severity vulnerabilities
2025-07-08 11:42:41 -04:00
"sharp": "0.34.2",
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"sort-package-json": "^2.10.0",
fix(templates): update template/plugin and fix import map issue (#12305) ### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
2025-05-27 22:33:23 +01:00
"typescript": "5.7.3",
templates: fix deprecation warnings during install (#15536) Fixes deprecation warnings during fresh install of our templates. ## Website Template Before ```bash alessio@alessiogravilismacbookpro16inch2024m4max v1 % rm -rf node_modules pnpm-lock.yaml && pnpm i  WARN  3 deprecated subdependencies found: glob@7.2.3, inflight@1.0.6, whatwg-encoding@3.1.1  WARN  Issues with peer dependencies found . ├─┬ vite 7.3.1 │ └── ✕ unmet peer @types/node@"^20.19.0 || >=22.12.0": found 22.5.4 ├─┬ lucide-react 0.378.0 │ └── ✕ unmet peer react@"^16.5.1 || ^17.0.0 || ^18.0.0": found 19.2.4 └─┬ react-hook-form 7.45.4 └── ✕ unmet peer react@"^16.8.0 || ^17 || ^18": found 19.2.4 Packages: +795 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Progress: resolved 936, reused 800, downloaded 0, added 795, done ``` ## Website Template After ```bash alessio@alessiogravilismacbookpro16inch2024m4max v1 % rm -rf node_modules pnpm-lock.yaml && pnpm i Packages: +795 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Progress: resolved 936, reused 800, downloaded 0, added 795, done ```
2026-02-05 14:09:12 -08:00
"vite-tsconfig-paths": "6.0.5",
"vitest": "4.0.18"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
},
"peerDependencies": {
fix(templates): update template/plugin and fix import map issue (#12305) ### What? 1. Adds logic to automatically update the `importMap.js` file with the project name provided by the user. 2. Adds an updated version of the `README.md` file that we had when this template existed outside of the monorepo ([here](https://github.com/payloadcms/plugin-template/blob/main/README.md)) to provide clear instructions of required steps. ### Why? 1. The plugin template when installed via `npx create-payload-app` asks the user for a project name, however the exports from `importMap.js` do not get updated to the provided name. This throws errors when running the project and prevents it from building. 2. The `/dev` folder requires the `.env.example` to be copied and renamed to `.env` - the project will not run until this is done. The template lacks instructions that this is a required step. ### How? 1. Updates `packages/create-payload-app/src/lib/configure-plugin-project.ts` to read the `importMap.js` file and replace the placeholder plugin name with the name provided by the users. Adds a test to `packages/create-payload-app/src/lib/create-project.spec.ts` to verify that this file gets updated correctly. 2. Adds instructions on using this template to the `README.md` file, ensuring key steps (like adding the `.env` file) are clearly stated. Additional housekeeping updates: - Removed Jest and replaced it with Vitest for testing - Updated the base test approach to use Vitest instead of Jest - Removed `NextRESTClient` in favor of directly creating Request objects - Abstracted `getCustomEndpointHandler` function - Added ensureIndexes: true to the mongooseAdapter configuration - Removed the custom server from the dev folder - Updated the pnpm dev script to "dev": "next dev dev --turbo" - Removed `admin.autoLogin` Fixes #12198
2025-05-27 22:33:23 +01:00
"payload": "^3.37.0"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
},
"engines": {
templates: set pnpm engines to version 9 (#10979) pnpm v10 + sharp is having issues. Setting to v9 for now.
2025-02-04 10:49:33 -05:00
"node": "^18.20.2 || >=20.9.0",
chore: add logging templates script and fix engines for pnpm v10 (#12021) - Fixes issues with using pnpm v10 in some templates by allowing `^10` in engines as well - Added logging to the template generation script so we can debug the latest version being pulled by CI
2025-04-07 20:13:54 +01:00
"pnpm": "^9 || ^10"
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
},
templates: use `publishConfig` for the plugin template (#10196) Separates `exports`, `main`, `types` for publish / dev with `publishConfig` for the plugin template. Previously, you needed a `dist` folder to run payload bin scripts.
2024-12-27 17:22:25 +02:00
"publishConfig": {
"exports": {
".": {
fix(templates): plugin template correct paths for exports (#13427) When using plugin template , initial package.json settings is wrong. They point to non-existing files in exports folder ( index.ts , index.js, index.d.ts ) , which results in broken package if published (can't import your plugin from package) Fixes #13426
2025-08-19 16:10:18 +03:00
"import": "./dist/index.js",
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
templates: use `publishConfig` for the plugin template (#10196) Separates `exports`, `main`, `types` for publish / dev with `publishConfig` for the plugin template. Previously, you needed a `dist` folder to run payload bin scripts.
2024-12-27 17:22:25 +02:00
},
"./client": {
"import": "./dist/exports/client.js",
"types": "./dist/exports/client.d.ts",
"default": "./dist/exports/client.js"
},
"./rsc": {
"import": "./dist/exports/rsc.js",
"types": "./dist/exports/rsc.d.ts",
"default": "./dist/exports/rsc.js"
}
},
fix(templates): plugin template correct paths for exports (#13427) When using plugin template , initial package.json settings is wrong. They point to non-existing files in exports folder ( index.ts , index.js, index.d.ts ) , which results in broken package if published (can't import your plugin from package) Fixes #13426
2025-08-19 16:10:18 +03:00
"main": "./dist/index.js",
"types": "./dist/index.d.ts"
templates: use `publishConfig` for the plugin template (#10196) Separates `exports`, `main`, `types` for publish / dev with `publishConfig` for the plugin template. Previously, you needed a `dist` folder to run payload bin scripts.
2024-12-27 17:22:25 +02:00
},
templates: fix compatibility with pnpm 10 (#10830) Fixes https://github.com/payloadcms/payload/issues/10813 In pnpm 10 (which isn't "latest" yet), according to the [list of breaking changes](https://github.com/orgs/pnpm/discussions/8945): > Lifecycle scripts of dependencies are not executed during installation by default! This is a breaking change aimed at increasing security. In order to allow lifecycle scripts of specific dependencies, they should be listed in the pnpm.onlyBuiltDependencies field of package.json The sharp package uses a script to install native binaries and so our templates don't run out of the box with pnpm 10.
2025-01-29 15:58:10 +02:00
"pnpm": {
"onlyBuiltDependencies": [
templates: fix pnpm 10 ignored build scripts warning (#12974) When using pnpm 10 to install any of our templates, the following warning is thrown: ![Screenshot 2025-06-29 at 13 23 28@2x](https://github.com/user-attachments/assets/450630f1-0455-48a0-96e9-516110b6146c) > Warning: Ignored build scripts: esbuild, unrs-resolver. Run "pnpm approve-builds" to pick which dependencies should be allowed to run scripts. This PR fixes this by adding those packages to `onlyBuiltDependencies`
2025-06-29 15:17:34 -07:00
"sharp",
"esbuild",
"unrs-resolver"
templates: fix compatibility with pnpm 10 (#10830) Fixes https://github.com/payloadcms/payload/issues/10813 In pnpm 10 (which isn't "latest" yet), according to the [list of breaking changes](https://github.com/orgs/pnpm/discussions/8945): > Lifecycle scripts of dependencies are not executed during installation by default! This is a breaking change aimed at increasing security. In order to allow lifecycle scripts of specific dependencies, they should be listed in the pnpm.onlyBuiltDependencies field of package.json The sharp package uses a script to install native binaries and so our templates don't run out of the box with pnpm 10.
2025-01-29 15:58:10 +02:00
]
},
feat: plugin template (#10150) Updates the plugin template and adds it to the monorepo Includes: * Integration testing setup * Adding custom client / server components via a plugin * The same building setup that we use for our plugins in the monorepo * `create-payload-app` dynamically configures the project based on the name:`dev/tsconfig.json`, `src/index.ts`, `dev/payload.config.ts` For example, from project name: `payload-plugin-cool` `src/index.ts`: ```ts export type PayloadPluginCoolConfig = { /** * List of collections to add a custom field */ collections?: Partial<Record<CollectionSlug, true>> disabled?: boolean } export const payloadPluginCool = (pluginOptions: PayloadPluginCoolConfig) => /// ... ``` `dev/tsconfig.json`: ```json { "extends": "../tsconfig.json", "exclude": [], "include": [ "**/*.ts", "**/*.tsx", "../src/**/*.ts", "../src/**/*.tsx", "next.config.mjs", ".next/types/**/*.ts" ], "compilerOptions": { "baseUrl": "./", "paths": { "@payload-config": [ "./payload.config.ts" ], "payload-plugin-cool": [ "../src/index.ts" ], "payload-plugin-cool/client": [ "../src/exports/client.ts" ], "payload-plugin-cool/rsc": [ "../src/exports/rsc.ts" ] }, "noEmit": true } } ``` `./dev/payload.config.ts` ``` import { payloadPluginCool } from 'payload-plugin-cool' /// plugins: [ payloadPluginCool({ collections: { posts: true, }, }), ], ``` Example of published plugin https://www.npmjs.com/package/payload-plugin-cool
2024-12-27 16:25:08 +02:00
"registry": "https://registry.npmjs.org/"
}
Reference in New Issue Copy Permalink