test: Add test setup and test to send message

Author: peoray

__tests__/services/message.spec.ts

@@ -0,0 +1,35 @@
+import { Message } from '../../src/services'
+import { ISendMessage, ISendMessageResponse } from '../../src/types'
+
+const message = new Message(
+  'TLaURAdBvnUNS9sEbugcE2gyRdKd1rNPSVxAG3fQp9sfbtpVh6575KoTon2Fv9'
+)
+const mockMessage: ISendMessage = {
+  to: '+2348012345678',
+  sms: 'Hello World',
+  from: 'Acme',
+  type: 'plain',
+  channel: 'generic',
+}
+
+const responseData: ISendMessageResponse = {
+  code: '200',
+  message_id: '123456789',
+  message_id_str: '123456789',
+  message: 'Message sent successfully',
+  balance: 50.0, // Assuming this is a balance in some currency
+  user: 'JohnDoe', // The user who sent the message
+}
+
+describe('Message', () => {
+  it('should send a message', async () => {
+    try {
+      const response = await message.sendMessage(mockMessage)
+
+      expect(response).toHaveBeenCalledWith(mockMessage)
+      expect(response).toEqual(responseData)
+    } catch (error) {
+      expect(error).toBeInstanceOf(Error)
+    }
+  })
+})

jest.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: './',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '.(ts)': 'ts-jest',
+  },
+  collectCoverageFrom: ['**/*.(t|j)s'],
+  coverageDirectory: './coverage',
+  testEnvironment: 'node',
+  testTimeout: 120000,
+}

package.json

@@ -25,13 +25,17 @@
   "scripts": {
     "start": "tsdx watch",
     "build": "tsdx build",
-    "lint": "tsdx lint"
+    "lint": "tsdx lint",
+    "test": "jest --config jest.config.js --no-cache"
   },
   "keywords": [],
   "license": "ISC",
   "devDependencies": {
+    "@types/jest": "^29.5.3",
     "@types/node": "^20.4.8",
     "class-validator": "^0.14.0",
+    "jest": "^29.6.2",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "tsdx": "^0.14.1",
     "tslib": "^2.6.1",

pnpm-lock.yaml

@@ -1,5 +1,5 @@
 import axios, { AxiosInstance } from 'axios'
-import { IAxiosStruct, BaseError, BASE_URL, handleAxiosError } from './utils'
+import { IAxiosStruct, BaseError, BASE_URL, handleErrors } from './utils'
 
 export class TermiiCore {
   public request: AxiosInstance
@@ -40,7 +40,9 @@ export class TermiiCore {
         throw new BaseError({ message: 'Invalid HTTP method' })
       }
     } catch (error) {
-      throw new BaseError({ message: handleAxiosError(error) })
+      // console.log(error)
+      console.log('--0=======00000========3030303=-===')
+      throw new BaseError({ message: handleErrors(error) })
     }
   }
 }

src/api.ts

@@ -1,23 +1,43 @@
 import { TermiiCore } from '../../api'
