connectbase-client 5.2.0 → 5.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -5534,6 +5534,26 @@ interface PreparePaymentRequest {
5534
5534
  * `discount_code_entry_unsupported` 로 거절된다.
5535
5535
  */
5536
5536
  allow_discount_code?: boolean;
5537
+ /**
5538
+ * 결제를 마친 고객이 돌아올 주소(선택).
5539
+ *
5540
+ * 미지정이면 콘솔 결제 설정의 success_url, 그것도 비어 있으면 **PG 대시보드의 브랜드 주소**로
5541
+ * 돌아갑니다. 그 페이지가 결제 복귀를 처리하지 않으면 "결제는 완료됐는데 권한이 지급되지 않는"
5542
+ * 상태가 됩니다.
5543
+ *
5544
+ * 요청 단위라 QA/프로덕션/미리보기 배포가 각자 자기 호스트로 복귀할 수 있습니다 — 앱 단위
5545
+ * success_url 하나로는 두 환경을 동시에 가리킬 수 없습니다.
5546
+ *
5547
+ * **앱이 소유한 origin 만 허용됩니다**: 웹 스토리지 호스트(production 과 `--qa` 미러),
5548
+ * 연결된 커스텀 도메인, 결제 설정의 success_url/fail_url origin, (로컬 개발을 켠 앱이면)
5549
+ * localhost. 그 외는 400 `return_url_not_allowed`, 형식 오류는 400 `return_url_invalid`.
5550
+ */
5551
+ return_url?: string;
5552
+ /**
5553
+ * 결제 실패/취소 시 복귀 주소(선택). 검증 규칙과 폴백은 `return_url` 과 같습니다
5554
+ * (미지정 시 결제 설정의 fail_url).
5555
+ */
5556
+ fail_url?: string;
5537
5557
  amount: number;
5538
5558
  order_name: string;
5539
5559
  order_id?: string;
@@ -5567,6 +5587,11 @@ interface PreparePaymentResponse {
5567
5587
  launch_mode?: "overlay" | "redirect";
5568
5588
  }
5569
5589
  interface CreateCheckoutSessionRequest {
5590
+ /**
5591
+ * 사용할 자격증명 모드 오버라이드(선택). `prepare()` 의 `payment_mode` 와 적용 조건이 같다 —
5592
+ * 서버 시크릿 키(`cb_sk_*`) 호출에서만 적용되고, 브라우저 공개 키 호출에서는 무시된다.
5593
+ */
5594
+ payment_mode?: PaymentMode;
5570
5595
  amount: number;
5571
5596
  currency: string;
5572
5597
  product_name: string;
@@ -5762,6 +5787,14 @@ declare class PaymentAPI {
5762
5787
  * })
5763
5788
  * // 확정 후 confirm 응답의 amount 는 할인이 반영된 실제 청구액,
5764
5789
  * // discount_amount 는 차감분이다.
5790
+ *
5791
+ * // 복귀 주소 — 배포마다 자기 호스트로 돌아오게 한다 (QA 가 라이브로 튕기지 않도록)
5792
+ * const withReturn = await cb.payment.prepare({
5793
+ * amount: 14900,
5794
+ * order_name: '프리미엄 1개월',
5795
+ * return_url: `${window.location.origin}/app/premium?paid=1`,
5796
+ * fail_url: `${window.location.origin}/app/premium?failed=1`,
5797
+ * })
5765
5798
  * ```
5766
5799
  *
5767
5800
  * @remarks
@@ -5769,6 +5802,11 @@ declare class PaymentAPI {
5769
5802
  *
5770
5803
  * 할인 코드는 MoR 프로바이더(dodo/paddle)에서만 지원됩니다. 그 외 프로바이더에 넘기면
5771
5804
  * 정가로 조용히 청구되지 않고 400 `discount_code_unsupported` 로 거절됩니다.
5805
+ *
5806
+ * `return_url`/`fail_url` 을 생략하면 콘솔 결제 설정의 success_url/fail_url 을 쓰고, 그것도
5807
+ * 비어 있으면 **PG 대시보드의 브랜드 주소**로 복귀합니다 — 그 페이지가 결제 복귀를 처리하지
5808
+ * 않으면 결제는 완료되지만 권한이 지급되지 않습니다. 앱이 소유한 origin 만 허용되며,
5809
+ * 그 외는 400 `return_url_not_allowed` 입니다.
5772
5810
  */
5773
5811
  prepare(data: PreparePaymentRequest): Promise<PreparePaymentResponse>;
5774
5812
  /**
@@ -7721,6 +7759,20 @@ type SubscriptionStatus = "active" | "paused" | "canceled" | "past_due" | "expir
7721
7759
  interface CreateSubscriptionRequest {
7722
7760
  /** 빌링키 ID (toss/stripe 필수, payapp 미사용 — payurl 모델) */
7723
7761
  billing_key_id?: string;
7762
+ /**
7763
+ * 구독 ID 를 직접 지정한다(선택). 미지정이면 서버가 `sub_<uuid>` 로 생성한다.
7764
+ *
7765
+ * 재시도 시 같은 값을 넘기면 최초 청구 orderID 가 결정적으로 만들어져 이중청구를 막는다 —
7766
+ * 네트워크 실패로 create 를 다시 호출해야 할 때 쓴다.
7767
+ */
7768
+ subscription_id?: string;
7769
+ /**
7770
+ * true 면 구독 생성 즉시 1회차를 청구한다(빌링키 모델). false(기본)면 다음 결제일부터 청구.
7771
+ * `trial_days` 가 있으면 즉시 청구하지 않는다(체험 종료 후 첫 청구).
7772
+ *
7773
+ * MoR(paddle/dodo)은 결제창에서 1회차를 받으므로 이 값을 쓰지 않는다.
7774
+ */
7775
+ start_now?: boolean;
7724
7776
  /** 플랜 이름 */
7725
7777
  plan_name: string;
7726
7778
  /** 플랜 설명 */
@@ -7758,6 +7810,14 @@ interface CreateSubscriptionRequest {
7758
7810
  * `discount_code_entry_unsupported` 로 거절된다.
7759
7811
  */
7760
7812
  allow_discount_code?: boolean;
7813
+ /**
7814
+ * 결제창을 마친 고객이 돌아올 주소(선택, 리다이렉트형 MoR).
7815
+ *
7816
+ * 미지정이면 결제 설정의 success_url, 그것도 비면 PG 대시보드의 브랜드 주소로 갑니다.
7817
+ * 앱이 소유한 origin 만 허용되며(검증 규칙은 `payment.prepare()` 와 동일),
7818
+ * 그 외는 400 `return_url_not_allowed` 입니다.
7819
+ */
7820
+ return_url?: string;
7761
7821
  /** 고객 이메일 */
7762
7822
  customer_email?: string;
7763
7823
  /** 고객 이름 */
package/dist/index.d.ts CHANGED
@@ -5534,6 +5534,26 @@ interface PreparePaymentRequest {
5534
5534
  * `discount_code_entry_unsupported` 로 거절된다.
5535
5535
  */
5536
5536
  allow_discount_code?: boolean;
5537
+ /**
5538
+ * 결제를 마친 고객이 돌아올 주소(선택).
5539
+ *
5540
+ * 미지정이면 콘솔 결제 설정의 success_url, 그것도 비어 있으면 **PG 대시보드의 브랜드 주소**로
5541
+ * 돌아갑니다. 그 페이지가 결제 복귀를 처리하지 않으면 "결제는 완료됐는데 권한이 지급되지 않는"
5542
+ * 상태가 됩니다.
5543
+ *
5544
+ * 요청 단위라 QA/프로덕션/미리보기 배포가 각자 자기 호스트로 복귀할 수 있습니다 — 앱 단위
5545
+ * success_url 하나로는 두 환경을 동시에 가리킬 수 없습니다.
5546
+ *
5547
+ * **앱이 소유한 origin 만 허용됩니다**: 웹 스토리지 호스트(production 과 `--qa` 미러),
5548
+ * 연결된 커스텀 도메인, 결제 설정의 success_url/fail_url origin, (로컬 개발을 켠 앱이면)
5549
+ * localhost. 그 외는 400 `return_url_not_allowed`, 형식 오류는 400 `return_url_invalid`.
5550
+ */
5551
+ return_url?: string;
5552
+ /**
5553
+ * 결제 실패/취소 시 복귀 주소(선택). 검증 규칙과 폴백은 `return_url` 과 같습니다
5554
+ * (미지정 시 결제 설정의 fail_url).
5555
+ */
5556
+ fail_url?: string;
5537
5557
  amount: number;
5538
5558
  order_name: string;
5539
5559
  order_id?: string;
@@ -5567,6 +5587,11 @@ interface PreparePaymentResponse {
5567
5587
  launch_mode?: "overlay" | "redirect";
5568
5588
  }
5569
5589
  interface CreateCheckoutSessionRequest {
5590
+ /**
5591
+ * 사용할 자격증명 모드 오버라이드(선택). `prepare()` 의 `payment_mode` 와 적용 조건이 같다 —
5592
+ * 서버 시크릿 키(`cb_sk_*`) 호출에서만 적용되고, 브라우저 공개 키 호출에서는 무시된다.
5593
+ */
5594
+ payment_mode?: PaymentMode;
5570
5595
  amount: number;
5571
5596
  currency: string;
5572
5597
  product_name: string;
@@ -5762,6 +5787,14 @@ declare class PaymentAPI {
5762
5787
  * })
5763
5788
  * // 확정 후 confirm 응답의 amount 는 할인이 반영된 실제 청구액,
5764
5789
  * // discount_amount 는 차감분이다.
5790
+ *
5791
+ * // 복귀 주소 — 배포마다 자기 호스트로 돌아오게 한다 (QA 가 라이브로 튕기지 않도록)
5792
+ * const withReturn = await cb.payment.prepare({
5793
+ * amount: 14900,
5794
+ * order_name: '프리미엄 1개월',
5795
+ * return_url: `${window.location.origin}/app/premium?paid=1`,
5796
+ * fail_url: `${window.location.origin}/app/premium?failed=1`,
5797
+ * })
5765
5798
  * ```
5766
5799
  *
5767
5800
  * @remarks
@@ -5769,6 +5802,11 @@ declare class PaymentAPI {
5769
5802
  *
5770
5803
  * 할인 코드는 MoR 프로바이더(dodo/paddle)에서만 지원됩니다. 그 외 프로바이더에 넘기면
5771
5804
  * 정가로 조용히 청구되지 않고 400 `discount_code_unsupported` 로 거절됩니다.
5805
+ *
5806
+ * `return_url`/`fail_url` 을 생략하면 콘솔 결제 설정의 success_url/fail_url 을 쓰고, 그것도
5807
+ * 비어 있으면 **PG 대시보드의 브랜드 주소**로 복귀합니다 — 그 페이지가 결제 복귀를 처리하지
5808
+ * 않으면 결제는 완료되지만 권한이 지급되지 않습니다. 앱이 소유한 origin 만 허용되며,
5809
+ * 그 외는 400 `return_url_not_allowed` 입니다.
5772
5810
  */
5773
5811
  prepare(data: PreparePaymentRequest): Promise<PreparePaymentResponse>;
5774
5812
  /**
@@ -7721,6 +7759,20 @@ type SubscriptionStatus = "active" | "paused" | "canceled" | "past_due" | "expir
7721
7759
  interface CreateSubscriptionRequest {
7722
7760
  /** 빌링키 ID (toss/stripe 필수, payapp 미사용 — payurl 모델) */
7723
7761
  billing_key_id?: string;
7762
+ /**
7763
+ * 구독 ID 를 직접 지정한다(선택). 미지정이면 서버가 `sub_<uuid>` 로 생성한다.
7764
+ *
7765
+ * 재시도 시 같은 값을 넘기면 최초 청구 orderID 가 결정적으로 만들어져 이중청구를 막는다 —
7766
+ * 네트워크 실패로 create 를 다시 호출해야 할 때 쓴다.
7767
+ */
7768
+ subscription_id?: string;
7769
+ /**
7770
+ * true 면 구독 생성 즉시 1회차를 청구한다(빌링키 모델). false(기본)면 다음 결제일부터 청구.
7771
+ * `trial_days` 가 있으면 즉시 청구하지 않는다(체험 종료 후 첫 청구).
7772
+ *
7773
+ * MoR(paddle/dodo)은 결제창에서 1회차를 받으므로 이 값을 쓰지 않는다.
7774
+ */
7775
+ start_now?: boolean;
7724
7776
  /** 플랜 이름 */
7725
7777
  plan_name: string;
7726
7778
  /** 플랜 설명 */
@@ -7758,6 +7810,14 @@ interface CreateSubscriptionRequest {
7758
7810
  * `discount_code_entry_unsupported` 로 거절된다.
7759
7811
  */
7760
7812
  allow_discount_code?: boolean;
7813
+ /**
7814
+ * 결제창을 마친 고객이 돌아올 주소(선택, 리다이렉트형 MoR).
7815
+ *
7816
+ * 미지정이면 결제 설정의 success_url, 그것도 비면 PG 대시보드의 브랜드 주소로 갑니다.
7817
+ * 앱이 소유한 origin 만 허용되며(검증 규칙은 `payment.prepare()` 와 동일),
7818
+ * 그 외는 400 `return_url_not_allowed` 입니다.
7819
+ */
7820
+ return_url?: string;
7761
7821
  /** 고객 이메일 */
7762
7822
  customer_email?: string;
7763
7823
  /** 고객 이름 */
package/dist/index.js CHANGED
@@ -6148,6 +6148,14 @@ var PaymentAPI = class {
6148
6148
  * })
6149
6149
  * // 확정 후 confirm 응답의 amount 는 할인이 반영된 실제 청구액,
6150
6150
  * // discount_amount 는 차감분이다.
6151
+ *
6152
+ * // 복귀 주소 — 배포마다 자기 호스트로 돌아오게 한다 (QA 가 라이브로 튕기지 않도록)
6153
+ * const withReturn = await cb.payment.prepare({
6154
+ * amount: 14900,
6155
+ * order_name: '프리미엄 1개월',
6156
+ * return_url: `${window.location.origin}/app/premium?paid=1`,
6157
+ * fail_url: `${window.location.origin}/app/premium?failed=1`,
6158
+ * })
6151
6159
  * ```
6152
6160
  *
6153
6161
  * @remarks
@@ -6155,6 +6163,11 @@ var PaymentAPI = class {
6155
6163
  *
6156
6164
  * 할인 코드는 MoR 프로바이더(dodo/paddle)에서만 지원됩니다. 그 외 프로바이더에 넘기면
6157
6165
  * 정가로 조용히 청구되지 않고 400 `discount_code_unsupported` 로 거절됩니다.
6166
+ *
6167
+ * `return_url`/`fail_url` 을 생략하면 콘솔 결제 설정의 success_url/fail_url 을 쓰고, 그것도
6168
+ * 비어 있으면 **PG 대시보드의 브랜드 주소**로 복귀합니다 — 그 페이지가 결제 복귀를 처리하지
6169
+ * 않으면 결제는 완료되지만 권한이 지급되지 않습니다. 앱이 소유한 origin 만 허용되며,
6170
+ * 그 외는 400 `return_url_not_allowed` 입니다.
6158
6171
  */
6159
6172
  async prepare(data) {
6160
6173
  const prefix = this.getPublicPrefix();
package/dist/index.mjs CHANGED
@@ -6099,6 +6099,14 @@ var PaymentAPI = class {
6099
6099
  * })
6100
6100
  * // 확정 후 confirm 응답의 amount 는 할인이 반영된 실제 청구액,
6101
6101
  * // discount_amount 는 차감분이다.
6102
+ *
6103
+ * // 복귀 주소 — 배포마다 자기 호스트로 돌아오게 한다 (QA 가 라이브로 튕기지 않도록)
6104
+ * const withReturn = await cb.payment.prepare({
6105
+ * amount: 14900,
6106
+ * order_name: '프리미엄 1개월',
6107
+ * return_url: `${window.location.origin}/app/premium?paid=1`,
6108
+ * fail_url: `${window.location.origin}/app/premium?failed=1`,
6109
+ * })
6102
6110
  * ```
6103
6111
  *
6104
6112
  * @remarks
@@ -6106,6 +6114,11 @@ var PaymentAPI = class {
6106
6114
  *
6107
6115
  * 할인 코드는 MoR 프로바이더(dodo/paddle)에서만 지원됩니다. 그 외 프로바이더에 넘기면
6108
6116
  * 정가로 조용히 청구되지 않고 400 `discount_code_unsupported` 로 거절됩니다.
6117
+ *
6118
+ * `return_url`/`fail_url` 을 생략하면 콘솔 결제 설정의 success_url/fail_url 을 쓰고, 그것도
6119
+ * 비어 있으면 **PG 대시보드의 브랜드 주소**로 복귀합니다 — 그 페이지가 결제 복귀를 처리하지
6120
+ * 않으면 결제는 완료되지만 권한이 지급되지 않습니다. 앱이 소유한 origin 만 허용되며,
6121
+ * 그 외는 400 `return_url_not_allowed` 입니다.
6109
6122
  */
6110
6123
  async prepare(data) {
6111
6124
  const prefix = this.getPublicPrefix();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "connectbase-client",
3
- "version": "5.2.0",
3
+ "version": "5.3.1",
4
4
  "description": "Connect Base JavaScript/TypeScript SDK for browser and Node.js",
5
5
  "repository": {
6
6
  "type": "git",