resend 0.1.2 → 0.8.0

package/build/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "resend",
+    "version": "0.8.0",
+    "description": "",
+    "main": "build/src/index.js",
+    "typings": "build/src/index.d.ts",
+    "files": [
+        "build/"
+    ],
+    "scripts": {
+        "build": "tsc -p .",
+        "lint": "tslint -p tsconfig.json -c tslint.json",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
+        "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
+        "prepublishOnly": "yarn run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/resend-inc/resend-node.git"
+    },
+    "author": "",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/resend-inc/resend-node/issues"
+    },
+    "homepage": "https://github.com/resend-inc/resend-node#readme",
+    "dependencies": {
+        "@react-email/render": "^0.0.1",
+        "axios": "0.27.2"
+    },
+    "devDependencies": {
+        "@types/jest": "28.1.7",
+        "@types/node": "18.6.4",
+        "@types/react": "18.0.17",
+        "axios-mock-adapter": "1.21.2",
+        "jest": "28.1.3",
+        "prettier": "2.7.1",
+        "supertest": "6.2.4",
+        "ts-jest": "28.0.8",
+        "tslint": "6.1.3",
+        "typescript": "4.7.4"
+    }
+}

package/build/src/index.d.ts

@@ -0,0 +1,2 @@
+import { Resend } from './resend';
+export { Resend };

package/build/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resend = void 0;
+const resend_1 = require("./resend");
+Object.defineProperty(exports, "Resend", { enumerable: true, get: function () { return resend_1.Resend; } });

package/build/src/interfaces.d.ts

@@ -0,0 +1,19 @@
+import { ReactElement } from 'react';
+export interface SendEmailData {
+    /** Sender email address. */
+    from: string;
+    /** Recipient email address. Max 50. */
+    to: string | string[];
+    /** Bcc recipient email address. Max 50. */
+    bcc?: string | string[];
+    /** Cc recipient email address. Max 50. */
+    cc?: string | string[];
+    /** Email subject. */
+    subject?: string;
+    /** The HTML version of the message. */
+    text?: string;
+    /** The plain text version of the message. */
+    html?: string;
+    /** The React version of the message. */
+    react?: ReactElement;
+}

package/build/src/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/resend.d.ts

@@ -0,0 +1,9 @@
+import { SendEmailData } from './interfaces';
+export declare class Resend {
+    readonly apiKey?: string | undefined;
+    readonly baseUrl: string;
+    private readonly headers;
+    private readonly request;
+    constructor(apiKey?: string | undefined);
+    sendEmail(data: SendEmailData): Promise<object>;
+}

package/build/src/resend.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resend = void 0;
+const axios_1 = __importDefault(require("axios"));
+const render_1 = require("@react-email/render");
+const package_json_1 = require("../package.json");
+class Resend {
+    constructor(apiKey) {
+        this.apiKey = apiKey;
+        if (!apiKey) {
+            this.apiKey = process.env.RESEND_API_KEY;
+            if (!this.apiKey) {
+                throw new Error('Missing API key. Pass it to the constructor `new Resend("re_123")`');
+            }
+        }
+        this.apiKey = apiKey;
+        this.baseUrl = process.env.RESEND_BASE_URL || 'https://api.resend.com';
+        this.headers = {
+            Authorization: `Bearer ${this.apiKey}`,
+            'User-Agent': `node:${package_json_1.version}`,
+            'Content-Type': 'application/json',
+        };
+        this.request = axios_1.default.create({
+            baseURL: this.baseUrl,
+            headers: this.headers,
+        });
+    }
+    sendEmail(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const path = `${this.baseUrl}/email`;
+                if (data.react) {
+                    data.html = (0, render_1.render)(data.react);
+                    delete data.react;
+                }
+                const response = yield this.request(path, { method: 'POST', data });
+                return response.data;
+            }
+            catch (error) {
+                throw error;
+            }
+        });
+    }
+}
+exports.Resend = Resend;

package/build/src/resend.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/resend.spec.js

