@ainsleydev/payload-helper 0.0.39 → 0.1.0

package/dist/types.d.ts

@@ -1,26 +1,172 @@
+import type { PartialEmailTheme } from '@ainsleydev/email-templates';
 import type { GlobalConfig, Tab } from 'payload';
+/**
+ * Configuration for the Settings global.
+ */
 export type SettingsConfig = {
+    /**
+     * Additional tabs to add to the Settings global.
+     */
     additionalTabs?: Tab[];
+    /**
+     * Function to override the entire Settings global configuration.
+     */
     override: (args: {
         config: GlobalConfig;
     }) => GlobalConfig;
 };
+/**
+ * Configuration for web server cache invalidation.
+ */
 export type WebServerConfig = {
+    /**
+     * Optional API key for authenticating cache invalidation requests.
+     */
     apiKey?: string;
+    /**
+     * Base URL of the web server.
+     */
     baseURL: string;
+    /**
+     * Endpoint path for cache invalidation.
+     */
     cacheEndpoint: string;
 };
+/**
+ * Configuration for the admin panel logo.
+ */
 export type AdminLogoConfig = {
+    /**
+     * Path to the logo image file.
+     */
     path: string;
+    /**
+     * Optional path to the dark mode logo image file.
+     */
     darkModePath?: string;
+    /**
+     * Optional width of the logo in pixels.
+     */
     width?: number;
+    /**
+     * Optional height of the logo in pixels.
+     */
     height?: number;
+    /**
+     * Optional alt text for the logo image.
+     */
     alt?: string;
+    /**
+     * Optional CSS class name for the logo.
+     */
     className?: string;
 };
+/**
+ * Configuration for the admin panel icon/favicon.
+ */
+export type AdminIconConfig = {
+    /**
+     * Path to the icon image file.
+     */
+    path: string;
+    /**
+     * Optional path to the dark mode icon image file.
+     */
+    darkModePath?: string;
+    /**
+     * Optional width of the icon in pixels.
+     */
+    width?: number;
+    /**
+     * Optional height of the icon in pixels.
+     */
+    height?: number;
+    /**
+     * Optional alt text for the icon image.
+     */
+    alt?: string;
+    /**
+     * Optional CSS class name for the icon.
+     */
+    className?: string;
+};
+/**
+ * Configuration for admin panel customization.
+ */
+export type AdminConfig = {
+    /**
+     * Optional logo configuration for the admin panel.
+     */
+    logo?: AdminLogoConfig;
+    /**
+     * Optional icon/favicon configuration for the admin panel.
+     */
+    icon?: AdminIconConfig;
+};
+/**
+ * Content overrides for customizing email template text.
+ */
+export type EmailContentOverrides = {
+    /**
+     * Optional preview text shown in email clients before opening.
+     */
+    previewText?: string;
+    /**
+     * Optional heading text displayed at the top of the email.
+     */
+    heading?: string;
+    /**
+     * Optional body text content of the email.
+     */
+    bodyText?: string;
+    /**
+     * Optional button text for the call-to-action button.
+     */
+    buttonText?: string;
+};
+/**
+ * Configuration for email templates used in authentication flows.
+ */
+export type EmailConfig = {
+    /**
+     * Optional front-end URL override for email links. If not provided, uses Payload's serverUrl.
+     */
+    frontEndUrl?: string;
+    /**
+     * Optional theme customization for email templates (colors, branding, etc.).
+     */
+    theme?: PartialEmailTheme;
+    /**
+     * Optional content overrides for the forgot password email template.
+     */
+    forgotPassword?: EmailContentOverrides;
+    /**
+     * Optional content overrides for the verify account email template.
+     */
+    verifyAccount?: EmailContentOverrides;
+};
+/**
+ * Main configuration object for the Payload Helper plugin.
+ */
 export type PayloadHelperPluginConfig = {
+    /**
+     * The name of the site, used throughout the admin panel and emails.
+     */
     siteName: string;
+    /**
+     * Optional settings global configuration.
+     */
     settings?: SettingsConfig;
+    /**
+     * Optional web server configuration for cache invalidation.
+     */
     webServer?: WebServerConfig;
-    adminLogo?: AdminLogoConfig;
+    /**
+     * Optional admin panel customization (logo, icon).
+     */
+    admin?: AdminConfig;
+    /**
+     * Optional email template configuration for authentication emails.
+     */
+    email?: EmailConfig;
 };

package/dist/types.js

@@ -1,4 +1,6 @@
 // import type { SEOPluginConfig } from "@payloadcms/plugin-seo/types";
