@ainsleydev/payload-helper 0.0.39 → 0.1.0

package/README.md

@@ -4,6 +4,169 @@ Payload Helper is a project designed to extend and enhance functionality for Pay
 project includes custom configurations, scripts, and utilities to streamline development and content
 management processes.
 
+## Installation
+
+```bash
+npm install @ainsleydev/payload-helper
+# or
+pnpm add @ainsleydev/payload-helper
+# or
+yarn add @ainsleydev/payload-helper
+```
+
+## Usage
+
+Add the plugin to your Payload configuration:
+
+```typescript
+import { payloadHelper } from '@ainsleydev/payload-helper'
+
+export default buildConfig({
+	plugins: [
+		payloadHelper({
+			siteName: 'My Site',
+			admin: {
+				logo: {
+					path: '/images/logo-light.svg',
+					darkModePath: '/images/logo-dark.svg',
+					width: 150,
+					height: 40,
+					alt: 'My Site Logo',
+					className: 'custom-logo-class',
+				},
+				icon: {
+					path: '/images/icon-light.svg',
+					darkModePath: '/images/icon-dark.svg',
+					width: 120,
+					height: 120,
+					alt: 'My Site Icon',
+					className: 'custom-icon-class',
+				},
+			},
+		}),
+	],
+})
+```
+
+## Configuration
+
+### Admin configuration
+
+The `admin` object contains configuration for admin UI customisation:
+
+#### Logo configuration
+
+The logo appears in the navigation area of the Payload admin dashboard.
+
+- `path` (required): Path to the logo image file
+- `darkModePath` (optional): Path to the logo for dark mode
+- `width` (optional): Logo width in pixels (default: 150)
+- `height` (optional): Logo height in pixels (default: 40)
+- `alt` (optional): Alt text for the logo (defaults to siteName)
+- `className` (optional): Custom CSS class name
+
+#### Icon configuration
+
+The icon appears in the top left corner of the Payload admin dashboard.
+
+- `path` (required): Path to the icon image file
+- `darkModePath` (optional): Path to the icon for dark mode
+- `width` (optional): Icon width in pixels (default: 120)
+- `height` (optional): Icon height in pixels (default: 120)
+- `alt` (optional): Alt text for the icon (defaults to siteName)
+- `className` (optional): Custom CSS class name
+
+### Web server configuration
+
+Configure cache invalidation for your web server:
+
+```typescript
+payloadHelper({
+	siteName: 'My Site',
+	webServer: {
+		apiKey: 'your-api-key',
+		baseURL: 'https://your-site.com',
+		cacheEndpoint: '/api/cache/purge',
+	},
+})
+```
+
+### Email configuration
+
+Configure branded email templates for Payload authentication flows. Automatically applies to all collections with `auth` enabled.
+
+```typescript
+payloadHelper({
+	siteName: 'My Site',
+	email: {
+		frontEndUrl: 'https://your-site.com', // Optional, defaults to Payload's serverURL
+		theme: {
+			branding: {
+				companyName: 'My Company',
+				logoUrl: 'https://your-site.com/logo.png',
+			},
+			colours: {
+				background: {
+					accent: '#ff5043',
+				},
+			},
+		},
+		forgotPassword: {
+			heading: 'Reset your password',
+			bodyText: 'Click the button below to reset your password.',
+			buttonText: 'Reset Password',
+		},
+		verifyAccount: {
+			heading: 'Welcome aboard',
+			bodyText: 'Please verify your email address.',
+			buttonText: 'Verify Email',
+		},
+	},
+})
+```
+
+#### Previewing emails
+
+Preview your emails with your actual branding directly from your Payload configuration:
+
+```bash
+npx payload-helper preview-emails
+```
+
+This command will:
+- Read your `payload.config.ts` to extract your email theme configuration
+- Generate preview templates with your actual branding
+- Launch a preview server at http://localhost:3000
+
+You can optionally specify a custom port:
+
+```bash
+npx payload-helper preview-emails --port 3001
+```
+
+The preview will show both ForgotPassword and VerifyAccount emails using your configured theme, frontEndUrl, and content overrides.
+
+## Utilities
+
+### Environment Variables
+
+The package exports an `env` utility object that provides access to environment variables required by Payload Helper.
+
+```typescript
+import { env } from '@ainsleydev/payload-helper'
+
+// Access environment variables
+const spaces = {
+	key: env.DO_SPACES_KEY,
+	secret: env.DO_SPACES_SECRET,
+	endpoint: env.DO_SPACES_ENDPOINT,
+	region: env.DO_SPACES_REGION,
+	bucket: env.DO_SPACES_BUCKET,
+}
+```
+
+**Note:** When using ESM modules, always import utilities from the main package entry point as shown above. Direct imports to subpaths (e.g., `@ainsleydev/payload-helper/dist/util/env`) are not supported.
+
 ## Open Source
 
 ainsley.dev permits the use of any HTML, SCSS and Javascript found within the repository for use

package/dist/admin/components/Icon.d.ts

@@ -0,0 +1,16 @@
+import type React from 'react';
+import type { AdminIconConfig } from '../../types.js';
+/**
+ * Props for the Icon component.
+ */
+export type IconProps = {
+    config: AdminIconConfig;
+};
+/**
+ * Icon component that displays a configurable icon with theme support.
+ * The icon appears in the top left corner of the Payload dashboard.
+ *
+ * @param {IconProps} props - Component props containing icon configuration
+ * @returns {React.ReactElement} Icon component
+ */
+export declare const Icon: React.FC<IconProps>;

