@bootpay/client-js 5.2.0-beta.2 → 5.2.0-beta.20

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

@@ -0,0 +1,312 @@
+import { ResponseBootpayWidgetTermsModel } from './bootpay-widget-interface';
+
+
+
+interface RequestPaymentBaseModel {
+    ver?: string // version
+    sdk?: boolean // sdk 사용여부
+    sdk_version?: string
+    sdk_type?: number
+    application_id?: string // application_id
+    pg?: string // PG 명
+    method?: string | string[] // 결제 수단
+    order_name: string
+    price: number
+    tax_free?: number
+    deposit_price?: number
+    platform_type?: number
+    currency?: string // 결제 currency 화폐단위
+    uuid?: string // UUID
+    sk?: string // 세션 고유키
+    ti?: number // 재방문까지 걸린 시각
+    tk?: string // 결제 고유키
+    user_token?: string // user token 값을 보낸다
+    wallet_id?: string
+    widget_key?: string
+    commission_keys?: CommissionKeyModel
+    redirect_url?: string
+    metadata?: any // 사용자가 보내는 custom data
+    user?: UserModel
+    items?: ItemModel[]
+    extra?: ExtraModel
+    env?: EnvironmentModel
+    terms?: ResponseBootpayWidgetTermsModel[]
+    widget_sandbox?: boolean
+    widget?: 1 | 0
+    locale?: string
+}
+
+/**
+ * 결제 요청 모델
+ * Comment by GOSOMI
+ * @date: 2021-04-13
+ */
+export interface RequestPaymentModel extends RequestPaymentBaseModel {
+    order_id: string
+}
+
+export interface RequestPaymentUrlModel {
+    application_id?: string
+    url?: string
+}
+
+export interface RequestSubscriptionModel extends RequestPaymentBaseModel {
+    subscription_id: string
+    subscribe_brandpay_type?: 'sequential' | 'select' | undefined
+}
+
+export interface RequestAuthenticationModel {
+    ver?: string
+    sdk?: boolean
+    application_id: string
+    authentication_id: string
+    metadata?: any // 메타 데이터
+    pg: string
+    method?: string
+    order_name: string // 본인인증 요청명
+    redirect_url?: string
+    platform_type?: number
+    uuid?: string
+    sk?: string
+    ti?: number
+    tk?: string
+    user: UserModel
+    extra: ExtraModel
+}
+
+/**
+ * User Model
+ * Comment by GOSOMI
+ * @date: 2021-04-13
+ */
+export interface UserModel {
+    id?: string | undefined
+    username?: string
+    email?: string
+    addr?: string
+    phone?: string
+}
+
+/**
+ * Item Model
+ * Comment by GOSOMI
+ * @date: 2021-04-13
+ */
+export interface ItemModel {
+    id: string // 상품 고유 ID
+    code?: string // item model code
+    name: string // 상품명
+    price: number // 상품가격
+    img?: string // 이미지 경로
+    qty: number // 상품수량
+    cat1?: string
+    cat2?: string
+    cat3?: string
+}
+
+export interface ItemAnalyticsModel {
+    cat1?: string
+    cat2?: string
+    cat3?: string
+    img?: string
+    name?: string
+    id: string
+    price: number
+}
+
+export interface ItemAnalyticsLegacyModel {
+    cat1?: string
+    cat2?: string
+    cat3?: string
+    item_img?: string
+    item_name?: string
+    unique: string
+    price: number
+}
+
+/**
+ * 통계 일반 common model
+ * Comment by GOSOMI
+ * @date: 2022-03-02
+ */
+export interface BootpayAnalyticsModel {
+    application_id?: string
+    uuid?: string
+    time?: number
+    url?: string
+    referer?: string
+    sk?: string
+    user_id?: string
+    page_type?: string
+    items?: Array<ItemAnalyticsModel> | Array<ItemAnalyticsLegacyModel>
+}
+
+export interface BootpayAnalyticsBaseModel {
+    uuid: string
+    time: number
+}
+
+/**
+ * 통계 User Model
+ * Comment by GOSOMI
+ * @date: 2022-03-02
+ */
+export interface BootpayAnalyticsUserModel {
+    application_id?: string
+    id: string
+    username?: string
+    birth?: string
+    phone?: string
+    email?: string
+    gender?: string
+    area?: string
+}
+
+interface OpenTypeFilterModel {
+    browser: string
+    open_type: 'iframe' | 'popup' | 'redirect'
+}
+
+/**
+ * Extra Model
+ * Comment by GOSOMI
+ * @date: 2021-04-13
+ */
+export interface ExtraModel {
+    open_type?: string // 결제 진행 방법, iframe, popup, redirect
+    browser_open_type?: Array<OpenTypeFilterModel>
+    escrow?: boolean // 에스크로 결제 여부
+    redirect_url?: string // 결제 진행 방법이 redirect인 경우 결제 완료시 이동한 마지막 URL
+    card_quota?: string | string[] | number[] // 카드 할부 개월수 노출 설정 ( PG 설정에 따름 )
+    seller_name?: string // 가맹점 이름 변경
+    delivery_day?: number // 배송일자
+    locale?: string // 결제 언어 선택
+    offer_period?: string // 제공기간 설정 ( PG사 마다 설정 방법이 상이 )
+    display_cash_receipt?: boolean // 현금 영수증 체크 노출 Y,N, default: true
+    deposit_expiration?: string // dateformat ('yyyy-mm-dd HH:MM:SS')
+    app_scheme?: string // 아이폰 앱 to 앱 호출
+    use_card_point?: boolean // 카드 포인트 사용 설정 ( 일부 PG만 지원 ), default: false
+    direct_card?: string // 특정 카드사로 바로 호출 ( 일부 PG만 지원 )
+    use_order_id?: boolean // PG사로 결제 데이터를 전송할때 receipt_id가 아닌 가맹점이 설정한 order_id로 전송 ,default: false
+    separately_confirmed?: boolean // 승인 분리 default: false
+    confirm_message?: string // 승인중 나오는 메세지 custom
+    display_success_result?: boolean // 결제 결과 display 옵션
+    display_error_result?: boolean // 결제 결과 display 옵션
+    test_deposit?: boolean // 테스트 모드일때 가상계좌 입금 모의 통지 여부, default: false
+    ad_id?: string // 원스토어 ThirdParty ad_id
+    sim_operator?: string // 원스토어 ThirdParty sim_operator
+    installer_package_name?: string // 원스토어 ThirdParty installer_package_name
+    timeout?: number // 분단위 결제 만료 시간 timeout ( default: 30분 )
+    common_event_webhook?: boolean // 닫기, 만료등의 이벤트 웹훅을 받을지 여부 ( default: false )
+
+    first_subscription_comment?: string // 정기결제 첫 결제 진행시 코멘트 ( price > 0 조건일 때 나오는 메세지 )
+    subscription_comment?: string // 정기결제 하단 코멘트 추가 관련 옵션
+    subscribe_test_payment?: boolean // 자동결제 카드 등록시 결제로 유효성 검사
+
+    enable_easy_payments?: Array<string> // 노출될 간편결제 리스트
+    except_card_companies?: Array<string> // 감춰질 카드사 리스트
+    enable_card_companies?: Array<string> // 보여질 카드사 리스트
+    direct_card_company?: string // 다이렉트 카드사 옵션
+    direct_card_quota?: string // 다이렉트 카드 quota 옵션
+
+    minimum_price_limit?: boolean // 최소금액 제한
+    confirm_grace_seconds?: number // 결제 승인 시간 유예 (단위, sec)
+
+    automatic_tax?: boolean // 해외결제 자동 세금 옵션
+    dynamic_tax_rates?: number // stripe tax 옵션
+    tax_rates?: number // stripe tax 옵션
+
+    show_close_button?: boolean // default false - iframe 모드일 경우 닫기 버튼을 보여줄지 체크
+
+    select_phone_carrier?: string // 휴대폰 소액결제시 통신사 prefix
+    phone_editable?: boolean // 휴대폰 소액결제시 전화번호 edit 가능 ( 다날만 적용 )
+    age_limit?: number // 본인인증시 나이 제한 설정
+
+    easy_payment_method?: 'card' | '카드' | 'point' | '포인트' // 네이버페이 결제시 point, card prefix
+    cash_receipt_type?: '소득공제' | '지출증빙' // 네이버포인트 결제시 현금영수증 발행 default - 소득공제 , option- 지출증빙
+    identity_no?: string // 현금영수증 발행 주체 ( 전화번호 or 사업자 등록증 )
+    override_global_event?: boolean
+    cash_receipt_not_published?: boolean
+    webhook_delay_duration?: number // webhook delay duration ( sec )
+
+    force_browser_mode?: 'pc' | 'mobile' // 강제로 브라우저 모드 지정 옵션 ( 현재 미구현 PG사마다 정책이 달라서 확인 이후에 업데이트 될 예정 )
+}
+
+export interface WidgetExtraModel extends Partial<ExtraModel> {
+    card_quota?: string | string[] | number[] // 카드 할부 개월수 노출 설정
+    direct_card_company?: string
+    direct_card_quota?: string
+
+    hide_title?: boolean
+    hide_divider_line?: boolean
+    inline_styles?: BootpayWidgetInlineStyleModel
+}
+
+export interface ConfirmModel {
+    event: string
+    receipt_id: string
+    gateway_url: string
+    data?: any
+}
+
+export interface ErrorModel {
+    event: string
+    pg_error_code?: string
+    error_code: string
+    message: string
+}
+
+interface BootpayWidgetInlineStyleModel {
+    mobile?: {
+        containerStyle?: {
+            'padding-top'?: string
+            'padding-bottom'?: string
+            'padding-left'?: string
+            'padding-right'?: string
+        }
+    }
+    pc?: {
+        containerStyle?: {
+            'padding-top'?: string
+            'padding-bottom'?: string
+            'padding-left'?: string
+            'padding-right'?: string
+        }
+    }
+}
+
+/**
+ * 사용자 환경 설정 관련 environment
+ * Comment by GOSOMI
+ * @date: 2021-12-09
+ */
+export interface EnvironmentModel {
+    width: number
+    height: number
+}
+
+export interface PopupDisplayResponseModel {
+    gatewayUrl: string
+    receiptId: string
+    name: string
+    message?: string // 메세지 정보는 아직 사용중이지 않음
+    price: number
+}
+
+export interface CommissionKeyModel {
+    commerce?: string
+    marketer?: string
+}
+
+export interface BootpaySliderOption {
+    title?: string
+    responseEvent: string
+    sliders: BootpaySliderSelectOption[]
+}
+
+export interface BootpaySliderSelectOption {
+    key: string
+    name: string
+    hook?: Function
+    class?: string
+}

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

