actually add rateLimiting field to response

Author: gabrielmfern

src/contacts/contacts.ts

@@ -57,6 +57,7 @@ export class Contacts {
     if (!options.id && !options.email) {
       return {
         data: null,
+        rateLimiting: null,
         error: {
           message: 'Missing `id` or `email` field.',
           name: 'missing_required_field',
@@ -74,6 +75,7 @@ export class Contacts {
     if (!payload.id && !payload.email) {
       return {
         data: null,
+        rateLimiting: null,
         error: {
           message: 'Missing `id` or `email` field.',
           name: 'missing_required_field',
@@ -96,6 +98,7 @@ export class Contacts {
     if (!payload.id && !payload.email) {
       return {
         data: null,
+        rateLimiting: null,
         error: {
           message: 'Missing `id` or `email` field.',
           name: 'missing_required_field',

src/interfaces.ts

@@ -1,4 +1,4 @@
-import { RateLimit } from './rate-limiting';
+import type { RateLimit } from './rate-limiting';
 
 export const RESEND_ERROR_CODES_BY_KEY = {
   missing_required_field: 422,
@@ -26,17 +26,16 @@ export type ErrorResponse = {
   name: RESEND_ERROR_CODE_KEY;
 };
 
-export type Response<Data> = (
+export type Response<Data> =
   | {
       data: Data;
+      rateLimiting: RateLimit;
       error: null;
     }
   | {
       data: null;
+      rateLimiting: RateLimit | null;
       error: ErrorResponse;
-    }
-) & {
-  rateLimiting: RateLimit;
-};
+    };
 
 export type Tag = { name: string; value: string };

src/rate-limiting.ts

@@ -4,16 +4,15 @@ export type RateLimit = {
   shouldResetAfter: number;
 };
 
-export function parseRateLimit(headers: Headers): RateLimit | undefined {
+export function parseRateLimit(headers: Headers): RateLimit {
   const limitHeader = headers.get('ratelimit-limit');
   const remainingHeader = headers.get('ratelimit-remaining');
   const resetHeader = headers.get('ratelimit-reset');
 
   if (!limitHeader || !remainingHeader || !resetHeader) {
-    console.warn(
+    throw new Error(
       "The rate limit headers are not present in the response, something must've gone wrong, please email us at support@resend.com",
     );
-    return undefined;
   }
 
   const limit = Number.parseInt(limitHeader, 10);

src/resend.ts

@@ -9,7 +9,8 @@ import type { PatchOptions } from './common/interfaces/patch-option.interface';
 import { Contacts } from './contacts/contacts';
 import { Domains } from './domains/domains';
 import { Emails } from './emails/emails';
-import type { ErrorResponse } from './interfaces';
+import type { ErrorResponse, Response } from './interfaces';
+import { parseRateLimit } from './rate-limiting';
 
 const defaultBaseUrl = 'https://api.resend.com';
 const defaultUserAgent = `resend-node:${version}`;
@@ -53,21 +54,21 @@ export class Resend {
     });
   }
 
-  async fetchRequest<T>(
-    path: string,
-    options = {},
-  ): Promise<{ data: T; error: null } | { data: null; error: ErrorResponse }> {
+  async fetchRequest<T>(path: string, options = {}): Promise<Response<T>> {
     try {
       const response = await fetch(`${baseUrl}${path}`, options);
 
+      const rateLimiting = parseRateLimit(response.headers);
+
       if (!response.ok) {
         try {
           const rawError = await response.text();
-          return { data: null, error: JSON.parse(rawError) };
+          return { data: null, rateLimiting, error: JSON.parse(rawError) };
         } catch (err) {
           if (err instanceof SyntaxError) {
             return {
               data: null,
+              rateLimiting,
               error: {
                 name: 'application_error',
                 message:
@@ -82,18 +83,23 @@ export class Resend {
           };
 
           if (err instanceof Error) {
-            return { data: null, error: { ...error, message: err.message } };
+            return {
+              data: null,
+              rateLimiting: rateLimiting,
+              error: { ...error, message: err.message },
+            };
           }
 
-          return { data: null, error };
+          return { data: null, rateLimiting, error };
         }
       }
 
       const data = await response.json();
-      return { data, error: null };
+      return { data, rateLimiting, error: null };
     } catch (error) {
       return {
         data: null,
+        rateLimiting: null,
         error: {
           name: 'application_error',
           message: 'Unable to fetch data. The request could not be resolved.',