fix(ui): unflattening json objects containing keys with periods (#6839)

## Description

Fixes an issue where the `unflatten` function would also unflatten json
objects when they contained a `.` in one of their keys

V2 PR [here](#6834)

Author: PatrikKozak

packages/ui/package.json

@@ -111,7 +111,7 @@
     "bson-objectid": "2.0.4",
     "date-fns": "3.3.1",
     "deep-equal": "2.2.2",
-    "flatley": "5.2.0",
+    "is-buffer": "^2.0.5",
     "md5": "2.3.0",
     "object-to-formdata": "4.5.1",
     "qs": "6.11.2",

packages/ui/src/forms/Form/getDataByPath.ts

@@ -1,7 +1,6 @@
 import type { FormState } from 'payload'
 
-import flatleyImport from 'flatley'
-const { unflatten } = flatleyImport
+import { unflatten } from '../../utilities/unflatten.js'
 
 export const getDataByPath = <T = unknown>(fields: FormState, path: string): T => {
   const pathPrefixToRemove = path.substring(0, path.lastIndexOf('.') + 1)

packages/ui/src/forms/Form/getSiblingData.ts

@@ -1,9 +1,7 @@
 import type { Data, FormState } from 'payload'
 
-import flatleyImport from 'flatley'
-const { unflatten } = flatleyImport
-
 import { reduceFieldsToValues } from '../../utilities/reduceFieldsToValues.js'
+import { unflatten } from '../../utilities/unflatten.js'
 
 export const getSiblingData = (fields: FormState, path: string): Data => {
   if (!fields) return null
@@ -39,5 +37,5 @@ export const getSiblingData = (fields: FormState, path: string): Data => {
     }
   })
 
-  return unflatten(siblingFields, { safe: true })
+  return unflatten(siblingFields)
 }

packages/ui/src/utilities/reduceFieldsToValues.ts

@@ -1,7 +1,6 @@
 import type { Data, FormState } from 'payload'
 
-import flatleyImport from 'flatley'
-const { unflatten: flatleyUnflatten } = flatleyImport
+import { unflatten as flatleyUnflatten } from './unflatten.js'
 /**
  * Reduce flattened form fields (Fields) to just map to the respective values instead of the full FormField object
  *
@@ -25,7 +24,7 @@ export const reduceFieldsToValues = (
   })
 
   if (unflatten) {
-    data = flatleyUnflatten(data, { safe: true })
+    data = flatleyUnflatten(data)
   }
 
   return data

packages/ui/src/utilities/reduceFieldsToValuesWithValidation.ts

@@ -1,7 +1,6 @@
 import type { Data, FormState } from 'payload'
 
-import flatleyImport from 'flatley'
-const { unflatten: flatleyUnflatten } = flatleyImport
+import { unflatten as flatleyUnflatten } from './unflatten.js'
 
 type ReturnType = {
   data: Data
@@ -35,7 +34,7 @@ export const reduceFieldsToValuesWithValidation = (
   })
 
   if (unflatten) {
-    state.data = flatleyUnflatten(state.data, { safe: true })
+    state.data = flatleyUnflatten(state.data)
   }
 
   return state

packages/ui/src/utilities/unflatten.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2014, Hugh Kennedy
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+ * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import isBuffer from 'is-buffer'
+
+interface Opts {
+  delimiter?: string
+  object?: any
+  overwrite?: boolean
+  recursive?: boolean
+}
+
+export const unflatten = (target, opts?: Opts) => {
+  opts = opts || {}
+
+  const delimiter = opts.delimiter || '.'
+  const overwrite = opts.overwrite || false
+  const recursive = opts.recursive || false
+  const result = {}
+
+  const isbuffer = isBuffer(target)
+
+  if (isbuffer || Object.prototype.toString.call(target) !== '[object Object]') {
+    return target
+  }
+
+  // safely ensure that the key is an integer.
+  const getkey = (key) => {
+    const parsedKey = Number(key)
+    return isNaN(parsedKey) || key.indexOf('.') !== -1 || opts.object ? key : parsedKey
+  }
+
+  const sortedKeys = Object.keys(target).sort((keyA, keyB) => keyA.length - keyB.length)
+
+  sortedKeys.forEach((key) => {
+    const split = key.split(delimiter)
+    let key1 = getkey(split.shift())
+    let key2 = getkey(split[0])
+    let recipient = result
+
+    while (key2 !== undefined) {
+      if (key1 === '__proto__') {
+        return
+      }
+
+      const type = Object.prototype.toString.call(recipient[key1])
+      const isobject = type === '[object Object]' || type === '[object Array]'
+
+      // do not write over falsey, non-undefined values if overwrite is false
+      if (!overwrite && !isobject && typeof recipient[key1] !== 'undefined') {
+        return
+      }
+
+      if ((overwrite && !isobject) || (!overwrite && recipient[key1] == null)) {
+        recipient[key1] = typeof key2 === 'number' && !opts.object ? [] : {}
+      }
+
+      recipient = recipient[key1]
+
+      if (split.length > 0) {
+        key1 = getkey(split.shift())
+        key2 = getkey(split[0])
+      }
+    }
+
+    // unflatten again for 'messy objects'
+    recipient[key1] = recursive ? unflatten(target[key], opts) : target[key]
+  })
+
+  return result
+}

pnpm-lock.yaml

@@ -2,13 +2,6 @@ import type { CollectionConfig } from 'payload'
 
 import { jsonFieldsSlug } from '../../slugs.js'
 
-type JSONField = {
-  createdAt: string
-  id: string
-  json?: any
-  updatedAt: string
-}
-
 const JSON: CollectionConfig = {
   slug: jsonFieldsSlug,
   access: {
@@ -34,6 +27,16 @@ const JSON: CollectionConfig = {
         uri: 'a://b/foo.json',
       },
     },
+    {
+      name: 'group',
+      type: 'group',
+      fields: [
+        {
+          name: 'jsonWithinGroup',
+          type: 'json',
+        },
+      ],
+    },
   ],
   versions: {
     maxPerDoc: 1,