-export { };
+/**
+ * Main configuration object for the Payload Helper plugin.
+ */ export { };
 
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["// import type { SEOPluginConfig } from \"@payloadcms/plugin-seo/types\";\nimport type { GlobalConfig, Tab, TextField, TextareaField, UploadField } from 'payload';\n// import type {SEOPluginConfig} from \"@payloadcms/plugin-seo/dist/types.js\";\n\nexport type SettingsConfig = {\n\tadditionalTabs?: Tab[];\n\toverride: (args: {\n\t\tconfig: GlobalConfig;\n\t}) => GlobalConfig;\n};\n\nexport type WebServerConfig = {\n\tapiKey?: string;\n\tbaseURL: string;\n\tcacheEndpoint: string;\n};\n\n// export type SEOConfig = Omit<SEOPluginConfig, 'uploadsCollection' | 'tabbedUI'>;\n//\n// export type S3Config = {\n// \tenabled: boolean;\n// \tbucket: string\n// \tconfig: AWS.S3ClientConfig;\n// }\n\nexport type AdminLogoConfig = {\n\tpath: string;\n\tdarkModePath?: string;\n\twidth?: number;\n\theight?: number;\n\talt?: string;\n\tclassName?: string;\n};\n\nexport type PayloadHelperPluginConfig = {\n\tsiteName: string;\n\tsettings?: SettingsConfig;\n\t// seo?: SEOConfig;\n\twebServer?: WebServerConfig;\n\tadminLogo?: AdminLogoConfig;\n};\n"],"names":[],"mappings":"AAAA,uEAAuE;AAkCvE,WAME"}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["// import type { SEOPluginConfig } from \"@payloadcms/plugin-seo/types\";\nimport type { PartialEmailTheme } from '@ainsleydev/email-templates';\nimport type { GlobalConfig, Tab, TextField, TextareaField, UploadField } from 'payload';\n// import type {SEOPluginConfig} from \"@payloadcms/plugin-seo/dist/types.js\";\n\n/**\n * Configuration for the Settings global.\n */\nexport type SettingsConfig = {\n\t/**\n\t * Additional tabs to add to the Settings global.\n\t */\n\tadditionalTabs?: Tab[];\n\t/**\n\t * Function to override the entire Settings global configuration.\n\t */\n\toverride: (args: {\n\t\tconfig: GlobalConfig;\n\t}) => GlobalConfig;\n};\n\n/**\n * Configuration for web server cache invalidation.\n */\nexport type WebServerConfig = {\n\t/**\n\t * Optional API key for authenticating cache invalidation requests.\n\t */\n\tapiKey?: string;\n\t/**\n\t * Base URL of the web server.\n\t */\n\tbaseURL: string;\n\t/**\n\t * Endpoint path for cache invalidation.\n\t */\n\tcacheEndpoint: string;\n};\n\n// export type SEOConfig = Omit<SEOPluginConfig, 'uploadsCollection' | 'tabbedUI'>;\n//\n// export type S3Config = {\n// \tenabled: boolean;\n// \tbucket: string\n// \tconfig: AWS.S3ClientConfig;\n// }\n\n/**\n * Configuration for the admin panel logo.\n */\nexport type AdminLogoConfig = {\n\t/**\n\t * Path to the logo image file.\n\t */\n\tpath: string;\n\t/**\n\t * Optional path to the dark mode logo image file.\n\t */\n\tdarkModePath?: string;\n\t/**\n\t * Optional width of the logo in pixels.\n\t */\n\twidth?: number;\n\t/**\n\t * Optional height of the logo in pixels.\n\t */\n\theight?: number;\n\t/**\n\t * Optional alt text for the logo image.\n\t */\n\talt?: string;\n\t/**\n\t * Optional CSS class name for the logo.\n\t */\n\tclassName?: string;\n};\n\n/**\n * Configuration for the admin panel icon/favicon.\n */\nexport type AdminIconConfig = {\n\t/**\n\t * Path to the icon image file.\n\t */\n\tpath: string;\n\t/**\n\t * Optional path to the dark mode icon image file.\n\t */\n\tdarkModePath?: string;\n\t/**\n\t * Optional width of the icon in pixels.\n\t */\n\twidth?: number;\n\t/**\n\t * Optional height of the icon in pixels.\n\t */\n\theight?: number;\n\t/**\n\t * Optional alt text for the icon image.\n\t */\n\talt?: string;\n\t/**\n\t * Optional CSS class name for the icon.\n\t */\n\tclassName?: string;\n};\n\n/**\n * Configuration for admin panel customization.\n */\nexport type AdminConfig = {\n\t/**\n\t * Optional logo configuration for the admin panel.\n\t */\n\tlogo?: AdminLogoConfig;\n\t/**\n\t * Optional icon/favicon configuration for the admin panel.\n\t */\n\ticon?: AdminIconConfig;\n};\n\n/**\n * Content overrides for customizing email template text.\n */\nexport type EmailContentOverrides = {\n\t/**\n\t * Optional preview text shown in email clients before opening.\n\t */\n\tpreviewText?: string;\n\t/**\n\t * Optional heading text displayed at the top of the email.\n\t */\n\theading?: string;\n\t/**\n\t * Optional body text content of the email.\n\t */\n\tbodyText?: string;\n\t/**\n\t * Optional button text for the call-to-action button.\n\t */\n\tbuttonText?: string;\n};\n\n/**\n * Configuration for email templates used in authentication flows.\n */\nexport type EmailConfig = {\n\t/**\n\t * Optional front-end URL override for email links. If not provided, uses Payload's serverUrl.\n\t */\n\tfrontEndUrl?: string;\n\n\t/**\n\t * Optional theme customization for email templates (colors, branding, etc.).\n\t */\n\ttheme?: PartialEmailTheme;\n\n\t/**\n\t * Optional content overrides for the forgot password email template.\n\t */\n\tforgotPassword?: EmailContentOverrides;\n\n\t/**\n\t * Optional content overrides for the verify account email template.\n\t */\n\tverifyAccount?: EmailContentOverrides;\n};\n\n/**\n * Main configuration object for the Payload Helper plugin.\n */\nexport type PayloadHelperPluginConfig = {\n\t/**\n\t * The name of the site, used throughout the admin panel and emails.\n\t */\n\tsiteName: string;\n\t/**\n\t * Optional settings global configuration.\n\t */\n\tsettings?: SettingsConfig;\n\t// seo?: SEOConfig;\n\t/**\n\t * Optional web server configuration for cache invalidation.\n\t */\n\twebServer?: WebServerConfig;\n\t/**\n\t * Optional admin panel customization (logo, icon).\n\t */\n\tadmin?: AdminConfig;\n\t/**\n\t * Optional email template configuration for authentication emails.\n\t */\n\temail?: EmailConfig;\n};\n"],"names":[],"mappings":"AAAA,uEAAuE;AAwKvE;;CAEC,GACD,WAsBE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ainsleydev/payload-helper",
-  "version": "0.0.39",
+  "version": "0.1.0",
   "description": "Payload CMS utilities, collections and global types for ainsley.dev builds",
   "license": "MIT",
   "type": "module",
