resend 0.18.0-canary.0 → 1.0.0

package/build/package.json

@@ -1,19 +1,22 @@
 {
     "name": "resend",
-    "version": "0.18.0-canary.0",
+    "version": "1.0.0",
     "description": "Node.js library for the Resend API",
     "main": "build/src/index.js",
     "typings": "build/src/index.d.ts",
     "files": [
         "build/"
     ],
+    "engines": {
+        "node": ">=16"
+    },
     "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",
+        "lint": "eslint --fix --ext .ts ./src",
+        "format:check": "prettier --check \"**/*.{ts,tsx}\"",
+        "format": "prettier --write .",
         "prepublishOnly": "yarn run build"
     },
     "repository": {
@@ -28,22 +31,24 @@
     "homepage": "https://github.com/resend-inc/resend-node#readme",
     "dependencies": {
         "@react-email/render": "0.0.7",
-        "node-fetch": "2.6.6",
+        "node-fetch": "2.6.12",
         "type-fest": "3.13.0"
     },
     "devDependencies": {
         "@types/jest": "29.5.3",
-        "@types/node": "18.16.2",
+        "@types/node": "18.17.5",
         "@types/node-fetch": "2.6.4",
-        "@types/react": "18.2.0",
+        "@types/react": "18.2.20",
+        "@typescript-eslint/eslint-plugin": "6.4.0",
+        "@typescript-eslint/parser": "6.4.0",
+        "eslint": "8.47.0",
         "fetch-mock": "9.11.0",
-        "jest": "29.6.1",
+        "jest": "29.6.2",
         "jest-fetch-mock": "3.0.3",
-        "prettier": "3.0.0",
+        "prettier": "3.0.2",
         "prettier-2": "npm:prettier@2",
         "supertest": "6.3.3",
         "ts-jest": "29.1.1",
-        "tslint": "6.1.3",
         "typescript": "5.1.6"
     }
 }

package/build/src/api-keys/api-keys.spec.js

@@ -115,7 +115,7 @@ describe('API Keys', () => {
                 yield expect(resend.apiKeys.create({
                     name: 'Test',
                     permission: 'wrong_access',
-                })).resolves.toThrowErrorMatchingInlineSnapshot(`"Access must be "full_access" | "sending_access""`);
+                })).resolves.toThrowErrorMatchingInlineSnapshot('"Access must be "full_access" | "sending_access""');
             }));
         });
         describe('restricted by domain', () => {
@@ -159,7 +159,7 @@ describe('API Keys', () => {
                     name: 'Test',
                     permission: 'sending_access',
                     domain_id: '1234',
-                })).resolves.toThrowErrorMatchingInlineSnapshot(`"Something went wrong"`);
+                })).resolves.toThrowErrorMatchingInlineSnapshot('"Something went wrong"');
             }));
         });
     });
@@ -214,7 +214,7 @@ describe('API Keys', () => {
                 },
             });
             const resend = new resend_1.Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
-            yield expect(resend.apiKeys.remove('5262504e-8ed7-4fac-bd16-0d4be94bc9f2')).resolves.toMatchInlineSnapshot(`undefined`);
+            yield expect(resend.apiKeys.remove('5262504e-8ed7-4fac-bd16-0d4be94bc9f2')).resolves.toMatchInlineSnapshot('undefined');
         }));
         it('throws error when missing id', () => __awaiter(void 0, void 0, void 0, function* () {
             fetchMock.mockOnce(JSON.stringify({
@@ -229,7 +229,7 @@ describe('API Keys', () => {
                 },
             });
             const resend = new resend_1.Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
-            yield expect(resend.apiKeys.remove('')).resolves.toMatchInlineSnapshot(`undefined`);
+            yield expect(resend.apiKeys.remove('')).resolves.toMatchInlineSnapshot('undefined');
         }));
         it('throws error when wrong id', () => __awaiter(void 0, void 0, void 0, function* () {
             fetchMock.mockOnce(JSON.stringify({
@@ -244,7 +244,7 @@ describe('API Keys', () => {
                 },
             });
             const resend = new resend_1.Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
-            yield expect(resend.apiKeys.remove('34bd250e-615a-400c-be11-5912572ee15b')).resolves.toMatchInlineSnapshot(`undefined`);
+            yield expect(resend.apiKeys.remove('34bd250e-615a-400c-be11-5912572ee15b')).resolves.toMatchInlineSnapshot('undefined');
         }));
     });
 });

