npm - payload-subscribers-plugin - Versions diffs - 0.0.1 - Mend

payload-subscribers-plugin 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (133) hide show

package/README.md +305 -0
package/dist/collections/OptInChannels.d.ts +3 -0
package/dist/collections/OptInChannels.js +44 -0
package/dist/collections/OptInChannels.js.map +1 -0
package/dist/collections/Subscribers.d.ts +8 -0
package/dist/collections/Subscribers.js +88 -0
package/dist/collections/Subscribers.js.map +1 -0
package/dist/collections/fields/OptedInChannels.d.ts +2 -0
package/dist/collections/fields/OptedInChannels.js +12 -0
package/dist/collections/fields/OptedInChannels.js.map +1 -0
package/dist/components/BeforeDashboardClient.d.ts +1 -0
package/dist/components/BeforeDashboardClient.js +40 -0
package/dist/components/BeforeDashboardClient.js.map +1 -0
package/dist/components/BeforeDashboardServer.d.ts +2 -0
package/dist/components/BeforeDashboardServer.js +22 -0
package/dist/components/BeforeDashboardServer.js.map +1 -0
package/dist/components/BeforeDashboardServer.module.css +5 -0
package/dist/components/app/RequestMagicLink.d.ts +16 -0
package/dist/components/app/RequestMagicLink.js +114 -0
package/dist/components/app/RequestMagicLink.js.map +1 -0
package/dist/components/app/RequestMagicLink.module.css +5 -0
package/dist/components/app/RequestOrSubscribe.d.ts +17 -0
package/dist/components/app/RequestOrSubscribe.js +28 -0
package/dist/components/app/RequestOrSubscribe.js.map +1 -0
package/dist/components/app/SelectOptInChannels.d.ts +20 -0
package/dist/components/app/SelectOptInChannels.js +120 -0
package/dist/components/app/SelectOptInChannels.js.map +1 -0
package/dist/components/app/SelectOptInChannels.module.css +5 -0
package/dist/components/app/Subscribe.d.ts +18 -0
package/dist/components/app/Subscribe.js +169 -0
package/dist/components/app/Subscribe.js.map +1 -0
package/dist/components/app/Subscribe.module.css +5 -0
package/dist/components/app/SubscriberMenu.d.ts +7 -0
package/dist/components/app/SubscriberMenu.js +44 -0
package/dist/components/app/SubscriberMenu.js.map +1 -0
package/dist/components/app/VerifyMagicLink.d.ts +23 -0
package/dist/components/app/VerifyMagicLink.js +169 -0
package/dist/components/app/VerifyMagicLink.js.map +1 -0
package/dist/components/app/VerifyMagicLink.module.css +5 -0
package/dist/components/app/helpers.d.ts +1 -0
package/dist/components/app/helpers.js +5 -0
package/dist/components/app/helpers.js.map +1 -0
package/dist/components/app/shared.module.css +14 -0
package/dist/contexts/SubscriberProvider.d.ts +15 -0
package/dist/contexts/SubscriberProvider.js +105 -0
package/dist/contexts/SubscriberProvider.js.map +1 -0
package/dist/copied/payload-types.d.ts +395 -0
package/dist/copied/payload-types.js +15 -0
package/dist/copied/payload-types.js.map +1 -0
package/dist/copied/payload.config.d.ts +2 -0
package/dist/endpoints/customEndpointHandler.d.ts +2 -0
package/dist/endpoints/customEndpointHandler.js +7 -0
package/dist/endpoints/customEndpointHandler.js.map +1 -0
package/dist/endpoints/getOptInChannels.d.ts +19 -0
package/dist/endpoints/getOptInChannels.js +42 -0
package/dist/endpoints/getOptInChannels.js.map +1 -0
package/dist/endpoints/logout.d.ts +20 -0
package/dist/endpoints/logout.js +60 -0
package/dist/endpoints/logout.js.map +1 -0
package/dist/endpoints/requestMagicLink.d.ts +20 -0
package/dist/endpoints/requestMagicLink.js +122 -0
package/dist/endpoints/requestMagicLink.js.map +1 -0
package/dist/endpoints/subscribe.d.ts +24 -0
package/dist/endpoints/subscribe.js +343 -0
package/dist/endpoints/subscribe.js.map +1 -0
package/dist/endpoints/subscriberAuth.d.ts +22 -0
package/dist/endpoints/subscriberAuth.js +69 -0
package/dist/endpoints/subscriberAuth.js.map +1 -0
package/dist/endpoints/verifyMagicLink.d.ts +20 -0
package/dist/endpoints/verifyMagicLink.js +142 -0
package/dist/endpoints/verifyMagicLink.js.map +1 -0
package/dist/exports/client.d.ts +1 -0
package/dist/exports/client.js +3 -0
package/dist/exports/client.js.map +1 -0
package/dist/exports/index.d.ts +1 -0
package/dist/exports/index.js +3 -0
package/dist/exports/index.js.map +1 -0
package/dist/exports/rsc.d.ts +1 -0
package/dist/exports/rsc.js +3 -0
package/dist/exports/rsc.js.map +1 -0
package/dist/exports/ui.d.ts +11 -0
package/dist/exports/ui.js +9 -0
package/dist/exports/ui.js.map +1 -0
package/dist/helpers/serverConfig.d.ts +4 -0
package/dist/helpers/serverConfig.js +22 -0
package/dist/helpers/serverConfig.js.map +1 -0
package/dist/helpers/testData.d.ts +2 -0
package/dist/helpers/testData.js +4 -0
package/dist/helpers/testData.js.map +1 -0
package/dist/helpers/token.d.ts +9 -0
package/dist/helpers/token.js +20 -0
package/dist/helpers/token.js.map +1 -0
package/dist/helpers/verifyOptIns.d.ts +5 -0
package/dist/helpers/verifyOptIns.js +33 -0
package/dist/helpers/verifyOptIns.js.map +1 -0
package/dist/index.d.ts +26 -0
package/dist/index.js +147 -0
package/dist/index.js.map +1 -0
package/dist/react-hooks/useServerUrl.d.ts +3 -0
package/dist/react-hooks/useServerUrl.js +19 -0
package/dist/react-hooks/useServerUrl.js.map +1 -0
package/dist/server-functions/serverUrl.d.ts +3 -0
package/dist/server-functions/serverUrl.js +31 -0
package/dist/server-functions/serverUrl.js.map +1 -0
package/dist/server-functions/subscriberAuth.d.ts +11 -0
package/package.json +94 -0
package/src/collections/OptInChannels.ts +45 -0
package/src/collections/Subscribers.ts +99 -0
package/src/collections/fields/OptedInChannels.ts +12 -0
package/src/components/app/RequestMagicLink.tsx +129 -0
package/src/components/app/RequestOrSubscribe.tsx +58 -0
package/src/components/app/SelectOptInChannels.tsx +147 -0
package/src/components/app/Subscribe.tsx +190 -0
package/src/components/app/SubscriberMenu.tsx +46 -0
package/src/components/app/VerifyMagicLink.tsx +197 -0
package/src/components/app/helpers.ts +6 -0
package/src/components/app/shared.module.css +14 -0
package/src/contexts/SubscriberProvider.tsx +122 -0
package/src/copied/payload-types.ts +478 -0
package/src/endpoints/getOptInChannels.ts +56 -0
package/src/endpoints/logout.ts +104 -0
package/src/endpoints/requestMagicLink.ts +139 -0
package/src/endpoints/subscribe.ts +435 -0
package/src/endpoints/subscriberAuth.ts +100 -0
package/src/endpoints/verifyMagicLink.ts +164 -0
package/src/exports/index.ts +1 -0
package/src/exports/ui.ts +17 -0
package/src/helpers/testData.ts +2 -0
package/src/helpers/token.ts +14 -0
package/src/helpers/verifyOptIns.ts +39 -0
package/src/index.ts +207 -0
package/src/react-hooks/useServerUrl.tsx +18 -0
package/src/server-functions/serverUrl.ts +38 -0

