@tosspayments/tosspayments-sdk 2.7.1 → 2.8.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tosspayments/tosspayments-sdk",
   "description": "TossPayments.js Tosspayments SDK.",
-  "version": "2.7.1",
+  "version": "2.8.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "types/index.d.ts",
@@ -19,12 +19,6 @@
     "url": "git+https://github.com/tosspayments/browser-sdk.git",
     "directory": "packages/tosspayments-sdk"
   },
-  "scripts": {
-    "build": "rm -rf dist && rollup -c",
-    "prepack": "yarn build",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit"
-  },
   "license": "MIT",
   "devDependencies": {
     "@babel/core": "^7.11.6",
@@ -33,8 +27,6 @@
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-typescript": "^8.3.0",
-    "@tosspayments/sdk-loader": "workspace:^",
-    "@tosspayments/standard-public-interfaces": "2.9.0",
     "happy-dom": "^14.12.3",
     "prettier": "^2.0.2",
     "rollup": "^2.60.0",
@@ -42,7 +34,8 @@
     "rollup-plugin-dts": "^6.1.1",
     "tslib": "^1.11.1",
     "typescript": "5.2.2",
-    "vitest": "^1.6.0"
+    "vitest": "^1.6.0",
+    "@tosspayments/sdk-loader": "^2.1.0"
   },
   "files": [
     "dist",
@@ -50,5 +43,10 @@
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf dist && rollup -c",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
   }
-}
+}

package/types/index.d.ts

@@ -1,5 +1,7 @@
 declare function clearTossPayments(): void;
 
+// standard-public-interfaces 2.17.1 — 자동 생성 파일입니다. 직접 수정하지 마세요.
+
 type WidgetSelectedPaymentMethod = {
     /**
      * 구매자가 결제 UI에서 선택한 결제수단입니다. 예를 들어, 신용・체크카드를 선택하면 `CARD` 코드가 응답됩니다. [ENUM 코드](/codes/enum-codes) 및 [기관 코드](/codes/org-codes)를 참고하세요.
@@ -173,6 +175,17 @@ interface WidgetPaymentRequest {
          * 페이북/ISP 앱에서 상점 앱으로 돌아올 때 사용됩니다. 상점의 앱 스킴을 지정하면 됩니다. 예를 들면 testapp://같은 형태입니다.
          */
         appScheme?: string | null;
+        /**
+         * 해외카드 결제의 3D Secure 인증 옵션입니다.
+         */
+        threeDS?: {
+            /**
+             * 3D Secure 인증에서 구매자에게 챌린지(추가 인증)를 요구할지 여부입니다.
+             * `CHALLENGE_REQUIRED`로 설정하면 챌린지 인증을 필수로 요청하고, 카드 발급사가 챌린지 없이 인증을 완료하면 인증을 거절하고 `failUrl`로 이동해요.
+             * 값을 설정하지 않으면 챌린지 여부를 카드 발급사 판단에 맡겨요.
+             */
+            challengeMode?: 'CHALLENGE_REQUIRED' | null;
+        } | null;
     } | null;
     /**
      * 구매자가 계좌이체를 선택하면 결제에 적용되는 옵션입니다.
@@ -447,23 +460,14 @@ interface WidgetPaymentWindow {
     /**
      * 결제창의 이벤트를 구독합니다.
      *
-     * @param {'paymentRequest'} eventName 구독할 이벤트입니다. `paymentRequest` 이벤트로 구매자의 결제 요청을 수신하세요.
+     * @param {'paymentRequest' | 'cancel'} eventName 구독할 이벤트입니다.
      * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
      *
-     * @example
-     *  ```javascript
-     *  paymentWindow.on('paymentRequest', ({ paymentMethod }) => {
-     *    // 결제 요청 처리
-     *  });
-     * ```
-     *
      * @throws {@link PublicError.Widgets.InvalidEventParameterError} eventName이 유효하지 않은 경우
      * @throws {@link PublicError.Widgets.InvalidCallbackParameterError} callback이 유효하지 않은 경우
      * @throws {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
      */
-    on: (eventName: 'paymentRequest', callback: (params: {
-        paymentMethod: WidgetSelectedPaymentMethod;
-    }) => Promise<void>) => void;
+    on: WidgetPaymentWindowOnPaymentRequest & WidgetPaymentWindowOnCancel;
     /**
      * 결제창을 제거합니다.
      *
@@ -476,6 +480,36 @@ interface WidgetPaymentWindow {
      */
     destroy: () => Promise<void>;
 }
