@paypay/mini-app-js-sdk 2.18.0 → 2.20.0

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

@@ -0,0 +1,26 @@
+declare const _default: {
+    topupCompletion: {
+        title: string;
+        idInfo: string;
+        copied: string;
+    };
+    paymentMethod: {
+        expired: string;
+        ordinary: string;
+        current: string;
+        checkGreen: string;
+        authenticated: string;
+        yjTitle: string;
+        ppCardTitle: string;
+        brand: string;
+    };
+    paymentMethodStatus: {
+        ACTIVATED: string;
+        OFF: string;
+        APPLYING: string;
+        MAINTENANCE: string;
+        BUSY: string;
+        SUSPENDED: string;
+    };
+};
+export default _default;

package/dist/types/GetExternalLinkageInformationResult.d.ts

@@ -0,0 +1,14 @@
+export declare type GetExternalLinkageInformationResult = {
+    yidLinked: boolean;
+    sbGroupMobileCarrier?: unknown;
+    responseValidTill?: number;
+};
+export declare type GetExternalLinkageInformationResponse = {
+    unsigned: {
+        data: {
+            yidLinked: boolean;
+            sbGroupMobileCarrier?: 'LINEMO' | 'YMOBILE' | 'SOFTBANK';
+            responseValidTill?: number;
+        };
+    };
+};

package/dist/types/getDeviceInformation.d.ts

@@ -1,3 +1,10 @@
 export declare type GetDeviceInformationResult = {
     os: string;
+    eSimSupported?: ESimSupportedType;
 };
+export declare const ESimSupported: {
+    readonly SUPPORTED: "SUPPORTED";
+    readonly NOT_SUPPORTED: "NOT_SUPPORTED";
+    readonly UNKNOWN: "UNKNOWN";
+};
+export declare type ESimSupportedType = (typeof ESimSupported)[keyof typeof ESimSupported];

package/dist/types/getLoginUrl.d.ts

@@ -0,0 +1,8 @@
+import type { NativeParams } from '../jsbridge-core/jsbridge';
+import type { RedirectType } from '../types';
+export interface GetLoginUrlParams extends NativeParams<{
+    url: string;
+}> {
+    redirectUrl?: string;
+    redirectType?: RedirectType;
+}

package/dist/types/getPermissionStatus.d.ts

