Merge pull request #45 from Palbahngmiyine/impr/kakao-v2

Palbahngmiyine · web-flow · commit 3688d48d5242 · 2022-09-27T16:51:54.000+09:00
Release SOLAPI Node.js SDK 5.1.1
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,12 @@ package-lock.json
 dist
 .parcel-cache
 yarn-error.log
-debug
+debug
+
+.yarn/*
+!.yarn/patches
+!.yarn/releases
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions
+.pnp.*
diff --git a/.yarn/releases/yarn-3.2.3.cjs b/.yarn/releases/yarn-3.2.3.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.2.3.cjs
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "solapi",
-  "version": "5.1.1-beta.1",
+  "version": "5.1.1",
   "description": "SOLAPI SDK for Node.js(Server Side Only)",
   "repository": {
     "type": "git",
@@ -30,7 +30,7 @@
   "homepage": "https://solapi.github.io/solapi-nodejs",
   "scripts": {
     "clean": "rimraf dist",
-    "compress": "yarn uglifyjs --v8 -- ./dist/index.js -o ./dist/index.js && yarn uglifyjs --v8 -- ./dist/module.js -o ./dist/module.js",
+    "compress": "yarn uglifyjs -o ./dist/index.js ./dist/index.js && yarn uglifyjs -o ./dist/module.js ./dist/module.js",
     "build": "yarn clean && parcel build --no-source-maps && yarn compress",
     "watch": "parcel watch",
     "docs": "typedoc --entryPointStrategy expand ./src"
@@ -41,29 +41,31 @@
   "dependencies": {
     "cross-fetch": "^3.1.5",
     "crypto-js": "^4.1.1",
-    "date-fns": "^2.28.0",
+    "date-fns": "^2.29.3",
     "image-to-base64": "^2.2.0",
-    "nanoid": "^3.3.4"
+    "nanoid": "^3.3.4",
+    "qs": "^6.11.0"
   },
   "devDependencies": {
-    "@parcel/packager-ts": "^2.6.0",
-    "@parcel/transformer-typescript-tsc": "^2.6.0",
-    "@parcel/transformer-typescript-types": "^2.6.0",
+    "@parcel/packager-ts": "2.7.0",
+    "@parcel/transformer-typescript-types": "2.7.0",
     "@types/crypto-js": "^4.1.1",
     "@types/image-to-base64": "^2.1.0",
-    "@types/node": "^17.0.42",
-    "@typescript-eslint/eslint-plugin": "^5.27.1",
-    "@typescript-eslint/parser": "^5.27.1",
-    "eslint": "^8.17.0",
-    "eslint-plugin-tsdoc": "^0.2.16",
-    "parcel": "^2.6.0",
+    "@types/node": "^18.7.18",
+    "@types/qs": "^6.9.7",
+    "@typescript-eslint/eslint-plugin": "^5.38.0",
+    "@typescript-eslint/parser": "^5.38.0",
+    "eslint": "^8.23.1",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "parcel": "^2.7.0",
     "querystring-es3": "^0.2.1",
     "rimraf": "^3.0.2",
-    "typedoc": "^0.22.17",
-    "typescript": "^4.7.3",
-    "uglify-js": "^3.16.0"
+    "typedoc": "^0.23.15",
+    "typescript": "^4.7.4",
+    "uglify-js": "^3.17.2"
   },
   "files": [
     "/dist"
-  ]
-}
+  ],
+  "packageManager": "yarn@3.2.3"
+}
diff --git a/src/errors/defaultError.ts b/src/errors/defaultError.ts
diff --git a/src/lib/authenticator.ts b/src/lib/authenticator.ts
@@ -1,7 +1,7 @@
 import {customAlphabet} from 'nanoid';
 import {formatISO} from 'date-fns';
 import {HmacSHA256} from 'crypto-js';
-import {ApiKeyError} from '../errors/DefaultError';
+import {ApiKeyError} from '../errors/defaultError';
 
 enum AuthenticateType {
     API_KEY
diff --git a/src/lib/defaultFetcher.ts b/src/lib/defaultFetcher.ts
@@ -1,6 +1,6 @@
 import getAuthInfo, {AuthenticationParameter} from './authenticator';
 import fetch from 'cross-fetch';
-import {DefaultError, ErrorResponse} from '../errors/DefaultError';
+import {DefaultError, ErrorResponse} from '../errors/defaultError';
 
 type DefaultRequest = {
     url: string,
diff --git a/src/lib/queryParameterGenerator.ts b/src/lib/queryParameterGenerator.ts
@@ -1,5 +1,10 @@
 import {URL, URLSearchParams} from 'url';
 
+/**
+ * @deprecated
+ * @param url API URl
+ * @param data object data
+ */
 export default function queryParameterGenerator<T extends object>(url: string, data?: T): string {
     const apiUrl = new URL(url);
     if (data) {
diff --git a/src/lib/stringDateTrasnfer.ts b/src/lib/stringDateTrasnfer.ts
@@ -1,5 +1,5 @@
 import {parseISO} from 'date-fns';
-import {InvalidDateError} from '../errors/DefaultError';
+import {InvalidDateError} from '../errors/defaultError';
 
 /**
  * 일반 문자열 날짜가 있을 경우 Date 타입으로 변환해주는 함수
diff --git a/src/models/kakao/kakaoAlimtalkTemplate.ts b/src/models/kakao/kakaoAlimtalkTemplate.ts
@@ -38,12 +38,17 @@ export class KakaoAlimtalkTemplate {
     /**
      * 카카오 비즈니스 채널 ID
      */
-    pfId: string;
+    channelId: string | null;
 
     /**
      * 카카오 비즈니스 채널 그룹 ID
      */
-    pfGroupId?: string | null;
+    channelGroupId: string | null;
+
+    /**
+     * 알림톡 템플릿 내용
+     */
+    content: string;
 
     /**
      * 알림톡 템플릿 숨김 여부
@@ -64,25 +69,25 @@ export class KakaoAlimtalkTemplate {
      * 부가정보
      * 메시지 유형이 "부가정보형"또는 "복합형"일 경우 필수
      */
-    extra?: string | null;
+    extra: string | null;
 
     /**
      * 간단 광고 문구
      * 메시지 유형이 "광고추가형"또는 "복합형"일 경우 필수
      */
-    ad?: string | null;
+    ad: string | null;
 
     /**
      * 강조표기 핵심문구 (변수사용가능, emphasizeType이 TEXT일 경우 필수 값)
      * 템플릿 내용에 강조표기할 핵심문구가 동일하게 포함되어 있어야합니다.
      */
-    emphasizeTitle?: string | null;
+    emphasizeTitle: string | null;
 
     /**
      * 강조표기 보조문구(emphasizeType이 TEXT일 경우 필수 값)
      * 템플릿 내용에 강조표기할 보조문구가 동일하게 포함되어 있어야합니다.
      */
-    emphasizeSubtitle?: string | null;
+    emphasizeSubtitle: string | null;
 
     /**
      * PC 노출 여부
@@ -93,30 +98,30 @@ export class KakaoAlimtalkTemplate {
     /**
      * 템플릿에 사용되는 이미지 ID
      */
-    imageId?: string | null;
+    imageId: string | null;
 
     /**
      * 카카오 알림톡 템플릿 그룹 유형
      */
-    assignType?: KakaoAlimtalkTemplateAssignType = 'CHANNEL';
+    assignType: KakaoAlimtalkTemplateAssignType = 'CHANNEL';
 
     /**
      * 카카오 알림톡 템플릿 버튼 목록
      */
-    buttons?: Array<KakaoButton>;
+    buttons: Array<KakaoButton>;
 
     /**
      * 카카오 알림톡 템플릿 상태 현황목록
      */
-    codes?: Array<KakaoAlimtalkTemplateCodeType>;
+    codes: Array<KakaoAlimtalkTemplateCodeType>;
 
     /**
      * 알림톡 템플릿 생성일자
      */
-    dateCreated?: string;
+    dateCreated: string;
 
     /**
      * 알림톡 템플릿 수정일자
      */
-    dateUpdated?: string;
+    dateUpdated: string;
 }
diff --git a/src/models/kakao/kakaoChannel.ts b/src/models/kakao/kakaoChannel.ts
@@ -1,10 +1,32 @@
-export class KakaoChannelCategory {
+/**
+ * @description 카카오 채널 카테고리 타입
+ * @property code 카테고리 코드번호
+ * @property name 카테고리 설명(이름)
+ */
+export type KakaoChannelCategory = {
     code: string;
     name: string;
 }
 
-export class KakaoChannel {
-    pfId: string;
+/**
+ * @description 카카오 채널 카테고리 타입
+ * @property code 카테고리 코드번호
+ * @property name 카테고리 설명(이름)
+ */
+export type KakaoAlimtalkTemplateCategory = KakaoChannelCategory;
+
+/**
+ * @description 카카오 채널
+ * @property channelId 카카오 채널 고유 ID, SOLAPI 내부 식별용
+ * @property searchId 카카오 채널 검색용 아이디, 채널명이 아님
+ * @property accountId 계정 고유번호
+ * @property phoneNumber 카카오 채널 담당자 휴대전화 번호
+ * @property sharedAccountIds 카카오 채널을 공유한 SOLAPI 계정 고유번호 목록
+ * @property dateCreated 카카오 채널 생성일자(연동일자)
+ * @property dateUpdated 카카오 채널 정보 수정일자
+ */
+export type KakaoChannel = {
+    channelId: string;
     searchId: string;
     accountId: string;
     phoneNumber: string;
diff --git a/src/requests/messageRequest.ts b/src/requests/messageRequest.ts
@@ -1,8 +1,8 @@
-import { Message, MessageType } from '../models/message';
-import { GroupId } from '../types/commonTypes';
-import { formatISO } from 'date-fns';
+import {Message, MessageType} from '../models/message';
+import {GroupId, OperatorType} from '../types/commonTypes';
+import {formatISO} from 'date-fns';
 import stringDateTransfer from '../lib/stringDateTrasnfer';
-import { KakaoButton } from '../models/kakao/kakaoButton';
+import {KakaoButton} from '../models/kakao/kakaoButton';
 import {
     KakaoAlimtalkTemplateEmphasizeType,
     KakaoAlimtalkTemplateMessageType
@@ -13,7 +13,7 @@ export type DefaultAgentType = {
     osPlatform: string
 };
 
-const sdkVersion = 'nodejs/5.1.1-beta.1';
+const sdkVersion = 'nodejs/5.1.1';
 
 export const defaultAgent: DefaultAgentType = {
     sdkVersion,
@@ -197,43 +197,20 @@ export type CreateGroupRequest = DefaultAgentType & {
     appId?: string
 }
 
-export type GetKakaoChannelsRequestType = {
-    pfId?: string
-    searchId?: string
-    phoneNumber?: string
-    categoryCode?: string
-    dateCreated?: string
-    dateUpdated?: string
-    startKey?: string
-    limit?: number
-}
-
-export class GetKakaoChannelsRequest {
-    readonly pfId?: string;
-    readonly searchId?: string;
-    readonly phoneNumber?: string;
-    readonly categoryCode?: string;
-    readonly dateCreated?: string;
-    readonly dateUpdated?: string;
-    readonly startKey?: string;
-    readonly limit?: number;
-
-    constructor(getKakaoChannelsRequestType: GetKakaoChannelsRequestType) {
-        this.pfId = getKakaoChannelsRequestType.pfId;
-        this.searchId = getKakaoChannelsRequestType.searchId;
-        this.phoneNumber = getKakaoChannelsRequestType.phoneNumber;
-        this.categoryCode = getKakaoChannelsRequestType.categoryCode;
-        this.dateCreated = getKakaoChannelsRequestType.dateCreated;
-        this.dateUpdated = getKakaoChannelsRequestType.dateUpdated;
-        this.startKey = getKakaoChannelsRequestType.startKey;
-        this.limit = getKakaoChannelsRequestType.limit;
-    }
+export type GetKakaoChannelsRequest = {
+    channelId: string;
+    searchId: string;
+    phoneNumber: string;
+    categoryCode: string;
+    dateCreated: Record<keyof Omit<OperatorType, 'ne' | 'like'>, Array<string>>;
+    dateUpdated: Record<keyof Omit<OperatorType, 'ne' | 'like'>, Array<string>>;
+    startKey: string;
+    limit: number;
 }
 
 export type CreateKakaoChannelTokenRequest = {
     searchId: string
     phoneNumber: string
-    categoryCode: string
 }
 
 export type CreateKakaoChannelRequest = {
@@ -279,23 +256,29 @@ export class GetKakaoAlimtalkTemplatesRequest {
     }
 }
 
+/**
+ * @description 카카오 알림톡 템플릿 요청 파라미터 타입
+ * @param name 알림톡 템플릿 제목 (동일한 채널에 중복적인 이름 등록 불가)
+ * @property content 알림톡 템플릿 내용
+ * @property categoryCode 알림톡 템플릿 카테고리 코드, KakaoAlimtalkTemplateCategory 타입 참고
+ * @property buttons 알림톡 템플릿
+ */
 export type KakaoAlimtalkTemplateRequest = {
-    name: string
-    content: string
-    categoryCode: string
-    buttons?: Array<KakaoButton>
-    messageType: KakaoAlimtalkTemplateMessageType
-    emphasizeType: KakaoAlimtalkTemplateEmphasizeType
-    extra?: string
-    ad?: string
-    emphasizeTitle?: string
-    emphasizeSubtitle?: string
-    securityFlag: boolean
-    imageId: string
+    name?: string;
+    content?: string;
+    categoryCode?: string;
+    buttons?: Array<KakaoButton>;
+    messageType?: KakaoAlimtalkTemplateMessageType;
+    emphasizeType?: KakaoAlimtalkTemplateEmphasizeType;
+    extra?: string;
+    ad?: string;
+    emphasizeTitle?: string;
+    emphasizeSubtitle?: string;
+    securityFlag?: boolean;
+    imageId?: string;
 };
 
 export type CreateKakaoAlimtalkTemplateRequest = KakaoAlimtalkTemplateRequest & {
-    pfId: string
-    pfGroupId?: string
-
+    channelId?: string;
+    channelGroupId?: string;
 }
diff --git a/src/responses/messageResponses.ts b/src/responses/messageResponses.ts
@@ -180,7 +180,9 @@ export type FileUploadResponse = {
 
 export type GetKakaoChannelsResponse = {
     limit: number
-    friends: Array<KakaoChannel>
+    startKey: string
+    nextKey: string|null
+    channelList: Array<KakaoChannel>
 }
 
 export type RequestKakaoChannelTokenResponse = {
@@ -193,7 +195,7 @@ export type CreateKakaoChannelResponse = {
     searchId: string
     dateCreated: string
     dateUpdated: string
-    pfId: string
+    channelId: string
 }
 
 export type GetKakaoAlimtalkTemplatesResponse = {
diff --git a/src/solapi.ts b/src/solapi.ts
diff --git a/src/types/commonTypes.ts b/src/types/commonTypes.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+nodeLinker: node-modules`
	`2`	`+`
	`3`	`+yarnPath: .yarn/releases/yarn-3.2.3.cjs`