+/**
+ * @docsAlias paymentRequest 이벤트
+ *
+ * @param {'paymentRequest'} eventName 구독할 이벤트입니다. `paymentRequest` 이벤트로 구매자의 결제 요청을 수신하세요.
+ * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
+ *
+ * @example
+ *  ```javascript
+ *  paymentWindow.on('paymentRequest', ({ paymentMethod }) => {
+ *    // 결제 요청 처리
+ *  });
+ * ```
+ */
+type WidgetPaymentWindowOnPaymentRequest = (eventName: 'paymentRequest', callback: (params: {
+    paymentMethod: WidgetSelectedPaymentMethod;
+}) => Promise<void>) => void;
+/**
+ * @docsAlias cancel 이벤트
+ *
+ * @param {'cancel'} eventName 구독할 이벤트입니다. `cancel` 이벤트로 구매자가 결제를 포기했는지 확인하세요. 구매자가 결제창을 닫으면 결제창이 사라진 뒤에 콜백이 호출돼요. `paymentWindow.destroy()`로 결제창을 닫은 경우에는 호출되지 않아요.
+ * @param {function} callback 이벤트가 일어나면 호출되는 콜백 함수입니다.
+ *
+ * @example
+ *  ```javascript
+ *  paymentWindow.on('cancel', async () => {
+ *    // 구매자가 결제를 포기했을 때 처리
+ *  });
+ * ```
+ */
+type WidgetPaymentWindowOnCancel = (eventName: 'cancel', callback: () => Promise<void>) => void;
 
 /**
  * 결제 UI 위젯을 렌더링합니다
@@ -839,6 +873,10 @@ interface BrandpayPaymentRequest {
      * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 2000자의 문자열입니다.
      */
     metadata?: Record<string | symbol | number, unknown> | null;
+    /**
+     * @ignore
+     */
+    shippingAddress?: string | null;
     /**
      * 구매자가 카드를 선택하면 결제에 적용되는 옵션입니다.
      */
