@portone/browser-sdk 0.0.1 → 0.0.3

package/dist/v2/exception/index.d.ts

@@ -0,0 +1,8 @@
+export interface PortOneError extends Error {
+    __portOneErrorType: string;
+}
+export declare function isPortOneError(error: unknown): error is PortOneError;
+export * from './IdentityVerificationError.js';
+export * from './IssueBillingKeyError.js';
+export * from './ModuleError.js';
+export * from './PaymentError.js';

package/dist/v2/index.d.ts

@@ -0,0 +1,15 @@
+import { requestPayment } from './requestPayment.js';
+import { requestIssueBillingKey } from './requestIssueBillingKey.js';
+import { requestIdentityVerification } from './requestIdentityVerification.js';
+declare const PortOne: {
+    requestPayment: typeof requestPayment;
+    requestIssueBillingKey: typeof requestIssueBillingKey;
+    requestIdentityVerification: typeof requestIdentityVerification;
+};
+export { setPortOneJsSdkUrl as __INTERNAL__setPortOneSdkUrl } from './loader.js';
+export { requestPayment, type PaymentRequest, type PaymentResponse, } from './requestPayment.js';
+export { requestIssueBillingKey, type IssueBillingKeyRequest, type IssueBillingKeyResponse, } from './requestIssueBillingKey.js';
+export { requestIdentityVerification, type IdentityVerificationRequest, type IdentityVerificationResponse, } from './requestIdentityVerification.js';
+export * as Entity from './entity/index.js';
+export * from './exception/index.js';
+export default PortOne;

package/dist/v2/loader.d.ts

@@ -0,0 +1,16 @@
+import type { PaymentRequest, PaymentResponse } from './requestPayment.js';
+import type { IssueBillingKeyRequest, IssueBillingKeyResponse } from './requestIssueBillingKey.js';
+import type { IdentityVerificationRequest, IdentityVerificationResponse } from './requestIdentityVerification.js';
+declare global {
+    interface Window {
+        PortOne: PortOne | undefined;
+    }
+}
+interface PortOne {
+    requestPayment(request: PaymentRequest): Promise<PaymentResponse>;
+    requestIssueBillingKey(request: IssueBillingKeyRequest): Promise<IssueBillingKeyResponse>;
+    requestIdentityVerification(request: IdentityVerificationRequest): Promise<IdentityVerificationResponse>;
+}
+export declare function loadScript(): Promise<PortOne>;
+export declare function setPortOneJsSdkUrl(url: string): string;
+export {};

package/dist/v2/requestIdentityVerification.d.ts

@@ -0,0 +1,25 @@
+import { Entity } from './index.js';
+export declare function requestIdentityVerification(request: IdentityVerificationRequest): Promise<IdentityVerificationResponse | undefined>;
+export type IdentityVerificationRequest = {
+    storeId: string;
+    identityVerificationId: string;
+    channelKey?: string;
+    pgProvider?: Entity.PgProvider;
+    isTestChannel?: boolean;
+    customer?: Entity.Customer;
+    windowType?: Entity.WindowTypes;
+    redirectUrl?: string;
+    customData?: string;
+    bypass?: Entity.IdentityVerificationBypass;
+};
+/**
+ * iframe/popup 방식으로 PG사 창이 렌더링 된 경우
+ * 프로세스 종료 후, 콜백 함수로 전달 될 본인인증 정보 데이터
+ */
+export type IdentityVerificationResponse = {
+    transactionType: typeof Entity.TransactionType.IDENTITY_VERIFICATION;
+    identityVerificationId?: string;
+    identityVerificationTxId: string;
+    code?: string;
+    message?: string;
+};

package/dist/v2/requestIssueBillingKey.d.ts

@@ -0,0 +1,49 @@
+import { CapsToCamel } from '../utils.js';
+import { Entity } from './index.js';
+export declare function requestIssueBillingKey(request: IssueBillingKeyRequest): Promise<IssueBillingKeyResponse | undefined>;
+export type IssueBillingKeyRequest = {
+    displayAmount?: number;
+    currency?: Entity.Currency;
+    storeId: string;
+    channelKey?: string;
+    pgProvider?: Entity.PgProvider;
+    isTestChannel?: boolean;
+    billingKeyMethod: Entity.BillingKeyMethod;
+    issueName?: string;
+    issueId?: string;
+    billingKey?: string;
+    customer?: Entity.Customer;
+    windowType?: Entity.WindowTypes;
+    redirectUrl?: string;
+    locale?: Entity.Locale;
+    customData?: Record<string, any>;
+    appScheme?: string;
+    noticeUrls?: string[];
+    bypass?: Entity.IssueBillingKeyBypass;
+} & (BillingKeyMethodOptions<'CARD', Card> | BillingKeyMethodOptions<'MOBILE', Mobile> | BillingKeyMethodOptions<'EASY_PAY', EasyPay> | BillingKeyMethodOptions<'PAYPAL', Paypal>);
+/**
+ * iframe/popup 방식으로 PG사 창이 렌더링 된 경우
+ * 프로세스 종료 후, 콜백 함수로 전달 될 빌링키 발급 정보 데이터
+ */
+export type IssueBillingKeyResponse = {
+    transactionType: typeof Entity.TransactionType.ISSUE_BILLING_KEY;
+    billingKey?: string;
+    code?: string;
+    message?: string;
+};
+type BillingKeyMethodOptions<Method extends Entity.BillingKeyMethod, T> = {
+    billingKeyMethod: Method;
+} & {
+    [K in Method as CapsToCamel<K>]?: T;
+};
+type Card = {
+    cardCompany?: Entity.CardCompany;
+};
+type EasyPay = {
+    availableCards?: Entity.CardCompany[];
+};
+type Mobile = {
+    carrier?: Entity.Carrier;
+};
+type Paypal = Record<string, never>;
+export {};

