refactor(plugin-mcp): reduced code and de-duplication (#15705)

This is a simple refactor to clean up code.

- No core CRUD tools were touched by this refactor other than a small
change to `convertCollectionSchemaToZod`
- Primarily experimental tools needing tidying that are used only when
experiments are enabled, and only in development node environments.

Author: kendelljoseph

packages/plugin-mcp/src/mcp/helpers/config.ts

@@ -1,10 +1,4 @@
-import type {
-  AdminConfig,
-  CollectionConfigUpdates,
-  DatabaseConfig,
-  GeneralConfig,
-  PluginUpdates,
-} from '../../types.js'
+import type { AdminConfig, DatabaseConfig, PluginUpdates } from '../../types.js'
 
 /**
  * Adds a collection to the payload.config.ts file
@@ -217,110 +211,3 @@ export function updatePluginsConfig(content: string, pluginUpdates: PluginUpdate
 
   return content
 }
-
-/**
- * Updates general configuration options in payload.config.ts
- */
-export function updateGeneralConfig(content: string, generalConfig: GeneralConfig): string {
-  // Update various general configuration options
-  Object.entries(generalConfig).forEach(([key, value]) => {
-    if (value !== undefined && value !== null) {
-      const configRegex = new RegExp(`${key}:\\s*[^,}]*`, 'g')
-
-      if (content.match(configRegex)) {
-        if (typeof value === 'string') {
-          content = content.replace(configRegex, `${key}: '${value}'`)
-        } else if (typeof value === 'boolean') {
-          content = content.replace(configRegex, `${key}: ${value}`)
-        } else if (typeof value === 'object') {
-          content = content.replace(configRegex, `${key}: ${JSON.stringify(value, null, 2)}`)
-        }
-      } else {
-        // Add new config option
-        const configValue =
-          typeof value === 'string'
-            ? `'${value}'`
-            : typeof value === 'object'
-              ? JSON.stringify(value, null, 2)
-              : value
-        content = content.replace(
-          /export default buildConfig\(\{/,
-          `export default buildConfig({\n  ${key}: ${configValue},`,
-        )
-      }
-    }
-  })
-
-  return content
-}
-
-/**
- * Updates collection-level configuration in a collection file
- */
-export function updateCollectionConfig(
-  content: string,
-  updates: CollectionConfigUpdates,
-  collectionName: string,
-): string {
-  let updatedContent = content
-
-  if (updates.slug) {
-    updatedContent = updatedContent.replace(/slug:\s*'[^']*'/, `slug: '${updates.slug}'`)
-  }
-
-  if (updates.access) {
-    const accessRegex = /access:\s*\{[^}]*\}/
-    if (updatedContent.match(accessRegex)) {
-      // Update existing access config
-      Object.entries(updates.access).forEach(([key, value]) => {
-        if (value !== undefined) {
-          updatedContent = updatedContent.replace(
-            new RegExp(`${key}:\\s*[^,}]*`),
-            `${key}: ${value}`,
-          )
-        }
-      })
-    } else {
-      // Add access config
-      const accessConfig = Object.entries(updates.access)
-        .filter(([, value]) => value !== undefined)
-        .map(([key, value]) => `    ${key}: ${value}`)
-        .join(',\n')
-
-      updatedContent = updatedContent.replace(
-        /slug:\s*'[^']*',/,
-        `slug: '${collectionName}',\n  access: {\n${accessConfig}\n  },`,
-      )
-    }
-  }
-
-  if (updates.timestamps !== undefined) {
-    if (updatedContent.includes('timestamps:')) {
-      updatedContent = updatedContent.replace(
-        /timestamps:[^,}]*/,
-        `timestamps: ${updates.timestamps}`,
-      )
-    } else {
-      updatedContent = updatedContent.replace(
-        /fields:\s*\[/,
-        `timestamps: ${updates.timestamps},\n  fields: [`,
-      )
-    }
-  }
-
-  if (updates.versioning !== undefined) {
-    if (updatedContent.includes('versioning:')) {
-      updatedContent = updatedContent.replace(
-        /versioning:[^,}]*/,
-        `versioning: ${updates.versioning}`,
-      )
-    } else {
-      updatedContent = updatedContent.replace(
-        /fields:\s*\[/,
-        `versioning: ${updates.versioning},\n  fields: [`,
-      )
-    }
-  }
-
-  return updatedContent
-}

packages/plugin-mcp/src/mcp/helpers/conversion.ts

@@ -1,21 +1,51 @@
-type FieldDefinition = {
-  description?: string
-  name: string
-  options?: { label: string; value: string }[]
-  position?: 'main' | 'sidebar'
-  required?: boolean
-  type: string
+import type { FieldDefinition, FieldModification } from '../../types.js'
+
+/** Escapes a value for safe embedding inside a single-quoted TypeScript string literal. */
+function escapeSingleQuotedString(value: string): string {
+  return value
+    .replace(/\\/g, '\\\\')
+    .replace(/'/g, "\\'")
+    .replace(/\r/g, '\\r')
+    .replace(/\n/g, '\\n')
 }
 
-type FieldModification = {
-  changes: {
-    description?: string
-    options?: { label: string; value: string }[]
-    position?: 'main' | 'sidebar'
-    required?: boolean
-    type?: string
+/**
+ * Generates the TypeScript source string for a single field definition block.
+ * Used when writing collection files to disk.
+ */
+export function generateFieldDefinitionString(field: FieldDefinition): string {
+  const lines: string[] = []
+  lines.push(`    {`)
+  lines.push(`      name: '${escapeSingleQuotedString(field.name)}',`)
+  lines.push(`      type: '${escapeSingleQuotedString(field.type)}',`)
+
+  if (field.required) {
+    lines.push(`      required: true,`)
+  }
+
+  if (field.description || field.position) {
+    lines.push(`      admin: {`)
+    if (field.description) {
+      lines.push(`        description: '${escapeSingleQuotedString(field.description)}',`)
+    }
+    if (field.position) {
+      lines.push(`        position: '${escapeSingleQuotedString(field.position)}',`)
+    }
+    lines.push(`      },`)
   }
-  fieldName: string
+
+  if (field.options && field.type === 'select') {
+    lines.push(`      options: [`)
+    field.options.forEach((option) => {
+      lines.push(
+        `        { label: '${escapeSingleQuotedString(option.label)}', value: '${escapeSingleQuotedString(option.value)}' },`,
+      )
+    })
+    lines.push(`      ],`)
+  }
+
+  lines.push(`    },`)
+  return lines.join('\n')
 }
 
 /**
@@ -30,41 +60,7 @@ export function addFieldsToCollection(content: string, newFields: FieldDefinitio
     throw new Error('Could not find fields array in collection file')
   }
 
-  // Generate new field definitions
-  const newFieldDefinitions = newFields
-    .map((field) => {
-      const fieldConfig = []
-      fieldConfig.push(`    {`)
-      fieldConfig.push(`      name: '${field.name}',`)
-      fieldConfig.push(`      type: '${field.type}',`)
-
-      if (field.required) {
-        fieldConfig.push(`      required: true,`)
-      }
-
-      if (field.description || field.position) {
-        fieldConfig.push(`      admin: {`)
-        if (field.description) {
-          fieldConfig.push(`        description: '${field.description}',`)
-        }
-        if (field.position) {
-          fieldConfig.push(`        position: '${field.position}',`)
-        }
-        fieldConfig.push(`      },`)
-      }
-
-      if (field.options && field.type === 'select') {
-        fieldConfig.push(`      options: [`)
-        field.options.forEach((option: { label: string; value: string }) => {
-          fieldConfig.push(`        { label: '${option.label}', value: '${option.value}' },`)
-        })
-        fieldConfig.push(`      ],`)
-      }
-
-      fieldConfig.push(`    },`)
-      return fieldConfig.join('\n')
-    })
-    .join('\n')
+  const newFieldDefinitions = newFields.map(generateFieldDefinitionString).join('\n')
 
   // Add new fields before the closing bracket
   const existingFields = match[1] || ''