Merge pull request #14 from ainsleyclark/fix/all-fields-override

refactor: Don't pass all fields in to overrides

Author: ainsleyclark

dev/int.spec.ts

@@ -111,5 +111,18 @@ describe('Plugin tests', () => {
 		const exists = globalFields.some((f) => f.name === 'extraSetting');
 		expect(exists).toBe(true);
 	});
+
+	it('hides default sitemap fields in admin', () => {
+		const fields = payload.collections['posts'].config.fields as FieldBase[];
+
+		const sitemapFields = ['sitemapPriority', 'excludeFromSitemap'];
+
+		sitemapFields.forEach(fieldName => {
+			const field = fields.find(f => f.name === fieldName);
+			expect(field).toBeDefined();
+			expect(field?.admin).toBeDefined();
+			expect(field?.admin?.hidden).toBe(true);
+		});
+	});
 });
 

dev/payload.config.ts

@@ -1,7 +1,7 @@
 import { mongooseAdapter } from '@payloadcms/db-mongodb';
 import { lexicalEditor } from '@payloadcms/richtext-lexical';
 import path from 'path';
-import { buildConfig } from 'payload';
+import { buildConfig, Field } from 'payload';
 import sharp from 'sharp';
 import { fileURLToPath } from 'url';
 
@@ -59,7 +59,12 @@ export default buildConfig({
 			collections: {
 				posts: {
 					fieldOverrides: ({ defaultFields }) => [
-						...defaultFields,
+						// Make all fields hidden in the UI for testing field overrides.
+						...defaultFields.map(f => ({
+							...f,
+							admin: { ...(f.admin || {}), hidden: true },
+						})) as Field[],
+						// Add a random field in to assert that one exists.
 						{
 							name: 'customSEO',
 							type: 'text',

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "payload-sitemap-plugin",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"description": "Payload Sitemap Plugin",
 	"license": "MIT",
 	"type": "module",

src/index.ts

@@ -51,20 +51,18 @@ export const sitemapPlugin = (pluginConfig: SitemapPluginConfig) => (config: Con
 			}
 
 			let defaultFields: Field[] = [
-				...(collection.fields || []),
 				SitemapPriority,
 				ExcludeFromSitemap,
 			];
 
-			// Apply per-collection field overrides if provided,
+			// Apply per-collection field overrides if provided.
 			const collConfig = pluginConfig.collections[collectionSlug];
 			if (typeof collConfig !== 'boolean' && collConfig?.fieldOverrides) {
-				defaultFields = collConfig.fieldOverrides({
-					defaultFields,
-				});
+				defaultFields = collConfig.fieldOverrides({ defaultFields });
 			}
 
-			collection.fields = defaultFields;
+			// Merge the sitemap fields into the collection without overwriting other fields.
+			collection.fields = [...(collection.fields || []), ...defaultFields];
 		}
 	}