@@ -0,0 +1,89 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const resend_1 = require("./resend");
+const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
+const axios_1 = __importDefault(require("axios"));
+const mock = new axios_mock_adapter_1.default(axios_1.default);
+const resend = new resend_1.Resend('re_924b3rjh2387fbewf823');
+describe('Resend', () => {
+    afterEach(() => mock.resetHistory());
+    it('throws API key error', () => {
+        expect(() => new resend_1.Resend()).toThrowErrorMatchingSnapshot();
+    });
+    it('sends email', () => __awaiter(void 0, void 0, void 0, function* () {
+        const payload = {
+            from: 'bu@resend.com',
+            to: 'zeno@resend.com',
+            subject: 'Hello World',
+        };
+        mock.onPost('https://api.resend.com/email', payload).replyOnce(200, {
+            id: '1234',
+            from: 'bu@resend.com',
+            to: 'zeno@resend.com',
+            created_at: '123',
+        });
+        const data = yield resend.sendEmail(payload);
+        expect(data).toMatchSnapshot();
+    }));
+    it('sends email with multiple recipients', () => __awaiter(void 0, void 0, void 0, function* () {
+        const payload = {
+            from: 'admin@resend.com',
+            to: ['bu@resend.com', 'zeno@resend.com'],
+            subject: 'Hello World',
+        };
+        mock.onPost('https://api.resend.com/email', payload).replyOnce(200, {
+            id: '1234',
+            from: 'admin@resend.com',
+            to: ['bu@resend.com', 'zeno@resend.com'],
+            created_at: '123',
+        });
+        const data = yield resend.sendEmail(payload);
+        expect(data).toMatchSnapshot();
+    }));
+    it('sends email with multiple bcc recipients', () => __awaiter(void 0, void 0, void 0, function* () {
+        const payload = {
+            from: 'admin@resend.com',
+            to: 'bu@resend.com',
+            bcc: ['foo@resend.com', 'bar@resend.com'],
+            subject: 'Hello World',
+        };
+        mock.onPost('https://api.resend.com/email', payload).replyOnce(200, {
+            id: '1234',
+            from: 'admin@resend.com',
+            to: 'bu@resend.com',
+            bcc: ['foo@resend.com', 'bar@resend.com'],
+            created_at: '123',
+        });
+        const data = yield resend.sendEmail(payload);
+        expect(data).toMatchSnapshot();
+    }));
+    it('sends email with multiple cc recipients', () => __awaiter(void 0, void 0, void 0, function* () {
+        const payload = {
+            from: 'admin@resend.com',
+            to: 'bu@resend.com',
+            cc: ['foo@resend.com', 'bar@resend.com'],
+            subject: 'Hello World',
+        };
+        mock.onPost('https://api.resend.com/email', payload).replyOnce(200, {
+            id: '1234',
+            from: 'admin@resend.com',
+            to: 'bu@resend.com',
+            cc: ['foo@resend.com', 'bar@resend.com'],
+            created_at: '123',
+        });
+        const data = yield resend.sendEmail(payload);
+        expect(data).toMatchSnapshot();
+    }));
+});

package/package.json

@@ -1,11 +1,45 @@
 {
   "name": "resend",
-  "version": "0.1.2",
+  "version": "0.8.0",
   "description": "",
-  "main": "index.js",
+  "main": "build/src/index.js",
+  "typings": "build/src/index.d.ts",
+  "files": [
+    "build/"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc -p .",
+    "lint": "tslint -p tsconfig.json -c tslint.json",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
+    "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
+    "prepublishOnly": "yarn run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/resend-inc/resend-node.git"
   },
   "author": "",
-  "license": "ISC"
-}
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/resend-inc/resend-node/issues"
+  },
+  "homepage": "https://github.com/resend-inc/resend-node#readme",
+  "dependencies": {
+    "@react-email/render": "^0.0.1",
+    "axios": "0.27.2"
+  },
+  "devDependencies": {
+    "@types/jest": "28.1.7",
+    "@types/node": "18.6.4",
+    "@types/react": "18.0.17",
+    "axios-mock-adapter": "1.21.2",
+    "jest": "28.1.3",
+    "prettier": "2.7.1",
+    "supertest": "6.2.4",
+    "ts-jest": "28.0.8",
+    "tslint": "6.1.3",
+    "typescript": "4.7.4"
+  }
+}

package/readme.md

@@ -0,0 +1,82 @@
+# Resend Node.js SDK
+
+Node.js library for the Resend API.
+
+## Install
+
+```bash
+npm install resend
+# or
+yarn add resend
+```
+
+## Setup
+
+First, you need to get an API key, which is available in the [Resend Dashboard](https://resend.com).
+
+```js
+import { Resend } from 'resend';
+const resend = new Resend('re_123');
+```
+
+## Usage
+
+Send your first email:
+
+```js
+await resend.sendEmail({
+  from: 'you@example.com',
+  to: 'user@gmail.com',
+  subject: 'hello world',
+  text: 'it works!',
+});
+```
+
+## Send email using HTML
+
+Send an email custom HTML content:
+
+```js
+await resend.sendEmail({
+  from: 'you@example.com',
+  to: 'user@gmail.com',
+  subject: 'hello world',
+  html: '<strong>it works!</strong>',
+});
+```
+
+## Send email using React
+
+Start by creating your email template as a React component.
+
+```jsx
+import React from 'react'
+
+export default function EmailTemplate(props) {
+  const { firstName, product } = props
+
+  return (
+    <div>
+      <h1>Welcome, {firstName}!</h1>
+      <p>Thanks for trying {product}. We’re thrilled to have you on board.</p>
+    </div>
+  )
+}
+```
+
+Then import the template component and pass it to the `react` property.
+
+```jsx
+import EmailTemplate from '../components/EmailTemplate'
+
+await resend.sendEmail({
+  from: 'you@example.com',
+  to: 'user@gmail.com',
+  subject: 'hello world',
+  react: <EmailTemplate firstName="John" product="MyApp" />,
+});
+```
+
+## License
+
+MIT License