@payloadcms/plugin-multi-tenant 0.0.1

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018-2024 Payload CMS, Inc. <info@payloadcms.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,204 @@
+# Multi Tenant Plugin
+
+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) -->
+
+## Plugin config example
+
+```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,
+  /**
+   * The slug of the tenants collection you added to your config
+   *
+   * optional - @default 'tenants'
+   */
+  tenantsSlug: 'tenants',
+  /**
+   * Define what collections you would like multi-tenancy to apply to
+   *
+   * Keyed on the slug of the collection
+   */
+  collections: {
+    pages: {
+      /**
+       * Used to opt out of using the provided baseListFilter
+       *
+       * You can use the exported utility "getTenantFilter" within your own list filter
+       *
+       * optional - @default true
+       */
+      useBaseListFilter: true
+      /**
+       * Used to opt out of the merged access control provided
+       *
+       * You can use the exported utility "getTenantAccess" within your access control functions
+       *
+       * optional - @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,
+      },
+      /**
+       * Name of the field
+       *
+       * optional - @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
+    /**
+     * Options for the array field that gets added to the users collection.
+     *
+     * The field is an array of rows, by default each row has a relationship to a tenant
+     *
+     * optional - @default undefined
+     */
+    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' },
+          ],
+        },
+      ],
+    }
+  },
+})
+```
+
+### How to configure Collections as Globals for multi-tenant
+
+When using multi-tenant, globals need to actually be configured as collections so the content can be specific per tenant.
+To do that, you can mark a collection with `isGlobal` and it will behave like a global and users will not see the list view.
+
+```ts
+multiTenantPlugin({
+  collections: {
+    navigation: {
+      isGlobal: true,
+    },
+  },
+})
+```
+
+### Customizing access control
+
+In some cases, the access control supplied out of the box may be too strict. For example, if you need _some_ documents to be shared between tenants, you will need to opt out of the supplied access control functionality.
+
+By default this plugin merges your access control result with a constraint based on tenants the user has access to within an _AND_ condition. That would not work for the above scenario.
+
+In the multi-tenant plugin config you can set `useTenantAccess` to false:
+
+```ts
+// File: payload.config.ts
+
+import { buildConfig } from 'payload'
+import { multiTenantPlugin } from '@payloadcms/plugin-multi-tenant'
+import { getTenantAccess } from '@payloadcms/plugin-multi-tenant/utilities'
+import { Config as ConfigTypes } from './payload-types'
+
+// Add the plugin to your payload config
+export default buildConfig({
+  plugins: [
+    multiTenantPlugin({
+      collections: {
+        media: {
+          useTenantAccess: false,
+        },
+      },
+    }),
+  ],
+  collections: [
+    {
+      slug: 'media',
+      fields: [
+        {
+          name: 'isShared',
+          type: 'checkbox',
+          defaultValue: false,
+          // you likely want to set access control on fields like this
+          // to prevent just any user from modifying it
+        },
+      ],
+      access: {
+        read: ({ req, doc }) => {
+          if (!req.user) return false
+
+          const whereConstraint = {
+            or: [
+              {
+                isShared: {
+                  equals: true,
+                },
+              },
+            ],
+          }
+
+          const tenantAccessResult = getTenantAccess({ user: req.user })
+
+          if (tenantAccessResult) {
+            whereConstraint.or.push(tenantAccessResult)
+          }
+
+          return whereConstraint
+        },
+      },
+    },
+  ],
+})
+```

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

@@ -0,0 +1,10 @@
+import type { CollectionSlug, ServerProps } from 'payload';
+type Args = {
+    collectionSlug: CollectionSlug;
+    docID?: number | string;
+    globalSlugs: string[];
+    viewType: 'edit' | 'list';
+} & ServerProps;
+export declare const GlobalViewRedirect: (args: Args) => Promise<void>;
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/dist/components/GlobalViewRedirect/index.js