package/build/src/domains/domains.spec.js

@@ -28,7 +28,7 @@ describe('Domains', () => {
                         type: 'MX',
                         ttl: 'Auto',
                         status: 'not_started',
-                        value: `feedback-smtp.us-east-1.com`,
+                        value: 'feedback-smtp.us-east-1.com',
                         priority: 10,
                     },
                     {
@@ -163,7 +163,7 @@ describe('Domains', () => {
                             type: 'MX',
                             ttl: 'Auto',
                             status: 'not_started',
-                            value: `feedback-smtp.eu-west-1.com`,
+                            value: 'feedback-smtp.eu-west-1.com',
                             priority: 10,
                         },
                         {
@@ -448,7 +448,7 @@ describe('Domains', () => {
                 },
             });
             const resend = new resend_1.Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
-            yield expect(resend.domains.verify('5262504e-8ed7-4fac-bd16-0d4be94bc9f2')).resolves.toMatchInlineSnapshot(`undefined`);
+            yield expect(resend.domains.verify('5262504e-8ed7-4fac-bd16-0d4be94bc9f2')).resolves.toMatchInlineSnapshot('undefined');
         }));
     });
     describe('remove', () => {
@@ -461,7 +461,7 @@ describe('Domains', () => {
                 },
             });
             const resend = new resend_1.Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
-            yield expect(resend.domains.remove('5262504e-8ed7-4fac-bd16-0d4be94bc9f2')).resolves.toMatchInlineSnapshot(`undefined`);
+            yield expect(resend.domains.remove('5262504e-8ed7-4fac-bd16-0d4be94bc9f2')).resolves.toMatchInlineSnapshot('undefined');
         }));
     });
 });

package/build/src/emails/emails.d.ts

@@ -1,6 +1,5 @@
 import { Resend } from '../resend';
