@danalpay/javascript-sdk 1.0.4 → 1.1.0

package/README.md

@@ -1,6 +1,7 @@
 # Danal SDK
 
-다날 결제창 연동을 위한 JavaScript SDK 입니다.
+다날(Danal) 결제창을 웹 서비스에 쉽게 연동할 수 있도록 제공되는 공식 JavaScript SDK입니다.  
+일반결제, 빌링(정기결제) 등 다날 결제 플로우를 안전하고 간편하게 구현할 수 있습니다.
 
 ---
 
@@ -27,11 +28,7 @@ const danal = await loadDanalPaymentsSDK({ clientKey: "YOUR_KEY" });
 await danal.requestPayment({...});
 ```
 
-## TypeScript
-
-TypeScript 타입 정의 파일(.d.ts)을 포함하고 있어, 타입 안전성과 자동완성을 지원합니다.
-
-## OUR Site
+## Our Site
 
 더 자세한 가이드 문서, API 레퍼런스, 샘플 코드는 개발자 사이트에서 확인하세요.<br/>
 [➡️ Danal 개발자 사이트](https://developers.danalpay.com)

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 type Paymethod = 'CARD' | 'NAVERPAY' | 'KAKAOPAY' | 'PAYCO' | 'MOBILE' | 'TRANSFER' | 'VACCOUNT' | 'CULTURELAND' | 'BOOK_AND_LIFE' | 'INTEGRATED';
+type BillingMethod = 'CARD_BILLING';
 
 /** PayMethod를 `CARD`로 설정하면 카드/간편결제 통합결제창, 카드・간편결제 자체창을 사용할 수 있어요. */
 type CardPaymentsRequest = {
@@ -74,9 +75,84 @@ type IntegratedPaymetnsRequest = {
     }>;
 };
 
-type CommonBaseParams = {
+/**
+ * PayMethod를 `CARD_BILLING`으로 설정하면
+ * 카드 자동결제(정기결제) 등록창을 호출할 수 있습니다.
+ */
+type CardBillingRequest = {
+    /**
+     * 정기결제 등록 화면에 노출되는 상단 문구 타입입니다.
+     *
+     * - '00' : 정기결제를 등록합니다 (기본 값)
+     * - '01' : 간편결제를 등록합니다
+     * - '02' : 자동결제를 등록합니다
+     *
+     * 미지정 시 기본 문구가 노출됩니다.
+     */
+    title?: '00' | '01' | '02';
+    /**
+     * 제공 기간 또는 이용 기간을 표시하는 문장입니다.
+     *
+     * 예:
+     * - "2026.12.01 - 2027.12.31"
+     * - "30일 무료 체험 후 자동결제"
+     * - "익월 10일 자동결제"
+     *
+     */
+    offerPeriod?: string;
+    /**
+     * 카드 등록과 동시에 인증(결제)를 수행할지 여부입니다.
+     *
+     * - true  : 인증(결제) 후 카드 등록
+     * - false : 인증(결제)없이 카드 등록
+     *
+     * 기본값은 false 입니다.
+     */
+    authOnly?: boolean;
+    /**
+     * 등록 화면에서 결제 금액 노출 여부를 설정합니다.
+     *
+     * - true  : 결제 금액 숨김
+     * - false : 결제 금액 노출
+     *
+     * 기본값은 false 입니다.
+     * 결제 금액 숨김(true)은 `authOnly` 값이 true일 때만 사용할 수 있습니다.
+     */
+    hideAmount?: boolean;
+    /**
+     * 카드 소유주 정보입니다.
+     *
+     * type에 따라 value 형식이 달라질 수 있습니다.
+     */
+    cardOwner?: {
+        /**
+         * 카드 소유주 유형
+         *
+         * - PERSONAL : 개인카드
+         * - BUSINESS : 법인카드
+         */
+        type: 'PERSONAL' | 'BUSINESS';
+        /**
+         * 카드 소유주 식별 값
+         *
+         * - PERSONAL : 주민등록번호(앞 6자리)
+         * - BUSINESS : 사업자등록번호(10자리)
+         */
+        value: string;
+    };
+    /**
+     * 결제자 휴대폰 번호입니다.
+     *
+     * 숫자만 입력하며, 하이픈(-)은 제외합니다.
+     *
+     * 예: "01012345678"
+     */
+    userPhoneNumber?: string;
+};
+
+type CommonBaseParams<T> = {
     /** 결제수단입니다. 결제수단을 구분하는 값입니다. */
-    paymentsMethod: Paymethod;
+    paymentsMethod: T;
     /** 상품명입니다. */
     orderName: string;
     /** 가맹점 주문번호입니다. */
@@ -93,6 +169,8 @@ type CommonBaseParams = {
     failUrl: string;
     /** 사용자 이메일입니다. */
     userEmail?: string;
+    /** 사용자 이름입니다. */
+    userName?: string;
 };
 
 type OptionParams = {
@@ -111,11 +189,18 @@ type PaymentRequestMap = {
     PAYCO: Omit<CardPaymentsRequest, 'cardCodes'>;
     INTEGRATED: IntegratedPaymetnsRequest;
 };
-type RequestPaymentParam<T extends keyof PaymentRequestMap> = CommonBaseParams & OptionParams & PaymentRequestMap[T];
+type BillingRequestMap = {
+    CARD_BILLING: CardBillingRequest;
+};
+type RequestPaymentParam<T extends keyof PaymentRequestMap> = CommonBaseParams<Paymethod> & OptionParams & PaymentRequestMap[T];
+type RequestBillingParam<T extends keyof BillingRequestMap> = CommonBaseParams<BillingMethod> & OptionParams & BillingRequestMap[T];
 interface DanalPayments {
     requestPayment<T extends Paymethod>(args: {
         paymentsMethod: T;
     } & RequestPaymentParam<T>): Promise<void>;
+    requestBilling<T extends BillingMethod>(args: {
+        paymentsMethod: T;
+    } & RequestBillingParam<T>): Promise<void>;
 }
 type InitialParams = {
     clientKey: string;
@@ -129,4 +214,4 @@ declare function loadDanalPaymentsSDK(params: InitialParams, scriptOption?: Part
 declare const loadDanalPayemntsSDK: typeof loadDanalPaymentsSDK;
 
 export { loadDanalPayemntsSDK, loadDanalPaymentsSDK };
-export type { DanalPayments, Paymethod, RequestPaymentParam };
+export type { BillingMethod as BillingMethodType, Paymethod as PaymethodType, RequestBillingParam as RequestBillingParamType, RequestPaymentParam as RequestPaymentParamType };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@danalpay/javascript-sdk",
   "description": "Danal ONE API javascript SDK",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",