@@ -0,0 +1,18 @@
+import { redirect } from 'next/navigation.js';
+import { getGlobalViewRedirect } from '../../utilities/getGlobalViewRedirect.js';
+export const GlobalViewRedirect = async (args)=>{
+    const collectionSlug = args?.collectionSlug;
+    if (collectionSlug && args.globalSlugs?.includes(collectionSlug)) {
+        const redirectRoute = await getGlobalViewRedirect({
+            slug: collectionSlug,
+            docID: args.docID,
+            payload: args.payload,
+            view: args.viewType
+        });
+        if (redirectRoute) {
+            redirect(redirectRoute);
+        }
+    }
+};
+
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

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

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

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

@@ -0,0 +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"}

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

@@ -0,0 +1,34 @@
+'use client';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { RelationshipField, useField } from '@payloadcms/ui';
+import React from 'react';
+export const TenantFieldClient = (args)=>{
+    const { path, serverValue } = args;
+    const { setValue, value } = useField({
+        path
+    });
+    React.useEffect(()=>{
+        if (serverValue && value !== serverValue) {
+            setValue(serverValue);
+        }
+    }, [
+        serverValue,
+        setValue,
+        value
+    ]);
+    if (args.debug) {
+        return /*#__PURE__*/ _jsx(RelationshipField, {
+            field: {
+                name: path,
+                type: 'relationship',
+                label: 'Tenant',
+                relationTo: args.tenantsCollectionSlug,
+                required: true
+            },
+            path: path
+        });
+    }
+    return null;
+};
+
+//# sourceMappingURL=index.client.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,3 @@
+import React from 'react';
+export declare const TenantField: React.FC;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/TenantField/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,OAAO,CAAA;AAazB,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAwC/B,CAAA"}

package/dist/components/TenantField/index.js

