@paypay/mini-app-js-sdk 2.31.0 → 2.37.0

package/dist/resources/locales/smartPayment/en.d.ts

@@ -5,9 +5,19 @@ declare const _default: {
         continueAs: string;
     };
     smartPay: {
-        pay: string;
         paypay: string;
         cashback: string;
     };
+    type: {
+        payment: {
+            pay: string;
+        };
+        donation: {
+            pay: string;
+        };
+        remittance: {
+            pay: string;
+        };
+    };
 };
 export default _default;

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

@@ -5,9 +5,19 @@ declare const _default: {
         continueAs: string;
     };
     smartPay: {
-        pay: string;
         paypay: string;
         cashback: string;
     };
+    type: {
+        payment: {
+            pay: string;
+        };
+        donation: {
+            pay: string;
+        };
+        remittance: {
+            pay: string;
+        };
+    };
 };
 export default _default;

package/dist/types/init.d.ts

@@ -1,4 +1,5 @@
 import { NativeParams } from '../jsbridge-core/jsbridge';
+import { SdkType } from '../types';
 export interface InitClientParams extends NativeParams<InitResult> {
     clientId: string;
     env?: PPEnvType;
@@ -17,6 +18,7 @@ export interface InitParams extends NativeParams<InitResult> {
     clientVersion?: string;
     debugMode?: boolean;
     useAllFunctions?: boolean;
+    clientSdkType?: SdkType;
 }
 export declare const PPEnv: {
     readonly staging: "staging";

package/dist/types/makePayment.d.ts

@@ -1,5 +1,10 @@
 import { NativeParams } from '../jsbridge-core/jsbridge';
 import { Address } from '../types/getUserAddress';
+export declare const Order: {
+    readonly ACQUIRING: "ACQUIRING";
+    readonly REMITTANCE: "REMITTANCE";
+};
+export declare type OrderType = (typeof Order)[keyof typeof Order];
 export interface MakePaymentParams extends NativeParams<MakePaymentResult> {
     amount: Amount;
     merchantPaymentId: string;
@@ -28,6 +33,7 @@ export interface MakePaymentParams extends NativeParams<MakePaymentResult> {
         };
     };
     merchantTimeoutAt?: number;
+    orderType?: OrderType;
 }
 export interface Amount {
     amount: number;
@@ -44,3 +50,7 @@ export declare type MakePaymentResult = {
     jws: string;
     address: Address | null;
 };
+export declare const PaymentConsultResultCode: {
+    EKYC_REQUIRED: string;
+    INSUFFICIENT_BALANCE_AND_NO_AVAILABLE_TOPUP_METHOD: string;
+};

package/dist/types.d.ts

@@ -1,8 +1,8 @@
-import { ButtonType } from './package/button';
 import { AuthStatusFailResult } from './types/getAuthStatus';
 import { Permission } from './types/getPermissionStatus';
 import { NativeParams, NativeResponse } from './jsbridge-core/jsbridge';
 import { MiniAppErrorType } from './model/miniAppError';
+import { OrderType } from './types/makePayment';
 declare global {
     type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 }
@@ -143,6 +143,7 @@ export declare type SmartButtonType = 'login' | 'pay';
 export declare type SmartButtonSize = 'lg' | 'sm';
 export declare type SmartButtonTheme = 'light' | 'dark' | 'red';
 export declare type SmartButtonLg = 'en' | 'ja';
+export declare type PaymentLabelType = 'payment' | 'donation' | 'remittance';
 export interface RenderSmartButtonParams extends NativeParams<MiniAppResult> {
     type: SmartButtonType;
     containerId: string;
@@ -219,6 +220,7 @@ export interface SmartPayParams {
             mandatory: boolean;
         };
     };
+    orderType?: OrderType;
 }
 export interface UserInfo {
     avatarUrl: string;
@@ -244,6 +246,7 @@ export declare type AppDetail = {
     version: string;
     statusDescription: string;
     userAuthorizationId: string;
+    externalUserId: string;
     permissions: Permission[];
     isInternal: boolean;
     terms: Array<{
@@ -329,6 +332,7 @@ export declare type SessionResponse = {
     };
 };
 export declare type ResultErrorType = MiniAppErrorResultType | AuthStatusFailResult;
+export declare type ButtonType = 'default' | 'primary' | 'success' | 'warning' | 'danger' | 'link' | 'outLined';
 export declare type ErrorSheetButton = {
     title: string;
     buttonType: 'BLUE' | 'WHITE' | ButtonType;
@@ -404,9 +408,6 @@ export declare type CashbackResponse = {
         };
     };
 };
-export interface ShowStorageAccessPermissionAlertParams extends NativeParams<void> {
-    clientUrl: string;
-}
 export declare type LinkOption = {
     url: string;
     target?: string;
@@ -489,6 +490,10 @@ export declare type ClientJsBridge = {
 export declare type ConsoleDebugInfoParams = {
     params: unknown[];
 };
+export declare enum SdkType {
+    MiniApp = "MiniApp",
+    SmartPayment = "SmartPayment"
+}
 export interface PayPayCallStackParamsType {
     complete?: () => void;
     [index: string]: unknown;
@@ -498,6 +503,7 @@ declare global {
     interface Window {
         _ppcs?: PayPayCallStackType;
         _ppsl?: boolean;
+        _PayPayJsBridge?: ClientJsBridge;
     }
 }
 export {};

package/dist/utils/analytics.d.ts

@@ -1,4 +1,4 @@
-import { PPFunctionNameType } from '../types';
+import { PPFunctionNameType, SdkType } from '../types';
 import { PPEnvType } from '../types/init';
 interface EventParams {
     env: PPEnvType;
@@ -9,6 +9,8 @@ interface EventParams {
     error_value?: string;
     event_label2?: unknown;
     merchant_id?: string;
+    order_type?: string;
+    user_agent?: string;
 }
 interface Options {
     env?: PPEnvType;
@@ -24,5 +26,6 @@ export declare function handleLogSDKEvent(name: PPFunctionNameType, eventActionS
 export declare function test_initClientState(params: {
     clientId: string;
     clientOrigin: string;
+    clientSdkType?: SdkType;
 }): void;
 export {};

package/dist/utils/fetch.d.ts

@@ -17,6 +17,7 @@ declare type PPFetchOptions = {
     skipResultCodeCheck?: boolean;
     skipStatusCodeCheck?: boolean;
     authorizationRequired?: boolean;
+    priority?: 'high' | 'low' | 'auto';
 };
 declare type APIBaseResponse = {
     signed: {

package/dist/utils/getAppDetail.d.ts

@@ -0,0 +1,6 @@
+import { SerializedAppDetail } from '../utils/storage';
+import { Ref } from 'vue';
+export declare function fetchAppDetail(accessToken?: string, options?: {
+    priority?: 'high' | 'low';
+}): Promise<SerializedAppDetail>;
+export declare function useAppDetail(): Ref<SerializedAppDetail | null>;

package/dist/utils/helper.d.ts

@@ -1,10 +1,11 @@
 import { MiniAppErrorType } from '../model/miniAppError';
-import { BankInfo, CreditCardInfo, SbidBankInfo, PayLaterCCInfo } from '../model/makePayment';
+import { BankInfo, CreditCardInfo, SbidBankInfo, PayLaterCCInfo, PaymentMethod } from '../model/makePayment';
 import { UIComponentsErrorButton } from '../model/uiComponents';
-import { ErrorSheetButton } from '../types';
+import { ErrorSheetButton, PaymentLabelType, SmartPayParams } from '../types';
 import { FontSize } from '../types/getPlatformInformation';
 import { NativeParams } from '../jsbridge-core/jsbridge';
 import { App } from 'vue';
+import { OrderType, MakePaymentParams } from '../types/makePayment';
 export declare function isDef<T>(val: T): val is NonNullable<T>;
 export declare function isFunction(val: unknown): val is () => void;
 export declare function isNumeric(val: string | number): val is string;
@@ -45,6 +46,7 @@ export declare function isPayPayMiniApp(): boolean;
 export declare function getAppVersion(): string | null;
 export declare function semVerCompare(a: string, b: string): boolean;
 export declare function checkVersion(minVersion: string): boolean;
+export declare function checkJSSDKVersion(minVersion: string): boolean;
 export declare function getPlatformFontSize(): FontSize;
 export declare function delay(time?: number): Promise<boolean>;
 export declare const createErrorCode: (errorCode: MiniAppErrorType, jws?: string | null | undefined) => {
@@ -55,18 +57,34 @@ export declare function updateLocalisedString(data: string, target: string, valu
 export declare function handleHeightResize(el: HTMLElement, windowHeight: number, isScrollable: boolean, offsetHeight: number): boolean;
 export declare function getPaymentMethodStatus(isExpired: boolean, paymentMethodInfo?: BankInfo | CreditCardInfo | SbidBankInfo | PayLaterCCInfo): string;
 export declare function filterErrorButtonList(buttonList: UIComponentsErrorButton[] | null): UIComponentsErrorButton[] | undefined;
+export declare function hasOmittedPrimaryButton(params: {
+    originalButtonList: UIComponentsErrorButton[];
+    filteredButtonList: UIComponentsErrorButton[] | undefined;
+}): boolean;
+export declare function checkPrimaryButtonNotPresent(buttonList: UIComponentsErrorButton[] | undefined): boolean;
 export declare function getFailErrorCode(ppFetchResult: string): MiniAppErrorType.timeOut | MiniAppErrorType.serverError | MiniAppErrorType.tokenExpired | MiniAppErrorType.notAuthorized | MiniAppErrorType.rateLimitExceeded;
 export declare function getStoreUrl(): "https://play.google.com/store/apps/details?id=jp.ne.paypay.android.app" | "https://itunes.apple.com/app/id1435783608";
 export declare function generateCodeVerifier(length?: number): string;
 export declare function generateCodeChallenge(codeVerifier: string): Promise<string>;
 export declare function openUrl(linkUrl: string): void;
-export declare function getButtonType(button: UIComponentsErrorButton | ErrorSheetButton, onlyButton?: boolean): "success" | "default" | "link" | "primary" | "warning" | "danger" | "outLined";
+export declare function getButtonType(button: UIComponentsErrorButton | ErrorSheetButton, primary?: boolean): "success" | "default" | "link" | "primary" | "warning" | "danger" | "outLined";
 export declare function getRandomString(): string;
 export declare function isAlphabet(value: string): boolean;
 export declare function reconstructKycPassportCallbackUrl(url: string, type: string): string;
 export declare function getValueFromUA(paramName: string): string | undefined;
+export declare function isBffSitEnvironment(): boolean;
 export declare function replaceStringPlaceholders(str: string, values: Record<string, string>): string;
 export declare function validateUrl(url: string): boolean;
 export declare function constructUrl(baseUrl: string, params: Record<string, string | string[] | number | number[] | boolean | undefined>): string;
 export declare function makeDefaultErrorHandler(app: App, params: NativeParams<never> | undefined): (err: unknown) => void;
+export declare function getCardBrandImage(brandName: string): string;
+export declare function hasMultiplePPCD(paymentMethods: PaymentMethod[] | undefined): boolean;
+export declare function addAdditionalInfoForMultiplePPCD(paymentMethods: PaymentMethod[]): void;
+declare type OrderInfo = SmartPayParams | MakePaymentParams;
+export declare function isValidOrderInfo(orderInfo: OrderInfo): boolean;
+export declare function isValidOrderType(orderType: string | undefined): boolean;
+export declare function getPaymentLabelType(orderType: OrderType | undefined, productType: string | undefined): PaymentLabelType;
+export declare function checkIfSdkUpgradeNeededForRemittance(orderType?: OrderType): boolean;
+export declare function isMobileSize(width: number): boolean;
+export declare function isDesktopSize(width: number): boolean;
 export {};

package/dist/utils/minimumJSSDKVersion.d.ts

@@ -0,0 +1,3 @@
+export declare const MinJSSDKVersion: {
+    ORDER_TYPE_REMITTANCE: string;
+};

package/dist/utils/storage.d.ts

@@ -1,3 +1,4 @@
+import { Window } from '../types';
 import { PPEnvType } from '../types/init';
 export declare function getAccessToken(): string | null;
 export declare function saveClaimCouponImmediately(couponId: string): void;
@@ -22,8 +23,19 @@ export declare function getLastTopupPayMethod(): string | null;
 export declare function getLastPayment(): string | null;
 export declare function saveLastTopup(topup: string): void;
 export declare function getLastTopup(): string;
-export declare function saveAppDetail(appDetail: string): void;
-export declare function getAppDetail(clientId?: string): string | null;
+export declare type SerializedAppDetail = {
+    appLogo: string | null;
+    appName: string | null;
+    englishName: string | null;
+    openUrl: string | null;
+    whiteListDomains: string[];
+    isInternal: boolean;
+    window: Window;
+    subdomainCookieSharing: boolean;
+    externalUserId?: string;
+};
+export declare function saveAppDetail(appDetail: SerializedAppDetail): void;
+export declare function getAppDetail(clientId?: string): SerializedAppDetail | null;
 export declare function removeAppDetail(): void;
 export declare function saveAppConfig(appConfig: string): void;
 export declare function getAppConfig(): string | null;
@@ -32,7 +44,6 @@ export declare function saveUserInfo(userData: string): void;
 export declare function removeCodeVerifier(): void;
 export declare function saveAuthorizedClientOrigin(clientId: string, origin: string): void;
 export declare function getAuthorizedClientOrigin(clientId: string): string | null;
-export declare function saveClientVersion(clientVersion: string): void;
 export declare function getClientVersion(): string;
 export declare function saveDebugMode(isDebugMode: boolean): void;
 export declare function getDebugMode(): boolean;

package/dist/utils/uiConstants.d.ts

@@ -0,0 +1 @@
+export declare const UI_BREAKPOINT = 767;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@paypay/mini-app-js-sdk",
-  "version": "2.31.0",
+  "version": "2.37.0",
   "private": false,
   "scripts": {
-    "build": "yarn build:client && yarn build:core && yarn build:init",
+    "build": "yarn build:client && yarn build:core",
     "build:miniApp": "SDK_TYPE=miniApp yarn build",
     "build:smartPayment": "SDK_TYPE=smartPayment yarn build",
     "build:client": "vite build",

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-import { PayPayJsBridge } from './mini-app-js-sdk';
-declare const paypayJsBridge: PayPayJsBridge;
-export default paypayJsBridge;

package/dist/jsbridge-core/lib/browser.d.ts

@@ -1,3 +0,0 @@
-import { JsBridge } from '../jsbridge';
-export declare function exposeJsBridge(jsBridge: JsBridge): boolean;
-export declare function exposePayPayJsBridge(paypayJsBridge: unknown): boolean;

package/dist/jsbridge-core/module.d.ts

@@ -1,13 +0,0 @@
-import { JsBridge, NativeParams } from './jsbridge';
-export declare abstract class JsBridgeModule {
-    jsBridge: JsBridge;
-    instances: Record<string, JsBridgeModule>;
-    state: {
-        executing: boolean;
-    };
-    isExecutableService: (params: NativeParams<never>) => boolean;
-}
-export interface JsBridgeModuleConstructor<M extends JsBridgeModule = JsBridgeModule> {
-    new (jsBridge: JsBridge): M;
-    readonly prototype: M;
-}

package/dist/jsbridge-core/paypay-jsbridge.d.ts

@@ -1,16 +0,0 @@
-import { JsBridge, NativeParams } from './jsbridge';
-import { JsBridgeModule, JsBridgeModuleConstructor } from './module';
-export declare class PayPayJsBridgeBase {
-    jsBridge: JsBridge;
-    instances: Record<string, JsBridgeModule>;
-    state: {
-        executing: boolean;
-    };
-    constructor(jsBridge: JsBridge);
-    isExecutableService(params: NativeParams<never>): boolean;
-}
-export interface PayPayJsBridgeBaseConstructor {
-    new (jsBridge: JsBridge): PayPayJsBridgeBase;
-    readonly prototype: PayPayJsBridgeBase;
-}
-export declare function composePayPayJsBridge(bridgeConstructor: PayPayJsBridgeBaseConstructor, ...moduleConstructors: JsBridgeModuleConstructor[]): void;

package/dist/mini-app-js-sdk.d.ts

@@ -1,10 +0,0 @@
-import { PayPayJsBridgeBase } from './jsbridge-core/paypay-jsbridge';
-import { JsBridge } from './jsbridge-core/jsbridge';
-import { MiniAppModule } from './mini-app-api';
-export declare class PayPayJsBridge extends PayPayJsBridgeBase {
-}
-export interface PayPayJsBridge extends MiniAppModule {
-}
-export declare const jsBridge: JsBridge;
-export declare const pp: PayPayJsBridge;
-export default pp;

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

@@ -1,3 +0,0 @@
-import { AppDetail } from '../../types';
-export declare function initAppDetail(accessToken: string): Promise<boolean>;
-export declare function getAppDetail(clientId?: string): AppDetail | null;

package/dist/package/button/index.d.ts

@@ -1,93 +0,0 @@
-import { PropType } from 'vue';
-export declare type ButtonType = 'default' | 'primary' | 'success' | 'warning' | 'danger' | 'link' | 'outLined';
-export declare type ButtonSize = 'large' | 'normal' | 'small';
-export declare const PButton: import("vue").DefineComponent<{
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    block: BooleanConstructor;
-    type: {
-        type: PropType<ButtonType>;
-        default: string;
-    };
-    size: {
-        type: PropType<ButtonSize>;
-        default: string;
-    };
-    tabIndex: {
-        type: NumberConstructor;
-        required: false;
-        default: number;
-    };
-    name: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-    disabledClassName: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-    class: {
-        type: (StringConstructor | ObjectConstructor)[];
-        required: false;
-        default: string;
-    };
-    noMargin: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-}, {
-    onClick: () => void;
-}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    click: () => true;
-}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    disabled: BooleanConstructor;
-    loading: BooleanConstructor;
-    block: BooleanConstructor;
-    type: {
-        type: PropType<ButtonType>;
-        default: string;
-    };
-    size: {
-        type: PropType<ButtonSize>;
-        default: string;
-    };
-    tabIndex: {
-        type: NumberConstructor;
-        required: false;
-        default: number;
-    };
-    name: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-    disabledClassName: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-    class: {
-        type: (StringConstructor | ObjectConstructor)[];
-        required: false;
-        default: string;
-    };
-    noMargin: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-}>> & {
-    onClick?: (() => any) | undefined;
-}, {
-    type: ButtonType;
-    name: string;
-    size: ButtonSize;
-    class: string | Record<string, any>;
-    loading: boolean;
-    disabled: boolean;
-    block: boolean;
-    tabIndex: number;
-    disabledClassName: string;
-    noMargin: boolean;
-}>;