@ingestkorea/client-sens 1.4.0 → 1.4.2

package/.github/pull_request_template.md

@@ -0,0 +1,14 @@
+### 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.

package/README.md

@@ -61,10 +61,16 @@ const client = new SensClient({
   serviceId: {
     sms: 'ncp:sms:kr:123456789xxx:your-service-name', // optional
     kakao: 'ncp:kkobizmsg:kr:9876xxx:your-service-name' // optional
-    // at least one serviceId required
-    // if you call send operation without serviceId, sdk throw error
   }
 });
+
+/**
+ * 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
@@ -83,14 +89,17 @@ let command = new SendAlimtalkCommand(params);
 ```ts
 /**
  * Automatically set message type('SMS' | 'LMS') according to content-length(euc-kr)
- * SMS: max 80bytes
+ * SMS: max 90bytes
  * LMS: max 2000bytes
  */
 let params: SendSMSCommandInput = {
   from: '01012345678',
-  content: CONTENT,
+  content: DEFAULT_CONTENT,
   messages: [
-    { to: '01087654321' }
+    {
+      to: '01087654321',
+      content: OPTIONAL_CONTENT // optional // this OPTIONAL_CONTENT override above DEFAULT_CONTENT
+    }
   ]
 };
 let command = new SendSMSCommand(params);

package/dist-cjs/SensClient.js