package/README.md ADDED Viewed

@@ -0,0 +1,305 @@
+# Payload Subscribers Plugin
+A plugin to manage subscribers and the "channels" they can subscribe to.
+## Installation
+```bash
+pnpm add payload-subscribers-plugin
+```
+## Usage
+Add the plugin to your Payload config.
+```typescript
+// payload.config.ts
+export default buildConfig({
+  plugins: [
+    payloadSubscribersPlugin({
+      collections: {
+        // Add slugs of your collections which should have a relationship field to the optInChannels.
+        posts: true,
+      },
+      // Easily disable the collection logic.
+      disabled: false,
+      // Provide a custom expiration for magic link tokens. The default is 30 minutes.
+      tokenExpiration: 60 * 60,
+    }),
+  ],
+})
+```
+Place the **SubscriberProvider** at the a good location in your app structure. For example, in your root layout:
+```typescript
+// layout.tsx
+import { SubscriberProvider } from 'payload-subscribers-plugin/ui'
+const Layout: React.FC<{ children: React.ReactNode }> = ({ children }) => {
+  return (
+    <html lang="en">
+      <head></head>
+      <body>
+        <SubscriberProvider>
+          ...
+        </SubscriberProvider>
+      </body>
+    </html>
+  )
+}
+```
+Then you can use the components in your app:
+```typescript
+// page.tsx
+import { RequestOrSubscribe } from 'payload-subscribers-plugin/ui'
+const Page = () => {
+  return (
+    <main>
+      <RequestOrSubscribe
+        classNames={{ button: 'customCssClassNames', container: 'customCssClassNames', emailInput: 'customCssClassNames' }}
+      />
+    </main>
+  )
+}
+```
+**_IMPORANT:_** Be sure to create a /verify route
+```typescript
+// verify/page.tsx
+import { VerifyClient } from '@/components/VerifyClient.js'
+const Page = () => {
+  return (
+    <main id="main-content">
+      <VerifyMagicLink
+        classNames={{ button: 'customCssClassNames', container: 'customCssClassNames', emailInput: 'customCssClassNames' }}
+      />
+    </main>
+  )
+}
+```
+## 🟢🔵🔴 Features
+### 🟢 Plugin options
+#### **collections**
+You can specify collections in the plugin options which will be amended to include a relationTo field referring to the optInChannels collection. Right now this does not override the plugin-added subscribers collection, which is still used for the primary record of subscribers and used for authentication. The collections amended with an optIns can be used, for example, to manage your subscription channels and any email campaigns related.
+#### **disabled**
+#### **tokenExpiration**
+### 🟢 Collections
+#### **optInChannels**
+Seeded when plugin inits.
+- Fields
+  - title: text
+  - description: text
+  - active: boolean
+  - slug: text
+#### **subscribers**
+Seeded when plugin inits.
+- Fields
+  - email: text
+  - first name: text
+  - status: Subscribed | Unsubscribed | Pending verification (default)
+  - opt-ins: referenceTo optInChannels hasMany
+  - source: text
+  - verificationToken: text hidden
+---
+### 🔵 Fields
+#### **OptedInChannels**
+_THE FIELD SPEC IS CURRENTLY NOT EXPORTED_ Documenting here in case that seems useful in the future.
+This is the same field used by the plugin **collections** to amended a relationTo field referring to the optInChannels collection.
+---
+### 🔴 Payload endpoints
+#### **requestMagicLink**
+Takes an email, verifies it, registers it if unknown, constructs a magic link, and uses your Payload emailAdapter to sendEmail.
+#### **verifyMagicLink**
+Takes an email and token, verifies the token, and authenticates the user, using Payload's HTTP-only cookies auth.
+#### **getOptInChannels**
+Returns all active optInChannels data.
+#### **subscribe** a user, or update a subscriber's opt-ins.
+Takes an email and list of optInChannel IDs, verifies them, and if the authenticated subscriber matches the email will update the channels that subscriber is opted into.
+#### TO DO: unsubscribe
+The **subscribe** endpoint will remove all optIns. But need a way to set the subscriber status to "unsubscribed"
+---
+### 🟢 SubscriberProvider provider with useSubscriber context
+---
+### 🔵 Provides several NextJS client components ready for use in a frontend app
+- All App Components are client components that consume hooks, server components, server functions. Including the useSubscriber context, and so the must be used within the children descendent tree of the SubscriberProvider provider.
+- All App Components accept a **classNames** prop to specify CSS class names to add to the different parts of the component
+#### **RequestOrSubscribe**
+Shows Subscribe to authenticated subscribers, otherwise shows RequestMagicLink.
+<!-- <div style="border: 1px solid #ccc; padding: 15px; border-radius: 5px;">
+</div> -->
+```typescript
+  <RequestMagicLink
+    // Provide your own global class names to add to the component elements. Optional
+    classNames={{
+      button: 'customCssClassNames',
+      container: 'customCssClassNames',
+      emailInput: 'customCssClassNames',
+      error: 'customCssClassNames',
+      form: 'customCssClassNames',
+      loading: 'customCssClassNames',
+      message: 'customCssClassNames',
+      section: 'customCssClassNames',
+    }}
+    // Called after a subscribers opt-ins have been updated. Optional
+    handleMagicLinkRequested={async (result: RequestMagicLinkResponse) => {}}
+    // 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>
+    }
+  />
+```
+#### **RequestMagicLink**
+Form to input email address and get a magic link email sent.
+```typescript
+  <RequestMagicLink
+    // Provide your own global class names to add to the component elements. Optional
+    classNames={{
+      button: 'customCssClassNames',
+      container: 'customCssClassNames',
+      emailInput: 'customCssClassNames',
+      error: 'customCssClassNames',
+      form: 'customCssClassNames',
+      message: 'customCssClassNames',
+    }}
+    // 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>
+    }
+  />
+```
+#### **VerifyMagicLink**
+Component that verifies a magic link using expected url parameters.
+```typescript
+  <VerifyMagicLink
+    // Provide your own global class names to add to the component elements. Optional
+    classNames={{
+      button: 'customCssClassNames',
+      container: 'customCssClassNames',
+      error: 'customCssClassNames',
+      form: 'customCssClassNames',
+      loading: 'customCssClassNames',
+      message: 'customCssClassNames',
+    }}
+    // Called after a magic link email has been sent. Optional
+    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, forwardUrl, onClick, text }) =>
+      forwardUrl ? (
+        <a href={forwardUrl}>
+          <button name={name} type="button">
+            {text}
+          </button>
+        </a>
+      ) : (
+        <button name={name} onClick={onClick} type="button">
+          {text}
+        </button>
+      )
+    }
+  />
+```
+#### **Subscribe**
+Allows a subscriber to select from among all active optInChannels.
+```typescript
+  <Subscribe
+    // Provide your own global class names to add to the component elements. Optional
+    classNames={{
+      button: 'customCssClassNames',
+      container: 'customCssClassNames',
+      emailInput: 'customCssClassNames',
+      error: 'customCssClassNames',
+      form: 'customCssClassNames',
+      loading: 'customCssClassNames',
+      message: 'customCssClassNames',
+      section: 'customCssClassNames',
+    }}
+    // 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>
+    }
+  />
+```
+#### **SubscriberMenu**
+```typescript
+// classNames prop
+export type SubscriberMenuClasses = {
+  button?: string
+  container?: string
+}
+```