@@ -23,6 +23,19 @@
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./dist/admin/components/*": {
+      "types": "./dist/admin/components/*.d.ts",
+      "import": "./dist/admin/components/*.js",
+      "default": "./dist/admin/components/*.js"
+    },
+    "./package.json": "./package.json"
+  },
   "bin": {
     "payload-helper": "bin.js"
   },
@@ -39,19 +52,20 @@
   "dependencies": {
     "@lexical/headless": "0.38.2",
     "@lexical/html": "0.38.2",
-    "@nouance/payload-better-fields-plugin": "^1.4.1",
+    "@nouance/payload-better-fields-plugin": "^2.0.2",
     "@payloadcms/db-sqlite": "3.63.0",
     "@payloadcms/plugin-form-builder": "3.63.0",
     "@payloadcms/plugin-seo": "3.63.0",
     "@payloadcms/richtext-lexical": "3.63.0",
     "@types/json-schema": "^7.0.15",
     "chalk": "^5.3.0",
-    "commander": "^12.1.0",
+    "commander": "^14.0.2",
     "dotenv": "^16.4.5",
-    "jsdom": "^24.1.1",
-    "lexical": "0.28.0",
-    "mime-types": "^2.1.35",
-    "payload": "3.63.0"
+    "jsdom": "^27.2.0",
+    "lexical": "0.38.2",
+    "mime-types": "^3.0.1",
+    "payload": "3.63.0",
+    "@ainsleydev/email-templates": "0.0.3"
   },
   "peerDependencies": {
     "@payloadcms/ui": "3.x",
@@ -59,23 +73,22 @@
     "react": "^18.0.0 || ^19.0.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
     "@payloadcms/ui": "3.63.0",
     "@swc/cli": "^0.7.8",
     "@swc/core": "^1.7.2",
-    "@types/jest": "^29.5.12",
-    "@types/jsdom": "^21.1.7",
-    "@types/mime-types": "^2.1.4",
+    "@types/jest": "^30.0.0",
+    "@types/jsdom": "^27.0.0",
+    "@types/mime-types": "^3.0.1",
     "@types/node": "^24.10.1",
     "@types/react": "^18.3.26",
-    "jest": "^29.7.0",
+    "jest": "^30.2.0",
     "json-schema": "^0.4.0",
     "next": "^16.0.1",
     "react": "^19.2.0",
     "rimraf": "6.1.0",
-    "ts-jest": "^29.2.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.4",
+    "vitest": "^2.0.5",
     "@ainsleydev/eslint-config": "0.0.9"
   },
   "engines": {
@@ -86,9 +99,9 @@
     "build": "pnpm clean && pnpm build:types && pnpm build:swc",
     "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
     "build:types": "tsc --emitDeclarationOnly --outDir dist",
-    "format": "biome format --write . --apply-unsafe --organise-imports",
+    "format": "biome check --write --unsafe .",
     "lint": "biome lint --write .",
     "clean": "rimraf {dist,*.tsbuildinfo}",
-    "test": "jest --passWithNoTests"
+    "test": "vitest run"
   }
 }

package/dist/plugin/logo.d.ts

@@ -1,6 +0,0 @@
-import type { Config } from 'payload';
-import type { AdminLogoConfig } from '../types.js';
-/**
- * Injects the admin Logo component into the Payload config.
- */
-export declare const injectAdminLogo: (config: Config, logoConfig: AdminLogoConfig, siteName: string) => Config;

