@ingestkorea/client-sens 1.10.0 → 1.11.0

package/dist-es/protocols/constants.js

@@ -1,93 +1,102 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertToUtc = exports.compact = exports.parseErrorBody = exports.parseBody = exports.deserializeMetadata = void 0;
-const util_http_handler_1 = require("@ingestkorea/util-http-handler");
-const index_js_1 = require("../models/index.js");
-const constants_js_1 = require("../middleware/constants.js");
-const deserializeMetadata = (response) => {
-    const attempts = response.headers[constants_js_1.INGESTKOREA_RETRY] || "1";
-    const totalRetryDelay = response.headers[constants_js_1.INGESTKOREA_RETRY_DELAY] || "0";
+import { collectBodyString, destroyStream } from "@ingestkorea/util-http-handler";
+import { SensError, SENS_ERROR_CODE_SPEC, NCLOUD_ERROR_CODE_SPEC, } from "../models/index.js";
+import { INGESTKOREA_RETRY, INGESTKOREA_RETRY_DELAY, NCP_TRACE_ID } from "../middleware/constants.js";
+const ALLOWED_CONTENT_TYPES = ["application/json"];
+const SENS_ERROR_BODY_SPEC = [
+    ["status", "number", true],
+    ["errorMessage", "string", false],
+    ["errors", "object", false],
+];
+const NCLOUD_ERROR_BODY_SPEC = [
+    ["errorCode", "string", true],
+    ["message", "string", false],
+    ["details", "string", false],
+];
+export const deserializeMetadata = (response) => {
+    const attempts = response.headers[INGESTKOREA_RETRY] || "1";
+    const totalRetryDelay = response.headers[INGESTKOREA_RETRY_DELAY] || "0";
+    const traceId = response.headers[NCP_TRACE_ID] || undefined;
     return {
         httpStatusCode: response.statusCode,
         attempts: Number(attempts),
         totalRetryDelay: Number(totalRetryDelay),
+        ...(traceId && { traceId }),
     };
 };
-exports.deserializeMetadata = deserializeMetadata;
-const parseBody = async (output) => {
+export const parseBody = async (output) => {
     const { statusCode, headers, body: streamBody } = output;
-    if (!isJsonResponse(headers["content-type"])) {
-        await (0, util_http_handler_1.destroyStream)(streamBody);
-        throw new index_js_1.SensError({
-            code: -1,
+    if (!isSupportContentType(ALLOWED_CONTENT_TYPES, headers["content-type"])) {
+        await destroyStream(streamBody);
+        throw new SensError({
+            code: statusCode,
             type: "SDK.REQUEST_ERROR",
-            message: "response content-type is not application/json",
+            message: `response content-type is not ${ALLOWED_CONTENT_TYPES.join(" or ")}`,
         });
     }
     try {
-        const data = await (0, util_http_handler_1.collectBodyString)(streamBody);
+        const data = await collectBodyString(streamBody);
         return data.length ? JSON.parse(data) : {};
     }
     catch (e) {
-        throw new index_js_1.SensError({
+        throw new SensError({
             code: -1,
             type: "SDK.REQUEST_ERROR",
-            message: e instanceof Error ? e.message : "parse response body error",
+            message: "parse response body error",
         });
     }
 };
-exports.parseBody = parseBody;
-const parseErrorBody = async (output) => {
+export const parseErrorBody = async (output) => {
     const { statusCode, headers, body: streamBody } = output;
-    if (!isJsonResponse(headers["content-type"])) {
-        await (0, util_http_handler_1.destroyStream)(streamBody);
-        throw new index_js_1.SensError({
+    if (!isSupportContentType(ALLOWED_CONTENT_TYPES, headers["content-type"])) {
+        await destroyStream(streamBody);
+        throw new SensError({
             code: -1,
             type: "SDK.REQUEST_ERROR",
-            message: "response content-type is not application/json",
+            message: `response content-type is not ${ALLOWED_CONTENT_TYPES.join(" or ")}`,
         });
     }
-    const data = await (0, util_http_handler_1.collectBodyString)(streamBody);
-    const sensErrorBody = isSensErrorResponse(data);
-    const nCloudErrorBody = isNCloudErrorResponse(data);
-    if (sensErrorBody) {
-        const errorType = isSensErrorCode(sensErrorBody.status)
-            ? index_js_1.SENS_ERROR_CODE_SPEC[sensErrorBody.status]
-            : "SDK.UNKNOWN_ERROR";
-        throw new index_js_1.SensError({
-            code: isSensErrorCode(sensErrorBody.status) ? sensErrorBody.status : statusCode,
-            type: errorType,
-            message: sensErrorBody.errorMessage || errorType,
-            ...(sensErrorBody.errors &&
-                Array.isArray(sensErrorBody.errors) && {
-                errors: sensErrorBody.errors.filter((d) => !!d),
-            }),
+    try {
+        const data = await collectBodyString(streamBody);
+        const sensContent = isSensErrorResponse(data);
+        const nCloudContent = isNCloudErrorResponse(data);
+        if (sensContent) {
+            throw handleSensError(sensContent, statusCode);
+        }
+        if (nCloudContent) {
+            throw handleNCloudError(nCloudContent, statusCode);
+        }
+        const summary = data ? data.slice(0, 100).trim() : "empty response";
+        throw new SensError({
+            code: -1,
+            type: "SDK.UNKNOWN_ERROR",
+            message: "Invalid Naver Cloud Platform response format",
+            errors: [`HTTP ${statusCode} - ${summary}...`],
         });
     }
-    if (nCloudErrorBody) {
-        const { errorCode } = nCloudErrorBody.error;
-        const errorType = isNCloudErrorCode(errorCode)
-            ? index_js_1.NCLOUD_ERROR_CODE_SPEC[errorCode].type
-            : "SDK.UNKNOWN_ERROR";
-        throw new index_js_1.SensError({
-            code: isNCloudErrorCode(errorCode) ? index_js_1.NCLOUD_ERROR_CODE_SPEC[errorCode].status : statusCode,
-            type: errorType,
-            message: nCloudErrorBody.error.details || "Something wrong",
-        });
+    catch (e) {
+        await destroyStream(streamBody);
+        throw e;
     }
-    throw new index_js_1.SensError({
-        code: -1,
-        type: "SDK.UNKNOWN_ERROR",
-        message: "Invalid Naver Cloud Platform response format",
-        errors: [`${statusCode} - ${data.slice(0, 120)}...`],
-    });
 };
-exports.parseErrorBody = parseErrorBody;
-const isSensErrorCode = (code) => {
-    return code in index_js_1.SENS_ERROR_CODE_SPEC;
+export const compact = (obj) => {
+    if (Array.isArray(obj)) {
+        return obj.map((item) => compact(item));
+    }
+    if (typeof obj === "object" && obj !== null) {
+        return Object.fromEntries(Object.entries(obj)
+            .filter(([_, value]) => value !== undefined) // undefined 필드 제거
+            .map(([key, value]) => [key, compact(value)]) // 내부 값 재귀 처리
+        );
+    }
+    return obj;
 };
-const isNCloudErrorCode = (code) => {
-    return code in index_js_1.NCLOUD_ERROR_CODE_SPEC;
+export const convertToUtc = (input) => {
+    const utcRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$/;
+    return utcRegex.test(input) ? input : new Date(input.replace(" ", "T") + "+09:00").toISOString();
+};
+const isSupportContentType = (allowedTypes, contentType) => {
+    const matchedType = allowedTypes.find((type) => contentType?.toLowerCase().includes(type));
+    return !!matchedType;
 };
 const isSensErrorResponse = (input) => {
     if (typeof input !== "string")
@@ -96,7 +105,7 @@ const isSensErrorResponse = (input) => {
         const data = JSON.parse(input);
         if (!data || typeof data !== "object")
             return null;
-        const isValid = index_js_1.SENS_ERROR_BODY_SPEC.every(([key, type, required]) => {
+        const isValid = SENS_ERROR_BODY_SPEC.every(([key, type, required]) => {
             const value = data[key];
             if (required && (value === undefined || value === null))
                 return false;
@@ -106,7 +115,7 @@ const isSensErrorResponse = (input) => {
         });
         return isValid ? data : null;
     }
-    catch (_a) {
+    catch {
         return null;
     }
 };
@@ -117,7 +126,7 @@ const isNCloudErrorResponse = (input) => {
         const data = JSON.parse(input);
         if (!(data && typeof data == "object" && typeof data.error == "object"))
             return null;
-        const isValid = index_js_1.NCLOUD_ERROR_BODY_SPEC.every(([key, type, required]) => {
+        const isValid = NCLOUD_ERROR_BODY_SPEC.every(([key, type, required]) => {
             const value = data.error[key];
             if (required && (value === undefined || value === null))
                 return false;
@@ -127,29 +136,32 @@ const isNCloudErrorResponse = (input) => {
         });
         return isValid ? data : null;
     }
-    catch (_a) {
+    catch {
         return null;
     }
 };
-const compact = (obj) => {
-    if (Array.isArray(obj)) {
-        return obj.map((item) => (0, exports.compact)(item));
-    }
-    if (typeof obj === "object" && obj !== null) {
-        return Object.fromEntries(Object.entries(obj)
-            .filter(([_, value]) => value !== undefined) // undefined 필드 제거
-            .map(([key, value]) => [key, (0, exports.compact)(value)]) // 내부 값 재귀 처리
-        );
-    }
-    return obj;
+const isSensErrorCode = (code) => {
+    return code in SENS_ERROR_CODE_SPEC;
 };
-exports.compact = compact;
-const convertToUtc = (input) => {
-    const utcRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z$/;
-    return utcRegex.test(input) ? input : new Date(input.replace(" ", "T") + "+09:00").toISOString();
+const isNCloudErrorCode = (code) => {
+    return code in NCLOUD_ERROR_CODE_SPEC;
+};
+const handleSensError = (data, httpStatusCode) => {
+    return new SensError({
+        code: httpStatusCode,
+        type: isSensErrorCode(data.status) ? SENS_ERROR_CODE_SPEC[data.status] : "SDK.UNKNOWN_ERROR",
+        message: data.errorMessage || "something wrong",
+        ...(Array.isArray(data?.errors) && {
+            errors: data.errors.filter((d) => !!d).map((d) => String(d)),
+        }),
+    });
 };
-exports.convertToUtc = convertToUtc;
-const isJsonResponse = (contentType) => {
-    var _a;
-    return (_a = contentType === null || contentType === void 0 ? void 0 : contentType.toLowerCase().includes("application/json")) !== null && _a !== void 0 ? _a : false;
+const handleNCloudError = (data, httpStatusCode) => {
+    const { errorCode, message, details } = data.error;
+    throw new SensError({
+        code: httpStatusCode,
+        type: isNCloudErrorCode(errorCode) ? NCLOUD_ERROR_CODE_SPEC[errorCode].type : "SDK.UNKNOWN_ERROR",
+        message: message || "something wrong",
+        ...(typeof details == "string" && { errors: [details] }),
+    });
 };

package/dist-types/SensClient.d.ts

@@ -2,7 +2,6 @@ import { SensClientConfig, SensClientResolvedConfig, SensCommand } from "./model
 export declare class SensClient {
     config: SensClientResolvedConfig;
     private httpHandler;
-    private requestHandler;
     constructor(config: SensClientConfig);
     send<T, P>(command: SensCommand<T, P, SensClientResolvedConfig>): Promise<P>;
 }

package/dist-types/index.d.ts

@@ -1,3 +1,3 @@
 export * from "./commands/index.js";
 export * from "./SensClient.js";
-export * from "./models/SensError.js";
+export * from "./models/SensClientError.js";

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

@@ -5,3 +5,4 @@ export declare const INGESTKOREA_RETRY_DELAY = "x-ingestkorea-total-retry-delay"
 export declare const NCP_ACCESS_KEY = "x-ncp-iam-access-key";
 export declare const NCP_TIMESTAMP = "x-ncp-apigw-timestamp";
 export declare const NCP_SIGNATURE = "x-ncp-apigw-signature-v2";
+export declare const NCP_TRACE_ID = "x-ncp-trace-id";

package/dist-types/models/MetadataBearer.d.ts

@@ -5,4 +5,5 @@ export interface ResponseMetadata {
     httpStatusCode: number;
     attempts: number;
     totalRetryDelay: number;
+    traceId?: string;
 }

package/dist-types/models/{SensErrorInfo.d.ts → SensApiError.d.ts}

@@ -53,5 +53,3 @@ export interface NCloudErrorResponse {
         details?: string;
     };
 }
-export declare const SENS_ERROR_BODY_SPEC: [[keyof SensErrorResponse][number], string, boolean][];
-export declare const NCLOUD_ERROR_BODY_SPEC: [[keyof NCloudErrorResponse["error"]][number], string, boolean][];

package/dist-types/models/SensClient.d.ts

@@ -6,11 +6,19 @@ export type ServiceId = {
     kakao: string;
     sms: string;
 };
+export type HttpHandlerOptions = {
+    connectionTimeout: number;
+    socketTimeout: number;
+    keepAlive: boolean;
+    family: 4;
+};
 export interface SensClientConfig {
     credentials?: Partial<Credentials>;
     serviceId?: Partial<ServiceId>;
+    httpHandler?: Partial<HttpHandlerOptions>;
 }
 export interface SensClientResolvedConfig {
     credentials: Credentials;
     serviceId: ServiceId;
+    httpHandler: HttpHandlerOptions;
 }

package/dist-types/models/{SensError.d.ts → SensClientError.d.ts}

@@ -1,6 +1,7 @@
-import { SesnResponseErrorType } from "./SensErrorInfo.js";
+import { HttpHandlerErrorCode } from "@ingestkorea/util-http-handler";
+import { SesnResponseErrorType } from "./SensApiError.js";
 type SensClientErrorType = "SDK.AUTH_ERROR" | "SDK.GENERAL_ERROR" | "SDK.REQUEST_ERROR" | "SDK.UNKNOWN_ERROR";
-export type SensErrorType = SesnResponseErrorType | SensClientErrorType;
+export type SensErrorType = SesnResponseErrorType | SensClientErrorType | HttpHandlerErrorCode;
 export interface SensErrorInput {
     code: number;
     type: SensErrorType;

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

@@ -11,8 +11,8 @@ export * from "./MetadataBearer.js";
 export * from "./SendAlimtalk.js";
 export * from "./SendMMS.js";
 export * from "./SendSMS.js";
+export * from "./SensApiError.js";
 export * from "./SensClient.js";
+export * from "./SensClientError.js";
 export * from "./SensCommand.js";
-export * from "./SensError.js";
-export * from "./SensErrorInfo.js";
 export * from "./SensMiddleware.js";

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ingestkorea/client-sens",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "INGESTKOREA SDK Naver Cloud Platform SENS Client for Node.js.",
   "exports": {
     ".": {
+      "types": "./dist-types/index.d.ts",
       "import": "./dist-es/index.js",
-      "require": "./dist-cjs/index.js",
-      "types": "./dist-types/index.d.ts"
+      "require": "./dist-cjs/index.js"
     }
   },
   "main": "./dist-cjs/index.js",
@@ -43,7 +43,7 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "@ingestkorea/util-http-handler": "^1.3.0"
+    "@ingestkorea/util-http-handler": "^1.4.0"
   },
   "keywords": [
     "sens",

package/dist-es/models/SensErrorInfo.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NCLOUD_ERROR_BODY_SPEC = exports.SENS_ERROR_BODY_SPEC = exports.NCLOUD_ERROR_CODE_SPEC = exports.SENS_ERROR_CODE_SPEC = void 0;
-exports.SENS_ERROR_CODE_SPEC = {
-    400: "Bad Request",
-    401: "Unauthorized",
-    403: "Forbidden",
-    404: "Not Found",
-    429: "Too Many Requests",
-    500: "Internal Server Error",
-};
-exports.NCLOUD_ERROR_CODE_SPEC = {
-    "100": { status: 400, type: exports.SENS_ERROR_CODE_SPEC["400"] },
-    "200": { status: 401, type: exports.SENS_ERROR_CODE_SPEC["401"] },
-    "210": { status: 403, type: exports.SENS_ERROR_CODE_SPEC["403"] },
-    "300": { status: 404, type: exports.SENS_ERROR_CODE_SPEC["404"] },
-    "400": { status: 429, type: exports.SENS_ERROR_CODE_SPEC["429"] },
-    "410": { status: 429, type: exports.SENS_ERROR_CODE_SPEC["429"] },
-    "420": { status: 429, type: exports.SENS_ERROR_CODE_SPEC["429"] },
-    "900": { status: 500, type: exports.SENS_ERROR_CODE_SPEC["500"] },
-};
-exports.SENS_ERROR_BODY_SPEC = [
-    ["status", "number", true],
-    ["errorMessage", "string", false],
-    ["errors", "object", false],
-];
-exports.NCLOUD_ERROR_BODY_SPEC = [
-    ["errorCode", "string", true],
-    ["message", "string", false],
-    ["details", "string", false],
-];