-import { BaseError, IAxiosStruct, handleAxiosError } from '../../utils'
-import { SendMessageDto } from './message.dto'
+import { IAxiosStruct } from '../../utils'
+// import { AxiosError } from 'axios'
+// import { SendMessageDto } from './message.dto'
+import { ISendMessageResponse, ISendMessage } from '../../types/message'
+// import { ISendMessageResponse } from '../../types/message'
 
 export class Message extends TermiiCore {
   constructor(apiKey: string) {
     super(apiKey)
   }
-  public async sendMessage(data: SendMessageDto) {
-    try {
-      const requestObj: IAxiosStruct = {
-        method: 'POST',
-        url: `/sms/send`,
-        data,
-      }
+  public async sendMessage(data: ISendMessage): Promise<ISendMessageResponse> {
+    // public async sendMessage(data: SendMessageDto) {
+    // try {
+    const requestObj: IAxiosStruct = {
+      method: 'POST',
+      url: `/sms/send`,
+      data,
+    }
 
-      const response = await this.useRequest(requestObj)
-      return response.data
-    } catch (error) {
-      throw new BaseError({ message: handleAxiosError(error) })
+    const message: ISendMessage = {
+      to: '+2348138666495',
+      from: 'Acme',
+      // sms: 'Your SMS message here',
+      type: 'plain',
+      channel: 'whatsapp', // This should match one of the allowed values: 'dnd', 'generic', or 'whatsapp'
+      media: {
+        caption: 'image',
+        url: 'https://i.imgur.com/1kK2i3E.jpg',
+      },
     }
+
+    // console.log(requestObj)
+    console.log(message)
+
+    const response = await this.useRequest(requestObj)
+    return response?.data as ISendMessageResponse
+    // } catch (error) {
+    //   const { response } = error as AxiosError
+    //   throw response
+    // }
   }
 }

src/services/message/message.dto.ts

@@ -1,14 +1,12 @@
 import { Message } from './services'
 
 /**
- * The Fincra class is the main class that is used to access the other classes
- * @class Fincra
- * @param {string} publicKey - The public key of the merchant
- * @param {string} privateKey - The private key of the merchant
- * @param {IEnvironment} environment - The environment to use
- * @returns The Fincra class
+ * The Termii class is the main class that is used to access the other classes
+ * @class Termii
+ * @param {string} apiKey - The api key to authorize usage
+ * @returns The Termii class
  * @example
- * const fincra = new Fincra('pk_NjI3ZmVmYmU1YTY1ZWM5OWJhOWFmMGJlOjoxMjE2NzA=', 'hzjMvDeY0dmBrDPSxZH5exnmdNc0aUXy', {sandbox: true});
+ * const termii = new Termii('pk_NjI3ZmVmYmU1YTY1ZWM5OWJhOWFmMGJlOjoxMjE2NzA);
  **/
 export class Termii {
   constructor(public apiKey: string) {

src/services/message/message.ts

@@ -5,20 +5,78 @@ export interface Media {
   caption: string
 }
 
-export interface ISendMessage {
-  api_key: string
-  to: string | string[]
-  from: string
-  sms: string
-  type: string
-  channel: ChannelType
-  media?: Media
+// export interface ISendMessageWithSMS {
+//   to: string | string[]
+//   from: string
+//   type: string
+//   channel: 'dnd' | 'generic' | 'whatsapp'
+//   sms: string
+//   media?: never // Ensure media is not present when sms is used
+// }
+
+// export interface ISendMessageWithMedia {
+//   to: string | string[]
+//   from: string
+//   type: string
+//   channel: 'whatsapp'
+//   sms?: never // Ensure sms is not present when media is used
+//   media: Media
+// }
+
+// export type ISendMessage = ISendMessageWithSMS | ISendMessageWithMedia
+
+export interface Media {
+  url: string
+  caption: string
 }
+
+// Define a base message type with common properties.
+// export interface BaseMessage {
+//   to: string | string[]
+//   from: string
+//   type: string
+//   channel: 'dnd' | 'generic' | 'whatsapp'
+// }
+
+// Define a type for messages with only SMS.
+// export type SMSMessage = BaseMessage & {
+//   sms: string
+//   media?: never
+// }
+
+// Define a type for messages with media allowed only when channel is 'whatsapp'.
+// export type MediaMessage = BaseMessage & {
+//   sms?: never
+//   channel: 'whatsapp'
+//   media: Media
+// }
+
+// Create a union type for messages that can be either SMS or Media.
+// export type ISendMessage = SMSMessage | MediaMessage
+
+export type ISendMessage =
+  | {
+      to: string | string[]
+      from: string
+      type: string
+      channel: 'dnd' | 'generic' | 'whatsapp'
+      sms: string
+      media?: never
+    }
+  | {
+      to: string | string[]
+      from: string
+      type: string
+      channel: 'whatsapp'
+      sms?: never
+      media: Media
+    }
+
 export interface ISendMessageResponse {
   code: string
   message_id: string
   message_id_str: string
   message: string
-  balance: string
+  balance: number
   user: string
 }

src/termii.ts

@@ -10,11 +10,16 @@ export class BaseError extends Error {
    * @constructor BaseError
    */
   constructor(options: Record<any, any> = {}) {
-    const errorMessage = options.message || '' // Default to an empty string if options.message is not provided
-    super(errorMessage)
-    // Error.captureStackTrace(this, this.constructor)
+    // const errorMessage = options.message || '' // Default to an empty string if options.message is not provided
+    // super(errorMessage)
+    // // Error.captureStackTrace(this, this.constructor)
+    // this.name = this.constructor.name
+    // this.message = options.message
+    // this.stack = new Error().stack
+
+    super()
+    Error.captureStackTrace(this, this.constructor)
     this.name = this.constructor.name
     this.message = options.message
-    this.stack = new Error().stack
   }
 }

src/types/message/index.ts

@@ -1,8 +1,7 @@
-// import { AxiosRequestConfig } from 'axios'
+import { ISendMessage } from '../../types'
 
-// export interface IAxiosStruct extends AxiosRequestConfig {
 export interface IAxiosStruct {
   method: 'GET' | 'POST' | 'PUT' | 'DELETE'
   url: string
-  data?: any
+  data?: ISendMessage
 }