@payloadcms/email-resend 3.0.0-alpha.66

package/LICENSE.md

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

package/README.md

@@ -0,0 +1,30 @@
+# Resend REST Email Adapter
+
+This adapter allows you to send emails using the [Resend](https://resend.com) REST API.
+
+## Installation
+
+```sh
+pnpm add @payloadcms/email-resend`
+```
+
+## Usage
+
+- Sign up for a [Resend](https://resend.com) account
+- Set up a domain
+- Create an API key
+- Set API key as RESEND_API_KEY environment variable
+- Configure your Payload config
+
+```ts
+// payload.config.js
+import { resendAdapter } from '@payloadcms/email-resend'
+
+export default buildConfig({
+  email: resendAdapter({
+    defaultFromAddress: 'dev@payloadcms.com',
+    defaultFromName: 'Payload CMS',
+    apiKey: process.env.RESEND_API_KEY || '',
+  }),
+})
+```

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import type { EmailAdapter } from 'payload/config';
+export type ResendAdapterArgs = {
+    apiKey: string;
+    defaultFromAddress: string;
+    defaultFromName: string;
+};
+type ResendAdapter = EmailAdapter<ResendResponse>;
+type ResendError = {
+    message: string;
+    name: string;
+    statusCode: number;
+};
+type ResendResponse = {
+    id: string;
+} | ResendError;
+/**
+ * Email adapter for [Resend](https://resend.com) REST API
+ */
+export declare const resendAdapter: (args: ResendAdapterArgs) => ResendAdapter;
+export type Tag = {
+    /**
+     * The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
+     */
+    name: string;
+    /**
+     * The value of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.
+     */
+    value: string;
+};
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAKlD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,KAAK,aAAa,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AAEjD,KAAK,WAAW,GAAG;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,KAAK,cAAc,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,WAAW,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,aAAa,SAAU,iBAAiB,KAAG,aAyCvD,CAAA;AAqKD,MAAM,MAAM,GAAG,GAAG;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,CAAA"}

package/dist/index.js

@@ -0,0 +1,98 @@
+import { APIError } from 'payload/errors';
+/**
+ * Email adapter for [Resend](https://resend.com) REST API
+ */ export const resendAdapter = (args)=>{
+    const { apiKey, defaultFromAddress, defaultFromName } = args;
+    const adapter = ()=>({
+            name: 'resend-rest',
+            defaultFromAddress,
+            defaultFromName,
+            sendEmail: async (message)=>{
+                // Map the Payload email options to Resend email options
+                const sendEmailOptions = mapPayloadEmailToResendEmail(message, defaultFromAddress, defaultFromName);
+                const res = await fetch('https://api.resend.com/emails', {
+                    body: JSON.stringify(sendEmailOptions),
+                    headers: {
+                        Authorization: `Bearer ${apiKey}`,
+                        'Content-Type': 'application/json'
+                    },
+                    method: 'POST'
+                });
+                const data = await res.json();
+                if ('id' in data) {
+                    return data;
+                } else {
+                    const statusCode = data.statusCode || res.status;
+                    let formattedError = `Error sending email: ${statusCode}`;
+                    if (data.name && data.message) {
+                        formattedError += ` ${data.name} - ${data.message}`;
+                    }
+                    throw new APIError(formattedError, statusCode);
+                }
+            }
+        });
+    return adapter;
+};
+function mapPayloadEmailToResendEmail(message, defaultFromAddress, defaultFromName) {
+    return {
+        // Required
+        from: mapFromAddress(message.from, defaultFromName, defaultFromAddress),
+        subject: message.subject ?? '',
+        to: mapAddresses(message.to),
+        // Other To fields
+        bcc: mapAddresses(message.bcc),
+        cc: mapAddresses(message.cc),
+        // Optional
+        attachments: mapAttachments(message.attachments),
+        html: message.html?.toString() || '',
+        text: message.text?.toString() || ''
+    };
+}
+function mapFromAddress(address, defaultFromName, defaultFromAddress) {
+    if (!address) {
+        return `${defaultFromName} <${defaultFromAddress}>`;
+    }
+    if (typeof address === 'string') {
+        return address;
+    }
+    return `${address.name} <${address.address}>`;
+}
+function mapAddresses(addresses) {
+    if (!addresses) {
+        return '';
+    }
+    if (typeof addresses === 'string') {
+        return addresses;
+    }
+    if (Array.isArray(addresses)) {
+        return addresses.map((address)=>typeof address === 'string' ? address : address.address);
+    }
+    return [
+        addresses.address
+    ];
+}
+function mapAttachments(attachments) {
+    if (!attachments) {
+        return [];
+    }
+    return attachments.map((attachment)=>{
+        if (!attachment.filename || !attachment.content) {
+            throw new APIError('Attachment is missing filename or content', 400);
+        }
+        if (typeof attachment.content === 'string') {
+            return {
+                content: Buffer.from(attachment.content),
+                filename: attachment.filename
+            };
+        }
+        if (attachment.content instanceof Buffer) {
+            return {
+                content: attachment.content,
+                filename: attachment.filename
+            };
+        }
+        throw new APIError('Attachment content must be a string or a buffer', 400);
+    });
+}
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { EmailAdapter } from 'payload/config'\nimport type { SendEmailOptions } from 'payload/types'\n\nimport { APIError } from 'payload/errors'\n\nexport type ResendAdapterArgs = {\n  apiKey: string\n  defaultFromAddress: string\n  defaultFromName: string\n}\n\ntype ResendAdapter = EmailAdapter<ResendResponse>\n\ntype ResendError = {\n  message: string\n  name: string\n  statusCode: number\n}\n\ntype ResendResponse = { id: string } | ResendError\n\n/**\n * Email adapter for [Resend](https://resend.com) REST API\n */\nexport const resendAdapter = (args: ResendAdapterArgs): ResendAdapter => {\n  const { apiKey, defaultFromAddress, defaultFromName } = args\n\n  const adapter: ResendAdapter = () => ({\n    name: 'resend-rest',\n    defaultFromAddress,\n    defaultFromName,\n    sendEmail: async (message) => {\n      // Map the Payload email options to Resend email options\n      const sendEmailOptions = mapPayloadEmailToResendEmail(\n        message,\n        defaultFromAddress,\n        defaultFromName,\n      )\n\n      const res = await fetch('https://api.resend.com/emails', {\n        body: JSON.stringify(sendEmailOptions),\n        headers: {\n          Authorization: `Bearer ${apiKey}`,\n          'Content-Type': 'application/json',\n        },\n        method: 'POST',\n      })\n\n      const data = (await res.json()) as ResendResponse\n\n      if ('id' in data) {\n        return data\n      } else {\n        const statusCode = data.statusCode || res.status\n        let formattedError = `Error sending email: ${statusCode}`\n        if (data.name && data.message) {\n          formattedError += ` ${data.name} - ${data.message}`\n        }\n\n        throw new APIError(formattedError, statusCode)\n      }\n    },\n  })\n\n  return adapter\n}\n\nfunction mapPayloadEmailToResendEmail(\n  message: SendEmailOptions,\n  defaultFromAddress: string,\n  defaultFromName: string,\n): ResendSendEmailOptions {\n  return {\n    // Required\n    from: mapFromAddress(message.from, defaultFromName, defaultFromAddress),\n    subject: message.subject ?? '',\n    to: mapAddresses(message.to),\n\n    // Other To fields\n    bcc: mapAddresses(message.bcc),\n    cc: mapAddresses(message.cc),\n\n    // Optional\n    attachments: mapAttachments(message.attachments),\n    html: message.html?.toString() || '',\n    text: message.text?.toString() || '',\n  } as ResendSendEmailOptions\n}\n\nfunction mapFromAddress(\n  address: SendEmailOptions['from'],\n  defaultFromName: string,\n  defaultFromAddress: string,\n): ResendSendEmailOptions['from'] {\n  if (!address) {\n    return `${defaultFromName} <${defaultFromAddress}>`\n  }\n\n  if (typeof address === 'string') {\n    return address\n  }\n\n  return `${address.name} <${address.address}>`\n}\n\nfunction mapAddresses(addresses: SendEmailOptions['to']): ResendSendEmailOptions['to'] {\n  if (!addresses) {\n    return ''\n  }\n\n  if (typeof addresses === 'string') {\n    return addresses\n  }\n\n  if (Array.isArray(addresses)) {\n    return addresses.map((address) => (typeof address === 'string' ? address : address.address))\n  }\n\n  return [addresses.address]\n}\n\nfunction mapAttachments(\n  attachments: SendEmailOptions['attachments'],\n): ResendSendEmailOptions['attachments'] {\n  if (!attachments) {\n    return []\n  }\n\n  return attachments.map((attachment) => {\n    if (!attachment.filename || !attachment.content) {\n      throw new APIError('Attachment is missing filename or content', 400)\n    }\n\n    if (typeof attachment.content === 'string') {\n      return {\n        content: Buffer.from(attachment.content),\n        filename: attachment.filename,\n      }\n    }\n\n    if (attachment.content instanceof Buffer) {\n      return {\n        content: attachment.content,\n        filename: attachment.filename,\n      }\n    }\n\n    throw new APIError('Attachment content must be a string or a buffer', 400)\n  })\n}\n\ntype ResendSendEmailOptions = {\n  /**\n   * Filename and content of attachments (max 40mb per email)\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  attachments?: Attachment[]\n  /**\n   * Blind carbon copy recipient email address. For multiple addresses, send as an array of strings.\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  bcc?: string | string[]\n\n  /**\n   * Carbon copy recipient email address. For multiple addresses, send as an array of strings.\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  cc?: string | string[]\n  /**\n   * Sender email address. To include a friendly name, use the format `\"Your Name <sender@domain.com>\"`\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  from: string\n  /**\n   * Custom headers to add to the email.\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  headers?: Record<string, string>\n  /**\n   * The HTML version of the message.\n   *\n   * @link https://resend.com/api-reference/emails/send-email#body-parameters\n   */\n  html?: string\n  /**\n   * Reply-to email address. For multiple addresses, send as an array of strings.\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  reply_to?: string | string[]\n  /**\n   * Email subject.\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  subject: string\n  /**\n   * Email tags\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  tags?: Tag[]\n  /**\n   * The plain text version of the message.\n   *\n   * @link https://resend.com/api-reference/emails/send-email#body-parameters\n   */\n  text?: string\n  /**\n   * Recipient email address. For multiple addresses, send as an array of strings. Max 50.\n   *\n   * @link https://resend.com/docs/api-reference/emails/send-email#body-parameters\n   */\n  to: string | string[]\n}\n\ntype Attachment = {\n  /** Content of an attached file. */\n  content?: Buffer | string\n  /** Name of attached file. */\n  filename?: false | string | undefined\n  /** Path where the attachment file is hosted */\n  path?: string\n}\n\nexport type Tag = {\n  /**\n   * The name of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.\n   */\n  name: string\n  /**\n   * The value of the email tag. It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). It can contain no more than 256 characters.\n   */\n  value: string\n}\n"],"names":["APIError","resendAdapter","args","apiKey","defaultFromAddress","defaultFromName","adapter","name","sendEmail","message","sendEmailOptions","mapPayloadEmailToResendEmail","res","fetch","body","JSON","stringify","headers","Authorization","method","data","json","statusCode","status","formattedError","from","mapFromAddress","subject","to","mapAddresses","bcc","cc","attachments","mapAttachments","html","toString","text","address","addresses","Array","isArray","map","attachment","filename","content","Buffer"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAGA,SAASA,QAAQ,QAAQ,iBAAgB;AAkBzC;;CAEC,GACD,OAAO,MAAMC,gBAAgB,CAACC;IAC5B,MAAM,EAAEC,MAAM,EAAEC,kBAAkB,EAAEC,eAAe,EAAE,GAAGH;IAExD,MAAMI,UAAyB,IAAO,CAAA;YACpCC,MAAM;YACNH;YACAC;YACAG,WAAW,OAAOC;gBAChB,wDAAwD;gBACxD,MAAMC,mBAAmBC,6BACvBF,SACAL,oBACAC;gBAGF,MAAMO,MAAM,MAAMC,MAAM,iCAAiC;oBACvDC,MAAMC,KAAKC,SAAS,CAACN;oBACrBO,SAAS;wBACPC,eAAe,CAAC,OAAO,EAAEf,OAAO,CAAC;wBACjC,gBAAgB;oBAClB;oBACAgB,QAAQ;gBACV;gBAEA,MAAMC,OAAQ,MAAMR,IAAIS,IAAI;gBAE5B,IAAI,QAAQD,MAAM;oBAChB,OAAOA;gBACT,OAAO;oBACL,MAAME,aAAaF,KAAKE,UAAU,IAAIV,IAAIW,MAAM;oBAChD,IAAIC,iBAAiB,CAAC,qBAAqB,EAAEF,WAAW,CAAC;oBACzD,IAAIF,KAAKb,IAAI,IAAIa,KAAKX,OAAO,EAAE;wBAC7Be,kBAAkB,CAAC,CAAC,EAAEJ,KAAKb,IAAI,CAAC,GAAG,EAAEa,KAAKX,OAAO,CAAC,CAAC;oBACrD;oBAEA,MAAM,IAAIT,SAASwB,gBAAgBF;gBACrC;YACF;QACF,CAAA;IAEA,OAAOhB;AACT,EAAC;AAED,SAASK,6BACPF,OAAyB,EACzBL,kBAA0B,EAC1BC,eAAuB;IAEvB,OAAO;QACL,WAAW;QACXoB,MAAMC,eAAejB,QAAQgB,IAAI,EAAEpB,iBAAiBD;QACpDuB,SAASlB,QAAQkB,OAAO,IAAI;QAC5BC,IAAIC,aAAapB,QAAQmB,EAAE;QAE3B,kBAAkB;QAClBE,KAAKD,aAAapB,QAAQqB,GAAG;QAC7BC,IAAIF,aAAapB,QAAQsB,EAAE;QAE3B,WAAW;QACXC,aAAaC,eAAexB,QAAQuB,WAAW;QAC/CE,MAAMzB,QAAQyB,IAAI,EAAEC,cAAc;QAClCC,MAAM3B,QAAQ2B,IAAI,EAAED,cAAc;IACpC;AACF;AAEA,SAAST,eACPW,OAAiC,EACjChC,eAAuB,EACvBD,kBAA0B;IAE1B,IAAI,CAACiC,SAAS;QACZ,OAAO,CAAC,EAAEhC,gBAAgB,EAAE,EAAED,mBAAmB,CAAC,CAAC;IACrD;IAEA,IAAI,OAAOiC,YAAY,UAAU;QAC/B,OAAOA;IACT;IAEA,OAAO,CAAC,EAAEA,QAAQ9B,IAAI,CAAC,EAAE,EAAE8B,QAAQA,OAAO,CAAC,CAAC,CAAC;AAC/C;AAEA,SAASR,aAAaS,SAAiC;IACrD,IAAI,CAACA,WAAW;QACd,OAAO;IACT;IAEA,IAAI,OAAOA,cAAc,UAAU;QACjC,OAAOA;IACT;IAEA,IAAIC,MAAMC,OAAO,CAACF,YAAY;QAC5B,OAAOA,UAAUG,GAAG,CAAC,CAACJ,UAAa,OAAOA,YAAY,WAAWA,UAAUA,QAAQA,OAAO;IAC5F;IAEA,OAAO;QAACC,UAAUD,OAAO;KAAC;AAC5B;AAEA,SAASJ,eACPD,WAA4C;IAE5C,IAAI,CAACA,aAAa;QAChB,OAAO,EAAE;IACX;IAEA,OAAOA,YAAYS,GAAG,CAAC,CAACC;QACtB,IAAI,CAACA,WAAWC,QAAQ,IAAI,CAACD,WAAWE,OAAO,EAAE;YAC/C,MAAM,IAAI5C,SAAS,6CAA6C;QAClE;QAEA,IAAI,OAAO0C,WAAWE,OAAO,KAAK,UAAU;YAC1C,OAAO;gBACLA,SAASC,OAAOpB,IAAI,CAACiB,WAAWE,OAAO;gBACvCD,UAAUD,WAAWC,QAAQ;YAC/B;QACF;QAEA,IAAID,WAAWE,OAAO,YAAYC,QAAQ;YACxC,OAAO;gBACLD,SAASF,WAAWE,OAAO;gBAC3BD,UAAUD,WAAWC,QAAQ;YAC/B;QACF;QAEA,MAAM,IAAI3C,SAAS,mDAAmD;IACxE;AACF"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@payloadcms/email-resend",
+  "version": "3.0.0-alpha.66",
+  "description": "Payload Resend Email Adapter",
+  "homepage": "https://payloadcms.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/payloadcms/payload.git",
+    "directory": "packages/email-resend"
+  },
+  "license": "MIT",
+  "author": "Payload CMS, Inc.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/jest": "29.5.12",
+    "jest": "^29.7.0",
+    "payload": "3.0.0-alpha.66"
+  },
+  "peerDependencies": {
+    "payload": "3.0.0-alpha.66"
+  },
+  "engines": {
+    "node": ">=18.20.2"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "pnpm build:swc && pnpm build:types",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc-build",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "clean": "rimraf {dist,*.tsbuildinfo}",
+    "test": "jest"
+  }
+}