@@ -861,6 +899,26 @@ interface BrandpayPaymentRequest {
          * [카드 프로모션 조회 API](https://docs.tosspayments.com/reference/brandpay#%EC%B9%B4%EB%93%9C-%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98-%EC%A1%B0%ED%9A%8C)로 적용할 수 있는 할인 코드의 목록을 조회할 수 있습니다.
          */
         discountCode?: string | null;
+        /**
+         * @ignore
+         */
+        affiliateCards?: Array<{
+            issuerCode: string;
+            cardProductCode: string;
+        }> | null;
+        /**
+         * @ignore
+         */
+        orderProductCode?: string | null;
+        /**
+         * @ignore
+         */
+        dividedSettlements?: Array<{
+            subMid: string;
+            amount: number;
+            taxFreeAmount: number;
+            productInfo: string;
+        }> | null;
     } | null;
     /**
      * 구매자가 계좌를 선택하면 결제에 적용되는 옵션입니다.
@@ -879,6 +937,19 @@ interface BrandpayPaymentRequest {
          * [계좌 프로모션 조회 API](https://docs.tosspayments.com/reference/brandpay#%EA%B3%84%EC%A2%8C-%ED%94%84%EB%A1%9C%EB%AA%A8%EC%85%98-%EC%A1%B0%ED%9A%8C)로 적용할 수 있는 할인 코드의 목록을 조회할 수 있습니다.
          */
         discountCode?: string | null;
+        /**
+         * @ignore
+         */
+        orderProductCode?: string | null;
+        /**
+         * @ignore
+         */
+        dividedSettlements?: Array<{
+            subMid: string;
+            amount: number;
+            taxFreeAmount: number;
+            productInfo: string;
+        }> | null;
     } | null;
 }
 interface BasicCashReceipt {
@@ -1140,6 +1211,21 @@ interface TossPaymentsBrandpay {
     requestBillingAuth: RequestBillingAuth$1;
 }
 
+/**
+ * 열려있는 결제창을 닫습니다.
+ *
+ * 진행 중인 `requestPayment()` Promise 가 `PaymentRequestAbortedError` 로 reject 됩니다.
+ *
+ * @throws {@link PublicError.Payment.NoActivePaymentRequestError} 진행 중인 결제 요청이 없는 경우
+ * @throws {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
+ *
+ * @example
+ * ```javascript
+ * await payment.destroy();
+ * ```
+ */
+type Destroy = () => Promise<void>;
+
 interface PaymentRequest {
     /**
      * 결제 금액 정보입니다.
@@ -1185,6 +1271,10 @@ interface PaymentRequest {
      * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 2000자의 문자열입니다.
      */
     metadata?: Record<string | symbol | number, unknown> | null;
+    /**
+     * @ignore
+     */
+    orderProductCode?: string | null;
     /**
      * @ignore
      */
@@ -1320,6 +1410,27 @@ interface CardPaymentRequest extends PaymentRequest {
          * 해외카드(Visa, MasterCard, JCB, UnionPay 등) 결제 여부입니다. `true`로 설정하면 해외카드 결제가 가능한 [다국어 결제창](/resources/glossary/payment-window#다국어-결제창)이 열립니다.
          */
         useInternationalCardOnly?: boolean | null;
+        /**
+         * 결제창 초기 언어입니다. `KO`(한국어), `EN`(영어), `JA`(일본어), `ZH`(중국어) 중 하나로 설정할 수 있어요.
+         * 값을 설정하지 않으면 결제 통화에 따라 자동으로 결정됩니다.
+         */
+        language?: 'KO' | 'EN' | 'JA' | 'ZH' | null;
+        /**
+         * 다국어 결제창에서 결제 금액 영역에 함께 표시되는 자국 통화 환산 추정 금액(예: `Estimated amount in USD $ 0.07`)의 노출 여부입니다.
+         * `false`로 설정하면 환산 추정 금액이 표시되지 않아요. 값을 설정하지 않으면 `true`로 동작하며, 다국어 결제창이 아닌 경우에는 적용되지 않습니다.
+         */
+        showEstimatedAmount?: boolean | null;
+        /**
+         * 해외카드 결제의 3D Secure 인증 옵션입니다.
+         */
+        threeDS?: {
+            /**
+             * 3D Secure 인증에서 구매자에게 챌린지(추가 인증)를 요구할지 여부입니다.
+             * `CHALLENGE_REQUIRED`로 설정하면 챌린지 인증을 필수로 요청하고, 카드 발급사가 챌린지 없이 인증을 완료하면 인증을 거절하고 `failUrl`로 이동해요.
+             * 값을 설정하지 않으면 챌린지 여부를 카드 발급사 판단에 맡겨요.
+             */
+            challengeMode?: 'CHALLENGE_REQUIRED' | null;
+        } | null;
         /**
          * 페이북/ISP 앱에서 상점 앱으로 돌아올 때 사용됩니다. 상점의 앱 스킴을 지정하면 됩니다. 예를 들면 testapp://같은 형태입니다.
          */
@@ -1333,6 +1444,27 @@ interface CardPaymentRequest extends PaymentRequest {
              */
             selectableCardTypes?: Array<'PERSONAL' | 'CORPORATE' | 'FOREIGN'> | null;
         } | null;
+        /**
+         * 모바일 결제창 상단 헤더의 노출 여부입니다. `false`로 설정하면 헤더가 표시되지 않아요.
+         * 값을 설정하지 않으면 `true`로 동작합니다.
+         */
+        showMobileAppHeader?: boolean | null;
+        /**
+         * @ignore
+         */
+        affiliateCards?: Array<{
+            issuerCode: string;
+            cardProductCode: string;
+        }> | null;
+        /**
+         * @ignore
+         */
+        dividedSettlements?: Array<{
+            subMid: string;
+            amount: number;
+            taxFreeAmount: number;
+            productInfo: string;
+        }> | null;
     } | null;
 }
 
@@ -1402,6 +1534,27 @@ interface VirtualAccountPaymentRequest extends PaymentRequest {
          * 문화비(도서, 공연 티켓, 박물관·미술관 입장권 등) 지출 여부입니다.
          */
         isCulturalExpenses?: boolean | null;
+        /**
+         * 결제창에 구매자 휴대폰 번호 입력란을 노출할지 여부입니다.
+         */
+        showCustomerMobilePhone?: boolean | null;
+        /**
+         * @ignore
+         */
+        refundReceiveAccount?: {
+            /**
+             * @ignore
+             */
+            bankCode: string;
+            /**
+             * @ignore
+             */
+            accountNumber: string;
+            /**
+             * @ignore
+             */
+            holderName: string;
+        } | null;
     } | null;
 }
 
@@ -1476,6 +1629,23 @@ interface TransferPaymentRequest extends PaymentRequest {
          * @ignore
          */
         encryptedCustomerCi?: string | null;
+        /**
+         * @ignore
+         */
+        showSecuritiesAccount?: boolean | null;
+        /**
+         * @ignore
+         */
+        provider?: 'OPENBANKING' | 'BANKPAY' | null;
+        /**
+         * @ignore
+         */
+        dividedSettlements?: Array<{
+            subMid: string;
+            amount: number;
+            taxFreeAmount: number;
+            productInfo: string;
+        }> | null;
     } | null;
 }
 