-import { CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse } from './interfaces';
-import { GetEmailResponse } from './interfaces/get-email-options.interface';
+import { CreateEmailOptions, CreateEmailRequestOptions, CreateEmailResponse, GetEmailResponse } from './interfaces';
 export declare class Emails {
     private readonly resend;
     constructor(resend: Resend);

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

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

package/build/src/emails/emails.spec.js

@@ -0,0 +1,179 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const jest_fetch_mock_1 = require("jest-fetch-mock");
+const resend_1 = require("../resend");
+(0, jest_fetch_mock_1.enableFetchMocks)();
+const resend = new resend_1.Resend('re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop');
+describe('Emails', () => {
+    afterEach(() => fetchMock.resetMocks());
+    describe('create', () => {
+        it('sends email', () => __awaiter(void 0, void 0, void 0, function* () {
+            const payload = {
+                from: 'bu@resend.com',
+                to: 'zeno@resend.com',
+                subject: 'Hello World',
+                html: '<h1>Hello world</h1>',
+            };
+            fetchMock.mockOnce(JSON.stringify({
+                id: '1234',
+            }), {
+                status: 200,
+                headers: {
+                    'content-type': 'application/json',
+                    Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+                },
+            });
+            const data = yield resend.emails.create(payload);
+            expect(data).toMatchInlineSnapshot(`
+        {
+          "id": "1234",
+        }
+      `);
+        }));
+    });
+    describe('send', () => {
+        it('sends email', () => __awaiter(void 0, void 0, void 0, function* () {
+            const payload = {
+                from: 'bu@resend.com',
+                to: 'zeno@resend.com',
+                subject: 'Hello World',
+                html: '<h1>Hello world</h1>',
+            };
+            fetchMock.mockOnce(JSON.stringify({
+                id: '1234',
+            }), {
+                status: 200,
+                headers: {
+                    'content-type': 'application/json',
+                    Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+                },
+            });
+            const data = yield resend.emails.send(payload);
+            expect(data).toMatchInlineSnapshot(`
+        {
+          "id": "1234",
+        }
+      `);
+        }));
+    });
+    describe('get', () => {
+        describe('when email not found', () => {
+            it('returns error', () => __awaiter(void 0, void 0, void 0, function* () {
+                fetchMock.mockOnce(JSON.stringify({
+                    name: 'not_found',
+                    message: 'Email not found',
+                    statusCode: 404,
+                }), {
+                    status: 404,
+                    headers: {
+                        'content-type': 'application/json',
+                        Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+                    },
+                });
+                yield expect(resend.emails.get('1234')).resolves.toMatchInlineSnapshot(`
+          {
+            "message": "Email not found",
+            "name": "not_found",
+            "statusCode": 404,
+          }
+        `);
+            }));
+        });
+        describe('when email found', () => {
+            it('returns emails with only to', () => __awaiter(void 0, void 0, void 0, function* () {
+                const response = {
+                    object: 'email',
+                    id: '123',
+                    to: ['zeno@resend.com'],
+                    from: 'bu@resend.com',
+                    created_at: '321',
+                    subject: 'Test email',
+                    html: '<p>hello hello</p>',
+                    text: null,
+                    bcc: null,
+                    cc: null,
+                    reply_to: null,
+                    last_event: 'sent',
+                };
+                fetchMock.mockOnce(JSON.stringify(response), {
+                    status: 200,
+                    headers: {
+                        'content-type': 'application/json',
+                        Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+                    },
+                });
+                yield expect(resend.emails.get('1234')).resolves.toMatchInlineSnapshot(`
+          {
+            "bcc": null,
+            "cc": null,
+            "created_at": "321",
+            "from": "bu@resend.com",
+            "html": "<p>hello hello</p>",
+            "id": "123",
+            "last_event": "sent",
+            "object": "email",
+            "reply_to": null,
+            "subject": "Test email",
+            "text": null,
+            "to": [
+              "zeno@resend.com",
+            ],
+          }
+        `);
+            }));
+            it('returns emails with to and multiple cc', () => __awaiter(void 0, void 0, void 0, function* () {
+                const response = {
+                    object: 'email',
+                    id: '123',
+                    to: ['zeno@resend.com'],
+                    from: 'bu@resend.com',
+                    created_at: '321',
+                    subject: 'Test email',
+                    html: '<p>hello hello</p>',
+                    text: null,
+                    bcc: null,
+                    cc: ['zeno@resend.com', 'bu@resend.com'],
+                    reply_to: null,
+                    last_event: 'sent',
+                };
+                fetchMock.mockOnce(JSON.stringify(response), {
+                    status: 200,
+                    headers: {
+                        'content-type': 'application/json',
+                        Authorization: 'Bearer re_zKa4RCko_Lhm9ost2YjNCctnPjbLw8Nop',
+                    },
+                });
+                yield expect(resend.emails.get('1234')).resolves.toMatchInlineSnapshot(`
+          {
+            "bcc": null,
+            "cc": [
+              "zeno@resend.com",
+              "bu@resend.com",
+            ],
+            "created_at": "321",
+            "from": "bu@resend.com",
+            "html": "<p>hello hello</p>",
+            "id": "123",
+            "last_event": "sent",
+            "object": "email",
+            "reply_to": null,
+            "subject": "Test email",
+            "text": null,
+            "to": [
+              "zeno@resend.com",
+            ],
+          }
+        `);
+            }));
+        });
+    });
+});

package/build/src/emails/interfaces/create-email-options.interface.d.ts

@@ -3,32 +3,102 @@ import * as React from 'react';
 import { PostOptions } from '../../common/interfaces';
 import { RequireAtLeastOne } from 'type-fest';
 interface CreateEmailBaseOptions {
+    /**
+     * Filename and content of attachments (max 40mb per email)
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     attachments?: Attachment[];
+    /**
+     * Blind carbon copy recipient email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     bcc?: string | string[];
+    /**
+     * Carbon copy recipient email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     cc?: string | string[];
+    /**
+     * Sender email address. To include a friendly name, use the format `"Your Name <sender@domain.com>"`
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     from: string;
+    /**
+     * Custom headers to add to the email.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     headers?: Record<string, string>;
+    /**
+     * The React component used to write the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     react?: React.ReactElement | React.ReactNode | null;
+    /**
+     * The HTML version of the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     html?: string;
+    /**
+     * The plain text version of the message.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     text?: string;
+    /**
+     * Reply-to email address. For multiple addresses, send as an array of strings.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     reply_to?: string | string[];
+    /**
+     * Email subject.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     subject: string;
+    /**
+     * Email tags
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     tags?: Tag[];
+    /**
+     * Recipient email address. For multiple addresses, send as an array of strings. Max 50.
+     *
+     * @link https://resend.com/api-reference/emails/send-email#body-parameters
+     */
     to: string | string[];
 }
 export type CreateEmailOptions = RequireAtLeastOne<CreateEmailBaseOptions, 'react' | 'html' | 'text'>;
 export interface CreateEmailRequestOptions extends PostOptions {
 }
 export interface CreateEmailResponse {
+    /** The ID of the newly created email. */
     id: string;
 }
 interface Attachment {
+    /** Content of an attached file. */
     content?: string | Buffer;
+    /** Name of attached file. */
     filename?: string | false | undefined;
+    /** Path where the attachment file is hosted */
     path?: string;
 }
 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 {};

package/build/src/emails/interfaces/get-email-options.interface.d.ts

@@ -1,11 +1,14 @@
 export interface GetEmailResponse {
-    bcc?: string[];
-    cc?: string[];
+    bcc: string[] | null;
+    cc: string[] | null;
+    created_at: string;
     from: string;
-    html?: string;
+    html: string | null;
     id: string;
+    last_event: string;
+    reply_to: string[] | null;
     subject: string;
-    text?: string;
+    text: string | null;
     to: string[];
     object: 'email';
 }

package/build/src/emails/interfaces/index.d.ts

@@ -1 +1,2 @@
 export * from './create-email-options.interface';
+export * from './get-email-options.interface';

package/build/src/emails/interfaces/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./create-email-options.interface"), exports);
+__exportStar(require("./get-email-options.interface"), exports);

package/build/src/resend.js

@@ -69,7 +69,7 @@ class Resend {
             return yield response.json();
         });
     }