package/dist/admin/components/Icon.js

@@ -0,0 +1,26 @@
+'use client';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useTheme } from '@payloadcms/ui';
+// @ts-expect-error - next/image is a peer dependency and will be available in consumer projects
+import Image from 'next/image';
+/**
+ * Icon component that displays a configurable icon with theme support.
+ * The icon appears in the top left corner of the Payload dashboard.
+ *
+ * @param {IconProps} props - Component props containing icon configuration
+ * @returns {React.ReactElement} Icon component
+ */ export const Icon = ({ config })=>{
+    const { theme } = useTheme();
+    const imagePath = theme === 'light' || !config.darkModePath ? config.path : config.darkModePath;
+    return /*#__PURE__*/ _jsx("figure", {
+        className: config.className ? config.className : undefined,
+        children: /*#__PURE__*/ _jsx(Image, {
+            src: imagePath,
+            alt: config.alt || 'Icon',
+            width: config.width || 120,
+            height: config.height || 120
+        })
+    });
+};
+
+//# sourceMappingURL=Icon.js.map

package/dist/admin/components/Icon.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/admin/components/Icon.tsx"],"sourcesContent":["'use client';\n\nimport { useTheme } from '@payloadcms/ui';\n// @ts-expect-error - next/image is a peer dependency and will be available in consumer projects\nimport Image from 'next/image';\nimport type React from 'react';\nimport type { AdminIconConfig } from '../../types.js';\n\n/**\n * Props for the Icon component.\n */\nexport type IconProps = {\n\tconfig: AdminIconConfig;\n};\n\n/**\n * Icon component that displays a configurable icon with theme support.\n * The icon appears in the top left corner of the Payload dashboard.\n *\n * @param {IconProps} props - Component props containing icon configuration\n * @returns {React.ReactElement} Icon component\n */\nexport const Icon: React.FC<IconProps> = ({ config }) => {\n\tconst { theme } = useTheme();\n\tconst imagePath = theme === 'light' || !config.darkModePath ? config.path : config.darkModePath;\n\n\treturn (\n\t\t<figure className={config.className ? config.className : undefined}>\n\t\t\t<Image\n\t\t\t\tsrc={imagePath}\n\t\t\t\talt={config.alt || 'Icon'}\n\t\t\t\twidth={config.width || 120}\n\t\t\t\theight={config.height || 120}\n\t\t\t/>\n\t\t</figure>\n\t);\n};\n"],"names":["useTheme","Image","Icon","config","theme","imagePath","darkModePath","path","figure","className","undefined","src","alt","width","height"],"mappings":"AAAA;;AAEA,SAASA,QAAQ,QAAQ,iBAAiB;AAC1C,gGAAgG;AAChG,OAAOC,WAAW,aAAa;AAW/B;;;;;;CAMC,GACD,OAAO,MAAMC,OAA4B,CAAC,EAAEC,MAAM,EAAE;IACnD,MAAM,EAAEC,KAAK,EAAE,GAAGJ;IAClB,MAAMK,YAAYD,UAAU,WAAW,CAACD,OAAOG,YAAY,GAAGH,OAAOI,IAAI,GAAGJ,OAAOG,YAAY;IAE/F,qBACC,KAACE;QAAOC,WAAWN,OAAOM,SAAS,GAAGN,OAAOM,SAAS,GAAGC;kBACxD,cAAA,KAACT;YACAU,KAAKN;YACLO,KAAKT,OAAOS,GAAG,IAAI;YACnBC,OAAOV,OAAOU,KAAK,IAAI;YACvBC,QAAQX,OAAOW,MAAM,IAAI;;;AAI7B,EAAE"}

package/dist/cli/bin.js

@@ -1,9 +1,29 @@
 #!/usr/bin/env node
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { Command } from 'commander';
+import { getPayload } from 'payload';
+import { previewEmails } from './commands/preview-emails.js';
 const program = new Command();
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
 program.command('generate-types').description('Generate JSON schema types for Payload CMS');
+program.command('preview-emails').description('Preview email templates with your Payload configuration').option('-p, --port <number>', 'Port to run preview server on', '3000').action(async (options)=>{
+    const payload = await getPayloadInstance();
+    await previewEmails({
+        payload,
+        port: Number.parseInt(options.port, 10)
+    });
+});
 export const bin = async ()=>{
     await program.parseAsync(process.argv);
 };
+const getPayloadInstance = async ()=>{
+    const configPath = path.join(process.cwd(), 'src/payload.config.ts');
+    const config = (await import(configPath)).default;
+    return await getPayload({
+        config
+    });
+};
 
 //# sourceMappingURL=bin.js.map

