@tosspayments/tosspayments-sdk 2.2.4 → 2.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.3.0](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.2.4...@tosspayments/tosspayments-sdk@2.3.0) (2024-09-03)
+
+
+### Features
+
+* @tosspayments/standard-public-interfaces 버전업 ([#121](https://github.com/tosspayments/browser-sdk/issues/121)) ([985e51c](https://github.com/tosspayments/browser-sdk/commit/985e51c172248a68803cc28538aa3a609bda85ee))
+
+
+
+
+
 ## [2.2.4](https://github.com/tosspayments/browser-sdk/compare/@tosspayments/tosspayments-sdk@2.2.3...@tosspayments/tosspayments-sdk@2.2.4) (2024-07-23)
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tosspayments/tosspayments-sdk",
   "description": "TossPayments.js Tosspayments SDK.",
-  "version": "2.2.4",
+  "version": "2.3.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "types/index.d.ts",
@@ -21,7 +21,7 @@
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-typescript": "^8.3.0",
     "@tosspayments/sdk-loader": "2.0.1",
-    "@tosspayments/standard-public-interfaces": "2.0.7",
+    "@tosspayments/standard-public-interfaces": "2.0.17",
     "happy-dom": "^14.12.3",
     "prettier": "^2.0.2",
     "rollup": "^2.60.0",
@@ -38,5 +38,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9ddfc2f54498c25c9c7ffa621e933ab26fc3a8c"
+  "gitHead": "58f8d7998a1b5d0021a770173dff9b023907e3f8"
 }

package/types/index.d.ts

@@ -131,6 +131,10 @@ interface WidgetPaymentRequest {
      * 결제 금액 중 면세 금액입니다. 면세 상점 혹은 복합 과세 상점으로 계약된 상점만 사용하세요. 자세한 내용은 세금 처리 가이드에서 확인하세요.
      */
     taxFreeAmount?: number;
+    /**
+     * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 500자의 문자열입니다.
+     */
+    metadata?: Record<string | symbol | number, unknown> | null;
     /**
      * 구매자가 카드를 선택하면 결제에 적용되는 옵션입니다.
      */
@@ -416,6 +420,7 @@ type RenderAgreement = (params: {
 
 /**
  * 결제를 요청합니다
+ * @docsDefaultSignature RequestPaymentWithRedirection
  *
  * @param {WidgetPaymentRequest} paymentRequest - 결제 요청 정보입니다.
  *
@@ -437,6 +442,7 @@ type RenderAgreement = (params: {
  * @throws {@link PublicError.Widgets.NotSupportedPromiseError} promise 방식을 지원하지 않는 환경인 경우
  * @throws {@link PublicError.Widgets.CustomPaymentMethodUnableToPayError} 커스텀 결제수단이 선택된 상태에서 결제요청을 한 경우
  * @throws {@link PublicError.Widgets.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
+ * @throws {@link PublicError.Widgets.InvalidMetadataError} metadata가 올바르지 않은 경우
  * @throws {@link PublicError.Widgets.InvalidParametersError} 파라미터가 올바르지 않은 경우
  * @throws {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
  */
@@ -561,6 +567,10 @@ interface BrandpayPaymentRequest {
      * 결제 금액 중 면세 금액입니다. 면세 상점 혹은 복합 과세 상점으로 계약된 상점만 사용하세요. 자세한 내용은 세금 처리 가이드에서 확인하세요.
      */
     taxFreeAmount?: number;
+    /**
+     * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 500자의 문자열입니다.
+     */
+    metadata?: Record<string | symbol | number, unknown> | null;
 }
 
 interface BrandpayRequestPaymentResult {
@@ -580,6 +590,7 @@ interface BrandpayRequestPaymentResult {
 
 /**
  * 결제를 요청합니다
+ * @docsDefaultSignature RequestPaymentWithRedirection
  *
  * @param {WithRedirection<BrandpayPaymentRequest> | BrandpayPaymentRequest} paymentRequest - 결제 요청 정보
  *
@@ -592,6 +603,7 @@ interface BrandpayRequestPaymentResult {
  * @throws {@link PublicError.Brandpay.PaymentRequestFailError} 결제 요청에 실패한 경우
  * @throws {@link PublicError.Brandpay.NotRegisteredRedirectUrlError} redirectUrl이 등록되지 않은 경우
  * @throws {@link PublicError.Brandpay.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
+ * @throws {@link PublicError.Brandpay.InvalidMetadataError} metadata가 올바르지 않은 경우
  * @throws {@link PublicError.Brandpay.InvalidParametersError} 파라미터가 올바르지 않은 경우
  * @throws {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
  */
@@ -808,11 +820,15 @@ interface PaymentRequest {
      */
     taxFreeAmount?: number;
     /**
-     * 결제창이 열리는 프레임입니다.
-     * `iframe` 또는 현재 브라우저 화면(`self`)에서 결제창을 열 수 있어요. 기본 값은 `iframe`입니다.
-     * 모바일 웹에서는 `windowTarget` 값이 작동하지 않고 화면이 이동합니다.
+     * 브라우저에서 결제창이 열리는 프레임입니다. `self`, `iframe` 중 하나입니다.
+     * \- `self`는 현재 브라우저를 결제창으로 이동시켜요. 모바일 환경에서 기본 값입니다.
+     * \- `iframe`은 iframe에서 결제창이 열려요. PC 환경에서 기본 값입니다. **모바일 환경에서는 `iframe`을 사용할 수 없습니다.**
      */
     windowTarget?: 'iframe' | 'self';
+    /**
+     * 결제 관련 정보를 추가할 수 있는 객체입니다. 최대 5개의 키-값(key-value) 쌍을 자유롭게 추가해주세요. 키는 `[` , `]` 를 사용하지 않는 최대 40자의 문자열, 값은 최대 500자의 문자열입니다.
+     */
+    metadata?: Record<string | symbol | number, unknown> | null;
 }
 
 interface CardPaymentRequest extends PaymentRequest {
@@ -1205,9 +1221,9 @@ interface BillingAuthRequest {
      */
     customerEmail?: string;
     /**
-     * 결제창이 열리는 프레임입니다.
-     * `iframe` 또는 현재 브라우저 화면(`self`)에서 등록창을 열 수 있어요. 기본 값은 `iframe`입니다.
-     * 모바일 웹에서는 `windowTarget` 값이 작동하지 않고 화면이 이동합니다.
+     * 브라우저에서 결제창이 열리는 프레임입니다. `self`, `iframe` 중 하나입니다.
+     * \- `self`는 현재 브라우저를 결제창으로 이동시켜요. 모바일 환경에서 기본 값입니다.
+     * \- `iframe`은 iframe에서 결제창이 열려요. PC 환경에서 기본 값입니다. **모바일 환경에서는 `iframe`을 사용할 수 없습니다.**
      *
      * @default 'iframe'
      */
@@ -1226,6 +1242,7 @@ interface BillingAuthRequest {
  * @throws {@link PublicError.Payment.IncorrectFailUrlFormatError} 가맹점에서 유효하지 않은 failUrl을 넘겨준 경우
  * @throws {@link PublicError.Payment.PaymentRequestFailError} 결제에 실패한 경우
  * @throws {@link PublicError.Payment.InvalidMethodTransactionError} 이미 다른 명령을 수행 중인 경우
+ * @throws {@link PublicError.Payment.InvalidMetadataError} metadata가 올바르지 않은 경우
  * @throws {@link PublicError.Payment.InvalidParametersError} 파라미터가 올바르지 않은 경우
  * @throws {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
  */
@@ -1619,12 +1636,8 @@ type RequestForeignEasyPayPaymentWithRedirection = (paymentRequest: WithRedirect
  * ```javascript
  * payment.requestBillingAuth({
  *   method: 'CARD',
- *   amount: {
- *     currency: 'KRW',
- *     value: 50000,
- *   },
- *   successUrl: window.location.origin + '/payment/billing.html',
- *   failUrl: window.location.origin + '/fail.html',
+ *   successUrl: window.location.origin + '/payment/billing',
+ *   failUrl: window.location.origin + '/fail',
  *   customerEmail: 'customer123@gmail.com',
  *   customerName: '김토스',
  * });
@@ -1657,7 +1670,7 @@ interface TossPaymentsSDK {
      *
      * @throw {@link PublicError.Widgets.InvalidClientKeyError} clientKey가 올바르지 않은 경우
      * @throw {@link PublicError.Widgets.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
-     * @throw {@link PublicError.Widgets.WidgetsSDKInitializeConflictError} widgets SDK 초기화 중 충돌이 발생한 경우
+     * @throw {@link PublicError.Widgets.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
      * @throw {@link PublicError.Widgets.UnknownError} 알 수 없는 오류가 발생한 경우
      * @returns 아래 메서드를 호출할 수 있는 결제위젯 객체를 반환합니다.
      * @example
@@ -1681,7 +1694,7 @@ interface TossPaymentsSDK {
      *
      * @throw {@link PublicError.Brandpay.InvalidClientKeyError} clientKey가 올바르지 않은 경우
      * @throw {@link PublicError.Brandpay.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
-     * @throw {@link PublicError.Brandpay.BrandpaySDKInitializeConflictError} 브랜드페이 SDK 초기화 중 충돌이 발생한 경우
+     * @throw {@link PublicError.Brandpay.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
      * @throw {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
      * @example
      * ```javascript
@@ -1700,8 +1713,8 @@ interface TossPaymentsSDK {
      *
      * @throw {@link PublicError.Payment.InvalidClientKeyError} clientKey가 올바르지 않은 경우
      * @throw {@link PublicError.Payment.InvalidCustomerKeyError} customerKey가 올바르지 않은 경우
-     * @throw {@link PublicError.Payment.PaymentSDKInitializeConflictError} payment SDK 초기화 중 충돌이 발생한 경우
-     * @throw {@link PublicError.Brandpay.UnknownError} 알 수 없는 오류가 발생한 경우
+     * @throw {@link PublicError.Payment.InsecureKeyUsageError} customerKey에 시크릿키를 사용한 경우
+     * @throw {@link PublicError.Payment.UnknownError} 알 수 없는 오류가 발생한 경우
      * @example
      * ```javascript
      * const payment = tossPayments.payment({ customerKey });
@@ -1716,7 +1729,8 @@ interface TossPaymentsSDK {
  * @example
  * ```javascript
  * // 스크립트 태그 연동방식
- * const tossPayments = TossPayments("<WidgetClientKey />");
+ * const tossPayments = TossPayments("<WidgetClientKey />"); // 결제위젯 연동 키
+ * const tossPayments = TossPayments("<ClientKey />");  // API 개별 연동 키
  *
  * // 모듈 임포트 연동방식
  * import { loadTossPayments } from "@tosspayments/tosspayments-sdk"
@@ -1725,7 +1739,7 @@ interface TossPaymentsSDK {
  *
  * @param {string} clientKey 토스페이먼츠 발급하는 클라이언트 키입니다. 개발자센터의 [API 키 메뉴](https://developers.tosspayments.com/my/api-keys)에서 확인할 수 있어요.
  *
- * 결제위젯을 연동한다면 [결제위젯 연동 키](/reference/using-api/api-keys#결제위젯-연동-키)를 사용하세요. 결제창, 자동결제(빌링)을 연동한다면 [API 개별 연동 키](/reference/using-api/api-keys#api-개별-연동-키)를 사용하세요.
+ * 결제위젯을 연동한다면 [결제위젯 연동 키](/reference/using-api/api-keys#결제위젯-연동-키)를 사용하세요. 브랜드페이, 결제창, 자동결제(빌링)를 연동한다면 [API 개별 연동 키](/reference/using-api/api-keys#api-개별-연동-키)를 사용하세요.
  *
  * @returns
  * 아래 메서드를 호출할 수 있는 토스페이먼츠 객체를 반환합니다.