package/dist/collections/OptInChannels.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import type { CollectionConfig } from 'payload';
+export declare const OptInChannels: CollectionConfig;
+export default OptInChannels;

package/dist/collections/OptInChannels.js ADDED Viewed

@@ -0,0 +1,44 @@
+export const OptInChannels = {
+    slug: 'opt-in-channels',
+    access: {
+        // Public access for creation (signup form)
+        create: ()=>true,
+        // Admin-only access for reading, updating, and deleting
+        delete: ({ req })=>req.user ? true : false,
+        // read: ({ req }) => (req.user ? true : false),
+        read: ()=>true,
+        update: ({ req })=>req.user ? true : false
+    },
+    admin: {
+        useAsTitle: 'title'
+    },
+    fields: [
+        {
+            name: 'title',
+            type: 'text',
+            label: 'Title',
+            required: true,
+            unique: true
+        },
+        {
+            name: 'description',
+            type: 'text',
+            label: 'Description'
+        },
+        {
+            name: 'active',
+            type: 'checkbox',
+            defaultValue: true,
+            label: 'Active',
+            required: true
+        },
+        {
+            name: 'slug',
+            type: 'text',
+            label: 'slug'
+        }
+    ]
+};
+export default OptInChannels;
+//# sourceMappingURL=OptInChannels.js.map