package/dist/cli/bin.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/cli/bin.ts"],"sourcesContent":["#!/usr/bin/env node\nimport chalk from 'chalk';\nimport { Command } from 'commander';\n\nconst program = new Command();\n\nprogram.command('generate-types').description('Generate JSON schema types for Payload CMS');\n\nexport const bin = async () => {\n\tawait program.parseAsync(process.argv);\n};\n"],"names":["Command","program","command","description","bin","parseAsync","process","argv"],"mappings":";AAEA,SAASA,OAAO,QAAQ,YAAY;AAEpC,MAAMC,UAAU,IAAID;AAEpBC,QAAQC,OAAO,CAAC,kBAAkBC,WAAW,CAAC;AAE9C,OAAO,MAAMC,MAAM;IAClB,MAAMH,QAAQI,UAAU,CAACC,QAAQC,IAAI;AACtC,EAAE"}
+{"version":3,"sources":["../../src/cli/bin.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from 'node:fs';\nimport path from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport { Command } from 'commander';\nimport { type Payload, getPayload } from 'payload';\nimport { previewEmails } from './commands/preview-emails.js';\n\nconst program = new Command();\nconst filename = fileURLToPath(import.meta.url);\nconst dirname = path.dirname(filename);\n\nprogram.command('generate-types').description('Generate JSON schema types for Payload CMS');\nprogram\n\t.command('preview-emails')\n\t.description('Preview email templates with your Payload configuration')\n\t.option('-p, --port <number>', 'Port to run preview server on', '3000')\n\t.action(async (options) => {\n\t\tconst payload = await getPayloadInstance();\n\n\t\tawait previewEmails({\n\t\t\tpayload,\n\t\t\tport: Number.parseInt(options.port, 10),\n\t\t});\n\t});\n\nexport const bin = async () => {\n\tawait program.parseAsync(process.argv);\n};\n\nconst getPayloadInstance = async (): Promise<Payload> => {\n\tconst configPath = path.join(process.cwd(), 'src/payload.config.ts');\n\tconst config = (await import(configPath)).default;\n\n\treturn await getPayload({ config });\n};\n"],"names":["path","fileURLToPath","Command","getPayload","previewEmails","program","filename","url","dirname","command","description","option","action","options","payload","getPayloadInstance","port","Number","parseInt","bin","parseAsync","process","argv","configPath","join","cwd","config","default"],"mappings":";AAEA,OAAOA,UAAU,YAAY;AAC7B,SAASC,aAAa,QAAQ,WAAW;AACzC,SAASC,OAAO,QAAQ,YAAY;AACpC,SAAuBC,UAAU,QAAQ,UAAU;AACnD,SAASC,aAAa,QAAQ,+BAA+B;AAE7D,MAAMC,UAAU,IAAIH;AACpB,MAAMI,WAAWL,cAAc,YAAYM,GAAG;AAC9C,MAAMC,UAAUR,KAAKQ,OAAO,CAACF;AAE7BD,QAAQI,OAAO,CAAC,kBAAkBC,WAAW,CAAC;AAC9CL,QACEI,OAAO,CAAC,kBACRC,WAAW,CAAC,2DACZC,MAAM,CAAC,uBAAuB,iCAAiC,QAC/DC,MAAM,CAAC,OAAOC;IACd,MAAMC,UAAU,MAAMC;IAEtB,MAAMX,cAAc;QACnBU;QACAE,MAAMC,OAAOC,QAAQ,CAACL,QAAQG,IAAI,EAAE;IACrC;AACD;AAED,OAAO,MAAMG,MAAM;IAClB,MAAMd,QAAQe,UAAU,CAACC,QAAQC,IAAI;AACtC,EAAE;AAEF,MAAMP,qBAAqB;IAC1B,MAAMQ,aAAavB,KAAKwB,IAAI,CAACH,QAAQI,GAAG,IAAI;IAC5C,MAAMC,SAAS,AAAC,CAAA,MAAM,MAAM,CAACH,WAAU,EAAGI,OAAO;IAEjD,OAAO,MAAMxB,WAAW;QAAEuB;IAAO;AAClC"}

package/dist/cli/commands/preview-emails.d.ts

@@ -0,0 +1,5 @@
+import type { Payload } from 'payload';
+export declare const previewEmails: (options: {
+    payload: Payload;
+    port?: number;
+}) => Promise<void>;

package/dist/cli/commands/preview-emails.js

