payload-subscribers-plugin 0.0.1

package/dist/endpoints/requestMagicLink.js

@@ -0,0 +1,122 @@
+import crypto from 'crypto';
+import { defaultCollectionSlug } from '../collections/Subscribers.js';
+import { getTokenAndHash } from '../helpers/token.js';
+/**
+ * createEndpointRequestMagicLink
+ * @param options
+ * @returns
+ *
+ * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug
+ *
+ */ function createEndpointRequestMagicLink({ subscribersCollectionSlug = defaultCollectionSlug }) {
+    /**
+   * requestMagicLink Endpoint Handler
+   * @param req
+   * @data { email }
+   * @returns { status: 200, json: {message: string, now: date} }
+   * @returns { status: 400, json: {error: ('Bad data' | 'Unknown email result'), now: date} }
+   */ const requestMagicLinkHandler = async (req)=>{
+        const data = req?.json ? await req.json() : {};
+        const { email, forwardUrl } = data // if by POST data
+        ;
+        // const { email } = req.routeParams // if by path
+        if (!email) {
+            return Response.json({
+                error: 'Bad data',
+                now: new Date().toISOString()
+            }, {
+                status: 400
+            });
+        }
+        const userResults = await req.payload.find({
+            collection: subscribersCollectionSlug,
+            where: {
+                email: {
+                    equals: email
+                }
+            }
+        });
+        const user = userResults.docs[0];
+        if (!user) {
+            //
+            // Create subscriber with status 'pending',
+            // and an invisible unknowable password,
+            //
+            const { tokenHash: tokenHash2 } = getTokenAndHash() // Unknowable
+            ;
+            const createResult = await req.payload.create({
+                collection: subscribersCollectionSlug,
+                data: {
+                    email,
+                    password: tokenHash2,
+                    status: 'pending'
+                },
+                draft: false
+            });
+            if (!createResult) {
+                return Response.json({
+                    error: 'Bad data',
+                    now: new Date().toISOString()
+                }, {
+                    status: 400
+                });
+            }
+        }
+        // Update user with verificationToken
+        const token = crypto.randomBytes(32).toString('hex');
+        const tokenHash = crypto.createHash('sha256').update(token).digest('hex');
+        const expiresAt = new Date(Date.now() + 15 * 60 * 1000) // 15 mins
+        ;
+        await req.payload.update({
+            collection: subscribersCollectionSlug,
+            data: {
+                verificationToken: tokenHash,
+                verificationTokenExpires: expiresAt.toISOString()
+            },
+            where: {
+                email: {
+                    equals: user.email
+                }
+            }
+        });
+        // Send email
+        const forwardUrlParam = forwardUrl ? `&forwardUrl=${encodeURI(forwardUrl)}` : '';
+        const magicLink = `${req.payload.config.serverURL}/verify?token=${token}&email=${email}${forwardUrlParam}`;
+        const subject = data.subject || 'Your Magic Login Link';
+        const message = `
+  ${data.message || '<p>Use this link to log in:</p>'}
+  <p><a href="${magicLink}"><b>Login</b></a></p>
+  `;
+        const emailResult = await req.payload.sendEmail({
+            html: message,
+            subject,
+            to: user.email
+        });
+        //   req.payload.logger.info(`email result: ${JSON.stringify(emailResult)}`)
+        // return data; // Return data to allow normal submission if needed
+        if (!emailResult) {
+            return Response.json({
+                error: 'Unknown email result',
+                now: new Date().toISOString()
+            }, {
+                status: 400
+            });
+        }
+        req.payload.logger.info(`requestMagicLinkHandler email sent \n ${magicLink}`);
+        return Response.json({
+            emailResult,
+            now: new Date().toISOString()
+        });
+    };
+    /**
+   * requestMagicLink Endpoint Config
+   */ const requestMagicLinkEndpoint = {
+        handler: requestMagicLinkHandler,
+        method: 'post',
+        path: '/emailToken'
+    };
+    return requestMagicLinkEndpoint;
+}
+export default createEndpointRequestMagicLink;
+
+//# sourceMappingURL=requestMagicLink.js.map

