@ingestkorea/client-sens 1.4.3 → 1.5.3

package/.github/pull_request_template.md

@@ -1,14 +1,19 @@
 ### Issue
+
 Issue number, if available, prefixed with "#"
 
 ### Description
+
 What does this implement/fix? Explain your changes.
 
 ### Testing
+
 How was this change tested?
 
 ### Additional context
+
 Add any other context about the PR here.
 
 ---
-By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
+
+By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

package/.prettierignore

@@ -0,0 +1,3 @@
+node_modules/
+dist-*/
+package-lock.json

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 INGESTKOREA LLC.
+Copyright (c) 2024 INGESTKOREA LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,13 +1,16 @@
 # @ingestkorea/client-sens
 
 [![npm (scoped)](https://img.shields.io/npm/v/@ingestkorea/client-sens?style=flat-square)](https://www.npmjs.com/package/@ingestkorea/client-sens)
-[![NPM downloads](https://img.shields.io/npm/dm/@ingestkorea/client-sens?style=flat-square)](https://www.npmjs.com/package/@ingestkorea/client-sens)
-![Build Status](https://codebuild.ap-northeast-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiOTYrKzNDRklOaWJxS2ZoTkZvY05TU2VGVFdxWFlSWE9DZXJTYVBlbCtwc0J5YTcvdUFKRjlSc1RDTHNDV1J4YnhxMmRLaFdIakpSVWN3QzBHQXp0KzdRPSIsIml2UGFyYW1ldGVyU3BlYyI6IjQ1dUtTMlE1UWhmWmFTRGsiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main)
+[![npm downloads](https://img.shields.io/npm/dm/@ingestkorea/client-sens?style=flat-square)](https://www.npmjs.com/package/@ingestkorea/client-sens)
+![build status](https://codebuild.ap-northeast-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiOTYrKzNDRklOaWJxS2ZoTkZvY05TU2VGVFdxWFlSWE9DZXJTYVBlbCtwc0J5YTcvdUFKRjlSc1RDTHNDV1J4YnhxMmRLaFdIakpSVWN3QzBHQXp0KzdRPSIsIml2UGFyYW1ldGVyU3BlYyI6IjQ1dUtTMlE1UWhmWmFTRGsiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main)
+[![license](https://img.shields.io/github/license/ingestkorea/client-sens?style=flat-square)](https://www.npmjs.com/package/@ingestkorea/client-sens)
 
 ## Description
+
 INGESTKOREA SDK Naver Cloud Platform SENS Client for Node.js.
 
 ## Installing
+
 ```sh
 npm install @ingestkorea/client-sens
 ```
@@ -15,77 +18,89 @@ npm install @ingestkorea/client-sens
 ## Getting Started
 
 ### Pre-requisites
-+ Use TypeScript v4.x
-+ Includes the TypeScript definitions for node.
+
+- Use TypeScript v5.x
+- Includes the TypeScript definitions for node.
   ```sh
+  npm install -D typescript # save dev mode
   npm install -D @types/node # save dev mode
   ```
 
 ### Support Commands
 
 #### Kakao Alimtalk
-+ SendAlimtalk
-+ GetAlimtalkStatus (`GetRequestStatus` is deprecated)
-+ GetAlimtalkResult (`GetRequestResult` is deprecated)
-+ GetAlimtalkTemplate (`GetTemplate` is deprecated)
-+ ListAlimtalkTemplates (`ListTemplates` is deprecated)
-+ ListAlimtalkChannels (`ListChannels` is deprecated)
-
-#### SMS(LMS)
-+ SendSMS
-+ GetSMSStatus
-+ GetSMSResult
+
+- SendAlimtalk
+- GetAlimtalkStatus
+- GetAlimtalkResult
+- GetAlimtalkTemplate
+- ListAlimtalkTemplates
+- ListAlimtalkChannels
+
+#### SMS, LMS, MMS
+
+- SendSMS (SMS, LMS)
+- SendMMS (MMS)
+- GetSMSStatus (SMS, LMS, MMS)
+- GetSMSResult (SMS, LMS, MMS)
 
 ### Import
+
 ```ts
 import {
   SensClient,
-  SendAlimtalkCommand, SendAlimtalkCommandInput,
-  SendSMSCommand, SendSMSCommandInput,
-} from '@ingestkorea/client-sens';
+  SendAlimtalkCommand,
+  SendAlimtalkCommandInput,
+  SendSMSCommand,
+  SendSMSCommandInput,
+  SendMMSCommand,
+  SendMMSCommandInput,
+} from "@ingestkorea/client-sens";
 ```
 
 ### Usage
+
 To send a request, you:
-+ Initiate client with configuration.
-+ Initiate command with input parameters.
-+ Call `send` operation on client with command object as input.
+
+- Initiate client with configuration.
+- Initiate command with input parameters.
+- Call `send` operation on client with command object as input.
 
 ```ts
 // a client can be shared by different commands.
 const client = new SensClient({
   credentials: {
     accessKey: ACCESS_KEY,
-    secretKey: SECRET_KEY
+    secretKey: SECRET_KEY,
   },
   serviceId: {
-    sms: 'ncp:sms:kr:123456789xxx:your-service-name', // optional
-    kakao: 'ncp:kkobizmsg:kr:9876xxx:your-service-name' // optional
-  }
+    sms: "ncp:sms:kr:123456789xxx:your-service-name", // optional
+    kakao: "ncp:kkobizmsg:kr:9876xxx:your-service-name", // optional
+  },
 });
 
 /**
  * accessKey, secretKey: https://www.ncloud.com/mypage/manage/authkey
  * serviceId: https://console.ncloud.com/sens/project
- * 
+ *
  * at least one serviceId required
  * if you call send operation without serviceId, sdk throw error
  */
 ```
 
 #### SendAlimtalk
+
 ```ts
 let params: SendAlimtalkCommandInput = {
   plusFriendId: PLUS_FRIEND_ID,
   templateCode: TEMPLATE_CODE,
-  messages: [
-    { to: '01012345678', content: CONTENT }
-  ]
+  messages: [{ to: "01012345678", content: CONTENT }],
 };
 let command = new SendAlimtalkCommand(params);
 ```
 
-#### SendSMS
+#### SendSMS (SMS, LMS)
+
 ```ts
 /**
  * Automatically set message type('SMS' | 'LMS') according to content-length(euc-kr)
@@ -96,33 +111,68 @@ let params: SendSMSCommandInput = {
   from: '01012345678',
   content: DEFAULT_CONTENT,
   messages: [
+    { to: '0109182xxxx' },
+    { to: '0104321xxxx', content?: OPTIONAL_CONTENT_01 }
+    { to: '0108765xxxx', content?: OPTIONAL_CONTENT_02, subject?: OPTIONAL_SUBJECT_01 },
+  ]
+};
+/**
+ * If you do not define the subject and content within the messages,
+ * it is sent with the value specified as the default subject('제목없음') and content.
+ */
+let command = new SendSMSCommand(params);
+```
+
+#### SendMMS (MMS)
+
+```ts
+import { readFileSync } from 'node:fs';
+
+let params: SendMMSCommandInput = {
+  from: '01012345678',
+  content: DEFAULT_CONTENT,
+  messages: [
+    { to: '0109182xxxx' },
+    { to: '0104321xxxx', content?: OPTIONAL_CONTENT_01 }
+    { to: '0108765xxxx', content?: OPTIONAL_CONTENT_02, subject?: OPTIONAL_SUBJECT_01 },
+  ],
+  files: [ // support jpg, jpeg
+    { name: '/your/absolute/path/sample-image-1.jpg' },
     {
-      to: '01087654321',
-      content: OPTIONAL_CONTENT // optional // this OPTIONAL_CONTENT override above DEFAULT_CONTENT
+      name: '/your/absolute/path/sample-image-2.jpg',
+      body?: readFileSync('/your/absolute/path/sample-image-2.jpg', { encoding: 'base64' })
     }
   ]
 };
-let command = new SendSMSCommand(params);
+/**
+ * If you do not define the subject and content within the messages,
+ * it is sent with the value specified as the default subject('제목없음') and content.
+ */
+let command = new SendMMSCommand(params);
 ```
 
 #### Async/await
+
 ```ts
 (async () => {
   try {
     const data = await client.send(command);
     console.dir(data, { depth: 4 });
-  } catch (err){
+  } catch (err) {
     console.dir(err, { depth: 4 });
-  };
+  }
 })();
 ```
 
 #### Promises
+
 ```ts
-client.send(command)
-  .then(data => console.dir(data, { depth: 4 }))
-  .catch(err => console.dir(err, { depth: 4 }));
+client
+  .send(command)
+  .then((data) => console.dir(data, { depth: 4 }))
+  .catch((err) => console.dir(err, { depth: 4 }));
 ```
 
 ## License
-This SDK is distributed under the [MIT License](https://opensource.org/licenses/MIT), see LICENSE for more information.
+
+This SDK is distributed under the [MIT License](https://opensource.org/licenses/MIT), see LICENSE for more information.

package/dist-cjs/commands/GetAlimtalkResultCommand.js

@@ -13,32 +13,29 @@ exports.GetAlimtalkResultCommand = void 0;
 const models_1 = require("../models");
 const GetAlimtalkResult_1 = require("../protocols/GetAlimtalkResult");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class GetAlimtalkResultCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.kakao)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check Kakao ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check Kakao ServiceId",
                 });
             let request = yield (0, GetAlimtalkResult_1.serializeIngestkorea_restJson_GetAlimtalkResultCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, GetAlimtalkResult_1.deserializeIngestkorea_restJson_GetAlimtalkResultCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.GetAlimtalkResultCommand = GetAlimtalkResultCommand;
-;

package/dist-cjs/commands/GetAlimtalkStatusCommand.js

@@ -13,32 +13,29 @@ exports.GetAlimtalkStatusCommand = void 0;
 const models_1 = require("../models");
 const GetAlimtalkStatus_1 = require("../protocols/GetAlimtalkStatus");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class GetAlimtalkStatusCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.kakao)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check Kakao ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check Kakao ServiceId",
                 });
             let request = yield (0, GetAlimtalkStatus_1.serializeIngestkorea_restJson_GetAlimtalkStatusCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, GetAlimtalkStatus_1.deserializeIngestkorea_restJson_GetAlimtalkStatusCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.GetAlimtalkStatusCommand = GetAlimtalkStatusCommand;
-;

package/dist-cjs/commands/GetAlimtalkTemplateCommand.js

@@ -13,32 +13,29 @@ exports.GetAlimtalkTemplateCommand = void 0;
 const models_1 = require("../models");
 const GetAlimtalkTemplate_1 = require("../protocols/GetAlimtalkTemplate");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class GetAlimtalkTemplateCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.kakao)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check Kakao ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check Kakao ServiceId",
                 });
             let request = yield (0, GetAlimtalkTemplate_1.serializeIngestkorea_restJson_GetAlimtalkTemplateCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, GetAlimtalkTemplate_1.deserializeIngestkorea_restJson_GetAlimtalkTemplateCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.GetAlimtalkTemplateCommand = GetAlimtalkTemplateCommand;
-;

package/dist-cjs/commands/GetSMSResultCommand.js

@@ -13,31 +13,29 @@ exports.GetSMSResultCommand = void 0;
 const models_1 = require("../models");
 const GetSMSResult_1 = require("../protocols/GetSMSResult");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class GetSMSResultCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.sms)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check SMS ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check SMS ServiceId",
                 });
             let request = yield (0, GetSMSResult_1.serializeIngestkorea_restJson_GetSMSResultCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, GetSMSResult_1.deserializeIngestkorea_restJson_GetSMSResultCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.GetSMSResultCommand = GetSMSResultCommand;

package/dist-cjs/commands/GetSMSStatusCommand.js

@@ -13,31 +13,29 @@ exports.GetSMSStatusCommand = void 0;
 const models_1 = require("../models");
 const GetSMSStatus_1 = require("../protocols/GetSMSStatus");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class GetSMSStatusCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.sms)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check SMS ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check SMS ServiceId",
                 });
             let request = yield (0, GetSMSStatus_1.serializeIngestkorea_restJson_GetSMSStatusCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, GetSMSStatus_1.deserializeIngestkorea_restJson_GetSMSStatusCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.GetSMSStatusCommand = GetSMSStatusCommand;

package/dist-cjs/commands/ListAlimtalkChannelsCommand.js

@@ -13,32 +13,29 @@ exports.ListAlimtalkChannelsCommand = void 0;
 const models_1 = require("../models");
 const ListAlimtalkChannels_1 = require("../protocols/ListAlimtalkChannels");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class ListAlimtalkChannelsCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.kakao)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check Kakao ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check Kakao ServiceId",
                 });
             let request = yield (0, ListAlimtalkChannels_1.serializeIngestkorea_restJson_ListAlimtalkChannelsCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, ListAlimtalkChannels_1.deserializeIngestkorea_restJson_ListAlimtalkChannelsCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.ListAlimtalkChannelsCommand = ListAlimtalkChannelsCommand;
-;

package/dist-cjs/commands/ListAlimtalkTemplatesCommand.js

@@ -13,32 +13,29 @@ exports.ListAlimtalkTemplatesCommand = void 0;
 const models_1 = require("../models");
 const ListAlimtalkTemplates_1 = require("../protocols/ListAlimtalkTemplates");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class ListAlimtalkTemplatesCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign({}, input);
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.kakao)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check Kakao ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check Kakao ServiceId",
                 });
             let request = yield (0, ListAlimtalkTemplates_1.serializeIngestkorea_restJson_ListAlimtalkTemplatesCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, ListAlimtalkTemplates_1.deserializeIngestkorea_restJson_ListAlimtalkTemplatesCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.ListAlimtalkTemplatesCommand = ListAlimtalkTemplatesCommand;
-;

package/dist-cjs/commands/SendAlimtalkCommand.js

@@ -13,41 +13,40 @@ exports.SendAlimtalkCommand = void 0;
 const models_1 = require("../models");
 const SendAlimtalk_1 = require("../protocols/SendAlimtalk");
 const util_error_handler_1 = require("@ingestkorea/util-error-handler");
-;
-;
 class SendAlimtalkCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
         this.input = Object.assign(Object.assign({}, input), { plusFriendId: input.plusFriendId, templateCode: input.templateCode, messages: input.messages.map(resolveAlimtalkMessage) });
     }
