Throw ErrorResponse instead of returning

Author: Kewin Polok

src/errors/MessageResponseError/index.ts

@@ -0,0 +1,25 @@
+export function isMessageErrorResponseData(
+  response: any
+): response is MessageErrorResponse {
+  return response.error !== undefined && response.message !== undefined;
+}
+
+export interface MessageErrorResponse {
+  error: number;
+  message: string;
+}
+
+class MessageError extends Error {
+  public data: MessageErrorResponse;
+
+  constructor(data: MessageErrorResponse) {
+    super();
+
+    Error.captureStackTrace(this, this.constructor);
+
+    this.name = 'MessageError';
+    this.data = data;
+  }
+}
+
+export { MessageError };

src/modules/baseMessageModule/index.ts

@@ -7,8 +7,12 @@ import snakeCase from 'lodash/snakeCase';
 
 import { BaseModule } from '../baseModule';
 import { SmsDetails } from '../sms/types/SmsDetails';
-import { ErrorResponse, isErrorResponse } from '../../types/ErrorResponse';
 import { MessageResponse } from '../../types/MessageResponse';
+import {
+  MessageError,
+  MessageErrorResponse,
+  isMessageErrorResponseData,
+} from '../../errors/MessageResponseError';
 
 import {
   MessageContent,
@@ -40,7 +44,7 @@ export class BaseMessageModule extends BaseModule {
     content: MessageContent,
     recipient: Recipient,
     details?: SmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     const body: Record<string, unknown> = {
       details: true,
       encoding: 'utf-8',
@@ -81,22 +85,29 @@ export class BaseMessageModule extends BaseModule {
     if (this.isVmsLocalFile(content)) {
       const formData = this.getFormDataForVmsLocalFile(body, content);
 
-      const data = await this.httpClient.post<MessageResponse, MessageResponse>(
-        this.endpoint,
-        formData.getBuffer(),
-        {
-          headers: formData.getHeaders(),
-        }
-      );
+      const data = await this.httpClient.post<
+        MessageResponse | MessageErrorResponse,
+        MessageResponse | MessageErrorResponse
+      >(this.endpoint, formData.getBuffer(), {
+        headers: formData.getHeaders(),
+      });
+
+      if (isMessageErrorResponseData(data)) {
+        throw new MessageError(data);
+      }
 
       return this.formatResponse(data);
     }
 
     const data = await this.httpClient.post<
-      MessageResponse | ErrorResponse,
-      MessageResponse | ErrorResponse
+      MessageResponse | MessageErrorResponse,
+      MessageResponse | MessageErrorResponse
     >(this.endpoint, body);
 
+    if (isMessageErrorResponseData(data)) {
+      throw new MessageError(data);
+    }
+
     return this.formatResponse(data);
   }
 
@@ -193,13 +204,7 @@ export class BaseMessageModule extends BaseModule {
     });
   }
 
-  protected formatResponse(
-    response: MessageResponse | ErrorResponse
-  ): MessageResponse | ErrorResponse {
-    if (isErrorResponse(response)) {
-      return response;
-    }
-
+  protected formatResponse(response: MessageResponse): MessageResponse {
     return {
       ...response,
       list: response.list.map((sms) => ({

src/modules/vms/index.ts

@@ -1,6 +1,5 @@
 import { BaseMessageModule } from '../baseMessageModule';
 import { MessageResponse } from '../../types/MessageResponse';
-import { ErrorResponse } from '../../types/ErrorResponse';
 
 import { VmsTtsLector } from './types/VmsTtsLector';
 import { VmsDetails } from './types/VmsDetails';
@@ -13,7 +12,7 @@ export class Vms extends BaseMessageModule {
     tts: string,
     ttsLector?: VmsTtsLector,
     details?: VmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     return await this.send(
       {
         tts,
@@ -30,7 +29,7 @@ export class Vms extends BaseMessageModule {
     numbers: string | string[],
     pathToLocaleFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     return await this.send(
       {
         localPath: pathToLocaleFile,
@@ -46,7 +45,7 @@ export class Vms extends BaseMessageModule {
     numbers: string | string[],
     pathToRemoteFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     return await this.send(
       {
         remotePath: pathToRemoteFile,
@@ -63,7 +62,7 @@ export class Vms extends BaseMessageModule {
     tts: string,
     ttsLector?: VmsTtsLector,
     details?: VmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     return await this.send(
       {
         tts,
@@ -80,7 +79,7 @@ export class Vms extends BaseMessageModule {
     groups: string | string[],
     pathToLocaleFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     return await this.send(
       {
         localPath: pathToLocaleFile,
@@ -96,7 +95,7 @@ export class Vms extends BaseMessageModule {
     groups: string | string[],
     pathToRemoteFile: string,
     details?: VmsDetails
-  ): Promise<MessageResponse | ErrorResponse> {
+  ): Promise<MessageResponse> {
     return await this.send(
       {
         remotePath: pathToRemoteFile,

src/types/ErrorResponse.ts

@@ -15,18 +15,18 @@ import { SubuserCredentials } from '../modules/subusers/types/SubuserCredentials
 import { SubuserPoints } from '../modules/subusers/types/SubuserPoints';
 import { Template } from '../modules/templates/types/Template';
 import { UpdateSubuser } from '../modules/subusers/types/UpdateSubuser';
+import { MessageErrorResponse } from '../errors/MessageResponseError';
 
-import { ErrorResponse } from './ErrorResponse';
 import { MessageStatus } from './MessageStatus';
 import { MessageResponse } from './MessageResponse';
 import { ApiCollection } from './ApiCollection';
 
 export {
   ApiCollection,
-  ErrorResponse,
   HlrCheck,
   HlrCheckError,
   HlrCheckResponse,
+  MessageErrorResponse,
   MessageResponse,
   MessageStatus,
   MmsDetails,