feat: allow creating domain with capabilities through the api (#682)

Author: lucasfcosta

src/common/interfaces/domain-api-options.interface.ts

@@ -2,4 +2,5 @@ export interface DomainApiOptions {
   name: string;
   region?: string;
   custom_return_path?: string;
+  capability?: 'send' | 'receive' | 'send-and-receive';
 }

src/common/utils/parse-domain-to-api-options.ts

@@ -7,6 +7,7 @@ export function parseDomainToApiOptions(
   return {
     name: domain.name,
     region: domain.region,
+    capability: domain.capability,
     custom_return_path: domain.customReturnPath,
   };
 }

src/domains/domains.spec.ts

@@ -25,6 +25,7 @@ describe('Domains', () => {
       const response: CreateDomainResponseSuccess = {
         id: '3d4a472d-bc6d-4dd2-aa9d-d3d50ce87222',
         name: 'resend.com',
+        capability: 'send-and-receive',
         created_at: '2023-04-07T22:48:33.420498+00:00',
         status: 'not_started',
         records: [
@@ -69,6 +70,15 @@ describe('Domains', () => {
             status: 'not_started',
             ttl: 'Auto',
           },
+          {
+            record: 'Receiving',
+            name: 'resend.com',
+            value: 'inbound-mx.resend.com',
+            type: 'MX',
+            ttl: 'Auto',
+            status: 'not_started',
+            priority: 10,
+          },
         ],
         region: 'us-east-1',
       };
@@ -87,6 +97,7 @@ describe('Domains', () => {
       ).resolves.toMatchInlineSnapshot(`
 {
   "data": {
+    "capability": "send-and-receive",
     "created_at": "2023-04-07T22:48:33.420498+00:00",
     "id": "3d4a472d-bc6d-4dd2-aa9d-d3d50ce87222",
     "name": "resend.com",
@@ -132,6 +143,15 @@ describe('Domains', () => {
         "type": "CNAME",
         "value": "eeaemodxoao5hxwjvhywx4bo5mswjw6v.dkim.com.",
       },
+      {
+        "name": "resend.com",
+        "priority": 10,
+        "record": "Receiving",
+        "status": "not_started",
+        "ttl": "Auto",
+        "type": "MX",
+        "value": "inbound-mx.resend.com",
+      },
     ],
     "region": "us-east-1",
     "status": "not_started",
@@ -179,6 +199,7 @@ describe('Domains', () => {
         const response: CreateDomainResponseSuccess = {
           id: '3d4a472d-bc6d-4dd2-aa9d-d3d50ce87222',
           name: 'resend.com',
+          capability: 'send',
           created_at: '2023-04-07T22:48:33.420498+00:00',
           status: 'not_started',
           records: [
@@ -238,6 +259,7 @@ describe('Domains', () => {
         ).resolves.toMatchInlineSnapshot(`
 {
   "data": {
+    "capability": "send",
     "created_at": "2023-04-07T22:48:33.420498+00:00",
     "id": "3d4a472d-bc6d-4dd2-aa9d-d3d50ce87222",
     "name": "resend.com",
@@ -330,6 +352,7 @@ describe('Domains', () => {
         const response: CreateDomainResponseSuccess = {
           id: '3d4a472d-bc6d-4dd2-aa9d-d3d50ce87222',
           name: 'resend.com',
+          capability: 'send',
           created_at: '2023-04-07T22:48:33.420498+00:00',
           status: 'not_started',
           records: [
@@ -381,6 +404,7 @@ describe('Domains', () => {
         ).resolves.toMatchInlineSnapshot(`
 {
   "data": {
+    "capability": "send",
     "created_at": "2023-04-07T22:48:33.420498+00:00",
     "id": "3d4a472d-bc6d-4dd2-aa9d-d3d50ce87222",
     "name": "resend.com",
@@ -432,13 +456,15 @@ describe('Domains', () => {
           status: 'not_started',
           created_at: '2023-04-07T23:13:52.669661+00:00',
           region: 'eu-west-1',
+          capability: 'send',
         },
         {
           id: 'ac7503ac-e027-4aea-94b3-b0acd46f65f9',
           name: 'react.email',
           status: 'not_started',
           created_at: '2023-04-07T23:13:20.417116+00:00',
           region: 'us-east-1',
+          capability: 'receive',
         },
       ],
     };
@@ -576,6 +602,7 @@ describe('Domains', () => {
         object: 'domain',
         id: 'fd61172c-cafc-40f5-b049-b45947779a29',
         name: 'resend.com',
+        capability: 'send-and-receive',
         status: 'not_started',
         created_at: '2023-06-21T06:10:36.144Z',
         region: 'us-east-1',
@@ -606,6 +633,15 @@ describe('Domains', () => {
             status: 'verified',
             ttl: 'Auto',
           },
+          {
+            record: 'Receiving',
+            name: 'resend.com',
+            value: 'inbound-mx.resend.com',
+            type: 'MX',
+            ttl: 'Auto',
+            status: 'not_started',
+            priority: 10,
+          },
         ],
       };
 
@@ -622,6 +658,7 @@ describe('Domains', () => {
       await expect(resend.domains.get('1234')).resolves.toMatchInlineSnapshot(`
 {
   "data": {
+    "capability": "send-and-receive",
     "created_at": "2023-06-21T06:10:36.144Z",
     "id": "fd61172c-cafc-40f5-b049-b45947779a29",
     "name": "resend.com",
@@ -652,6 +689,15 @@ describe('Domains', () => {
         "type": "TXT",
         "value": "p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDZDhdsAKs5xdSj7h3v22wjx3WMWWADCHwxfef8U03JUbVM/sNSVuY5mbrdJKUoG6QBdfxsOGzhINmQnT89idjp5GdAUhx/KNpt8hcLXMID4nB0Gbcafn03/z5zEPxPfzVJqQd/UqOtZQcfxN9OrIhLiBsYTbcTBB7EvjCb3wEaBwIDAQAB",
       },
+      {
+        "name": "resend.com",
+        "priority": 10,
+        "record": "Receiving",
+        "status": "not_started",
+        "ttl": "Auto",
+        "type": "MX",
+        "value": "inbound-mx.resend.com",
+      },
     ],
     "region": "us-east-1",
     "status": "not_started",

src/domains/interfaces/create-domain-options.interface.ts

@@ -6,12 +6,16 @@ export interface CreateDomainOptions {
   name: string;
   region?: DomainRegion;
   customReturnPath?: string;
+  capability?: 'send' | 'receive' | 'send-and-receive';
 }
 
 export interface CreateDomainRequestOptions extends PostOptions {}
 
 export interface CreateDomainResponseSuccess
-  extends Pick<Domain, 'name' | 'id' | 'status' | 'created_at' | 'region'> {
+  extends Pick<
+    Domain,
+    'name' | 'id' | 'status' | 'created_at' | 'region' | 'capability'
+  > {
   records: DomainRecords[];
 }
 

src/domains/interfaces/domain.ts

@@ -21,7 +21,10 @@ export type DomainStatus =
   | 'temporary_failure'
   | 'not_started';
 
-export type DomainRecords = DomainSpfRecord | DomainDkimRecord;
+export type DomainRecords =
+  | DomainSpfRecord
+  | DomainDkimRecord
+  | ReceivingRecord;
 
 export interface DomainSpfRecord {
   record: 'SPF';
@@ -47,10 +50,21 @@ export interface DomainDkimRecord {
   proxy_status?: 'enable' | 'disable';
 }
 
+export interface ReceivingRecord {
+  record: 'Receiving';
+  name: string;
+  value: string;
+  type: 'MX';
+  ttl: string;
+  status: DomainStatus;
+  priority: number;
+}
+
 export interface Domain {
   id: string;
   name: string;
   status: DomainStatus;
   created_at: string;
   region: DomainRegion;
+  capability: 'send' | 'receive' | 'send-and-receive';
 }

src/domains/interfaces/get-domain.interface.ts

@@ -2,7 +2,10 @@ import type { ErrorResponse } from '../../interfaces';
 import type { Domain, DomainRecords } from './domain';
 
 export interface GetDomainResponseSuccess
-  extends Pick<Domain, 'id' | 'name' | 'created_at' | 'region' | 'status'> {
+  extends Pick<
+    Domain,
+    'id' | 'name' | 'created_at' | 'region' | 'status' | 'capability'
+  > {
   object: 'domain';
   records: DomainRecords[];
 }