package/dist/collections/OptInChannels.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/collections/OptInChannels.ts"],"sourcesContent":["import type { CollectionConfig } from 'payload'\n\nexport const OptInChannels: CollectionConfig = {\n slug: 'opt-in-channels',\n access: {\n // Public access for creation (signup form)\n create: () => true,\n // Admin-only access for reading, updating, and deleting\n delete: ({ req }) => (req.user ? true : false),\n // read: ({ req }) => (req.user ? true : false),\n read: () => true,\n update: ({ req }) => (req.user ? true : false),\n },\n admin: {\n useAsTitle: 'title', // Specify the field to use as the title\n },\n fields: [\n {\n name: 'title',\n type: 'text', // Enforces valid email format\n label: 'Title',\n required: true,\n unique: true, // Ensures no duplicate titles\n },\n {\n name: 'description',\n type: 'text',\n label: 'Description',\n },\n {\n name: 'active',\n type: 'checkbox',\n defaultValue: true, // Default to pending until verified\n label: 'Active',\n required: true,\n },\n {\n name: 'slug',\n type: 'text',\n label: 'slug',\n },\n ],\n}\n\nexport default OptInChannels\n"],"names":["OptInChannels","slug","access","create","delete","req","user","read","update","admin","useAsTitle","fields","name","type","label","required","unique","defaultValue"],"mappings":"AAEA,OAAO,MAAMA,gBAAkC;IAC7CC,MAAM;IACNC,QAAQ;QACN,2CAA2C;QAC3CC,QAAQ,IAAM;QACd,wDAAwD;QACxDC,QAAQ,CAAC,EAAEC,GAAG,EAAE,GAAMA,IAAIC,IAAI,GAAG,OAAO;QACxC,gDAAgD;QAChDC,MAAM,IAAM;QACZC,QAAQ,CAAC,EAAEH,GAAG,EAAE,GAAMA,IAAIC,IAAI,GAAG,OAAO;IAC1C;IACAG,OAAO;QACLC,YAAY;IACd;IACAC,QAAQ;QACN;YACEC,MAAM;YACNC,MAAM;YACNC,OAAO;YACPC,UAAU;YACVC,QAAQ;QACV;QACA;YACEJ,MAAM;YACNC,MAAM;YACNC,OAAO;QACT;QACA;YACEF,MAAM;YACNC,MAAM;YACNI,cAAc;YACdH,OAAO;YACPC,UAAU;QACZ;QACA;YACEH,MAAM;YACNC,MAAM;YACNC,OAAO;QACT;KACD;AACH,EAAC;AAED,eAAed,cAAa"}

package/dist/collections/Subscribers.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+import type { CollectionConfig, CollectionSlug, Field } from 'payload';
+export declare const defaultTokenExpiration: number;
+export declare const defaultCollectionSlug = "subscribers";
+export declare const SubscribersCollectionFactory: ({ slug, tokenExpiration, }: {
+    slug?: CollectionSlug;
+    tokenExpiration?: number;
+}) => CollectionConfig;
+export declare const subscribersCollectionFields: Field[];

package/dist/collections/Subscribers.js ADDED Viewed

@@ -0,0 +1,88 @@
+import { OptedInChannels } from './fields/OptedInChannels.js';
+export const defaultTokenExpiration = 30 * 60 // 30 minutes
+;
+export const defaultCollectionSlug = 'subscribers';
+export const SubscribersCollectionFactory = ({ slug, tokenExpiration = defaultTokenExpiration })=>{
+    const Subscribers = {
+        slug: slug ? slug : defaultCollectionSlug,
+        access: {
+            // Public access for creation (signup form)
+            create: ()=>true,
+            // Admin-only access for reading, updating, and deleting
+            delete: ({ req })=>req.user ? true : false,
+            read: ({ req })=>req.user ? true : false,
+            update: ({ req })=>req.user ? true : false
+        },
+        admin: {
+            useAsTitle: 'email'
+        },
+        auth: {
+            tokenExpiration
+        },
+        fields: [
+            ...subscribersCollectionFields
+        ]
+    };
+    return Subscribers;
+};
+export const subscribersCollectionFields = [
+    {
+        name: 'email',
+        type: 'email',
+        label: 'Email Address',
+        required: true,
+        unique: true
+    },
+    {
+        name: 'firstName',
+        type: 'text',
+        label: 'First Name'
+    },
+    {
+        name: 'status',
+        type: 'select',
+        defaultValue: 'pending',
+        label: 'Subscription Status',
+        options: [
+            {
+                label: 'Subscribed',
+                value: 'subscribed'
+            },
+            {
+                label: 'Unsubscribed',
+                value: 'unsubscribed'
+            },
+            {
+                label: 'Pending Verification',
+                value: 'pending'
+            }
+        ],
+        required: true
+    },
+    {
+        name: 'source',
+        type: 'text',
+        label: 'Signup Source'
+    },
+    {
+        name: 'verificationToken',
+        type: 'text',
+        admin: {
+            hidden: true
+        },
+        label: 'Verification Token'
+    },
+    {
+        name: 'verificationTokenExpires',
+        type: 'date',
+        admin: {
+            hidden: true
+        },
+        label: 'Verification Token Expiration'
+    },
+    /**
+   * Plugin field relationship to optinchannels
+   */ OptedInChannels
+];
+//# sourceMappingURL=Subscribers.js.map

package/dist/collections/Subscribers.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/collections/Subscribers.ts"],"sourcesContent":["import type { CollectionConfig, CollectionSlug, Field } from 'payload'\n\nimport { OptedInChannels } from './fields/OptedInChannels.js'\n\nexport const defaultTokenExpiration = 30 * 60 // 30 minutes\n\nexport const defaultCollectionSlug = 'subscribers'\n\nexport const SubscribersCollectionFactory = ({\n slug,\n tokenExpiration = defaultTokenExpiration,\n}: {\n slug?: CollectionSlug\n tokenExpiration?: number\n}) => {\n const Subscribers: CollectionConfig = {\n slug: slug ? slug : defaultCollectionSlug,\n access: {\n // Public access for creation (signup form)\n create: () => true,\n // Admin-only access for reading, updating, and deleting\n delete: ({ req }) => (req.user ? true : false),\n read: ({ req }) => (req.user ? true : false),\n update: ({ req }) => (req.user ? true : false),\n },\n admin: { useAsTitle: 'email' },\n auth: {\n tokenExpiration,\n // verify: true, // Require email verification before being allowed to authenticate\n // maxLoginAttempts: 5, // Automatically lock a user out after X amount of failed logins\n // lockTime: 600 * 1000, // Time period to allow the max login attempts\n },\n fields: [...subscribersCollectionFields],\n }\n\n return Subscribers\n}\n\nexport const subscribersCollectionFields: Field[] = [\n {\n name: 'email',\n type: 'email', // Enforces valid email format\n label: 'Email Address',\n required: true,\n unique: true, // Ensures no duplicate emails\n },\n {\n name: 'firstName',\n type: 'text',\n label: 'First Name',\n },\n {\n name: 'status',\n type: 'select',\n defaultValue: 'pending', // Default to pending until verified\n label: 'Subscription Status',\n options: [\n {\n label: 'Subscribed',\n value: 'subscribed',\n },\n {\n label: 'Unsubscribed',\n value: 'unsubscribed',\n },\n {\n label: 'Pending Verification',\n value: 'pending',\n },\n ],\n required: true,\n },\n {\n name: 'source',\n type: 'text', // e.g., 'Homepage form', 'Blog post A', etc.\n label: 'Signup Source',\n },\n {\n name: 'verificationToken',\n type: 'text',\n admin: {\n hidden: true, // Hide this field in the admin panel for security/cleanliness\n },\n label: 'Verification Token',\n },\n {\n name: 'verificationTokenExpires',\n type: 'date',\n admin: {\n hidden: true, // Hide this field in the admin panel for security/cleanliness\n },\n label: 'Verification Token Expiration',\n },\n\n /**\n * Plugin field relationship to optinchannels\n */\n OptedInChannels,\n]\n"],"names":["OptedInChannels","defaultTokenExpiration","defaultCollectionSlug","SubscribersCollectionFactory","slug","tokenExpiration","Subscribers","access","create","delete","req","user","read","update","admin","useAsTitle","auth","fields","subscribersCollectionFields","name","type","label","required","unique","defaultValue","options","value","hidden"],"mappings":"AAEA,SAASA,eAAe,QAAQ,8BAA6B;AAE7D,OAAO,MAAMC,yBAAyB,KAAK,GAAG,aAAa;CAAd;AAE7C,OAAO,MAAMC,wBAAwB,cAAa;AAElD,OAAO,MAAMC,+BAA+B,CAAC,EAC3CC,IAAI,EACJC,kBAAkBJ,sBAAsB,EAIzC;IACC,MAAMK,cAAgC;QACpCF,MAAMA,OAAOA,OAAOF;QACpBK,QAAQ;YACN,2CAA2C;YAC3CC,QAAQ,IAAM;YACd,wDAAwD;YACxDC,QAAQ,CAAC,EAAEC,GAAG,EAAE,GAAMA,IAAIC,IAAI,GAAG,OAAO;YACxCC,MAAM,CAAC,EAAEF,GAAG,EAAE,GAAMA,IAAIC,IAAI,GAAG,OAAO;YACtCE,QAAQ,CAAC,EAAEH,GAAG,EAAE,GAAMA,IAAIC,IAAI,GAAG,OAAO;QAC1C;QACAG,OAAO;YAAEC,YAAY;QAAQ;QAC7BC,MAAM;YACJX;QAIF;QACAY,QAAQ;eAAIC;SAA4B;IAC1C;IAEA,OAAOZ;AACT,EAAC;AAED,OAAO,MAAMY,8BAAuC;IAClD;QACEC,MAAM;QACNC,MAAM;QACNC,OAAO;QACPC,UAAU;QACVC,QAAQ;IACV;IACA;QACEJ,MAAM;QACNC,MAAM;QACNC,OAAO;IACT;IACA;QACEF,MAAM;QACNC,MAAM;QACNI,cAAc;QACdH,OAAO;QACPI,SAAS;YACP;gBACEJ,OAAO;gBACPK,OAAO;YACT;YACA;gBACEL,OAAO;gBACPK,OAAO;YACT;YACA;gBACEL,OAAO;gBACPK,OAAO;YACT;SACD;QACDJ,UAAU;IACZ;IACA;QACEH,MAAM;QACNC,MAAM;QACNC,OAAO;IACT;IACA;QACEF,MAAM;QACNC,MAAM;QACNN,OAAO;YACLa,QAAQ;QACV;QACAN,OAAO;IACT;IACA;QACEF,MAAM;QACNC,MAAM;QACNN,OAAO;YACLa,QAAQ;QACV;QACAN,OAAO;IACT;IAEA;;GAEC,GACDrB;CACD,CAAA"}

package/dist/collections/fields/OptedInChannels.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import type { Field } from 'payload';
2	+ export declare const OptedInChannels: Field;

package/dist/collections/fields/OptedInChannels.js ADDED Viewed

@@ -0,0 +1,12 @@
+export const OptedInChannels = {
+    name: 'optIns',
+    type: 'relationship',
+    admin: {
+        position: 'sidebar'
+    },
+    hasMany: true,
+    label: 'Opted-in channels',
+    relationTo: 'opt-in-channels'
+};
+//# sourceMappingURL=OptedInChannels.js.map

package/dist/collections/fields/OptedInChannels.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../../src/collections/fields/OptedInChannels.ts"],"sourcesContent":["import type { Field } from 'payload'\n\nexport const OptedInChannels: Field = {\n name: 'optIns',\n type: 'relationship',\n admin: {\n position: 'sidebar',\n },\n hasMany: true,\n label: 'Opted-in channels',\n relationTo: 'opt-in-channels',\n}\n"],"names":["OptedInChannels","name","type","admin","position","hasMany","label","relationTo"],"mappings":"AAEA,OAAO,MAAMA,kBAAyB;IACpCC,MAAM;IACNC,MAAM;IACNC,OAAO;QACLC,UAAU;IACZ;IACAC,SAAS;IACTC,OAAO;IACPC,YAAY;AACd,EAAC"}

package/dist/components/BeforeDashboardClient.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare const BeforeDashboardClient: () => import("react").JSX.Element;

package/dist/components/BeforeDashboardClient.js ADDED Viewed

@@ -0,0 +1,40 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useConfig } from '@payloadcms/ui';
+import { formatAdminURL } from 'payload/shared';
+import { useEffect, useState } from 'react';
+export const BeforeDashboardClient = ()=>{
+    const { config } = useConfig();
+    const [message, setMessage] = useState('');
+    useEffect(()=>{
+        const fetchMessage = async ()=>{
+            const response = await fetch(formatAdminURL({
+                adminRoute: config.routes.api,
+                path: '/my-plugin-endpoint'
+            }));
+            const result = await response.json();
+            setMessage(result.message);
+        };
+        void fetchMessage();
+    }, [
+        config.serverURL,
+        config.routes.api
+    ]);
+    return /*#__PURE__*/ _jsxs("div", {
+        children: [
+            /*#__PURE__*/ _jsx("h1", {
+                children: "Added by the plugin: Before Dashboard Client"
+            }),
+            /*#__PURE__*/ _jsxs("div", {
+                children: [
+                    "Message from the endpoint:",
+                    /*#__PURE__*/ _jsx("div", {
+                        children: message || 'Loading...'
+                    })
+                ]
+            })
+        ]
+    });
+};
+//# sourceMappingURL=BeforeDashboardClient.js.map

package/dist/components/BeforeDashboardClient.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/components/BeforeDashboardClient.tsx"],"sourcesContent":["'use client'\nimport { useConfig } from '@payloadcms/ui'\nimport { formatAdminURL } from 'payload/shared'\nimport { useEffect, useState } from 'react'\n\nexport const BeforeDashboardClient = () => {\n const { config } = useConfig()\n\n const [message, setMessage] = useState('')\n\n useEffect(() => {\n const fetchMessage = async () => {\n const response = await fetch(\n formatAdminURL({\n adminRoute: config.routes.api,\n path: '/my-plugin-endpoint',\n }),\n )\n const result = await response.json()\n setMessage(result.message)\n }\n\n void fetchMessage()\n }, [config.serverURL, config.routes.api])\n\n return (\n <div>\n <h1>Added by the plugin: Before Dashboard Client</h1>\n <div>\n Message from the endpoint:\n <div>{message || 'Loading...'}</div>\n </div>\n </div>\n )\n}\n"],"names":["useConfig","formatAdminURL","useEffect","useState","BeforeDashboardClient","config","message","setMessage","fetchMessage","response","fetch","adminRoute","routes","api","path","result","json","serverURL","div","h1"],"mappings":"AAAA;;AACA,SAASA,SAAS,QAAQ,iBAAgB;AAC1C,SAASC,cAAc,QAAQ,iBAAgB;AAC/C,SAASC,SAAS,EAAEC,QAAQ,QAAQ,QAAO;AAE3C,OAAO,MAAMC,wBAAwB;IACnC,MAAM,EAAEC,MAAM,EAAE,GAAGL;IAEnB,MAAM,CAACM,SAASC,WAAW,GAAGJ,SAAS;IAEvCD,UAAU;QACR,MAAMM,eAAe;YACnB,MAAMC,WAAW,MAAMC,MACrBT,eAAe;gBACbU,YAAYN,OAAOO,MAAM,CAACC,GAAG;gBAC7BC,MAAM;YACR;YAEF,MAAMC,SAAS,MAAMN,SAASO,IAAI;YAClCT,WAAWQ,OAAOT,OAAO;QAC3B;QAEA,KAAKE;IACP,GAAG;QAACH,OAAOY,SAAS;QAAEZ,OAAOO,MAAM,CAACC,GAAG;KAAC;IAExC,qBACE,MAACK;;0BACC,KAACC;0BAAG;;0BACJ,MAACD;;oBAAI;kCAEH,KAACA;kCAAKZ,WAAW;;;;;;AAIzB,EAAC"}

package/dist/components/BeforeDashboardServer.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import type { ServerComponentProps } from 'payload';
2	+ export declare const BeforeDashboardServer: (props: ServerComponentProps) => Promise<import("react").JSX.Element>;

package/dist/components/BeforeDashboardServer.js ADDED Viewed

@@ -0,0 +1,22 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import styles from './BeforeDashboardServer.module.css';
+export const BeforeDashboardServer = async (props)=>{
+    const { payload } = props;
+    const { docs } = await payload.find({
+        collection: 'subscribers'
+    });
+    return /*#__PURE__*/ _jsxs("div", {
+        className: styles.wrapper,
+        children: [
+            /*#__PURE__*/ _jsx("h1", {
+                children: "Added by the plugin: Before Dashboard Server"
+            }),
+            "Docs from Local API:",
+            docs.map((doc)=>/*#__PURE__*/ _jsx("div", {
+                    children: doc.id
+                }, doc.id))
+        ]
+    });
+};
+//# sourceMappingURL=BeforeDashboardServer.js.map

package/dist/components/BeforeDashboardServer.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/components/BeforeDashboardServer.tsx"],"sourcesContent":["import type { ServerComponentProps } from 'payload'\n\nimport styles from './BeforeDashboardServer.module.css'\n\nexport const BeforeDashboardServer = async (props: ServerComponentProps) => {\n const { payload } = props\n\n const { docs } = await payload.find({ collection: 'subscribers' })\n\n return (\n <div className={styles.wrapper}>\n <h1>Added by the plugin: Before Dashboard Server</h1>\n Docs from Local API:\n {docs.map((doc) => (\n <div key={doc.id}>{doc.id}</div>\n ))}\n </div>\n )\n}\n"],"names":["styles","BeforeDashboardServer","props","payload","docs","find","collection","div","className","wrapper","h1","map","doc","id"],"mappings":";AAEA,OAAOA,YAAY,qCAAoC;AAEvD,OAAO,MAAMC,wBAAwB,OAAOC;IAC1C,MAAM,EAAEC,OAAO,EAAE,GAAGD;IAEpB,MAAM,EAAEE,IAAI,EAAE,GAAG,MAAMD,QAAQE,IAAI,CAAC;QAAEC,YAAY;IAAc;IAEhE,qBACE,MAACC;QAAIC,WAAWR,OAAOS,OAAO;;0BAC5B,KAACC;0BAAG;;YAAiD;YAEpDN,KAAKO,GAAG,CAAC,CAACC,oBACT,KAACL;8BAAkBK,IAAIC,EAAE;mBAAfD,IAAIC,EAAE;;;AAIxB,EAAC"}

package/dist/components/BeforeDashboardServer.module.css ADDED Viewed

@@ -0,0 +1,5 @@
+.wrapper {
+  display: flex;
+  gap: 5px;
+  flex-direction: column;
+}

package/dist/components/app/RequestMagicLink.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import type { RequestMagicLinkResponse } from '../../endpoints/requestMagicLink.js';
+export { RequestMagicLinkResponse };
+export interface IRequestMagicLink {
+    classNames?: RequestMagicLinkClasses;
+    handleMagicLinkRequested?: (result: RequestMagicLinkResponse) => void;
+    props?: any;
+}
+export type RequestMagicLinkClasses = {
+    button?: string;
+    container?: string;
+    emailInput?: string;
+    error?: string;
+    form?: string;
+    message?: string;
+};
+export declare const RequestMagicLink: ({ classNames, handleMagicLinkRequested, }: IRequestMagicLink) => import("react").JSX.Element;