payload-subscribers-plugin 0.0.12 → 0.0.14

package/README.md

@@ -38,7 +38,7 @@ export default buildConfig({
         posts: true,
       },
 
-      // Easily disable the collection logic.
+      // Easily disable the plugin logic while keep the collections schema changes.
       disabled: false,
 
       // Specify the collection to use as the subscribers collection
@@ -51,11 +51,11 @@ export default buildConfig({
       // Provide a custom expiration for magic link tokens. The default is 30 minutes.
       tokenExpiration: 60 * 60,
 
-      // Provide your unsubscribe route. This route should include the Unsubscribe component. If not provided, your payload config must have serverURL defined, and the default will be serverURL+'/unsubscribe'
-      unsubscribeURL?: string
+      // Provide your unsubscribe route. This route should include the Unsubscribe component, or implement your own with the useUnsubscribe hook. If not provided, your payload config must have serverURL defined, and the default will be serverURL+'/unsubscribe'
+      unsubscribeURL?: string,
 
-      // Provide your verify route. This route should include the Unsubscribe component. If not provided, your payload config must have serverURL defined, and the default will be serverURL+'/verify'
-      verifyURL?: string
+      // Provide your verify route. This route should include the Verify component, or implement your own with the useVerifyMagicLink hook. If not provided, your payload config must have serverURL defined, and the default will be serverURL+'/verify'
+      verifyURL?: string,
 }),
   ],
 })
@@ -128,8 +128,22 @@ You can specify collections in the plugin options which will be amended to inclu
 
 #### **disabled**
 
+Easily disable the plugin logic while keep the collections schema changes.
+
 #### **tokenExpiration**
 
+Provide a custom expiration for magic link tokens. The default is 30 minutes.
+
+#### unsubscribeURL
+
+Provide your unsubscribe route. This route should include the Unsubscribe component, or implement your own with the useUnsubscribe hook. If not provided, your payload config must have serverURL defined, and the default will be ```serverURL+'/unsubscribe'```
+
+
+#### **verifyURL**
+
+Provide your verify route. This route should include the Verify component, or implement your own with the useVerifyMagicLink hook. If not provided, your payload config must have serverURL defined, and the default will be ```serverURL+'/verify'```
+
+
 ### 🔵 Collections
 
 #### **optInChannels**
