fix: fallbackLocale not respecting default settings, locale specific fallbacks and not respecting 'none' or false (#8591)

This PR fixes and improves a few things around localisation and
fallbackLocale:
- For the REST API `fallbackLocale` and `fallback-locale` are treated
the same for consistency with the Local API
- `fallback: false` in config is now respected, by default results will
not fallback to `defaultLocale` unless this config is true, can also be
overridden by providing an explicit `fallbackLocale` in the request
- locale specific fallbacks will now take priority over `defaultLocale`
unless an explicit fallback is provided
- Fixes types on operations to allow `'none'` as a value for
fallbackLocale
- `fallback` is now true by default if unspecified

Closes #8443

Author: paulpopus

docs/configuration/localization.mdx

@@ -65,7 +65,7 @@ export default buildConfig({
       },
     ],
     defaultLocale: 'en', // required
-    fallback: true,
+    fallback: true, // defaults to true
   },
 })
 ```
@@ -81,7 +81,7 @@ The following options are available:
 | -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
 | **`locales`**  | Array of all the languages that you would like to support. [More details](#locales)                                            |
 | **`defaultLocale`** | Required string that matches one of the locale codes from the array provided. By default, if no locale is specified, documents will be returned in this locale. |
-| **`fallback`** | Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a localized value corresponding to the requested locale, then if this property is enabled, the document will automatically fall back to the fallback locale value. If this property is not enabled, the value will not be populated. |
+| **`fallback`** | Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a localized value corresponding to the requested locale, then if this property is enabled, the document will automatically fall back to the fallback locale value. If this property is not enabled, the value will not be populated unless a fallback is explicitly provided in the request. True by default. |
 
 ### Locales
 

examples/multi-tenant/src/app/components/Login/client.page.tsx

@@ -20,7 +20,9 @@ export const Login = ({ tenantSlug }: Props) => {
 
   const handleSubmit = async (e: FormEvent) => {
     e.preventDefault()
-    if (!usernameRef?.current?.value || !passwordRef?.current?.value) {return}
+    if (!usernameRef?.current?.value || !passwordRef?.current?.value) {
+      return
+    }
     const actionRes = await fetch(
       `${process.env.NEXT_PUBLIC_SERVER_URL}/api/users/external-users/login`,
       {

examples/multi-tenant/src/collections/Pages/hooks/ensureUniqueSlug.ts

@@ -6,7 +6,9 @@ import { getTenantAccessIDs } from '../../../utilities/getTenantAccessIDs'
 
 export const ensureUniqueSlug: FieldHook = async ({ data, originalDoc, req, value }) => {
   // if value is unchanged, skip validation
-  if (originalDoc.slug === value) {return value}
+  if (originalDoc.slug === value) {
+    return value
+  }
 
   const incomingTenantID = typeof data?.tenant === 'object' ? data.tenant.id : data?.tenant
   const currentTenantID =

examples/multi-tenant/src/collections/Pages/index.ts

@@ -14,7 +14,9 @@ export const Pages: CollectionConfig = {
     read: (args) => {
       // when viewing pages inside the admin panel
       // restrict access to the ones your user has access to
-      if (isPayloadAdminPanel(args.req)) {return filterByTenantRead(args)}
+      if (isPayloadAdminPanel(args.req)) {
+        return filterByTenantRead(args)
+      }
 
       // when viewing pages from outside the admin panel
       // you should be able to see your tenants and public tenants

examples/multi-tenant/src/collections/Tenants/access/read.ts

@@ -7,7 +7,9 @@ export const tenantRead: Access = (args) => {
   const req = args.req
 
   // Super admin can read all
-  if (isSuperAdmin(args)) {return true}
+  if (isSuperAdmin(args)) {
+    return true
+  }
 
   const tenantIDs = getTenantAccessIDs(req.user)
 

examples/multi-tenant/src/collections/Users/access/create.ts

@@ -7,13 +7,19 @@ import { getTenantAdminTenantAccessIDs } from '../../../utilities/getTenantAcces
 
 export const createAccess: Access<User> = (args) => {
   const { req } = args
-  if (!req.user) {return false}
+  if (!req.user) {
+    return false
+  }
 
-  if (isSuperAdmin(args)) {return true}
+  if (isSuperAdmin(args)) {
+    return true
+  }
 
   const adminTenantAccessIDs = getTenantAdminTenantAccessIDs(req.user)
 
-  if (adminTenantAccessIDs.length > 0) {return true}
+  if (adminTenantAccessIDs.length > 0) {
+    return true
+  }
 
   return false
 }

examples/multi-tenant/src/collections/Users/access/isAccessingSelf.ts

@@ -1,6 +1,8 @@
 import type { Access } from 'payload'
 
 export const isAccessingSelf: Access = ({ id, req }) => {
-  if (!req?.user) {return false}
+  if (!req?.user) {
+    return false
+  }
   return req.user.id === id
 }

examples/multi-tenant/src/collections/Users/access/updateAndDelete.ts

@@ -5,9 +5,13 @@ import { getTenantAdminTenantAccessIDs } from '../../../utilities/getTenantAcces
 
 export const updateAndDeleteAccess: Access = (args) => {
   const { req } = args
-  if (!req.user) {return false}
+  if (!req.user) {
+    return false
+  }
 
-  if (isSuperAdmin(args)) {return true}
+  if (isSuperAdmin(args)) {
+    return true
+  }
 
   const adminTenantAccessIDs = getTenantAdminTenantAccessIDs(req.user)
 

examples/multi-tenant/src/collections/Users/hooks/ensureUniqueUsername.ts

@@ -6,7 +6,9 @@ import { getTenantAccessIDs } from '../../../utilities/getTenantAccessIDs'
 
 export const ensureUniqueUsername: FieldHook = async ({ data, originalDoc, req, value }) => {
   // if value is unchanged, skip validation
-  if (originalDoc.username === value) {return value}
+  if (originalDoc.username === value) {
+    return value
+  }
 
   const incomingTenantID = typeof data?.tenant === 'object' ? data.tenant.id : data?.tenant
   const currentTenantID =

examples/multi-tenant/src/fields/TenantField/hooks/autofillTenant.ts

@@ -8,7 +8,9 @@ export const autofillTenant: FieldHook = ({ req, value }) => {
   // return that tenant ID as the value
   if (!value) {
     const tenantIDs = getTenantAccessIDs(req.user)
-    if (tenantIDs.length === 1) {return tenantIDs[0]}
+    if (tenantIDs.length === 1) {
+      return tenantIDs[0]
+    }
   }
 
   return value