feat/patch: add Preprocessed API Testsuite

ADD Implmentation for Preprocessing on Test
COVER all Preprocessed responses

TODO - documentation for v1.2.0

src/__test__/apiclient.test.ts

@@ -45,7 +45,7 @@ describe('ApiClient TestSuite', () => {
         'Content-Type': 'application/json; charset=utf-8'
       }
     }
-    const response = await client.request<testDataType>(apiRequest)
+    const response = await client.request<testDataType, object>(apiRequest)
     expect(response.isSuccess).toEqual(true)
     if (response.data) {
       const data: testDataType = response.data || undefined
@@ -74,7 +74,7 @@ describe('ApiClient TestSuite', () => {
         'Content-Type': 'application/json; charset=utf-8'
       }
     }
-    const response = await client.request<testDataType>(apiRequest)
+    const response = await client.request<testDataType, object>(apiRequest)
     expect(response.isSuccess).toEqual(false)
     expect(response.errorMessage).toEqual('Unexpected HTTP Status Code : 404')
   })
@@ -95,7 +95,7 @@ describe('ApiClient TestSuite', () => {
         'Content-Type': 'application/json; charset=utf-8'
       }
     }
-    const response = await client.request<testDataType>(apiRequest)
+    const response = await client.request<testDataType, object>(apiRequest)
     expect(response.isSuccess).toEqual(false)
     expect(response.errorMessage).toEqual('No response from the server')
   })
@@ -115,7 +115,7 @@ describe('ApiClient TestSuite', () => {
         'Content-Type': 'application/json; charset=utf-8'
       }
     }
-    const response = await client.request<testDataType>(apiRequest)
+    const response = await client.request<testDataType, object>(apiRequest)
     expect(response.isSuccess).toEqual(false)
     expect(response.errorMessage).toEqual('Error occured during setup request')
   })

src/__test__/mock/mock_apiClient.ts

@@ -1,5 +1,5 @@
 import axios, { AxiosResponse, Method } from 'axios'
-import { ApiClientResponse, PapagoDetectLanguageReturnType, PapagoKoreanNameRomanizerReturnType, PapagoTranslationReturnType } from '../../types/return_types'
+import { ApiClientResponse, PapagoDetectLanguageReturnType, PapagoKoreanNameRomanizerReturnType, PapagoTranslationReturnType, SearchMessageRequestReturnType, SearchMessageResultReturnType, SendSMSReturnType } from '../../types/return_types'
 import { ResponseTranslator, SupportedServices } from '../../types/service_translator'
 import { ServiceError } from '../../utils/errors'
 