@@ -383,8 +397,6 @@ Shows the [Subscribe](#subscribe) component to authenticated subscribers, otherw
 
 ```typescript
   <RequestOrSubscribe
-    // Provide the URL the user should go to after clicking the link in the email and having it verified
-    afterVerifyUrl={new URL(window.href)}
     // Provide your own global class names to add to the component elements. Optional
     classNames={{
       button: 'customCssClassNames',
@@ -400,11 +412,6 @@ Shows the [Subscribe](#subscribe) component to authenticated subscribers, otherw
     handleMagicLinkRequested={async (result: RequestMagicLinkResponse) => {}}
     // Called after a subscribers opt-ins have been updated. Optional
     handleSubscribe={async (result: SubscribeResponse) => {}}
-    // Provide your own button component. Optional
-    renderButton={({ name, onClick, text }) =>
-      <button name={name} onClick={onClick} type="button">
-        {text}
-      </button>
     }
     // Provide a payload of data to put on any verify link sent by either Request or Subscribe components
     verifyData={`forwardURL=${window.location.href}`}
@@ -419,8 +426,6 @@ Form to input email address and get a magic link email sent.
 
 ```typescript
   <RequestMagicLink
-    // Provide the URL the user should go to after clicking the link in the email and having it verified
-    afterVerifyUrl={new URL(window.href)}
     // Provide your own global class names to add to the component elements. Optional
     classNames={{
       button: 'customCssClassNames',
@@ -432,12 +437,6 @@ Form to input email address and get a magic link email sent.
     }}
     // Called after a subscribers opt-ins have been updated. Optional
     handleMagicLinkRequested={async (result: RequestMagicLinkResponse) => {}}
-    // Provided your own button component. Optional
-    renderButton={({ name, onClick, text }) =>
-      <button name={name} onClick={onClick} type="button">
-        {text}
-      </button>
-    }
     // Provide a payload of data to put on any verify link sent
     verifyData={`forwardURL=${window.location.href}`}
   />
@@ -475,12 +474,6 @@ Component that verifies a magic link using expected url parameters.
     handleMagicLinkRequested={async (result: RequestMagicLinkResponse) => {}}
     // Called after a magic link has been verified. Optional
     handleMagicLinkVerified={async (result: RequestMagicLinkResponse) => {}}
-    // Provided your own button component. Optional
-    renderButton={({ name, onClick, text }) =>
-        <button name={name} onClick={onClick} type="button">
-          {text}
-        </button>
-    }
     // Provide a payload of data to put on "request another" link sent
     verifyData={`forwardURL=${window.location.href}`}
   >
@@ -501,8 +494,8 @@ Component that verifies a magic link using expected url parameters.
   <p class="subscribers-loading">verifying...</p>
   <p class="subscribers-message">{result}</p>
   <div class="subscribers-form">
-    {renderButton({ name: "request", onClick: handleRequestAnother, text:"Request another magic
-    link", })} {children}
+    <!-- Form elements render here, before the component children provided -->
+    {children}
   </div>
 </div>
 ```
@@ -515,8 +508,6 @@ Allows a subscriber to select from among all active optInChannels.
 
 ```typescript
   <Subscribe
-    // Provide the URL the user should go to after clicking the link in the email and having it verified
-    afterVerifyUrl={new URL(window.href)}
     // Provide your own global class names to add to the component elements. Optional
     classNames={{
       button: 'customCssClassNames',
@@ -530,12 +521,6 @@ Allows a subscriber to select from among all active optInChannels.
     }}
     // Called after a subscribers opt-ins have been updated. Optional
     handleSubscribe={async (result: SubscribeResponse) => {}}
-    // Provided your own button component. Optional
-    renderButton={({ name, onClick, text }) =>
-      <button name={name} onClick={onClick} type="button">
-        {text}
-      </button>
-    }
     // Provide a payload of data to put on any verify link sent
     verifyData={`forwardURL=${window.location.href}`}
   />

package/dist/contexts/SubscriberProvider.js

@@ -28,7 +28,9 @@ const SubscriberContext = /*#__PURE__*/ createContext(undefined);
                 });
                 if (authResponse.ok) {
                     // Call the server function to get the user data
-                    const { permissions, subscriber } = await authResponse.json();
+                    const authResponseJson = await authResponse.json();
+                    // console.log('authResponseJson', JSON.stringify(authResponseJson, undefined, 2))
+                    const { permissions, subscriber } = authResponseJson;
                     // console.log(`subscriber = `, subscriber)
                     // console.log(`permissions = `, permissions)
                     setPermissions(permissions);

package/dist/contexts/SubscriberProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/contexts/SubscriberProvider.tsx"],"sourcesContent":["'use client'\n\nimport { PayloadSDK } from '@payloadcms/sdk'\nimport { type ReactNode, useCallback, useEffect } from 'react'\nimport { createContext, useContext, useMemo, useState } from 'react'\n\nimport type { Config, OptInChannel, Subscriber } from '../copied/payload-types.js'\n\nimport { useServerUrl } from '../react-hooks/useServerUrl.js'\n\n/** Value provided by SubscriberProvider: current subscriber, auth state, and actions. */\nexport type SubscriberContextType = {\n  isLoaded: boolean\n  logOut: () => void\n  permissions: any\n  refreshSubscriber: () => void\n  subscriber: ({ optIns?: null | OptInChannel[] } & Omit<Subscriber, 'optIns'>) | null\n}\n\nconst SubscriberContext = createContext<SubscriberContextType | undefined>(undefined)\n\n/** Props for SubscriberProvider. */\ninterface ProviderProps {\n  children?: ReactNode\n}\n\n/**\n * Provider that fetches and holds the current subscriber auth state (via POST /api/subscriberAuth).\n * Exposes subscriber, permissions, refreshSubscriber, and logOut to descendants. Must wrap any\n * component that uses useSubscriber().\n *\n * @param props.children - React tree to wrap\n * @returns SubscriberContext.Provider with current auth state and actions\n */\nexport function SubscriberProvider({ children }: ProviderProps) {\n  // eslint-disable-next-line\n  const [subscriber, setSubscriber] = useState<null | (Subscriber & { optIns: OptInChannel[] })>(\n    null,\n  )\n\n  const { serverURL } = useServerUrl()\n\n  // Keep track of if the selection content is loaded yet\n  const [isLoaded, setIsLoaded] = useState(false)\n\n  const [permissions, setPermissions] = useState<any>()\n\n  const refreshSubscriber = useCallback(async () => {\n    const initSubscriber = async () => {\n      setIsLoaded(false)\n      try {\n        const authResponse = await fetch('/api/subscriberAuth', {\n          // body: JSON.stringify({}),\n          method: 'POST',\n        })\n\n        if (authResponse.ok) {\n          // Call the server function to get the user data\n          const { permissions, subscriber } = await authResponse.json()\n          // console.log(`subscriber = `, subscriber)\n          // console.log(`permissions = `, permissions)\n          setPermissions(permissions)\n          setSubscriber(subscriber)\n        } else {\n          setPermissions(null)\n          setSubscriber(null)\n        }\n      } catch (error: unknown) {\n        console.log(`authResponse error`, error)\n      }\n      setIsLoaded(true)\n    }\n    await initSubscriber()\n  }, [serverURL])\n\n  const logOut = useCallback(async () => {\n    setIsLoaded(false)\n    try {\n      // const sdk = new PayloadSDK<Config>({\n      //   baseURL: serverURL || '',\n      // })\n      // const logoutResponse = await sdk.request({\n      //   json: {},\n      //   method: 'POST',\n      //   path: '/api/logout',\n      // })\n      // Unsure why sdk isn't working here\n      const logoutResponse = await fetch('/api/logout', {\n        method: 'POST',\n      })\n\n      // console.log(`logoutResponse`, logoutResponse)\n\n      if (logoutResponse.ok) {\n        setSubscriber(null)\n        setPermissions(null)\n      }\n    } catch (error: unknown) {\n      console.log(`logoutResponse error`, error)\n    }\n    setIsLoaded(true)\n  }, [])\n\n  useEffect(() => {\n    void refreshSubscriber()\n  }, [refreshSubscriber])\n\n  // Memoize the value to prevent unnecessary re-renders in consumers\n  const contextValue: SubscriberContextType = useMemo(\n    () => ({\n      isLoaded,\n      logOut,\n      permissions,\n      refreshSubscriber,\n      subscriber,\n    }),\n    [isLoaded, logOut, permissions, refreshSubscriber, subscriber],\n  )\n\n  return <SubscriberContext.Provider value={contextValue}>{children}</SubscriberContext.Provider>\n}\n\n/**\n * Consumes SubscriberContext. Use only inside a SubscriberProvider.\n *\n * @returns Current subscriber (or null), permissions, isLoaded, refreshSubscriber, and logOut\n * @throws Error if used outside SubscriberProvider\n */\nexport function useSubscriber() {\n  const context = useContext(SubscriberContext)\n  if (context === undefined) {\n    throw new Error('useSubscriber must be used within a SubscriberProvider')\n  }\n  return context\n}\n"],"names":["useCallback","useEffect","createContext","useContext","useMemo","useState","useServerUrl","SubscriberContext","undefined","SubscriberProvider","children","subscriber","setSubscriber","serverURL","isLoaded","setIsLoaded","permissions","setPermissions","refreshSubscriber","initSubscriber","authResponse","fetch","method","ok","json","error","console","log","logOut","logoutResponse","contextValue","Provider","value","useSubscriber","context","Error"],"mappings":"AAAA;;AAGA,SAAyBA,WAAW,EAAEC,SAAS,QAAQ,QAAO;AAC9D,SAASC,aAAa,EAAEC,UAAU,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAO;AAIpE,SAASC,YAAY,QAAQ,iCAAgC;AAW7D,MAAMC,kCAAoBL,cAAiDM;AAO3E;;;;;;;CAOC,GACD,OAAO,SAASC,mBAAmB,EAAEC,QAAQ,EAAiB;IAC5D,2BAA2B;IAC3B,MAAM,CAACC,YAAYC,cAAc,GAAGP,SAClC;IAGF,MAAM,EAAEQ,SAAS,EAAE,GAAGP;IAEtB,uDAAuD;IACvD,MAAM,CAACQ,UAAUC,YAAY,GAAGV,SAAS;IAEzC,MAAM,CAACW,aAAaC,eAAe,GAAGZ;IAEtC,MAAMa,oBAAoBlB,YAAY;QACpC,MAAMmB,iBAAiB;YACrBJ,YAAY;YACZ,IAAI;gBACF,MAAMK,eAAe,MAAMC,MAAM,uBAAuB;oBACtD,4BAA4B;oBAC5BC,QAAQ;gBACV;gBAEA,IAAIF,aAAaG,EAAE,EAAE;oBACnB,gDAAgD;oBAChD,MAAM,EAAEP,WAAW,EAAEL,UAAU,EAAE,GAAG,MAAMS,aAAaI,IAAI;oBAC3D,2CAA2C;oBAC3C,6CAA6C;oBAC7CP,eAAeD;oBACfJ,cAAcD;gBAChB,OAAO;oBACLM,eAAe;oBACfL,cAAc;gBAChB;YACF,EAAE,OAAOa,OAAgB;gBACvBC,QAAQC,GAAG,CAAC,CAAC,kBAAkB,CAAC,EAAEF;YACpC;YACAV,YAAY;QACd;QACA,MAAMI;IACR,GAAG;QAACN;KAAU;IAEd,MAAMe,SAAS5B,YAAY;QACzBe,YAAY;QACZ,IAAI;YACF,uCAAuC;YACvC,8BAA8B;YAC9B,KAAK;YACL,6CAA6C;YAC7C,cAAc;YACd,oBAAoB;YACpB,yBAAyB;YACzB,KAAK;YACL,oCAAoC;YACpC,MAAMc,iBAAiB,MAAMR,MAAM,eAAe;gBAChDC,QAAQ;YACV;YAEA,gDAAgD;YAEhD,IAAIO,eAAeN,EAAE,EAAE;gBACrBX,cAAc;gBACdK,eAAe;YACjB;QACF,EAAE,OAAOQ,OAAgB;YACvBC,QAAQC,GAAG,CAAC,CAAC,oBAAoB,CAAC,EAAEF;QACtC;QACAV,YAAY;IACd,GAAG,EAAE;IAELd,UAAU;QACR,KAAKiB;IACP,GAAG;QAACA;KAAkB;IAEtB,mEAAmE;IACnE,MAAMY,eAAsC1B,QAC1C,IAAO,CAAA;YACLU;YACAc;YACAZ;YACAE;YACAP;QACF,CAAA,GACA;QAACG;QAAUc;QAAQZ;QAAaE;QAAmBP;KAAW;IAGhE,qBAAO,KAACJ,kBAAkBwB,QAAQ;QAACC,OAAOF;kBAAepB;;AAC3D;AAEA;;;;;CAKC,GACD,OAAO,SAASuB;IACd,MAAMC,UAAU/B,WAAWI;IAC3B,IAAI2B,YAAY1B,WAAW;QACzB,MAAM,IAAI2B,MAAM;IAClB;IACA,OAAOD;AACT"}
+{"version":3,"sources":["../../src/contexts/SubscriberProvider.tsx"],"sourcesContent":["'use client'\n\nimport { PayloadSDK } from '@payloadcms/sdk'\nimport { type ReactNode, useCallback, useEffect } from 'react'\nimport { createContext, useContext, useMemo, useState } from 'react'\n\nimport type { Config, OptInChannel, Subscriber } from '../copied/payload-types.js'\n\nimport { useServerUrl } from '../react-hooks/useServerUrl.js'\n\n/** Value provided by SubscriberProvider: current subscriber, auth state, and actions. */\nexport type SubscriberContextType = {\n  isLoaded: boolean\n  logOut: () => void\n  permissions: any\n  refreshSubscriber: () => void\n  subscriber: ({ optIns?: null | OptInChannel[] } & Omit<Subscriber, 'optIns'>) | null\n}\n\nconst SubscriberContext = createContext<SubscriberContextType | undefined>(undefined)\n\n/** Props for SubscriberProvider. */\ninterface ProviderProps {\n  children?: ReactNode\n}\n\n/**\n * Provider that fetches and holds the current subscriber auth state (via POST /api/subscriberAuth).\n * Exposes subscriber, permissions, refreshSubscriber, and logOut to descendants. Must wrap any\n * component that uses useSubscriber().\n *\n * @param props.children - React tree to wrap\n * @returns SubscriberContext.Provider with current auth state and actions\n */\nexport function SubscriberProvider({ children }: ProviderProps) {\n  // eslint-disable-next-line\n  const [subscriber, setSubscriber] = useState<null | (Subscriber & { optIns: OptInChannel[] })>(\n    null,\n  )\n\n  const { serverURL } = useServerUrl()\n\n  // Keep track of if the selection content is loaded yet\n  const [isLoaded, setIsLoaded] = useState(false)\n\n  const [permissions, setPermissions] = useState<any>()\n\n  const refreshSubscriber = useCallback(async () => {\n    const initSubscriber = async () => {\n      setIsLoaded(false)\n      try {\n        const authResponse = await fetch('/api/subscriberAuth', {\n          // body: JSON.stringify({}),\n          method: 'POST',\n        })\n\n        if (authResponse.ok) {\n          // Call the server function to get the user data\n          const authResponseJson = await authResponse.json()\n          // console.log('authResponseJson', JSON.stringify(authResponseJson, undefined, 2))\n          const { permissions, subscriber } = authResponseJson\n          // console.log(`subscriber = `, subscriber)\n          // console.log(`permissions = `, permissions)\n          setPermissions(permissions)\n          setSubscriber(subscriber)\n        } else {\n          setPermissions(null)\n          setSubscriber(null)\n        }\n      } catch (error: unknown) {\n        console.log(`authResponse error`, error)\n      }\n      setIsLoaded(true)\n    }\n    await initSubscriber()\n  }, [serverURL])\n\n  const logOut = useCallback(async () => {\n    setIsLoaded(false)\n    try {\n      // const sdk = new PayloadSDK<Config>({\n      //   baseURL: serverURL || '',\n      // })\n      // const logoutResponse = await sdk.request({\n      //   json: {},\n      //   method: 'POST',\n      //   path: '/api/logout',\n      // })\n      // Unsure why sdk isn't working here\n      const logoutResponse = await fetch('/api/logout', {\n        method: 'POST',\n      })\n\n      // console.log(`logoutResponse`, logoutResponse)\n\n      if (logoutResponse.ok) {\n        setSubscriber(null)\n        setPermissions(null)\n      }\n    } catch (error: unknown) {\n      console.log(`logoutResponse error`, error)\n    }\n    setIsLoaded(true)\n  }, [])\n\n  useEffect(() => {\n    void refreshSubscriber()\n  }, [refreshSubscriber])\n\n  // Memoize the value to prevent unnecessary re-renders in consumers\n  const contextValue: SubscriberContextType = useMemo(\n    () => ({\n      isLoaded,\n      logOut,\n      permissions,\n      refreshSubscriber,\n      subscriber,\n    }),\n    [isLoaded, logOut, permissions, refreshSubscriber, subscriber],\n  )\n\n  return <SubscriberContext.Provider value={contextValue}>{children}</SubscriberContext.Provider>\n}\n\n/**\n * Consumes SubscriberContext. Use only inside a SubscriberProvider.\n *\n * @returns Current subscriber (or null), permissions, isLoaded, refreshSubscriber, and logOut\n * @throws Error if used outside SubscriberProvider\n */\nexport function useSubscriber() {\n  const context = useContext(SubscriberContext)\n  if (context === undefined) {\n    throw new Error('useSubscriber must be used within a SubscriberProvider')\n  }\n  return context\n}\n"],"names":["useCallback","useEffect","createContext","useContext","useMemo","useState","useServerUrl","SubscriberContext","undefined","SubscriberProvider","children","subscriber","setSubscriber","serverURL","isLoaded","setIsLoaded","permissions","setPermissions","refreshSubscriber","initSubscriber","authResponse","fetch","method","ok","authResponseJson","json","error","console","log","logOut","logoutResponse","contextValue","Provider","value","useSubscriber","context","Error"],"mappings":"AAAA;;AAGA,SAAyBA,WAAW,EAAEC,SAAS,QAAQ,QAAO;AAC9D,SAASC,aAAa,EAAEC,UAAU,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,QAAO;AAIpE,SAASC,YAAY,QAAQ,iCAAgC;AAW7D,MAAMC,kCAAoBL,cAAiDM;AAO3E;;;;;;;CAOC,GACD,OAAO,SAASC,mBAAmB,EAAEC,QAAQ,EAAiB;IAC5D,2BAA2B;IAC3B,MAAM,CAACC,YAAYC,cAAc,GAAGP,SAClC;IAGF,MAAM,EAAEQ,SAAS,EAAE,GAAGP;IAEtB,uDAAuD;IACvD,MAAM,CAACQ,UAAUC,YAAY,GAAGV,SAAS;IAEzC,MAAM,CAACW,aAAaC,eAAe,GAAGZ;IAEtC,MAAMa,oBAAoBlB,YAAY;QACpC,MAAMmB,iBAAiB;YACrBJ,YAAY;YACZ,IAAI;gBACF,MAAMK,eAAe,MAAMC,MAAM,uBAAuB;oBACtD,4BAA4B;oBAC5BC,QAAQ;gBACV;gBAEA,IAAIF,aAAaG,EAAE,EAAE;oBACnB,gDAAgD;oBAChD,MAAMC,mBAAmB,MAAMJ,aAAaK,IAAI;oBAChD,kFAAkF;oBAClF,MAAM,EAAET,WAAW,EAAEL,UAAU,EAAE,GAAGa;oBACpC,2CAA2C;oBAC3C,6CAA6C;oBAC7CP,eAAeD;oBACfJ,cAAcD;gBAChB,OAAO;oBACLM,eAAe;oBACfL,cAAc;gBAChB;YACF,EAAE,OAAOc,OAAgB;gBACvBC,QAAQC,GAAG,CAAC,CAAC,kBAAkB,CAAC,EAAEF;YACpC;YACAX,YAAY;QACd;QACA,MAAMI;IACR,GAAG;QAACN;KAAU;IAEd,MAAMgB,SAAS7B,YAAY;QACzBe,YAAY;QACZ,IAAI;YACF,uCAAuC;YACvC,8BAA8B;YAC9B,KAAK;YACL,6CAA6C;YAC7C,cAAc;YACd,oBAAoB;YACpB,yBAAyB;YACzB,KAAK;YACL,oCAAoC;YACpC,MAAMe,iBAAiB,MAAMT,MAAM,eAAe;gBAChDC,QAAQ;YACV;YAEA,gDAAgD;YAEhD,IAAIQ,eAAeP,EAAE,EAAE;gBACrBX,cAAc;gBACdK,eAAe;YACjB;QACF,EAAE,OAAOS,OAAgB;YACvBC,QAAQC,GAAG,CAAC,CAAC,oBAAoB,CAAC,EAAEF;QACtC;QACAX,YAAY;IACd,GAAG,EAAE;IAELd,UAAU;QACR,KAAKiB;IACP,GAAG;QAACA;KAAkB;IAEtB,mEAAmE;IACnE,MAAMa,eAAsC3B,QAC1C,IAAO,CAAA;YACLU;YACAe;YACAb;YACAE;YACAP;QACF,CAAA,GACA;QAACG;QAAUe;QAAQb;QAAaE;QAAmBP;KAAW;IAGhE,qBAAO,KAACJ,kBAAkByB,QAAQ;QAACC,OAAOF;kBAAerB;;AAC3D;AAEA;;;;;CAKC,GACD,OAAO,SAASwB;IACd,MAAMC,UAAUhC,WAAWI;IAC3B,IAAI4B,YAAY3B,WAAW;QACzB,MAAM,IAAI4B,MAAM;IAClB;IACA,OAAOD;AACT"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { CollectionSlug, Config } from 'payload';
+import type { CollectionSlug, Plugin } from 'payload';
 export type PayloadSubscribersConfig = {
     /**
      * List of collections to add a custom field
@@ -32,4 +32,16 @@ export type PayloadSubscribersConfig = {
      */
     verifyURL?: string;
 };
-export declare const payloadSubscribersPlugin: (pluginOptions: PayloadSubscribersConfig) => (config: Config) => Config;
+/**
+ * Adds the payload-subscribers-plugin to your payload config
+ *
+ * @param pluginOptions - Plugin options
+ * @param pluginOptions.collections - (optional) An array of existing collection slugs to add an optIns relationship field to
+ * @param pluginOptions.disabled - (optional) A convenience option to disable the plugin
+ * @param pluginOptions.subscribersCollectionSlug - (optional) The slug of an existing collection to use for subscribers. If omitted, the plugin will create the 'subscribers' collection
+ * @param pluginOptions.tokenExpiration - (optional) The expiration time for a token, in milliseconds. Defaults to 30 minutes
+ * @param pluginOptions.unsubscribeURL - (optional) The route or full URL for unsubscribe links
+ * @param pluginOptions.verifyURL - (optional) The route or full URL for verify links
+ * @returns Payload config modified to include the plugin
+ */
+export declare const payloadSubscribersPlugin: (pluginOptions: PayloadSubscribersConfig) => Plugin;

package/dist/index.js

@@ -11,7 +11,18 @@ import createEndpointVerifyMagicLink from './endpoints/verifyMagicLink.js';
 import { getTestEmail } from './helpers/testData.js';
 import { getTokenAndHash } from './helpers/token.js';
 import { isAbsoluteURL } from './helpers/utilities.js';
-export const payloadSubscribersPlugin = (pluginOptions)=>(config)=>{
+/**
+ * Adds the payload-subscribers-plugin to your payload config
+ *
+ * @param pluginOptions - Plugin options
+ * @param pluginOptions.collections - (optional) An array of existing collection slugs to add an optIns relationship field to
+ * @param pluginOptions.disabled - (optional) A convenience option to disable the plugin
+ * @param pluginOptions.subscribersCollectionSlug - (optional) The slug of an existing collection to use for subscribers. If omitted, the plugin will create the 'subscribers' collection
+ * @param pluginOptions.tokenExpiration - (optional) The expiration time for a token, in milliseconds. Defaults to 30 minutes
+ * @param pluginOptions.unsubscribeURL - (optional) The route or full URL for unsubscribe links
+ * @param pluginOptions.verifyURL - (optional) The route or full URL for verify links
+ * @returns Payload config modified to include the plugin
+ */ export const payloadSubscribersPlugin = (pluginOptions)=>(config)=>{
         if (!config.serverURL && !(pluginOptions.unsubscribeURL && pluginOptions.verifyURL)) {
             throw new Error('payloadSubscribersPlugin requires config.serverURL OR valid values for all URL options: unsubscribeURL, verifyURL');
         }

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { BasePayload, CollectionSlug, Config } from 'payload'\n\nimport { OptedInChannels } from './collections/fields/OptedInChannels.js'\nimport OptInChannels from './collections/OptInChannels.js'\nimport {\n  defaultTokenExpiration,\n  SubscribersCollectionFactory,\n  subscribersCollectionFields,\n} from './collections/Subscribers.js'\nimport getOptInChannelsEndpoint from './endpoints/getOptInChannels.js'\nimport createEndpointLogout from './endpoints/logout.js'\nimport createEndpointRequestMagicLink from './endpoints/requestMagicLink.js'\nimport createEndpointSubscribe from './endpoints/subscribe.js'\nimport createEndpointSubscriberAuth from './endpoints/subscriberAuth.js'\nimport createEndpointUnsubscribe from './endpoints/unsubscribe.js'\nimport createEndpointVerifyMagicLink from './endpoints/verifyMagicLink.js'\nimport { getTestEmail } from './helpers/testData.js'\nimport { getTokenAndHash } from './helpers/token.js'\nimport { isAbsoluteURL } from './helpers/utilities.js'\n\nexport type PayloadSubscribersConfig = {\n  /**\n   * List of collections to add a custom field\n   */\n  collections?: Partial<Record<CollectionSlug, true>>\n  /**\n   * Defaults to false-y. When true:\n   *  - Database schema changes are still made and seeded\n   *  - APIs return null or undefined success\n   *  - Admin components are not added\n   *  - App components return nothing\n   */\n  disabled?: boolean\n  /**\n   * The collection to use as the subscribers collection\n   * - Optional. If not specified, the plugin will add a 'subscribers' collection.\n   * - Sets the collection auth if not already.\n   * - Adds (or overrides) fields: email, firstName, status, optIns, verificationToken, verificationTokenExpires.\n   */\n  subscribersCollectionSlug?: CollectionSlug\n  /**\n   * Defaults to 30 minutes\n   */\n  tokenExpiration?: number\n  /**\n   * The route or full URL for unsubscribe links\n   */\n  unsubscribeURL?: string\n  /**\n   * The route or full URL for verify links\n   */\n  verifyURL?: string\n}\n\nexport const payloadSubscribersPlugin =\n  (pluginOptions: PayloadSubscribersConfig) =>\n  (config: Config): Config => {\n    if (!config.serverURL && !(pluginOptions.unsubscribeURL && pluginOptions.verifyURL)) {\n      throw new Error(\n        'payloadSubscribersPlugin requires config.serverURL OR valid values for all URL options: unsubscribeURL, verifyURL',\n      )\n    }\n\n    if (!config.collections) {\n      config.collections = []\n    }\n\n    config.collections.push(OptInChannels)\n\n    const unsubscribeURL = !pluginOptions.unsubscribeURL\n      ? new URL('/unsubscribe', config.serverURL)\n      : isAbsoluteURL(pluginOptions.unsubscribeURL)\n        ? new URL(pluginOptions.unsubscribeURL)\n        : new URL(pluginOptions.unsubscribeURL, config.serverURL)\n\n    // Get a URL object from the verifyURL option\n    const verifyURL = !pluginOptions.verifyURL\n      ? new URL('/verify', config.serverURL)\n      : isAbsoluteURL(pluginOptions.verifyURL)\n        ? new URL(pluginOptions.verifyURL)\n        : new URL(pluginOptions.verifyURL, config.serverURL)\n\n    let subscribersCollection = pluginOptions.subscribersCollectionSlug\n      ? config.collections.find(\n          (collection) => collection.slug == pluginOptions.subscribersCollectionSlug,\n        )\n      : undefined\n\n    if (subscribersCollection) {\n      // Configure the input collection to be the subscribers collection\n      config.collections = config.collections.filter(\n        (collection) => collection.slug != subscribersCollection?.slug,\n      )\n      subscribersCollection.fields.push(...subscribersCollectionFields)\n      if (!subscribersCollection.auth) {\n        subscribersCollection = {\n          ...subscribersCollection,\n          auth: { tokenExpiration: defaultTokenExpiration },\n        }\n      }\n      if (!subscribersCollection.admin?.useAsTitle) {\n        if (!subscribersCollection.admin) {\n          subscribersCollection.admin = { useAsTitle: 'email' }\n        } else {\n          // Throw error? Or override?\n          subscribersCollection.admin.useAsTitle = 'email'\n        }\n      }\n      config.collections.push(subscribersCollection)\n    } else {\n      // Configure the default built-in subscribers collection\n      subscribersCollection = SubscribersCollectionFactory({\n        slug: pluginOptions.subscribersCollectionSlug,\n        tokenExpiration: pluginOptions.tokenExpiration,\n      })\n      config.collections.push(subscribersCollection)\n    }\n\n    if (pluginOptions.collections) {\n      for (const collectionSlug in pluginOptions.collections) {\n        const collection = config.collections.find(\n          (collection) => collection.slug === collectionSlug,\n        )\n\n        if (collection) {\n          collection.fields.push(OptedInChannels)\n        }\n      }\n    }\n\n    /**\n     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.\n     * If your plugin heavily modifies the database schema, you may want to remove this property.\n     */\n    if (pluginOptions.disabled) {\n      return config\n    }\n\n    if (!config.admin) {\n      config.admin = {}\n    }\n\n    if (!config.admin.components) {\n      config.admin.components = {}\n    }\n\n    if (!config.admin.components.beforeDashboard) {\n      config.admin.components.beforeDashboard = []\n    }\n\n    if (!config.endpoints) {\n      config.endpoints = []\n    }\n\n    config.endpoints.push(\n      getOptInChannelsEndpoint,\n      createEndpointLogout({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n      createEndpointRequestMagicLink({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n        unsubscribeURL,\n        verifyURL,\n      }),\n      createEndpointSubscribe({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n        unsubscribeURL,\n        verifyURL,\n      }),\n      createEndpointSubscriberAuth({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n      createEndpointUnsubscribe({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n      createEndpointVerifyMagicLink({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n    )\n\n    const incomingOnInit = config.onInit\n\n    const genInit = (testData: { testEmail: string }) => async (payload: BasePayload) => {\n      // Ensure we are executing any existing onInit functions before running our own.\n      if (incomingOnInit) {\n        await incomingOnInit(payload)\n      }\n\n      // console.log('Object.keys(payload.collections)', Object.keys(payload.collections))\n      const { totalDocs: totalOptIns } = await payload.count({\n        collection: 'opt-in-channels',\n        where: {\n          title: {\n            equals: 'seeded-by-plugin',\n          },\n        },\n      })\n\n      if (totalOptIns === 0) {\n        await payload.create({\n          collection: 'opt-in-channels',\n          data: {\n            active: true,\n            title: 'seeded-by-plugin',\n          },\n        })\n      }\n\n      // const { seededChannel } = await payload.find({\n      //   collection: 'opt-in-channels',\n      //   where: {\n      //     title: {\n      //       equals: 'seeded-by-plugin',\n      //     },\n      //   },\n      // })\n\n      const { totalDocs: totalSubscribers } = await payload.count({\n        collection: subscribersCollection.slug as CollectionSlug,\n        where: {\n          email: {\n            equals: testData.testEmail,\n          },\n        },\n      })\n\n      const { tokenHash } = getTokenAndHash() // Unknowable\n      // payload.logger.info(`testData.testEmail == '${testData.testEmail}'`)\n      if (totalSubscribers === 0) {\n        await payload.create({\n          collection: subscribersCollection.slug as CollectionSlug,\n          data: {\n            email: testData.testEmail,\n            password: tokenHash,\n            status: 'pending',\n          },\n        })\n      }\n    }\n\n    // console.log(`getTestEmail == '${getTestEmail()}'`)\n    config.onInit = genInit({ testEmail: getTestEmail() })\n\n    return config\n  }\n"],"names":["OptedInChannels","OptInChannels","defaultTokenExpiration","SubscribersCollectionFactory","subscribersCollectionFields","getOptInChannelsEndpoint","createEndpointLogout","createEndpointRequestMagicLink","createEndpointSubscribe","createEndpointSubscriberAuth","createEndpointUnsubscribe","createEndpointVerifyMagicLink","getTestEmail","getTokenAndHash","isAbsoluteURL","payloadSubscribersPlugin","pluginOptions","config","serverURL","unsubscribeURL","verifyURL","Error","collections","push","URL","subscribersCollection","subscribersCollectionSlug","find","collection","slug","undefined","filter","fields","auth","tokenExpiration","admin","useAsTitle","collectionSlug","disabled","components","beforeDashboard","endpoints","incomingOnInit","onInit","genInit","testData","payload","totalDocs","totalOptIns","count","where","title","equals","create","data","active","totalSubscribers","email","testEmail","tokenHash","password","status"],"mappings":"AAEA,SAASA,eAAe,QAAQ,0CAAyC;AACzE,OAAOC,mBAAmB,iCAAgC;AAC1D,SACEC,sBAAsB,EACtBC,4BAA4B,EAC5BC,2BAA2B,QACtB,+BAA8B;AACrC,OAAOC,8BAA8B,kCAAiC;AACtE,OAAOC,0BAA0B,wBAAuB;AACxD,OAAOC,oCAAoC,kCAAiC;AAC5E,OAAOC,6BAA6B,2BAA0B;AAC9D,OAAOC,kCAAkC,gCAA+B;AACxE,OAAOC,+BAA+B,6BAA4B;AAClE,OAAOC,mCAAmC,iCAAgC;AAC1E,SAASC,YAAY,QAAQ,wBAAuB;AACpD,SAASC,eAAe,QAAQ,qBAAoB;AACpD,SAASC,aAAa,QAAQ,yBAAwB;AAoCtD,OAAO,MAAMC,2BACX,CAACC,gBACD,CAACC;QACC,IAAI,CAACA,OAAOC,SAAS,IAAI,CAAEF,CAAAA,cAAcG,cAAc,IAAIH,cAAcI,SAAS,AAAD,GAAI;YACnF,MAAM,IAAIC,MACR;QAEJ;QAEA,IAAI,CAACJ,OAAOK,WAAW,EAAE;YACvBL,OAAOK,WAAW,GAAG,EAAE;QACzB;QAEAL,OAAOK,WAAW,CAACC,IAAI,CAACtB;QAExB,MAAMkB,iBAAiB,CAACH,cAAcG,cAAc,GAChD,IAAIK,IAAI,gBAAgBP,OAAOC,SAAS,IACxCJ,cAAcE,cAAcG,cAAc,IACxC,IAAIK,IAAIR,cAAcG,cAAc,IACpC,IAAIK,IAAIR,cAAcG,cAAc,EAAEF,OAAOC,SAAS;QAE5D,6CAA6C;QAC7C,MAAME,YAAY,CAACJ,cAAcI,SAAS,GACtC,IAAII,IAAI,WAAWP,OAAOC,SAAS,IACnCJ,cAAcE,cAAcI,SAAS,IACnC,IAAII,IAAIR,cAAcI,SAAS,IAC/B,IAAII,IAAIR,cAAcI,SAAS,EAAEH,OAAOC,SAAS;QAEvD,IAAIO,wBAAwBT,cAAcU,yBAAyB,GAC/DT,OAAOK,WAAW,CAACK,IAAI,CACrB,CAACC,aAAeA,WAAWC,IAAI,IAAIb,cAAcU,yBAAyB,IAE5EI;QAEJ,IAAIL,uBAAuB;YACzB,kEAAkE;YAClER,OAAOK,WAAW,GAAGL,OAAOK,WAAW,CAACS,MAAM,CAC5C,CAACH,aAAeA,WAAWC,IAAI,IAAIJ,uBAAuBI;YAE5DJ,sBAAsBO,MAAM,CAACT,IAAI,IAAInB;YACrC,IAAI,CAACqB,sBAAsBQ,IAAI,EAAE;gBAC/BR,wBAAwB;oBACtB,GAAGA,qBAAqB;oBACxBQ,MAAM;wBAAEC,iBAAiBhC;oBAAuB;gBAClD;YACF;YACA,IAAI,CAACuB,sBAAsBU,KAAK,EAAEC,YAAY;gBAC5C,IAAI,CAACX,sBAAsBU,KAAK,EAAE;oBAChCV,sBAAsBU,KAAK,GAAG;wBAAEC,YAAY;oBAAQ;gBACtD,OAAO;oBACL,4BAA4B;oBAC5BX,sBAAsBU,KAAK,CAACC,UAAU,GAAG;gBAC3C;YACF;YACAnB,OAAOK,WAAW,CAACC,IAAI,CAACE;QAC1B,OAAO;YACL,wDAAwD;YACxDA,wBAAwBtB,6BAA6B;gBACnD0B,MAAMb,cAAcU,yBAAyB;gBAC7CQ,iBAAiBlB,cAAckB,eAAe;YAChD;YACAjB,OAAOK,WAAW,CAACC,IAAI,CAACE;QAC1B;QAEA,IAAIT,cAAcM,WAAW,EAAE;YAC7B,IAAK,MAAMe,kBAAkBrB,cAAcM,WAAW,CAAE;gBACtD,MAAMM,aAAaX,OAAOK,WAAW,CAACK,IAAI,CACxC,CAACC,aAAeA,WAAWC,IAAI,KAAKQ;gBAGtC,IAAIT,YAAY;oBACdA,WAAWI,MAAM,CAACT,IAAI,CAACvB;gBACzB;YACF;QACF;QAEA;;;KAGC,GACD,IAAIgB,cAAcsB,QAAQ,EAAE;YAC1B,OAAOrB;QACT;QAEA,IAAI,CAACA,OAAOkB,KAAK,EAAE;YACjBlB,OAAOkB,KAAK,GAAG,CAAC;QAClB;QAEA,IAAI,CAAClB,OAAOkB,KAAK,CAACI,UAAU,EAAE;YAC5BtB,OAAOkB,KAAK,CAACI,UAAU,GAAG,CAAC;QAC7B;QAEA,IAAI,CAACtB,OAAOkB,KAAK,CAACI,UAAU,CAACC,eAAe,EAAE;YAC5CvB,OAAOkB,KAAK,CAACI,UAAU,CAACC,eAAe,GAAG,EAAE;QAC9C;QAEA,IAAI,CAACvB,OAAOwB,SAAS,EAAE;YACrBxB,OAAOwB,SAAS,GAAG,EAAE;QACvB;QAEAxB,OAAOwB,SAAS,CAAClB,IAAI,CACnBlB,0BACAC,qBAAqB;YACnBoB,2BAA2BD,sBAAsBI,IAAI;QACvD,IACAtB,+BAA+B;YAC7BmB,2BAA2BD,sBAAsBI,IAAI;YACrDV;YACAC;QACF,IACAZ,wBAAwB;YACtBkB,2BAA2BD,sBAAsBI,IAAI;YACrDV;YACAC;QACF,IACAX,6BAA6B;YAC3BiB,2BAA2BD,sBAAsBI,IAAI;QACvD,IACAnB,0BAA0B;YACxBgB,2BAA2BD,sBAAsBI,IAAI;QACvD,IACAlB,8BAA8B;YAC5Be,2BAA2BD,sBAAsBI,IAAI;QACvD;QAGF,MAAMa,iBAAiBzB,OAAO0B,MAAM;QAEpC,MAAMC,UAAU,CAACC,WAAoC,OAAOC;gBAC1D,gFAAgF;gBAChF,IAAIJ,gBAAgB;oBAClB,MAAMA,eAAeI;gBACvB;gBAEA,oFAAoF;gBACpF,MAAM,EAAEC,WAAWC,WAAW,EAAE,GAAG,MAAMF,QAAQG,KAAK,CAAC;oBACrDrB,YAAY;oBACZsB,OAAO;wBACLC,OAAO;4BACLC,QAAQ;wBACV;oBACF;gBACF;gBAEA,IAAIJ,gBAAgB,GAAG;oBACrB,MAAMF,QAAQO,MAAM,CAAC;wBACnBzB,YAAY;wBACZ0B,MAAM;4BACJC,QAAQ;4BACRJ,OAAO;wBACT;oBACF;gBACF;gBAEA,iDAAiD;gBACjD,mCAAmC;gBACnC,aAAa;gBACb,eAAe;gBACf,oCAAoC;gBACpC,SAAS;gBACT,OAAO;gBACP,KAAK;gBAEL,MAAM,EAAEJ,WAAWS,gBAAgB,EAAE,GAAG,MAAMV,QAAQG,KAAK,CAAC;oBAC1DrB,YAAYH,sBAAsBI,IAAI;oBACtCqB,OAAO;wBACLO,OAAO;4BACLL,QAAQP,SAASa,SAAS;wBAC5B;oBACF;gBACF;gBAEA,MAAM,EAAEC,SAAS,EAAE,GAAG9C,kBAAkB,aAAa;;gBACrD,uEAAuE;gBACvE,IAAI2C,qBAAqB,GAAG;oBAC1B,MAAMV,QAAQO,MAAM,CAAC;wBACnBzB,YAAYH,sBAAsBI,IAAI;wBACtCyB,MAAM;4BACJG,OAAOZ,SAASa,SAAS;4BACzBE,UAAUD;4BACVE,QAAQ;wBACV;oBACF;gBACF;YACF;QAEA,qDAAqD;QACrD5C,OAAO0B,MAAM,GAAGC,QAAQ;YAAEc,WAAW9C;QAAe;QAEpD,OAAOK;IACT,EAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { BasePayload, CollectionSlug, Config, Plugin } from 'payload'\n\nimport { OptedInChannels } from './collections/fields/OptedInChannels.js'\nimport OptInChannels from './collections/OptInChannels.js'\nimport {\n  defaultTokenExpiration,\n  SubscribersCollectionFactory,\n  subscribersCollectionFields,\n} from './collections/Subscribers.js'\nimport getOptInChannelsEndpoint from './endpoints/getOptInChannels.js'\nimport createEndpointLogout from './endpoints/logout.js'\nimport createEndpointRequestMagicLink from './endpoints/requestMagicLink.js'\nimport createEndpointSubscribe from './endpoints/subscribe.js'\nimport createEndpointSubscriberAuth from './endpoints/subscriberAuth.js'\nimport createEndpointUnsubscribe from './endpoints/unsubscribe.js'\nimport createEndpointVerifyMagicLink from './endpoints/verifyMagicLink.js'\nimport { getTestEmail } from './helpers/testData.js'\nimport { getTokenAndHash } from './helpers/token.js'\nimport { isAbsoluteURL } from './helpers/utilities.js'\n\nexport type PayloadSubscribersConfig = {\n  /**\n   * List of collections to add a custom field\n   */\n  collections?: Partial<Record<CollectionSlug, true>>\n  /**\n   * Defaults to false-y. When true:\n   *  - Database schema changes are still made and seeded\n   *  - APIs return null or undefined success\n   *  - Admin components are not added\n   *  - App components return nothing\n   */\n  disabled?: boolean\n  /**\n   * The collection to use as the subscribers collection\n   * - Optional. If not specified, the plugin will add a 'subscribers' collection.\n   * - Sets the collection auth if not already.\n   * - Adds (or overrides) fields: email, firstName, status, optIns, verificationToken, verificationTokenExpires.\n   */\n  subscribersCollectionSlug?: CollectionSlug\n  /**\n   * Defaults to 30 minutes\n   */\n  tokenExpiration?: number\n  /**\n   * The route or full URL for unsubscribe links\n   */\n  unsubscribeURL?: string\n  /**\n   * The route or full URL for verify links\n   */\n  verifyURL?: string\n}\n\n/**\n * Adds the payload-subscribers-plugin to your payload config\n *\n * @param pluginOptions - Plugin options\n * @param pluginOptions.collections - (optional) An array of existing collection slugs to add an optIns relationship field to\n * @param pluginOptions.disabled - (optional) A convenience option to disable the plugin\n * @param pluginOptions.subscribersCollectionSlug - (optional) The slug of an existing collection to use for subscribers. If omitted, the plugin will create the 'subscribers' collection\n * @param pluginOptions.tokenExpiration - (optional) The expiration time for a token, in milliseconds. Defaults to 30 minutes\n * @param pluginOptions.unsubscribeURL - (optional) The route or full URL for unsubscribe links\n * @param pluginOptions.verifyURL - (optional) The route or full URL for verify links\n * @returns Payload config modified to include the plugin\n */\nexport const payloadSubscribersPlugin =\n  (pluginOptions: PayloadSubscribersConfig): Plugin =>\n  (config: Config): Config => {\n    if (!config.serverURL && !(pluginOptions.unsubscribeURL && pluginOptions.verifyURL)) {\n      throw new Error(\n        'payloadSubscribersPlugin requires config.serverURL OR valid values for all URL options: unsubscribeURL, verifyURL',\n      )\n    }\n\n    if (!config.collections) {\n      config.collections = []\n    }\n\n    config.collections.push(OptInChannels)\n\n    const unsubscribeURL = !pluginOptions.unsubscribeURL\n      ? new URL('/unsubscribe', config.serverURL)\n      : isAbsoluteURL(pluginOptions.unsubscribeURL)\n        ? new URL(pluginOptions.unsubscribeURL)\n        : new URL(pluginOptions.unsubscribeURL, config.serverURL)\n\n    // Get a URL object from the verifyURL option\n    const verifyURL = !pluginOptions.verifyURL\n      ? new URL('/verify', config.serverURL)\n      : isAbsoluteURL(pluginOptions.verifyURL)\n        ? new URL(pluginOptions.verifyURL)\n        : new URL(pluginOptions.verifyURL, config.serverURL)\n\n    let subscribersCollection = pluginOptions.subscribersCollectionSlug\n      ? config.collections.find(\n          (collection) => collection.slug == pluginOptions.subscribersCollectionSlug,\n        )\n      : undefined\n\n    if (subscribersCollection) {\n      // Configure the input collection to be the subscribers collection\n      config.collections = config.collections.filter(\n        (collection) => collection.slug != subscribersCollection?.slug,\n      )\n      subscribersCollection.fields.push(...subscribersCollectionFields)\n      if (!subscribersCollection.auth) {\n        subscribersCollection = {\n          ...subscribersCollection,\n          auth: { tokenExpiration: defaultTokenExpiration },\n        }\n      }\n      if (!subscribersCollection.admin?.useAsTitle) {\n        if (!subscribersCollection.admin) {\n          subscribersCollection.admin = { useAsTitle: 'email' }\n        } else {\n          // Throw error? Or override?\n          subscribersCollection.admin.useAsTitle = 'email'\n        }\n      }\n      config.collections.push(subscribersCollection)\n    } else {\n      // Configure the default built-in subscribers collection\n      subscribersCollection = SubscribersCollectionFactory({\n        slug: pluginOptions.subscribersCollectionSlug,\n        tokenExpiration: pluginOptions.tokenExpiration,\n      })\n      config.collections.push(subscribersCollection)\n    }\n\n    if (pluginOptions.collections) {\n      for (const collectionSlug in pluginOptions.collections) {\n        const collection = config.collections.find(\n          (collection) => collection.slug === collectionSlug,\n        )\n\n        if (collection) {\n          collection.fields.push(OptedInChannels)\n        }\n      }\n    }\n\n    /**\n     * If the plugin is disabled, we still want to keep added collections/fields so the database schema is consistent which is important for migrations.\n     * If your plugin heavily modifies the database schema, you may want to remove this property.\n     */\n    if (pluginOptions.disabled) {\n      return config\n    }\n\n    if (!config.admin) {\n      config.admin = {}\n    }\n\n    if (!config.admin.components) {\n      config.admin.components = {}\n    }\n\n    if (!config.admin.components.beforeDashboard) {\n      config.admin.components.beforeDashboard = []\n    }\n\n    if (!config.endpoints) {\n      config.endpoints = []\n    }\n\n    config.endpoints.push(\n      getOptInChannelsEndpoint,\n      createEndpointLogout({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n      createEndpointRequestMagicLink({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n        unsubscribeURL,\n        verifyURL,\n      }),\n      createEndpointSubscribe({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n        unsubscribeURL,\n        verifyURL,\n      }),\n      createEndpointSubscriberAuth({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n      createEndpointUnsubscribe({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n      createEndpointVerifyMagicLink({\n        subscribersCollectionSlug: subscribersCollection.slug as CollectionSlug,\n      }),\n    )\n\n    const incomingOnInit = config.onInit\n\n    const genInit = (testData: { testEmail: string }) => async (payload: BasePayload) => {\n      // Ensure we are executing any existing onInit functions before running our own.\n      if (incomingOnInit) {\n        await incomingOnInit(payload)\n      }\n\n      // console.log('Object.keys(payload.collections)', Object.keys(payload.collections))\n      const { totalDocs: totalOptIns } = await payload.count({\n        collection: 'opt-in-channels',\n        where: {\n          title: {\n            equals: 'seeded-by-plugin',\n          },\n        },\n      })\n\n      if (totalOptIns === 0) {\n        await payload.create({\n          collection: 'opt-in-channels',\n          data: {\n            active: true,\n            title: 'seeded-by-plugin',\n          },\n        })\n      }\n\n      // const { seededChannel } = await payload.find({\n      //   collection: 'opt-in-channels',\n      //   where: {\n      //     title: {\n      //       equals: 'seeded-by-plugin',\n      //     },\n      //   },\n      // })\n\n      const { totalDocs: totalSubscribers } = await payload.count({\n        collection: subscribersCollection.slug as CollectionSlug,\n        where: {\n          email: {\n            equals: testData.testEmail,\n          },\n        },\n      })\n\n      const { tokenHash } = getTokenAndHash() // Unknowable\n      // payload.logger.info(`testData.testEmail == '${testData.testEmail}'`)\n      if (totalSubscribers === 0) {\n        await payload.create({\n          collection: subscribersCollection.slug as CollectionSlug,\n          data: {\n            email: testData.testEmail,\n            password: tokenHash,\n            status: 'pending',\n          },\n        })\n      }\n    }\n\n    // console.log(`getTestEmail == '${getTestEmail()}'`)\n    config.onInit = genInit({ testEmail: getTestEmail() })\n\n    return config\n  }\n"],"names":["OptedInChannels","OptInChannels","defaultTokenExpiration","SubscribersCollectionFactory","subscribersCollectionFields","getOptInChannelsEndpoint","createEndpointLogout","createEndpointRequestMagicLink","createEndpointSubscribe","createEndpointSubscriberAuth","createEndpointUnsubscribe","createEndpointVerifyMagicLink","getTestEmail","getTokenAndHash","isAbsoluteURL","payloadSubscribersPlugin","pluginOptions","config","serverURL","unsubscribeURL","verifyURL","Error","collections","push","URL","subscribersCollection","subscribersCollectionSlug","find","collection","slug","undefined","filter","fields","auth","tokenExpiration","admin","useAsTitle","collectionSlug","disabled","components","beforeDashboard","endpoints","incomingOnInit","onInit","genInit","testData","payload","totalDocs","totalOptIns","count","where","title","equals","create","data","active","totalSubscribers","email","testEmail","tokenHash","password","status"],"mappings":"AAEA,SAASA,eAAe,QAAQ,0CAAyC;AACzE,OAAOC,mBAAmB,iCAAgC;AAC1D,SACEC,sBAAsB,EACtBC,4BAA4B,EAC5BC,2BAA2B,QACtB,+BAA8B;AACrC,OAAOC,8BAA8B,kCAAiC;AACtE,OAAOC,0BAA0B,wBAAuB;AACxD,OAAOC,oCAAoC,kCAAiC;AAC5E,OAAOC,6BAA6B,2BAA0B;AAC9D,OAAOC,kCAAkC,gCAA+B;AACxE,OAAOC,+BAA+B,6BAA4B;AAClE,OAAOC,mCAAmC,iCAAgC;AAC1E,SAASC,YAAY,QAAQ,wBAAuB;AACpD,SAASC,eAAe,QAAQ,qBAAoB;AACpD,SAASC,aAAa,QAAQ,yBAAwB;AAoCtD;;;;;;;;;;;CAWC,GACD,OAAO,MAAMC,2BACX,CAACC,gBACD,CAACC;QACC,IAAI,CAACA,OAAOC,SAAS,IAAI,CAAEF,CAAAA,cAAcG,cAAc,IAAIH,cAAcI,SAAS,AAAD,GAAI;YACnF,MAAM,IAAIC,MACR;QAEJ;QAEA,IAAI,CAACJ,OAAOK,WAAW,EAAE;YACvBL,OAAOK,WAAW,GAAG,EAAE;QACzB;QAEAL,OAAOK,WAAW,CAACC,IAAI,CAACtB;QAExB,MAAMkB,iBAAiB,CAACH,cAAcG,cAAc,GAChD,IAAIK,IAAI,gBAAgBP,OAAOC,SAAS,IACxCJ,cAAcE,cAAcG,cAAc,IACxC,IAAIK,IAAIR,cAAcG,cAAc,IACpC,IAAIK,IAAIR,cAAcG,cAAc,EAAEF,OAAOC,SAAS;QAE5D,6CAA6C;QAC7C,MAAME,YAAY,CAACJ,cAAcI,SAAS,GACtC,IAAII,IAAI,WAAWP,OAAOC,SAAS,IACnCJ,cAAcE,cAAcI,SAAS,IACnC,IAAII,IAAIR,cAAcI,SAAS,IAC/B,IAAII,IAAIR,cAAcI,SAAS,EAAEH,OAAOC,SAAS;QAEvD,IAAIO,wBAAwBT,cAAcU,yBAAyB,GAC/DT,OAAOK,WAAW,CAACK,IAAI,CACrB,CAACC,aAAeA,WAAWC,IAAI,IAAIb,cAAcU,yBAAyB,IAE5EI;QAEJ,IAAIL,uBAAuB;YACzB,kEAAkE;YAClER,OAAOK,WAAW,GAAGL,OAAOK,WAAW,CAACS,MAAM,CAC5C,CAACH,aAAeA,WAAWC,IAAI,IAAIJ,uBAAuBI;YAE5DJ,sBAAsBO,MAAM,CAACT,IAAI,IAAInB;YACrC,IAAI,CAACqB,sBAAsBQ,IAAI,EAAE;gBAC/BR,wBAAwB;oBACtB,GAAGA,qBAAqB;oBACxBQ,MAAM;wBAAEC,iBAAiBhC;oBAAuB;gBAClD;YACF;YACA,IAAI,CAACuB,sBAAsBU,KAAK,EAAEC,YAAY;gBAC5C,IAAI,CAACX,sBAAsBU,KAAK,EAAE;oBAChCV,sBAAsBU,KAAK,GAAG;wBAAEC,YAAY;oBAAQ;gBACtD,OAAO;oBACL,4BAA4B;oBAC5BX,sBAAsBU,KAAK,CAACC,UAAU,GAAG;gBAC3C;YACF;YACAnB,OAAOK,WAAW,CAACC,IAAI,CAACE;QAC1B,OAAO;YACL,wDAAwD;YACxDA,wBAAwBtB,6BAA6B;gBACnD0B,MAAMb,cAAcU,yBAAyB;gBAC7CQ,iBAAiBlB,cAAckB,eAAe;YAChD;YACAjB,OAAOK,WAAW,CAACC,IAAI,CAACE;QAC1B;QAEA,IAAIT,cAAcM,WAAW,EAAE;YAC7B,IAAK,MAAMe,kBAAkBrB,cAAcM,WAAW,CAAE;gBACtD,MAAMM,aAAaX,OAAOK,WAAW,CAACK,IAAI,CACxC,CAACC,aAAeA,WAAWC,IAAI,KAAKQ;gBAGtC,IAAIT,YAAY;oBACdA,WAAWI,MAAM,CAACT,IAAI,CAACvB;gBACzB;YACF;QACF;QAEA;;;KAGC,GACD,IAAIgB,cAAcsB,QAAQ,EAAE;YAC1B,OAAOrB;QACT;QAEA,IAAI,CAACA,OAAOkB,KAAK,EAAE;YACjBlB,OAAOkB,KAAK,GAAG,CAAC;QAClB;QAEA,IAAI,CAAClB,OAAOkB,KAAK,CAACI,UAAU,EAAE;YAC5BtB,OAAOkB,KAAK,CAACI,UAAU,GAAG,CAAC;QAC7B;QAEA,IAAI,CAACtB,OAAOkB,KAAK,CAACI,UAAU,CAACC,eAAe,EAAE;YAC5CvB,OAAOkB,KAAK,CAACI,UAAU,CAACC,eAAe,GAAG,EAAE;QAC9C;QAEA,IAAI,CAACvB,OAAOwB,SAAS,EAAE;YACrBxB,OAAOwB,SAAS,GAAG,EAAE;QACvB;QAEAxB,OAAOwB,SAAS,CAAClB,IAAI,CACnBlB,0BACAC,qBAAqB;YACnBoB,2BAA2BD,sBAAsBI,IAAI;QACvD,IACAtB,+BAA+B;YAC7BmB,2BAA2BD,sBAAsBI,IAAI;YACrDV;YACAC;QACF,IACAZ,wBAAwB;YACtBkB,2BAA2BD,sBAAsBI,IAAI;YACrDV;YACAC;QACF,IACAX,6BAA6B;YAC3BiB,2BAA2BD,sBAAsBI,IAAI;QACvD,IACAnB,0BAA0B;YACxBgB,2BAA2BD,sBAAsBI,IAAI;QACvD,IACAlB,8BAA8B;YAC5Be,2BAA2BD,sBAAsBI,IAAI;QACvD;QAGF,MAAMa,iBAAiBzB,OAAO0B,MAAM;QAEpC,MAAMC,UAAU,CAACC,WAAoC,OAAOC;gBAC1D,gFAAgF;gBAChF,IAAIJ,gBAAgB;oBAClB,MAAMA,eAAeI;gBACvB;gBAEA,oFAAoF;gBACpF,MAAM,EAAEC,WAAWC,WAAW,EAAE,GAAG,MAAMF,QAAQG,KAAK,CAAC;oBACrDrB,YAAY;oBACZsB,OAAO;wBACLC,OAAO;4BACLC,QAAQ;wBACV;oBACF;gBACF;gBAEA,IAAIJ,gBAAgB,GAAG;oBACrB,MAAMF,QAAQO,MAAM,CAAC;wBACnBzB,YAAY;wBACZ0B,MAAM;4BACJC,QAAQ;4BACRJ,OAAO;wBACT;oBACF;gBACF;gBAEA,iDAAiD;gBACjD,mCAAmC;gBACnC,aAAa;gBACb,eAAe;gBACf,oCAAoC;gBACpC,SAAS;gBACT,OAAO;gBACP,KAAK;gBAEL,MAAM,EAAEJ,WAAWS,gBAAgB,EAAE,GAAG,MAAMV,QAAQG,KAAK,CAAC;oBAC1DrB,YAAYH,sBAAsBI,IAAI;oBACtCqB,OAAO;wBACLO,OAAO;4BACLL,QAAQP,SAASa,SAAS;wBAC5B;oBACF;gBACF;gBAEA,MAAM,EAAEC,SAAS,EAAE,GAAG9C,kBAAkB,aAAa;;gBACrD,uEAAuE;gBACvE,IAAI2C,qBAAqB,GAAG;oBAC1B,MAAMV,QAAQO,MAAM,CAAC;wBACnBzB,YAAYH,sBAAsBI,IAAI;wBACtCyB,MAAM;4BACJG,OAAOZ,SAASa,SAAS;4BACzBE,UAAUD;4BACVE,QAAQ;wBACV;oBACF;gBACF;YACF;QAEA,qDAAqD;QACrD5C,OAAO0B,MAAM,GAAGC,QAAQ;YAAEc,WAAW9C;QAAe;QAEpD,OAAOK;IACT,EAAC"}

package/package.json

@@ -69,7 +69,7 @@
   },
   "registry": "https://registry.npmjs.org/",
   "dependencies": {},
-  "version": "0.0.12",
+  "version": "0.0.14",
   "scripts": {
     "build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
     "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",