@@ -0,0 +1,33 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React from 'react';
+import { getTenantFromCookie } from '../../utilities/getTenantFromCookie.js';
+import { getUserTenantIDs } from '../../utilities/getUserTenantIDs.js';
+import { TenantFieldClient } from './index.client.js';
+export const TenantField = async ({ clientField, debug, path, payload, readOnly, req, tenantsCollectionSlug, user })=>{
+    let serverValue = getTenantFromCookie(req.headers, payload.db.defaultIDType) || getUserTenantIDs(user)?.[0];
+    if (serverValue) {
+        try {
+            // validate that the tenant exists
+            const doc = await payload.findByID({
+                id: serverValue,
+                collection: tenantsCollectionSlug,
+                depth: 0
+            });
+            if (!doc) {
+                serverValue = undefined;
+            }
+        } catch (_) {
+            serverValue = undefined;
+        }
+    }
+    return /*#__PURE__*/ _jsx(TenantFieldClient, {
+        debug: debug,
+        field: clientField,
+        path: path,
+        readOnly: readOnly,
+        serverValue: serverValue,
+        tenantsCollectionSlug: tenantsCollectionSlug
+    });
+};
+
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/components/TenantField/index.tsx"],"sourcesContent":["import type { RelationshipFieldServerProps } from 'payload'\n\nimport React from 'react'\n\nimport type { UserWithTenantsField } from '../../types.js'\n\nimport { getTenantFromCookie } from '../../utilities/getTenantFromCookie.js'\nimport { getUserTenantIDs } from '../../utilities/getUserTenantIDs.js'\nimport { TenantFieldClient } from './index.client.js'\n\ntype Props = {\n  debug?: boolean\n  tenantsCollectionSlug: string\n} & RelationshipFieldServerProps\n\nexport const TenantField: React.FC = async ({\n  clientField,\n  debug,\n  path,\n  payload,\n  readOnly,\n  req,\n  tenantsCollectionSlug,\n  user,\n}: Props) => {\n  let serverValue: number | string | undefined =\n    getTenantFromCookie(req.headers, payload.db.defaultIDType) ||\n    getUserTenantIDs(user as UserWithTenantsField)?.[0]\n\n  if (serverValue) {\n    try {\n      // validate that the tenant exists\n      const doc = await payload.findByID({\n        id: serverValue,\n        collection: tenantsCollectionSlug,\n        depth: 0,\n      })\n      if (!doc) {\n        serverValue = undefined\n      }\n    } catch (_) {\n      serverValue = undefined\n    }\n  }\n\n  return (\n    <TenantFieldClient\n      debug={debug}\n      field={clientField}\n      path={path}\n      readOnly={readOnly}\n      serverValue={serverValue}\n      tenantsCollectionSlug={tenantsCollectionSlug}\n    />\n  )\n}\n"],"names":["React","getTenantFromCookie","getUserTenantIDs","TenantFieldClient","TenantField","clientField","debug","path","payload","readOnly","req","tenantsCollectionSlug","user","serverValue","headers","db","defaultIDType","doc","findByID","id","collection","depth","undefined","_","field"],"mappings":";AAEA,OAAOA,WAAW,QAAO;AAIzB,SAASC,mBAAmB,QAAQ,yCAAwC;AAC5E,SAASC,gBAAgB,QAAQ,sCAAqC;AACtE,SAASC,iBAAiB,QAAQ,oBAAmB;AAOrD,OAAO,MAAMC,cAAwB,OAAO,EAC1CC,WAAW,EACXC,KAAK,EACLC,IAAI,EACJC,OAAO,EACPC,QAAQ,EACRC,GAAG,EACHC,qBAAqB,EACrBC,IAAI,EACE;IACN,IAAIC,cACFZ,oBAAoBS,IAAII,OAAO,EAAEN,QAAQO,EAAE,CAACC,aAAa,KACzDd,iBAAiBU,OAA+B,CAAC,EAAE;IAErD,IAAIC,aAAa;QACf,IAAI;YACF,kCAAkC;YAClC,MAAMI,MAAM,MAAMT,QAAQU,QAAQ,CAAC;gBACjCC,IAAIN;gBACJO,YAAYT;gBACZU,OAAO;YACT;YACA,IAAI,CAACJ,KAAK;gBACRJ,cAAcS;YAChB;QACF,EAAE,OAAOC,GAAG;YACVV,cAAcS;QAChB;IACF;IAEA,qBACE,KAACnB;QACCG,OAAOA;QACPkB,OAAOnB;QACPE,MAAMA;QACNE,UAAUA;QACVI,aAAaA;QACbF,uBAAuBA;;AAG7B,EAAC"}

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import './index.scss';
+export declare const TenantSelectorClient: ({ cookieToSet, initialValue, options, }: {
+    cookieToSet?: string;
+    initialValue?: string;
+    options: {
+        label: string;
+        value: string;
+    }[];
+}) => React.JSX.Element;
+//# sourceMappingURL=index.client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.client.d.ts","sourceRoot":"","sources":["../../../src/components/TenantSelector/index.client.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,cAAc,CAAA;AAMrB,eAAO,MAAM,oBAAoB,4CAI9B;IACD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ,sBAsDA,CAAA"}

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

@@ -0,0 +1,61 @@
+'use client';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { SelectInput } from '@payloadcms/ui';
+import { useRouter } from 'next/navigation.js';
+import React from 'react';
+import './index.scss';
+function findValue(options, value) {
+    return options.find((opt)=>opt.value === value)?.value;
+}
+export const TenantSelectorClient = ({ cookieToSet, initialValue, options })=>{
+    const [value, setValue] = React.useState(()=>{
+        if (initialValue) {
+            return findValue(options, initialValue);
+        }
+    });
+    const router = useRouter();
+    const setCookieAndReload = React.useCallback((value)=>{
+        const expires = '; expires=Fri, 31 Dec 9999 23:59:59 GMT';
+        document.cookie = 'payload-tenant=' + (value || '') + expires + '; path=/';
+        setValue(value);
+        router.refresh();
+    }, [
+        router
+    ]);
+    const handleChange = React.useCallback((option)=>{
+        if (!option) {
+            setCookieAndReload(undefined);
+        } else if ('value' in option) {
+            setCookieAndReload(option.value);
+        }
+    }, [
+        setCookieAndReload
+    ]);
+    React.useEffect(()=>{
+        if (cookieToSet) {
+            setCookieAndReload(findValue(options, cookieToSet));
+        }
+    }, [
+        cookieToSet,
+        options,
+        setCookieAndReload
+    ]);
+    if (options.length <= 1) {
+        return null;
+    }
+    return /*#__PURE__*/ _jsx("div", {
+        className: "tenant-selector",
+        children: /*#__PURE__*/ _jsx(SelectInput, {
+            isClearable: false,
+            label: "Select a tenant",
+            name: "setTenant",
+            onChange: handleChange,
+            options: options,
+            path: "setTenant",
+            readOnly: !value,
+            value: value
+        })
+    });
+};
+
+//# sourceMappingURL=index.client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/components/TenantSelector/index.client.tsx"],"sourcesContent":["'use client'\nimport type { ReactSelectOption } from '@payloadcms/ui'\n\nimport { SelectInput } from '@payloadcms/ui'\nimport { useRouter } from 'next/navigation.js'\nimport React from 'react'\n\nimport './index.scss'\n\nfunction findValue(options: { label: string; value: string }[], value?: string) {\n  return options.find((opt) => opt.value === value)?.value\n}\n\nexport const TenantSelectorClient = ({\n  cookieToSet,\n  initialValue,\n  options,\n}: {\n  cookieToSet?: string\n  initialValue?: string\n  options: {\n    label: string\n    value: string\n  }[]\n}) => {\n  const [value, setValue] = React.useState<string | undefined>(() => {\n    if (initialValue) {\n      return findValue(options, initialValue)\n    }\n  })\n\n  const router = useRouter()\n\n  const setCookieAndReload = React.useCallback(\n    (value?: string) => {\n      const expires = '; expires=Fri, 31 Dec 9999 23:59:59 GMT'\n      document.cookie = 'payload-tenant=' + (value || '') + expires + '; path=/'\n      setValue(value)\n      router.refresh()\n    },\n    [router],\n  )\n\n  const handleChange = React.useCallback(\n    (option: ReactSelectOption | ReactSelectOption[]) => {\n      if (!option) {\n        setCookieAndReload(undefined)\n      } else if ('value' in option) {\n        setCookieAndReload(option.value as string)\n      }\n    },\n    [setCookieAndReload],\n  )\n\n  React.useEffect(() => {\n    if (cookieToSet) {\n      setCookieAndReload(findValue(options, cookieToSet))\n    }\n  }, [cookieToSet, options, setCookieAndReload])\n\n  if (options.length <= 1) {\n    return null\n  }\n\n  return (\n    <div className=\"tenant-selector\">\n      <SelectInput\n        isClearable={false}\n        label=\"Select a tenant\"\n        name=\"setTenant\"\n        onChange={handleChange}\n        options={options}\n        path=\"setTenant\"\n        readOnly={!value}\n        value={value}\n      />\n    </div>\n  )\n}\n"],"names":["SelectInput","useRouter","React","findValue","options","value","find","opt","TenantSelectorClient","cookieToSet","initialValue","setValue","useState","router","setCookieAndReload","useCallback","expires","document","cookie","refresh","handleChange","option","undefined","useEffect","length","div","className","isClearable","label","name","onChange","path","readOnly"],"mappings":"AAAA;;AAGA,SAASA,WAAW,QAAQ,iBAAgB;AAC5C,SAASC,SAAS,QAAQ,qBAAoB;AAC9C,OAAOC,WAAW,QAAO;AAEzB,OAAO,eAAc;AAErB,SAASC,UAAUC,OAA2C,EAAEC,KAAc;IAC5E,OAAOD,QAAQE,IAAI,CAAC,CAACC,MAAQA,IAAIF,KAAK,KAAKA,QAAQA;AACrD;AAEA,OAAO,MAAMG,uBAAuB,CAAC,EACnCC,WAAW,EACXC,YAAY,EACZN,OAAO,EAQR;IACC,MAAM,CAACC,OAAOM,SAAS,GAAGT,MAAMU,QAAQ,CAAqB;QAC3D,IAAIF,cAAc;YAChB,OAAOP,UAAUC,SAASM;QAC5B;IACF;IAEA,MAAMG,SAASZ;IAEf,MAAMa,qBAAqBZ,MAAMa,WAAW,CAC1C,CAACV;QACC,MAAMW,UAAU;QAChBC,SAASC,MAAM,GAAG,oBAAqBb,CAAAA,SAAS,EAAC,IAAKW,UAAU;QAChEL,SAASN;QACTQ,OAAOM,OAAO;IAChB,GACA;QAACN;KAAO;IAGV,MAAMO,eAAelB,MAAMa,WAAW,CACpC,CAACM;QACC,IAAI,CAACA,QAAQ;YACXP,mBAAmBQ;QACrB,OAAO,IAAI,WAAWD,QAAQ;YAC5BP,mBAAmBO,OAAOhB,KAAK;QACjC;IACF,GACA;QAACS;KAAmB;IAGtBZ,MAAMqB,SAAS,CAAC;QACd,IAAId,aAAa;YACfK,mBAAmBX,UAAUC,SAASK;QACxC;IACF,GAAG;QAACA;QAAaL;QAASU;KAAmB;IAE7C,IAAIV,QAAQoB,MAAM,IAAI,GAAG;QACvB,OAAO;IACT;IAEA,qBACE,KAACC;QAAIC,WAAU;kBACb,cAAA,KAAC1B;YACC2B,aAAa;YACbC,OAAM;YACNC,MAAK;YACLC,UAAUV;YACVhB,SAASA;YACT2B,MAAK;YACLC,UAAU,CAAC3B;YACXA,OAAOA;;;AAIf,EAAC"}

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

@@ -0,0 +1,10 @@
+import type { ServerProps } from 'payload';
+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 {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/dist/components/TenantSelector/index.js

@@ -0,0 +1,31 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { cookies as getCookies } from 'next/headers.js';
+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);
+    }
+    return /*#__PURE__*/ _jsx(TenantSelectorClient, {
+        cookieToSet: cookieToSet,
+        initialValue: selectedTenant,
+        options: tenantOptions
+    });
+};
+
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

package/dist/components/TenantSelector/index.scss

@@ -0,0 +1,4 @@
+.tenant-selector {
+  width: 100%;
+  margin-bottom: 2rem;
+}

package/dist/exports/rsc.d.ts

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

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

@@ -0,0 +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"}

package/dist/exports/rsc.js

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

package/dist/exports/rsc.js.map

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

package/dist/exports/types.d.ts

@@ -0,0 +1,2 @@
+export type { MultiTenantPluginConfig } from '../types.js';
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/exports/types.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA"}

package/dist/exports/types.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=types.js.map

package/dist/exports/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/exports/types.ts"],"sourcesContent":["export type { MultiTenantPluginConfig } from '../types.js'\n"],"names":[],"mappings":"AAAA,WAA0D"}

package/dist/exports/utilities.d.ts

@@ -0,0 +1,6 @@
+export { getGlobalViewRedirect } from '../utilities/getGlobalViewRedirect.js';
+export { getTenantAccess } from '../utilities/getTenantAccess.js';
+export { getTenantFromCookie } from '../utilities/getTenantFromCookie.js';
+export { getTenantListFilter } from '../utilities/getTenantListFilter.js';
+export { getUserTenantIDs } from '../utilities/getUserTenantIDs.js';
+//# sourceMappingURL=utilities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.d.ts","sourceRoot":"","sources":["../../src/exports/utilities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAA;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA"}

package/dist/exports/utilities.js

@@ -0,0 +1,7 @@
+export { getGlobalViewRedirect } from '../utilities/getGlobalViewRedirect.js';
+export { getTenantAccess } from '../utilities/getTenantAccess.js';
+export { getTenantFromCookie } from '../utilities/getTenantFromCookie.js';
+export { getTenantListFilter } from '../utilities/getTenantListFilter.js';
+export { getUserTenantIDs } from '../utilities/getUserTenantIDs.js';
+
+//# sourceMappingURL=utilities.js.map

package/dist/exports/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/exports/utilities.ts"],"sourcesContent":["export { getGlobalViewRedirect } from '../utilities/getGlobalViewRedirect.js'\nexport { getTenantAccess } from '../utilities/getTenantAccess.js'\nexport { getTenantFromCookie } from '../utilities/getTenantFromCookie.js'\nexport { getTenantListFilter } from '../utilities/getTenantListFilter.js'\nexport { getUserTenantIDs } from '../utilities/getUserTenantIDs.js'\n"],"names":["getGlobalViewRedirect","getTenantAccess","getTenantFromCookie","getTenantListFilter","getUserTenantIDs"],"mappings":"AAAA,SAASA,qBAAqB,QAAQ,wCAAuC;AAC7E,SAASC,eAAe,QAAQ,kCAAiC;AACjE,SAASC,mBAAmB,QAAQ,sCAAqC;AACzE,SAASC,mBAAmB,QAAQ,sCAAqC;AACzE,SAASC,gBAAgB,QAAQ,mCAAkC"}

package/dist/fields/tenantField/index.d.ts

@@ -0,0 +1,12 @@
+import { type RelationshipField } from 'payload';
+import type { MultiTenantPluginConfig } from '../../types.js';
+type Args = {
+    access: MultiTenantPluginConfig['documentTenantField']['access'];
+    debug?: boolean;
+    name: string;
+    tenantsCollectionSlug: MultiTenantPluginConfig['tenantsSlug'];
+    unique: boolean;
+};
+export declare const tenantField: ({ name, access, debug, tenantsCollectionSlug, unique, }: Args) => RelationshipField;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/fields/tenantField/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fields/tenantField/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAGhD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAI7D,KAAK,IAAI,GAAG;IACV,MAAM,EAAE,uBAAuB,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,CAAA;IAChE,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,qBAAqB,EAAE,uBAAuB,CAAC,aAAa,CAAC,CAAA;IAC7D,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AACD,eAAO,MAAM,WAAW,4DAMrB,IAAI,KAAG,iBAiCR,CAAA"}

package/dist/fields/tenantField/index.js

@@ -0,0 +1,38 @@
+import { APIError } from 'payload';
+import { getTenantFromCookie } from '../../utilities/getTenantFromCookie.js';
+export const tenantField = ({ name, access, debug, tenantsCollectionSlug, unique })=>({
+        name,
+        type: 'relationship',
+        access,
+        admin: {
+            components: {
+                Field: {
+                    clientProps: {
+                        debug,
+                        tenantsCollectionSlug
+                    },
+                    path: '@payloadcms/plugin-multi-tenant/rsc#TenantField'
+                }
+            },
+            position: debug ? 'sidebar' : undefined
+        },
+        hasMany: false,
+        hooks: {
+            beforeChange: [
+                ({ req, value })=>{
+                    if (!value) {
+                        const tenantFromCookie = getTenantFromCookie(req.headers, req.payload.db.defaultIDType);
+                        if (tenantFromCookie) {
+                            return tenantFromCookie;
+                        }
+                        throw new APIError('You must select a tenant', 400, null, true);
+                    }
+                }
+            ]
+        },
+        index: true,
+        relationTo: tenantsCollectionSlug,
+        unique
+    });
+
+//# sourceMappingURL=index.js.map