@paypay/mini-app-js-sdk 2.41.0 → 2.48.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/dist/client/clientUtils.d.ts +2 -1
  2. package/dist/client/communicationWithCore.d.ts +16 -0
  3. package/dist/client/functions/copyToClipboard.d.ts +2 -0
  4. package/dist/client/functions/coreWindowBridgeFunctions.d.ts +12 -0
  5. package/dist/client/functions/getKycPassportInfo.d.ts +3 -0
  6. package/dist/client/functions/logout.d.ts +6 -0
  7. package/dist/client/functions/renderCoupons.d.ts +6 -0
  8. package/dist/client/functions/scanCode.d.ts +2 -0
  9. package/dist/client/functions/setTitle.d.ts +2 -0
  10. package/dist/client/functions/share.d.ts +2 -0
  11. package/dist/client/functions/storageFunctions.d.ts +6 -0
  12. package/dist/client/functions/verifyMultiFactorAuthResult.d.ts +3 -0
  13. package/dist/client/index.d.ts +4 -54
  14. package/dist/client/types.d.ts +37 -2
  15. package/dist/client/{clientFunctions → windowBridgeFunctions}/storageFunctions.d.ts +10 -0
  16. package/dist/client/{clientFunctions → windowBridgeFunctions}/urlFunctions.d.ts +1 -0
  17. package/dist/core/coreFunctions/fetchCoupons.d.ts +4 -0
  18. package/dist/core/coreFunctions/getLoginUrl.d.ts +5 -1
  19. package/dist/core/coreFunctions/index.d.ts +17 -7
  20. package/dist/core/coreFunctions/logEvent.d.ts +4 -0
  21. package/dist/core/coreFunctions/markAsReady.d.ts +4 -0
  22. package/dist/core/coreFunctions/middlewares/initRequired.d.ts +2 -0
  23. package/dist/core/coreFunctions/middlewares/loginRequired.d.ts +2 -0
  24. package/dist/core/coreUtils.d.ts +1 -1
  25. package/dist/core/index.d.ts +1 -1
  26. package/dist/environment-variables.d.ts +0 -1
  27. package/dist/jsbridge-core/jsbridge.d.ts +4 -5
  28. package/dist/mini-app-api.d.ts +4 -4
  29. package/dist/mini-app-js-sdk.browser.js +2 -2
  30. package/dist/mini-app-js-sdk.es.js +865 -1493
  31. package/dist/model/bridge/getPlatformInformation.d.ts +1 -1
  32. package/dist/model/bridge/getTopBarHeight.d.ts +1 -1
  33. package/dist/model/bridge/renderPayButton.d.ts +0 -6
  34. package/dist/model/miniAppError.d.ts +2 -5
  35. package/dist/package/lottie/lottie.d.ts +6 -6
  36. package/dist/types/checkPaymentMethod.d.ts +1 -1
  37. package/dist/types/getKycInformation.d.ts +3 -3
  38. package/dist/types/getKycPassportInfo.d.ts +2 -2
  39. package/dist/types/getPlatformInformation.d.ts +0 -1
  40. package/dist/types/init.d.ts +2 -3
  41. package/dist/types/makePayment.d.ts +421 -1
  42. package/dist/types/topup.d.ts +1 -1
  43. package/dist/types.d.ts +8 -2
  44. package/dist/utils/analytics.d.ts +1 -0
  45. package/dist/utils/api.d.ts +0 -1
  46. package/dist/utils/getAppDetail.d.ts +1 -0
  47. package/dist/utils/helper.d.ts +7 -4
  48. package/dist/utils/minimumAppVersion.d.ts +0 -5
  49. package/dist/utils/minimumJSSDKVersion.d.ts +1 -0
  50. package/dist/utils/storage.d.ts +0 -2
  51. package/dist/utils/windowBridge.d.ts +24 -3
  52. package/dist/views/coupon/components/Arrow/index.d.ts +5 -5
  53. package/dist/views/coupon/components/CouponAction/index.d.ts +27 -7
  54. package/dist/views/coupon/components/CouponContainer/index.d.ts +3 -3
  55. package/dist/views/coupon/index.d.ts +27 -7
  56. package/dist/views/registerPaymentFeatures/types.d.ts +1 -1
  57. package/package.json +55 -67
  58. package/dist/composition-api/useShowUpdateWarningKycPassport.d.ts +0 -4
  59. package/dist/model/makePayment.d.ts +0 -430
  60. package/dist/types/getLoginUrl.d.ts +0 -8
  61. /package/dist/client/{clientFunctions → windowBridgeFunctions}/index.d.ts +0 -0
