chore(plugin-multi-tenant): add better defaults for imported components (#11030)

Creates a default variables file to use in exported components.
Extension of #10975.

Author: JarrodMFlesch

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

@@ -0,0 +1,6 @@
+export const defaults = {
+  tenantCollectionSlug: 'tenants',
+  tenantFieldName: 'tenant',
+  tenantsArrayFieldName: 'tenants',
+  tenantsArrayTenantFieldName: 'tenant',
+}

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

@@ -1,6 +1,7 @@
 import { type RelationshipField } from 'payload'
 import { APIError } from 'payload'
 
+import { defaults } from '../../defaults.js'
 import { getCollectionIDType } from '../../utilities/getCollectionIDType.js'
 import { getTenantFromCookie } from '../../utilities/getTenantFromCookie.js'
 
@@ -12,10 +13,10 @@ type Args = {
   unique: boolean
 }
 export const tenantField = ({
-  name,
+  name = defaults.tenantFieldName,
   access = undefined,
   debug,
-  tenantsCollectionSlug,
+  tenantsCollectionSlug = defaults.tenantCollectionSlug,
   unique,
 }: Args): RelationshipField => ({
   name,

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

@@ -1,27 +1,37 @@
 import type { ArrayField, RelationshipField } from 'payload'
 
-export const tenantsArrayField = (args: {
+import { defaults } from '../../defaults.js'
+
+type Args = {
   arrayFieldAccess?: ArrayField['access']
   rowFields?: ArrayField['fields']
   tenantFieldAccess?: RelationshipField['access']
   tenantsArrayFieldName: ArrayField['name']
   tenantsArrayTenantFieldName: RelationshipField['name']
   tenantsCollectionSlug: string
-}): ArrayField => ({
-  name: args.tenantsArrayFieldName,
+}
+export const tenantsArrayField = ({
+  arrayFieldAccess,
+  rowFields,
+  tenantFieldAccess,
+  tenantsArrayFieldName = defaults.tenantsArrayFieldName,
+  tenantsArrayTenantFieldName = defaults.tenantsArrayFieldName,
+  tenantsCollectionSlug = defaults.tenantCollectionSlug,
+}: Args): ArrayField => ({
+  name: tenantsArrayFieldName,
   type: 'array',
-  access: args?.arrayFieldAccess,
+  access: arrayFieldAccess,
   fields: [
     {
-      name: args.tenantsArrayTenantFieldName,
+      name: tenantsArrayTenantFieldName,
       type: 'relationship',
-      access: args.tenantFieldAccess,
+      access: tenantFieldAccess,
       index: true,
-      relationTo: args.tenantsCollectionSlug,
+      relationTo: tenantsCollectionSlug,
       required: true,
       saveToJWT: true,
     },
-    ...(args?.rowFields || []),
+    ...(rowFields || []),
   ],
   saveToJWT: true,
 })

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

@@ -2,20 +2,14 @@ import type { CollectionConfig, Config } from 'payload'
 
 import type { MultiTenantPluginConfig } from './types.js'
 
+import { defaults } from './defaults.js'
 import { tenantField } from './fields/tenantField/index.js'
 import { tenantsArrayField } from './fields/tenantsArrayField/index.js'
 import { addTenantCleanup } from './hooks/afterTenantDelete.js'
 import { addCollectionAccess } from './utilities/addCollectionAccess.js'
 import { addFilterOptionsToFields } from './utilities/addFilterOptionsToFields.js'
 import { withTenantListFilter } from './utilities/withTenantListFilter.js'
 
-const defaults = {
-  tenantCollectionSlug: 'tenants',
-  tenantFieldName: 'tenant',
-  tenantsArrayFieldName: 'tenants',
-  tenantsArrayTenantFieldName: 'tenant',
-}
-
 export const multiTenantPlugin =
   <ConfigType>(pluginConfig: MultiTenantPluginConfig<ConfigType>) =>
   (incomingConfig: Config): Config => {