package/dist/plugin/logo.js

@@ -1,26 +0,0 @@
-/**
- * Injects the admin Logo component into the Payload config.
- */ export const injectAdminLogo = (config, logoConfig, siteName)=>({
-        ...config,
-        admin: {
-            ...config.admin,
-            components: {
-                ...config.admin?.components,
-                graphics: {
-                    ...config.admin?.components?.graphics,
-                    Logo: {
-                        path: '@ainsleydev/payload-helper/dist/admin/components/Logo',
-                        exportName: 'Logo',
-                        clientProps: {
-                            config: {
-                                ...logoConfig,
-                                alt: logoConfig.alt || siteName
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    });
-
-//# sourceMappingURL=logo.js.map

package/dist/plugin/logo.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/plugin/logo.ts"],"sourcesContent":["import type { Config } from 'payload';\nimport type { AdminLogoConfig } from '../types.js';\n\n/**\n * Injects the admin Logo component into the Payload config.\n */\nexport const injectAdminLogo = (\n\tconfig: Config,\n\tlogoConfig: AdminLogoConfig,\n\tsiteName: string,\n): Config => ({\n\t...config,\n\tadmin: {\n\t\t...config.admin,\n\t\tcomponents: {\n\t\t\t...config.admin?.components,\n\t\t\tgraphics: {\n\t\t\t\t...config.admin?.components?.graphics,\n\t\t\t\tLogo: {\n\t\t\t\t\tpath: '@ainsleydev/payload-helper/dist/admin/components/Logo',\n\t\t\t\t\texportName: 'Logo',\n\t\t\t\t\tclientProps: {\n\t\t\t\t\t\tconfig: {\n\t\t\t\t\t\t\t...logoConfig,\n\t\t\t\t\t\t\talt: logoConfig.alt || siteName,\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n});\n"],"names":["injectAdminLogo","config","logoConfig","siteName","admin","components","graphics","Logo","path","exportName","clientProps","alt"],"mappings":"AAGA;;CAEC,GACD,OAAO,MAAMA,kBAAkB,CAC9BC,QACAC,YACAC,WACa,CAAA;QACb,GAAGF,MAAM;QACTG,OAAO;YACN,GAAGH,OAAOG,KAAK;YACfC,YAAY;gBACX,GAAGJ,OAAOG,KAAK,EAAEC,UAAU;gBAC3BC,UAAU;oBACT,GAAGL,OAAOG,KAAK,EAAEC,YAAYC,QAAQ;oBACrCC,MAAM;wBACLC,MAAM;wBACNC,YAAY;wBACZC,aAAa;4BACZT,QAAQ;gCACP,GAAGC,UAAU;gCACbS,KAAKT,WAAWS,GAAG,IAAIR;4BACxB;wBACD;oBACD;gBACD;YACD;QACD;IACD,CAAA,EAAG"}