@@ -21,7 +21,9 @@ export class MockApiClient {
     try {
       if (serviceError) throw serviceError
       const val = await this.createRequest<T>(apiRequest)
+      console.log(val)
       const preprocessed = this.preprocessingServerResponse(val, apiRequest) as P
+      console.log(val, preprocessed)
       return {
         isSuccess: true,
         data: val,
@@ -80,6 +82,14 @@ export class MockApiClient {
 
   private preprocessingServerResponse(val: object, apiRequest: ApiRequest) {
     switch(apiRequest.service) {
+      // SMS
+      case SupportedServices.SENS_SEND_SMS:
+        return ResponseTranslator.sensSendSMS(val as SendSMSReturnType)
+      case SupportedServices.SENS_SEARCH_MESSAGE_REQUEST:
+        return ResponseTranslator.sensSearchMessageRequest(val as SearchMessageRequestReturnType)
+      case SupportedServices.SENS_SEARCH_MESSAGE_RESULT:
+        return ResponseTranslator.sensSearchMessageResult(val as SearchMessageResultReturnType)
+      // PAPAGO
       case SupportedServices.PAPAGO_TRANSLATION:
         return ResponseTranslator.papagoTranslation(val as PapagoTranslationReturnType)
       case SupportedServices.PAPAGO_LANGUAGE_DETECTION:

src/__test__/mock/mock_smsClient.ts

@@ -1,7 +1,7 @@
 import { Method } from "axios"
 import { NCPAuthKeyType, SMSserviceAuthType } from "../../types/auth_types"
 import { SendSMSParamType } from "../../types/param_types"
-import { SENS_preprocessed_SendSMS } from "../../types/processing_types"
+import { SENS_preprocessed_SearchMessageRequest, SENS_preprocessed_SearchMessageResult, SENS_preprocessed_SendSMS } from "../../types/processing_types"
 import { ApiClientResponse, SearchMessageRequestReturnType, SearchMessageResultReturnType, SendSMSReturnType } from "../../types/return_types"
 import { SupportedServices } from "../../types/service_translator"
 import { generateApiSignature } from "../../utils/helper"
@@ -58,7 +58,7 @@ export class MockSMS {
     return this.client.request<SendSMSReturnType, SENS_preprocessed_SendSMS>(apiRequest)
   }
 
-  public async searchMessageRequest(requestId: string): Promise<ApiClientResponse<SearchMessageRequestReturnType>> {
+  public async searchMessageRequest(requestId: string): Promise<ApiClientResponse<SearchMessageRequestReturnType, SENS_preprocessed_SearchMessageRequest>> {
     // construct path and method
     const path = `/sms/v2/services/${this.smsAuth.serviceId}/messages?requestId=${requestId}`
     const method: Method = 'GET'
@@ -73,12 +73,14 @@ export class MockSMS {
     const apiRequest: ApiRequest = {
       path: path,
       method: method,
-      headers: headers
+      headers: headers,
+
+      service: SupportedServices.SENS_SEARCH_MESSAGE_REQUEST
     }
-    return this.client.request<SearchMessageRequestReturnType>(apiRequest)
+    return this.client.request<SearchMessageRequestReturnType, SENS_preprocessed_SearchMessageRequest>(apiRequest)
   }
 
-  public async searchMessageResult(messageId: string): Promise<ApiClientResponse<SearchMessageResultReturnType>> {
+  public async searchMessageResult(messageId: string): Promise<ApiClientResponse<SearchMessageResultReturnType, SENS_preprocessed_SearchMessageResult>> {
     // construct path and method
     const path = `/sms/v2/services/${this.smsAuth.serviceId}/messages/${messageId}`
     const method: Method = 'GET'
@@ -93,9 +95,11 @@ export class MockSMS {
     const apiRequest: ApiRequest = {
       path: path,
       method: method,
-      headers: headers
+      headers: headers,
+
+      service: SupportedServices.SENS_SEARCH_MESSAGE_RESULT
     }
-    return this.client.request<SearchMessageResultReturnType>(apiRequest)
+    return this.client.request<SearchMessageResultReturnType, SENS_preprocessed_SearchMessageResult>(apiRequest)
   }
 
 

src/__test__/papago/detect_language.test.ts

@@ -30,22 +30,32 @@ describe('PAPAGO.DetectLanguage TestSuite', () => {
 
     axios.mockImplementationOnce(() =>
       Promise.resolve({
-        langCode: 'ko'
+        status: 200,
+        statusText: 'OK',
+        data : {
+          langCode: 'ko'
+        }
       })
     )
     const text = '이게 된다고?'
 
     const response = await client.detectLanguage(text)
     expect(response.isSuccess).toEqual(true)
+    // check response data parsing
+    expect(response.data !== null).toEqual(true)
     if (response.data) {
       console.log('data detected')
       const data: PapagoDetectLanguageReturnType = response.data
       expect(data !== undefined).toEqual(true)
       expect(data.langCode === 'ko').toEqual(true)
     }
+    // check response preprocessed data
+    expect(response.preprocessed !== null).toEqual(true)
     if (response.preprocessed) {
       console.log('preprocessed complete')
-      const preprocessed = response.preprocessed
+      const preprocessed: PAPAGO_preprocessed_LanguageDetction = response.preprocessed
+      expect(typeof preprocessed.detected).toBe('string')
+      expect(preprocessed.detected).toBe('ko')
     }
 
   })

src/__test__/papago/korean_name_romanizer.test.ts

@@ -2,6 +2,7 @@ const axios = require('axios')
 import { MockPAPAGO } from '../mock/mock_papago'
 import { NaverOpenApiAuthType } from '../../types/auth_types'
 import { PapagoKoreanNameRomanizerReturnType } from '../../types/return_types'
+import { PAPAGO_preprocessed_KoreanNameRomanizer } from '../../types/processing_types'
 
 jest.mock('axios')
 
@@ -29,30 +30,36 @@ describe('PAPAGO.KoreanNameRomanizer TestSuite', () => {
 
     axios.mockImplementationOnce(() =>
       Promise.resolve({
-        aResult: [
-          {
-            sFirstName: '허',
-            aItems: [
-              { name: 'Heo Jae', score: '100' },
-              { name: 'Huh Jae', score: '60' },
-              { name: 'Hur Jae', score: '45' },
-              { name: 'Hu Jae', score: '26' },
-              { name: 'Heo Je', score: '10' },
-              { name: 'Heo Jea', score: '10' },
-              { name: 'Huh Je', score: '6' },
-              { name: 'Huh Jea', score: '6' },
-              { name: 'Hur Je', score: '4' },
-              { name: 'Hur Jea', score: '4' }
-            ]
-          }
-        ]
+        status: 200,
+        statusText: 'OK',
+        data : {
+          aResult: [
+            {
+              sFirstName: '허 ',
+              aItems: [
+                { name: 'Heo Jae', score: '100' },
+                { name: 'Huh Jae', score: '60' },
+                { name: 'Hur Jae', score: '45' },
+                { name: 'Hu Jae', score: '26' },
+                { name: 'Heo Je', score: '10' },
+                { name: 'Heo Jea', score: '10' },
+                { name: 'Huh Je', score: '6' },
+                { name: 'Huh Jea', score: '6' },
+                { name: 'Hur Je', score: '4' },
+                { name: 'Hur Jea', score: '4' }
+              ]
+            }
+          ]
+        }
       })
     )
 
     const name = "허재"
-
+      
     const response = await client.koreanNameRominizer(name)
     expect(response.isSuccess).toEqual(true)
+    // check response data parsing
+    expect(response.data !== null).toEqual(true)
     if (response.data) {
       console.log('data detected')
       const data: PapagoKoreanNameRomanizerReturnType = response.data || undefined
@@ -61,6 +68,15 @@ describe('PAPAGO.KoreanNameRomanizer TestSuite', () => {
       expect(data.aResult[0].sFirstName.length > 0).toEqual(true)
       expect(data.aResult[0].aItems.length > 0).toEqual(true)
     }
+    // check response preprocessed data
+    expect(response.preprocessed !== null).toEqual(true)
+    if (response.preprocessed) {
+      console.log('preprocessed complete')
+      const preprocessed: PAPAGO_preprocessed_KoreanNameRomanizer = response.preprocessed
+      expect(typeof preprocessed.firstName).toBe('string')
+      expect(preprocessed.firstName).toBe('허 ')
+      expect(preprocessed.bestMatched).not.toBeNull()
+    }
 
   })
 

src/__test__/papago/translation.test.ts

@@ -2,6 +2,7 @@ const axios = require('axios')
 import { MockPAPAGO } from '../mock/mock_papago'
 import { NaverOpenApiAuthType } from '../../types/auth_types'
 import { PapagoTranslationReturnType } from '../../types/return_types'
+import { PAPAGO_preprocessed_Translation } from '../../types/processing_types'
 
 jest.mock('axios')
 
@@ -29,20 +30,26 @@ describe('PAPAGO.Translation TestSuite', () => {
 
     axios.mockImplementationOnce(() =>
       Promise.resolve({
-        '@type': 'response',
-        '@service': 'naverservice.nmt.proxy',
-        '@version': '1.0.0',
-        result: {
-          srcLangType: 'ko',
-          tarLangType: 'en',
-          translatedText: 'Really?'
+        status: 200,
+        statusText: 'OK',
+        data : {
+          message: {
+            '@type': 'response',
+            '@service': 'naverservice.nmt.proxy',
+            '@version': '1.0.0',
+            result: {
+              srcLangType: 'ko',
+              tarLangType: 'en',
+              translatedText: 'Really?'
+            }
+          }
         }
       })
     )
 
     const source = 'ko'
     const target = 'en'
-    const text = '이게 진짜 된다고?'
+    const text = '정말로?'
 
     const response = await client.translation(source, target, text)
     expect(response.isSuccess).toEqual(true)
@@ -52,12 +59,24 @@ describe('PAPAGO.Translation TestSuite', () => {
       expect(data !== undefined).toEqual(true)
       expect(data.message !== undefined).toEqual(true)
       expect(data.message['@type'] === 'response').toEqual(true)
-      expect(data.message['@service']).toEqual(true)
+      expect(data.message['@service']).toBe('naverservice.nmt.proxy')
       expect(data.message.result.srcLangType === source).toEqual(true)
       expect(data.message.result.tarLangType === target).toEqual(true)
       expect((data.message.result.srcLangType !== data.message.result.tarLangType) && (data.message.result.translatedText !== text)).toEqual(true)
     }
 
+    expect(response.preprocessed).not.toBeNull()
+    if (response.preprocessed) {
+      console.log('preprocessd complete')
+      const preprocessed: PAPAGO_preprocessed_Translation = response.preprocessed
+      expect(typeof preprocessed.source).toBe('string')
+      expect(preprocessed.source).toBe('ko')
+      expect(typeof preprocessed.target).toBe('string')
+      expect(preprocessed.target).toBe('en')
+      expect(typeof preprocessed.translated).toBe('string')
+      expect(preprocessed.translated).toBe('Really?')
+    }
+
   })
 
   test('Invalid Request with empty source', async () => {

src/__test__/sms/search_sms_request.test.ts

@@ -2,6 +2,7 @@ const axios = require('axios')
 import { MockSMS } from '../mock/mock_smsClient';
 import { SearchMessageRequestReturnType } from '../../types/return_types';
 import { NCPAuthKeyType, SMSserviceAuthType } from '../../types/auth_types';
+import { SENS_preprocessed_SearchMessageRequest } from '../../types/processing_types';
 
 jest.mock('axios')
 
@@ -35,8 +36,9 @@ describe('SMS.SearchSmsRequest TestSuite', () => {
 
     axios.mockImplementationOnce(() =>
       Promise.resolve({
-        isSuccess: true,
-        data: {
+        status: 200,
+        statusText: 'OK',
+        data : {
           statusCode: '202',
           statusName: 'success',
           requestId: '3a4cb63856b04f93aa43805188d6f695',
@@ -64,6 +66,19 @@ describe('SMS.SearchSmsRequest TestSuite', () => {
       expect(data.messages[0].countryCode).toEqual('82')
       expect(data.messages[0].requestTime.match(/(\d{4})-(\d{2})-(\d{2})(\s)(\d{2}):(\d{2}):(\d{2})/) !== null).toEqual(true)
     }
+
+
+    expect(response.preprocessed).not.toBeNull()
+    if (response.preprocessed) {
+      console.log('preprocessd complete')
+      const preprocessed: SENS_preprocessed_SearchMessageRequest = response.preprocessed
+      expect(typeof preprocessed.requestId).toBe('string')
+      expect(preprocessed.requestId).toBe('3a4cb63856b04f93aa43805188d6f695')
+      expect(typeof preprocessed.result).toBe('string')
+      expect(preprocessed.result).toBe('success')
+      expect(preprocessed.messageIds.length).toBe(1)
+    }
+
   })
 
   test('Successful request for searchMessageRequest with multi Message', async () => {

src/__test__/sms/search_sms_result.test.ts

@@ -2,6 +2,7 @@ const axios = require('axios')
 import { MockSMS } from '../mock/mock_smsClient';
 import { SearchMessageResultReturnType } from '../../types/return_types';
 import { NCPAuthKeyType, SMSserviceAuthType } from '../../types/auth_types';
+import { SENS_preprocessed_SearchMessageResult } from '../../types/processing_types';
 
 jest.mock('axios')
 
@@ -35,8 +36,9 @@ describe('SMS.SearchSmsResult TestSuite', () => {
 
     axios.mockImplementationOnce(() =>
       Promise.resolve({
-        isSuccess: true,
-        data: {
+        status: 200,
+        statusText: 'OK',
+        data : {
           statusCode: '202',
           statusName: 'success',
           messages: [ {
@@ -71,6 +73,15 @@ describe('SMS.SearchSmsResult TestSuite', () => {
       expect(data.messages[0].requestTime.match(/(\d{4})-(\d{2})-(\d{2})(\s)(\d{2}):(\d{2}):(\d{2})/) !== null).toEqual(true)
       expect(data.messages[0].requestTime !== data.messages[0].completeTime).toEqual(true)
     }
+
+    expect(response.preprocessed).not.toBeNull()
+    if (response.preprocessed) {
+      console.log('preprocessd complete')
+      const preprocessed: SENS_preprocessed_SearchMessageResult = response.preprocessed
+      expect(typeof preprocessed.result).toBe('string')
+      expect(preprocessed.result).toBe('success')
+      expect(preprocessed.messages.length).toBe(1)
+    }
   })
 
   test('Invalid Response with http status Code 401', async () => {