@@ -30,7 +30,8 @@ class SensClient {
         return __awaiter(this, void 0, void 0, function* () {
             let input = command.input;
             let request = yield command.serialize(input, this.config);
-            request = yield (0, middleware_1.middlewareSigner)(request, this.config);
+            request = yield (0, middleware_1.middlewareNcpSigner)(request, this.config);
+            request = yield (0, middleware_1.middlewareIngestkoreaMetadata)(request, this.config);
             let { response } = yield this.httpHandler.handle(request);
             let output = yield command.deserialize(response);
             return output;

package/dist-cjs/commands/SendSMSCommand.js

@@ -18,11 +18,10 @@ const util_error_handler_1 = require("@ingestkorea/util-error-handler");
 class SendSMSCommand extends models_1.SensCommand {
     constructor(input) {
         super(input);
-        const content = textTrimming(input.content);
-        const messageType = messageTypeChecker(content);
-        this.input = Object.assign(Object.assign({}, input), { from: phoneNumPretty(input.from), content: content, type: input.type === messageType ? input.type : messageType, messages: input.messages.map(message => {
-                return Object.assign(Object.assign({ to: phoneNumPretty(message.to) }, (message.content != undefined && { content: textTrimming(message.content) })), (message.subject != undefined && messageType === 'LMS' && { subject: textTrimming(message.subject) }));
-            }) });
+        const content = trimText(input.content);
+        const { messages, messageType: childMessageType } = resolveInputMessages(input.messages);
+        const messageType = childMessageType == 'LMS' ? childMessageType : checkMessageType(content);
+        this.input = Object.assign(Object.assign({}, input), { from: prettyPhoneNum(input.from), content: content, type: messageType, messages: messages });
     }
     ;
     serialize(input, config) {
@@ -46,25 +45,41 @@ class SendSMSCommand extends models_1.SensCommand {
 }
 exports.SendSMSCommand = SendSMSCommand;
 ;
-const textTrimming = (input) => input.trim();
-const phoneNumPretty = (input) => input.replace(/\-/gi, "");
-const messageTypeChecker = (input) => {
-    const MAXIMUM = 2000;
-    const euckrByte = input.split('').reduce((acc, text) => {
+const trimText = (input) => input.trim();
+const prettyPhoneNum = (input) => input.replace(/\-/gi, "");
+const getTextBytes = (input) => {
+    return input.split('').reduce((acc, text) => {
         let byte = Buffer.from(text).length;
         let modulo = byte % 3;
         modulo ? acc += 1 : acc += 2;
         return acc;
     }, 0);
-    if (!euckrByte)
+};
+const checkMessageType = (input) => {
+    const SMS_MAX = 90;
+    const LMS_MAX = 2000;
+    const euckrBytes = getTextBytes(input);
+    if (!euckrBytes)
         throw new util_error_handler_1.IngestkoreaError({
             code: 400, type: 'Bad Request',
             message: 'Invalid Request', description: `Please check input message`
         });
-    if (euckrByte > MAXIMUM)
+    if (euckrBytes > LMS_MAX)
         throw new util_error_handler_1.IngestkoreaError({
             code: 400, type: 'Bad Request',
-            message: 'Invalid Request', description: `Maximum message length is ${MAXIMUM}bytes`
+            message: 'Invalid Request', description: `Maximum message length is ${LMS_MAX}bytes`
         });
-    return euckrByte > 80 ? 'LMS' : 'SMS';
+    return euckrBytes > SMS_MAX ? 'LMS' : 'SMS';
+};
+const resolveInputMessages = (messages) => {
+    let resolvedMessageType = 'SMS';
+    let resolvedMessages = messages.map(message => {
+        const resolvedContent = message.content != undefined ? trimText(message.content) : '';
+        const resolvedSubject = message.subject != undefined ? trimText(message.subject) : '';
+        const messageType = !!resolvedContent != false ? checkMessageType(resolvedContent) : 'SMS';
+        if (messageType === 'LMS')
+            resolvedMessageType = messageType;
+        return Object.assign(Object.assign({ to: prettyPhoneNum(message.to) }, (!!resolvedContent != false && { content: resolvedContent })), (!!resolvedSubject != false && messageType === 'LMS' && { subject: resolvedSubject }));
+    });
+    return { messages: resolvedMessages, messageType: resolvedMessageType };
 };

package/dist-cjs/middleware/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./signer"), exports);
+__exportStar(require("./signer-ncp"), exports);
+__exportStar(require("./metadata-ingestkorea"), exports);

package/dist-cjs/middleware/metadata-ingestkorea.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.middlewareIngestkoreaMetadata = void 0;
+const middlewareIngestkoreaMetadata = (request, config) => __awaiter(void 0, void 0, void 0, function* () {
+    const { longDate } = yield convertFormatDate(request.headers['x-ncp-apigw-timestamp']);
+    request.headers = Object.assign(Object.assign({}, request.headers), { ['x-ingestkorea-date']: longDate, ['x-ingestkorea-user-agent']: '@ingestkorea/client-sens/1.4.x' });
+    return request;
+});
+exports.middlewareIngestkoreaMetadata = middlewareIngestkoreaMetadata;
+/**
+ * @param input milliseconds
+ */
+const convertFormatDate = (input) => __awaiter(void 0, void 0, void 0, function* () {
+    let milliseconds = input ? Number(input) : new Date().getTime();
+    let iso8601 = new Date(milliseconds).toISOString().replace(/\.\d{3}Z$/, "Z");
+    let longDate = iso8601.replace(/[\-:]/g, "");
+    let shortDate = longDate.slice(0, 8);
+    return { longDate, shortDate };
+});

package/dist-cjs/middleware/{signer.js → signer-ncp.js}

@@ -9,12 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.middlewareSigner = void 0;
+exports.middlewareNcpSigner = void 0;
 const crypto_1 = require("crypto");
-const middlewareSigner = (request, config) => __awaiter(void 0, void 0, void 0, function* () {
+const util_http_handler_1 = require("@ingestkorea/util-http-handler");
+const middlewareNcpSigner = (request, config) => __awaiter(void 0, void 0, void 0, function* () {
     const { accessKey, secretKey } = config.credentials;
     const method = request.method;
-    const queryString = new URLSearchParams(request.query).toString();
+    const queryString = (0, util_http_handler_1.buildQueryString)(request.query);
     const path = queryString ? `${request.path}?${queryString}` : request.path;
     const space = " ";
     const newLine = "\n";
@@ -28,4 +29,4 @@ const middlewareSigner = (request, config) => __awaiter(void 0, void 0, void 0,
     request.headers = Object.assign(Object.assign({}, request.headers), { ['x-ncp-iam-access-key']: accessKey, ['x-ncp-apigw-timestamp']: timestamp, ['x-ncp-apigw-signature-v2']: signature });
     return request;
 });
-exports.middlewareSigner = middlewareSigner;
+exports.middlewareNcpSigner = middlewareNcpSigner;

package/dist-es/SensClient.js

@@ -1,6 +1,6 @@
 import { NodeHttpHandler } from '@ingestkorea/util-http-handler';
 import { IngestkoreaError } from '@ingestkorea/util-error-handler';
-import { middlewareSigner } from './middleware';
+import { middlewareNcpSigner, middlewareIngestkoreaMetadata } from './middleware';
 ;
 ;
 export class SensClient {
@@ -17,7 +17,8 @@ export class SensClient {
     async send(command) {
         let input = command.input;
         let request = await command.serialize(input, this.config);
-        request = await middlewareSigner(request, this.config);
+        request = await middlewareNcpSigner(request, this.config);
+        request = await middlewareIngestkoreaMetadata(request, this.config);
         let { response } = await this.httpHandler.handle(request);
         let output = await command.deserialize(response);
         return output;

package/dist-es/commands/SendSMSCommand.js

@@ -6,20 +6,15 @@ import { IngestkoreaError } from '@ingestkorea/util-error-handler';
 export class SendSMSCommand extends SensCommand {
     constructor(input) {
         super(input);
-        const content = textTrimming(input.content);
-        const messageType = messageTypeChecker(content);
+        const content = trimText(input.content);
+        const { messages, messageType: childMessageType } = resolveInputMessages(input.messages);
+        const messageType = childMessageType == 'LMS' ? childMessageType : checkMessageType(content);
         this.input = {
             ...input,
-            from: phoneNumPretty(input.from),
+            from: prettyPhoneNum(input.from),
             content: content,
-            type: input.type === messageType ? input.type : messageType,
-            messages: input.messages.map(message => {
-                return {
-                    to: phoneNumPretty(message.to),
-                    ...(message.content != undefined && { content: textTrimming(message.content) }),
-                    ...(message.subject != undefined && messageType === 'LMS' && { subject: textTrimming(message.subject) }),
-                };
-            })
+            type: messageType,
+            messages: messages
         };
     }
     ;
@@ -39,25 +34,45 @@ export class SendSMSCommand extends SensCommand {
     ;
 }
 ;
-const textTrimming = (input) => input.trim();
-const phoneNumPretty = (input) => input.replace(/\-/gi, "");
-const messageTypeChecker = (input) => {
-    const MAXIMUM = 2000;
-    const euckrByte = input.split('').reduce((acc, text) => {
+const trimText = (input) => input.trim();
+const prettyPhoneNum = (input) => input.replace(/\-/gi, "");
+const getTextBytes = (input) => {
+    return input.split('').reduce((acc, text) => {
         let byte = Buffer.from(text).length;
         let modulo = byte % 3;
         modulo ? acc += 1 : acc += 2;
         return acc;
     }, 0);
-    if (!euckrByte)
+};
+const checkMessageType = (input) => {
+    const SMS_MAX = 90;
+    const LMS_MAX = 2000;
+    const euckrBytes = getTextBytes(input);
+    if (!euckrBytes)
         throw new IngestkoreaError({
             code: 400, type: 'Bad Request',
             message: 'Invalid Request', description: `Please check input message`
         });
-    if (euckrByte > MAXIMUM)
+    if (euckrBytes > LMS_MAX)
         throw new IngestkoreaError({
             code: 400, type: 'Bad Request',
-            message: 'Invalid Request', description: `Maximum message length is ${MAXIMUM}bytes`
+            message: 'Invalid Request', description: `Maximum message length is ${LMS_MAX}bytes`
         });
-    return euckrByte > 80 ? 'LMS' : 'SMS';
+    return euckrBytes > SMS_MAX ? 'LMS' : 'SMS';
+};
+const resolveInputMessages = (messages) => {
+    let resolvedMessageType = 'SMS';
+    let resolvedMessages = messages.map(message => {
+        const resolvedContent = message.content != undefined ? trimText(message.content) : '';
+        const resolvedSubject = message.subject != undefined ? trimText(message.subject) : '';
+        const messageType = !!resolvedContent != false ? checkMessageType(resolvedContent) : 'SMS';
+        if (messageType === 'LMS')
+            resolvedMessageType = messageType;
+        return {
+            to: prettyPhoneNum(message.to),
+            ...(!!resolvedContent != false && { content: resolvedContent }),
+            ...(!!resolvedSubject != false && messageType === 'LMS' && { subject: resolvedSubject }),
+        };
+    });
+    return { messages: resolvedMessages, messageType: resolvedMessageType };
 };

package/dist-es/middleware/index.js

@@ -1 +1,2 @@
-export * from './signer';
+export * from './signer-ncp';
+export * from './metadata-ingestkorea';

package/dist-es/middleware/metadata-ingestkorea.js

@@ -0,0 +1,19 @@
+export const middlewareIngestkoreaMetadata = async (request, config) => {
+    const { longDate } = await convertFormatDate(request.headers['x-ncp-apigw-timestamp']);
+    request.headers = {
+        ...request.headers,
+        ['x-ingestkorea-date']: longDate,
+        ['x-ingestkorea-user-agent']: '@ingestkorea/client-sens/1.4.x'
+    };
+    return request;
+};
+/**
+ * @param input milliseconds
+ */
+const convertFormatDate = async (input) => {
+    let milliseconds = input ? Number(input) : new Date().getTime();
+    let iso8601 = new Date(milliseconds).toISOString().replace(/\.\d{3}Z$/, "Z");
+    let longDate = iso8601.replace(/[\-:]/g, "");
+    let shortDate = longDate.slice(0, 8);
+    return { longDate, shortDate };
+};

package/dist-es/middleware/{signer.js → signer-ncp.js}

@@ -1,8 +1,9 @@
 import { createHmac } from 'crypto';
-export const middlewareSigner = async (request, config) => {
+import { buildQueryString } from '@ingestkorea/util-http-handler';
+export const middlewareNcpSigner = async (request, config) => {
     const { accessKey, secretKey } = config.credentials;
     const method = request.method;
-    const queryString = new URLSearchParams(request.query).toString();
+    const queryString = buildQueryString(request.query);
     const path = queryString ? `${request.path}?${queryString}` : request.path;
     const space = " ";
     const newLine = "\n";

package/dist-types/middleware/index.d.ts

@@ -1 +1,2 @@
-export * from './signer';
+export * from './signer-ncp';
+export * from './metadata-ingestkorea';

package/dist-types/middleware/metadata-ingestkorea.d.ts

@@ -0,0 +1,3 @@
+import { HttpRequest } from '@ingestkorea/util-http-handler';
+import { SensClientResolvedConfig } from '../SensClient';
+export declare const middlewareIngestkoreaMetadata: (request: HttpRequest, config: SensClientResolvedConfig) => Promise<HttpRequest>;

package/dist-types/middleware/signer-ncp.d.ts

@@ -0,0 +1,3 @@
+import { HttpRequest } from '@ingestkorea/util-http-handler';
+import { SensClientResolvedConfig } from '../SensClient';
+export declare const middlewareNcpSigner: (request: HttpRequest, config: SensClientResolvedConfig) => Promise<HttpRequest>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ingestkorea/client-sens",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "INGESTKOREA SDK Naver Cloud Platform SENS Client for Node.js.",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",

package/dist-types/middleware/signer.d.ts

@@ -1,3 +0,0 @@
-import { HttpRequest } from '@ingestkorea/util-http-handler';
-import { SensClientResolvedConfig } from '../SensClient';
-export declare const middlewareSigner: (request: HttpRequest, config: SensClientResolvedConfig) => Promise<HttpRequest>;