@ainsleydev/payload-helper 0.0.1 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ainsleydev/payload-helper",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"description": "Payload CMS utilities, collections and global types for ainsley.dev builds",
 	"license": "MIT",
 	"keywords": [
@@ -20,14 +20,15 @@
 		"url": "https://ainsley.dev"
 	},
 	"scripts": {
-		"publish": "npm publish --access public",
+		"release": "npm publish --access public",
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},
 	"dependencies": {
 		"@nouance/payload-better-fields-plugin": "^1.4.1",
-		"@payloadcms/richtext-slate": "^1.5.2",
+		"@payloadcms/richtext-slate": "beta",
+		"@payloadcms/richtext-lexical": "beta",
 		"json-schema": "^0.4.0",
-		"payload": "^2.18.3",
+		"payload": "beta",
 		"pluralize": "^8.0.0"
 	},
 	"devDependencies": {

package/src/collections/Media.ts

@@ -1,5 +1,5 @@
-// import { slateEditor } from '@payloadcms/richtext-slate';
-import type { CollectionConfig, Field } from 'payload/types';
+import type { CollectionConfig, Field } from 'payload';
+import { lexicalEditor } from '@payloadcms/richtext-lexical';
 
 /**
  * Media Collection Configuration
@@ -9,12 +9,34 @@ import type { CollectionConfig, Field } from 'payload/types';
  * @param additionalFields
  * @constructor
  */
-export const Media = (filePath: string, additionalFields?: Field[]): CollectionConfig => {
+export const Media = (additionalFields?: Field[]): CollectionConfig => {
 	return {
 		slug: 'media',
+		access: {
+			read: () => true,
+		},
+		fields: [
+			{
+				name: 'alt',
+				type: 'text',
+				required: true,
+			},
+			{
+				name: 'caption',
+				type: 'richText',
+				required: false,
+				editor: lexicalEditor({
+					features: ({ defaultFeatures }) => {
+						return defaultFeatures.filter((feature) => {
+							return feature.key === 'paragraph' || feature.key === 'link';
+						});
+					},
+				}),
+			},
+			...(additionalFields ? additionalFields : []),
+		],
 		upload: {
-			staticURL: '/media',
-			staticDir: filePath,
+			staticDir: 'media',
 			imageSizes: [
 				// Original Size (for WebP & Avif)
 				{
@@ -128,22 +150,5 @@ export const Media = (filePath: string, additionalFields?: Field[]): CollectionC
 				},
 			],
 		},
-		fields: [
-			{
-				name: 'alt',
-				type: 'text',
-				required: true,
-			},
-			{
-				name: 'caption',
-				type: 'richText',
-				// editor: slateEditor({
-				// 		admin: {
-				// 			elements: ['link'],
-				// 		},
-				// 	}),
-			},
-			...(additionalFields ? additionalFields : []),
-		],
 	};
 };

package/src/collections/Redirects.ts

@@ -1,4 +1,4 @@
-import type { CollectionConfig } from 'payload/types';
+import type { CollectionConfig } from 'payload';
 
 /**
  * Redirects Collection Configuration
@@ -10,49 +10,47 @@ import type { CollectionConfig } from 'payload/types';
  */
 export const Redirects = (overrides?: Partial<CollectionConfig>): CollectionConfig => {
 	return {
-		...{
-			slug: 'redirects',
-			admin: {
-				useAsTitle: 'from',
-			},
-			fields: [
-				{
-					name: 'from',
-					type: 'text',
-					label: 'From URL',
-					required: true,
-					index: true,
-					admin: {
-						description: 'The URL you want to redirect from, ensure it starts with a /',
-					},
-				},
-				{
-					name: 'to',
-					type: 'text',
-					label: 'Destination URL',
-					required: true,
-					admin: {
-						description:
-							'The URL you want to redirect to, can be a relative or absolute URL',
-					},
+		slug: 'redirects',
+		admin: {
+			useAsTitle: 'from',
+		},
+		fields: [
+			{
+				name: 'from',
+				type: 'text',
+				label: 'From URL',
+				required: true,
+				index: true,
+				admin: {
+					description: 'The URL you want to redirect from, ensure it starts with a /',
 				},
-				{
-					name: 'code',
-					type: 'select',
-					label: 'Redirect Code',
-					required: true,
-					defaultValue: '301',
-					options: [
-						{ label: '301 - Permanent', value: '301' },
-						{ label: '302 - Temporary', value: '302' },
-						{ label: '307 - Temporary Redirect', value: '307' },
-						{ label: '308 - Permanent Redirect', value: '308' },
-						{ label: '410 - Content Deleted', value: '410' },
-						{ label: '451 - Unavailable For Legal Reasons', value: '451' },
-					],
+			},
+			{
+				name: 'to',
+				type: 'text',
+				label: 'Destination URL',
+				required: true,
+				admin: {
+					description:
+						'The URL you want to redirect to, can be a relative or absolute URL',
 				},
-			],
-		},
+			},
+			{
+				name: 'code',
+				type: 'select',
+				label: 'Redirect Code',
+				required: true,
+				defaultValue: '301',
+				options: [
+					{ label: '301 - Permanent', value: '301' },
+					{ label: '302 - Temporary', value: '302' },
+					{ label: '307 - Temporary Redirect', value: '307' },
+					{ label: '308 - Permanent Redirect', value: '308' },
+					{ label: '410 - Content Deleted', value: '410' },
+					{ label: '451 - Unavailable For Legal Reasons', value: '451' },
+				],
+			},
+		],
 		...(overrides ? overrides : {}),
 	};
 };

package/src/common/SEO.ts

@@ -1,4 +1,4 @@
-import { Field } from 'payload/types';
+import { Field } from 'payload';
 import { validateURL } from '../util/validation';
 
 /**

package/src/endpoints/slug.ts

@@ -1,4 +1,4 @@
-import { PayloadHandler } from 'payload/config';
+import { PayloadHandler, PayloadRequest } from 'payload';
 
 /**
  * Find a document in the given collection by its slug.
@@ -6,25 +6,27 @@ import { PayloadHandler } from 'payload/config';
  * @param collection
  */
 export const findBySlug = (collection: string): PayloadHandler => {
-	return async (req, res) => {
+	return async (req: PayloadRequest): Promise<Response> => {
 		try {
 			const data = await req.payload.find({
 				collection,
 				where: {
 					slug: {
-						equals: req.params.slug,
+						equals: req.routeParams.slug,
 					},
 				},
 				limit: 1,
 			});
 			if (data.docs.length === 0) {
-				res.status(404).send({ error: 'not found' });
+				return new Response(JSON.stringify({ error: 'not found' }), { status: 404 });
 			} else {
-				res.status(200).send(data.docs[0]);
+				return new Response(JSON.stringify(data.docs[0]), { status: 200 });
 			}
 		} catch (error) {
 			console.error('Error occurred while fetching document:', error);
-			res.status(500).send({ error: 'Internal server error' });
+			return new Response(JSON.stringify({ error: 'Internal server error' }), {
+				status: 500,
+			});
 		}
 	};
 };

package/src/globals/Navigation.ts

@@ -1,4 +1,4 @@
-import type { Field, GlobalConfig, Tab } from 'payload/types';
+import type { GlobalConfig, Tab, Field, ArrayField } from 'payload';
 
 /**
  * Navigation Configuration for the header and footer
@@ -111,7 +111,7 @@ export const Navigation = (config?: NavigationConfig): GlobalConfig => {
 					],
 				},
 			],
-		},
+		} as ArrayField,
 	];
 
 	if (config?.includeFooter) {
@@ -141,7 +141,7 @@ export const Navigation = (config?: NavigationConfig): GlobalConfig => {
 					],
 				},
 			],
-		});
+		} as ArrayField);
 	}
 
 	return {
@@ -158,7 +158,7 @@ export const Navigation = (config?: NavigationConfig): GlobalConfig => {
 		fields: [
 			{
 				type: 'tabs',
-				tabs: [...tabs, ...(config.additionalTabs ? config.additionalTabs : [])],
+				tabs: [...tabs, ...(config?.additionalTabs ? config.additionalTabs : [])],
 			},
 		],
 	};

package/src/globals/Settings.ts

@@ -1,4 +1,4 @@
-import type { GlobalConfig, Tab } from 'payload/types';
+import type { GlobalConfig, GroupField, Tab, UploadField } from 'payload';
 import { validatePostcode, validateURL } from '../util/validation';
 import { languages } from './locales';
 import { countries } from './countries';
@@ -10,7 +10,7 @@ import { countries } from './countries';
  * @param additionalTabs
  * @constructor
  */
-export const Settings = (additionalTabs?: Tab[]): GlobalConfig => {
+export const Settings = (additionalTabs: Tab[]): GlobalConfig => {
 	return {
 		slug: 'settings',
 		typescript: {
@@ -83,7 +83,7 @@ export const Settings = (additionalTabs?: Tab[]): GlobalConfig => {
 									description:
 										'Add a logo for the website that will be displayed in the header & across the website.',
 								},
-							},
+							} as UploadField,
 							{
 								name: 'robots',
 								type: 'textarea',
@@ -164,7 +164,7 @@ export const Settings = (additionalTabs?: Tab[]): GlobalConfig => {
 										],
 									},
 								],
-							},
+							} as GroupField,
 							{
 								type: 'group',
 								name: 'address',
@@ -236,7 +236,7 @@ export const Settings = (additionalTabs?: Tab[]): GlobalConfig => {
 										],
 									},
 								],
-							},
+							} as GroupField,
 							{
 								type: 'group',
 								name: 'social',
@@ -307,7 +307,7 @@ export const Settings = (additionalTabs?: Tab[]): GlobalConfig => {
 										],
 									},
 								],
-							},
+							} as GroupField,
 						],
 					},
 					{

package/src/util/validation.ts

@@ -1,6 +1,4 @@
-import { Validate } from 'payload/dist/fields/config/types';
-
-export const validateURL: Validate<string> = async (value) => {
+export const validateURL = async (value) => {
 	if (!value) {
 		return true;
 	}
@@ -12,7 +10,7 @@ export const validateURL: Validate<string> = async (value) => {
 	}
 };
 
-export const validatePostcode: Validate<string> = async (value) => {
+export const validatePostcode = async (value) => {
 	if (!value) {
 		return true;
 	}