@paypay/mini-app-js-sdk 2.51.0 → 2.55.0

package/dist/resources/locales/payment/ja.d.ts

@@ -0,0 +1,249 @@
+declare const _default: {
+    payment: {
+        address: string;
+        insufficientAmount: string;
+        cancel: string;
+        noAddress: string;
+        change: string;
+        close: string;
+        noCashBack: string;
+        transactionId: string;
+        ppPointGuideMessage: string;
+    };
+    duplicate: {
+        cancel: string;
+        topHeader: string;
+        topText1: string;
+        topText2: string;
+        topAgreeButtonText: string;
+    };
+    birthdayConfirm: {
+        title: string;
+        title2: string;
+        desc: string;
+        desc1: string;
+        desc2: string;
+        desc3: string;
+        date: string;
+        primaryBtn: string;
+        cancelBtn: string;
+    };
+    birthdayConfirmError: {
+        title: string;
+        title2: string;
+        desc: string;
+        desc2: string;
+        helpBtn: string;
+        closeBtn: string;
+    };
+    cashbackDet: {
+        button1: string;
+        button2: string;
+        button3: string;
+    };
+    topContent: {
+        chargeTitle: string;
+        chargeLabel: string;
+        unavailable1: string;
+        unavailable2: string;
+        topupNotice: string;
+        topupLink: string;
+        return: string;
+    };
+    cashbackList: {
+        close: string;
+        condition: string;
+    };
+    newOffersBanner: {
+        title: string;
+        description: string;
+    };
+    ekyc: {
+        title: string;
+        link: string;
+        button1: string;
+        button2: string;
+    };
+    qr: {
+        titleEKYC: string;
+        bodyEKYC: string;
+        titleAddTopup: string;
+        bodyAddTopup: string;
+        close: string;
+    };
+    type: {
+        payment: {
+            title: string;
+            payAmount: string;
+            payAmountTaxExempt: string;
+            method: string;
+            selectMethod: string;
+            paying: string;
+            pay: string;
+            charge: string;
+            notice: string;
+            terms: null;
+            payLaterCCTerms: null;
+            duplicate: {
+                header: string;
+                text1: string;
+                text2: string;
+                agreeButtonText: string;
+            };
+            topContent: {
+                title: string;
+                loading: string;
+                amount: string;
+            };
+            desktopTitle: {
+                Payment: string;
+                paymentCompletion: string;
+            };
+            errorSheet: {
+                payPeriod: string;
+            };
+            ekyc: {
+                description: string;
+            };
+            complete: {
+                title: string;
+                titlePreAuth: string;
+            };
+            closeConfirmation: {
+                title: string;
+                confirm: string;
+                cancel: string;
+            };
+        };
+        donation: {
+            title: string;
+            payAmount: string;
+            payAmountTaxExempt: string;
+            method: string;
+            selectMethod: string;
+            paying: string;
+            pay: string;
+            charge: string;
+            notice: string;
+            terms: string[];
+            payLaterCCTerms: string[];
+            duplicate: {
+                header: string;
+                text1: string;
+                text2: string;
+                agreeButtonText: string;
+            };
+            topContent: {
+                title: string;
+                loading: string;
+                amount: string;
+            };
+            desktopTitle: {
+                Payment: string;
+                paymentCompletion: string;
+            };
+            errorSheet: {
+                payPeriod: string;
+            };
+            ekyc: {
+                description: string;
+            };
+            complete: {
+                title: string;
+                titlePreAuth: string;
+            };
+            closeConfirmation: {
+                title: string;
+                confirm: string;
+                cancel: string;
+            };
+        };
+        remittance: {
+            title: string;
+            payAmount: string;
+            payAmountTaxExempt: string;
+            method: string;
+            selectMethod: string;
+            paying: string;
+            pay: string;
+            charge: string;
+            notice: string;
+            terms: string[];
+            payLaterCCTerms: string[];
+            duplicate: {
+                header: string;
+                text1: string;
+                text2: string;
+                agreeButtonText: string;
+            };
+            topContent: {
+                title: string;
+                loading: string;
+                amount: string;
+            };
+            desktopTitle: {
+                Payment: string;
+                paymentCompletion: string;
+            };
+            errorSheet: {
+                payPeriod: string;
+            };
+            ekyc: {
+                description: string;
+            };
+            complete: {
+                title: string;
+                titlePreAuth: string;
+            };
+            closeConfirmation: {
+                title: string;
+                confirm: string;
+                cancel: string;
+            };
+        };
+        deposit: {
+            title: string;
+            payAmount: string;
+            payAmountTaxExempt: string;
+            method: string;
+            selectMethod: string;
+            paying: string;
+            pay: string;
+            charge: string;
+            notice: string;
+            terms: string[];
+            payLaterCCTerms: null;
+            duplicate: {
+                header: string;
+                text1: string;
+                text2: string;
+                agreeButtonText: string;
+            };
+            topContent: {
+                title: string;
+                loading: string;
+                amount: string;
+            };
+            desktopTitle: {
+                Payment: string;
+                paymentCompletion: string;
+            };
+            errorSheet: {
+                payPeriod: string;
+            };
+            ekyc: {
+                description: string;
+            };
+            complete: {
+                title: string;
+                titlePreAuth: string;
+            };
+            closeConfirmation: {
+                title: string;
+                confirm: string;
+                cancel: string;
+            };
+        };
+    };
+};
+export default _default;