@@ -43,6 +43,7 @@ export declare const PermissionName: {
     readonly user_info_yahoo_premium_user: "user_info_yahoo_premium_user";
     readonly user_info_tpoint: "user_info_tpoint";
     readonly mini_app_transaction: "mini_app_transaction";
+    readonly mini_app_device_esim_info: "mini_app_device_esim_info";
 };
 export declare type PermissionNameType = (typeof PermissionName)[keyof typeof PermissionName];
 export declare type Permission = {

package/dist/types/getTransactionInfo.d.ts

@@ -14,10 +14,14 @@ export declare type TransactionItem = {
     status: TransactionStatusType;
     errorCode: string;
     amount: Amount;
-    storeId: string;
-    storeName: string;
+    storeId?: string;
+    storeName?: string;
     merchantId: string;
-    merchantName: string;
+    merchantName?: string;
+    description: string;
+    cashbacks?: {
+        name: string;
+    }[];
 };
 export declare const TransactionStatus: {
     readonly CREATED: "CREATED";

package/dist/types.d.ts

@@ -166,6 +166,7 @@ export interface RenderSmartButtonParams extends NativeParams<MiniAppResult> {
     getDefault?: boolean;
     renderId?: string;
     redirectUrl?: string;
+    redirectType?: RedirectType;
 }
 export declare type Locale = 'ja' | 'en';
 export declare type Translation = Record<string, string>;
@@ -387,7 +388,7 @@ export declare type CoreCallUtilMessageData = {
     forWindowBridge?: boolean;
 };
 export declare type ClientMessageData = {
-    name: Exclude<PPFunctionNameType, 'renderCoupons'>;
+    name: PPFunctionNameType;
     params?: unknown;
     messageId: string;
     forWindowBridge?: boolean;
@@ -444,7 +445,6 @@ export declare const PPFunctionName: {
     readonly showErrorSheet: "showErrorSheet";
     readonly getPlatformInformation: "getPlatformInformation";
     readonly share: "share";
-    readonly setTitle: "setTitle";
     readonly getTopBarHeight: "getTopBarHeight";
     readonly openWebview: "openWebview";
     readonly openMap: "openMap";
@@ -465,13 +465,11 @@ export declare const PPFunctionName: {
     readonly request: "request";
     readonly getDeviceInformation: "getDeviceInformation";
     readonly debug: "debug";
-    readonly copyToClipboard: "copyToClipboard";
     readonly createOrder: "createOrder";
     readonly handleMessageFromNative: "handleMessageFromNative";
     readonly initKycPassport: "initKycPassport";
     readonly smsAuth: "smsAuth";
     readonly getKycPassportInfo: "getKycPassportInfo";
-    readonly renderCoupons: "renderCoupons";
 };
 export declare type PPFunctionNameType = (typeof PPFunctionName)[keyof typeof PPFunctionName];
 export declare const PPUtilFunctionName: {

package/dist/utils/analytics.d.ts

@@ -2,17 +2,23 @@ import { PPFunctionNameType } from '../types';
 import { PPEnvType } from '../types/init';
 interface EventParams {
     env: PPEnvType;
-    event_category: string;
-    event_label?: string;
+    event_category?: string;
+    event_label?: unknown;
     screen_name: string;
     event_action?: string;
     error_value?: string;
     event_label2?: unknown;
+    merchant_id?: string;
 }
 interface Options {
     env?: PPEnvType;
     sendImmediately?: boolean;
 }
+export declare function getEventCategory(params?: {
+    sdkType?: string;
+    clientId?: string;
+    featureName?: string;
+}): string;
 export declare function logSDKEvent(eventName: string, eventParams: Omit<EventParams, 'env'>, { env, sendImmediately }?: Options): void;
 export declare function handleLogSDKEvent(name: PPFunctionNameType, eventActionSuffix: string, errorValue?: string, params?: unknown): void;
 export {};

package/dist/utils/getLanguage.d.ts

@@ -1,403 +1,2 @@
-export declare function getLanguage(): {
-    smsAuth: {
-        title: string;
-        subTitle: string;
-        subInfo: string;
-        help: string;
-        resend1: string;
-        resendText: string;
-        questionText: string;
-        authenticateBtn: string;
-        invalidOtpError: string;
-        errorOverLimitTitle: string;
-        errorOverLimitText: string;
-        defaultBtnText: string;
-        errorBtnText: string;
-        errorResendTitle: string;
-        errorResendText: string;
-        defaultErrordesc: string;
-        errorOverVerifyLimitTitle: string;
-        errorOverVerifyLimitText: string;
-        errorExpireTitle: string;
-        errorExpireText: string;
-        errorVerifyLimit: string;
-        errorVerifyText: string;
-        cancel: string;
-        close: string;
-    };
-    initKycPassport: {
-        UNACCEPTABLE_OP: {
-            text: string;
-            desc: string;
-            btnText1: string;
-            btnText2: string;
-        };
-        KYC_UPDATE_REQUIRED: {
-            text: string;
-            desc: string;
-            btnText1: string;
-            btnText2: string;
-        };
-        NOT_COMPLETED: {
-            text: string;
-            desc: string;
-            btnText1: string;
-            btnText2: string;
-        };
-        KYC_VALIDATION_IN_PROCESS: {
-            text: string;
-            desc: string;
-            btnText1: string;
-            btnText2: string;
-        };
-        DEFAULT: {
-            text: string;
-            desc: string;
-            btnText1: string;
-            btnText2: string;
-        };
-        updateWarning: {
-            title: string;
-            description: string;
-            update: string;
-            cancel: string;
-        };
-    };
-    showUpdateWarning: {
-        closeBtn: string;
-        notNow: string;
-        update: string;
-        title: string;
-        errorText: string;
-        desc1: string;
-        desc2: string;
-    };
-    openApp: {
-        title: string;
-        body: string;
-        errorText: string;
-        openApp: string;
-        cancel: string;
-    };
-    openMap: {
-        title: string;
-        errorText: string;
-    };
-    payment: {
-        title: string;
-        payAmount: string;
-        payAmountTaxExempt: string;
-        method: string;
-        address: string;
-        insufficientAmount: string;
-        paying: string;
-        pay: string;
-        charge: string;
-        cancel: string;
-        noAddress: string;
-        change: string;
-        close: string;
-        noCashBack: string;
-    };
-    duplicate: {
-        header: string;
-        text1: string;
-        text2: string;
-        cancel: string;
-        agreeButtonText: 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: {
-        title: string;
-        chargeTitle: string;
-        chargeLabel: string;
-        loading: string;
-        unavailable1: string;
-        unavailable2: string;
-        amount: string;
-        return: string;
-    };
-    choosePayment: {
-        title: string;
-        desc1: string;
-        desc2: string;
-        title2: string;
-        addMethod: string;
-        noMethod: string;
-    };
-    topupCompletion: {
-        title: string;
-        idInfo: string;
-        copied: string;
-    };
-    userAddress: {
-        title: string;
-        header: string;
-        tagForm: string;
-        home: string;
-        work: string;
-        billing: string;
-        footer: string;
-        titlePre: string;
-        titleApp: string;
-        titlePlace: string;
-        receiverPre: string;
-        receiverPlace: string;
-        inputPre: string;
-        statePre: string;
-        statePlace: string;
-        cityPre: string;
-        cityPlace: string;
-        street1Pre: string;
-        streetPlace: string;
-        street2Pre: string;
-        street2Place: string;
-        footerBtn1: string;
-        footerBtn2: string;
-        displayTitle: string;
-        deleteTitle: string;
-        delete: string;
-        close: string;
-        addAddress: string;
-        address: string;
-        return: string;
-        change: string;
-        noAddress: string;
-        registerAddress: string;
-        confirmAddress: string;
-        returnEdit: string;
-        selectAddress: string;
-        selectDeliveryAddress: string;
-    };
-    errorSheet: {
-        title: string;
-        title1: string;
-        desc: string;
-        topup: string;
-        topupDesc: string;
-        pay: string;
-        payDesc: string;
-        payPeriod: string;
-        tryAgain: string;
-    };
-    paymentMethod: {
-        expired: string;
-        ordinary: string;
-        current: string;
-        checkGreen: string;
-        authenticated: string;
-        yjTitle: string;
-        ppCardTitle: string;
-        brand: string;
-    };
-    paymentMethodStatus: {
-        ACTIVATED: string;
-        OFF: string;
-        APPLYING: string;
-        MAINTENANCE: string;
-        BUSY: string;
-        SUSPENDED: string;
-    };
-    softbank: {
-        desc: string;
-        desc1: string;
-        isDisable: string;
-    };
-    registerEmail: {
-        title: string;
-        warning: string;
-        cancelTxt: string;
-        errorTitleAlreadyRegistered: string;
-        errorDescriptionAlreadyRegistered: string;
-        errorTitle: string;
-        errorDescription: string;
-    };
-    smartLogin: {
-        title: string;
-        signIn: string;
-        continueAs: string;
-    };
-    smartPay: {
-        pay: string;
-        paypay: string;
-        cashback: string;
-    };
-    cashbackList: {
-        close: string;
-        condition: string;
-    };
-    desktopTitle: {
-        Payment: string;
-        addNewAddress: string;
-        editAddress: string;
-        paymentCompletion: string;
-        getUserAddress: string;
-    };
-    closeConfirmation: {
-        title: string;
-        confirm: string;
-        cancel: string;
-    };
-    registerUserInfo: {
-        kycDataTitle: string;
-        uneditableDataTitle: string;
-        unenteredInfoTitle: string;
-        footer: {
-            description: string;
-            backButton: string;
-            nextButton: string;
-            finishButton: string;
-            cancelButton: string;
-        };
-        cancelSheet: {
-            title: string;
-            text: string;
-            confirmButton: string;
-        };
-        kycSheet: {
-            title: string;
-            text: string;
-            confirmButton: string;
-        };
-        mailSheet: {
-            title: string;
-            text: string;
-            confirmButton: string;
-        };
-        defaultErrorSheet: {
-            title: string;
-            text: string;
-        };
-        validation: {
-            numberError: string;
-            alphabetError: string;
-            alphabetLength32Error: string;
-            katakanaError: string;
-            katakanaLength16Error: string;
-            lengthError: string;
-        };
-        emailInput: string;
-        emailNotVerified: string;
-        emailNotVerifiedDescription: string;
-        change: string;
-        cancel: string;
-    };
-    getBankInfo: {
-        title: string;
-        close: string;
-    };
-    '3dSecureSheet': {
-        title: string;
-        descriptionForYJCardOrPPCard: string;
-        description: string;
-        setting3DSecure: string;
-        about3DSecure: string;
-        close: string;
-    };
-    registerPaymentFeatures: {
-        autoTopupRoot: {
-            title: string;
-            titleNeedUpdate: string;
-            description: string;
-            minAmount: string;
-            unit: string;
-            addTopupMethod: string;
-            noActivatedTopupMethod: string;
-            topupNotice: string;
-            updateWarning: {
-                message: string;
-                update: string;
-                cancel: string;
-            };
-            viewdetails: string;
-            eMoneyOnly: string;
-            topupNoticeEmoneyOnlyTitle: string;
-            topupNoticeEmoneyOnlyDesc: string;
-        };
-        autoTopupRootFooter: {
-            enable: string;
-            notice: string;
-            notNow: string;
-        };
-        amountChange: {
-            title: string;
-            description: string;
-            register: string;
-            cancel: string;
-        };
-        amountError: {
-            changeLimit: string;
-            close: string;
-        };
-        defaultError: {
-            title: string;
-            description: string;
-        };
-        autoTopupConfirmation: {
-            title: string;
-            description: string;
-            change: string;
-            cancel: string;
-        };
-        autoTopupSettingComplete: {
-            title: string;
-            description: string;
-            finish: string;
-        };
-        setupTopupMethod: {
-            title: string;
-            description: string;
-            finish: string;
-            cancel: string;
-        };
-        selectTopupAmount: {
-            title: string;
-            recommend: string;
-            close: string;
-            unit: string;
-        };
-        fallbackMethod: {
-            updateWarning: {
-                description: string;
-                update: string;
-                close: string;
-            };
-        };
-    };
-    getKycPassport: {
-        fallbackSmsSheet: {
-            title: string;
-            text: string;
-            button: string;
-            buttonClose: string;
-        };
-    };
-};
-export declare function getPayPayLanguage(): string;
+import { Locale } from '../types';
+export declare function getPayPayLanguage(): Locale;

package/dist/utils/helper.d.ts

@@ -41,8 +41,6 @@ export declare enum MiniAppRuntime {
 export declare function getRuntime(): MiniAppRuntime;
 export declare function isPayPayMiniApp(): boolean;
 export declare function getAppVersion(): string | null;
-export declare function getEventLabel(merchant?: string | null): string;
-export declare function getEventCategory(): string;
 export declare function semVerCompare(a: string, b: string): boolean;
 export declare function checkVersion(minVersion: string): boolean;
 export declare function getPlatformFontSize(): FontSize;
@@ -53,7 +51,7 @@ export declare const createErrorCode: (errorCode: MiniAppErrorType, jws?: string
 };
 export declare function updateLocalisedString(data: string, target: string, value: string): string;
 export declare function handleHeightResize(el: HTMLElement, windowHeight: number, isScrollable: boolean, offsetHeight: number): boolean;
-export declare function getPaymentMethodStatus(isExpired: boolean, paymentMethodInfo?: BankInfo | CreditCardInfo | SbidBankInfo | PayLaterCCInfo): unknown;
+export declare function getPaymentMethodStatus(isExpired: boolean, paymentMethodInfo?: BankInfo | CreditCardInfo | SbidBankInfo | PayLaterCCInfo): string;
 export declare function filterErrorButtonList(buttonList: UIComponentsErrorButton[] | null): UIComponentsErrorButton[] | undefined;
 export declare function getFailErrorCode(ppFetchResult: string): MiniAppErrorType.timeOut | MiniAppErrorType.serverError | MiniAppErrorType.tokenExpired | MiniAppErrorType.notAuthorized;
 export declare function getStoreUrl(): "https://play.google.com/store/apps/details?id=jp.ne.paypay.android.app" | "https://itunes.apple.com/app/id1435783608";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paypay/mini-app-js-sdk",
-  "version": "2.18.0",
+  "version": "2.20.0",
   "private": false,
   "scripts": {
     "build": "yarn build:client && yarn build:core && yarn build:init",
@@ -21,6 +21,9 @@
     "upgrade": "yarn upgrade-interactive",
     "test": "jest --silent --coverage",
     "test:watch": "jest --watch",
+    "e2e:record": "playwright test",
+    "e2e:replay": "REPLAY=true yarn playwright test",
+    "e2e:update": "yarn e2e:replay --update-snapshots",
     "preview": "yarn dev:client & vite preview --config vite.config.core.ts --port 3100"
   },
   "license": "MIT",
@@ -41,6 +44,7 @@
     "@babel/preset-env": "^7.15.4",
     "@braintree/browser-detection": "^1.16.0",
     "@pinia/testing": "^0.0.12",
+    "@playwright/test": "^1.40.1",
     "@rollup/plugin-html": "^1.0.2",
     "@rollup/plugin-replace": "^3.0.0",
     "@rollup/plugin-terser": "^0.4.3",
@@ -52,6 +56,7 @@
     "@types/jest": "^26.0.24",
     "@types/js-cookie": "^2.2.7",
     "@types/lodash": "^4.14.195",
+    "@types/node": "^20.10.3",
     "@types/ua-parser-js": "^0.7.36",
     "@types/uuid": "^8.3.1",
     "@typescript-eslint/eslint-plugin": "^5.58.0",
@@ -78,6 +83,7 @@
     "jest-transform-stub": "^2.0.0",
     "less": "^4.1.1",
     "lint-staged": "^11.1.2",
+    "lodash": "^4.17.21",
     "lottie-web": "^5.9.6",
     "npm-run-all": "^4.1.5",
     "pinia": "^2.0.20",

package/dist/model/bridge/copyToClipboard.d.ts

@@ -1,2 +0,0 @@
-import { CopyToClipBoardParams } from '../../types';
-export declare function copyToClipboard(copyTextParams: CopyToClipBoardParams): void;

package/dist/model/bridge/getLoginUrl.d.ts

@@ -1,11 +0,0 @@
-import { MiniAppFunctionContext, PostLogInRedirectParams } from '../../types';
-import { PKCEChallengeType } from '../../types/getAuthStatus';
-interface GetLoginUrlParams extends PostLogInRedirectParams {
-    pkceCodeChallenge: PKCEChallengeType;
-    scopes?: Array<string>;
-}
-export declare const getLoginUrlEndpoint = "public/auth/v1/loginUrl";
-export declare function getLoginUrl({ pkceCodeChallenge, postLoginRedirectUrl, postLoginRedirectType, scopes, }: GetLoginUrlParams): Promise<string>;
-export declare function getLoginUrlWithPkce(params: Omit<GetLoginUrlParams, 'pkceCodeChallenge'>, clientOrigin: string): Promise<string>;
-export declare function getLoginUrlIfUserNotSignedIn(params: Omit<GetLoginUrlParams, 'pkceCodeChallenge'>, context: MiniAppFunctionContext): Promise<string | undefined>;
-export {};

package/dist/model/bridge/getSessionData.d.ts

@@ -1,2 +0,0 @@
-import { GetDataParams } from '../../types';
-export declare function getSessionData(getDataParams: GetDataParams): void;

package/dist/model/bridge/getStorageData.d.ts

@@ -1,2 +0,0 @@
-import { GetDataParams } from '../../types';
-export declare function getStorageData(getDataParams: GetDataParams): void;

package/dist/model/bridge/removeStorageData.d.ts

@@ -1,2 +0,0 @@
-import { RemoveDataParams } from '../../types';
-export declare function removeStorageData(params: RemoveDataParams): void;

package/dist/model/bridge/setSessionData.d.ts

@@ -1,2 +0,0 @@
-import { SetDataParams } from '../../types';
-export declare function setSessionData(setDataParams: SetDataParams): void;

package/dist/model/bridge/setStorageData.d.ts

@@ -1,2 +0,0 @@
-import { SetDataParams } from '../../types';
-export declare function setStorageData(setDataParams: SetDataParams): void;

package/dist/model/bridge/setTitle.d.ts

@@ -1,2 +0,0 @@
-import { SetTitleParams } from '../../types';
-export declare function setTitle(setTitleParams: SetTitleParams): void;