d8a62b7022
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
39 lines
1.1 KiB
TypeScript
39 lines
1.1 KiB
TypeScript
import type { EmailAdapter, SendEmailOptions } from 'payload'
|
|
|
|
/**
|
|
* Logs all emails to stdout
|
|
*/
|
|
export const testEmailAdapter: EmailAdapter<void> = ({ payload }) => ({
|
|
name: 'test-email-adapter',
|
|
defaultFromAddress: 'dev@payloadcms.com',
|
|
defaultFromName: 'Payload Test',
|
|
sendEmail: async (message) => {
|
|
const stringifiedTo = getStringifiedToAddress(message)
|
|
const res = `Test email to: '${stringifiedTo}', Subject: '${message.subject}'`
|
|
payload.logger.info({ content: message, msg: res })
|
|
return Promise.resolve()
|
|
},
|
|
})
|
|
|
|
function getStringifiedToAddress(message: SendEmailOptions): string | undefined {
|
|
let stringifiedTo: string | undefined
|
|
|
|
if (typeof message.to === 'string') {
|
|
stringifiedTo = message.to
|
|
} else if (Array.isArray(message.to)) {
|
|
stringifiedTo = message.to
|
|
.map((to: { address: string } | string) => {
|
|
if (typeof to === 'string') {
|
|
return to
|
|
} else if (to.address) {
|
|
return to.address
|
|
}
|
|
return ''
|
|
})
|
|
.join(', ')
|
|
} else if (message.to?.address) {
|
|
stringifiedTo = message.to.address
|
|
}
|
|
return stringifiedTo
|
|
}
|