@bootpay/client-js 5.3.1 → 5.5.0

package/dist/src/bootpay.d.ts

@@ -1,4 +1,4 @@
-import { BootpayAnalyticsModel, BootpayAnalyticsUserModel, RequestAuthenticationModel, RequestPaymentModel, RequestPaymentUrlModel, RequestSubscriptionModel } from './types/bootpay-interface';
+import { BootpayAnalyticsModel, BootpayAnalyticsUserModel, OnboardingResultModel, RequestAuthenticationModel, RequestOnboardingModel, RequestPaymentModel, RequestPaymentUrlModel, RequestSubscriptionModel } from './types/bootpay-interface';
 import { EnvironmentInterface } from './support/environment';
 import { BootpayRequestPaymentManager } from './lib/bootpay';
 import { BootpayAnalyticsManager } from './lib/analytics';
@@ -11,6 +11,7 @@ export interface BootpayInterface {
     requestSubscription(data: RequestSubscriptionModel): Promise<any>;
     requestAuthentication(data: RequestAuthenticationModel): Promise<any>;
     requestPaymentUrl(data: RequestPaymentUrlModel): Promise<any>;
+    requestOnboarding(data: RequestOnboardingModel): Promise<OnboardingResultModel>;
     confirm(): Promise<any>;
     errorHandler(data: any): any;
     setEnvironmentMode(env: 'development' | 'stage' | 'production', hostname?: string | undefined | null): void;

package/dist/src/lib/event/onboarding.d.ts

@@ -0,0 +1,17 @@
+import { BootpayWindowEvent } from '../../vendor/mixins/event';
+import { OnboardingResultModel } from '../../types/bootpay-interface';
+
+/**
+ * 리셀러 등록 폼(PG 신청 화면) 결과 메시지 — Bootpay.requestOnboarding 전용
+ * 신청 화면은 JSON 문자열 { bootpay_event: true, event: 'done' | 'cancel', id, kind, pg_wait_id, status } 를 보낸다.
+ * 결과는 리셀러 화면 상태를 바꾸므로 기존 리스너와 달리 origin 을 확인한다 — 신청 화면 origin 에서,
+ * 이 SDK 가 연 창(popup · iframe)이 보낸 메시지만 받는다.
+ * 토큰 · 결과는 로그나 분석 이벤트로 보내지 않는다.
+ * @date: 26-10-27
+ */
+export declare class BootpayOnboardingEventManager extends BootpayWindowEvent {
+    $messageEventName: string;
+    constructor();
+    bindOnboarding(allowedOrigin: string, expectedSource: () => Window | null, onDone: (result: OnboardingResultModel) => void, onCancel: () => void): void;
+    unbind(): void;
+}

package/dist/src/lib/template/onboarding.d.ts

@@ -0,0 +1,40 @@
+import { TemplateManager } from '../../vendor/mixins/template-manager';
+import { BootpayOnboardingEventManager } from '../event/onboarding';
+import { OnboardingResultModel, RequestOnboardingModel } from '../../types/bootpay-interface';
+
+type OnboardingDisplay = 'popup' | 'iframe' | 'redirect';
+/**
+ * 리셀러 등록 폼(PG 신청 화면) 창 — Bootpay.requestOnboarding 전용
+ * - popup: window.open + 500ms 닫힘 감시(결제창 readyToPopup 과 같은 방식) — 닫히면 cancel
+ * - iframe(기본): 결제창 덮개(bootpay-payment-background) + iframe, 본문 스크롤 잠금 — 끝나면 덮개 제거 · 스크롤 복구
+ * - redirect: 현재 창 이동. Promise 는 끝나지 않는다(결과는 return_url 쿼리 · 리셀러 웹훅)
+ * 신청 화면 주소: {ONBOARDING_URL}/onboarding/s/{token}?display=…&origin={리셀러 페이지 origin}
+ * @date: 26-10-27
+ */
+export declare class OnboardingTemplateManager extends TemplateManager {
+    $template: string;
+    $windowId: string;
+    $iFrameId: string;
+    $onboardingWindowId: string;
+    $event: BootpayOnboardingEventManager;
+    $popup: Window | null;
+    $popupWatcher: ReturnType<typeof setInterval> | undefined;
+    $abortPrevious: (() => void) | null;
+    constructor();
+    template(): string;
+    /**
+     * 신청 화면 주소 — url 을 주면 부트페이 신청 화면 주소(ONBOARDING_URL)일 때만 쓴다
+     */
+    onboardingUrl(data: RequestOnboardingModel, display: OnboardingDisplay): string;
+    /**
+     * 신청 화면을 연다. done 은 resolve, cancel 과 error 는 reject
+     */
+    open(data: RequestOnboardingModel): Promise<OnboardingResultModel>;
+    currentWindow(display: OnboardingDisplay): Window | null;
+    /**
+     * 창 · 덮개 · 감시 · 리스너를 정리하고 본문 스크롤을 되돌린다
+     */
+    destroy(): void;
+}
+export declare const OnboardingTemplate: OnboardingTemplateManager;
+export {};

package/dist/src/lib/template/payment.d.ts

@@ -17,6 +17,7 @@ declare class TemplatePaymentManager extends TemplateManager {
     $env: any;
     $popup?: any;
     $popupWatcher?: any;
+    $themeColor?: string;
     mode: string;
     modeApiUrl: any;
     constructor();
@@ -110,6 +111,19 @@ declare class TemplatePaymentManager extends TemplateManager {
      * @returns void
      */
     showPopupMessage(displayData: PopupDisplayResponseModel): void;
+    /**
+     * 팝업 안내 창에 결제 요청 extra.theme_color 를 적용한다
+     * 값이 없거나 CSS 색상이 아니면 common.sass 의 기본색(--bootpay-primary)을 쓴다
+     */
+    private applyPopupThemeColor;
+    /**
+     * CSS 색상 문자열을 [r, g, b] 로 변환한다 — 브라우저가 계산한 값을 읽으므로 hex/rgb/hsl/색상명 모두 지원한다
+     */
+    private resolveRgb;
+    /**
+     * WCAG 상대 휘도 — 버튼 글자색(흰색/검정)을 고르는 데 쓴다
+     */
+    private relativeLuminance;
     /**
      * 팝업 버튼 창을 닫는다
      * Comment by GOSOMI
@@ -169,6 +183,11 @@ declare class TemplatePaymentManager extends TemplateManager {
      */
     moveToUrl(url: string): void;
     apiUrl(): any;
+    /**
+     * Progress 창을 보여준다 — 결제 요청 extra.theme_color 가 있으면 로딩 점 색을 그 색으로 바꾼다
+     * 값이 없거나 CSS 색상이 아니면 alfred-progress 기본색(--bootpay-progress-accent)을 쓴다
+     */
+    showProgress(message: string): void;
     /**
      * Form 설정 공통 메서드
      * Comment by GOSOMI

package/dist/src/support/environment.d.ts

@@ -27,6 +27,7 @@ export interface EnvironmentInterface {
     ANALYTICS_URL: EnvironmentMode;
     DOOR_URL: EnvironmentMode;
     WIDGET_URL: EnvironmentMode;
+    ONBOARDING_URL: EnvironmentMode;
     sdkNames: SdkNameInterface;
     sdkVersion: string;
     packageVersion: string;
@@ -40,6 +41,7 @@ export interface EnvironmentInterface {
     toApi(uri: string): string;
     toDoor(uri: string): string;
     toWidget(uri: string): string;
+    toOnboarding(uri: string): string;
     isMobile(): boolean;
     isMobileSafari(): any;
     toAnalytics(uri: string): string;

package/dist/src/types/bootpay-interface.d.ts

@@ -17,6 +17,8 @@ interface RequestPaymentBaseModel {
     deposit_price?: number
     platform_type?: number
     currency?: string // 결제 currency 화폐단위
+    currencies?: string[] // 통합결제창에서 결제 가능한 통화 목록 ex) ['krw', 'usd']
+    currency_prices?: { [currency: string]: number } // 통화별 결제 금액 ex) { usd: 11.12, cny: 100.23 }, 없으면 price를 환율로 환산
     uuid?: string // UUID
     sk?: string // 세션 고유키
     ti?: number // 재방문까지 걸린 시각
@@ -232,12 +234,20 @@ export interface ExtraModel {
     webhook_delay_duration?: number // webhook delay duration ( sec )
 
     force_browser_mode?: 'pc' | 'mobile' // 강제로 브라우저 모드 지정 옵션 ( 현재 미구현 PG사마다 정책이 달라서 확인 이후에 업데이트 될 예정 )
+    card_interest_merchant_share?: boolean // 가맹점 분담 무이자 사용 여부
+
+    theme_color?: string // 부트페이 결제창(카드 등록 등) 강조색 — 버튼 배경 · 입력 focus, CSS 색상값 ( 비우면 기본색 #3182F6, 이니시스는 결제창 SKIN 으로도 쓴다 )
+    theme_text_color?: string // theme_color 배경 위 글자색, CSS 색상값 ( 비우면 기본색 #FFFFFF )
+    force_redirect?: boolean
 }
 
 export interface WidgetExtraModel extends Partial<ExtraModel> {
     card_quota?: string | string[] | number[] // 카드 할부 개월수 노출 설정
     direct_card_company?: string
     direct_card_quota?: string
+    // true 면 카드사 바로 호출을 지원하는 PG(나이스페이 · KCP 등)라도 위젯이 카드사 목록을 그리지 않고
+    // PG 결제창(카드사 선택 화면)을 띄운다 — PG 심사처럼 PG 전용 창이 필요한 경우에 쓴다. 기본 false
+    use_pg_card_window?: boolean
 
     hide_title?: boolean
     hide_divider_line?: boolean
@@ -299,4 +309,31 @@ export interface PopupDisplayResponseModel {
 export interface CommissionKeyModel {
     commerce?: string
     marketer?: string
-}
+}
+
+/**
+ * 리셀러 등록 폼(PG 신청) 열기 요청 — Bootpay.requestOnboarding
+ * token: 리셀러 서버가 발급받은 등록 폼 토큰(rst_…)
+ * display: 'iframe'(기본, 현재 페이지 위 덮개) | 'popup'(새 창) | 'redirect'(현재 창 이동 — Promise 가 끝나지 않는다)
+ * url: 발급 응답의 url 을 그대로 쓸 때만. 부트페이 신청 화면 주소일 때만 받는다
+ * @date: 26-10-27
+ */
+export interface RequestOnboardingModel {
+    token: string
+    display?: 'popup' | 'iframe' | 'redirect'
+    url?: string
+}
+
+/**
+ * 리셀러 등록 폼 결과 — done 은 resolve, cancel(창 닫기 · 나중에 할게요)과 error 는 reject
+ * @date: 26-10-27
+ */
+export interface OnboardingResultModel {
+    event: 'done' | 'cancel' | 'error'
+    id?: string
+    kind?: 'pg_join' | string
+    pg_wait_id?: string
+    status?: number | null
+    error_code?: 'ONBOARDING_TOKEN_REQUIRED' | 'ONBOARDING_URL_INVALID' | 'POPUP_BLOCKED' | string
+    message?: string
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bootpay/client-js",
-  "version": "5.3.1",
+  "version": "5.5.0",
   "main": "dist/index.mjs",
   "exports": {
     ".": {