@@ -1484,6 +1654,18 @@ interface MobilePhonePaymentRequest extends PaymentRequest {
      * 결제수단입니다. `MOBILE_PHONE`으로 설정하면 휴대폰 결제창이 열려요.
      */
     method: 'MOBILE_PHONE';
+    /**
+     * 휴대폰 결제 정보입니다.
+     */
+    mobilePhone?: {
+        /**
+         * 휴대폰 결제창에서 선택할 수 있는 통신사를 제한합니다.
+         * `SKT`(SK텔레콤), `KT`(KT), `LGU`(LG유플러스), `HELLO`(LG헬로모바일), `KCT`(티플러스), `SK7`(SK세븐모바일) 값을 배열 형태로 전달할 수 있습니다.
+         * 예를 들어 `['KT', 'SKT']`로 설정하면 두 통신사만 선택할 수 있어요. 값을 설정하지 않으면 모든 통신사가 노출됩니다.
+         * 전체 목록은 [통신사 코드](https://docs.tosspayments.com/codes/org-codes#통신사-코드)에서 확인하세요.
+         */
+        mobileCarriers?: Array<'KT' | 'LGU' | 'SKT' | 'HELLO' | 'KCT' | 'SK7'> | null;
+    } | null;
 }
 
 interface GiftCertificatePaymentRequest extends PaymentRequest {
@@ -1699,6 +1881,7 @@ type BillingAuthRequest = CardBillingAuthRequest | TransferBillingAuthRequest;
 /**
  *
  * @throws {@link PublicError.Payment.UserCancelError} 사용자가 결제창을 닫은 경우
+ * @throws {@link PublicError.Payment.PaymentRequestAbortedError} `payment.destroy()` 호출로 결제 요청이 중단된 경우
  * @throws {@link PublicError.Payment.InvalidAmountValueError} 결제 금액이 유효하지 않은 경우
  * @throws {@link PublicError.Payment.InvalidAmountCurrencyError} 결제 금액의 통화가 유효하지 않은 경우
  * @throws {@link PublicError.Payment.BelowZeroAmountError} 결제 금액이 0원 미만인 경우
@@ -2073,6 +2256,7 @@ type RequestForeignEasyPayPaymentWithRedirection = (paymentRequest: WithRedirect
  * ```
  *
  * @throws {@link PublicError.Payment.UserCancelError} 사용자가 자동결제 인증창을 닫은 경우
+ * @throws {@link PublicError.Payment.PaymentRequestAbortedError} `payment.destroy()` 호출로 자동결제 인증 요청이 중단된 경우
  * @throws {@link PublicError.Payment.NotSupportedMethodError} 가맹점에서 정의되지 않은 method를 넘겨준 경우
  * @throws {@link PublicError.Payment.IncorrectSuccessUrlFormatError} 가맹점에서 유효하지 않은 successUrl을 넘겨준 경우
  * @throws {@link PublicError.Payment.IncorrectFailUrlFormatError} 가맹점에서 유효하지 않은 failUrl을 넘겨준 경우
@@ -2091,6 +2275,11 @@ interface TossPaymentsPayment {
      * 자동결제(빌링) 카드 등록창을 띄웁니다. [자세히 >](#paymentrequestbillingauth)
      */
     requestBillingAuth: RequestBillingAuth;
+    /**
+     * 현재 열려있는 결제창/인증창을 닫고 launcher 자원을 해제합니다.
+     * 열려있는 창이 없을 때 호출해도 안전합니다.
+     */
+    destroy: Destroy;
 }
 interface TossPaymentsSDK {
     /**
@@ -2190,6 +2379,15 @@ interface BrandpayInitParams {
      * \* 브랜드페이 메뉴에 두 개 이상의 리다이렉트 URL을 등록한 상점은 각 도메인에 맞는 `redirectUrl` 값을 필수로 추가하세요.
      */
     redirectUrl?: string;
+    /**
+     * @ignore
+     */
+    features?: {
+        cardOCR?: {
+            active: boolean;
+            autoStart?: boolean;
+        };
+    };
 }
 /**
  * @returns 아래 메서드를 호출할 수 있는 토스페이먼츠 객체를 반환합니다.
@@ -2211,6 +2409,15 @@ interface WidgetInitParams {
          * \* 브랜드페이 메뉴에 두 개 이상의 리다이렉트 URL을 등록한 상점은 각 도메인에 맞는 `redirectUrl` 값을 필수로 추가하세요.
          */
         redirectUrl?: string;
+        /**
+         * @ignore
+         */
+        features?: {
+            cardOCR?: {
+                active: boolean;
+                autoStart?: boolean;
+            };
+        };
     };
 }
 interface PaymentInitParams {