@@ -0,0 +1,17 @@
+import { RequestPaymentModel } from './bootpay-interface';
+
+
+
+export interface BiometricDataModel {
+    userToken: string,
+    os?: string
+    token: string
+}
+
+export interface RequestPaymentWalletModel extends RequestPaymentModel {
+    user_token?: string
+    authenticate_type: string
+    token: string
+    wallet_id: string
+    easy_type?: string
+}

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

@@ -0,0 +1,121 @@
+import { ExtraModel, RequestPaymentModel, WidgetExtraModel } from './bootpay-interface';
+
+
+
+export interface RequestBootpayWidgetModel extends Partial<RequestPaymentModel> {
+    subscription_id?: string
+    use_only_brandpay?: boolean
+    subscribe_brandpay_type?: 'select' | 'sequential' | null | undefined
+    use_terms?: boolean
+    sandbox?: boolean
+    use_bootpay_inapp_sdk?: boolean
+    external_terms?: ExternalBootpayWidgetTermsModel[]
+    use_popup?: boolean
+    extra?: WidgetExtraModel
+    hooks?: WidgetHookFunction
+}
+
+export interface ResponseBootpayWidgetTermsModel {
+    term_id?: string
+    pk: string
+    title: string
+    agree?: boolean
+}
+
+export interface ExternalBootpayWidgetTermsModel {
+    pk: string
+    title: string
+    url: string
+    required: 'required' | 'optional'
+}
+
+export interface ExternalBootpaySelectModel {
+    payment_type?: string
+    method_alias?: string
+    wallet_id?: string
+}
+
+export interface PaymentParametersModel {
+    pg?: string
+    method?: string
+    wallet_id?: string
+    terms?: ResponseBootpayWidgetTermsModel[]
+    widget_key?: string
+    widget_sandbox?: boolean
+    extra?: ExtraModel
+}
+
+export interface WidgetStoreData {
+    el?: string
+    application_id?: string
+    order_name?: string
+    price?: number
+    tax_free?: number
+    deposit_price?: number
+    currency?: string
+    user_token?: string
+    pg?: string
+    method?: string
+    wallet_id?: string
+    use_only_brandpay?: boolean
+    use_bootpay_inapp_sdk?: boolean
+    use_terms?: boolean
+    sandbox?: boolean
+    widget_key?: string
+    widget_type?: number
+    external_terms?: ExternalBootpayWidgetTermsModel[]
+    extra?: ExtraModel
+}
+
+export interface WidgetHookFunction {
+    ready?: (data: any) => void
+    allTermsAccepted?: (data: any) => void
+    resize?: (data: any) => void
+    paymentMethodUpdated?: (data: any) => void
+    termsConsentUpdated?: (data: any) => void
+    brandpayWalletUpdated?: (data: WidgetBrandpayWalletModel[]) => void
+    brandpayManagerWindowClosed?: () => void
+    brandpayManagerWindowReady?: (data: any) => void
+}
+
+export interface WidgetBrandpayUpdateModel {
+    el?: string
+    application_id: string
+    widget_key: string
+    user_token: string
+    sandbox: boolean
+    is_popup: boolean
+}
+
+export interface WidgetBrandpayWalletModel {
+    wallet_id: string
+    type: number
+    payment_status: number
+    sandbox: boolean
+    order: number
+    name: string
+    card_code?: string
+    expired_at: string
+    latest_purchased_at: string
+    batch_data: {
+        bank_code?: string
+        bank_account?: string
+        bank_username?: string
+        card_company?: string
+        card_hash?: string
+        card_company_code?: string
+        card_no?: string
+        card_type?: number
+    }
+}
+
+export interface RequestBootpayBrandpayLaunchManager {
+    application_id: string
+    widget_key: string
+    user_token: string
+    el?: string
+    sandbox?: boolean
+    use_popup?: boolean
+    subscribe_brandpay_type?: 'select' | 'sequential' | null | undefined
+    hooks?: WidgetHookFunction
+}

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@bootpay/client-js",
-  "version": "5.2.0-beta.2",
-  "main": "dist/index.es.js",
-  "types": "dist/src/index.d.ts",
+  "version": "5.2.0-beta.20",
+  "main": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "styles": "dist/index.css",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -28,6 +33,11 @@
     "@babel/plugin-transform-object-assign": "^7.22.5",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-transform-destructuring": "^7.24.8",
