@payloadcms/plugin-multi-tenant 3.21.0-canary.c6481e1 → 3.21.0-canary.db74962

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,MAAM,EAAE,MAAM,SAAS,CAAA;AAEvD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAgBzD,eAAO,MAAM,iBAAiB,GAC3B,UAAU,gBAAgB,uBAAuB,CAAC,UAAU,CAAC,sBAC7C,MAAM,KAAG,MA0OzB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,MAAM,EAAE,MAAM,SAAS,CAAA;AAEvD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAgBzD,eAAO,MAAM,iBAAiB,GAC3B,UAAU,gBAAgB,uBAAuB,CAAC,UAAU,CAAC,sBAC7C,MAAM,KAAG,MA4OzB,CAAA"}

package/dist/index.js

@@ -91,14 +91,16 @@ export const multiTenantPlugin = (pluginConfig)=>(incomingConfig)=>{
        * Modify tenants collection
        */ if (collection.slug === tenantsCollectionSlug) {
                 tenantCollection = collection;
-                /**
-         * Add access control constraint to tenants collection
-         * - constrains access a users assigned tenants
-         */ addCollectionAccess({
-                    collection,
-                    fieldName: 'id',
-                    userHasAccessToAllTenants
-                });
+                if (pluginConfig.useTenantsCollectionAccess !== false) {
+                    /**
+           * Add access control constraint to tenants collection
+           * - constrains access a users assigned tenants
+           */ addCollectionAccess({
+                        collection,
+                        fieldName: 'id',
+                        userHasAccessToAllTenants
+                    });
+                }
                 if (pluginConfig.cleanupAfterTenantDelete !== false) {
                     /**
            * Add cleanup logic when tenant is deleted

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionConfig, Config } from 'payload'\n\nimport type { MultiTenantPluginConfig } from './types.js'\n\nimport { tenantField } from './fields/tenantField/index.js'\nimport { tenantsArrayField } from './fields/tenantsArrayField/index.js'\nimport { addTenantCleanup } from './hooks/afterTenantDelete.js'\nimport { addCollectionAccess } from './utilities/addCollectionAccess.js'\nimport { addFilterOptionsToFields } from './utilities/addFilterOptionsToFields.js'\nimport { withTenantListFilter } from './utilities/withTenantListFilter.js'\n\nconst defaults = {\n  tenantCollectionSlug: 'tenants',\n  tenantFieldName: 'tenant',\n  tenantsArrayFieldName: 'tenants',\n  tenantsArrayTenantFieldName: 'tenant',\n}\n\nexport const multiTenantPlugin =\n  <ConfigType>(pluginConfig: MultiTenantPluginConfig<ConfigType>) =>\n  (incomingConfig: Config): Config => {\n    if (pluginConfig.enabled === false) {\n      return incomingConfig\n    }\n\n    /**\n     * Set defaults\n     */\n    const userHasAccessToAllTenants: Required<\n      MultiTenantPluginConfig<ConfigType>\n    >['userHasAccessToAllTenants'] =\n      typeof pluginConfig.userHasAccessToAllTenants === 'function'\n        ? pluginConfig.userHasAccessToAllTenants\n        : () => false\n    const tenantsCollectionSlug = (pluginConfig.tenantsSlug =\n      pluginConfig.tenantsSlug || defaults.tenantCollectionSlug)\n    const tenantFieldName = pluginConfig?.tenantField?.name || defaults.tenantFieldName\n    const tenantsArrayFieldName =\n      pluginConfig?.tenantsArrayField?.arrayFieldName || defaults.tenantsArrayFieldName\n    const tenantsArrayTenantFieldName =\n      pluginConfig?.tenantsArrayField?.arrayTenantFieldName || defaults.tenantsArrayTenantFieldName\n\n    /**\n     * Add defaults for admin properties\n     */\n    if (!incomingConfig.admin) {\n      incomingConfig.admin = {}\n    }\n    if (!incomingConfig.admin?.components) {\n      incomingConfig.admin.components = {\n        actions: [],\n        beforeNavLinks: [],\n        providers: [],\n      }\n    }\n    if (!incomingConfig.admin.components?.providers) {\n      incomingConfig.admin.components.providers = []\n    }\n    if (!incomingConfig.admin.components?.actions) {\n      incomingConfig.admin.components.actions = []\n    }\n    if (!incomingConfig.admin.components?.beforeNavLinks) {\n      incomingConfig.admin.components.beforeNavLinks = []\n    }\n    if (!incomingConfig.collections) {\n      incomingConfig.collections = []\n    }\n\n    /**\n     * Add tenants array field to users collection\n     */\n    const adminUsersCollection = incomingConfig.collections.find(({ slug, auth }) => {\n      if (incomingConfig.admin?.user) {\n        return slug === incomingConfig.admin.user\n      } else if (auth) {\n        return true\n      }\n    })\n\n    if (!adminUsersCollection) {\n      throw Error('An auth enabled collection was not found')\n    }\n\n    /**\n     * Add tenants array field to users collection\n     */\n    if (pluginConfig?.tenantsArrayField?.includeDefaultField !== false) {\n      adminUsersCollection.fields.push(\n        tenantsArrayField({\n          ...(pluginConfig?.tenantsArrayField || {}),\n          tenantsArrayFieldName,\n          tenantsArrayTenantFieldName,\n          tenantsCollectionSlug,\n        }),\n      )\n    }\n\n    addCollectionAccess({\n      collection: adminUsersCollection,\n      fieldName: `${tenantsArrayFieldName}.${tenantsArrayTenantFieldName}`,\n      userHasAccessToAllTenants,\n    })\n\n    let tenantCollection: CollectionConfig | undefined\n\n    const [collectionSlugs, globalCollectionSlugs] = Object.keys(pluginConfig.collections).reduce<\n      [string[], string[]]\n    >(\n      (acc, slug) => {\n        if (pluginConfig?.collections?.[slug]?.isGlobal) {\n          acc[1].push(slug)\n        } else {\n          acc[0].push(slug)\n        }\n\n        return acc\n      },\n      [[], []],\n    )\n\n    /**\n     * Modify collections\n     */\n    incomingConfig.collections.forEach((collection) => {\n      /**\n       * Modify tenants collection\n       */\n      if (collection.slug === tenantsCollectionSlug) {\n        tenantCollection = collection\n\n        /**\n         * Add access control constraint to tenants collection\n         * - constrains access a users assigned tenants\n         */\n        addCollectionAccess({\n          collection,\n          fieldName: 'id',\n          userHasAccessToAllTenants,\n        })\n\n        if (pluginConfig.cleanupAfterTenantDelete !== false) {\n          /**\n           * Add cleanup logic when tenant is deleted\n           * - delete documents related to tenant\n           * - remove tenant from users\n           */\n          addTenantCleanup({\n            collection,\n            enabledSlugs: [...collectionSlugs, ...globalCollectionSlugs],\n            tenantFieldName,\n            tenantsCollectionSlug,\n            usersSlug: adminUsersCollection.slug,\n            usersTenantsArrayFieldName: tenantsArrayFieldName,\n            usersTenantsArrayTenantFieldName: tenantsArrayTenantFieldName,\n          })\n        }\n      } else if (pluginConfig.collections?.[collection.slug]) {\n        const isGlobal = Boolean(pluginConfig.collections[collection.slug]?.isGlobal)\n\n        if (isGlobal) {\n          collection.disableDuplicate = true\n        }\n\n        /**\n         * Modify enabled collections\n         */\n        addFilterOptionsToFields({\n          fields: collection.fields,\n          tenantEnabledCollectionSlugs: collectionSlugs,\n          tenantEnabledGlobalSlugs: globalCollectionSlugs,\n          tenantFieldName,\n          tenantsCollectionSlug,\n        })\n\n        /**\n         * Add tenant field to enabled collections\n         */\n        collection.fields.splice(\n          0,\n          0,\n          tenantField({\n            ...(pluginConfig?.tenantField || {}),\n            name: tenantFieldName,\n            debug: pluginConfig.debug,\n            tenantsCollectionSlug,\n            unique: isGlobal,\n          }),\n        )\n\n        if (pluginConfig.collections[collection.slug]?.useBaseListFilter !== false) {\n          /**\n           * Collection baseListFilter with selected tenant constraint (if selected)\n           */\n          if (!collection.admin) {\n            collection.admin = {}\n          }\n          collection.admin.baseListFilter = withTenantListFilter({\n            baseListFilter: collection.admin?.baseListFilter,\n            tenantFieldName,\n            tenantsCollectionSlug,\n          })\n        }\n\n        if (pluginConfig.collections[collection.slug]?.useTenantAccess !== false) {\n          /**\n           * Add access control constraint to tenant enabled collection\n           */\n          addCollectionAccess({\n            collection,\n            fieldName: tenantFieldName,\n            userHasAccessToAllTenants,\n          })\n        }\n      }\n    })\n\n    if (!tenantCollection) {\n      throw new Error(`Tenants collection not found with slug: ${tenantsCollectionSlug}`)\n    }\n\n    /**\n     * Add TenantSelectionProvider to admin providers\n     */\n    incomingConfig.admin.components.providers.push({\n      clientProps: {\n        tenantsCollectionSlug: tenantCollection.slug,\n        useAsTitle: tenantCollection.admin?.useAsTitle || 'id',\n      },\n      path: '@payloadcms/plugin-multi-tenant/rsc#TenantSelectionProvider',\n    })\n\n    /**\n     * Add global redirect action\n     */\n    if (globalCollectionSlugs.length) {\n      incomingConfig.admin.components.actions.push({\n        path: '@payloadcms/plugin-multi-tenant/rsc#GlobalViewRedirect',\n        serverProps: {\n          globalSlugs: globalCollectionSlugs,\n          tenantFieldName,\n          tenantsCollectionSlug,\n          useAsTitle: tenantCollection.admin?.useAsTitle || 'id',\n        },\n      })\n    }\n\n    /**\n     * Add tenant selector to admin UI\n     */\n    incomingConfig.admin.components.beforeNavLinks.push({\n      path: '@payloadcms/plugin-multi-tenant/client#TenantSelector',\n    })\n\n    return incomingConfig\n  }\n"],"names":["tenantField","tenantsArrayField","addTenantCleanup","addCollectionAccess","addFilterOptionsToFields","withTenantListFilter","defaults","tenantCollectionSlug","tenantFieldName","tenantsArrayFieldName","tenantsArrayTenantFieldName","multiTenantPlugin","pluginConfig","incomingConfig","enabled","userHasAccessToAllTenants","tenantsCollectionSlug","tenantsSlug","name","arrayFieldName","arrayTenantFieldName","admin","components","actions","beforeNavLinks","providers","collections","adminUsersCollection","find","slug","auth","user","Error","includeDefaultField","fields","push","collection","fieldName","tenantCollection","collectionSlugs","globalCollectionSlugs","Object","keys","reduce","acc","isGlobal","forEach","cleanupAfterTenantDelete","enabledSlugs","usersSlug","usersTenantsArrayFieldName","usersTenantsArrayTenantFieldName","Boolean","disableDuplicate","tenantEnabledCollectionSlugs","tenantEnabledGlobalSlugs","splice","debug","unique","useBaseListFilter","baseListFilter","useTenantAccess","clientProps","useAsTitle","path","length","serverProps","globalSlugs"],"mappings":"AAIA,SAASA,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,iBAAiB,QAAQ,sCAAqC;AACvE,SAASC,gBAAgB,QAAQ,+BAA8B;AAC/D,SAASC,mBAAmB,QAAQ,qCAAoC;AACxE,SAASC,wBAAwB,QAAQ,0CAAyC;AAClF,SAASC,oBAAoB,QAAQ,sCAAqC;AAE1E,MAAMC,WAAW;IACfC,sBAAsB;IACtBC,iBAAiB;IACjBC,uBAAuB;IACvBC,6BAA6B;AAC/B;AAEA,OAAO,MAAMC,oBACX,CAAaC,eACb,CAACC;QACC,IAAID,aAAaE,OAAO,KAAK,OAAO;YAClC,OAAOD;QACT;QAEA;;KAEC,GACD,MAAME,4BAGJ,OAAOH,aAAaG,yBAAyB,KAAK,aAC9CH,aAAaG,yBAAyB,GACtC,IAAM;QACZ,MAAMC,wBAAyBJ,aAAaK,WAAW,GACrDL,aAAaK,WAAW,IAAIX,SAASC,oBAAoB;QAC3D,MAAMC,kBAAkBI,cAAcZ,aAAakB,QAAQZ,SAASE,eAAe;QACnF,MAAMC,wBACJG,cAAcX,mBAAmBkB,kBAAkBb,SAASG,qBAAqB;QACnF,MAAMC,8BACJE,cAAcX,mBAAmBmB,wBAAwBd,SAASI,2BAA2B;QAE/F;;KAEC,GACD,IAAI,CAACG,eAAeQ,KAAK,EAAE;YACzBR,eAAeQ,KAAK,GAAG,CAAC;QAC1B;QACA,IAAI,CAACR,eAAeQ,KAAK,EAAEC,YAAY;YACrCT,eAAeQ,KAAK,CAACC,UAAU,GAAG;gBAChCC,SAAS,EAAE;gBACXC,gBAAgB,EAAE;gBAClBC,WAAW,EAAE;YACf;QACF;QACA,IAAI,CAACZ,eAAeQ,KAAK,CAACC,UAAU,EAAEG,WAAW;YAC/CZ,eAAeQ,KAAK,CAACC,UAAU,CAACG,SAAS,GAAG,EAAE;QAChD;QACA,IAAI,CAACZ,eAAeQ,KAAK,CAACC,UAAU,EAAEC,SAAS;YAC7CV,eAAeQ,KAAK,CAACC,UAAU,CAACC,OAAO,GAAG,EAAE;QAC9C;QACA,IAAI,CAACV,eAAeQ,KAAK,CAACC,UAAU,EAAEE,gBAAgB;YACpDX,eAAeQ,KAAK,CAACC,UAAU,CAACE,cAAc,GAAG,EAAE;QACrD;QACA,IAAI,CAACX,eAAea,WAAW,EAAE;YAC/Bb,eAAea,WAAW,GAAG,EAAE;QACjC;QAEA;;KAEC,GACD,MAAMC,uBAAuBd,eAAea,WAAW,CAACE,IAAI,CAAC,CAAC,EAAEC,IAAI,EAAEC,IAAI,EAAE;YAC1E,IAAIjB,eAAeQ,KAAK,EAAEU,MAAM;gBAC9B,OAAOF,SAAShB,eAAeQ,KAAK,CAACU,IAAI;YAC3C,OAAO,IAAID,MAAM;gBACf,OAAO;YACT;QACF;QAEA,IAAI,CAACH,sBAAsB;YACzB,MAAMK,MAAM;QACd;QAEA;;KAEC,GACD,IAAIpB,cAAcX,mBAAmBgC,wBAAwB,OAAO;YAClEN,qBAAqBO,MAAM,CAACC,IAAI,CAC9BlC,kBAAkB;gBAChB,GAAIW,cAAcX,qBAAqB,CAAC,CAAC;gBACzCQ;gBACAC;gBACAM;YACF;QAEJ;QAEAb,oBAAoB;YAClBiC,YAAYT;YACZU,WAAW,GAAG5B,sBAAsB,CAAC,EAAEC,6BAA6B;YACpEK;QACF;QAEA,IAAIuB;QAEJ,MAAM,CAACC,iBAAiBC,sBAAsB,GAAGC,OAAOC,IAAI,CAAC9B,aAAac,WAAW,EAAEiB,MAAM,CAG3F,CAACC,KAAKf;YACJ,IAAIjB,cAAcc,aAAa,CAACG,KAAK,EAAEgB,UAAU;gBAC/CD,GAAG,CAAC,EAAE,CAACT,IAAI,CAACN;YACd,OAAO;gBACLe,GAAG,CAAC,EAAE,CAACT,IAAI,CAACN;YACd;YAEA,OAAOe;QACT,GACA;YAAC,EAAE;YAAE,EAAE;SAAC;QAGV;;KAEC,GACD/B,eAAea,WAAW,CAACoB,OAAO,CAAC,CAACV;YAClC;;OAEC,GACD,IAAIA,WAAWP,IAAI,KAAKb,uBAAuB;gBAC7CsB,mBAAmBF;gBAEnB;;;SAGC,GACDjC,oBAAoB;oBAClBiC;oBACAC,WAAW;oBACXtB;gBACF;gBAEA,IAAIH,aAAamC,wBAAwB,KAAK,OAAO;oBACnD;;;;WAIC,GACD7C,iBAAiB;wBACfkC;wBACAY,cAAc;+BAAIT;+BAAoBC;yBAAsB;wBAC5DhC;wBACAQ;wBACAiC,WAAWtB,qBAAqBE,IAAI;wBACpCqB,4BAA4BzC;wBAC5B0C,kCAAkCzC;oBACpC;gBACF;YACF,OAAO,IAAIE,aAAac,WAAW,EAAE,CAACU,WAAWP,IAAI,CAAC,EAAE;gBACtD,MAAMgB,WAAWO,QAAQxC,aAAac,WAAW,CAACU,WAAWP,IAAI,CAAC,EAAEgB;gBAEpE,IAAIA,UAAU;oBACZT,WAAWiB,gBAAgB,GAAG;gBAChC;gBAEA;;SAEC,GACDjD,yBAAyB;oBACvB8B,QAAQE,WAAWF,MAAM;oBACzBoB,8BAA8Bf;oBAC9BgB,0BAA0Bf;oBAC1BhC;oBACAQ;gBACF;gBAEA;;SAEC,GACDoB,WAAWF,MAAM,CAACsB,MAAM,CACtB,GACA,GACAxD,YAAY;oBACV,GAAIY,cAAcZ,eAAe,CAAC,CAAC;oBACnCkB,MAAMV;oBACNiD,OAAO7C,aAAa6C,KAAK;oBACzBzC;oBACA0C,QAAQb;gBACV;gBAGF,IAAIjC,aAAac,WAAW,CAACU,WAAWP,IAAI,CAAC,EAAE8B,sBAAsB,OAAO;oBAC1E;;WAEC,GACD,IAAI,CAACvB,WAAWf,KAAK,EAAE;wBACrBe,WAAWf,KAAK,GAAG,CAAC;oBACtB;oBACAe,WAAWf,KAAK,CAACuC,cAAc,GAAGvD,qBAAqB;wBACrDuD,gBAAgBxB,WAAWf,KAAK,EAAEuC;wBAClCpD;wBACAQ;oBACF;gBACF;gBAEA,IAAIJ,aAAac,WAAW,CAACU,WAAWP,IAAI,CAAC,EAAEgC,oBAAoB,OAAO;oBACxE;;WAEC,GACD1D,oBAAoB;wBAClBiC;wBACAC,WAAW7B;wBACXO;oBACF;gBACF;YACF;QACF;QAEA,IAAI,CAACuB,kBAAkB;YACrB,MAAM,IAAIN,MAAM,CAAC,wCAAwC,EAAEhB,uBAAuB;QACpF;QAEA;;KAEC,GACDH,eAAeQ,KAAK,CAACC,UAAU,CAACG,SAAS,CAACU,IAAI,CAAC;YAC7C2B,aAAa;gBACX9C,uBAAuBsB,iBAAiBT,IAAI;gBAC5CkC,YAAYzB,iBAAiBjB,KAAK,EAAE0C,cAAc;YACpD;YACAC,MAAM;QACR;QAEA;;KAEC,GACD,IAAIxB,sBAAsByB,MAAM,EAAE;YAChCpD,eAAeQ,KAAK,CAACC,UAAU,CAACC,OAAO,CAACY,IAAI,CAAC;gBAC3C6B,MAAM;gBACNE,aAAa;oBACXC,aAAa3B;oBACbhC;oBACAQ;oBACA+C,YAAYzB,iBAAiBjB,KAAK,EAAE0C,cAAc;gBACpD;YACF;QACF;QAEA;;KAEC,GACDlD,eAAeQ,KAAK,CAACC,UAAU,CAACE,cAAc,CAACW,IAAI,CAAC;YAClD6B,MAAM;QACR;QAEA,OAAOnD;IACT,EAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { CollectionConfig, Config } from 'payload'\n\nimport type { MultiTenantPluginConfig } from './types.js'\n\nimport { tenantField } from './fields/tenantField/index.js'\nimport { tenantsArrayField } from './fields/tenantsArrayField/index.js'\nimport { addTenantCleanup } from './hooks/afterTenantDelete.js'\nimport { addCollectionAccess } from './utilities/addCollectionAccess.js'\nimport { addFilterOptionsToFields } from './utilities/addFilterOptionsToFields.js'\nimport { withTenantListFilter } from './utilities/withTenantListFilter.js'\n\nconst defaults = {\n  tenantCollectionSlug: 'tenants',\n  tenantFieldName: 'tenant',\n  tenantsArrayFieldName: 'tenants',\n  tenantsArrayTenantFieldName: 'tenant',\n}\n\nexport const multiTenantPlugin =\n  <ConfigType>(pluginConfig: MultiTenantPluginConfig<ConfigType>) =>\n  (incomingConfig: Config): Config => {\n    if (pluginConfig.enabled === false) {\n      return incomingConfig\n    }\n\n    /**\n     * Set defaults\n     */\n    const userHasAccessToAllTenants: Required<\n      MultiTenantPluginConfig<ConfigType>\n    >['userHasAccessToAllTenants'] =\n      typeof pluginConfig.userHasAccessToAllTenants === 'function'\n        ? pluginConfig.userHasAccessToAllTenants\n        : () => false\n    const tenantsCollectionSlug = (pluginConfig.tenantsSlug =\n      pluginConfig.tenantsSlug || defaults.tenantCollectionSlug)\n    const tenantFieldName = pluginConfig?.tenantField?.name || defaults.tenantFieldName\n    const tenantsArrayFieldName =\n      pluginConfig?.tenantsArrayField?.arrayFieldName || defaults.tenantsArrayFieldName\n    const tenantsArrayTenantFieldName =\n      pluginConfig?.tenantsArrayField?.arrayTenantFieldName || defaults.tenantsArrayTenantFieldName\n\n    /**\n     * Add defaults for admin properties\n     */\n    if (!incomingConfig.admin) {\n      incomingConfig.admin = {}\n    }\n    if (!incomingConfig.admin?.components) {\n      incomingConfig.admin.components = {\n        actions: [],\n        beforeNavLinks: [],\n        providers: [],\n      }\n    }\n    if (!incomingConfig.admin.components?.providers) {\n      incomingConfig.admin.components.providers = []\n    }\n    if (!incomingConfig.admin.components?.actions) {\n      incomingConfig.admin.components.actions = []\n    }\n    if (!incomingConfig.admin.components?.beforeNavLinks) {\n      incomingConfig.admin.components.beforeNavLinks = []\n    }\n    if (!incomingConfig.collections) {\n      incomingConfig.collections = []\n    }\n\n    /**\n     * Add tenants array field to users collection\n     */\n    const adminUsersCollection = incomingConfig.collections.find(({ slug, auth }) => {\n      if (incomingConfig.admin?.user) {\n        return slug === incomingConfig.admin.user\n      } else if (auth) {\n        return true\n      }\n    })\n\n    if (!adminUsersCollection) {\n      throw Error('An auth enabled collection was not found')\n    }\n\n    /**\n     * Add tenants array field to users collection\n     */\n    if (pluginConfig?.tenantsArrayField?.includeDefaultField !== false) {\n      adminUsersCollection.fields.push(\n        tenantsArrayField({\n          ...(pluginConfig?.tenantsArrayField || {}),\n          tenantsArrayFieldName,\n          tenantsArrayTenantFieldName,\n          tenantsCollectionSlug,\n        }),\n      )\n    }\n\n    addCollectionAccess({\n      collection: adminUsersCollection,\n      fieldName: `${tenantsArrayFieldName}.${tenantsArrayTenantFieldName}`,\n      userHasAccessToAllTenants,\n    })\n\n    let tenantCollection: CollectionConfig | undefined\n\n    const [collectionSlugs, globalCollectionSlugs] = Object.keys(pluginConfig.collections).reduce<\n      [string[], string[]]\n    >(\n      (acc, slug) => {\n        if (pluginConfig?.collections?.[slug]?.isGlobal) {\n          acc[1].push(slug)\n        } else {\n          acc[0].push(slug)\n        }\n\n        return acc\n      },\n      [[], []],\n    )\n\n    /**\n     * Modify collections\n     */\n    incomingConfig.collections.forEach((collection) => {\n      /**\n       * Modify tenants collection\n       */\n      if (collection.slug === tenantsCollectionSlug) {\n        tenantCollection = collection\n\n        if (pluginConfig.useTenantsCollectionAccess !== false) {\n          /**\n           * Add access control constraint to tenants collection\n           * - constrains access a users assigned tenants\n           */\n          addCollectionAccess({\n            collection,\n            fieldName: 'id',\n            userHasAccessToAllTenants,\n          })\n        }\n\n        if (pluginConfig.cleanupAfterTenantDelete !== false) {\n          /**\n           * Add cleanup logic when tenant is deleted\n           * - delete documents related to tenant\n           * - remove tenant from users\n           */\n          addTenantCleanup({\n            collection,\n            enabledSlugs: [...collectionSlugs, ...globalCollectionSlugs],\n            tenantFieldName,\n            tenantsCollectionSlug,\n            usersSlug: adminUsersCollection.slug,\n            usersTenantsArrayFieldName: tenantsArrayFieldName,\n            usersTenantsArrayTenantFieldName: tenantsArrayTenantFieldName,\n          })\n        }\n      } else if (pluginConfig.collections?.[collection.slug]) {\n        const isGlobal = Boolean(pluginConfig.collections[collection.slug]?.isGlobal)\n\n        if (isGlobal) {\n          collection.disableDuplicate = true\n        }\n\n        /**\n         * Modify enabled collections\n         */\n        addFilterOptionsToFields({\n          fields: collection.fields,\n          tenantEnabledCollectionSlugs: collectionSlugs,\n          tenantEnabledGlobalSlugs: globalCollectionSlugs,\n          tenantFieldName,\n          tenantsCollectionSlug,\n        })\n\n        /**\n         * Add tenant field to enabled collections\n         */\n        collection.fields.splice(\n          0,\n          0,\n          tenantField({\n            ...(pluginConfig?.tenantField || {}),\n            name: tenantFieldName,\n            debug: pluginConfig.debug,\n            tenantsCollectionSlug,\n            unique: isGlobal,\n          }),\n        )\n\n        if (pluginConfig.collections[collection.slug]?.useBaseListFilter !== false) {\n          /**\n           * Collection baseListFilter with selected tenant constraint (if selected)\n           */\n          if (!collection.admin) {\n            collection.admin = {}\n          }\n          collection.admin.baseListFilter = withTenantListFilter({\n            baseListFilter: collection.admin?.baseListFilter,\n            tenantFieldName,\n            tenantsCollectionSlug,\n          })\n        }\n\n        if (pluginConfig.collections[collection.slug]?.useTenantAccess !== false) {\n          /**\n           * Add access control constraint to tenant enabled collection\n           */\n          addCollectionAccess({\n            collection,\n            fieldName: tenantFieldName,\n            userHasAccessToAllTenants,\n          })\n        }\n      }\n    })\n\n    if (!tenantCollection) {\n      throw new Error(`Tenants collection not found with slug: ${tenantsCollectionSlug}`)\n    }\n\n    /**\n     * Add TenantSelectionProvider to admin providers\n     */\n    incomingConfig.admin.components.providers.push({\n      clientProps: {\n        tenantsCollectionSlug: tenantCollection.slug,\n        useAsTitle: tenantCollection.admin?.useAsTitle || 'id',\n      },\n      path: '@payloadcms/plugin-multi-tenant/rsc#TenantSelectionProvider',\n    })\n\n    /**\n     * Add global redirect action\n     */\n    if (globalCollectionSlugs.length) {\n      incomingConfig.admin.components.actions.push({\n        path: '@payloadcms/plugin-multi-tenant/rsc#GlobalViewRedirect',\n        serverProps: {\n          globalSlugs: globalCollectionSlugs,\n          tenantFieldName,\n          tenantsCollectionSlug,\n          useAsTitle: tenantCollection.admin?.useAsTitle || 'id',\n        },\n      })\n    }\n\n    /**\n     * Add tenant selector to admin UI\n     */\n    incomingConfig.admin.components.beforeNavLinks.push({\n      path: '@payloadcms/plugin-multi-tenant/client#TenantSelector',\n    })\n\n    return incomingConfig\n  }\n"],"names":["tenantField","tenantsArrayField","addTenantCleanup","addCollectionAccess","addFilterOptionsToFields","withTenantListFilter","defaults","tenantCollectionSlug","tenantFieldName","tenantsArrayFieldName","tenantsArrayTenantFieldName","multiTenantPlugin","pluginConfig","incomingConfig","enabled","userHasAccessToAllTenants","tenantsCollectionSlug","tenantsSlug","name","arrayFieldName","arrayTenantFieldName","admin","components","actions","beforeNavLinks","providers","collections","adminUsersCollection","find","slug","auth","user","Error","includeDefaultField","fields","push","collection","fieldName","tenantCollection","collectionSlugs","globalCollectionSlugs","Object","keys","reduce","acc","isGlobal","forEach","useTenantsCollectionAccess","cleanupAfterTenantDelete","enabledSlugs","usersSlug","usersTenantsArrayFieldName","usersTenantsArrayTenantFieldName","Boolean","disableDuplicate","tenantEnabledCollectionSlugs","tenantEnabledGlobalSlugs","splice","debug","unique","useBaseListFilter","baseListFilter","useTenantAccess","clientProps","useAsTitle","path","length","serverProps","globalSlugs"],"mappings":"AAIA,SAASA,WAAW,QAAQ,gCAA+B;AAC3D,SAASC,iBAAiB,QAAQ,sCAAqC;AACvE,SAASC,gBAAgB,QAAQ,+BAA8B;AAC/D,SAASC,mBAAmB,QAAQ,qCAAoC;AACxE,SAASC,wBAAwB,QAAQ,0CAAyC;AAClF,SAASC,oBAAoB,QAAQ,sCAAqC;AAE1E,MAAMC,WAAW;IACfC,sBAAsB;IACtBC,iBAAiB;IACjBC,uBAAuB;IACvBC,6BAA6B;AAC/B;AAEA,OAAO,MAAMC,oBACX,CAAaC,eACb,CAACC;QACC,IAAID,aAAaE,OAAO,KAAK,OAAO;YAClC,OAAOD;QACT;QAEA;;KAEC,GACD,MAAME,4BAGJ,OAAOH,aAAaG,yBAAyB,KAAK,aAC9CH,aAAaG,yBAAyB,GACtC,IAAM;QACZ,MAAMC,wBAAyBJ,aAAaK,WAAW,GACrDL,aAAaK,WAAW,IAAIX,SAASC,oBAAoB;QAC3D,MAAMC,kBAAkBI,cAAcZ,aAAakB,QAAQZ,SAASE,eAAe;QACnF,MAAMC,wBACJG,cAAcX,mBAAmBkB,kBAAkBb,SAASG,qBAAqB;QACnF,MAAMC,8BACJE,cAAcX,mBAAmBmB,wBAAwBd,SAASI,2BAA2B;QAE/F;;KAEC,GACD,IAAI,CAACG,eAAeQ,KAAK,EAAE;YACzBR,eAAeQ,KAAK,GAAG,CAAC;QAC1B;QACA,IAAI,CAACR,eAAeQ,KAAK,EAAEC,YAAY;YACrCT,eAAeQ,KAAK,CAACC,UAAU,GAAG;gBAChCC,SAAS,EAAE;gBACXC,gBAAgB,EAAE;gBAClBC,WAAW,EAAE;YACf;QACF;QACA,IAAI,CAACZ,eAAeQ,KAAK,CAACC,UAAU,EAAEG,WAAW;YAC/CZ,eAAeQ,KAAK,CAACC,UAAU,CAACG,SAAS,GAAG,EAAE;QAChD;QACA,IAAI,CAACZ,eAAeQ,KAAK,CAACC,UAAU,EAAEC,SAAS;YAC7CV,eAAeQ,KAAK,CAACC,UAAU,CAACC,OAAO,GAAG,EAAE;QAC9C;QACA,IAAI,CAACV,eAAeQ,KAAK,CAACC,UAAU,EAAEE,gBAAgB;YACpDX,eAAeQ,KAAK,CAACC,UAAU,CAACE,cAAc,GAAG,EAAE;QACrD;QACA,IAAI,CAACX,eAAea,WAAW,EAAE;YAC/Bb,eAAea,WAAW,GAAG,EAAE;QACjC;QAEA;;KAEC,GACD,MAAMC,uBAAuBd,eAAea,WAAW,CAACE,IAAI,CAAC,CAAC,EAAEC,IAAI,EAAEC,IAAI,EAAE;YAC1E,IAAIjB,eAAeQ,KAAK,EAAEU,MAAM;gBAC9B,OAAOF,SAAShB,eAAeQ,KAAK,CAACU,IAAI;YAC3C,OAAO,IAAID,MAAM;gBACf,OAAO;YACT;QACF;QAEA,IAAI,CAACH,sBAAsB;YACzB,MAAMK,MAAM;QACd;QAEA;;KAEC,GACD,IAAIpB,cAAcX,mBAAmBgC,wBAAwB,OAAO;YAClEN,qBAAqBO,MAAM,CAACC,IAAI,CAC9BlC,kBAAkB;gBAChB,GAAIW,cAAcX,qBAAqB,CAAC,CAAC;gBACzCQ;gBACAC;gBACAM;YACF;QAEJ;QAEAb,oBAAoB;YAClBiC,YAAYT;YACZU,WAAW,GAAG5B,sBAAsB,CAAC,EAAEC,6BAA6B;YACpEK;QACF;QAEA,IAAIuB;QAEJ,MAAM,CAACC,iBAAiBC,sBAAsB,GAAGC,OAAOC,IAAI,CAAC9B,aAAac,WAAW,EAAEiB,MAAM,CAG3F,CAACC,KAAKf;YACJ,IAAIjB,cAAcc,aAAa,CAACG,KAAK,EAAEgB,UAAU;gBAC/CD,GAAG,CAAC,EAAE,CAACT,IAAI,CAACN;YACd,OAAO;gBACLe,GAAG,CAAC,EAAE,CAACT,IAAI,CAACN;YACd;YAEA,OAAOe;QACT,GACA;YAAC,EAAE;YAAE,EAAE;SAAC;QAGV;;KAEC,GACD/B,eAAea,WAAW,CAACoB,OAAO,CAAC,CAACV;YAClC;;OAEC,GACD,IAAIA,WAAWP,IAAI,KAAKb,uBAAuB;gBAC7CsB,mBAAmBF;gBAEnB,IAAIxB,aAAamC,0BAA0B,KAAK,OAAO;oBACrD;;;WAGC,GACD5C,oBAAoB;wBAClBiC;wBACAC,WAAW;wBACXtB;oBACF;gBACF;gBAEA,IAAIH,aAAaoC,wBAAwB,KAAK,OAAO;oBACnD;;;;WAIC,GACD9C,iBAAiB;wBACfkC;wBACAa,cAAc;+BAAIV;+BAAoBC;yBAAsB;wBAC5DhC;wBACAQ;wBACAkC,WAAWvB,qBAAqBE,IAAI;wBACpCsB,4BAA4B1C;wBAC5B2C,kCAAkC1C;oBACpC;gBACF;YACF,OAAO,IAAIE,aAAac,WAAW,EAAE,CAACU,WAAWP,IAAI,CAAC,EAAE;gBACtD,MAAMgB,WAAWQ,QAAQzC,aAAac,WAAW,CAACU,WAAWP,IAAI,CAAC,EAAEgB;gBAEpE,IAAIA,UAAU;oBACZT,WAAWkB,gBAAgB,GAAG;gBAChC;gBAEA;;SAEC,GACDlD,yBAAyB;oBACvB8B,QAAQE,WAAWF,MAAM;oBACzBqB,8BAA8BhB;oBAC9BiB,0BAA0BhB;oBAC1BhC;oBACAQ;gBACF;gBAEA;;SAEC,GACDoB,WAAWF,MAAM,CAACuB,MAAM,CACtB,GACA,GACAzD,YAAY;oBACV,GAAIY,cAAcZ,eAAe,CAAC,CAAC;oBACnCkB,MAAMV;oBACNkD,OAAO9C,aAAa8C,KAAK;oBACzB1C;oBACA2C,QAAQd;gBACV;gBAGF,IAAIjC,aAAac,WAAW,CAACU,WAAWP,IAAI,CAAC,EAAE+B,sBAAsB,OAAO;oBAC1E;;WAEC,GACD,IAAI,CAACxB,WAAWf,KAAK,EAAE;wBACrBe,WAAWf,KAAK,GAAG,CAAC;oBACtB;oBACAe,WAAWf,KAAK,CAACwC,cAAc,GAAGxD,qBAAqB;wBACrDwD,gBAAgBzB,WAAWf,KAAK,EAAEwC;wBAClCrD;wBACAQ;oBACF;gBACF;gBAEA,IAAIJ,aAAac,WAAW,CAACU,WAAWP,IAAI,CAAC,EAAEiC,oBAAoB,OAAO;oBACxE;;WAEC,GACD3D,oBAAoB;wBAClBiC;wBACAC,WAAW7B;wBACXO;oBACF;gBACF;YACF;QACF;QAEA,IAAI,CAACuB,kBAAkB;YACrB,MAAM,IAAIN,MAAM,CAAC,wCAAwC,EAAEhB,uBAAuB;QACpF;QAEA;;KAEC,GACDH,eAAeQ,KAAK,CAACC,UAAU,CAACG,SAAS,CAACU,IAAI,CAAC;YAC7C4B,aAAa;gBACX/C,uBAAuBsB,iBAAiBT,IAAI;gBAC5CmC,YAAY1B,iBAAiBjB,KAAK,EAAE2C,cAAc;YACpD;YACAC,MAAM;QACR;QAEA;;KAEC,GACD,IAAIzB,sBAAsB0B,MAAM,EAAE;YAChCrD,eAAeQ,KAAK,CAACC,UAAU,CAACC,OAAO,CAACY,IAAI,CAAC;gBAC3C8B,MAAM;gBACNE,aAAa;oBACXC,aAAa5B;oBACbhC;oBACAQ;oBACAgD,YAAY1B,iBAAiBjB,KAAK,EAAE2C,cAAc;gBACpD;YACF;QACF;QAEA;;KAEC,GACDnD,eAAeQ,KAAK,CAACC,UAAU,CAACE,cAAc,CAACW,IAAI,CAAC;YAClD8B,MAAM;QACR;QAEA,OAAOpD;IACT,EAAC"}

package/dist/types.d.ts

@@ -118,6 +118,10 @@ export type MultiTenantPluginConfig<ConfigTypes = unknown> = {
     userHasAccessToAllTenants?: (user: ConfigTypes extends {
         user: unknown;
     } ? ConfigTypes['user'] : User) => boolean;
+    /**
+     * Opt out of adding access constraints to the tenants collection
+     */
+    useTenantsCollectionAccess?: boolean;
 };
 export type Tenant<IDType = number | string> = {
     id: IDType;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEzF,MAAM,MAAM,uBAAuB,CAAC,WAAW,GAAG,OAAO,IAAI;IAC3D;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;OAEG;IACH,WAAW,EAAE;SACV,GAAG,IAAI,cAAc,CAAC,CAAC,EAAE;YACxB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAA;YAClB;;;;eAIG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;YAC3B;;;;eAIG;YACH,eAAe,CAAC,EAAE,OAAO,CAAA;SAC1B;KACF,CAAA;IACD;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;QACpC;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;;;;OAKG;IACH,iBAAiB,CAAC,EACd;QACE;;WAEG;QACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAA;QACvC;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B;;WAEG;QACH,mBAAmB,CAAC,EAAE,IAAI,CAAA;QAC1B;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,EAAE,CAAA;QACnB;;WAEG;QACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;KAChD,GACD;QACE,gBAAgB,CAAC,EAAE,KAAK,CAAA;QACxB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAA;QAC3B,SAAS,CAAC,EAAE,KAAK,CAAA;QACjB,iBAAiB,CAAC,EAAE,KAAK,CAAA;KAC1B,CAAA;IACL;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,CAC1B,IAAI,EAAE,WAAW,SAAS;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,KACrE,OAAO,CAAA;CACb,CAAA;AAED,MAAM,MAAM,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,IAAI;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KACjC,EAAE,CAAA;CACJ,GAAG,IAAI,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEzF,MAAM,MAAM,uBAAuB,CAAC,WAAW,GAAG,OAAO,IAAI;IAC3D;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC;;OAEG;IACH,WAAW,EAAE;SACV,GAAG,IAAI,cAAc,CAAC,CAAC,EAAE;YACxB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAA;YAClB;;;;eAIG;YACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;YAC3B;;;;eAIG;YACH,eAAe,CAAC,EAAE,OAAO,CAAA;SAC1B;KACF,CAAA;IACD;;;;;OAKG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;QACpC;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;;;;OAKG;IACH,iBAAiB,CAAC,EACd;QACE;;WAEG;QACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAA;QACvC;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B;;WAEG;QACH,mBAAmB,CAAC,EAAE,IAAI,CAAA;QAC1B;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,EAAE,CAAA;QACnB;;WAEG;QACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAA;KAChD,GACD;QACE,gBAAgB,CAAC,EAAE,KAAK,CAAA;QACxB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B;;WAEG;QACH,mBAAmB,CAAC,EAAE,KAAK,CAAA;QAC3B,SAAS,CAAC,EAAE,KAAK,CAAA;QACjB,iBAAiB,CAAC,EAAE,KAAK,CAAA;KAC1B,CAAA;IACL;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,CAC1B,IAAI,EAAE,WAAW,SAAS;QAAE,IAAI,EAAE,OAAO,CAAA;KAAE,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,KACrE,OAAO,CAAA;IACZ;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,IAAI;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KACjC,EAAE,CAAA;CACJ,GAAG,IAAI,CAAA"}

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { ArrayField, CollectionSlug, Field, RelationshipField, User } from 'payload'\n\nexport type MultiTenantPluginConfig<ConfigTypes = unknown> = {\n  /**\n   * After a tenant is deleted, the plugin will attempt to clean up related documents\n   * - removing documents with the tenant ID\n   * - removing the tenant from users\n   *\n   * @default true\n   */\n  cleanupAfterTenantDelete?: boolean\n  /**\n   * Automatically\n   */\n  collections: {\n    [key in CollectionSlug]?: {\n      /**\n       * Set to `true` if you want the collection to behave as a global\n       *\n       * @default false\n       */\n      isGlobal?: boolean\n      /**\n       * Set to `false` if you want to manually apply the baseListFilter\n       *\n       * @default true\n       */\n      useBaseListFilter?: boolean\n      /**\n       * Set to `false` if you want to handle collection access manually without the multi-tenant constraints applied\n       *\n       * @default true\n       */\n      useTenantAccess?: boolean\n    }\n  }\n  /**\n   * Enables debug mode\n   * - Makes the tenant field visible in the admin UI within applicable collections\n   *\n   * @default false\n   */\n  debug?: boolean\n  /**\n   * Enables the multi-tenant plugin\n   *\n   * @default true\n   */\n  enabled?: boolean\n  /**\n   * Field configuration for the field added to all tenant enabled collections\n   */\n  tenantField?: {\n    access?: RelationshipField['access']\n    /**\n     * The name of the field added to all tenant enabled collections\n     *\n     * @default 'tenant'\n     */\n    name?: string\n  }\n  /**\n   * Field configuration for the field added to the users collection\n   *\n   * If `includeDefaultField` is `false`, you must include the field on your users collection manually\n   * This is useful if you want to customize the field or place the field in a specific location\n   */\n  tenantsArrayField?:\n    | {\n        /**\n         * Access configuration for the array field\n         */\n        arrayFieldAccess?: ArrayField['access']\n        /**\n         * Name of the array field\n         *\n         * @default 'tenants'\n         */\n        arrayFieldName?: string\n        /**\n         * Name of the tenant field\n         *\n         * @default 'tenant'\n         */\n        arrayTenantFieldName?: string\n        /**\n         * When `includeDefaultField` is `true`, the field will be added to the users collection automatically\n         */\n        includeDefaultField?: true\n        /**\n         * Additional fields to include on the tenants array field\n         */\n        rowFields?: Field[]\n        /**\n         * Access configuration for the tenant field\n         */\n        tenantFieldAccess?: RelationshipField['access']\n      }\n    | {\n        arrayFieldAccess?: never\n        arrayFieldName?: string\n        arrayTenantFieldName?: string\n        /**\n         * When `includeDefaultField` is `false`, you must include the field on your users collection manually\n         */\n        includeDefaultField?: false\n        rowFields?: never\n        tenantFieldAccess?: never\n      }\n  /**\n   * The slug for the tenant collection\n   *\n   * @default 'tenants'\n   */\n  tenantsSlug?: string\n  /**\n   * Function that determines if a user has access to _all_ tenants\n   *\n   * Useful for super-admin type users\n   */\n  userHasAccessToAllTenants?: (\n    user: ConfigTypes extends { user: unknown } ? ConfigTypes['user'] : User,\n  ) => boolean\n}\n\nexport type Tenant<IDType = number | string> = {\n  id: IDType\n  name: string\n}\n\nexport type UserWithTenantsField = {\n  tenants: {\n    tenant: number | string | Tenant\n  }[]\n} & User\n"],"names":[],"mappings":"AAkIA,WAIQ"}
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import type { ArrayField, CollectionSlug, Field, RelationshipField, User } from 'payload'\n\nexport type MultiTenantPluginConfig<ConfigTypes = unknown> = {\n  /**\n   * After a tenant is deleted, the plugin will attempt to clean up related documents\n   * - removing documents with the tenant ID\n   * - removing the tenant from users\n   *\n   * @default true\n   */\n  cleanupAfterTenantDelete?: boolean\n  /**\n   * Automatically\n   */\n  collections: {\n    [key in CollectionSlug]?: {\n      /**\n       * Set to `true` if you want the collection to behave as a global\n       *\n       * @default false\n       */\n      isGlobal?: boolean\n      /**\n       * Set to `false` if you want to manually apply the baseListFilter\n       *\n       * @default true\n       */\n      useBaseListFilter?: boolean\n      /**\n       * Set to `false` if you want to handle collection access manually without the multi-tenant constraints applied\n       *\n       * @default true\n       */\n      useTenantAccess?: boolean\n    }\n  }\n  /**\n   * Enables debug mode\n   * - Makes the tenant field visible in the admin UI within applicable collections\n   *\n   * @default false\n   */\n  debug?: boolean\n  /**\n   * Enables the multi-tenant plugin\n   *\n   * @default true\n   */\n  enabled?: boolean\n  /**\n   * Field configuration for the field added to all tenant enabled collections\n   */\n  tenantField?: {\n    access?: RelationshipField['access']\n    /**\n     * The name of the field added to all tenant enabled collections\n     *\n     * @default 'tenant'\n     */\n    name?: string\n  }\n  /**\n   * Field configuration for the field added to the users collection\n   *\n   * If `includeDefaultField` is `false`, you must include the field on your users collection manually\n   * This is useful if you want to customize the field or place the field in a specific location\n   */\n  tenantsArrayField?:\n    | {\n        /**\n         * Access configuration for the array field\n         */\n        arrayFieldAccess?: ArrayField['access']\n        /**\n         * Name of the array field\n         *\n         * @default 'tenants'\n         */\n        arrayFieldName?: string\n        /**\n         * Name of the tenant field\n         *\n         * @default 'tenant'\n         */\n        arrayTenantFieldName?: string\n        /**\n         * When `includeDefaultField` is `true`, the field will be added to the users collection automatically\n         */\n        includeDefaultField?: true\n        /**\n         * Additional fields to include on the tenants array field\n         */\n        rowFields?: Field[]\n        /**\n         * Access configuration for the tenant field\n         */\n        tenantFieldAccess?: RelationshipField['access']\n      }\n    | {\n        arrayFieldAccess?: never\n        arrayFieldName?: string\n        arrayTenantFieldName?: string\n        /**\n         * When `includeDefaultField` is `false`, you must include the field on your users collection manually\n         */\n        includeDefaultField?: false\n        rowFields?: never\n        tenantFieldAccess?: never\n      }\n  /**\n   * The slug for the tenant collection\n   *\n   * @default 'tenants'\n   */\n  tenantsSlug?: string\n  /**\n   * Function that determines if a user has access to _all_ tenants\n   *\n   * Useful for super-admin type users\n   */\n  userHasAccessToAllTenants?: (\n    user: ConfigTypes extends { user: unknown } ? ConfigTypes['user'] : User,\n  ) => boolean\n  /**\n   * Opt out of adding access constraints to the tenants collection\n   */\n  useTenantsCollectionAccess?: boolean\n}\n\nexport type Tenant<IDType = number | string> = {\n  id: IDType\n  name: string\n}\n\nexport type UserWithTenantsField = {\n  tenants: {\n    tenant: number | string | Tenant\n  }[]\n} & User\n"],"names":[],"mappings":"AAsIA,WAIQ"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payloadcms/plugin-multi-tenant",
-  "version": "3.21.0-canary.c6481e1",
+  "version": "3.21.0-canary.db74962",
   "description": "Multi Tenant plugin for Payload",
   "keywords": [
     "payload",
@@ -67,13 +67,13 @@
   ],
   "devDependencies": {
     "@payloadcms/eslint-config": "3.9.0",
-    "payload": "3.21.0-canary.c6481e1",
-    "@payloadcms/ui": "3.21.0-canary.c6481e1"
+    "@payloadcms/ui": "3.21.0-canary.db74962",
+    "payload": "3.21.0-canary.db74962"
   },
   "peerDependencies": {
     "next": "^15.0.3",
-    "@payloadcms/ui": "3.21.0-canary.c6481e1",
-    "payload": "3.21.0-canary.c6481e1"
+    "@payloadcms/ui": "3.21.0-canary.db74962",
+    "payload": "3.21.0-canary.db74962"
   },
   "homepage:": "https://payloadcms.com",
   "scripts": {