@@ -0,0 +1,123 @@
+import { spawn } from 'node:child_process';
+import { mkdirSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import chalk from 'chalk';
+/**
+ * Escapes a string for safe use in template literals.
+ */ const escapeForTemplate = (str)=>{
+    return str.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\$/g, '\\$');
+};
+/**
+ * Retrieves the email configuration from the Payload config.
+ */ const getEmailConfig = (payload)=>{
+    const custom = payload.config.custom;
+    const payloadHelperOptions = custom?.payloadHelperOptions;
+    return payloadHelperOptions?.email;
+};
+export const previewEmails = async (options)=>{
+    const port = options.port || 3000;
+    const payload = options.payload;
+    console.log(chalk.blue('🔍 Looking for email configuration...'));
+    // Get email config from stored plugin options
+    const emailConfig = getEmailConfig(payload);
+    if (!emailConfig) {
+        console.log(chalk.yellow('⚠️  No email configuration found'));
+        console.log(chalk.yellow('   Make sure you have configured email in your payloadHelper plugin:\n'));
+        console.log(chalk.cyan(`   payloadHelper({
+     email: {
+       theme: { /* ... */ },
+       frontEndUrl: 'https://yoursite.com',
+     }
+   })`));
+        console.log(chalk.yellow('\n   Using default theme for email previews'));
+    } else {
+        console.log(chalk.green('✓ Found email configuration'));
+    }
+    // Create temp directory for preview files
+    const tempDir = join(tmpdir(), `payload-helper-preview-${Date.now()}-${process.pid}`);
+    mkdirSync(tempDir, {
+        recursive: true
+    });
+    console.log(chalk.blue('📝 Generating preview templates...'));
+    // Extract theme and frontEndUrl
+    const themeConfig = emailConfig?.theme ? JSON.stringify(emailConfig.theme, null, 2) : '{}';
+    const frontEndUrl = emailConfig?.frontEndUrl || 'https://yoursite.com';
+    // Safely escape the frontEndUrl for use in template strings
+    const escapedFrontEndUrl = escapeForTemplate(frontEndUrl);
+    // Generate ForgotPassword preview
+    const forgotPasswordContent = emailConfig?.forgotPassword ? JSON.stringify(emailConfig.forgotPassword, null, 3) : 'undefined';
+    const forgotPasswordPreview = `import { renderEmail } from '@ainsleydev/email-templates';
+import { ForgotPasswordEmail } from '@ainsleydev/payload-helper';
+
+export default async function render() {
+	return renderEmail({
+		component: ForgotPasswordEmail,
+		props: {
+			user: { firstName: 'John', email: 'john@example.com' },
+			resetUrl: \`${escapedFrontEndUrl}/admin/reset/token123\`,
+			content: ${forgotPasswordContent},
+		},
+		theme: ${themeConfig},
+	});
+}
+`;
+    // Generate VerifyAccount preview
+    const verifyAccountContent = emailConfig?.verifyAccount ? JSON.stringify(emailConfig.verifyAccount, null, 3) : 'undefined';
+    const verifyAccountPreview = `import { renderEmail } from '@ainsleydev/email-templates';
+import { VerifyAccountEmail } from '@ainsleydev/payload-helper';
+
+export default async function render() {
+	return renderEmail({
+		component: VerifyAccountEmail,
+		props: {
+			user: { firstName: 'John', email: 'john@example.com' },
+			verifyUrl: \`${escapedFrontEndUrl}/admin/verify/token123\`,
+			content: ${verifyAccountContent},
+		},
+		theme: ${themeConfig},
+	});
+}
+`;
+    // Write preview files
+    writeFileSync(join(tempDir, 'forgot-password-email-preview.tsx'), forgotPasswordPreview);
+    writeFileSync(join(tempDir, 'verify-account-email-preview.tsx'), verifyAccountPreview);
+    console.log(chalk.green('✓ Preview templates generated'));
+    console.log(chalk.blue(`🚀 Starting preview server on http://localhost:${port}...`));
+    // Launch email-templates preview
+    const previewProcess = spawn('npx', [
+        'email-templates',
+        'preview',
+        tempDir,
+        `--port=${port}`
+    ], {
+        stdio: 'inherit',
+        shell: true
+    });
+    // Cleanup on exit
+    const cleanup = ()=>{
+        console.log(chalk.blue('\n🧹 Cleaning up...'));
+        try {
+            rmSync(tempDir, {
+                recursive: true,
+                force: true
+            });
+            console.log(chalk.green('✓ Cleanup complete'));
+        } catch (error) {
+            console.error(chalk.red('❌ Error during cleanup:'), error);
+        }
+    };
+    previewProcess.on('exit', (code)=>{
+        cleanup();
+        process.exit(code || 0);
+    });
+    // Handle Ctrl+C
+    process.on('SIGINT', ()=>{
+        previewProcess.kill('SIGINT');
+    });
+    process.on('SIGTERM', ()=>{
+        previewProcess.kill('SIGTERM');
+    });
+};
+
+//# sourceMappingURL=preview-emails.js.map