-    post(path, entity, options) {
+    post(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = Object.assign({ method: 'POST', headers: this.headers, body: JSON.stringify(entity) }, options);
             return yield this.fetchRequest(path, requestOptions);

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "resend",
-  "version": "0.18.0-canary.0",
+  "version": "1.0.0",
   "description": "Node.js library for the Resend API",
   "main": "build/src/index.js",
   "typings": "build/src/index.d.ts",
   "files": [
     "build/"
   ],
+  "engines": {
+    "node": ">=16"
+  },
   "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",
+    "lint": "eslint --fix --ext .ts ./src",
+    "format:check": "prettier --check \"**/*.{ts,tsx}\"",
+    "format": "prettier --write .",
     "prepublishOnly": "yarn run build"
   },
   "repository": {
@@ -28,22 +31,24 @@
   "homepage": "https://github.com/resend-inc/resend-node#readme",
   "dependencies": {
     "@react-email/render": "0.0.7",
-    "node-fetch": "2.6.6",
+    "node-fetch": "2.6.12",
     "type-fest": "3.13.0"
   },
   "devDependencies": {
     "@types/jest": "29.5.3",
-    "@types/node": "18.16.2",
+    "@types/node": "18.17.5",
     "@types/node-fetch": "2.6.4",
-    "@types/react": "18.2.0",
+    "@types/react": "18.2.20",
+    "@typescript-eslint/eslint-plugin": "6.4.0",
+    "@typescript-eslint/parser": "6.4.0",
+    "eslint": "8.47.0",
     "fetch-mock": "9.11.0",
-    "jest": "29.6.1",
+    "jest": "29.6.2",
     "jest-fetch-mock": "3.0.3",
-    "prettier": "3.0.0",
+    "prettier": "3.0.2",
     "prettier-2": "npm:prettier@2",
     "supertest": "6.3.3",
     "ts-jest": "29.1.1",
-    "tslint": "6.1.3",
     "typescript": "5.1.6"
   }
 }

package/readme.md

@@ -14,10 +14,10 @@ yarn add resend
 
 Send email with:
 
-* [Node.js](https://github.com/resendlabs/resend-node-example)
-* [Next.js (App Router)](https://github.com/resendlabs/resend-nextjs-app-router-example)
-* [Next.js (Pages Router)](https://github.com/resendlabs/resend-nextjs-pages-router-example)
-* [Express](https://github.com/resendlabs/resend-express-example)
+- [Node.js](https://github.com/resendlabs/resend-node-example)
+- [Next.js (App Router)](https://github.com/resendlabs/resend-nextjs-app-router-example)
+- [Next.js (Pages Router)](https://github.com/resendlabs/resend-nextjs-pages-router-example)
+- [Express](https://github.com/resendlabs/resend-express-example)
 
 ## Setup
 
@@ -59,24 +59,24 @@ await resend.emails.send({
 Start by creating your email template as a React component.
 
 ```jsx
-import React from 'react'
+import React from 'react';
 
 export default function EmailTemplate(props) {
-  const { firstName, product } = 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'
+import EmailTemplate from '../components/EmailTemplate';
 
 await resend.emails.send({
   from: 'you@example.com',