[impr] improve KakaoAlimtalkTemplateQuickReply type

Author: Palbahngmiyine

changelog/ko/CHANGELOG.md

@@ -1,10 +1,11 @@
-# 5.2.0 (2022년 12월 12일)
+# 5.2.0 (2022년 12월 13일)
 
 - 5.1.1에서 추가된 카카오 알림톡 채널/템플릿 관리 기능을 안정화 했습니다.
     - 템플릿 내 아이템리스트 유형 및 바로연결 버튼 유형이 추가되었습니다.
     - `getKakaoChannels`, `getKakaoAlimtalkTemplates`, `getKakaoChannel`, `getKakaoAlimtalkTemplate`
       , `createKakaoAlimtalkTemplate`, `updateKakaoAlimtalkTemplate`, `cancelInspectionKakaoAlimtalkTemplate`, `deleteKakaoAlimtalkTemplate`, `requestInspectionKakaoAlimtalkTemplate` 호출 시 실제 각 모델 별 클래스 인스턴스를
       반환하도록 수정되었습니다.
+    - KakaoButton 타입이 조금 더 정확하게 타입을 추론하도록 수정되었습니다.
 - send 메소드에 messages 파라미터 이후의 파라미터들을 하나의 오브젝트(requestConfigParameter)로 변경되었습니다.
     - breaking change가 발생하여 예약 발송, 중복 수신번호 허용, appId를 사용하시던 사용자는 업데이트 후 코드를 변경하셔야 합니다.
     - send 메소드에서 messages 파라미터의 타입을 `Message | Array<Message>` 타입이 아닌 `MessageParameter | Array<MessageParameter>`로

src/models/kakao/kakaoAlimtalkTemplate.ts

@@ -1,7 +1,8 @@
-import {KakaoButton, KakaoButtonType} from './kakaoButton';
+import {KakaoButton} from './kakaoButton';
 import stringDateTransfer from '../../lib/stringDateTrasnfer';
 import {GetKakaoTemplateResponse} from '../../responses/kakao/getKakaoTemplateResponse';
 import {KakaoChannelCategory} from './kakaoChannel';
