fix: field schema map paths

.github/workflows/main.yml

@@ -239,6 +239,7 @@ jobs:
           - dashboard
           - joins
           - field-error-states
+          - field-paths
           - fields-relationship
           - fields__collections__Array
           - fields__collections__Blocks

packages/next/src/views/Version/RenderFieldsToDiff/buildVersionFields.tsx

@@ -304,8 +304,8 @@ const buildVersionField = ({
         field: tabAsField,
         index: tabIndex,
         parentIndexPath: indexPath,
-        parentPath,
-        parentSchemaPath,
+        parentPath: path,
+        parentSchemaPath: schemaPath,
       })
 
       let tabFieldsPermissions: SanitizedFieldsPermissions = undefined
@@ -340,11 +340,7 @@ const buildVersionField = ({
           parentIndexPath: isNamedTab ? '' : tabIndexPath,
           parentIsLocalized: parentIsLocalized || tab.localized,
           parentPath: isNamedTab ? tabPath : 'name' in field ? path : parentPath,
-          parentSchemaPath: isNamedTab
-            ? tabSchemaPath
-            : 'name' in field
-              ? schemaPath
-              : parentSchemaPath,
+          parentSchemaPath: tabSchemaPath,
           req,
           selectedLocales,
           versionFromSiblingData: 'name' in tab ? valueFrom?.[tab.name] : valueFrom,
@@ -396,7 +392,7 @@ const buildVersionField = ({
           parentIndexPath: 'name' in field ? '' : indexPath,
           parentIsLocalized: parentIsLocalized || field.localized,
           parentPath: ('name' in field ? path : parentPath) + '.' + i,
-          parentSchemaPath: 'name' in field ? schemaPath : parentSchemaPath,
+          parentSchemaPath: schemaPath,
           req,
           selectedLocales,
           versionFromSiblingData: fromRow,
@@ -424,7 +420,7 @@ const buildVersionField = ({
         parentIndexPath: 'name' in field ? '' : indexPath,
         parentIsLocalized: parentIsLocalized || ('localized' in field && field.localized),
         parentPath: 'name' in field ? path : parentPath,
-        parentSchemaPath: 'name' in field ? schemaPath : parentSchemaPath,
+        parentSchemaPath: schemaPath,
         req,
         selectedLocales,
         versionFromSiblingData: valueFrom as object,
@@ -502,7 +498,7 @@ const buildVersionField = ({
         parentIndexPath: 'name' in field ? '' : indexPath,
         parentIsLocalized: parentIsLocalized || ('localized' in field && field.localized),
         parentPath: ('name' in field ? path : parentPath) + '.' + i,
-        parentSchemaPath: ('name' in field ? schemaPath : parentSchemaPath) + '.' + toBlock.slug,
+        parentSchemaPath: schemaPath + '.' + toBlock.slug,
         req,
         selectedLocales,
         versionFromSiblingData: fromRow,

packages/payload/src/admin/forms/Form.ts

@@ -1,7 +1,7 @@
 import { type SupportedLanguages } from '@payloadcms/translations'
 
 import type { SanitizedDocumentPermissions } from '../../auth/types.js'
-import type { Field, Option, Validate } from '../../fields/config/types.js'
+import type { Field, Option, TabAsField, Validate } from '../../fields/config/types.js'
 import type { TypedLocale } from '../../index.js'
 import type { DocumentPreferences } from '../../preferences/types.js'
 import type { PayloadRequest, SelectType, Where } from '../../types/index.js'
@@ -60,7 +60,7 @@ export type FieldState = {
    * The fieldSchema may be part of the form state if `includeSchema: true` is passed to buildFormState.
    * This will never be in the form state of the client.
    */
-  fieldSchema?: Field
+  fieldSchema?: Field | TabAsField
   filterOptions?: FilterOptionsResult
   initialValue?: unknown
   /**

packages/payload/src/fields/config/types.ts

@@ -1951,7 +1951,7 @@ export type FieldWithManyClient = RelationshipFieldClient | SelectFieldClient
 export type FieldWithMaxDepth = RelationshipField | UploadField
 export type FieldWithMaxDepthClient = JoinFieldClient | RelationshipFieldClient | UploadFieldClient
 
-export function fieldHasSubFields<TField extends ClientField | Field>(
+export function fieldHasSubFields<TField extends ClientField | Field | TabAsField>(
   field: TField,
 ): field is TField & (TField extends ClientField ? FieldWithSubFieldsClient : FieldWithSubFields) {
   return (

packages/payload/src/fields/getFieldPaths.ts

@@ -1,7 +1,8 @@
+import type { ClientTab } from '../admin/types.js'
 import type { ClientField, Field, Tab, TabAsFieldClient } from './config/types.js'
 
 type Args = {
-  field: ClientField | Field | Tab | TabAsFieldClient
+  field: ClientField | ClientTab | Field | Tab | TabAsFieldClient
   index: number
   parentIndexPath: string
   parentPath: string
@@ -31,43 +32,17 @@ export function getFieldPaths({
   parentIndexPath,
   parentPath,
   parentSchemaPath,
-}: Args): FieldPaths {
-  if ('name' in field) {
-    return {
-      indexPath: `${parentIndexPath ? parentIndexPath + '-' : ''}${index}`,
-      path: `${parentPath ? parentPath + '.' : ''}${field.name}`,
-      schemaPath: `${parentSchemaPath ? parentSchemaPath + '.' : ''}${field.name}`,
-    }
-  }
-
-  const indexSuffix = `_index-${`${parentIndexPath ? parentIndexPath + '-' : ''}${index}`}`
-
-  return {
-    indexPath: `${parentIndexPath ? parentIndexPath + '-' : ''}${index}`,
-    path: `${parentPath ? parentPath + '.' : ''}${indexSuffix}`,
-    schemaPath: `${parentSchemaPath ? parentSchemaPath + '.' : ''}${indexSuffix}`,
-  }
-}
-
-/**
- * @deprecated - will be removed in 4.0. Use `getFieldPaths` instead.
- */
-export function getFieldPathsModified({
-  field,
-  index,
-  parentIndexPath,
-  parentPath,
-  parentSchemaPath,
 }: Args): FieldPaths {
   const parentPathSegments = parentPath.split('.')
 
-  const parentIsUnnamed = parentPathSegments[parentPathSegments.length - 1]!.startsWith('_index-')
+  const parentPathIsUnnamed =
+    parentPathSegments?.[parentPathSegments.length - 1]?.startsWith('_index-')
 
-  const parentWithoutIndex = parentIsUnnamed
+  const parentWithoutIndex = parentPathIsUnnamed
     ? parentPathSegments.slice(0, -1).join('.')
     : parentPath
 
-  const parentPathToUse = parentIsUnnamed ? parentWithoutIndex : parentPath
+  const parentPathToUse = parentPathIsUnnamed ? parentWithoutIndex : parentPath
 
   if ('name' in field) {
     return {
@@ -79,9 +54,16 @@ export function getFieldPathsModified({
 
   const indexSuffix = `_index-${`${parentIndexPath ? parentIndexPath + '-' : ''}${index}`}`
 
+  const parentSchemaPathSegments = parentSchemaPath.split('.')
+
+  const parentSchemaPathIsUnnamed =
+    parentSchemaPathSegments?.[parentSchemaPathSegments.length - 1]?.startsWith('_index-')
+
   return {
     indexPath: `${parentIndexPath ? parentIndexPath + '-' : ''}${index}`,
     path: `${parentPathToUse ? parentPathToUse + '.' : ''}${indexSuffix}`,
-    schemaPath: `${!parentIsUnnamed && parentSchemaPath ? parentSchemaPath + '.' : ''}${indexSuffix}`,
+    schemaPath: parentSchemaPathIsUnnamed
+      ? `${parentSchemaPath}-${index}`
+      : `${parentSchemaPath ? parentSchemaPath + '.' : ''}${indexSuffix}`,
   }
 }

packages/payload/src/fields/hooks/afterChange/promise.ts

@@ -7,7 +7,7 @@ import type { Block, Field, TabAsField } from '../../config/types.js'
 
 import { MissingEditorProp } from '../../../errors/index.js'
 import { fieldAffectsData, tabHasName } from '../../config/types.js'
-import { getFieldPathsModified as getFieldPaths } from '../../getFieldPaths.js'
+import { getFieldPaths } from '../../getFieldPaths.js'
 import { traverseFields } from './traverseFields.js'
 
 type Args = {

packages/payload/src/fields/hooks/afterRead/promise.ts

@@ -17,7 +17,7 @@ import { getBlockSelect } from '../../../utilities/getBlockSelect.js'
 import { stripUnselectedFields } from '../../../utilities/stripUnselectedFields.js'
 import { fieldAffectsData, fieldShouldBeLocalized, tabHasName } from '../../config/types.js'
 import { getDefaultValue } from '../../getDefaultValue.js'
-import { getFieldPathsModified as getFieldPaths } from '../../getFieldPaths.js'
+import { getFieldPaths } from '../../getFieldPaths.js'
 import { relationshipPopulationPromise } from './relationshipPopulationPromise.js'
 import { traverseFields } from './traverseFields.js'
 import { virtualFieldPopulationPromise } from './virtualFieldPopulationPromise.js'

packages/payload/src/fields/hooks/beforeChange/promise.ts

@@ -10,7 +10,7 @@ import { type RequestContext, validateBlocksFilterOptions } from '../../../index
 import { deepMergeWithSourceArrays } from '../../../utilities/deepMerge.js'
 import { getTranslatedLabel } from '../../../utilities/getTranslatedLabel.js'
 import { fieldAffectsData, fieldShouldBeLocalized, tabHasName } from '../../config/types.js'
-import { getFieldPathsModified as getFieldPaths } from '../../getFieldPaths.js'
+import { getFieldPaths } from '../../getFieldPaths.js'
 import { getExistingRowDoc } from './getExistingRowDoc.js'
 import { traverseFields } from './traverseFields.js'
 

packages/payload/src/fields/hooks/beforeDuplicate/promise.ts

@@ -4,7 +4,7 @@ import type { JsonObject, PayloadRequest } from '../../../types/index.js'
 import type { Block, Field, FieldHookArgs, TabAsField } from '../../config/types.js'
 
 import { fieldAffectsData, fieldShouldBeLocalized } from '../../config/types.js'
-import { getFieldPathsModified as getFieldPaths } from '../../getFieldPaths.js'
+import { getFieldPaths } from '../../getFieldPaths.js'
 import { traverseFields } from './traverseFields.js'
 
 type Args<T> = {

packages/payload/src/fields/hooks/beforeValidate/promise.ts

@@ -7,7 +7,7 @@ import type { Block, Field, TabAsField } from '../../config/types.js'
 
 import { MissingEditorProp } from '../../../errors/index.js'
 import { fieldAffectsData, tabHasName, valueIsValueWithRelation } from '../../config/types.js'
-import { getFieldPathsModified as getFieldPaths } from '../../getFieldPaths.js'
+import { getFieldPaths } from '../../getFieldPaths.js'
 import { getExistingRowDoc } from '../beforeChange/getExistingRowDoc.js'
 import { getFallbackValue } from './getFallbackValue.js'
 import { traverseFields } from './traverseFields.js'