@@ -1,430 +0,0 @@
1
- import { PPFetchResult } from '../utils/fetch';
2
- import { MiniAppErrorType } from './miniAppError';
3
- import { UIComponentsError } from './uiComponents';
4
- import { Amount, OrderItem, OrderType } from '../types/makePayment';
5
- export declare type PaymentQuery = {
6
- merchant?: string;
7
- agreeSimilarTransaction: boolean;
8
- };
9
- interface PaymentBody {
10
- merchantPaymentId: string;
11
- amount: Amount;
12
- orderReceiptNumber?: string;
13
- orderDescription?: string;
14
- orderItems?: Array<OrderItem>;
15
- metaData?: unknown;
16
- storeId?: string;
17
- paymentMethodId: string;
18
- terminalId?: number | string;
19
- merchantAlias?: string;
20
- requestedAt?: number;
21
- productType?: string;
22
- storeInfo?: string;
23
- metadata?: unknown;
24
- expiresAt?: number;
25
- merchant?: string;
26
- }
27
- export declare type Balance = {
28
- balance: number;
29
- currency: 'JPY';
30
- usable: boolean;
31
- };
32
- export declare const PaymentMethodName: {
33
- readonly WALLET: "WALLET";
34
- readonly CREDIT_CARD: "CREDIT_CARD";
35
- readonly BANK: "BANK";
36
- readonly YMONEY_BANK: "YMONEY_BANK";
37
- readonly SBID_CARRIER_BILLING: "SBID_CARRIER_BILLING";
38
- readonly PAY_LATER: "PAY_LATER";
39
- readonly PAY_LATER_CC: "PAY_LATER_CC";
40
- };
41
- export declare type PaymentMethodNameType = (typeof PaymentMethodName)[keyof typeof PaymentMethodName];
42
- declare type GlobalLimitInfo = {
43
- topup?: {
44
- min: number;
45
- max: number;
46
- formattedMax: string;
47
- formattedMin: string;
48
- };
49
- };
50
- declare type MethodBase = {
51
- paymentMethodId: string;
52
- paymentMethodType: PaymentMethodNameType;
53
- descriptionBannerInfo?: BannerInfo;
54
- walletInfo?: unknown;
55
- creditCardInfo?: unknown;
56
- bankInfo?: unknown;
57
- sbidCarrierBillingInfo?: unknown;
58
- payLaterCcInfo?: unknown;
59
- paymentMethodDescriptionInfo?: {
60
- statusDescription: DescriptionInfo | null;
61
- additionalDescription: DescriptionInfo | null;
62
- detailDescription: DescriptionInfo | null;
63
- label?: DescriptionInfo | null;
64
- amountInfo?: {
65
- label: string;
66
- amount: number;
67
- currency: string;
68
- };
69
- };
70
- feeInfo?: TopupFeeInfo;
71
- globalLimitInfo?: GlobalLimitInfo;
72
- };
73
- export declare type DescriptionInfo = {
74
- text: string;
75
- linkUrl?: string;
76
- headerIcon?: string;
77
- isBold: boolean;
78
- color: string;
79
- backgroundColor?: string;
80
- };
81
- export declare type BannerInfo = {
82
- label?: string;
83
- title?: string;
84
- iconImageUrl?: string;
85
- displayResponse?: UIComponentsError;
86
- };
87
- export declare type WalletMethod = MethodBase & {
88
- paymentMethodType: 'WALLET';
89
- walletInfo?: {
90
- cashBackBalanceInfo?: Balance;
91
- cashBackExpirableBalanceInfo?: Balance;
92
- emoneyBalanceInfo?: Balance;
93
- prepaidBalanceInfo?: Balance;
94
- isPreTransactionAutoChargeEnabled?: boolean;
95
- walletSummary?: {
96
- totalBalanceInfo: Balance;
97
- payoutableBalanceInfo: Balance;
98
- transferableBalanceInfo: Balance;
99
- };
100
- walletDetail?: {
101
- emoneyBalanceInfo?: Balance;
102
- totalEmoneyBalanceInfo?: Balance;
103
- prepaidBalanceInfo?: Balance;
104
- cashBackBalanceInfo?: Balance;
105
- cashBackExpirableBalanceInfo?: Balance;
106
- };
107
- };
108
- };
109
- export declare enum CreditTypes {
110
- VISA = "VISA",
111
- MASTER = "MASTER",
112
- JCB = "JCB",
113
- DINERS = "D",
114
- AMEX = "A",
115
- OTHER = "O"
116
- }
117
- export declare enum PaymentMethodStatus {
118
- ACTIVATED = "ACTIVATED",
119
- OFF = "OFF",
120
- APPLYING = "APPLYING",
121
- MAINTENANCE = "MAINTENANCE",
122
- BUSY = "BUSY",
123
- SUSPENDED = "SUSPENDED"
124
- }
125
- export declare enum PayPayCardType {
126
- GOLD = "GOLD",
127
- REGULAR = "REGULAR"
128
- }
129
- export declare type CreditCardInfo = {
130
- brand?: CreditTypes;
131
- isAuthenticated?: boolean;
132
- isExpired?: boolean;
133
- isYjCard?: boolean;
134
- last4digits?: string;
135
- ccType?: string;
136
- paymentMethodStatus?: PaymentMethodStatus;
137
- preTransactionAutoChargeSupported?: boolean;
138
- paymentMethodStatusLabel?: string;
139
- };
140
- export declare type CreditMethod = MethodBase & {
141
- paymentMethodType: 'CREDIT_CARD';
142
- creditCardInfo?: CreditCardInfo;
143
- };
144
- export declare enum bankCode {
145
- MIZUHO_BANK_CODE = "0001",
146
- MUFJ_BANK_CODE = "0005",
147
- SMBC_BANK_CODE = "0009",
148
- RESONA_BANK_CODE = "0010",
149
- S_RESONA_BANK_CODE = "0017",
150
- JNB_BANK_CODE = "0033",
151
- YUCHO_BANK_CODE = "9900",
152
- AEON_BANK_CODE = "0040",
153
- JIBUN_BANK_CODE = "0039",
154
- SBI_BANK_CODE = "0038"
155
- }
156
- export declare enum status {
157
- 'ACTIVATED' = "",
158
- 'OFF' = "\u7121\u52B9",
159
- 'APPLYING' = "\u5229\u7528\u4E0D\u53EF",
160
- 'MAINTENANCE' = "\u30E1\u30F3\u30C6\u30CA\u30F3\u30B9\u4E2D",
161
- 'BUSY' = "\u5229\u7528\u4E0D\u53EF",
162
- 'SUSPENDED' = "\u5229\u7528\u4E0D\u53EF"
163
- }
164
- export declare type BankInfo = {
165
- paymentMethodStatusLabel?: string;
166
- paymentMethodStatus?: PaymentMethodStatus;
167
- bankName?: string;
168
- bankLogoUrl?: string;
169
- bankCode?: string;
170
- bankCardImage?: {
171
- cardUrl: string;
172
- textColor: string;
173
- uiColor: string;
174
- };
175
- bankBranchName?: string;
176
- bankBranchCode?: string;
177
- bankAccountType?: string;
178
- bankAccountNumberLast2digits?: string;
179
- preTransactionAutoChargeSupported?: boolean;
180
- showAmount?: boolean;
181
- };
182
- export declare type BankMethod = MethodBase & {
183
- paymentMethodType: 'BANK' | 'YMONEY_BANK';
184
- bankInfo?: BankInfo;
185
- };
186
- export declare type SbidBankMethod = MethodBase & {
187
- paymentMethodType: 'SBID_CARRIER_BILLING';
188
- sbidCarrierBillingInfo?: SbidBankInfo;
189
- };
190
- export declare type SbidBankInfo = {
191
- paymentMethodStatus?: PaymentMethodStatus;
192
- paymentMethodStatusLabel?: string;
193
- };
194
- declare type PayLaterCCMethodAdditionalInfo = {
195
- showCardDetails?: boolean;
196
- };
197
- export declare type PayLaterCCMethod = MethodBase & PayLaterCCMethodAdditionalInfo & {
198
- paymentMethodType: 'PAY_LATER_CC';
199
- payLaterCcInfo?: PayLaterCCInfo;
200
- };
201
- export declare type PayLaterCCInfo = {
202
- cardName?: string;
203
- last4digits?: string;
204
- linkedCardBrand?: Exclude<CreditTypes, CreditTypes.AMEX | CreditTypes.DINERS | CreditTypes.OTHER>;
205
- linkedCardType?: PayPayCardType;
206
- availableAmount?: number;
207
- paymentMethodStatus?: PaymentMethodStatus;
208
- paymentMethodStatusLabel?: string;
209
- };
210
- declare type PayLaterMethod = MethodBase & {
211
- paymentMethodType: 'PAY_LATER';
212
- };
213
- export declare type ResponseBase = {
214
- status: number;
215
- signed: {
216
- jws?: string;
217
- };
218
- uiComponents?: {
219
- displayErrorResponse: UIComponentsError;
220
- };
221
- unsigned: {
222
- resultInfo: {
223
- code: MiniAppErrorType;
224
- };
225
- };
226
- };
227
- export declare type PaymentMethod = WalletMethod | CreditMethod | BankMethod | SbidBankMethod | PayLaterCCMethod | PayLaterMethod;
228
- export declare type TopupFeeInfo = {
229
- feePercentage?: number;
230
- label: string;
231
- zeroFeeText?: string;
232
- };
233
- declare type PaymentMethodPreference = {
234
- preTransactionAutoChargeEnabled: boolean;
235
- prioritizedPaymentMethodsEnabled: boolean;
236
- };
237
- declare type OverdraftBalanceInfo = {
238
- balance: number;
239
- currency: string;
240
- };
241
- export declare type InfoBanner = {
242
- text: string;
243
- additionalText: string;
244
- link: string;
245
- linkText: string;
246
- type: string;
247
- };
248
- export declare type GetPaymentMethodsResponse = ResponseBase & {
249
- unsigned: {
250
- data: {
251
- payload: {
252
- paymentMethodList: PaymentMethod[];
253
- appealDescription: AppealDescription | null;
254
- paymentMethodPreference: PaymentMethodPreference | null;
255
- overdraftBalanceInfo?: OverdraftBalanceInfo;
256
- infoBannerList?: InfoBanner[];
257
- };
258
- };
259
- };
260
- };
261
- export declare const getPaymentMethods2: (params: {
262
- merchant?: string;
263
- type: string;
264
- productType?: string;
265
- }) => Promise<PPFetchResult<GetPaymentMethodsResponse, Record<string, unknown>>>;
266
- export declare type PaymentResult = {
267
- requestedAt: number;
268
- storeId: string;
269
- amount: Amount;
270
- statusLabelString: string;
271
- statusLabelColor: string;
272
- userAuthorizationId: string;
273
- acceptedAt: number;
274
- merchantName: string;
275
- orderDescription: string;
276
- status: 'COMPLETED' | 'AUTHORIZED';
277
- paymentId: string;
278
- expiresAt: number;
279
- };
280
- export declare type MakePaymentResponse = ResponseBase & {
281
- signed: {
282
- jws: string;
283
- };
284
- unsigned: {
285
- data: PaymentResult;
286
- };
287
- };
288
- export declare const makePayment: (queryParams: PaymentQuery, body: PaymentBody, isAuthorization: boolean) => Promise<PPFetchResult<MakePaymentResponse>>;
289
- export declare type AppealDescription = {
290
- backgroundColor?: string;
291
- color: string;
292
- headerIcon?: string | null;
293
- isBold: boolean;
294
- linkUrl?: string;
295
- text: string;
296
- };
297
- export declare type InsufficientBalanceInfo = {
298
- appealDescription: AppealDescription;
299
- insufficientAmount: number;
300
- paymentMethodList: PaymentMethod[];
301
- prepaidOnly: boolean | null;
302
- recommendedTopupAmount: number;
303
- totalBalanceInfo: {
304
- balance: number;
305
- currency: 'JPY';
306
- };
307
- overdraftBalanceInfo?: OverdraftBalanceInfo;
308
- infoBannerList?: InfoBanner[];
309
- };
310
- export declare type ConsultError = {
311
- backendResultCode: string;
312
- displayErrorResponse?: UIComponentsError;
313
- insufficientAmount: number;
314
- insufficientBalanceInfo: InsufficientBalanceInfo;
315
- paymentMethodList: PaymentMethod[];
316
- recommendedTopupAmount: number;
317
- };
318
- export declare type ConsultResponse = ResponseBase & {
319
- unsigned: {
320
- resultInfo: unknown;
321
- data: {
322
- error?: ConsultError;
323
- header: {
324
- resultCode: string;
325
- };
326
- };
327
- };
328
- };
329
- export declare const getConsult: ({ merchant, amount, productType, metaData, orderType, }: {
330
- merchant: string;
331
- amount: number;
332
- productType: string;
333
- metaData: unknown;
334
- orderType: string;
335
- }) => Promise<PPFetchResult<ConsultResponse, ConsultResponse>>;
336
- interface CashBackDetailHelpLink {
337
- label: string;
338
- url: string;
339
- googleAnalyticsInfo: unknown;
340
- }
341
- interface CashBackDetailItem {
342
- campaignId: string;
343
- bannerId: string | null;
344
- campaignName: string;
345
- campaignNameColor: string;
346
- optionalText: string | null;
347
- optionalTextColor: string | null;
348
- amountText: string;
349
- amountTextColor: string;
350
- couponIdText: string | null;
351
- couponIdTextColor: string | null;
352
- status: string;
353
- isMeti: boolean;
354
- deeplinkUrl: string | null;
355
- googleAnalyticsInfo: unknown;
356
- }
357
- interface CouponCashbackDetail {
358
- title: string;
359
- iconImageUrl: string;
360
- cashBackDetailLinkLabel: string;
361
- cashBackDetailLinkTarget: string;
362
- googleAnalyticsInfo: unknown;
363
- }
364
- interface CashBackDetail {
365
- cashBackDetailListDescription: string | null;
366
- cashBackDetailHelpLink: CashBackDetailHelpLink | null;
367
- cashBackDetailList: Array<CashBackDetailItem>;
368
- googleAnalyticsInfo: unknown;
369
- }
370
- export interface CashBackComponent {
371
- cashBackAmount: number;
372
- currencyText: string;
373
- cashBackAmountText: string | null;
374
- cashBackDescription: string;
375
- animationUrl: string;
376
- optionalText: string | null;
377
- cashBackDetailLinkLabel: string;
378
- couponCashbackDetail: CouponCashbackDetail;
379
- cashBackDetail: CashBackDetail;
380
- }
381
- export interface AnimationCard {
382
- cardId: string;
383
- campaignId: string | null;
384
- cardType: string;
385
- animationUrl: string;
386
- amount: number | null;
387
- soundUrl: string | null;
388
- duration: number | null;
389
- title: string | null;
390
- description: string | null;
391
- showAgeConfirmFlag?: boolean | null;
392
- backgroundColor: string | null;
393
- }
394
- export interface StackAnimationCardInfo {
395
- totalAnimationCards: number;
396
- animationCardList: Array<AnimationCard>;
397
- }
398
- export interface CashBackDetailResponsePayload {
399
- cashBackComponent: CashBackComponent;
400
- stackAnimationCardInfo: StackAnimationCardInfo | null;
401
- cashBackDescriptionForShareLink: string;
402
- }
403
- export declare type CashBackDetailResponse = ResponseBase & {
404
- unsigned: {
405
- data: {
406
- payload: CashBackDetailResponsePayload;
407
- };
408
- };
409
- };
410
- export declare const getCashBackDetails: (paymentId: string, orderType?: OrderType) => Promise<PPFetchResult<CashBackDetailResponse, Record<string, unknown>>>;
411
- export declare type SendAgePayload = {
412
- month: number;
413
- orderId: string;
414
- year: number;
415
- orderType: 'ACQUIRING';
416
- amount: number;
417
- date: number;
418
- campaignId: string;
419
- };
420
- export declare type SendAgeResponse = ResponseBase & {
421
- unsigned: {
422
- data: {
423
- payload: {
424
- isEligibleForCashBack: boolean;
425
- };
426
- };
427
- };
428
- };
429
- export declare const sendAge: (payload: SendAgePayload) => Promise<PPFetchResult<SendAgeResponse, Record<string, unknown>>>;
430
- export {};
@@ -1,8 +0,0 @@
1
- import type { NativeParams } from '../jsbridge-core/jsbridge';
2
- import type { RedirectType } from '../types';
3
- export interface GetLoginUrlParams extends NativeParams<{
4
- url: string;
5
- }> {
6
- redirectUrl?: string;
7
- redirectType?: RedirectType;
8
- }