+import {KakaoAlimtalkTemplateQuickReply} from './kakaoAlimtalkTemplateQuickReply';
 
 /**
  * @description 카카오 채널 카테고리 타입
@@ -54,15 +55,6 @@ export type KakaoAlimtalkTemplateCommentType = {
   dateCreated: string;
 };
 
-export type KakaoAlimtalkTemplateQuickReplyType = {
-  name: string;
-  linkType: Omit<KakaoButtonType, 'AC' | 'DS' | 'MD'>;
-  linkMo?: string | null;
-  linkPc?: string | null;
-  linkAnd?: string | null;
-  linkIos?: string | null;
-};
-
 export type KakaoAlimtalkTemplateHighlightType = {
   title?: string | null;
   description?: string | null;
@@ -80,12 +72,6 @@ export type KakaoAlimtalkTemplateItemType = {
   };
 };
 
-/*
- memberId: { type: String, required: true },
-      isAdmin: { type: Boolean, default: false },
-      content: { type: String, default: null },
-      dateCreated: { type: Date, default: Date.now
-* */
 export interface KakaoAlimtalkTemplateInterface {
   /**
    * @description 템플릿 제목
@@ -175,7 +161,7 @@ export interface KakaoAlimtalkTemplateInterface {
   /**
    * 바로가기 연결(링크) 목록
    */
-  quickReplies?: Array<KakaoAlimtalkTemplateQuickReplyType>;
+  quickReplies?: Array<KakaoAlimtalkTemplateQuickReply>;
 
   /**
    * @description 아이템 리스트 용 헤더
@@ -233,7 +219,7 @@ export class KakaoAlimtalkTemplate implements KakaoAlimtalkTemplateInterface {
   imageId?: string | null;
   assignType?: KakaoAlimtalkTemplateAssignType;
   buttons?: KakaoButton[];
-  quickReplies?: KakaoAlimtalkTemplateQuickReplyType[];
+  quickReplies?: KakaoAlimtalkTemplateQuickReply[];
   header?: string | null;
   highlight?: KakaoAlimtalkTemplateHighlightType;
   item?: KakaoAlimtalkTemplateItemType;

src/models/kakao/kakaoAlimtalkTemplateQuickReply.ts

@@ -0,0 +1,33 @@
+import {KakaoButtonType} from './kakaoButton';
+
+export type KakaoAlimtalkTemplateQuickReplyWebLink = {
+  name: string;
+  linkType: Extract<KakaoButtonType, 'WL'>;
+  linkMo: string;
+  linkPc?: string;
+  linkAnd?: never;
+  linkIos?: never;
+};
+
+export type KakaoAlimtalkTemplateQuickReplyAppLink = {
+  name: string;
+  linkType: Extract<KakaoButtonType, 'AL'>;
+  linkMo?: never;
+  linkPc?: never;
+  linkAnd: string;
+  linkIos: string;
+};
+
+export type KakaoAlimtalkTemplateQuickReplyDefault = {
+  name: string;
+  linkType: Exclude<KakaoButtonType, 'AC' | 'DS' | 'MD' | 'AL' | 'WL'>;
+  linkMo?: never;
+  linkPc?: never;
+  linkAnd?: never;
+  linkIos?: never;
+};
+
+export type KakaoAlimtalkTemplateQuickReply =
+  | KakaoAlimtalkTemplateQuickReplyWebLink
+  | KakaoAlimtalkTemplateQuickReplyAppLink
+  | KakaoAlimtalkTemplateQuickReplyDefault;

src/requests/kakao/createKakaoAlimtalkTemplateRequest.ts

@@ -3,9 +3,9 @@ import {
   KakaoAlimtalkTemplateHighlightType,
   KakaoAlimtalkTemplateItemType,
   KakaoAlimtalkTemplateMessageType,
-  KakaoAlimtalkTemplateQuickReplyType,
 } from '../../models/kakao/kakaoAlimtalkTemplate';
 import {KakaoButton} from '../../models/kakao/kakaoButton';
+import {KakaoAlimtalkTemplateQuickReply} from '../../models/kakao/kakaoAlimtalkTemplateQuickReply';
 
 /**
  * @description 카카오 알림톡 템플릿 요청 타입
@@ -34,7 +34,7 @@ export type BaseKakaoAlimtalkTemplateRequest = {
   /**
    * @description 바로연결(버튼과 유사한 링크) 배열
    */
-  quickReplies?: Array<KakaoAlimtalkTemplateQuickReplyType>;
+  quickReplies?: Array<KakaoAlimtalkTemplateQuickReply>;
 
   /**
    * @description 알림톡 템플릿 메시지 유형

src/requests/kakao/updateKakaoAlimtalkTemplateRequest.ts

@@ -3,9 +3,9 @@ import {
   KakaoAlimtalkTemplateHighlightType,
   KakaoAlimtalkTemplateItemType,
   KakaoAlimtalkTemplateMessageType,
-  KakaoAlimtalkTemplateQuickReplyType,
 } from '../../models/kakao/kakaoAlimtalkTemplate';
 import {KakaoButton} from '../../models/kakao/kakaoButton';
+import {KakaoAlimtalkTemplateQuickReply} from '../../models/kakao/kakaoAlimtalkTemplateQuickReply';
 
 /**
  * @description 카카오 알림톡 템플릿 요청 타입
@@ -34,7 +34,7 @@ export type UpdateKakaoAlimtalkTemplateRequest = {
   /**
    * @description 바로연결(버튼과 유사한 링크) 배열
    */
-  quickReplies?: Array<KakaoAlimtalkTemplateQuickReplyType>;
+  quickReplies?: Array<KakaoAlimtalkTemplateQuickReply>;
 
   /**
    * @description 알림톡 템플릿 메시지 유형