package/dist/v2/requestPayment.d.ts

@@ -0,0 +1,91 @@
+import { CapsToCamel, OneOfType } from '../utils.js';
+import { Entity } from './index.js';
+export declare function requestPayment(request: PaymentRequest): Promise<PaymentResponse | undefined>;
+export type PaymentRequest = {
+    storeId: string;
+    paymentId: string;
+    orderName: string;
+    totalAmount: number;
+    channelKey?: string;
+    pgProvider?: Entity.PgProvider;
+    isTestChannel?: boolean;
+    taxFreeAmount?: number;
+    vatAmount?: number;
+    customer?: Entity.Customer;
+    windowType?: Entity.WindowTypes;
+    redirectUrl?: string;
+    noticeUrls?: string[];
+    confirmUrl?: string;
+    appScheme?: string;
+    isEscrow?: boolean;
+    products?: Entity.Product[];
+    isCulturalExpense?: boolean;
+    currency: Entity.Currency;
+    locale?: Entity.Locale;
+    customData?: Record<string, any>;
+    offerPeriod?: Entity.OfferPeriod;
+    productType?: Entity.ProductType;
+    storeDetails?: Entity.StoreDetails;
+    bypass?: Entity.PaymentBypass;
+    country?: Entity.Country;
+    shippingAddress?: Entity.Address;
+} & (PayMethodOptions<'CARD', Card> | PayMethodOptions<'VIRTUAL_ACCOUNT', VirtualAccount> | PayMethodOptions<'TRANSFER', Transfer> | PayMethodOptions<'MOBILE', Mobile> | PayMethodOptions<'GIFT_CERTIFICATE', GiftCertificate> | PayMethodOptions<'EASY_PAY', EasyPay> | PayMethodOptions<'PAYPAL', Paypal>);
+/**
+ * iframe/popup 방식으로 PG사 창이 렌더링 된 경우
+ * 프로세스 종료 후, 콜백 함수로 전달 될 결제 정보 데이터
+ */
+export type PaymentResponse = {
+    transactionType: typeof Entity.TransactionType.PAYMENT;
+    txId: string;
+    paymentId?: string;
+    code?: string;
+    message?: string;
+};
+type PayMethodOptions<Method extends Entity.PayMethod, T> = {
+    payMethod: Method;
+} & {
+    [K in Method as CapsToCamel<K>]?: T;
+};
+type Card = {
+    cardCompany?: Entity.CardCompany;
+    installment?: Entity.Installment;
+    useCardPoint?: boolean;
+    useAppCardOnly?: boolean;
+    availableCards?: Entity.CardCompany[];
+    useFreeInterestFromMall?: boolean;
+};
+type VirtualAccount = {
+    cashReceiptType?: Entity.CashReceiptType;
+    customerIdentifier?: string;
+    accountExpiry?: OneOfType<{
+        validHours: number;
+        dueDate: string;
+    }>;
+    bankCode?: Entity.Bank;
+    fixedOption?: OneOfType<{
+        pgAccountId: string;
+        accountNumber: string;
+    }>;
+};
+type Transfer = {
+    cashReceiptType?: Entity.CashReceiptType;
+    customerIdentifier?: string;
+    bankCode?: Entity.Bank;
+};
+type Mobile = {
+    carrier?: Entity.Carrier;
+};
+type GiftCertificate = {
+    giftCertificateType?: Entity.GiftCertificateType;
+};
+type EasyPay = {
+    easyPayProvider?: Entity.EasyPayProvider;
+    installment?: Entity.Installment;
+    availableCards?: Entity.CardCompany[];
+    useFreeInterestFromMall?: boolean;
+    cashReceiptType?: Entity.CashReceiptType;
+    customerIdentifier?: string;
+    useCardPoint?: boolean;
+};
+type Paypal = Record<string, never>;
+export {};