-    ;
     serialize(input, config) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!config.serviceId.kakao)
                 throw new util_error_handler_1.IngestkoreaError({
-                    code: 400, type: 'Bad Request', message: 'Invalid Params', description: 'Please Check Kakao ServiceId'
+                    code: 400,
+                    type: "Bad Request",
+                    message: "Invalid Params",
+                    description: "Please Check Kakao ServiceId",
                 });
             let request = yield (0, SendAlimtalk_1.serializeIngestkorea_restJson_SendAlimtalkCommand)(input, config);
             return request;
         });
     }
-    ;
     deserialize(response) {
         return __awaiter(this, void 0, void 0, function* () {
             let output = yield (0, SendAlimtalk_1.deserializeIngestkorea_restJson_SendAlimtalkCommand)(response);
             return output;
         });
     }
-    ;
 }
 exports.SendAlimtalkCommand = SendAlimtalkCommand;
-;
 const resolveAlimtalkMessage = (message) => {
-    const MAXIMUM_STRING_LENGTH = 1000;
-    if (message.content.length > MAXIMUM_STRING_LENGTH)
+    const ALIMTALK_MAX = 1000;
+    if (message.content.length > ALIMTALK_MAX)
         throw new util_error_handler_1.IngestkoreaError({
-            code: 400, type: 'Bad Request',
-            message: 'Invalid Params', description: `Maximum message length is ${MAXIMUM_STRING_LENGTH}`
+            code: 400,
+            type: "Bad Request",
+            message: "Invalid Params",
+            description: `Maximum message length is ${ALIMTALK_MAX}`,
         });
     return Object.assign({ to: message.to.replace(/\-/gi, ""), content: message.content }, (message.buttons != undefined && { buttons: message.buttons }));
 };