@ainsleydev/payload-helper 0.0.39 → 0.0.40

package/README.md

@@ -4,6 +4,93 @@ 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',
+	},
+})
+```
+
 ## 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/index.d.ts

@@ -7,5 +7,6 @@ import type { PayloadHelperPluginConfig } from './types.js';
  * @param pluginOptions
  */
 export declare const payloadHelper: (pluginOptions: PayloadHelperPluginConfig) => (incomingConfig: Config) => Config;
+export type { IconProps } from './admin/components/Icon.js';
 export type { LogoProps } from './admin/components/Logo.js';
-export type { AdminLogoConfig, PayloadHelperPluginConfig } from './types.js';
+export type { AdminConfig, AdminIconConfig, AdminLogoConfig, PayloadHelperPluginConfig, } from './types.js';

package/dist/index.js

@@ -1,5 +1,5 @@
+import { injectAdminIcon, injectAdminLogo } from './plugin/admin.js';
 import { cacheHookCollections, cacheHookGlobals } from './plugin/hooks.js';
-import { injectAdminLogo } from './plugin/logo.js';
 /**
  * Payload Helper Plugin for websites at ainsley.dev
  *
@@ -11,9 +11,13 @@ import { injectAdminLogo } from './plugin/logo.js';
         // Update typescript generation file
         config.typescript = config.typescript || {};
         config.typescript.outputFile = './src/types/payload.ts';
-        // Inject admin Logo component if adminLogo config is provided
-        if (pluginOptions.adminLogo) {
-            config = injectAdminLogo(config, pluginOptions.adminLogo, pluginOptions.siteName);
+        // Inject admin Logo component if logo config is provided
+        if (pluginOptions.admin?.logo) {
+            config = injectAdminLogo(config, pluginOptions.admin.logo, pluginOptions.siteName);
+        }
+        // Inject admin Icon component if icon config is provided
+        if (pluginOptions.admin?.icon) {
+            config = injectAdminIcon(config, pluginOptions.admin.icon, pluginOptions.siteName);
         }
         // Map collections & add hooks
         config.collections = (config.collections || []).map((collection)=>{

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionConfig, Config } from 'payload';\nimport { cacheHookCollections, cacheHookGlobals } from './plugin/hooks.js';\nimport { injectAdminLogo } from './plugin/logo.js';\nimport type { PayloadHelperPluginConfig } from './types.js';\n\n/**\n * Payload Helper Plugin for websites at ainsley.dev\n *\n * @constructor\n * @param pluginOptions\n */\nexport const payloadHelper =\n\t(pluginOptions: PayloadHelperPluginConfig) =>\n\t(incomingConfig: Config): Config => {\n\t\t// TODO: Validate Config\n\n\t\tlet config = incomingConfig;\n\n\t\t// Update typescript generation file\n\t\tconfig.typescript = config.typescript || {};\n\t\tconfig.typescript.outputFile = './src/types/payload.ts';\n\n\t\t// Inject admin Logo component if adminLogo config is provided\n\t\tif (pluginOptions.adminLogo) {\n\t\t\tconfig = injectAdminLogo(config, pluginOptions.adminLogo, pluginOptions.siteName);\n\t\t}\n\n\t\t// Map collections & add hooks\n\t\tconfig.collections = (config.collections || []).map((collection): CollectionConfig => {\n\t\t\tif (collection.upload !== undefined && collection.upload !== true) {\n\t\t\t\treturn collection;\n\t\t\t}\n\n\t\t\tconst hooks = collection.hooks || {};\n\n\t\t\t// Add afterChange hook only if webServer is defined\n\t\t\tif (pluginOptions.webServer) {\n\t\t\t\thooks.afterChange = [\n\t\t\t\t\t...(hooks.afterChange || []),\n\t\t\t\t\tcacheHookCollections({\n\t\t\t\t\t\tserver: pluginOptions.webServer,\n\t\t\t\t\t\tslug: collection.slug,\n\t\t\t\t\t\tfields: collection.fields,\n\t\t\t\t\t\tisCollection: true,\n\t\t\t\t\t}),\n\t\t\t\t];\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\t...collection,\n\t\t\t\thooks,\n\t\t\t};\n\t\t});\n\n\t\t// Map globals & add hooks\n\t\tconfig.globals = (config.globals || []).map((global) => {\n\t\t\tconst hooks = global.hooks || {};\n\n\t\t\t// Add afterChange hook only if webServer is defined\n\t\t\tif (pluginOptions.webServer) {\n\t\t\t\thooks.afterChange = [\n\t\t\t\t\t...(hooks.afterChange || []),\n\t\t\t\t\tcacheHookGlobals({\n\t\t\t\t\t\tserver: pluginOptions.webServer,\n\t\t\t\t\t\tslug: global.slug,\n\t\t\t\t\t\tfields: global.fields,\n\t\t\t\t\t\tisCollection: true,\n\t\t\t\t\t}),\n\t\t\t\t];\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\t...global,\n\t\t\t\thooks,\n\t\t\t};\n\t\t});\n\n\t\treturn config;\n\t};\n\nexport type { LogoProps } from './admin/components/Logo.js';\nexport type { AdminLogoConfig, PayloadHelperPluginConfig } from './types.js';\n"],"names":["cacheHookCollections","cacheHookGlobals","injectAdminLogo","payloadHelper","pluginOptions","incomingConfig","config","typescript","outputFile","adminLogo","siteName","collections","map","collection","upload","undefined","hooks","webServer","afterChange","server","slug","fields","isCollection","globals","global"],"mappings":"AACA,SAASA,oBAAoB,EAAEC,gBAAgB,QAAQ,oBAAoB;AAC3E,SAASC,eAAe,QAAQ,mBAAmB;AAGnD;;;;;CAKC,GACD,OAAO,MAAMC,gBACZ,CAACC,gBACD,CAACC;QACA,wBAAwB;QAExB,IAAIC,SAASD;QAEb,oCAAoC;QACpCC,OAAOC,UAAU,GAAGD,OAAOC,UAAU,IAAI,CAAC;QAC1CD,OAAOC,UAAU,CAACC,UAAU,GAAG;QAE/B,8DAA8D;QAC9D,IAAIJ,cAAcK,SAAS,EAAE;YAC5BH,SAASJ,gBAAgBI,QAAQF,cAAcK,SAAS,EAAEL,cAAcM,QAAQ;QACjF;QAEA,8BAA8B;QAC9BJ,OAAOK,WAAW,GAAG,AAACL,CAAAA,OAAOK,WAAW,IAAI,EAAE,AAAD,EAAGC,GAAG,CAAC,CAACC;YACpD,IAAIA,WAAWC,MAAM,KAAKC,aAAaF,WAAWC,MAAM,KAAK,MAAM;gBAClE,OAAOD;YACR;YAEA,MAAMG,QAAQH,WAAWG,KAAK,IAAI,CAAC;YAEnC,oDAAoD;YACpD,IAAIZ,cAAca,SAAS,EAAE;gBAC5BD,MAAME,WAAW,GAAG;uBACfF,MAAME,WAAW,IAAI,EAAE;oBAC3BlB,qBAAqB;wBACpBmB,QAAQf,cAAca,SAAS;wBAC/BG,MAAMP,WAAWO,IAAI;wBACrBC,QAAQR,WAAWQ,MAAM;wBACzBC,cAAc;oBACf;iBACA;YACF;YAEA,OAAO;gBACN,GAAGT,UAAU;gBACbG;YACD;QACD;QAEA,0BAA0B;QAC1BV,OAAOiB,OAAO,GAAG,AAACjB,CAAAA,OAAOiB,OAAO,IAAI,EAAE,AAAD,EAAGX,GAAG,CAAC,CAACY;YAC5C,MAAMR,QAAQQ,OAAOR,KAAK,IAAI,CAAC;YAE/B,oDAAoD;YACpD,IAAIZ,cAAca,SAAS,EAAE;gBAC5BD,MAAME,WAAW,GAAG;uBACfF,MAAME,WAAW,IAAI,EAAE;oBAC3BjB,iBAAiB;wBAChBkB,QAAQf,cAAca,SAAS;wBAC/BG,MAAMI,OAAOJ,IAAI;wBACjBC,QAAQG,OAAOH,MAAM;wBACrBC,cAAc;oBACf;iBACA;YACF;YAEA,OAAO;gBACN,GAAGE,MAAM;gBACTR;YACD;QACD;QAEA,OAAOV;IACR,EAAE"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionConfig, Config } from 'payload';\nimport { injectAdminIcon, injectAdminLogo } from './plugin/admin.js';\nimport { cacheHookCollections, cacheHookGlobals } from './plugin/hooks.js';\nimport type { PayloadHelperPluginConfig } from './types.js';\n\n/**\n * Payload Helper Plugin for websites at ainsley.dev\n *\n * @constructor\n * @param pluginOptions\n */\nexport const payloadHelper =\n\t(pluginOptions: PayloadHelperPluginConfig) =>\n\t(incomingConfig: Config): Config => {\n\t\t// TODO: Validate Config\n\n\t\tlet config = incomingConfig;\n\n\t\t// Update typescript generation file\n\t\tconfig.typescript = config.typescript || {};\n\t\tconfig.typescript.outputFile = './src/types/payload.ts';\n\n\t\t// Inject admin Logo component if logo config is provided\n\t\tif (pluginOptions.admin?.logo) {\n\t\t\tconfig = injectAdminLogo(config, pluginOptions.admin.logo, pluginOptions.siteName);\n\t\t}\n\n\t\t// Inject admin Icon component if icon config is provided\n\t\tif (pluginOptions.admin?.icon) {\n\t\t\tconfig = injectAdminIcon(config, pluginOptions.admin.icon, pluginOptions.siteName);\n\t\t}\n\n\t\t// Map collections & add hooks\n\t\tconfig.collections = (config.collections || []).map((collection): CollectionConfig => {\n\t\t\tif (collection.upload !== undefined && collection.upload !== true) {\n\t\t\t\treturn collection;\n\t\t\t}\n\n\t\t\tconst hooks = collection.hooks || {};\n\n\t\t\t// Add afterChange hook only if webServer is defined\n\t\t\tif (pluginOptions.webServer) {\n\t\t\t\thooks.afterChange = [\n\t\t\t\t\t...(hooks.afterChange || []),\n\t\t\t\t\tcacheHookCollections({\n\t\t\t\t\t\tserver: pluginOptions.webServer,\n\t\t\t\t\t\tslug: collection.slug,\n\t\t\t\t\t\tfields: collection.fields,\n\t\t\t\t\t\tisCollection: true,\n\t\t\t\t\t}),\n\t\t\t\t];\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\t...collection,\n\t\t\t\thooks,\n\t\t\t};\n\t\t});\n\n\t\t// Map globals & add hooks\n\t\tconfig.globals = (config.globals || []).map((global) => {\n\t\t\tconst hooks = global.hooks || {};\n\n\t\t\t// Add afterChange hook only if webServer is defined\n\t\t\tif (pluginOptions.webServer) {\n\t\t\t\thooks.afterChange = [\n\t\t\t\t\t...(hooks.afterChange || []),\n\t\t\t\t\tcacheHookGlobals({\n\t\t\t\t\t\tserver: pluginOptions.webServer,\n\t\t\t\t\t\tslug: global.slug,\n\t\t\t\t\t\tfields: global.fields,\n\t\t\t\t\t\tisCollection: true,\n\t\t\t\t\t}),\n\t\t\t\t];\n\t\t\t}\n\n\t\t\treturn {\n\t\t\t\t...global,\n\t\t\t\thooks,\n\t\t\t};\n\t\t});\n\n\t\treturn config;\n\t};\n\nexport type { IconProps } from './admin/components/Icon.js';\nexport type { LogoProps } from './admin/components/Logo.js';\nexport type {\n\tAdminConfig,\n\tAdminIconConfig,\n\tAdminLogoConfig,\n\tPayloadHelperPluginConfig,\n} from './types.js';\n"],"names":["injectAdminIcon","injectAdminLogo","cacheHookCollections","cacheHookGlobals","payloadHelper","pluginOptions","incomingConfig","config","typescript","outputFile","admin","logo","siteName","icon","collections","map","collection","upload","undefined","hooks","webServer","afterChange","server","slug","fields","isCollection","globals","global"],"mappings":"AACA,SAASA,eAAe,EAAEC,eAAe,QAAQ,oBAAoB;AACrE,SAASC,oBAAoB,EAAEC,gBAAgB,QAAQ,oBAAoB;AAG3E;;;;;CAKC,GACD,OAAO,MAAMC,gBACZ,CAACC,gBACD,CAACC;QACA,wBAAwB;QAExB,IAAIC,SAASD;QAEb,oCAAoC;QACpCC,OAAOC,UAAU,GAAGD,OAAOC,UAAU,IAAI,CAAC;QAC1CD,OAAOC,UAAU,CAACC,UAAU,GAAG;QAE/B,yDAAyD;QACzD,IAAIJ,cAAcK,KAAK,EAAEC,MAAM;YAC9BJ,SAASN,gBAAgBM,QAAQF,cAAcK,KAAK,CAACC,IAAI,EAAEN,cAAcO,QAAQ;QAClF;QAEA,yDAAyD;QACzD,IAAIP,cAAcK,KAAK,EAAEG,MAAM;YAC9BN,SAASP,gBAAgBO,QAAQF,cAAcK,KAAK,CAACG,IAAI,EAAER,cAAcO,QAAQ;QAClF;QAEA,8BAA8B;QAC9BL,OAAOO,WAAW,GAAG,AAACP,CAAAA,OAAOO,WAAW,IAAI,EAAE,AAAD,EAAGC,GAAG,CAAC,CAACC;YACpD,IAAIA,WAAWC,MAAM,KAAKC,aAAaF,WAAWC,MAAM,KAAK,MAAM;gBAClE,OAAOD;YACR;YAEA,MAAMG,QAAQH,WAAWG,KAAK,IAAI,CAAC;YAEnC,oDAAoD;YACpD,IAAId,cAAce,SAAS,EAAE;gBAC5BD,MAAME,WAAW,GAAG;uBACfF,MAAME,WAAW,IAAI,EAAE;oBAC3BnB,qBAAqB;wBACpBoB,QAAQjB,cAAce,SAAS;wBAC/BG,MAAMP,WAAWO,IAAI;wBACrBC,QAAQR,WAAWQ,MAAM;wBACzBC,cAAc;oBACf;iBACA;YACF;YAEA,OAAO;gBACN,GAAGT,UAAU;gBACbG;YACD;QACD;QAEA,0BAA0B;QAC1BZ,OAAOmB,OAAO,GAAG,AAACnB,CAAAA,OAAOmB,OAAO,IAAI,EAAE,AAAD,EAAGX,GAAG,CAAC,CAACY;YAC5C,MAAMR,QAAQQ,OAAOR,KAAK,IAAI,CAAC;YAE/B,oDAAoD;YACpD,IAAId,cAAce,SAAS,EAAE;gBAC5BD,MAAME,WAAW,GAAG;uBACfF,MAAME,WAAW,IAAI,EAAE;oBAC3BlB,iBAAiB;wBAChBmB,QAAQjB,cAAce,SAAS;wBAC/BG,MAAMI,OAAOJ,IAAI;wBACjBC,QAAQG,OAAOH,MAAM;wBACrBC,cAAc;oBACf;iBACA;YACF;YAEA,OAAO;gBACN,GAAGE,MAAM;gBACTR;YACD;QACD;QAEA,OAAOZ;IACR,EAAE"}

package/dist/plugin/admin.d.ts

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

package/dist/plugin/admin.js

@@ -0,0 +1,50 @@
+/**
+ * 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
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    });
+/**
+ * Injects the admin Icon component into the Payload config.
+ */ export const injectAdminIcon = (config, iconConfig, siteName)=>({
+        ...config,
+        admin: {
+            ...config.admin,
+            components: {
+                ...config.admin?.components,
+                graphics: {
+                    ...config.admin?.components?.graphics,
+                    Icon: {
+                        path: '@ainsleydev/payload-helper/dist/admin/components/Icon',
+                        exportName: 'Icon',
+                        clientProps: {
+                            config: {
+                                ...iconConfig,
+                                alt: iconConfig.alt || siteName
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    });
+
+//# sourceMappingURL=admin.js.map

package/dist/plugin/admin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/plugin/admin.ts"],"sourcesContent":["import type { Config } from 'payload';\nimport type { AdminIconConfig, 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\n/**\n * Injects the admin Icon component into the Payload config.\n */\nexport const injectAdminIcon = (\n\tconfig: Config,\n\ticonConfig: AdminIconConfig,\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\tIcon: {\n\t\t\t\t\tpath: '@ainsleydev/payload-helper/dist/admin/components/Icon',\n\t\t\t\t\texportName: 'Icon',\n\t\t\t\t\tclientProps: {\n\t\t\t\t\t\tconfig: {\n\t\t\t\t\t\t\t...iconConfig,\n\t\t\t\t\t\t\talt: iconConfig.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","injectAdminIcon","iconConfig","Icon"],"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;AAEH;;CAEC,GACD,OAAO,MAAMS,kBAAkB,CAC9BX,QACAY,YACAV,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;oBACrCQ,MAAM;wBACLN,MAAM;wBACNC,YAAY;wBACZC,aAAa;4BACZT,QAAQ;gCACP,GAAGY,UAAU;gCACbF,KAAKE,WAAWF,GAAG,IAAIR;4BACxB;wBACD;oBACD;gBACD;YACD;QACD;IACD,CAAA,EAAG"}

package/dist/plugin/icon.d.ts

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

package/dist/plugin/icon.js

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

package/dist/plugin/icon.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/plugin/icon.ts"],"sourcesContent":["import type { Config } from 'payload';\nimport type { AdminIconConfig } from '../types.js';\n\n/**\n * Injects the admin Icon component into the Payload config.\n */\nexport const injectAdminIcon = (\n\tconfig: Config,\n\ticonConfig: AdminIconConfig,\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\tIcon: {\n\t\t\t\t\tpath: '@ainsleydev/payload-helper/dist/admin/components/Icon',\n\t\t\t\t\texportName: 'Icon',\n\t\t\t\t\tclientProps: {\n\t\t\t\t\t\tconfig: {\n\t\t\t\t\t\t\t...iconConfig,\n\t\t\t\t\t\t\talt: iconConfig.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":["injectAdminIcon","config","iconConfig","siteName","admin","components","graphics","Icon","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"}

package/dist/types.d.ts

@@ -18,9 +18,21 @@ export type AdminLogoConfig = {
     alt?: string;
     className?: string;
 };
+export type AdminIconConfig = {
+    path: string;
+    darkModePath?: string;
+    width?: number;
+    height?: number;
+    alt?: string;
+    className?: string;
+};
+export type AdminConfig = {
+    logo?: AdminLogoConfig;
+    icon?: AdminIconConfig;
+};
 export type PayloadHelperPluginConfig = {
     siteName: string;
     settings?: SettingsConfig;
     webServer?: WebServerConfig;
-    adminLogo?: AdminLogoConfig;
+    admin?: AdminConfig;
 };

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 { 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 AdminIconConfig = {\n\tpath: string;\n\tdarkModePath?: string;\n\twidth?: number;\n\theight?: number;\n\talt?: string;\n\tclassName?: string;\n};\n\nexport type AdminConfig = {\n\tlogo?: AdminLogoConfig;\n\ticon?: AdminIconConfig;\n};\n\nexport type PayloadHelperPluginConfig = {\n\tsiteName: string;\n\tsettings?: SettingsConfig;\n\t// seo?: SEOConfig;\n\twebServer?: WebServerConfig;\n\tadmin?: AdminConfig;\n};\n"],"names":[],"mappings":"AAAA,uEAAuE;AAgDvE,WAME"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ainsleydev/payload-helper",
-  "version": "0.0.39",
+  "version": "0.0.40",
   "description": "Payload CMS utilities, collections and global types for ainsley.dev builds",
   "license": "MIT",
   "type": "module",
@@ -86,7 +86,7 @@
     "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"