package/dist/endpoints/requestMagicLink.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/endpoints/requestMagicLink.ts"],"sourcesContent":["import type { CollectionSlug, Endpoint, PayloadHandler, PayloadRequest, TypedUser } from 'payload'\n\nimport crypto from 'crypto'\nimport { defaultCollectionSlug } from '../collections/Subscribers.js'\n\nimport { getTokenAndHash } from '../helpers/token.js'\n\nexport type RequestMagicLinkResponse =\n  | {\n      emailResult: any\n      now: string\n    }\n  | {\n      error: string\n      now: string\n    }\n\n/**\n * createEndpointRequestMagicLink\n * @param options\n * @returns\n *\n * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug\n *\n */\nfunction createEndpointRequestMagicLink({\n  subscribersCollectionSlug = defaultCollectionSlug,\n}: {\n  subscribersCollectionSlug: CollectionSlug\n}): Endpoint {\n  /**\n   * requestMagicLink Endpoint Handler\n   * @param req\n   * @data { email }\n   * @returns { status: 200, json: {message: string, now: date} }\n   * @returns { status: 400, json: {error: ('Bad data' | 'Unknown email result'), now: date} }\n   */\n  const requestMagicLinkHandler: PayloadHandler = async (req: PayloadRequest) => {\n    const data = req?.json ? await req.json() : {}\n    const { email, forwardUrl } = data // if by POST data\n    // const { email } = req.routeParams // if by path\n\n    if (!email) {\n      return Response.json(\n        { error: 'Bad data', now: new Date().toISOString() } as RequestMagicLinkResponse,\n        { status: 400 },\n      )\n    }\n\n    const userResults = await req.payload.find({\n      collection: subscribersCollectionSlug,\n      where: {\n        email: { equals: email },\n      },\n    })\n    const user = userResults.docs[0] as TypedUser\n\n    if (!user) {\n      //\n      // Create subscriber with status 'pending',\n      // and an invisible unknowable password,\n      //\n      const { tokenHash: tokenHash2 } = getTokenAndHash() // Unknowable\n      const createResult = await req.payload.create({\n        collection: subscribersCollectionSlug,\n        data: {\n          email,\n          password: tokenHash2,\n          status: 'pending',\n        },\n        draft: false,\n      })\n      if (!createResult) {\n        return Response.json(\n          { error: 'Bad data', now: new Date().toISOString() } as RequestMagicLinkResponse,\n          { status: 400 },\n        )\n      }\n    }\n\n    // Update user with verificationToken\n    const token = crypto.randomBytes(32).toString('hex')\n    const tokenHash = crypto.createHash('sha256').update(token).digest('hex')\n    const expiresAt = new Date(Date.now() + 15 * 60 * 1000) // 15 mins\n    await req.payload.update({\n      collection: subscribersCollectionSlug,\n      data: {\n        verificationToken: tokenHash,\n        verificationTokenExpires: expiresAt.toISOString(),\n      },\n      where: {\n        email: { equals: user.email },\n      },\n    })\n\n    // Send email\n    const forwardUrlParam = forwardUrl ? `&forwardUrl=${encodeURI(forwardUrl)}` : ''\n    const magicLink = `${req.payload.config.serverURL}/verify?token=${token}&email=${email}${forwardUrlParam}`\n    const subject = data.subject || 'Your Magic Login Link'\n    const message = `\n  ${data.message || '<p>Use this link to log in:</p>'}\n  <p><a href=\"${magicLink}\"><b>Login</b></a></p>\n  `\n    const emailResult = await req.payload.sendEmail({\n      html: message,\n      subject,\n      to: user.email,\n    })\n    //   req.payload.logger.info(`email result: ${JSON.stringify(emailResult)}`)\n    // return data; // Return data to allow normal submission if needed\n    if (!emailResult) {\n      return Response.json(\n        {\n          error: 'Unknown email result',\n          now: new Date().toISOString(),\n        } as RequestMagicLinkResponse,\n        { status: 400 },\n      )\n    }\n    req.payload.logger.info(`requestMagicLinkHandler email sent \\n ${magicLink}`)\n    return Response.json({\n      emailResult,\n      now: new Date().toISOString(),\n    } as RequestMagicLinkResponse)\n  }\n\n  /**\n   * requestMagicLink Endpoint Config\n   */\n  const requestMagicLinkEndpoint: Endpoint = {\n    handler: requestMagicLinkHandler,\n    method: 'post',\n    path: '/emailToken',\n  }\n\n  return requestMagicLinkEndpoint\n}\n\nexport default createEndpointRequestMagicLink\n"],"names":["crypto","defaultCollectionSlug","getTokenAndHash","createEndpointRequestMagicLink","subscribersCollectionSlug","requestMagicLinkHandler","req","data","json","email","forwardUrl","Response","error","now","Date","toISOString","status","userResults","payload","find","collection","where","equals","user","docs","tokenHash","tokenHash2","createResult","create","password","draft","token","randomBytes","toString","createHash","update","digest","expiresAt","verificationToken","verificationTokenExpires","forwardUrlParam","encodeURI","magicLink","config","serverURL","subject","message","emailResult","sendEmail","html","to","logger","info","requestMagicLinkEndpoint","handler","method","path"],"mappings":"AAEA,OAAOA,YAAY,SAAQ;AAC3B,SAASC,qBAAqB,QAAQ,gCAA+B;AAErE,SAASC,eAAe,QAAQ,sBAAqB;AAYrD;;;;;;;CAOC,GACD,SAASC,+BAA+B,EACtCC,4BAA4BH,qBAAqB,EAGlD;IACC;;;;;;GAMC,GACD,MAAMI,0BAA0C,OAAOC;QACrD,MAAMC,OAAOD,KAAKE,OAAO,MAAMF,IAAIE,IAAI,KAAK,CAAC;QAC7C,MAAM,EAAEC,KAAK,EAAEC,UAAU,EAAE,GAAGH,KAAK,kBAAkB;;QACrD,kDAAkD;QAElD,IAAI,CAACE,OAAO;YACV,OAAOE,SAASH,IAAI,CAClB;gBAAEI,OAAO;gBAAYC,KAAK,IAAIC,OAAOC,WAAW;YAAG,GACnD;gBAAEC,QAAQ;YAAI;QAElB;QAEA,MAAMC,cAAc,MAAMX,IAAIY,OAAO,CAACC,IAAI,CAAC;YACzCC,YAAYhB;YACZiB,OAAO;gBACLZ,OAAO;oBAAEa,QAAQb;gBAAM;YACzB;QACF;QACA,MAAMc,OAAON,YAAYO,IAAI,CAAC,EAAE;QAEhC,IAAI,CAACD,MAAM;YACT,EAAE;YACF,2CAA2C;YAC3C,wCAAwC;YACxC,EAAE;YACF,MAAM,EAAEE,WAAWC,UAAU,EAAE,GAAGxB,kBAAkB,aAAa;;YACjE,MAAMyB,eAAe,MAAMrB,IAAIY,OAAO,CAACU,MAAM,CAAC;gBAC5CR,YAAYhB;gBACZG,MAAM;oBACJE;oBACAoB,UAAUH;oBACVV,QAAQ;gBACV;gBACAc,OAAO;YACT;YACA,IAAI,CAACH,cAAc;gBACjB,OAAOhB,SAASH,IAAI,CAClB;oBAAEI,OAAO;oBAAYC,KAAK,IAAIC,OAAOC,WAAW;gBAAG,GACnD;oBAAEC,QAAQ;gBAAI;YAElB;QACF;QAEA,qCAAqC;QACrC,MAAMe,QAAQ/B,OAAOgC,WAAW,CAAC,IAAIC,QAAQ,CAAC;QAC9C,MAAMR,YAAYzB,OAAOkC,UAAU,CAAC,UAAUC,MAAM,CAACJ,OAAOK,MAAM,CAAC;QACnE,MAAMC,YAAY,IAAIvB,KAAKA,KAAKD,GAAG,KAAK,KAAK,KAAK,MAAM,UAAU;;QAClE,MAAMP,IAAIY,OAAO,CAACiB,MAAM,CAAC;YACvBf,YAAYhB;YACZG,MAAM;gBACJ+B,mBAAmBb;gBACnBc,0BAA0BF,UAAUtB,WAAW;YACjD;YACAM,OAAO;gBACLZ,OAAO;oBAAEa,QAAQC,KAAKd,KAAK;gBAAC;YAC9B;QACF;QAEA,aAAa;QACb,MAAM+B,kBAAkB9B,aAAa,CAAC,YAAY,EAAE+B,UAAU/B,aAAa,GAAG;QAC9E,MAAMgC,YAAY,GAAGpC,IAAIY,OAAO,CAACyB,MAAM,CAACC,SAAS,CAAC,cAAc,EAAEb,MAAM,OAAO,EAAEtB,QAAQ+B,iBAAiB;QAC1G,MAAMK,UAAUtC,KAAKsC,OAAO,IAAI;QAChC,MAAMC,UAAU,CAAC;EACnB,EAAEvC,KAAKuC,OAAO,IAAI,kCAAkC;cACxC,EAAEJ,UAAU;EACxB,CAAC;QACC,MAAMK,cAAc,MAAMzC,IAAIY,OAAO,CAAC8B,SAAS,CAAC;YAC9CC,MAAMH;YACND;YACAK,IAAI3B,KAAKd,KAAK;QAChB;QACA,4EAA4E;QAC5E,mEAAmE;QACnE,IAAI,CAACsC,aAAa;YAChB,OAAOpC,SAASH,IAAI,CAClB;gBACEI,OAAO;gBACPC,KAAK,IAAIC,OAAOC,WAAW;YAC7B,GACA;gBAAEC,QAAQ;YAAI;QAElB;QACAV,IAAIY,OAAO,CAACiC,MAAM,CAACC,IAAI,CAAC,CAAC,sCAAsC,EAAEV,WAAW;QAC5E,OAAO/B,SAASH,IAAI,CAAC;YACnBuC;YACAlC,KAAK,IAAIC,OAAOC,WAAW;QAC7B;IACF;IAEA;;GAEC,GACD,MAAMsC,2BAAqC;QACzCC,SAASjD;QACTkD,QAAQ;QACRC,MAAM;IACR;IAEA,OAAOH;AACT;AAEA,eAAelD,+BAA8B"}

package/dist/endpoints/subscribe.d.ts

@@ -0,0 +1,24 @@
+import type { CollectionSlug, Endpoint } from 'payload';
+export type SubscribeResponse = {
+    email: string;
+    now: string;
+    optIns: string[];
+} | {
+    emailResult: any;
+    now: string;
+} | {
+    error: string;
+    now: string;
+};
+/**
+ * createEndpointLogout
+ * @param options
+ * @returns
+ *
+ * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug
+ *
+ */
+declare function createEndpointSubscribe({ subscribersCollectionSlug, }: {
+    subscribersCollectionSlug: CollectionSlug;
+}): Endpoint;
+export default createEndpointSubscribe;

package/dist/endpoints/subscribe.js

@@ -0,0 +1,343 @@
+import { defaultCollectionSlug } from '../collections/Subscribers.js';
+import { getTokenAndHash } from '../helpers/token.js';
+import { verifyOptIns } from '../helpers/verifyOptIns.js';
+/**
+ * createEndpointLogout
+ * @param options
+ * @returns
+ *
+ * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug
+ *
+ */ function createEndpointSubscribe({ subscribersCollectionSlug = defaultCollectionSlug }) {
+    /**
+   * subscribe Endpoint Handler
+   * @param req
+   * @data { email }
+   * @returns { status: 200, json: {message: string, now: date} }
+   * @returns { status: 400, json: {error: ('Bad data' | 'Already subscribed' | 'Unknown email result'), now: date} }
+   */ const subscribeHandler = async (req)=>{
+        const data = req?.json ? await req.json() : {};
+        const { afterVerifyUrl, email, optIns } = data // if by POST data
+        ;
+        // const { email } = req.routeParams // if by path
+        //
+        // HELPERS
+        // Some of these functions make use of the scope within handler,
+        // and would have to be refactored if moved out.
+        //
+        const createSubscriber = async ({ optIns, password, status, verificationToken, verificationTokenExpires })=>{
+            await req.payload.create({
+                collection: subscribersCollectionSlug,
+                data: {
+                    email,
+                    optIns,
+                    password,
+                    status: status || 'pending',
+                    verificationToken,
+                    verificationTokenExpires: verificationTokenExpires?.toISOString()
+                },
+                draft: false
+            });
+        };
+        const updateSubscriber = async ({ id, optIns, password, status, verificationToken, verificationTokenExpires })=>{
+            const updateResults = await req.payload.update({
+                id,
+                collection: subscribersCollectionSlug,
+                data: {
+                    optIns,
+                    password,
+                    status,
+                    verificationToken,
+                    verificationTokenExpires: verificationTokenExpires?.toISOString() || null
+                },
+                depth: 0
+            });
+            return updateResults;
+        };
+        const sendVerifyEmail = async ({ email, forwardUrl, linkText, message, subject, token })=>{
+            const forwardUrlParam = forwardUrl ? `&forwardUrl=${encodeURI(forwardUrl)}` : '';
+            const magicLink = `${req.payload.config.serverURL}/verify?token=${token}&email=${email}${forwardUrlParam}`;
+            const html = message + `<p><a href="${magicLink}">${linkText}</a></p>`;
+            const emailResult = await req.payload.sendEmail({
+                html,
+                subject,
+                to: email
+            });
+            req.payload.logger.info(`subscribe email sent \n ${magicLink}`);
+            return emailResult;
+        };
+        //
+        // VALIDATE INPUT
+        //
+        // Require email
+        if (!email) {
+            req.payload.logger.error(JSON.stringify({
+                error: 'Bad data',
+                now: new Date().toISOString()
+            }, undefined, 2));
+            return Response.json({
+                error: 'Bad data',
+                now: new Date().toISOString()
+            }, {
+                status: 400
+            });
+        }
+        //
+        // Validate OptInChannels
+        const { invalidOptInsInput, verifiedOptInIDs } = await verifyOptIns(req.payload, optIns);
+        if (invalidOptInsInput) {
+            req.payload.logger.error(JSON.stringify({
+                error: 'Invalid input: ' + JSON.stringify(optIns),
+                now: new Date().toISOString()
+            }, undefined, 2));
+            return Response.json({
+                error: 'Invalid input: ' + JSON.stringify(optIns),
+                now: new Date().toISOString()
+            }, {
+                status: 400
+            });
+        }
+        //
+        // Verify subscriber exists
+        const userResults = await req.payload.find({
+            collection: subscribersCollectionSlug,
+            where: {
+                email: {
+                    equals: email
+                }
+            }
+        });
+        const subscriber = userResults.docs[0];
+        //
+        // Now we have a subscriber and validatedOptIns
+        // Handle scenarios
+        //
+        // ********************************************************
+        //
+        if (req.user && req.user.email != email) {
+            //
+            // Error: Auth-ed user doesn't match subscriber email
+            //
+            req.payload.logger.error(JSON.stringify({
+                error: 'Unauthorized: ' + email,
+                now: new Date().toISOString()
+            }, undefined, 2));
+            return Response.json({
+                error: 'Unauthorized: ' + email,
+                now: new Date().toISOString()
+            }, {
+                status: 400
+            });
+        }
+        //
+        // ********************************************************
+        //
+        if (!subscriber) {
+            //
+            // Create subscriber with status 'pending',
+            // and an invisible unknowable password,
+            // and send a verify email
+            // Pass all optIns through verify link
+            //
+            const { expiresAt, token, tokenHash } = getTokenAndHash(15 * 60 * 1000) // Use for magic link
+            ;
+            const { tokenHash: tokenHash2 } = getTokenAndHash() // Unknowable
+            ;
+            await createSubscriber({
+                email,
+                optIns,
+                password: tokenHash2,
+                status: 'pending',
+                verificationToken: tokenHash,
+                verificationTokenExpires: expiresAt
+            });
+            //
+            // Send email
+            const emailResult = await sendVerifyEmail({
+                email,
+                forwardUrl: afterVerifyUrl,
+                linkText: '<b>Verify</b>',
+                message: data.message || `<p>Click here to verify your subscription:</p>`,
+                subject: data.subject || 'Please verify your subscription',
+                token
+            });
+            if (!emailResult) {
+                req.payload.logger.error(JSON.stringify({
+                    error: 'Unknown email result',
+                    now: new Date().toISOString()
+                }, undefined, 2));
+                return Response.json({
+                    error: 'Unknown email result',
+                    now: new Date().toISOString()
+                }, {
+                    status: 400
+                });
+            }
+            return Response.json({
+                emailResult,
+                now: new Date().toISOString()
+            });
+        //
+        }
+        //
+        // ********************************************************
+        //
+        if (!req.user && subscriber) {
+            //
+            // Send magic link to log the user in
+            // Pass all optIns through verify link
+            //
+            const { expiresAt, token, tokenHash } = getTokenAndHash(15 * 60 * 1000) // Use for magic link
+            ;
+            // Update subscriber with token for pending email
+            const updateResults = await updateSubscriber({
+                id: subscriber.id,
+                verificationToken: tokenHash,
+                verificationTokenExpires: expiresAt
+            });
+            if (!updateResults) {
+                req.payload.logger.error(JSON.stringify({
+                    error: 'Unknown error',
+                    now: new Date().toISOString()
+                }, undefined, 2));
+                return Response.json({
+                    error: 'Unknown error',
+                    now: new Date().toISOString()
+                }, {
+                    status: 400
+                });
+            }
+            //
+            // Send email
+            const emailResult = await sendVerifyEmail({
+                email,
+                forwardUrl: afterVerifyUrl,
+                linkText: 'Verify',
+                message: data.message || `<h1>Click here to verify your subscription:</h1>`,
+                subject: data.subject || 'Please verify your subscription',
+                token
+            });
+            if (!emailResult) {
+                req.payload.logger.error(JSON.stringify({
+                    error: 'Unknown email result',
+                    now: new Date().toISOString()
+                }, undefined, 2));
+                return Response.json({
+                    error: 'Unknown email result',
+                    now: new Date().toISOString()
+                }, {
+                    status: 400
+                });
+            }
+            return Response.json({
+                emailResult,
+                now: new Date().toISOString()
+            });
+        }
+        //
+        // ********************************************************
+        //
+        if (req.user && subscriber && subscriber.status == 'pending') {
+            //
+            // Send magic link to verify the email and log the user in
+            // Pass all optIns through verify link
+            //
+            const { expiresAt, token, tokenHash } = getTokenAndHash(15 * 60 * 1000) // Use for magic link
+            ;
+            // Create subscriber with token for pending email
+            const updateResults = await updateSubscriber({
+                id: subscriber.id,
+                verificationToken: tokenHash,
+                verificationTokenExpires: expiresAt
+            });
+            if (!updateResults) {
+                req.payload.logger.error(JSON.stringify({
+                    error: 'Unknown error',
+                    now: new Date().toISOString()
+                }, undefined, 2));
+                return Response.json({
+                    error: 'Unknown error',
+                    now: new Date().toISOString()
+                }, {
+                    status: 400
+                });
+            }
+            const emailResult = await sendVerifyEmail({
+                email,
+                forwardUrl: afterVerifyUrl,
+                linkText: 'Verify',
+                message: data.message || `<h1>Click here to verify your email:</h1>`,
+                subject: data.subject || 'Please verify your subscription',
+                token
+            });
+            if (!emailResult) {
+                req.payload.logger.error(JSON.stringify({
+                    error: 'Unknown email result',
+                    now: new Date().toISOString()
+                }, undefined, 2));
+                return Response.json({
+                    error: 'Unknown email result',
+                    now: new Date().toISOString()
+                }, {
+                    status: 400
+                });
+            }
+            return Response.json({
+                emailResult,
+                now: new Date().toISOString()
+            });
+        }
+        //
+        // ********************************************************
+        //
+        if (req.user && subscriber && subscriber.status != 'pending') {
+            //
+            // Update subscriber with status 'subscribed',
+            // an invisible unknowable password,
+            // and if any optIns input exists, set subscriber optIns
+            // to EXACTLY verifiedOptInIDs (potentially unsubscribing from any not in verifiedOptInIDs)
+            //
+            const { tokenHash } = getTokenAndHash() // Use for magic link
+            ;
+            // Update subscriber with optIns
+            const updateResults = await updateSubscriber({
+                id: subscriber.id,
+                optIns: verifiedOptInIDs,
+                password: tokenHash,
+                status: 'subscribed',
+                verificationToken: '',
+                verificationTokenExpires: null
+            });
+            // Return results, including the verified optIns
+            return Response.json({
+                email: updateResults.email,
+                now: new Date().toISOString(),
+                optIns: updateResults.optIns
+            });
+        }
+        //
+        // Uncaught case
+        //
+        req.payload.logger.error(JSON.stringify({
+            error: 'Unknown error',
+            now: new Date().toISOString()
+        }, undefined, 2));
+        return Response.json({
+            error: 'Unknown error',
+            now: new Date().toISOString()
+        }, {
+            status: 400
+        });
+    };
+    /**
+   * subscribe Endpoint Config
+   */ const subscribeEndpoint = {
+        handler: subscribeHandler,
+        method: 'post',
+        path: '/subscribe'
+    };
+    return subscribeEndpoint;
+}
+export default createEndpointSubscribe;
+
+//# sourceMappingURL=subscribe.js.map

package/dist/endpoints/subscribe.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/endpoints/subscribe.ts"],"sourcesContent":["import type { CollectionSlug, Endpoint, PayloadHandler } from 'payload'\nimport type { Subscriber } from 'src/copied/payload-types.js'\n\nimport { defaultCollectionSlug } from '../collections/Subscribers.js'\n\nimport { getTokenAndHash } from '../helpers/token.js'\nimport { verifyOptIns } from '../helpers/verifyOptIns.js'\n\nexport type SubscribeResponse =\n  // When subscriber optIns are updated...\n  | {\n      email: string\n      now: string\n      optIns: string[]\n    }\n  // When a verify link is emailed...\n  | {\n      emailResult: any\n      now: string\n    }\n  // When any error occurs...\n  | {\n      error: string\n      now: string\n    }\n\n/**\n * createEndpointLogout\n * @param options\n * @returns\n *\n * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug\n *\n */\nfunction createEndpointSubscribe({\n  subscribersCollectionSlug = defaultCollectionSlug,\n}: {\n  subscribersCollectionSlug: CollectionSlug\n}): Endpoint {\n  /**\n   * subscribe Endpoint Handler\n   * @param req\n   * @data { email }\n   * @returns { status: 200, json: {message: string, now: date} }\n   * @returns { status: 400, json: {error: ('Bad data' | 'Already subscribed' | 'Unknown email result'), now: date} }\n   */\n  const subscribeHandler: PayloadHandler = async (req) => {\n    const data = req?.json ? await req.json() : {}\n    const {\n      afterVerifyUrl,\n      email,\n      optIns,\n    }: { afterVerifyUrl: string; email: string; optIns: string[] } = data // if by POST data\n    // const { email } = req.routeParams // if by path\n\n    //\n    // HELPERS\n    // Some of these functions make use of the scope within handler,\n    // and would have to be refactored if moved out.\n    //\n    const createSubscriber = async ({\n      optIns,\n      password,\n      status,\n      verificationToken,\n      verificationTokenExpires,\n    }: {\n      email: string\n      optIns?: string[]\n      password?: string\n      status?: 'pending' | 'subscribed' | 'unsubscribed'\n      verificationToken?: string\n      verificationTokenExpires?: Date\n    }) => {\n      await req.payload.create({\n        collection: subscribersCollectionSlug,\n        data: {\n          email,\n          optIns,\n          password,\n          status: status || 'pending',\n          verificationToken,\n          verificationTokenExpires: verificationTokenExpires?.toISOString(),\n        },\n        draft: false,\n      })\n    }\n    const updateSubscriber = async ({\n      id,\n      optIns,\n      password,\n      status,\n      verificationToken,\n      verificationTokenExpires,\n    }: {\n      id: string\n      optIns?: string[]\n      password?: string\n      status?: 'pending' | 'subscribed' | 'unsubscribed'\n      verificationToken?: string\n      verificationTokenExpires?: Date | null\n    }) => {\n      const updateResults = await req.payload.update({\n        id,\n        collection: subscribersCollectionSlug,\n        data: {\n          optIns,\n          password,\n          status,\n          verificationToken,\n          verificationTokenExpires: verificationTokenExpires?.toISOString() || null,\n        },\n        depth: 0,\n      })\n      return updateResults\n    }\n    const sendVerifyEmail = async ({\n      email,\n      forwardUrl,\n      linkText,\n      message,\n      subject,\n      token,\n    }: {\n      email: string\n      forwardUrl?: string\n      linkText: string\n      message: string\n      subject: string\n      token: string\n    }) => {\n      const forwardUrlParam = forwardUrl ? `&forwardUrl=${encodeURI(forwardUrl)}` : ''\n      const magicLink = `${req.payload.config.serverURL}/verify?token=${token}&email=${email}${forwardUrlParam}`\n      const html = message + `<p><a href=\"${magicLink}\">${linkText}</a></p>`\n      const emailResult = await req.payload.sendEmail({\n        html,\n        subject,\n        to: email,\n      })\n      req.payload.logger.info(`subscribe email sent \\n ${magicLink}`)\n      return emailResult\n    }\n\n    //\n    // VALIDATE INPUT\n    //\n    // Require email\n    if (!email) {\n      req.payload.logger.error(\n        JSON.stringify(\n          { error: 'Bad data', now: new Date().toISOString() } as SubscribeResponse,\n          undefined,\n          2,\n        ),\n      )\n      return Response.json(\n        { error: 'Bad data', now: new Date().toISOString() } as SubscribeResponse,\n        { status: 400 },\n      )\n    }\n\n    //\n    // Validate OptInChannels\n    const { invalidOptInsInput, verifiedOptInIDs } = await verifyOptIns(req.payload, optIns)\n\n    if (invalidOptInsInput) {\n      req.payload.logger.error(\n        JSON.stringify(\n          {\n            error: 'Invalid input: ' + JSON.stringify(optIns),\n            now: new Date().toISOString(),\n          } as SubscribeResponse,\n          undefined,\n          2,\n        ),\n      )\n      return Response.json(\n        {\n          error: 'Invalid input: ' + JSON.stringify(optIns),\n          now: new Date().toISOString(),\n        } as SubscribeResponse,\n        { status: 400 },\n      )\n    }\n\n    //\n    // Verify subscriber exists\n    const userResults = await req.payload.find({\n      collection: subscribersCollectionSlug,\n      where: {\n        email: { equals: email },\n      },\n    })\n    const subscriber = userResults.docs[0] as Subscriber\n\n    //\n    // Now we have a subscriber and validatedOptIns\n    // Handle scenarios\n    //\n    // ********************************************************\n    //\n    if (req.user && req.user.email != email) {\n      //\n      // Error: Auth-ed user doesn't match subscriber email\n      //\n      req.payload.logger.error(\n        JSON.stringify(\n          {\n            error: 'Unauthorized: ' + email,\n            now: new Date().toISOString(),\n          } as SubscribeResponse,\n          undefined,\n          2,\n        ),\n      )\n      return Response.json(\n        {\n          error: 'Unauthorized: ' + email,\n          now: new Date().toISOString(),\n        } as SubscribeResponse,\n        { status: 400 },\n      )\n    }\n\n    //\n    // ********************************************************\n    //\n    if (!subscriber) {\n      //\n      // Create subscriber with status 'pending',\n      // and an invisible unknowable password,\n      // and send a verify email\n      // Pass all optIns through verify link\n      //\n      const { expiresAt, token, tokenHash } = getTokenAndHash(15 * 60 * 1000) // Use for magic link\n      const { tokenHash: tokenHash2 } = getTokenAndHash() // Unknowable\n      await createSubscriber({\n        email,\n        optIns,\n        password: tokenHash2,\n        status: 'pending',\n        verificationToken: tokenHash,\n        verificationTokenExpires: expiresAt,\n      })\n\n      //\n      // Send email\n      const emailResult = await sendVerifyEmail({\n        email,\n        forwardUrl: afterVerifyUrl,\n        linkText: '<b>Verify</b>',\n        message: data.message || `<p>Click here to verify your subscription:</p>`,\n        subject: data.subject || 'Please verify your subscription',\n        token,\n      })\n      if (!emailResult) {\n        req.payload.logger.error(\n          JSON.stringify(\n            { error: 'Unknown email result', now: new Date().toISOString() } as SubscribeResponse,\n            undefined,\n            2,\n          ),\n        )\n        return Response.json(\n          { error: 'Unknown email result', now: new Date().toISOString() } as SubscribeResponse,\n          { status: 400 },\n        )\n      }\n      return Response.json({ emailResult, now: new Date().toISOString() } as SubscribeResponse)\n      //\n    }\n    //\n    // ********************************************************\n    //\n    if (!req.user && subscriber) {\n      //\n      // Send magic link to log the user in\n      // Pass all optIns through verify link\n      //\n      const { expiresAt, token, tokenHash } = getTokenAndHash(15 * 60 * 1000) // Use for magic link\n      // Update subscriber with token for pending email\n      const updateResults = await updateSubscriber({\n        id: subscriber.id,\n        verificationToken: tokenHash,\n        verificationTokenExpires: expiresAt,\n      })\n      if (!updateResults) {\n        req.payload.logger.error(\n          JSON.stringify(\n            { error: 'Unknown error', now: new Date().toISOString() } as SubscribeResponse,\n            undefined,\n            2,\n          ),\n        )\n        return Response.json(\n          { error: 'Unknown error', now: new Date().toISOString() } as SubscribeResponse,\n          { status: 400 },\n        )\n      }\n\n      //\n      // Send email\n      const emailResult = await sendVerifyEmail({\n        email,\n        forwardUrl: afterVerifyUrl,\n        linkText: 'Verify',\n        message: data.message || `<h1>Click here to verify your subscription:</h1>`,\n        subject: data.subject || 'Please verify your subscription',\n        token,\n      })\n      if (!emailResult) {\n        req.payload.logger.error(\n          JSON.stringify(\n            { error: 'Unknown email result', now: new Date().toISOString() } as SubscribeResponse,\n            undefined,\n            2,\n          ),\n        )\n        return Response.json(\n          { error: 'Unknown email result', now: new Date().toISOString() } as SubscribeResponse,\n          { status: 400 },\n        )\n      }\n      return Response.json({ emailResult, now: new Date().toISOString() } as SubscribeResponse)\n    }\n    //\n    // ********************************************************\n    //\n    if (req.user && subscriber && subscriber.status == 'pending') {\n      //\n      // Send magic link to verify the email and log the user in\n      // Pass all optIns through verify link\n      //\n      const { expiresAt, token, tokenHash } = getTokenAndHash(15 * 60 * 1000) // Use for magic link\n      // Create subscriber with token for pending email\n      const updateResults = await updateSubscriber({\n        id: subscriber.id,\n        verificationToken: tokenHash,\n        verificationTokenExpires: expiresAt,\n      })\n      if (!updateResults) {\n        req.payload.logger.error(\n          JSON.stringify(\n            { error: 'Unknown error', now: new Date().toISOString() } as SubscribeResponse,\n            undefined,\n            2,\n          ),\n        )\n        return Response.json(\n          { error: 'Unknown error', now: new Date().toISOString() } as SubscribeResponse,\n          { status: 400 },\n        )\n      }\n\n      const emailResult = await sendVerifyEmail({\n        email,\n        forwardUrl: afterVerifyUrl,\n        linkText: 'Verify',\n        message: data.message || `<h1>Click here to verify your email:</h1>`,\n        subject: data.subject || 'Please verify your subscription',\n        token,\n      })\n      if (!emailResult) {\n        req.payload.logger.error(\n          JSON.stringify(\n            { error: 'Unknown email result', now: new Date().toISOString() } as SubscribeResponse,\n            undefined,\n            2,\n          ),\n        )\n        return Response.json(\n          { error: 'Unknown email result', now: new Date().toISOString() } as SubscribeResponse,\n          { status: 400 },\n        )\n      }\n      return Response.json({ emailResult, now: new Date().toISOString() } as SubscribeResponse)\n    }\n\n    //\n    // ********************************************************\n    //\n    if (req.user && subscriber && subscriber.status != 'pending') {\n      //\n      // Update subscriber with status 'subscribed',\n      // an invisible unknowable password,\n      // and if any optIns input exists, set subscriber optIns\n      // to EXACTLY verifiedOptInIDs (potentially unsubscribing from any not in verifiedOptInIDs)\n      //\n      const { tokenHash } = getTokenAndHash() // Use for magic link\n      // Update subscriber with optIns\n      const updateResults = (await updateSubscriber({\n        id: subscriber.id,\n        optIns: verifiedOptInIDs,\n        password: tokenHash,\n        status: 'subscribed',\n        verificationToken: '',\n        verificationTokenExpires: null,\n      })) as Subscriber\n\n      // Return results, including the verified optIns\n      return Response.json({\n        email: updateResults.email,\n        now: new Date().toISOString(),\n        optIns: updateResults.optIns,\n      } as SubscribeResponse)\n    }\n    //\n    // Uncaught case\n    //\n    req.payload.logger.error(\n      JSON.stringify(\n        { error: 'Unknown error', now: new Date().toISOString() } as SubscribeResponse,\n        undefined,\n        2,\n      ),\n    )\n    return Response.json(\n      { error: 'Unknown error', now: new Date().toISOString() } as SubscribeResponse,\n      { status: 400 },\n    )\n  }\n\n  /**\n   * subscribe Endpoint Config\n   */\n  const subscribeEndpoint: Endpoint = {\n    handler: subscribeHandler,\n    method: 'post',\n    path: '/subscribe',\n  }\n\n  return subscribeEndpoint\n}\n\nexport default createEndpointSubscribe\n"],"names":["defaultCollectionSlug","getTokenAndHash","verifyOptIns","createEndpointSubscribe","subscribersCollectionSlug","subscribeHandler","req","data","json","afterVerifyUrl","email","optIns","createSubscriber","password","status","verificationToken","verificationTokenExpires","payload","create","collection","toISOString","draft","updateSubscriber","id","updateResults","update","depth","sendVerifyEmail","forwardUrl","linkText","message","subject","token","forwardUrlParam","encodeURI","magicLink","config","serverURL","html","emailResult","sendEmail","to","logger","info","error","JSON","stringify","now","Date","undefined","Response","invalidOptInsInput","verifiedOptInIDs","userResults","find","where","equals","subscriber","docs","user","expiresAt","tokenHash","tokenHash2","subscribeEndpoint","handler","method","path"],"mappings":"AAGA,SAASA,qBAAqB,QAAQ,gCAA+B;AAErE,SAASC,eAAe,QAAQ,sBAAqB;AACrD,SAASC,YAAY,QAAQ,6BAA4B;AAoBzD;;;;;;;CAOC,GACD,SAASC,wBAAwB,EAC/BC,4BAA4BJ,qBAAqB,EAGlD;IACC;;;;;;GAMC,GACD,MAAMK,mBAAmC,OAAOC;QAC9C,MAAMC,OAAOD,KAAKE,OAAO,MAAMF,IAAIE,IAAI,KAAK,CAAC;QAC7C,MAAM,EACJC,cAAc,EACdC,KAAK,EACLC,MAAM,EACP,GAAgEJ,KAAK,kBAAkB;;QACxF,kDAAkD;QAElD,EAAE;QACF,UAAU;QACV,gEAAgE;QAChE,gDAAgD;QAChD,EAAE;QACF,MAAMK,mBAAmB,OAAO,EAC9BD,MAAM,EACNE,QAAQ,EACRC,MAAM,EACNC,iBAAiB,EACjBC,wBAAwB,EAQzB;YACC,MAAMV,IAAIW,OAAO,CAACC,MAAM,CAAC;gBACvBC,YAAYf;gBACZG,MAAM;oBACJG;oBACAC;oBACAE;oBACAC,QAAQA,UAAU;oBAClBC;oBACAC,0BAA0BA,0BAA0BI;gBACtD;gBACAC,OAAO;YACT;QACF;QACA,MAAMC,mBAAmB,OAAO,EAC9BC,EAAE,EACFZ,MAAM,EACNE,QAAQ,EACRC,MAAM,EACNC,iBAAiB,EACjBC,wBAAwB,EAQzB;YACC,MAAMQ,gBAAgB,MAAMlB,IAAIW,OAAO,CAACQ,MAAM,CAAC;gBAC7CF;gBACAJ,YAAYf;gBACZG,MAAM;oBACJI;oBACAE;oBACAC;oBACAC;oBACAC,0BAA0BA,0BAA0BI,iBAAiB;gBACvE;gBACAM,OAAO;YACT;YACA,OAAOF;QACT;QACA,MAAMG,kBAAkB,OAAO,EAC7BjB,KAAK,EACLkB,UAAU,EACVC,QAAQ,EACRC,OAAO,EACPC,OAAO,EACPC,KAAK,EAQN;YACC,MAAMC,kBAAkBL,aAAa,CAAC,YAAY,EAAEM,UAAUN,aAAa,GAAG;YAC9E,MAAMO,YAAY,GAAG7B,IAAIW,OAAO,CAACmB,MAAM,CAACC,SAAS,CAAC,cAAc,EAAEL,MAAM,OAAO,EAAEtB,QAAQuB,iBAAiB;YAC1G,MAAMK,OAAOR,UAAU,CAAC,YAAY,EAAEK,UAAU,EAAE,EAAEN,SAAS,QAAQ,CAAC;YACtE,MAAMU,cAAc,MAAMjC,IAAIW,OAAO,CAACuB,SAAS,CAAC;gBAC9CF;gBACAP;gBACAU,IAAI/B;YACN;YACAJ,IAAIW,OAAO,CAACyB,MAAM,CAACC,IAAI,CAAC,CAAC,wBAAwB,EAAER,WAAW;YAC9D,OAAOI;QACT;QAEA,EAAE;QACF,iBAAiB;QACjB,EAAE;QACF,gBAAgB;QAChB,IAAI,CAAC7B,OAAO;YACVJ,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;gBAAEF,OAAO;gBAAYG,KAAK,IAAIC,OAAO5B,WAAW;YAAG,GACnD6B,WACA;YAGJ,OAAOC,SAAS1C,IAAI,CAClB;gBAAEoC,OAAO;gBAAYG,KAAK,IAAIC,OAAO5B,WAAW;YAAG,GACnD;gBAAEN,QAAQ;YAAI;QAElB;QAEA,EAAE;QACF,yBAAyB;QACzB,MAAM,EAAEqC,kBAAkB,EAAEC,gBAAgB,EAAE,GAAG,MAAMlD,aAAaI,IAAIW,OAAO,EAAEN;QAEjF,IAAIwC,oBAAoB;YACtB7C,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;gBACEF,OAAO,oBAAoBC,KAAKC,SAAS,CAACnC;gBAC1CoC,KAAK,IAAIC,OAAO5B,WAAW;YAC7B,GACA6B,WACA;YAGJ,OAAOC,SAAS1C,IAAI,CAClB;gBACEoC,OAAO,oBAAoBC,KAAKC,SAAS,CAACnC;gBAC1CoC,KAAK,IAAIC,OAAO5B,WAAW;YAC7B,GACA;gBAAEN,QAAQ;YAAI;QAElB;QAEA,EAAE;QACF,2BAA2B;QAC3B,MAAMuC,cAAc,MAAM/C,IAAIW,OAAO,CAACqC,IAAI,CAAC;YACzCnC,YAAYf;YACZmD,OAAO;gBACL7C,OAAO;oBAAE8C,QAAQ9C;gBAAM;YACzB;QACF;QACA,MAAM+C,aAAaJ,YAAYK,IAAI,CAAC,EAAE;QAEtC,EAAE;QACF,+CAA+C;QAC/C,mBAAmB;QACnB,EAAE;QACF,2DAA2D;QAC3D,EAAE;QACF,IAAIpD,IAAIqD,IAAI,IAAIrD,IAAIqD,IAAI,CAACjD,KAAK,IAAIA,OAAO;YACvC,EAAE;YACF,qDAAqD;YACrD,EAAE;YACFJ,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;gBACEF,OAAO,mBAAmBlC;gBAC1BqC,KAAK,IAAIC,OAAO5B,WAAW;YAC7B,GACA6B,WACA;YAGJ,OAAOC,SAAS1C,IAAI,CAClB;gBACEoC,OAAO,mBAAmBlC;gBAC1BqC,KAAK,IAAIC,OAAO5B,WAAW;YAC7B,GACA;gBAAEN,QAAQ;YAAI;QAElB;QAEA,EAAE;QACF,2DAA2D;QAC3D,EAAE;QACF,IAAI,CAAC2C,YAAY;YACf,EAAE;YACF,2CAA2C;YAC3C,wCAAwC;YACxC,0BAA0B;YAC1B,sCAAsC;YACtC,EAAE;YACF,MAAM,EAAEG,SAAS,EAAE5B,KAAK,EAAE6B,SAAS,EAAE,GAAG5D,gBAAgB,KAAK,KAAK,MAAM,qBAAqB;;YAC7F,MAAM,EAAE4D,WAAWC,UAAU,EAAE,GAAG7D,kBAAkB,aAAa;;YACjE,MAAMW,iBAAiB;gBACrBF;gBACAC;gBACAE,UAAUiD;gBACVhD,QAAQ;gBACRC,mBAAmB8C;gBACnB7C,0BAA0B4C;YAC5B;YAEA,EAAE;YACF,aAAa;YACb,MAAMrB,cAAc,MAAMZ,gBAAgB;gBACxCjB;gBACAkB,YAAYnB;gBACZoB,UAAU;gBACVC,SAASvB,KAAKuB,OAAO,IAAI,CAAC,8CAA8C,CAAC;gBACzEC,SAASxB,KAAKwB,OAAO,IAAI;gBACzBC;YACF;YACA,IAAI,CAACO,aAAa;gBAChBjC,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;oBAAEF,OAAO;oBAAwBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GAC/D6B,WACA;gBAGJ,OAAOC,SAAS1C,IAAI,CAClB;oBAAEoC,OAAO;oBAAwBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GAC/D;oBAAEN,QAAQ;gBAAI;YAElB;YACA,OAAOoC,SAAS1C,IAAI,CAAC;gBAAE+B;gBAAaQ,KAAK,IAAIC,OAAO5B,WAAW;YAAG;QAClE,EAAE;QACJ;QACA,EAAE;QACF,2DAA2D;QAC3D,EAAE;QACF,IAAI,CAACd,IAAIqD,IAAI,IAAIF,YAAY;YAC3B,EAAE;YACF,qCAAqC;YACrC,sCAAsC;YACtC,EAAE;YACF,MAAM,EAAEG,SAAS,EAAE5B,KAAK,EAAE6B,SAAS,EAAE,GAAG5D,gBAAgB,KAAK,KAAK,MAAM,qBAAqB;;YAC7F,iDAAiD;YACjD,MAAMuB,gBAAgB,MAAMF,iBAAiB;gBAC3CC,IAAIkC,WAAWlC,EAAE;gBACjBR,mBAAmB8C;gBACnB7C,0BAA0B4C;YAC5B;YACA,IAAI,CAACpC,eAAe;gBAClBlB,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;oBAAEF,OAAO;oBAAiBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GACxD6B,WACA;gBAGJ,OAAOC,SAAS1C,IAAI,CAClB;oBAAEoC,OAAO;oBAAiBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GACxD;oBAAEN,QAAQ;gBAAI;YAElB;YAEA,EAAE;YACF,aAAa;YACb,MAAMyB,cAAc,MAAMZ,gBAAgB;gBACxCjB;gBACAkB,YAAYnB;gBACZoB,UAAU;gBACVC,SAASvB,KAAKuB,OAAO,IAAI,CAAC,gDAAgD,CAAC;gBAC3EC,SAASxB,KAAKwB,OAAO,IAAI;gBACzBC;YACF;YACA,IAAI,CAACO,aAAa;gBAChBjC,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;oBAAEF,OAAO;oBAAwBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GAC/D6B,WACA;gBAGJ,OAAOC,SAAS1C,IAAI,CAClB;oBAAEoC,OAAO;oBAAwBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GAC/D;oBAAEN,QAAQ;gBAAI;YAElB;YACA,OAAOoC,SAAS1C,IAAI,CAAC;gBAAE+B;gBAAaQ,KAAK,IAAIC,OAAO5B,WAAW;YAAG;QACpE;QACA,EAAE;QACF,2DAA2D;QAC3D,EAAE;QACF,IAAId,IAAIqD,IAAI,IAAIF,cAAcA,WAAW3C,MAAM,IAAI,WAAW;YAC5D,EAAE;YACF,0DAA0D;YAC1D,sCAAsC;YACtC,EAAE;YACF,MAAM,EAAE8C,SAAS,EAAE5B,KAAK,EAAE6B,SAAS,EAAE,GAAG5D,gBAAgB,KAAK,KAAK,MAAM,qBAAqB;;YAC7F,iDAAiD;YACjD,MAAMuB,gBAAgB,MAAMF,iBAAiB;gBAC3CC,IAAIkC,WAAWlC,EAAE;gBACjBR,mBAAmB8C;gBACnB7C,0BAA0B4C;YAC5B;YACA,IAAI,CAACpC,eAAe;gBAClBlB,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;oBAAEF,OAAO;oBAAiBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GACxD6B,WACA;gBAGJ,OAAOC,SAAS1C,IAAI,CAClB;oBAAEoC,OAAO;oBAAiBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GACxD;oBAAEN,QAAQ;gBAAI;YAElB;YAEA,MAAMyB,cAAc,MAAMZ,gBAAgB;gBACxCjB;gBACAkB,YAAYnB;gBACZoB,UAAU;gBACVC,SAASvB,KAAKuB,OAAO,IAAI,CAAC,yCAAyC,CAAC;gBACpEC,SAASxB,KAAKwB,OAAO,IAAI;gBACzBC;YACF;YACA,IAAI,CAACO,aAAa;gBAChBjC,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;oBAAEF,OAAO;oBAAwBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GAC/D6B,WACA;gBAGJ,OAAOC,SAAS1C,IAAI,CAClB;oBAAEoC,OAAO;oBAAwBG,KAAK,IAAIC,OAAO5B,WAAW;gBAAG,GAC/D;oBAAEN,QAAQ;gBAAI;YAElB;YACA,OAAOoC,SAAS1C,IAAI,CAAC;gBAAE+B;gBAAaQ,KAAK,IAAIC,OAAO5B,WAAW;YAAG;QACpE;QAEA,EAAE;QACF,2DAA2D;QAC3D,EAAE;QACF,IAAId,IAAIqD,IAAI,IAAIF,cAAcA,WAAW3C,MAAM,IAAI,WAAW;YAC5D,EAAE;YACF,8CAA8C;YAC9C,oCAAoC;YACpC,wDAAwD;YACxD,2FAA2F;YAC3F,EAAE;YACF,MAAM,EAAE+C,SAAS,EAAE,GAAG5D,kBAAkB,qBAAqB;;YAC7D,gCAAgC;YAChC,MAAMuB,gBAAiB,MAAMF,iBAAiB;gBAC5CC,IAAIkC,WAAWlC,EAAE;gBACjBZ,QAAQyC;gBACRvC,UAAUgD;gBACV/C,QAAQ;gBACRC,mBAAmB;gBACnBC,0BAA0B;YAC5B;YAEA,gDAAgD;YAChD,OAAOkC,SAAS1C,IAAI,CAAC;gBACnBE,OAAOc,cAAcd,KAAK;gBAC1BqC,KAAK,IAAIC,OAAO5B,WAAW;gBAC3BT,QAAQa,cAAcb,MAAM;YAC9B;QACF;QACA,EAAE;QACF,gBAAgB;QAChB,EAAE;QACFL,IAAIW,OAAO,CAACyB,MAAM,CAACE,KAAK,CACtBC,KAAKC,SAAS,CACZ;YAAEF,OAAO;YAAiBG,KAAK,IAAIC,OAAO5B,WAAW;QAAG,GACxD6B,WACA;QAGJ,OAAOC,SAAS1C,IAAI,CAClB;YAAEoC,OAAO;YAAiBG,KAAK,IAAIC,OAAO5B,WAAW;QAAG,GACxD;YAAEN,QAAQ;QAAI;IAElB;IAEA;;GAEC,GACD,MAAMiD,oBAA8B;QAClCC,SAAS3D;QACT4D,QAAQ;QACRC,MAAM;IACR;IAEA,OAAOH;AACT;AAEA,eAAe5D,wBAAuB"}

package/dist/endpoints/subscriberAuth.d.ts

@@ -0,0 +1,22 @@
+import type { Subscriber } from '../copied/payload-types.js';
+import type { CollectionSlug, Endpoint, Permissions } from 'payload';
+export type SubscriberAuthResponse = {
+    error: string;
+    now: string;
+} | {
+    now: string;
+    permissions: Permissions;
+    subscriber: null | Subscriber;
+};
+/**
+ * createEndpointLogout
+ * @param options
+ * @returns
+ *
+ * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug
+ *
+ */
+declare function createEndpointSubscriberAuth({ subscribersCollectionSlug, }: {
+    subscribersCollectionSlug: CollectionSlug;
+}): Endpoint;
+export default createEndpointSubscriberAuth;

package/dist/endpoints/subscriberAuth.js

@@ -0,0 +1,69 @@
+import { headers as nextHeaders } from 'next/headers.js';
+import { defaultCollectionSlug } from '../collections/Subscribers.js';
+/**
+ * createEndpointLogout
+ * @param options
+ * @returns
+ *
+ * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug
+ *
+ */ function createEndpointSubscriberAuth({ subscribersCollectionSlug = defaultCollectionSlug }) {
+    /**
+   * subscriberAuth Endpoint Handler
+   * @param req
+   * @returns { status: 200, json: {message: string, now: date} }
+   * @returns { status: 400, json: {error: ('No subscriber authed' | catchError | 'Unknown error'), now: date} }
+   */ const subscriberAuthHandler = async (req)=>{
+        // req.payload.logger.info('subscriberAuthHandler')
+        // Log the user in via Payload headers
+        const headers = await nextHeaders();
+        try {
+            const { permissions, user } = await req.payload.auth({
+                headers
+            });
+            // req.payload.logger.info(`user = ${JSON.stringify(user)}`)
+            // req.payload.logger.info(`permissions = ${JSON.stringify(permissions)}`)
+            if (user && user.collection == subscribersCollectionSlug) {
+                const subscriber = user;
+                if (subscriber.optIns) {
+                    subscriber.optIns = subscriber.optIns.map((channel)=>typeof channel == 'string' ? channel : channel.id);
+                }
+                return Response.json({
+                    now: new Date().toISOString(),
+                    permissions,
+                    subscriber
+                });
+            }
+            // req.payload.logger.info('subscriberAuthHandler: No subscriber authed')
+            return Response.json({
+                // error: 'No subscriber authed',
+                now: new Date().toISOString(),
+                permissions,
+                subscriber: null
+            }, {
+                headers,
+                status: 200
+            });
+        } catch (error) {
+            // req.payload.logger.info(`subscriberAuth error: ${JSON.stringify(error)}`)
+            return Response.json({
+                error,
+                now: new Date().toISOString()
+            }, {
+                headers,
+                status: 400
+            });
+        }
+    };
+    /**
+   * subscriberAuth Endpoint Config
+   */ const subscriberAuthEndpoint = {
+        handler: subscriberAuthHandler,
+        method: 'post',
+        path: '/subscriberAuth'
+    };
+    return subscriberAuthEndpoint;
+}
+export default createEndpointSubscriberAuth;
+
+//# sourceMappingURL=subscriberAuth.js.map

package/dist/endpoints/subscriberAuth.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/endpoints/subscriberAuth.ts"],"sourcesContent":["import { headers as nextHeaders } from 'next/headers.js'\n\nimport type { Subscriber } from '../copied/payload-types.js'\n\n// If you're using Next.js, you'll have to import headers from next/headers, like so:\nimport type { CollectionSlug, Endpoint, PayloadHandler, Permissions } from 'payload'\n\nimport { defaultCollectionSlug } from '../collections/Subscribers.js'\n\nexport type SubscriberAuthResponse =\n  | {\n      error: string\n      now: string\n    }\n  | {\n      now: string\n      permissions: Permissions\n      subscriber: null | Subscriber\n    }\n\n/**\n * createEndpointLogout\n * @param options\n * @returns\n *\n * Factory to generate the endpoint config with handler based on input option for subscribersCollectionSlug\n *\n */\nfunction createEndpointSubscriberAuth({\n  subscribersCollectionSlug = defaultCollectionSlug,\n}: {\n  subscribersCollectionSlug: CollectionSlug\n}): Endpoint {\n  /**\n   * subscriberAuth Endpoint Handler\n   * @param req\n   * @returns { status: 200, json: {message: string, now: date} }\n   * @returns { status: 400, json: {error: ('No subscriber authed' | catchError | 'Unknown error'), now: date} }\n   */\n  const subscriberAuthHandler: PayloadHandler = async (req) => {\n    // req.payload.logger.info('subscriberAuthHandler')\n    // Log the user in via Payload headers\n    const headers = await nextHeaders()\n\n    try {\n      const { permissions, user } = await req.payload.auth({\n        headers,\n      })\n\n      // req.payload.logger.info(`user = ${JSON.stringify(user)}`)\n      // req.payload.logger.info(`permissions = ${JSON.stringify(permissions)}`)\n\n      if (user && user.collection == subscribersCollectionSlug) {\n        const subscriber: Subscriber = user as Subscriber\n        if (subscriber.optIns) {\n          subscriber.optIns = subscriber.optIns.map((channel) =>\n            typeof channel == 'string' ? channel : channel.id,\n          )\n        }\n        return Response.json({\n          now: new Date().toISOString(),\n          permissions,\n          subscriber,\n        } as SubscriberAuthResponse)\n      }\n\n      // req.payload.logger.info('subscriberAuthHandler: No subscriber authed')\n      return Response.json(\n        {\n          // error: 'No subscriber authed',\n          now: new Date().toISOString(),\n          permissions,\n          subscriber: null,\n        } as SubscriberAuthResponse,\n        { headers, status: 200 },\n      )\n    } catch (error: unknown) {\n      // req.payload.logger.info(`subscriberAuth error: ${JSON.stringify(error)}`)\n      return Response.json(\n        {\n          error,\n          now: new Date().toISOString(),\n        } as SubscriberAuthResponse,\n        { headers, status: 400 },\n      )\n    }\n  }\n\n  /**\n   * subscriberAuth Endpoint Config\n   */\n  const subscriberAuthEndpoint: Endpoint = {\n    handler: subscriberAuthHandler,\n    method: 'post',\n    path: '/subscriberAuth',\n  }\n  return subscriberAuthEndpoint\n}\n\nexport default createEndpointSubscriberAuth\n"],"names":["headers","nextHeaders","defaultCollectionSlug","createEndpointSubscriberAuth","subscribersCollectionSlug","subscriberAuthHandler","req","permissions","user","payload","auth","collection","subscriber","optIns","map","channel","id","Response","json","now","Date","toISOString","status","error","subscriberAuthEndpoint","handler","method","path"],"mappings":"AAAA,SAASA,WAAWC,WAAW,QAAQ,kBAAiB;AAOxD,SAASC,qBAAqB,QAAQ,gCAA+B;AAarE;;;;;;;CAOC,GACD,SAASC,6BAA6B,EACpCC,4BAA4BF,qBAAqB,EAGlD;IACC;;;;;GAKC,GACD,MAAMG,wBAAwC,OAAOC;QACnD,mDAAmD;QACnD,sCAAsC;QACtC,MAAMN,UAAU,MAAMC;QAEtB,IAAI;YACF,MAAM,EAAEM,WAAW,EAAEC,IAAI,EAAE,GAAG,MAAMF,IAAIG,OAAO,CAACC,IAAI,CAAC;gBACnDV;YACF;YAEA,4DAA4D;YAC5D,0EAA0E;YAE1E,IAAIQ,QAAQA,KAAKG,UAAU,IAAIP,2BAA2B;gBACxD,MAAMQ,aAAyBJ;gBAC/B,IAAII,WAAWC,MAAM,EAAE;oBACrBD,WAAWC,MAAM,GAAGD,WAAWC,MAAM,CAACC,GAAG,CAAC,CAACC,UACzC,OAAOA,WAAW,WAAWA,UAAUA,QAAQC,EAAE;gBAErD;gBACA,OAAOC,SAASC,IAAI,CAAC;oBACnBC,KAAK,IAAIC,OAAOC,WAAW;oBAC3Bd;oBACAK;gBACF;YACF;YAEA,yEAAyE;YACzE,OAAOK,SAASC,IAAI,CAClB;gBACE,iCAAiC;gBACjCC,KAAK,IAAIC,OAAOC,WAAW;gBAC3Bd;gBACAK,YAAY;YACd,GACA;gBAAEZ;gBAASsB,QAAQ;YAAI;QAE3B,EAAE,OAAOC,OAAgB;YACvB,4EAA4E;YAC5E,OAAON,SAASC,IAAI,CAClB;gBACEK;gBACAJ,KAAK,IAAIC,OAAOC,WAAW;YAC7B,GACA;gBAAErB;gBAASsB,QAAQ;YAAI;QAE3B;IACF;IAEA;;GAEC,GACD,MAAME,yBAAmC;QACvCC,SAASpB;QACTqB,QAAQ;QACRC,MAAM;IACR;IACA,OAAOH;AACT;AAEA,eAAerB,6BAA4B"}