+    "@babel/plugin-proposal-export-default-from": "^7.27.1",
+    "@babel/plugin-transform-class-properties": "^7.27.1",
+    "@babel/plugin-proposal-decorators": "^7.28.0",
+    "@babel/plugin-transform-private-methods": "^7.27.1",
+    "@babel/plugin-transform-typescript": "^7.28.0",
     "@babel/preset-env": "^7.22.5",
     "@babel/preset-typescript": "^7.22.5",
     "@babel/runtime-corejs3": "^7.22.5",
@@ -41,7 +51,7 @@
     "vite": "^5.4.3",
     "vite-plugin-dts": "^3.6.4",
     "vite-plugin-tsconfig": "^1.0.4",
-    "vite-plugin-css-injected-by-js": "^3.3.0"
+    "vite-plugin-css-injected-by-js": "3.3.1"
   },
   "resolutions": {
     "@webpack-cli/serve": "^1.3.1"

package/tsconfig.json

@@ -19,13 +19,17 @@
     "strict": false,
     "rootDir": "./",
     "baseUrl": "./src/",
-    "paths": {
-      "*": [
-        "../node_modules/*",
-        "./*"
-      ]
-    }
+    "typeRoots": [
+      "../node_modules/@types",
+      "../src/types"
+    ]
   },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.js",
+    "src/**/*.json",
+    "src/**/*.vue"
+  ],
   "exclude": [
     "**/*.spec.ts",
     "node_modules",

package/vite.config.ts

@@ -1,26 +1,25 @@
 import { defineConfig } from 'vite'
 import dts from 'vite-plugin-dts'
 import cssInjectedByJsPlugin from 'vite-plugin-css-injected-by-js'
-
-const path = require('path')
+import path from 'path'
 
 export default defineConfig({
     build:     {
-        minify:        'esbuild',
-        lib:           {
+        minify: 'esbuild',
+        lib:    {
             entry:    path.resolve(__dirname, 'src/index.ts'),
             name:     'Bootpay',
-            fileName: (format) => `index.${ format }.js`
+            fileName: 'index'
         }
     },
-    base:      './',
-    root:      './',
     plugins:   [
-        dts(),
+        dts({ copyDtsFiles: true, insertTypesEntry: true }),
         cssInjectedByJsPlugin()
     ],
+    base:      './',
+    root:      './',
     publicDir: '_public',
     resolve:   {
-        extensions: ['.css', '.sass', '.scss', '.ts', '.js']
+        extensions: ['.css', '.sass', '.scss', '.ts', '.js', '.d.ts']
     }
 })