feat(plugin-multi-tenant): allow custom tenant field per collection (#13553)

docs/plugins/multi-tenant.mdx

@@ -80,13 +80,18 @@ type MultiTenantPluginConfig<ConfigTypes = unknown> = {
        * @default false
        */
       isGlobal?: boolean
+      /**
+       * Opt out of adding the tenant field and place
+       * it manually using the `tenantField` export from the plugin
+       */
+      customTenantField?: boolean
       /**
        * Overrides for the tenant field, will override the entire tenantField configuration
        */
       tenantFieldOverrides?: CollectionTenantFieldConfigOverrides
       /**
-       * Set to `false` if you want to manually apply
-       * the baseFilter
+       * Set to `false` if you want to manually apply the baseListFilter
+       * Set to `false` if you want to manually apply the baseFilter
        *
        * @default true
        */

packages/plugin-multi-tenant/src/components/TenantField/index.client.tsx

@@ -53,7 +53,7 @@ export const TenantField = (args: Props) => {
     }
   }, [args.unique, options, selectedTenantID, setTenant, value, setEntityType, entityType])
 
-  if (options.length > 1) {
+  if (options.length > 1 && !args.field.admin?.hidden && !args.field.hidden) {
     return (
       <>
         <div className={baseClass}>
@@ -64,7 +64,7 @@ export const TenantField = (args: Props) => {
                 ...args.field,
                 required: true,
               }}
-              readOnly={args.readOnly || args.unique}
+              readOnly={args.readOnly || args.field.admin?.readOnly || args.unique}
             />
           </div>
         </div>

packages/plugin-multi-tenant/src/exports/fields.ts

@@ -1 +1,2 @@
+export { tenantField } from '../fields/tenantField/index.js'
 export { tenantsArrayField } from '../fields/tenantsArrayField/index.js'

packages/plugin-multi-tenant/src/exports/utilities.ts

@@ -1,3 +1,4 @@
+export { defaults } from '../defaults.js'
 export { filterDocumentsByTenants as getTenantListFilter } from '../filters/filterDocumentsByTenants.js'
 export { getGlobalViewRedirect } from '../utilities/getGlobalViewRedirect.js'
 export { getTenantAccess } from '../utilities/getTenantAccess.js'

packages/plugin-multi-tenant/src/index.ts

@@ -178,10 +178,7 @@ export const multiTenantPlugin =
           tenantsCollectionSlug,
         })
 
-        const overrides = pluginConfig.collections[collection.slug]?.tenantFieldOverrides
-          ? pluginConfig.collections[collection.slug]?.tenantFieldOverrides
-          : pluginConfig.tenantField || {}
-
+        if (pluginConfig.collections[foldersSlug]?.customTenantField !== true) {
           /**
            * Add tenant field to enabled collections
            */
@@ -189,13 +186,16 @@ export const multiTenantPlugin =
             tenantField({
               name: tenantFieldName,
               debug: pluginConfig.debug,
-            overrides,
+              overrides: pluginConfig.collections[collection.slug]?.tenantFieldOverrides
+                ? pluginConfig.collections[collection.slug]?.tenantFieldOverrides
+                : pluginConfig.tenantField || {},
               tenantsArrayFieldName,
               tenantsArrayTenantFieldName,
               tenantsCollectionSlug,
               unique: false,
             }),
           )
+        }
 
         const { useBaseFilter, useBaseListFilter } = pluginConfig.collections[collection.slug] || {}
         if (useBaseFilter ?? useBaseListFilter ?? true) {
@@ -348,10 +348,7 @@ export const multiTenantPlugin =
           tenantsCollectionSlug,
         })
 
-        const overrides = pluginConfig.collections[collection.slug]?.tenantFieldOverrides
-          ? pluginConfig.collections[collection.slug]?.tenantFieldOverrides
-          : pluginConfig.tenantField || {}
-
+        if (pluginConfig.collections[collection.slug]?.customTenantField !== true) {
           /**
            * Add tenant field to enabled collections
            */
@@ -359,13 +356,16 @@ export const multiTenantPlugin =
             tenantField({
               name: tenantFieldName,
               debug: pluginConfig.debug,
-            overrides,
+              overrides: pluginConfig.collections[collection.slug]?.tenantFieldOverrides
+                ? pluginConfig.collections[collection.slug]?.tenantFieldOverrides
+                : pluginConfig.tenantField || {},
               tenantsArrayFieldName,
               tenantsArrayTenantFieldName,
               tenantsCollectionSlug,
               unique: isGlobal,
             }),
           )
+        }
 
         const { useBaseFilter, useBaseListFilter } = pluginConfig.collections[collection.slug] || {}
         if (useBaseFilter ?? useBaseListFilter ?? true) {

packages/plugin-multi-tenant/src/types.ts

@@ -30,6 +30,11 @@ export type MultiTenantPluginConfig<ConfigTypes = unknown> = {
    */
   collections: {
     [key in CollectionSlug]?: {
+      /**
+       * Opt out of adding the tenant field and place
+       * it manually using the `tenantField` export from the plugin
+       */
+      customTenantField?: boolean
       /**
        * Set to `true` if you want the collection to behave as a global
        *

packages/ui/src/elements/FolderView/FolderTypeField/index.tsx

@@ -102,7 +102,6 @@ export const FolderTypeField = ({
   const styles = React.useMemo(() => mergeFieldStyles(field), [field])
 
   return (
-    <div>
     <SelectInput
       AfterInput={AfterInput}
       BeforeInput={BeforeInput}
@@ -135,6 +134,5 @@ export const FolderTypeField = ({
       style={styles}
       value={value as string | string[]}
     />
-    </div>
   )
 }