package/dist/resources/locales/shared/index.d.ts

@@ -0,0 +1,79 @@
+declare const _default: {
+    ja: {
+        desktopTitle: {
+            addNewAddress: string;
+            editAddress: string;
+            paymentCompletion: string;
+            getUserAddress: string;
+        };
+        choosePayment: {
+            title: string;
+            desc1: string;
+            desc2: string;
+            addMethod: string;
+            noMethod: string;
+        };
+        errorSheet: {
+            title: string;
+            title1: string;
+            desc: string;
+            topup: string;
+            topupDesc: string;
+            pay: string;
+            payDesc: string;
+            tryAgain: string;
+        };
+        softbank: {
+            desc: string;
+            desc1: string;
+            isDisable: string;
+        };
+        '3dSecureSheet': {
+            title: string;
+            descriptionForYJCardOrPPCard: string;
+            description: string;
+            setting3DSecure: string;
+            about3DSecure: string;
+            close: string;
+        };
+    };
+    en: {
+        desktopTitle: {
+            addNewAddress: string;
+            editAddress: string;
+            paymentCompletion: string;
+            getUserAddress: string;
+        };
+        choosePayment: {
+            title: string;
+            desc1: string;
+            desc2: string;
+            addMethod: string;
+            noMethod: string;
+        };
+        errorSheet: {
+            title: string;
+            title1: string;
+            desc: string;
+            topup: string;
+            topupDesc: string;
+            pay: string;
+            payDesc: string;
+            tryAgain: string;
+        };
+        softbank: {
+            desc: string;
+            desc1: string;
+            isDisable: string;
+        };
+        '3dSecureSheet': {
+            title: string;
+            descriptionForYJCardOrPPCard: string;
+            description: string;
+            setting3DSecure: string;
+            about3DSecure: string;
+            close: string;
+        };
+    };
+};
+export default _default;

package/dist/resources/locales/shared/ja.d.ts

@@ -0,0 +1,39 @@
+declare const _default: {
+    desktopTitle: {
+        addNewAddress: string;
+        editAddress: string;
+        paymentCompletion: string;
+        getUserAddress: string;
+    };
+    choosePayment: {
+        title: string;
+        desc1: string;
+        desc2: string;
+        addMethod: string;
+        noMethod: string;
+    };
+    errorSheet: {
+        title: string;
+        title1: string;
+        desc: string;
+        topup: string;
+        topupDesc: string;
+        pay: string;
+        payDesc: string;
+        tryAgain: string;
+    };
+    softbank: {
+        desc: string;
+        desc1: string;
+        isDisable: string;
+    };
+    '3dSecureSheet': {
+        title: string;
+        descriptionForYJCardOrPPCard: string;
+        description: string;
+        setting3DSecure: string;
+        about3DSecure: string;
+        close: string;
+    };
+};
+export default _default;

package/dist/types/getTransactions.d.ts

@@ -9,6 +9,11 @@ export interface GetTransactionsParams extends NativeParams<GetTransactionsResul
     cursor?: string;
     size?: number;
 }
