fix: preserve shared localized draft changes (3.x backport of #17367)

packages/payload/src/collections/operations/utilities/update.ts

@@ -38,6 +38,7 @@ import {
   hasLocalizeStatusEnabled,
 } from '../../../utilities/getVersionsConfig.js'
 import { mergeLocalizedData } from '../../../utilities/mergeLocalizedData.js'
+import { hasNonLocalizedDataChanged } from '../../../versions/drafts/hasNonLocalizedDataChanged.js'
 export type SharedUpdateDocumentArgs<TSlug extends CollectionSlug> = {
   autosave: boolean
   collectionConfig: SanitizedCollectionConfig
@@ -278,6 +279,67 @@ export const updateDocument = async <
   let result: JsonObject = await beforeChange(beforeChangeArgs)
   let snapshotToSave: JsonObject | undefined
 
+  if (
+    config.localization &&
+    hasLocalizeStatusEnabled(collectionConfig) &&
+    typeof result._status === 'string'
+  ) {
+    const statusStr = result._status
+    result._status = {}
+    for (const localeCode of config.localization.localeCodes) {
+      ;(result._status as Record<string, unknown>)[localeCode] = statusStr
+    }
+  }
+
+  const shouldDraftAllLocales =
+    isSavingDraft &&
+    config.localization &&
+    hasLocalizeStatusEnabled(collectionConfig) &&
+    hasNonLocalizedDataChanged({
+      after: mergeLocalizedData({
+        configBlockReferences: config.blocks,
+        dataWithLocales: result,
+        docWithLocales,
+        fields: collectionConfig.fields,
+        selectedLocales: config.localization.localeCodes,
+      }),
+      before: docWithLocales,
+      configBlockReferences: config.blocks,
+      fields: collectionConfig.fields,
+    })
+
+  if (shouldDraftAllLocales && config.localization) {
+    if (!result._status || typeof result._status !== 'object' || Array.isArray(result._status)) {
+      result._status = {}
+    }
+
+    for (const localeCode of config.localization.localeCodes) {
+      ;(result._status as Record<string, unknown>)[localeCode] = 'draft'
+    }
+  } else if (isSavingDraft && config.localization && hasLocalizeStatusEnabled(collectionConfig)) {
+    const existingStatus =
+      docWithLocales._status &&
+      typeof docWithLocales._status === 'object' &&
+      !Array.isArray(docWithLocales._status)
+        ? docWithLocales._status
+        : {}
+
+    if (locale === 'all') {
+      const statusByLocale = { ...existingStatus }
+
+      for (const localeCode of config.localization.localeCodes) {
+        statusByLocale[localeCode] = 'draft'
+      }
+
+      result._status = statusByLocale
+    } else {
+      result._status = {
+        ...existingStatus,
+        [locale]: 'draft',
+      }
+    }
+  }
+
   if (config.localization && collectionConfig.versions) {
     let snapshotData: JsonObject | undefined
     let currentDoc
@@ -303,10 +365,16 @@ export const updateDocument = async <
         for (const localeCode of accessibleLocaleCodes) {
           result._status[localeCode] = unpublishAllLocales ? 'draft' : 'published'
         }
-      } else if (!isSavingDraft) {
-        // publishing a single locale
+      } else if (
+        !isSavingDraft &&
+        result._status &&
+        typeof result._status === 'object' &&
+        !Array.isArray(result._status) &&
+        (result._status as Record<string, unknown>)[locale] === 'published'
+      ) {
         currentDoc = await payload.db.findOne<DataFromCollectionSlug<TSlug>>({
           collection: collectionConfig.slug,
+          locale: 'all',
           req,
           where: { id: { equals: id } },
         })

packages/payload/src/globals/operations/update.ts

@@ -34,6 +34,7 @@ import { initTransaction } from '../../utilities/initTransaction.js'
 import { killTransaction } from '../../utilities/killTransaction.js'
 import { mergeLocalizedData } from '../../utilities/mergeLocalizedData.js'
 import { sanitizeSelect } from '../../utilities/sanitizeSelect.js'
+import { hasNonLocalizedDataChanged } from '../../versions/drafts/hasNonLocalizedDataChanged.js'
 import { getLatestGlobalVersion } from '../../versions/getLatestGlobalVersion.js'
 import { saveVersion } from '../../versions/saveVersion.js'
 type Args<TSlug extends GlobalSlug> = {
@@ -262,6 +263,62 @@ export const updateOperation = async <
     let result: JsonObject = await beforeChange(beforeChangeArgs)
     let snapshotToSave: JsonObject | undefined
 
+    if (
+      config?.localization &&
+      hasLocalizeStatusEnabled(globalConfig) &&
+      typeof result._status === 'string'
+    ) {
+      const statusStr = result._status
+      result._status = {}
+      for (const localeCode of config.localization.localeCodes) {
+        ;(result._status as Record<string, unknown>)[localeCode] = statusStr
+      }
+    }
+
+    const localization = config?.localization
+    const shouldDraftAllLocales =
+      isSavingDraft &&
+      localization &&
+      hasLocalizeStatusEnabled(globalConfig) &&
+      hasNonLocalizedDataChanged({
+        after: result,
+        before: globalJSON,
+        configBlockReferences: config.blocks,
+        fields: globalConfig.fields,
+      })
+
+    if (shouldDraftAllLocales && localization) {
+      if (!result._status || typeof result._status !== 'object' || Array.isArray(result._status)) {
+        result._status = {}
+      }
+
+      for (const localeCode of localization.localeCodes) {
+        ;(result._status as Record<string, unknown>)[localeCode] = 'draft'
+      }
+    } else if (isSavingDraft && localization && hasLocalizeStatusEnabled(globalConfig)) {
+      const existingStatus =
+        globalJSON._status &&
+        typeof globalJSON._status === 'object' &&
+        !Array.isArray(globalJSON._status)
+          ? globalJSON._status
+          : {}
+
+      if (locale === 'all') {
+        const statusByLocale = { ...existingStatus }
+
+        for (const localeCode of localization.localeCodes) {
+          statusByLocale[localeCode] = 'draft'
+        }
+
+        result._status = statusByLocale
+      } else {
+        result._status = {
+          ...existingStatus,
+          [locale!]: 'draft',
+        }
+      }
+    }
+
     // /////////////////////////////////////
     // Handle Localized Data Merging
     // /////////////////////////////////////
@@ -291,8 +348,13 @@ export const updateOperation = async <
           for (const localeCode of accessibleLocaleCodes) {
             result._status[localeCode] = unpublishAllLocales ? 'draft' : 'published'
           }
-        } else if (!isSavingDraft) {
-          // publishing a single locale
+        } else if (
+          !isSavingDraft &&
+          result._status &&
+          typeof result._status === 'object' &&
+          !Array.isArray(result._status) &&
+          (result._status as Record<string, unknown>)[locale!] === 'published'
+        ) {
           currentGlobal = await payload.db.findGlobal({
             slug: globalConfig.slug,
             req,

packages/payload/src/versions/drafts/getLocalizedDraftStatus.spec.ts

@@ -0,0 +1,37 @@
+import { describe, expect, it } from 'vitest'
+
+import { getLocalizedDraftStatus } from './getLocalizedDraftStatus.js'
+
+describe('getLocalizedDraftStatus', () => {
+  it('should preserve existing locale statuses and draft the requested locale', () => {
+    expect(
+      getLocalizedDraftStatus({
+        existingStatus: {
+          en: 'published',
+          es: 'published',
+        },
+        locale: 'en',
+        localeCodes: ['en', 'es'],
+      }),
+    ).toStrictEqual({
+      en: 'draft',
+      es: 'published',
+    })
+  })
+
+  it('should draft all configured locales for locale all without adding an all key', () => {
+    expect(
+      getLocalizedDraftStatus({
+        existingStatus: {
+          en: 'published',
+          es: 'published',
+        },
+        locale: 'all',
+        localeCodes: ['en', 'es'],
+      }),
+    ).toStrictEqual({
+      en: 'draft',
+      es: 'draft',
+    })
+  })
+})

packages/payload/src/versions/drafts/getLocalizedDraftStatus.ts

@@ -0,0 +1,26 @@
+import type { JsonObject } from '../../types/index.js'
+
+type GetLocalizedDraftStatusArgs = {
+  existingStatus: unknown
+  locale: string
+  localeCodes: string[]
+}
+
+export const getLocalizedDraftStatus = ({
+  existingStatus,
+  locale,
+  localeCodes,
+}: GetLocalizedDraftStatusArgs): JsonObject => {
+  const status =
+    existingStatus && typeof existingStatus === 'object' && !Array.isArray(existingStatus)
+      ? { ...(existingStatus as JsonObject) }
+      : {}
+
+  const localesToDraft = locale === 'all' ? localeCodes : [locale]
+
+  for (const localeCode of localesToDraft) {
+    status[localeCode] = 'draft'
+  }
+
+  return status
+}