package/dist/cli/commands/preview-emails.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/cli/commands/preview-emails.ts"],"sourcesContent":["import { spawn } from 'node:child_process';\nimport { mkdirSync, rmSync, writeFileSync } from 'node:fs';\nimport { tmpdir } from 'node:os';\nimport { join } from 'node:path';\nimport chalk from 'chalk';\nimport type { Payload } from 'payload';\nimport type { PayloadHelperPluginConfig } from '../../types.js';\n\n/**\n * Escapes a string for safe use in template literals.\n */\nconst escapeForTemplate = (str: string): string => {\n\treturn str.replace(/\\\\/g, '\\\\\\\\').replace(/`/g, '\\\\`').replace(/\\$/g, '\\\\$');\n};\n\n/**\n * Retrieves the email configuration from the Payload config.\n */\nconst getEmailConfig = (payload: Payload): PayloadHelperPluginConfig['email'] | undefined => {\n\tconst custom = payload.config.custom as Record<string, unknown> | undefined;\n\tconst payloadHelperOptions = custom?.payloadHelperOptions as\n\t\t| PayloadHelperPluginConfig\n\t\t| undefined;\n\treturn payloadHelperOptions?.email;\n};\n\nexport const previewEmails = async (options: { payload: Payload; port?: number }) => {\n\tconst port = options.port || 3000;\n\tconst payload = options.payload;\n\n\tconsole.log(chalk.blue('🔍 Looking for email configuration...'));\n\n\t// Get email config from stored plugin options\n\tconst emailConfig = getEmailConfig(payload);\n\n\tif (!emailConfig) {\n\t\tconsole.log(chalk.yellow('⚠️  No email configuration found'));\n\t\tconsole.log(\n\t\t\tchalk.yellow('   Make sure you have configured email in your payloadHelper plugin:\\n'),\n\t\t);\n\t\tconsole.log(\n\t\t\tchalk.cyan(`   payloadHelper({\n     email: {\n       theme: { /* ... */ },\n       frontEndUrl: 'https://yoursite.com',\n     }\n   })`),\n\t\t);\n\t\tconsole.log(chalk.yellow('\\n   Using default theme for email previews'));\n\t} else {\n\t\tconsole.log(chalk.green('✓ Found email configuration'));\n\t}\n\n\t// Create temp directory for preview files\n\tconst tempDir = join(tmpdir(), `payload-helper-preview-${Date.now()}-${process.pid}`);\n\tmkdirSync(tempDir, { recursive: true });\n\n\tconsole.log(chalk.blue('📝 Generating preview templates...'));\n\n\t// Extract theme and frontEndUrl\n\tconst themeConfig = emailConfig?.theme ? JSON.stringify(emailConfig.theme, null, 2) : '{}';\n\tconst frontEndUrl = emailConfig?.frontEndUrl || 'https://yoursite.com';\n\n\t// Safely escape the frontEndUrl for use in template strings\n\tconst escapedFrontEndUrl = escapeForTemplate(frontEndUrl);\n\n\t// Generate ForgotPassword preview\n\tconst forgotPasswordContent = emailConfig?.forgotPassword\n\t\t? JSON.stringify(emailConfig.forgotPassword, null, 3)\n\t\t: 'undefined';\n\n\tconst forgotPasswordPreview = `import { renderEmail } from '@ainsleydev/email-templates';\nimport { ForgotPasswordEmail } from '@ainsleydev/payload-helper';\n\nexport default async function render() {\n\treturn renderEmail({\n\t\tcomponent: ForgotPasswordEmail,\n\t\tprops: {\n\t\t\tuser: { firstName: 'John', email: 'john@example.com' },\n\t\t\tresetUrl: \\`${escapedFrontEndUrl}/admin/reset/token123\\`,\n\t\t\tcontent: ${forgotPasswordContent},\n\t\t},\n\t\ttheme: ${themeConfig},\n\t});\n}\n`;\n\n\t// Generate VerifyAccount preview\n\tconst verifyAccountContent = emailConfig?.verifyAccount\n\t\t? JSON.stringify(emailConfig.verifyAccount, null, 3)\n\t\t: 'undefined';\n\n\tconst verifyAccountPreview = `import { renderEmail } from '@ainsleydev/email-templates';\nimport { VerifyAccountEmail } from '@ainsleydev/payload-helper';\n\nexport default async function render() {\n\treturn renderEmail({\n\t\tcomponent: VerifyAccountEmail,\n\t\tprops: {\n\t\t\tuser: { firstName: 'John', email: 'john@example.com' },\n\t\t\tverifyUrl: \\`${escapedFrontEndUrl}/admin/verify/token123\\`,\n\t\t\tcontent: ${verifyAccountContent},\n\t\t},\n\t\ttheme: ${themeConfig},\n\t});\n}\n`;\n\n\t// Write preview files\n\twriteFileSync(join(tempDir, 'forgot-password-email-preview.tsx'), forgotPasswordPreview);\n\twriteFileSync(join(tempDir, 'verify-account-email-preview.tsx'), verifyAccountPreview);\n\n\tconsole.log(chalk.green('✓ Preview templates generated'));\n\tconsole.log(chalk.blue(`🚀 Starting preview server on http://localhost:${port}...`));\n\n\t// Launch email-templates preview\n\tconst previewProcess = spawn('npx', ['email-templates', 'preview', tempDir, `--port=${port}`], {\n\t\tstdio: 'inherit',\n\t\tshell: true,\n\t});\n\n\t// Cleanup on exit\n\tconst cleanup = () => {\n\t\tconsole.log(chalk.blue('\\n🧹 Cleaning up...'));\n\t\ttry {\n\t\t\trmSync(tempDir, { recursive: true, force: true });\n\t\t\tconsole.log(chalk.green('✓ Cleanup complete'));\n\t\t} catch (error) {\n\t\t\tconsole.error(chalk.red('❌ Error during cleanup:'), error);\n\t\t}\n\t};\n\n\tpreviewProcess.on('exit', (code) => {\n\t\tcleanup();\n\t\tprocess.exit(code || 0);\n\t});\n\n\t// Handle Ctrl+C\n\tprocess.on('SIGINT', () => {\n\t\tpreviewProcess.kill('SIGINT');\n\t});\n\n\tprocess.on('SIGTERM', () => {\n\t\tpreviewProcess.kill('SIGTERM');\n\t});\n};\n"],"names":["spawn","mkdirSync","rmSync","writeFileSync","tmpdir","join","chalk","escapeForTemplate","str","replace","getEmailConfig","payload","custom","config","payloadHelperOptions","email","previewEmails","options","port","console","log","blue","emailConfig","yellow","cyan","green","tempDir","Date","now","process","pid","recursive","themeConfig","theme","JSON","stringify","frontEndUrl","escapedFrontEndUrl","forgotPasswordContent","forgotPassword","forgotPasswordPreview","verifyAccountContent","verifyAccount","verifyAccountPreview","previewProcess","stdio","shell","cleanup","force","error","red","on","code","exit","kill"],"mappings":"AAAA,SAASA,KAAK,QAAQ,qBAAqB;AAC3C,SAASC,SAAS,EAAEC,MAAM,EAAEC,aAAa,QAAQ,UAAU;AAC3D,SAASC,MAAM,QAAQ,UAAU;AACjC,SAASC,IAAI,QAAQ,YAAY;AACjC,OAAOC,WAAW,QAAQ;AAI1B;;CAEC,GACD,MAAMC,oBAAoB,CAACC;IAC1B,OAAOA,IAAIC,OAAO,CAAC,OAAO,QAAQA,OAAO,CAAC,MAAM,OAAOA,OAAO,CAAC,OAAO;AACvE;AAEA;;CAEC,GACD,MAAMC,iBAAiB,CAACC;IACvB,MAAMC,SAASD,QAAQE,MAAM,CAACD,MAAM;IACpC,MAAME,uBAAuBF,QAAQE;IAGrC,OAAOA,sBAAsBC;AAC9B;AAEA,OAAO,MAAMC,gBAAgB,OAAOC;IACnC,MAAMC,OAAOD,QAAQC,IAAI,IAAI;IAC7B,MAAMP,UAAUM,QAAQN,OAAO;IAE/BQ,QAAQC,GAAG,CAACd,MAAMe,IAAI,CAAC;IAEvB,8CAA8C;IAC9C,MAAMC,cAAcZ,eAAeC;IAEnC,IAAI,CAACW,aAAa;QACjBH,QAAQC,GAAG,CAACd,MAAMiB,MAAM,CAAC;QACzBJ,QAAQC,GAAG,CACVd,MAAMiB,MAAM,CAAC;QAEdJ,QAAQC,GAAG,CACVd,MAAMkB,IAAI,CAAC,CAAC;;;;;KAKV,CAAC;QAEJL,QAAQC,GAAG,CAACd,MAAMiB,MAAM,CAAC;IAC1B,OAAO;QACNJ,QAAQC,GAAG,CAACd,MAAMmB,KAAK,CAAC;IACzB;IAEA,0CAA0C;IAC1C,MAAMC,UAAUrB,KAAKD,UAAU,CAAC,uBAAuB,EAAEuB,KAAKC,GAAG,GAAG,CAAC,EAAEC,QAAQC,GAAG,EAAE;IACpF7B,UAAUyB,SAAS;QAAEK,WAAW;IAAK;IAErCZ,QAAQC,GAAG,CAACd,MAAMe,IAAI,CAAC;IAEvB,gCAAgC;IAChC,MAAMW,cAAcV,aAAaW,QAAQC,KAAKC,SAAS,CAACb,YAAYW,KAAK,EAAE,MAAM,KAAK;IACtF,MAAMG,cAAcd,aAAac,eAAe;IAEhD,4DAA4D;IAC5D,MAAMC,qBAAqB9B,kBAAkB6B;IAE7C,kCAAkC;IAClC,MAAME,wBAAwBhB,aAAaiB,iBACxCL,KAAKC,SAAS,CAACb,YAAYiB,cAAc,EAAE,MAAM,KACjD;IAEH,MAAMC,wBAAwB,CAAC;;;;;;;;eAQjB,EAAEH,mBAAmB;YACxB,EAAEC,sBAAsB;;SAE3B,EAAEN,YAAY;;;AAGvB,CAAC;IAEA,iCAAiC;IACjC,MAAMS,uBAAuBnB,aAAaoB,gBACvCR,KAAKC,SAAS,CAACb,YAAYoB,aAAa,EAAE,MAAM,KAChD;IAEH,MAAMC,uBAAuB,CAAC;;;;;;;;gBAQf,EAAEN,mBAAmB;YACzB,EAAEI,qBAAqB;;SAE1B,EAAET,YAAY;;;AAGvB,CAAC;IAEA,sBAAsB;IACtB7B,cAAcE,KAAKqB,SAAS,sCAAsCc;IAClErC,cAAcE,KAAKqB,SAAS,qCAAqCiB;IAEjExB,QAAQC,GAAG,CAACd,MAAMmB,KAAK,CAAC;IACxBN,QAAQC,GAAG,CAACd,MAAMe,IAAI,CAAC,CAAC,+CAA+C,EAAEH,KAAK,GAAG,CAAC;IAElF,iCAAiC;IACjC,MAAM0B,iBAAiB5C,MAAM,OAAO;QAAC;QAAmB;QAAW0B;QAAS,CAAC,OAAO,EAAER,MAAM;KAAC,EAAE;QAC9F2B,OAAO;QACPC,OAAO;IACR;IAEA,kBAAkB;IAClB,MAAMC,UAAU;QACf5B,QAAQC,GAAG,CAACd,MAAMe,IAAI,CAAC;QACvB,IAAI;YACHnB,OAAOwB,SAAS;gBAAEK,WAAW;gBAAMiB,OAAO;YAAK;YAC/C7B,QAAQC,GAAG,CAACd,MAAMmB,KAAK,CAAC;QACzB,EAAE,OAAOwB,OAAO;YACf9B,QAAQ8B,KAAK,CAAC3C,MAAM4C,GAAG,CAAC,4BAA4BD;QACrD;IACD;IAEAL,eAAeO,EAAE,CAAC,QAAQ,CAACC;QAC1BL;QACAlB,QAAQwB,IAAI,CAACD,QAAQ;IACtB;IAEA,gBAAgB;IAChBvB,QAAQsB,EAAE,CAAC,UAAU;QACpBP,eAAeU,IAAI,CAAC;IACrB;IAEAzB,QAAQsB,EAAE,CAAC,WAAW;QACrBP,eAAeU,IAAI,CAAC;IACrB;AACD,EAAE"}

package/dist/email/ForgotPasswordEmail.d.ts

@@ -0,0 +1,38 @@
+import type { EmailTheme } from '@ainsleydev/email-templates';
+import * as React from 'react';
+/**
+ * Props for the ForgotPasswordEmail component.
+ */
+export interface ForgotPasswordEmailProps {
+    /**
+     * The email theme (required by renderEmail).
+     */
+    theme: EmailTheme;
+    /**
+     * The user object containing user information.
+     */
+    user: {
+        firstName?: string;
+        email?: string;
+    };
+    /**
+     * The URL for resetting the password.
+     */
+    resetUrl: string;
+    /**
+     * Optional content overrides.
+     */
+    content?: {
+        previewText?: string;
+        heading?: string;
+        bodyText?: string;
+        buttonText?: string;
+    };
+}
+/**
+ * Email template for password reset requests in Payload CMS.
+ *
+ * @param props - The component props
+ * @returns The rendered email component
+ */
+export declare const ForgotPasswordEmail: ({ theme, user, resetUrl, content, }: ForgotPasswordEmailProps) => React.JSX.Element;

package/dist/email/ForgotPasswordEmail.js

@@ -0,0 +1,61 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { BaseEmail, Button, Heading, Section, Text } from '@ainsleydev/email-templates';
+import * as React from 'react';
+/**
+ * Email template for password reset requests in Payload CMS.
+ *
+ * @param props - The component props
+ * @returns The rendered email component
+ */ export const ForgotPasswordEmail = ({ theme, user, resetUrl, content })=>{
+    const userName = user.firstName || user.email || 'there';
+    const previewText = content?.previewText || 'Reset your password';
+    const heading = content?.heading || `Hello, ${userName}!`;
+    const bodyText = content?.bodyText || 'We received a request to reset your password, please click the button below. If you did not request a password reset, you can safely ignore this email.';
+    const buttonText = content?.buttonText || 'Reset Password';
+    return /*#__PURE__*/ _jsxs(BaseEmail, {
+        theme: theme,
+        previewText: previewText,
+        children: [
+            /*#__PURE__*/ _jsx(Heading, {
+                style: {
+                    color: theme.colours.text.heading,
+                    fontSize: '24px',
+                    fontWeight: 'bold',
+                    marginBottom: '20px'
+                },
+                children: heading
+            }),
+            /*#__PURE__*/ _jsx(Text, {
+                style: {
+                    color: theme.colours.text.body,
+                    fontSize: '16px',
+                    lineHeight: '24px',
+                    marginBottom: '30px'
+                },
+                children: bodyText
+            }),
+            /*#__PURE__*/ _jsx(Section, {
+                style: {
+                    textAlign: 'center',
+                    marginBottom: '30px'
+                },
+                children: /*#__PURE__*/ _jsx(Button, {
+                    href: resetUrl,
+                    style: {
+                        backgroundColor: theme.colours.background.accent,
+                        color: theme.colours.text.heading,
+                        padding: '12px 32px',
+                        borderRadius: '5px',
+                        fontSize: '16px',
+                        fontWeight: 'bold',
+                        textDecoration: 'none',
+                        display: 'inline-block'
+                    },
+                    children: buttonText
+                })
+            })
+        ]
+    });
+};
+
+//# sourceMappingURL=ForgotPasswordEmail.js.map

package/dist/email/ForgotPasswordEmail.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/email/ForgotPasswordEmail.tsx"],"sourcesContent":["import { BaseEmail, Button, Heading, Section, Text } from '@ainsleydev/email-templates';\nimport type { EmailTheme } from '@ainsleydev/email-templates';\nimport * as React from 'react';\n\n/**\n * Props for the ForgotPasswordEmail component.\n */\nexport interface ForgotPasswordEmailProps {\n\t/**\n\t * The email theme (required by renderEmail).\n\t */\n\ttheme: EmailTheme;\n\n\t/**\n\t * The user object containing user information.\n\t */\n\tuser: {\n\t\tfirstName?: string;\n\t\temail?: string;\n\t};\n\n\t/**\n\t * The URL for resetting the password.\n\t */\n\tresetUrl: string;\n\n\t/**\n\t * Optional content overrides.\n\t */\n\tcontent?: {\n\t\tpreviewText?: string;\n\t\theading?: string;\n\t\tbodyText?: string;\n\t\tbuttonText?: string;\n\t};\n}\n\n/**\n * Email template for password reset requests in Payload CMS.\n *\n * @param props - The component props\n * @returns The rendered email component\n */\nexport const ForgotPasswordEmail = ({\n\ttheme,\n\tuser,\n\tresetUrl,\n\tcontent,\n}: ForgotPasswordEmailProps) => {\n\tconst userName = user.firstName || user.email || 'there';\n\tconst previewText = content?.previewText || 'Reset your password';\n\tconst heading = content?.heading || `Hello, ${userName}!`;\n\tconst bodyText =\n\t\tcontent?.bodyText ||\n\t\t'We received a request to reset your password, please click the button below. If you did not request a password reset, you can safely ignore this email.';\n\tconst buttonText = content?.buttonText || 'Reset Password';\n\n\treturn (\n\t\t<BaseEmail theme={theme} previewText={previewText}>\n\t\t\t<Heading\n\t\t\t\tstyle={{\n\t\t\t\t\tcolor: theme.colours.text.heading,\n\t\t\t\t\tfontSize: '24px',\n\t\t\t\t\tfontWeight: 'bold',\n\t\t\t\t\tmarginBottom: '20px',\n\t\t\t\t}}\n\t\t\t>\n\t\t\t\t{heading}\n\t\t\t</Heading>\n\t\t\t<Text\n\t\t\t\tstyle={{\n\t\t\t\t\tcolor: theme.colours.text.body,\n\t\t\t\t\tfontSize: '16px',\n\t\t\t\t\tlineHeight: '24px',\n\t\t\t\t\tmarginBottom: '30px',\n\t\t\t\t}}\n\t\t\t>\n\t\t\t\t{bodyText}\n\t\t\t</Text>\n\t\t\t<Section style={{ textAlign: 'center', marginBottom: '30px' }}>\n\t\t\t\t<Button\n\t\t\t\t\thref={resetUrl}\n\t\t\t\t\tstyle={{\n\t\t\t\t\t\tbackgroundColor: theme.colours.background.accent,\n\t\t\t\t\t\tcolor: theme.colours.text.heading,\n\t\t\t\t\t\tpadding: '12px 32px',\n\t\t\t\t\t\tborderRadius: '5px',\n\t\t\t\t\t\tfontSize: '16px',\n\t\t\t\t\t\tfontWeight: 'bold',\n\t\t\t\t\t\ttextDecoration: 'none',\n\t\t\t\t\t\tdisplay: 'inline-block',\n\t\t\t\t\t}}\n\t\t\t\t>\n\t\t\t\t\t{buttonText}\n\t\t\t\t</Button>\n\t\t\t</Section>\n\t\t</BaseEmail>\n\t);\n};\n"],"names":["BaseEmail","Button","Heading","Section","Text","React","ForgotPasswordEmail","theme","user","resetUrl","content","userName","firstName","email","previewText","heading","bodyText","buttonText","style","color","colours","text","fontSize","fontWeight","marginBottom","body","lineHeight","textAlign","href","backgroundColor","background","accent","padding","borderRadius","textDecoration","display"],"mappings":";AAAA,SAASA,SAAS,EAAEC,MAAM,EAAEC,OAAO,EAAEC,OAAO,EAAEC,IAAI,QAAQ,8BAA8B;AAExF,YAAYC,WAAW,QAAQ;AAmC/B;;;;;CAKC,GACD,OAAO,MAAMC,sBAAsB,CAAC,EACnCC,KAAK,EACLC,IAAI,EACJC,QAAQ,EACRC,OAAO,EACmB;IAC1B,MAAMC,WAAWH,KAAKI,SAAS,IAAIJ,KAAKK,KAAK,IAAI;IACjD,MAAMC,cAAcJ,SAASI,eAAe;IAC5C,MAAMC,UAAUL,SAASK,WAAW,CAAC,OAAO,EAAEJ,SAAS,CAAC,CAAC;IACzD,MAAMK,WACLN,SAASM,YACT;IACD,MAAMC,aAAaP,SAASO,cAAc;IAE1C,qBACC,MAACjB;QAAUO,OAAOA;QAAOO,aAAaA;;0BACrC,KAACZ;gBACAgB,OAAO;oBACNC,OAAOZ,MAAMa,OAAO,CAACC,IAAI,CAACN,OAAO;oBACjCO,UAAU;oBACVC,YAAY;oBACZC,cAAc;gBACf;0BAECT;;0BAEF,KAACX;gBACAc,OAAO;oBACNC,OAAOZ,MAAMa,OAAO,CAACC,IAAI,CAACI,IAAI;oBAC9BH,UAAU;oBACVI,YAAY;oBACZF,cAAc;gBACf;0BAECR;;0BAEF,KAACb;gBAAQe,OAAO;oBAAES,WAAW;oBAAUH,cAAc;gBAAO;0BAC3D,cAAA,KAACvB;oBACA2B,MAAMnB;oBACNS,OAAO;wBACNW,iBAAiBtB,MAAMa,OAAO,CAACU,UAAU,CAACC,MAAM;wBAChDZ,OAAOZ,MAAMa,OAAO,CAACC,IAAI,CAACN,OAAO;wBACjCiB,SAAS;wBACTC,cAAc;wBACdX,UAAU;wBACVC,YAAY;wBACZW,gBAAgB;wBAChBC,SAAS;oBACV;8BAEClB;;;;;AAKN,EAAE"}

package/dist/email/ForgotPasswordEmail.test.d.ts

@@ -0,0 +1 @@
+export {};