+export declare type GetTransactionsApiResponseData = {
+    hasNext: boolean;
+    nextPageKey: string;
+    transactions: TransactionItem[];
+};
 export declare type GetTransactionsResult = {
     hasNext: boolean;
     nextCursor: string;

package/dist/types/init.d.ts

@@ -5,6 +5,7 @@ export interface InitClientParams extends NativeParams<InitResult> {
     env?: PPEnvType;
     mode?: string;
     debugMode?: boolean;
+    useLocalStorage?: boolean;
 }
 export interface InitParams extends NativeParams<InitResult> {
     clientId: string;
@@ -18,6 +19,7 @@ export interface InitParams extends NativeParams<InitResult> {
     debugMode?: boolean;
     clientSdkType?: SdkType;
     clientUrl?: string;
+    useLocalStorage?: boolean;
 }
 export declare const PPEnv: {
     readonly staging: "staging";

package/dist/types/makePayment.d.ts

@@ -1,5 +1,4 @@
 import { NativeParams } from '../jsbridge-core/jsbridge';
-import { Address } from '../types/getUserAddress';
 import { UIComponentsError } from '../model/uiComponents';
 import { MiniAppErrorType } from '../model/miniAppError';
 export declare const Order: {
@@ -27,12 +26,6 @@ export interface MakePaymentParams extends NativeParams<MakePaymentResult> {
     storeInfo?: string;
     productType?: string;
     taxExempt?: boolean;
-    additionalUserInfo?: {
-        userAddress?: {
-            visible: boolean;
-            mandatory: boolean;
-        };
-    };
     merchantTimeoutAt?: number;
     orderType?: OrderType;
 }
@@ -49,7 +42,6 @@ export interface OrderItem {
 }
 export declare type MakePaymentResult = {
     jws: string;
-    address: Address | null;
 };
 export declare const PaymentConsultResultCode: {
     EKYC_REQUIRED_FOR_DONATION: string;
@@ -105,6 +97,7 @@ declare type MethodBase = {
     paymentMethodId: string;
     paymentMethodType: PaymentMethodNameType;
     descriptionBannerInfo?: BannerInfo;
+    pointToggleInfo?: PointToggleInfo;
     walletInfo?: unknown;
     creditCardInfo?: unknown;
     bankInfo?: unknown;
@@ -156,10 +149,14 @@ export declare type WalletMethod = MethodBase & {
             totalEmoneyBalanceInfo?: Balance;
             prepaidBalanceInfo?: Balance;
             cashBackBalanceInfo?: Balance;
+            totalPayPayPointsInfo?: Balance;
             cashBackExpirableBalanceInfo?: Balance;
         };
     };
 };
+declare type PointToggleInfo = {
+    cashBackUseStatus: 'USE' | 'SAVE' | 'INVEST' | null;
+};
 export declare enum CreditTypes {
     VISA = "VISA",
     MASTER = "MASTER",

package/dist/types.d.ts

@@ -123,9 +123,10 @@ export declare enum Environment {
     CANARY = "canary",
     PRD = "prd"
 }
-export interface CloseAppParams extends NativeParams<unknown> {
+export interface CloseAppParams extends NativeParams<void> {
     options?: {
         deeplink?: string;
+        closeConfirmation?: boolean;
     };
 }
 export interface GetKycInformationParams extends NativeParams<MiniAppResult> {
@@ -210,12 +211,6 @@ export interface SmartPayParams {
     expiresAt?: number;
     agreeSimilarTransaction?: boolean;
     terminalId?: string;
-    additionalUserInfo?: {
-        userAddress?: {
-            visible: boolean;
-            mandatory: boolean;
-        };
-    };
     orderType?: OrderType;
 }
 export interface UserInfo {
@@ -459,6 +454,8 @@ export declare const PPUtilFunctionName: {
     readonly saveRefreshToken: "saveRefreshToken";
     readonly saveCodeVerifier: "saveCodeVerifier";
     readonly makeVisible: "makeVisible";
+    readonly hideIframe: "hideIframe";
+    readonly showIframe: "showIframe";
     readonly consoleDebugInfo: "consoleDebugInfo";
     readonly clientPopState: "clientPopState";
 };

package/dist/utils/analytics.d.ts

@@ -31,6 +31,7 @@ export declare function handleLogSDKEvent(name: PPFunctionNameType, eventActionS
 export declare function test_initClientState(params: {
     clientId: string;
     clientOrigin: string;
-    clientSdkType?: SdkType;
+    clientSdkType: SdkType;
+    useLocalStorage: boolean;
 }): void;
 export {};

package/dist/utils/api.d.ts

@@ -1,6 +1,7 @@
 import { MiniAppErrorType } from '../model/miniAppError';
 import { UIComponentsError } from '../model/uiComponents';
 import { CashbackResponse, SmartPayParams } from '../types';
+import { PPFetchResult } from './fetch';
 import { Address, NewAddress } from '../types/getUserAddress';
 import { MakePaymentParams } from '../types/makePayment';
 import { GetKycPassportInfoResult } from '../types/getKycPassportInfo';
@@ -66,72 +67,14 @@ export declare type BalanceInfo = {
         currency: string;
     };
 };
-export declare function topup(queryParams: TopupQuery, body: TopupBody, paymentParams?: MakePaymentParams): Promise<{
-    ppFetchResult: "notAuthorized";
-    errorCode: MiniAppErrorType.notAuthorized;
-    body: null;
-} | {
-    ppFetchResult: "fetchError";
-    errorCode: MiniAppErrorType.serverError;
-    body: null;
-} | {
-    ppFetchResult: "timeout";
-    errorCode: MiniAppErrorType.timeOut;
-    body: null;
-} | {
-    ppFetchResult: "tokenExpired";
-    errorCode: MiniAppErrorType.tokenExpired;
-    statusCode: number;
-    body?: null | undefined;
-} | {
-    ppFetchResult: "apiError" | "rateLimitExceeded";
-    errorCode: MiniAppErrorType;
-    statusCode: number;
-    body: ({
-        signed: {
-            jws: string;
-        };
-        unsigned: {
-            resultInfo: {
-                code: string;
-                codeId?: string | undefined;
-                message?: string | undefined;
-            };
-            data?: {
-                header?: {
-                    resultCode?: string | undefined;
-                } | undefined;
-                error?: unknown;
-                helpUrl?: string | undefined;
-            } | undefined;
-        };
-        uiComponents?: {
-            displayErrorResponse?: UIComponentsError | undefined;
-        } | undefined;
-    } | {
-        signed?: undefined;
-        unsigned?: undefined;
-        resultInfo: {
-            code: string;
-            codeId?: string | undefined;
-            message?: string | undefined;
-        };
-        uiComponents?: {
-            displayErrorResponse: UIComponentsError;
-        } | undefined;
-    }) & Record<string, unknown>;
-} | {
-    ppFetchResult: "success";
-    statusCode: number;
-    body: TopupResponse;
-}>;
+export declare function topup(queryParams: TopupQuery, body: TopupBody, paymentParams?: MakePaymentParams): Promise<PPFetchResult<TopupResponse>>;
 export declare type BalanceParams = {
     clientId?: string;
     currency?: string;
     merchant?: string;
     productType?: string;
 };
-export declare function getBalance(params?: BalanceParams): Promise<import("./fetch").PPFetchResult<unknown, Record<string, unknown>>>;
+export declare function getBalance(params?: BalanceParams): Promise<PPFetchResult<unknown, Record<string, unknown>>>;
 declare type BalanceInfoForTopupSheetResponse = {
     data: BalanceInfo;
 };
@@ -140,7 +83,7 @@ declare type BalanceInfoForTopupSheetRequestParams = {
     productType?: string;
     clientId: string;
 };
-export declare function getBalanceInfoForTopupSheet(params: BalanceInfoForTopupSheetRequestParams): Promise<import("./fetch").PPFetchResult<BalanceInfoForTopupSheetResponse, Record<string, unknown>>>;
+export declare function getBalanceInfoForTopupSheet(params: BalanceInfoForTopupSheetRequestParams): Promise<PPFetchResult<BalanceInfoForTopupSheetResponse, Record<string, unknown>>>;
 export declare type ShallowAddress = {
     prefecture: string;
     cityAndOaza: string;
@@ -157,7 +100,7 @@ export declare type GetAddressByZipResponse = {
 export declare type AddressParams = {
     zipcode: string;
 };
-export declare function getAddressByZip(params: AddressParams): Promise<import("./fetch").PPFetchResult<GetAddressByZipResponse, Record<string, unknown>>>;
+export declare function getAddressByZip(params: AddressParams): Promise<PPFetchResult<GetAddressByZipResponse, Record<string, unknown>>>;
 export declare type SetSelectedAddressResponse = {
     signed: unknown;
     statusCode: number;
@@ -175,8 +118,8 @@ export declare type GetAddressListResponse = {
         };
     };
 };
-export declare function getAddressList(): Promise<import("./fetch").PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
-export declare function postAddress(body: NewAddress): Promise<import("./fetch").PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
+export declare function getAddressList(): Promise<PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
+export declare function postAddress(body: NewAddress): Promise<PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
 export declare type GetOTPResponse = {
     signed: {
         jws: string;
@@ -213,7 +156,7 @@ export declare type VerifyOTPBody = {
     otpKey: string;
     otp: number;
 };
-export declare function getOtp(): Promise<import("./fetch").PPFetchResult<GetOTPResponse, Record<string, unknown>>>;
+export declare function getOtp(): Promise<PPFetchResult<GetOTPResponse, Record<string, unknown>>>;
 export declare type KycTypeResponse = {
     signed: {
         resultInfo?: {
@@ -249,11 +192,11 @@ export declare type VerifyKycPassportResponse = {
         data: GetKycPassportInfoResult;
     };
 };
-export declare function getInitKycPassport(params: InitKycPassportParams): Promise<import("./fetch").PPFetchResult<KycTypeResponse, Record<string, unknown>>>;
-export declare function verifyOtp(body: VerifyOTPBody): Promise<import("./fetch").PPFetchResult<VerifyOTPResponse, Record<string, unknown>>>;
-export declare function editAddress(body: NewAddress, id: number): Promise<import("./fetch").PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
-export declare function deleteAddress(id: number): Promise<import("./fetch").PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
-export declare function setSelectedAddress(addressId: number): Promise<import("./fetch").PPFetchResult<SetSelectedAddressResponse, Record<string, unknown>>>;
+export declare function getInitKycPassport(params: InitKycPassportParams): Promise<PPFetchResult<KycTypeResponse, Record<string, unknown>>>;
+export declare function verifyOtp(body: VerifyOTPBody): Promise<PPFetchResult<VerifyOTPResponse, Record<string, unknown>>>;
+export declare function editAddress(body: NewAddress, id: number): Promise<PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
+export declare function deleteAddress(id: number): Promise<PPFetchResult<GetAddressListResponse, Record<string, unknown>>>;
+export declare function setSelectedAddress(addressId: number): Promise<PPFetchResult<SetSelectedAddressResponse, Record<string, unknown>>>;
 export declare type VERIFY_STATUS = 'NOT_VERIFIED' | 'VERIFIED';
 export declare type ProfileInfo = {
     firstName?: string;
@@ -284,8 +227,8 @@ export declare type ProfileResponse = {
     };
     statusCode: number;
 };
-export declare function getUserProfileData(): Promise<import("./fetch").PPFetchResult<ProfileResponse, Record<string, unknown>>>;
-export declare function getUserProfileDataV2(): Promise<import("./fetch").PPFetchResult<ProfileResponse, Record<string, unknown>>>;
+export declare function getUserProfileData(): Promise<PPFetchResult<ProfileResponse, Record<string, unknown>>>;
+export declare function getUserProfileDataV2(): Promise<PPFetchResult<ProfileResponse, Record<string, unknown>>>;
 export declare type RegisterEmailResponse = {
     signed: unknown;
     statusCode: number;
@@ -304,8 +247,8 @@ export declare type RegisterEmailResponse = {
         };
     };
 };
-export declare function registerEmail(email: string): Promise<import("./fetch").PPFetchResult<RegisterEmailResponse, Record<string, unknown>>>;
-export declare function resendEmail(): Promise<import("./fetch").PPFetchResult<RegisterEmailResponse, Record<string, unknown>>>;
+export declare function registerEmail(email: string): Promise<PPFetchResult<RegisterEmailResponse, Record<string, unknown>>>;
+export declare function resendEmail(): Promise<PPFetchResult<RegisterEmailResponse, Record<string, unknown>>>;
 export declare type UserLocationResponse = {
     unsigned: {
         data: {
@@ -318,6 +261,6 @@ export declare type UserLocationResponse = {
 };
 export declare function getUserLocationRequest(params: {
     validTimeMinutes: number;
-}): Promise<import("./fetch").PPFetchResult<UserLocationResponse, Record<string, unknown>>>;
-export declare function getExpectedCashbackInfo(orderInfo: SmartPayParams): Promise<import("./fetch").PPFetchResult<CashbackResponse, Record<string, unknown>>>;
+}): Promise<PPFetchResult<UserLocationResponse, Record<string, unknown>>>;
+export declare function getExpectedCashbackInfo(orderInfo: SmartPayParams): Promise<PPFetchResult<CashbackResponse, Record<string, unknown>>>;
 export {};

package/dist/utils/clientCustomization.d.ts

@@ -0,0 +1,3 @@
+export declare const clientCustomization: {
+    HIDE_PP_POINT: string[];
+};

package/dist/utils/getLanguage.d.ts

@@ -1,3 +1,2 @@
 import { Locale } from '../types';
-export declare function getPayPayLanguage(): string;
-export declare function getTranslationLanguage(): Locale;
+export declare function getTranslationLanguage(preferredLanguage?: string): Locale;