@payloadcms/plugin-multi-tenant 0.0.1 → 3.18.0

package/README.md

@@ -3,122 +3,126 @@
 A plugin for [Payload](https://github.com/payloadcms/payload) to easily manage multiple tenants from within your admin panel.
 
 - [Source code](https://github.com/payloadcms/payload/tree/main/packages/plugin-multi-tenant)
-<!-- - [Documentation](https://payloadcms.com/docs/plugins/multi-tenant)
-- [Documentation source](https://github.com/payloadcms/payload/tree/main/docs/plugins/multi-tenant.mdx) -->
+- [Documentation](https://payloadcms.com/docs/plugins/multi-tenant)
+- [Documentation source](https://github.com/payloadcms/payload/tree/main/docs/plugins/multi-tenant.mdx)
 
-## Plugin config example
+## Installation
+
+```bash
+pnpm add @payloadcms/plugin-multi-tenant@beta
+```
+
+## Plugin Types
 
 ```ts
-multiTenantPlugin({
-  /**
-   * Enable debugging:
-   * - shows the relationship field on enabled collection documents
-   *
-   * optional - @default false
-   */
-  debug: false,
-  /**
-   * Enables/Disables the plugin
-   *
-   * optional - @default true
-   */
-  enabled: true,
+type MultiTenantPluginConfig<ConfigTypes = unknown> = {
   /**
-   * The slug of the tenants collection you added to your config
+   * After a tenant is deleted, the plugin will attempt to clean up related documents
+   * - removing documents with the tenant ID
+   * - removing the tenant from users
    *
-   * optional - @default 'tenants'
+   * @default true
    */
-  tenantsSlug: 'tenants',
+  cleanupAfterTenantDelete?: boolean
   /**
-   * Define what collections you would like multi-tenancy to apply to
-   *
-   * Keyed on the slug of the collection
+   * Automatically
    */
   collections: {
-    pages: {
+    [key in CollectionSlug]?: {
       /**
-       * Used to opt out of using the provided baseListFilter
-       *
-       * You can use the exported utility "getTenantFilter" within your own list filter
+       * Set to `true` if you want the collection to behave as a global
        *
-       * optional - @default true
+       * @default false
        */
-      useBaseListFilter: true
+      isGlobal?: boolean
       /**
-       * Used to opt out of the merged access control provided
+       * Set to `false` if you want to manually apply the baseListFilter
        *
-       * You can use the exported utility "getTenantAccess" within your access control functions
-       *
-       * optional - @default true
+       * @default true
        */
-      useTenantAccess: true
-      /**
-       * Used to make a collection feel like a global. When navigating to the list view, they will be redirected to the document view.
-       *
-       * optional - @default false
-       */
-      isGlobal: false
-    },
-    /**
-     * Custom configuration for the tenant field placed on every enabled collection
-     */
-    documentTenantField: {
-      // optional - provide access control on the injected tenant field
-      access: {
-        create,
-        read,
-        update,
-      },
+      useBaseListFilter?: boolean
       /**
-       * Name of the field
+       * Set to `false` if you want to handle collection access manually without the multi-tenant constraints applied
        *
-       * optional - @default true
+       * @default true
        */
-      name: 'tenant',
-    },
-    /**
-     * Function that allows you to determine if certain users should have access to all tenants
-     *
-     * optional - @default () => false
-     */
-    userHasAccessToAllTenants: (user) => user.isSuperAdmin === true
+      useTenantAccess?: boolean
+    }
+  }
+  /**
+   * Enables debug mode
+   * - Makes the tenant field visible in the admin UI within applicable collections
+   *
+   * @default false
+   */
+  debug?: boolean
+  /**
+   * Enables the multi-tenant plugin
+   *
+   * @default true
+   */
+  enabled?: boolean
+  /**
+   * Field configuration for the field added to all tenant enabled collections
+   */
+  tenantField?: {
+    access?: RelationshipField['access']
     /**
-     * Options for the array field that gets added to the users collection.
+     * The name of the field added to all tenant enabled collections
      *
-     * The field is an array of rows, by default each row has a relationship to a tenant
-     *
-     * optional - @default undefined
+     * @default 'tenant'
      */
-    userTenantsField: {
-      /**
-       * Allows you to set access control on the array field
-       *
-       * optional - @default undefined
-       */
-      access: {
-        create, // optional
-        read, // optional
-        update, // optional
-      },
-      /**
-       * If you want to add additional fields to the tenant rows, you can specify them under rowFields
-       *
-       * optional - @default undefined
-       */
-      rowFields: [
-        // Example adding a field onto the array row
-        {
-          name: 'roles',
-          type: 'select',
-          options: [
-            { label: 'Admin', value: 'admin' },
-            { label: 'User', value: 'user' },
-          ],
-        },
-      ],
-    }
-  },
-})
+    name?: string
+  }
+  /**
+   * Field configuration for the field added to the users collection
+   *
+   * If `includeDefaultField` is `false`, you must include the field on your users collection manually
+   * This is useful if you want to customize the field or place the field in a specific location
+   */
+  tenantsArrayField?:
+    | {
+        /**
+         * Access configuration for the array field
+         */
+        arrayFieldAccess?: ArrayField['access']
+        /**
+         * When `includeDefaultField` is `true`, the field will be added to the users collection automatically
+         */
+        includeDefaultField?: true
+        /**
+         * Additional fields to include on the tenants array field
+         */
+        rowFields?: Field[]
+        /**
+         * Access configuration for the tenant field
+         */
+        tenantFieldAccess?: RelationshipField['access']
+      }
+    | {
+        arrayFieldAccess?: never
+        /**
+         * When `includeDefaultField` is `false`, you must include the field on your users collection manually
+         */
+        includeDefaultField?: false
+        rowFields?: never
+        tenantFieldAccess?: never
+      }
+  /**
+   * The slug for the tenant collection
+   *
+   * @default 'tenants'
+   */
+  tenantsSlug?: string
+  /**
+   * Function that determines if a user has access to _all_ tenants
+   *
+   * Useful for super-admin type users
+   */
+  userHasAccessToAllTenants?: (
+    user: ConfigTypes extends { user } ? ConfigTypes['user'] : User,
+  ) => boolean
+}
 ```
 
 ### How to configure Collections as Globals for multi-tenant
@@ -202,3 +206,34 @@ export default buildConfig({
   ],
 })
 ```
+
+### Placing the tenants array field
+
+In your users collection you may want to place the field in a tab or in the sidebar, or customize some of the properties on it.
+
+You can use the `tenantsArrayField.includeDefaultField: false` setting in the plugin config. You will then need to manually add a `tenants` array field in your users collection.
+
+This field cannot be nested inside a named field, ie a group, named-tab or array. It _can_ be nested inside a row, unnamed-tab, collapsible.
+
+To make it easier, this plugin exports the field for you to import and merge in your own properties.
+
+```ts
+import type { CollectionConfig } from 'payload'
+import { tenantsArrayField } from '@payloadcms/plugin-multi-tenant/fields'
+
+const customTenantsArrayField = tenantsArrayField({
+  arrayFieldAccess: {}, // access control for the array field
+  tenantFieldAccess: {}, // access control for the tenants field on the array row
+  rowFields: [], // additional row fields
+})
+
+export const UsersCollection: CollectionConfig = {
+  slug: 'users',
+  fields: [
+    {
+      ...customTenantsArrayField,
+      label: 'Associated Tenants',
+    },
+  ],
+}
+```

package/dist/components/GlobalViewRedirect/index.d.ts

@@ -1,9 +1,10 @@
-import type { CollectionSlug, ServerProps } from 'payload';
+import type { CollectionSlug, ServerProps, ViewTypes } from 'payload';
 type Args = {
     collectionSlug: CollectionSlug;
     docID?: number | string;
     globalSlugs: string[];
-    viewType: 'edit' | 'list';
+    tenantFieldName: string;
+    viewType: ViewTypes;
 } & ServerProps;
 export declare const GlobalViewRedirect: (args: Args) => Promise<void>;
 export {};

package/dist/components/GlobalViewRedirect/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/GlobalViewRedirect/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAM1D,KAAK,IAAI,GAAG;IACV,cAAc,EAAE,cAAc,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,GAAG,WAAW,CAAA;AAEf,eAAO,MAAM,kBAAkB,SAAgB,IAAI,kBAelD,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/GlobalViewRedirect/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAMrE,KAAK,IAAI,GAAG;IACV,cAAc,EAAE,cAAc,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,EAAE,SAAS,CAAA;CACpB,GAAG,WAAW,CAAA;AAEf,eAAO,MAAM,kBAAkB,SAAgB,IAAI,kBAgBlD,CAAA"}

package/dist/components/GlobalViewRedirect/index.js

@@ -7,6 +7,7 @@ export const GlobalViewRedirect = async (args)=>{
             slug: collectionSlug,
             docID: args.docID,
             payload: args.payload,
+            tenantFieldName: args.tenantFieldName,
             view: args.viewType
         });
         if (redirectRoute) {

package/dist/components/GlobalViewRedirect/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/components/GlobalViewRedirect/index.ts"],"sourcesContent":["import type { CollectionSlug, ServerProps } from 'payload'\n\nimport { redirect } from 'next/navigation.js'\n\nimport { getGlobalViewRedirect } from '../../utilities/getGlobalViewRedirect.js'\n\ntype Args = {\n  collectionSlug: CollectionSlug\n  docID?: number | string\n  globalSlugs: string[]\n  viewType: 'edit' | 'list'\n} & ServerProps\n\nexport const GlobalViewRedirect = async (args: Args) => {\n  const collectionSlug = args?.collectionSlug\n\n  if (collectionSlug && args.globalSlugs?.includes(collectionSlug)) {\n    const redirectRoute = await getGlobalViewRedirect({\n      slug: collectionSlug,\n      docID: args.docID,\n      payload: args.payload,\n      view: args.viewType,\n    })\n\n    if (redirectRoute) {\n      redirect(redirectRoute)\n    }\n  }\n}\n"],"names":["redirect","getGlobalViewRedirect","GlobalViewRedirect","args","collectionSlug","globalSlugs","includes","redirectRoute","slug","docID","payload","view","viewType"],"mappings":"AAEA,SAASA,QAAQ,QAAQ,qBAAoB;AAE7C,SAASC,qBAAqB,QAAQ,2CAA0C;AAShF,OAAO,MAAMC,qBAAqB,OAAOC;IACvC,MAAMC,iBAAiBD,MAAMC;IAE7B,IAAIA,kBAAkBD,KAAKE,WAAW,EAAEC,SAASF,iBAAiB;QAChE,MAAMG,gBAAgB,MAAMN,sBAAsB;YAChDO,MAAMJ;YACNK,OAAON,KAAKM,KAAK;YACjBC,SAASP,KAAKO,OAAO;YACrBC,MAAMR,KAAKS,QAAQ;QACrB;QAEA,IAAIL,eAAe;YACjBP,SAASO;QACX;IACF;AACF,EAAC"}
+{"version":3,"sources":["../../../src/components/GlobalViewRedirect/index.ts"],"sourcesContent":["import type { CollectionSlug, ServerProps, ViewTypes } from 'payload'\n\nimport { redirect } from 'next/navigation.js'\n\nimport { getGlobalViewRedirect } from '../../utilities/getGlobalViewRedirect.js'\n\ntype Args = {\n  collectionSlug: CollectionSlug\n  docID?: number | string\n  globalSlugs: string[]\n  tenantFieldName: string\n  viewType: ViewTypes\n} & ServerProps\n\nexport const GlobalViewRedirect = async (args: Args) => {\n  const collectionSlug = args?.collectionSlug\n\n  if (collectionSlug && args.globalSlugs?.includes(collectionSlug)) {\n    const redirectRoute = await getGlobalViewRedirect({\n      slug: collectionSlug,\n      docID: args.docID,\n      payload: args.payload,\n      tenantFieldName: args.tenantFieldName,\n      view: args.viewType,\n    })\n\n    if (redirectRoute) {\n      redirect(redirectRoute)\n    }\n  }\n}\n"],"names":["redirect","getGlobalViewRedirect","GlobalViewRedirect","args","collectionSlug","globalSlugs","includes","redirectRoute","slug","docID","payload","tenantFieldName","view","viewType"],"mappings":"AAEA,SAASA,QAAQ,QAAQ,qBAAoB;AAE7C,SAASC,qBAAqB,QAAQ,2CAA0C;AAUhF,OAAO,MAAMC,qBAAqB,OAAOC;IACvC,MAAMC,iBAAiBD,MAAMC;IAE7B,IAAIA,kBAAkBD,KAAKE,WAAW,EAAEC,SAASF,iBAAiB;QAChE,MAAMG,gBAAgB,MAAMN,sBAAsB;YAChDO,MAAMJ;YACNK,OAAON,KAAKM,KAAK;YACjBC,SAASP,KAAKO,OAAO;YACrBC,iBAAiBR,KAAKQ,eAAe;YACrCC,MAAMT,KAAKU,QAAQ;QACrB;QAEA,IAAIN,eAAe;YACjBP,SAASO;QACX;IACF;AACF,EAAC"}

package/dist/components/TenantField/index.client.d.ts

@@ -1,10 +1,10 @@
 import type { RelationshipFieldClientProps } from 'payload';
 import React from 'react';
+import './index.scss';
 type Props = {
     debug?: boolean;
-    serverValue?: number | string;
-    tenantsCollectionSlug: string;
+    unique?: boolean;
 } & RelationshipFieldClientProps;
-export declare const TenantFieldClient: (args: Props) => React.JSX.Element;
+export declare const TenantField: (args: Props) => React.JSX.Element | null;
 export {};
 //# sourceMappingURL=index.client.d.ts.map

package/dist/components/TenantField/index.client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.client.d.ts","sourceRoot":"","sources":["../../../src/components/TenantField/index.client.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AAG3D,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,KAAK,KAAK,GAAG;IACX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7B,qBAAqB,EAAE,MAAM,CAAA;CAC9B,GAAG,4BAA4B,CAAA;AAEhC,eAAO,MAAM,iBAAiB,SAAU,KAAK,sBA2B5C,CAAA"}
+{"version":3,"file":"index.client.d.ts","sourceRoot":"","sources":["../../../src/components/TenantField/index.client.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AAG3D,OAAO,KAAK,MAAM,OAAO,CAAA;AAIzB,OAAO,cAAc,CAAA;AAIrB,KAAK,KAAK,GAAG;IACX,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,GAAG,4BAA4B,CAAA;AAEhC,eAAO,MAAM,WAAW,SAAU,KAAK,6BA0CtC,CAAA"}

package/dist/components/TenantField/index.client.js

@@ -1,31 +1,69 @@
 'use client';
-import { jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { RelationshipField, useField } from '@payloadcms/ui';
 import React from 'react';
-export const TenantFieldClient = (args)=>{
-    const { path, serverValue } = args;
+import { SELECT_ALL } from '../../constants.js';
+import { useTenantSelection } from '../../providers/TenantSelectionProvider/index.client.js';
+import './index.scss';
+const baseClass = 'tenantField';
+export const TenantField = (args)=>{
+    const { debug, path, unique } = args;
     const { setValue, value } = useField({
         path
     });
+    const { options, selectedTenantID, setPreventRefreshOnChange, setTenant } = useTenantSelection();
+    const hasSetValueRef = React.useRef(false);
     React.useEffect(()=>{
-        if (serverValue && value !== serverValue) {
-            setValue(serverValue);
+        if (!hasSetValueRef.current && value) {
+            // set value on load
+            setTenant({
+                id: value,
+                refresh: unique
+            });
+            hasSetValueRef.current = true;
+        } else if (selectedTenantID && selectedTenantID === SELECT_ALL && options?.[0]?.value) {
+            // in the document view, the tenant field should always have a value
+            setTenant({
+                id: options[0].value,
+                refresh: unique
+            });
+        } else if ((!value || value !== selectedTenantID) && selectedTenantID) {
+            // Update the field value when the tenant is changed
+            setValue(selectedTenantID);
         }
     }, [
-        serverValue,
+        value,
+        selectedTenantID,
+        setTenant,
         setValue,
-        value
+        options,
+        unique
     ]);
-    if (args.debug) {
-        return /*#__PURE__*/ _jsx(RelationshipField, {
-            field: {
-                name: path,
-                type: 'relationship',
-                label: 'Tenant',
-                relationTo: args.tenantsCollectionSlug,
-                required: true
-            },
-            path: path
+    React.useEffect(()=>{
+        if (!unique) {
+            setPreventRefreshOnChange(true);
+        }
+        return ()=>{
+            setPreventRefreshOnChange(false);
+        };
+    }, [
+        unique,
+        setPreventRefreshOnChange
+    ]);
+    if (debug) {
+        return /*#__PURE__*/ _jsxs("div", {
+            className: baseClass,
+            children: [
+                /*#__PURE__*/ _jsx("div", {
+                    className: `${baseClass}__wrapper`,
+                    children: /*#__PURE__*/ _jsx(RelationshipField, {
+                        ...args
+                    })
+                }),
+                /*#__PURE__*/ _jsx("div", {
+                    className: `${baseClass}__hr`
+                })
+            ]
         });
     }
     return null;

package/dist/components/TenantField/index.client.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/components/TenantField/index.client.tsx"],"sourcesContent":["'use client'\n\nimport type { RelationshipFieldClientProps } from 'payload'\n\nimport { RelationshipField, useField } from '@payloadcms/ui'\nimport React from 'react'\n\ntype Props = {\n  debug?: boolean\n  serverValue?: number | string\n  tenantsCollectionSlug: string\n} & RelationshipFieldClientProps\n\nexport const TenantFieldClient = (args: Props) => {\n  const { path, serverValue } = args\n\n  const { setValue, value } = useField({ path })\n\n  React.useEffect(() => {\n    if (serverValue && value !== serverValue) {\n      setValue(serverValue)\n    }\n  }, [serverValue, setValue, value])\n\n  if (args.debug) {\n    return (\n      <RelationshipField\n        field={{\n          name: path,\n          type: 'relationship',\n          label: 'Tenant',\n          relationTo: args.tenantsCollectionSlug,\n          required: true,\n        }}\n        path={path}\n      />\n    )\n  }\n\n  return null\n}\n"],"names":["RelationshipField","useField","React","TenantFieldClient","args","path","serverValue","setValue","value","useEffect","debug","field","name","type","label","relationTo","tenantsCollectionSlug","required"],"mappings":"AAAA;;AAIA,SAASA,iBAAiB,EAAEC,QAAQ,QAAQ,iBAAgB;AAC5D,OAAOC,WAAW,QAAO;AAQzB,OAAO,MAAMC,oBAAoB,CAACC;IAChC,MAAM,EAAEC,IAAI,EAAEC,WAAW,EAAE,GAAGF;IAE9B,MAAM,EAAEG,QAAQ,EAAEC,KAAK,EAAE,GAAGP,SAAS;QAAEI;IAAK;IAE5CH,MAAMO,SAAS,CAAC;QACd,IAAIH,eAAeE,UAAUF,aAAa;YACxCC,SAASD;QACX;IACF,GAAG;QAACA;QAAaC;QAAUC;KAAM;IAEjC,IAAIJ,KAAKM,KAAK,EAAE;QACd,qBACE,KAACV;YACCW,OAAO;gBACLC,MAAMP;gBACNQ,MAAM;gBACNC,OAAO;gBACPC,YAAYX,KAAKY,qBAAqB;gBACtCC,UAAU;YACZ;YACAZ,MAAMA;;IAGZ;IAEA,OAAO;AACT,EAAC"}
+{"version":3,"sources":["../../../src/components/TenantField/index.client.tsx"],"sourcesContent":["'use client'\n\nimport type { RelationshipFieldClientProps } from 'payload'\n\nimport { RelationshipField, useField } from '@payloadcms/ui'\nimport React from 'react'\n\nimport { SELECT_ALL } from '../../constants.js'\nimport { useTenantSelection } from '../../providers/TenantSelectionProvider/index.client.js'\nimport './index.scss'\n\nconst baseClass = 'tenantField'\n\ntype Props = {\n  debug?: boolean\n  unique?: boolean\n} & RelationshipFieldClientProps\n\nexport const TenantField = (args: Props) => {\n  const { debug, path, unique } = args\n  const { setValue, value } = useField<number | string>({ path })\n  const { options, selectedTenantID, setPreventRefreshOnChange, setTenant } = useTenantSelection()\n\n  const hasSetValueRef = React.useRef(false)\n\n  React.useEffect(() => {\n    if (!hasSetValueRef.current && value) {\n      // set value on load\n      setTenant({ id: value, refresh: unique })\n      hasSetValueRef.current = true\n    } else if (selectedTenantID && selectedTenantID === SELECT_ALL && options?.[0]?.value) {\n      // in the document view, the tenant field should always have a value\n      setTenant({ id: options[0].value, refresh: unique })\n    } else if ((!value || value !== selectedTenantID) && selectedTenantID) {\n      // Update the field value when the tenant is changed\n      setValue(selectedTenantID)\n    }\n  }, [value, selectedTenantID, setTenant, setValue, options, unique])\n\n  React.useEffect(() => {\n    if (!unique) {\n      setPreventRefreshOnChange(true)\n    }\n    return () => {\n      setPreventRefreshOnChange(false)\n    }\n  }, [unique, setPreventRefreshOnChange])\n\n  if (debug) {\n    return (\n      <div className={baseClass}>\n        <div className={`${baseClass}__wrapper`}>\n          <RelationshipField {...args} />\n        </div>\n        <div className={`${baseClass}__hr`} />\n      </div>\n    )\n  }\n\n  return null\n}\n"],"names":["RelationshipField","useField","React","SELECT_ALL","useTenantSelection","baseClass","TenantField","args","debug","path","unique","setValue","value","options","selectedTenantID","setPreventRefreshOnChange","setTenant","hasSetValueRef","useRef","useEffect","current","id","refresh","div","className"],"mappings":"AAAA;;AAIA,SAASA,iBAAiB,EAAEC,QAAQ,QAAQ,iBAAgB;AAC5D,OAAOC,WAAW,QAAO;AAEzB,SAASC,UAAU,QAAQ,qBAAoB;AAC/C,SAASC,kBAAkB,QAAQ,0DAAyD;AAC5F,OAAO,eAAc;AAErB,MAAMC,YAAY;AAOlB,OAAO,MAAMC,cAAc,CAACC;IAC1B,MAAM,EAAEC,KAAK,EAAEC,IAAI,EAAEC,MAAM,EAAE,GAAGH;IAChC,MAAM,EAAEI,QAAQ,EAAEC,KAAK,EAAE,GAAGX,SAA0B;QAAEQ;IAAK;IAC7D,MAAM,EAAEI,OAAO,EAAEC,gBAAgB,EAAEC,yBAAyB,EAAEC,SAAS,EAAE,GAAGZ;IAE5E,MAAMa,iBAAiBf,MAAMgB,MAAM,CAAC;IAEpChB,MAAMiB,SAAS,CAAC;QACd,IAAI,CAACF,eAAeG,OAAO,IAAIR,OAAO;YACpC,oBAAoB;YACpBI,UAAU;gBAAEK,IAAIT;gBAAOU,SAASZ;YAAO;YACvCO,eAAeG,OAAO,GAAG;QAC3B,OAAO,IAAIN,oBAAoBA,qBAAqBX,cAAcU,SAAS,CAAC,EAAE,EAAED,OAAO;YACrF,oEAAoE;YACpEI,UAAU;gBAAEK,IAAIR,OAAO,CAAC,EAAE,CAACD,KAAK;gBAAEU,SAASZ;YAAO;QACpD,OAAO,IAAI,AAAC,CAAA,CAACE,SAASA,UAAUE,gBAAe,KAAMA,kBAAkB;YACrE,oDAAoD;YACpDH,SAASG;QACX;IACF,GAAG;QAACF;QAAOE;QAAkBE;QAAWL;QAAUE;QAASH;KAAO;IAElER,MAAMiB,SAAS,CAAC;QACd,IAAI,CAACT,QAAQ;YACXK,0BAA0B;QAC5B;QACA,OAAO;YACLA,0BAA0B;QAC5B;IACF,GAAG;QAACL;QAAQK;KAA0B;IAEtC,IAAIP,OAAO;QACT,qBACE,MAACe;YAAIC,WAAWnB;;8BACd,KAACkB;oBAAIC,WAAW,GAAGnB,UAAU,SAAS,CAAC;8BACrC,cAAA,KAACL;wBAAmB,GAAGO,IAAI;;;8BAE7B,KAACgB;oBAAIC,WAAW,GAAGnB,UAAU,IAAI,CAAC;;;;IAGxC;IAEA,OAAO;AACT,EAAC"}

package/dist/components/TenantField/index.scss

@@ -0,0 +1,14 @@
+.tenantField {
+  &__wrapper {
+    margin-top: calc(-.75 * var(--spacing-field));
+    margin-bottom: var(--spacing-field);
+    width: 25%;
+  }
+  &__hr {
+    width: calc(100% + 2 * var(--gutter-h));
+    margin-left: calc(-1 * var(--gutter-h));
+    background-color: var(--theme-elevation-100);
+    height: 1px;
+    margin-bottom: var(--spacing-field);
+  }
+ }

package/dist/components/TenantSelector/index.d.ts

@@ -1,10 +1,7 @@
-import type { ServerProps } from 'payload';
+import type { ViewTypes } from 'payload';
+import './index.scss';
 import React from 'react';
-import type { MultiTenantPluginConfig, UserWithTenantsField } from '../../types.js';
-type Args = {
-    tenantsCollectionSlug: MultiTenantPluginConfig['tenantsSlug'];
-    user?: UserWithTenantsField;
-} & ServerProps;
-export declare const TenantSelector: ({ payload, tenantsCollectionSlug, user }: Args) => Promise<React.JSX.Element>;
-export {};
+export declare const TenantSelector: ({ viewType }: {
+    viewType?: ViewTypes;
+}) => React.JSX.Element | null;
 //# sourceMappingURL=index.d.ts.map

package/dist/components/TenantSelector/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/TenantSelector/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAG1C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAE,uBAAuB,EAAU,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAI3F,KAAK,IAAI,GAAG;IACV,qBAAqB,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAA;IAC7D,IAAI,CAAC,EAAE,oBAAoB,CAAA;CAC5B,GAAG,WAAW,CAAA;AAEf,eAAO,MAAM,cAAc,6CAAoD,IAAI,+BAgClF,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/TenantSelector/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAIxC,OAAO,cAAc,CAAA;AAErB,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,eAAO,MAAM,cAAc,iBAAkB;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,6BAqCpE,CAAA"}

package/dist/components/TenantSelector/index.js

@@ -1,30 +1,41 @@
+'use client';
 import { jsx as _jsx } from "react/jsx-runtime";
-import { cookies as getCookies } from 'next/headers.js';
+import { SelectInput } from '@payloadcms/ui';
+import './index.scss';
 import React from 'react';
-import { TenantSelectorClient } from './index.client.js';
-export const TenantSelector = async ({ payload, tenantsCollectionSlug, user })=>{
-    const { docs: userTenants } = await payload.find({
-        collection: tenantsCollectionSlug,
-        depth: 0,
-        limit: 1000,
-        overrideAccess: false,
-        sort: 'name',
-        user
-    });
-    const tenantOptions = userTenants.map((doc)=>({
-            label: doc.name,
-            value: String(doc.id)
-        }));
-    let cookieToSet;
-    const cookies = await getCookies();
-    const selectedTenant = tenantOptions.find((tenant)=>tenant.value === cookies.get('payload-tenant')?.value)?.value;
-    if (!selectedTenant && userTenants.length > 0) {
-        cookieToSet = String(userTenants[0].id);
+import { SELECT_ALL } from '../../constants.js';
+import { useTenantSelection } from '../../providers/TenantSelectionProvider/index.client.js';
+export const TenantSelector = ({ viewType })=>{
+    const { options, selectedTenantID, setTenant } = useTenantSelection();
+    const handleChange = React.useCallback((option)=>{
+        if (option && 'value' in option) {
+            setTenant({
+                id: option.value,
+                refresh: true
+            });
+        } else {
+            setTenant({
+                id: undefined,
+                refresh: true
+            });
+        }
+    }, [
+        setTenant
+    ]);
+    if (options.length <= 1) {
+        return null;
     }
-    return /*#__PURE__*/ _jsx(TenantSelectorClient, {
-        cookieToSet: cookieToSet,
-        initialValue: selectedTenant,
-        options: tenantOptions
+    return /*#__PURE__*/ _jsx("div", {
+        className: "tenant-selector",
+        children: /*#__PURE__*/ _jsx(SelectInput, {
+            isClearable: viewType === 'list',
+            label: "Tenant",
+            name: "setTenant",
+            onChange: handleChange,
+            options: options,
+            path: "setTenant",
+            value: selectedTenantID ? selectedTenantID === SELECT_ALL ? undefined : String(selectedTenantID) : undefined
+        })
     });
 };
 

package/dist/components/TenantSelector/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/components/TenantSelector/index.tsx"],"sourcesContent":["import type { ServerProps } from 'payload'\n\nimport { cookies as getCookies } from 'next/headers.js'\nimport React from 'react'\n\nimport type { MultiTenantPluginConfig, Tenant, UserWithTenantsField } from '../../types.js'\n\nimport { TenantSelectorClient } from './index.client.js'\n\ntype Args = {\n  tenantsCollectionSlug: MultiTenantPluginConfig['tenantsSlug']\n  user?: UserWithTenantsField\n} & ServerProps\n\nexport const TenantSelector = async ({ payload, tenantsCollectionSlug, user }: Args) => {\n  const { docs: userTenants } = await payload.find({\n    collection: tenantsCollectionSlug,\n    depth: 0,\n    limit: 1000,\n    overrideAccess: false,\n    sort: 'name',\n    user,\n  })\n\n  const tenantOptions = userTenants.map((doc: Tenant) => ({\n    label: doc.name,\n    value: String(doc.id),\n  }))\n\n  let cookieToSet: string | undefined\n  const cookies = await getCookies()\n  const selectedTenant = tenantOptions.find(\n    (tenant) => tenant.value === cookies.get('payload-tenant')?.value,\n  )?.value\n\n  if (!selectedTenant && userTenants.length > 0) {\n    cookieToSet = String(userTenants[0].id)\n  }\n\n  return (\n    <TenantSelectorClient\n      cookieToSet={cookieToSet}\n      initialValue={selectedTenant}\n      options={tenantOptions}\n    />\n  )\n}\n"],"names":["cookies","getCookies","React","TenantSelectorClient","TenantSelector","payload","tenantsCollectionSlug","user","docs","userTenants","find","collection","depth","limit","overrideAccess","sort","tenantOptions","map","doc","label","name","value","String","id","cookieToSet","selectedTenant","tenant","get","length","initialValue","options"],"mappings":";AAEA,SAASA,WAAWC,UAAU,QAAQ,kBAAiB;AACvD,OAAOC,WAAW,QAAO;AAIzB,SAASC,oBAAoB,QAAQ,oBAAmB;AAOxD,OAAO,MAAMC,iBAAiB,OAAO,EAAEC,OAAO,EAAEC,qBAAqB,EAAEC,IAAI,EAAQ;IACjF,MAAM,EAAEC,MAAMC,WAAW,EAAE,GAAG,MAAMJ,QAAQK,IAAI,CAAC;QAC/CC,YAAYL;QACZM,OAAO;QACPC,OAAO;QACPC,gBAAgB;QAChBC,MAAM;QACNR;IACF;IAEA,MAAMS,gBAAgBP,YAAYQ,GAAG,CAAC,CAACC,MAAiB,CAAA;YACtDC,OAAOD,IAAIE,IAAI;YACfC,OAAOC,OAAOJ,IAAIK,EAAE;QACtB,CAAA;IAEA,IAAIC;IACJ,MAAMxB,UAAU,MAAMC;IACtB,MAAMwB,iBAAiBT,cAAcN,IAAI,CACvC,CAACgB,SAAWA,OAAOL,KAAK,KAAKrB,QAAQ2B,GAAG,CAAC,mBAAmBN,QAC3DA;IAEH,IAAI,CAACI,kBAAkBhB,YAAYmB,MAAM,GAAG,GAAG;QAC7CJ,cAAcF,OAAOb,WAAW,CAAC,EAAE,CAACc,EAAE;IACxC;IAEA,qBACE,KAACpB;QACCqB,aAAaA;QACbK,cAAcJ;QACdK,SAASd;;AAGf,EAAC"}
+{"version":3,"sources":["../../../src/components/TenantSelector/index.tsx"],"sourcesContent":["'use client'\nimport type { ReactSelectOption } from '@payloadcms/ui'\nimport type { ViewTypes } from 'payload'\n\nimport { SelectInput } from '@payloadcms/ui'\n\nimport './index.scss'\n\nimport React from 'react'\n\nimport { SELECT_ALL } from '../../constants.js'\nimport { useTenantSelection } from '../../providers/TenantSelectionProvider/index.client.js'\n\nexport const TenantSelector = ({ viewType }: { viewType?: ViewTypes }) => {\n  const { options, selectedTenantID, setTenant } = useTenantSelection()\n\n  const handleChange = React.useCallback(\n    (option: ReactSelectOption | ReactSelectOption[]) => {\n      if (option && 'value' in option) {\n        setTenant({ id: option.value as string, refresh: true })\n      } else {\n        setTenant({ id: undefined, refresh: true })\n      }\n    },\n    [setTenant],\n  )\n\n  if (options.length <= 1) {\n    return null\n  }\n\n  return (\n    <div className=\"tenant-selector\">\n      <SelectInput\n        isClearable={viewType === 'list'}\n        label=\"Tenant\"\n        name=\"setTenant\"\n        onChange={handleChange}\n        options={options}\n        path=\"setTenant\"\n        value={\n          selectedTenantID\n            ? selectedTenantID === SELECT_ALL\n              ? undefined\n              : String(selectedTenantID)\n            : undefined\n        }\n      />\n    </div>\n  )\n}\n"],"names":["SelectInput","React","SELECT_ALL","useTenantSelection","TenantSelector","viewType","options","selectedTenantID","setTenant","handleChange","useCallback","option","id","value","refresh","undefined","length","div","className","isClearable","label","name","onChange","path","String"],"mappings":"AAAA;;AAIA,SAASA,WAAW,QAAQ,iBAAgB;AAE5C,OAAO,eAAc;AAErB,OAAOC,WAAW,QAAO;AAEzB,SAASC,UAAU,QAAQ,qBAAoB;AAC/C,SAASC,kBAAkB,QAAQ,0DAAyD;AAE5F,OAAO,MAAMC,iBAAiB,CAAC,EAAEC,QAAQ,EAA4B;IACnE,MAAM,EAAEC,OAAO,EAAEC,gBAAgB,EAAEC,SAAS,EAAE,GAAGL;IAEjD,MAAMM,eAAeR,MAAMS,WAAW,CACpC,CAACC;QACC,IAAIA,UAAU,WAAWA,QAAQ;YAC/BH,UAAU;gBAAEI,IAAID,OAAOE,KAAK;gBAAYC,SAAS;YAAK;QACxD,OAAO;YACLN,UAAU;gBAAEI,IAAIG;gBAAWD,SAAS;YAAK;QAC3C;IACF,GACA;QAACN;KAAU;IAGb,IAAIF,QAAQU,MAAM,IAAI,GAAG;QACvB,OAAO;IACT;IAEA,qBACE,KAACC;QAAIC,WAAU;kBACb,cAAA,KAAClB;YACCmB,aAAad,aAAa;YAC1Be,OAAM;YACNC,MAAK;YACLC,UAAUb;YACVH,SAASA;YACTiB,MAAK;YACLV,OACEN,mBACIA,qBAAqBL,aACnBa,YACAS,OAAOjB,oBACTQ;;;AAKd,EAAC"}

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const SELECT_ALL = "_ALL_";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,UAAU,CAAA"}

package/dist/constants.js

@@ -0,0 +1,4 @@
+// The tenant cookie can be set to _ALL_ to allow users to see all results for tenants they are a member of.
+export const SELECT_ALL = '_ALL_';
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["// The tenant cookie can be set to _ALL_ to allow users to see all results for tenants they are a member of.\nexport const SELECT_ALL = '_ALL_'\n"],"names":["SELECT_ALL"],"mappings":"AAAA,4GAA4G;AAC5G,OAAO,MAAMA,aAAa,QAAO"}

package/dist/exports/client.d.ts

@@ -0,0 +1,3 @@
+export { TenantField } from '../components/TenantField/index.client.js';
+export { TenantSelector } from '../components/TenantSelector/index.js';
+//# sourceMappingURL=client.d.ts.map

package/dist/exports/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/exports/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAA;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA"}

package/dist/exports/client.js

@@ -0,0 +1,4 @@
+export { TenantField } from '../components/TenantField/index.client.js';
+export { TenantSelector } from '../components/TenantSelector/index.js';
+
+//# sourceMappingURL=client.js.map

package/dist/exports/client.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/exports/client.ts"],"sourcesContent":["export { TenantField } from '../components/TenantField/index.client.js'\nexport { TenantSelector } from '../components/TenantSelector/index.js'\n"],"names":["TenantField","TenantSelector"],"mappings":"AAAA,SAASA,WAAW,QAAQ,4CAA2C;AACvE,SAASC,cAAc,QAAQ,wCAAuC"}

package/dist/exports/fields.d.ts

@@ -0,0 +1,3 @@
+export { tenantField } from '../fields/tenantField/index.js';
+export { tenantsArrayField } from '../fields/tenantsArrayField/index.js';
+//# sourceMappingURL=fields.d.ts.map

package/dist/exports/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/exports/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAA;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA"}

package/dist/exports/fields.js

@@ -0,0 +1,4 @@
+export { tenantField } from '../fields/tenantField/index.js';
+export { tenantsArrayField } from '../fields/tenantsArrayField/index.js';
+
+//# sourceMappingURL=fields.js.map

package/dist/exports/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/exports/fields.ts"],"sourcesContent":["export { tenantField } from '../fields/tenantField/index.js'\nexport { tenantsArrayField } from '../fields/tenantsArrayField/index.js'\n"],"names":["tenantField","tenantsArrayField"],"mappings":"AAAA,SAASA,WAAW,QAAQ,iCAAgC;AAC5D,SAASC,iBAAiB,QAAQ,uCAAsC"}

package/dist/exports/rsc.d.ts

@@ -1,4 +1,3 @@
 export { GlobalViewRedirect } from '../components/GlobalViewRedirect/index.js';
-export { TenantField } from '../components/TenantField/index.js';
-export { TenantSelector } from '../components/TenantSelector/index.js';
+export { TenantSelectionProvider } from '../providers/TenantSelectionProvider/index.js';
 //# sourceMappingURL=rsc.d.ts.map

package/dist/exports/rsc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rsc.d.ts","sourceRoot":"","sources":["../../src/exports/rsc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAA;AAC9E,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA"}
+{"version":3,"file":"rsc.d.ts","sourceRoot":"","sources":["../../src/exports/rsc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAA;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAA"}

package/dist/exports/rsc.js

@@ -1,5 +1,4 @@
 export { GlobalViewRedirect } from '../components/GlobalViewRedirect/index.js';
-export { TenantField } from '../components/TenantField/index.js';
-export { TenantSelector } from '../components/TenantSelector/index.js';
+export { TenantSelectionProvider } from '../providers/TenantSelectionProvider/index.js';
 
 //# sourceMappingURL=rsc.js.map