@yuno-payments/sdk-web-types 1.22.0 → 1.22.2-beta.1

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.
package/dist/index.d.ts CHANGED
@@ -297,6 +297,8 @@ interface FullInstallmentInfo {
297
297
  };
298
298
  type?: string;
299
299
  first_installment_deferral?: string;
300
+ id?: string;
301
+ additional_data?: Record<string, unknown>;
300
302
  }
301
303
  interface FullInstallmentsInfo {
302
304
  installments: FullInstallmentInfo[];
@@ -605,4 +607,4 @@ interface Yuno {
605
607
  initialize(publicApiKey: string): YunoInstance;
606
608
  }
607
609
 
608
- declare const Yuno: Yuno;
610
+ export { type ButtonTextCard, type CardConfig, type CreateArgsSF, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type FormElementSelector, type Language, type LoadingType, type MountCheckoutArgs, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yuno-payments/sdk-web-types",
3
- "version": "1.22.0",
3
+ "version": "1.22.2-beta.1",
4
4
  "types": "dist/index.d.ts",
5
5
  "main": "dist/types.ts",
6
6
  "type": "commonjs",
@@ -11,7 +11,7 @@
11
11
  "/dist"
12
12
  ],
13
13
  "scripts": {
14
- "build": "rm -rf ./dist && rollup -c --bundleConfigAsCjs && node ./script.js",
14
+ "build": "rm -rf ./dist && rollup -c --bundleConfigAsCjs",
15
15
  "prepublishOnly": "npm run build",
16
16
  "test": "echo \"Error: no test specified\" && exit 0"
17
17
  },
@@ -19,8 +19,8 @@
19
19
  "license": "ISC",
20
20
  "devDependencies": {
21
21
  "@types/node": "^20.6.2",
22
- "rollup": "^3.29.2",
22
+ "rollup": "^4.34.8",
23
23
  "rollup-plugin-dts": "^6.0.2",
24
24
  "typescript": "^5.2.2"
25
25
  }
26
- }
26
+ }
package/dist/types.ts DELETED
@@ -1,608 +0,0 @@
1
- interface Customer {
2
- first_name?: string | null;
3
- last_name?: string | null;
4
- email?: string | null;
5
- gender?: string | null;
6
- device_fingerprint?: string | null;
7
- third_party_session_id?: string | null;
8
- document?: {
9
- document_number: string;
10
- document_type: string;
11
- } | null;
12
- phone?: {
13
- country_code: string;
14
- number: string;
15
- } | null;
16
- billing_address?: {
17
- address_line_1: string;
18
- address_line_2: string;
19
- city: string;
20
- country: string;
21
- state: string;
22
- zip_code: string;
23
- } | null;
24
- shipping_address?: {
25
- address_line_1: string;
26
- address_line_2: string;
27
- country: string;
28
- state: string;
29
- city: string;
30
- zip_code: string;
31
- } | null;
32
- }
33
-
34
- interface Card {
35
- number: string | null;
36
- expiration_month: number | null;
37
- expiration_year: number | null;
38
- security_code: string | null;
39
- holder_name: string | null;
40
- type: string | null;
41
- }
42
- interface OneTimeToken$1 {
43
- token: string;
44
- vaulted_token: string | null;
45
- vault_on_success: boolean;
46
- type: string;
47
- card_data?: {
48
- holder_name: string;
49
- iin: string;
50
- lfd: string;
51
- number_length: number;
52
- security_code_length: number;
53
- brand: string;
54
- issuer_name: string;
55
- issuer_code: string | null;
56
- category: string | null;
57
- type: string;
58
- };
59
- customer: Customer;
60
- }
61
- type ApiClientCard = {
62
- save?: boolean;
63
- detail?: Partial<Card>;
64
- three_d_secure?: {
65
- three_d_secure_setup_id?: string | null;
66
- };
67
- installment?: {
68
- id: string;
69
- value: number;
70
- amount?: {
71
- currency: string;
72
- value: string;
73
- total_value: string;
74
- } | null;
75
- };
76
- };
77
- declare enum StatusEnrollment {
78
- CREATED = "CREATED",
79
- EXPIRED = "EXPIRED",
80
- REJECTED = "REJECTED",
81
- READY_TO_ENROLL = "READY_TO_ENROLL",
82
- ENROLL_IN_PROCESS = "ENROLL_IN_PROCESS",
83
- UNENROLL_IN_PROCESS = "UNENROLL_IN_PROCESS",
84
- ENROLLED = "ENROLLED",
85
- DECLINED = "DECLINED",
86
- CANCELED = "CANCELED",
87
- ERROR = "ERROR",
88
- UNENROLLED = "UNENROLLED"
89
- }
90
- declare enum CountryCode {
91
- ANGUILLA = "AI",
92
- ANTIGUA_AND_BARBUDA = "AG",
93
- ARGENTINA = "AR",
94
- ARUBA = "AW",
95
- BAHAMAS = "BS",
96
- BARBADOS = "BB",
97
- BELIZE = "BZ",
98
- BERMUDA = "BM",
99
- BOLIVIA = "BO",
100
- BONAIRE = "BQ",
101
- BOTSWANA = "BW",
102
- BRAZIL = "BR",
103
- CANADA = "CA",
104
- CAYMAN_ISLANDS = "KY",
105
- CHILE = "CL",
106
- COLOMBIA = "CO",
107
- COSTA_RICA = "CR",
108
- CUBA = "CU",
109
- CURAÇAO = "CW",
110
- DOMINICA = "DM",
111
- DOMINICAN_REPUBLIC = "DO",
112
- ECUADOR = "EC",
113
- EL_SALVADOR = "SV",
114
- FALKLAND_ISLANDS = "FK",
115
- PHILIPPINES = "PH",
116
- FRENCH_GUIANA = "GF",
117
- GREENLAND = "GL",
118
- GRENADA = "GD",
119
- GUADELOUPE = "GP",
120
- GUATEMALA = "GT",
121
- GUYANA = "GY",
122
- HAITI = "HT",
123
- HONDURAS = "HN",
124
- INDONESIA = "ID",
125
- JAMAICA = "JM",
126
- MALAYSIA = "MY",
127
- MARTINIQUE = "MQ",
128
- MEXICO = "MX",
129
- MONTSERRAT = "MS",
130
- NICARAGUA = "NI",
131
- PANAMA = "PA",
132
- PARAGUAY = "PY",
133
- PERU = "PE",
134
- PUERTO_RICO = "PR",
135
- SAINT_BARTHÉLEMY = "BL",
136
- SAINT_KITTS_AND_NEVIS = "KN",
137
- SAINT_LUCIA = "LC",
138
- SAINT_MARTIN = "MF",
139
- SAINT_PIERRE_AND_MIQUELON = "PM",
140
- SAINT_VINCENT_AND_THE_GRENADINES = "VC",
141
- SINT_MAARTEN = "SX",
142
- SURINAME = "SR",
143
- THAILAND = "TH",
144
- TRINIDAD_AND_TOBAGO = "TT",
145
- TURKS_AND_CAICOS_ISLANDS = "TC",
146
- UNITED_STATES = "US",
147
- URUGUAY = "UY",
148
- VENEZUELA = "VE",
149
- VIRGIN_ISLANDS_BRITISH = "VG",
150
- VIRGIN_ISLANDS_US = "VI",
151
- ZIMBABWE = "ZW"
152
- }
153
-
154
- type ApiClientPaymentArgs = {
155
- checkout_session: string;
156
- country_code: CountryCode;
157
- };
158
- type GenerateTokenArgs$1 = {
159
- checkout_session?: string;
160
- payment_method: {
161
- type: string;
162
- vaulted_token?: string | null;
163
- card?: ApiClientCard;
164
- customer?: Customer;
165
- device_fingerprint?: string | null;
166
- third_party_session_id?: string | null;
167
- };
168
- };
169
- type GetThreeDSecureChallengeReturn = {
170
- url: string;
171
- };
172
- type GenerateToken = (args: GenerateTokenArgs$1) => Promise<OneTimeToken$1>;
173
- type GetThreeDSecureChallenge = (checkoutSession?: string) => Promise<GetThreeDSecureChallengeReturn>;
174
- type ApiClientPaymentReturn = {
175
- generateToken: GenerateToken;
176
- getThreeDSecureChallenge: GetThreeDSecureChallenge;
177
- };
178
- type ApiClientPayment = (args: ApiClientPaymentArgs) => ApiClientPaymentReturn;
179
-
180
- type ApiClientEnrollArgs = {
181
- customer_session: string;
182
- country_code: CountryCode;
183
- };
184
- type ContinueEnrollmentArgs = {
185
- customer_session?: string;
186
- payment_method: {
187
- type: string;
188
- card?: ApiClientCard;
189
- customer?: Customer;
190
- };
191
- };
192
- type ContinueEnrollmentReturn = {
193
- vaulted_token: string;
194
- status: string;
195
- customer: {
196
- session: StatusEnrollment;
197
- };
198
- };
199
- type ApiClientEnrollReturn = {
200
- continueEnrollment: (args: ContinueEnrollmentArgs) => Promise<ContinueEnrollmentReturn>;
201
- };
202
- type ApiClientEnroll = (args: ApiClientEnrollArgs) => ApiClientEnrollReturn;
203
-
204
- type Status = 'FAIL' | 'REJECT' | 'SUCCEEDED' | 'PROCESSING' | 'READY';
205
- type EnrollmentStatus = 'CREATED' | 'EXPIRED' | 'REJECTED' | 'READY_TO_ENROLL' | 'ENROLL_IN_PROCESS' | 'UNENROLL_IN_PROCESS' | 'ENROLLED' | 'DECLINED' | 'CANCELED' | 'ERROR' | 'UNENROLLED';
206
-
207
- type Name = 'cvv' | 'pan' | 'expiration' | 'cardLoadPreview';
208
- interface FontFile {
209
- weight: number;
210
- url: string;
211
- }
212
- interface ExternalFont {
213
- family_name: string;
214
- files: FontFile[];
215
- }
216
- type Installment = {
217
- installmentId: string;
218
- installment: number;
219
- amount?: {
220
- currency: string;
221
- value: string;
222
- total_value: string;
223
- };
224
- };
225
- interface CardIINResponse {
226
- id: string;
227
- iin: string;
228
- scheme: string;
229
- issuer_name: string;
230
- issuer_code: string;
231
- brand: string;
232
- type: string;
233
- category: string;
234
- country_code: string;
235
- country_name: string;
236
- website: string;
237
- phone: {
238
- country_code: string;
239
- number: string;
240
- };
241
- address: {
242
- address_line_1: string;
243
- address_line_2: string | null;
244
- city: string;
245
- country: string;
246
- state: string;
247
- zip_code: string;
248
- };
249
- }
250
- declare enum CardNetwork {
251
- DISCOVER = "DISCOVER",
252
- MAESTRO = "MAESTRO",
253
- MASTERCARD = "MASTERCARD",
254
- DINERS_CLUB_INTERNATIONAL = "DINERS_CLUB_INTERNATIONAL",
255
- DINERS = "DINERS",
256
- AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
257
- VISA = "VISA",
258
- UATP = "UATP",
259
- SODEXO = "SODEXO",
260
- VR_VALE_REFEICAO = "VR_VALE_REFEICAO",
261
- DEFAULT = "default"
262
- }
263
- type CardConfig$1 = {
264
- numberRegex: RegExp;
265
- maxLength: number;
266
- minLength: number;
267
- cvvRegex: RegExp;
268
- scheme: CardNetwork;
269
- brand: CardNetwork;
270
- altCardLogo: string;
271
- cardLogo: string;
272
- cardInputIcon: string;
273
- groupSizes: number[];
274
- placeHolder: string;
275
- cardType: CardType;
276
- styles: {
277
- backgroundColor: string;
278
- valueColor: string;
279
- labelColor: string;
280
- magneticStripeColor: string;
281
- signatureBackgroundColor: string;
282
- signatureLineColor: string;
283
- };
284
- };
285
- type InstallmentTypesList = {
286
- type: string;
287
- description: string;
288
- id: string;
289
- };
290
- interface FullInstallmentInfo {
291
- installment: number;
292
- rate: string;
293
- amount?: {
294
- currency: string;
295
- value: string;
296
- total_value: string;
297
- };
298
- type?: string;
299
- first_installment_deferral?: string;
300
- }
301
- interface FullInstallmentsInfo {
302
- installments: FullInstallmentInfo[];
303
- id: string;
304
- filter_by?: string;
305
- types_list?: InstallmentTypesList[];
306
- }
307
- type OnChangeArgs = {
308
- error: boolean;
309
- data?: {
310
- installments?: Installment[];
311
- cardIIN?: CardIINResponse;
312
- isCardIINLoading: boolean;
313
- isInstallmentLoading: boolean;
314
- cardConfig: CardConfig$1 | null;
315
- fullInstallmentsInfo?: FullInstallmentsInfo;
316
- };
317
- };
318
- type CardLoadPreviewSecureConfig = {
319
- showFrontCard?: boolean;
320
- defaultCardConfig?: CardConfig$1;
321
- focusCvv?: boolean;
322
- number?: string;
323
- cardHolderName?: string;
324
- showCardIcon?: boolean;
325
- onRenderedSecureField?(): void;
326
- language?: string;
327
- isEnrolled?: boolean;
328
- };
329
- type ValidationTypeSecureFields = 'on_change' | 'on_blur' | 'on_blur_full';
330
- type DesignType = 'float-label' | 'float-label-static' | 'label-placeholder';
331
- type CreateArgs = {
332
- name: Name;
333
- options: {
334
- label?: string;
335
- showError?: boolean;
336
- onChange?(onChangeArgs: OnChangeArgs): void;
337
- onBlur?(): void;
338
- onFocus?(): void;
339
- onRenderedSecureField?(): void;
340
- styles?: string;
341
- placeholder?: string;
342
- errorMessage?: string;
343
- requiredErrorMessage?: string;
344
- validationType?: ValidationTypeSecureFields;
345
- designType?: DesignType;
346
- errorIcon?: string | null;
347
- enableFocusAnimation?: boolean;
348
- defaultCardConfig?: CardConfig$1;
349
- externalFonts?: ExternalFont[];
350
- };
351
- cardLoadPreviewConfig?: CardLoadPreviewSecureConfig;
352
- };
353
- type GetElement = {
354
- name: Name;
355
- };
356
- interface GenerateTokenArgs {
357
- checkoutSession?: string;
358
- cardHolderName: string;
359
- saveCard?: boolean;
360
- customer?: Partial<Customer>;
361
- installment?: {
362
- id: string;
363
- value: number;
364
- amount?: {
365
- currency: string;
366
- value: string;
367
- total_value: string;
368
- };
369
- };
370
- cardType?: string;
371
- }
372
- interface GenerateVaultedToken {
373
- customerSession?: string;
374
- cardHolderName: string;
375
- customer?: Partial<Customer>;
376
- cardType?: string;
377
- }
378
- interface OneTimeToken {
379
- token: string;
380
- vaulted_token: string | null;
381
- vault_on_success: boolean;
382
- type: string;
383
- card_data?: {
384
- holder_name: string;
385
- iin: string;
386
- lfd: string;
387
- number_length: number;
388
- security_code_length: number;
389
- brand: string;
390
- issuer_name: string;
391
- issuer_code: string | null;
392
- category: string | null;
393
- type: string;
394
- };
395
- customer: Customer;
396
- }
397
- interface VaultedToken {
398
- code: string;
399
- idempotency_key: string;
400
- organization_code: string;
401
- account_code: string;
402
- customer_session: string;
403
- name: string;
404
- description: string;
405
- status: Status;
406
- type: string;
407
- category: string;
408
- provider: {
409
- type: string;
410
- action: string;
411
- token: string;
412
- enrollment_id: string | null;
413
- provider_status: string | null;
414
- redirect: string | null;
415
- raw_response: unknown;
416
- };
417
- created_at: Date;
418
- updated_at: Date;
419
- }
420
- type CardType = 'CREDIT' | 'DEBIT' | 'VOUCHER';
421
- interface SecureField {
422
- render(elementSelector: string): Promise<void>;
423
- focus(): Promise<void>;
424
- validate(): Promise<boolean>;
425
- unmountSync(): Promise<void>;
426
- clearValue(): Promise<void>;
427
- setError(errorMessage: string): Promise<void>;
428
- setCardType(cardType: CardType): Promise<void>;
429
- clearError(): Promise<void>;
430
- resetFields(): Promise<void>;
431
- toggleFocusCvv(value: boolean): Promise<void>;
432
- toggleFrontCardVisibility(value: boolean): Promise<void>;
433
- setCardHolderName(value: string): Promise<void>;
434
- }
435
- interface SecureFields {
436
- create({ name, options }: CreateArgs): SecureField;
437
- getElement({ name }: GetElement): SecureField;
438
- generateToken(params: GenerateTokenArgs): Promise<string>;
439
- generateTokenWithInformation(params: GenerateTokenArgs): Promise<OneTimeToken>;
440
- generateVaultedToken(params: GenerateVaultedToken): Promise<string>;
441
- generateVaultedTokenWithInformation(params: GenerateVaultedToken): Promise<VaultedToken>;
442
- unmountSync(): void;
443
- }
444
-
445
- interface ButtonTextCard {
446
- cardForm?: {
447
- enrollmentSubmitButton?: string;
448
- paymentSubmitButton?: string;
449
- };
450
- cardStepper?: {
451
- numberCardStep?: {
452
- nextButton?: string;
453
- };
454
- cardHolderNameStep?: {
455
- prevButton?: string;
456
- nextButton?: string;
457
- };
458
- expirationDateStep?: {
459
- prevButton?: string;
460
- nextButton?: string;
461
- };
462
- cvvStep?: {
463
- prevButton?: string;
464
- nextButton?: string;
465
- };
466
- };
467
- }
468
- interface TextsCustom {
469
- customerForm?: {
470
- submitButton?: string;
471
- };
472
- paymentOtp?: {
473
- sendOtpButton?: string;
474
- };
475
- }
476
- interface CardConfig {
477
- styles?: string;
478
- type?: 'extends' | 'step';
479
- cardSaveEnable?: boolean;
480
- vaultOnSuccess?: boolean;
481
- texts?: ButtonTextCard;
482
- documentEnable?: boolean;
483
- isCreditCardProcessingOnly?: boolean;
484
- }
485
- interface FormElementSelector {
486
- apmForm?: string;
487
- actionForm?: string;
488
- }
489
- interface RenderMode {
490
- type: 'modal' | 'element';
491
- elementSelector?: string | FormElementSelector;
492
- }
493
- declare enum ExternalPaymentButtonsTypes {
494
- PAYPAL = "paypal"
495
- }
496
- type ExternalPaymentButtons = {
497
- [key in ExternalPaymentButtonsTypes]: {
498
- elementSelector: string;
499
- };
500
- };
501
- type LoadingType = 'DOCUMENT' | 'ONE_TIME_TOKEN';
502
- type Language = 'es' | 'en' | 'pt';
503
- interface YunoConfig {
504
- publicApiKey: string;
505
- checkoutSession: string;
506
- customerSession: string;
507
- language: Language;
508
- countryCode: string;
509
- elementSelector?: string;
510
- vaultedToken?: string;
511
- type?: string;
512
- renderMode?: RenderMode;
513
- externalPaymentButtons?: ExternalPaymentButtons;
514
- card?: CardConfig;
515
- showLoading?: boolean;
516
- c2p?: {
517
- enableRememberMe?: boolean;
518
- recognitionToken?: string;
519
- c2pFlowType?: string;
520
- onRecognitionTokenCreated?(recognitionToken: string): void;
521
- onRecognitionTokenDeleted?(): void;
522
- };
523
- texts?: TextsCustom;
524
- issuersFormEnable?: boolean;
525
- automaticallyUnmount?: boolean;
526
- cardFormUnfoldedEnable?: boolean;
527
- isDynamicViewEnabled?: boolean;
528
- showOnlyThesePaymentMethods?: string[];
529
- showPayButton?: boolean;
530
- yunoCreatePayment?: (oneTimeToken: string, tokenWithInformation: OneTimeToken) => void;
531
- yunoPaymentMethodSelected?: (arg: {
532
- type: string;
533
- name: string;
534
- }) => void;
535
- yunoPaymentResult?: (status: Status) => void;
536
- yunoError?: (message: string) => void;
537
- onRendered?(): void;
538
- onOneTimeTokenCreationStart?(): void;
539
- yunoEnrollmentStatus?(params: {
540
- status: EnrollmentStatus;
541
- vaultedToken?: string;
542
- }): void;
543
- /**
544
- * @deprecated
545
- */
546
- onLoading?(args: {
547
- isLoading: boolean;
548
- type: LoadingType;
549
- }): void;
550
- }
551
- type StartCheckoutArgs = Omit<YunoConfig, 'yunoEnrollmentStatus' | 'customerSession' | 'publicApiKey'>;
552
- type MountEnrollmentLiteArgs = Pick<YunoConfig, 'language' | 'countryCode' | 'renderMode' | 'yunoEnrollmentStatus' | 'yunoError' | 'showLoading' | 'onRendered' | 'onOneTimeTokenCreationStart' | 'onLoading'>;
553
- type mountFraudArgs = Pick<YunoConfig, 'yunoCreatePayment' | 'yunoError' | 'language' | 'checkoutSession'>;
554
- interface MountCheckoutArgs {
555
- paymentMethodType?: string;
556
- vaultedToken?: string;
557
- category?: string;
558
- }
559
- interface MountCheckoutLiteArgs {
560
- paymentMethodType?: string;
561
- vaultedToken?: string;
562
- }
563
- interface MountSeamlessCheckoutLiteArgs {
564
- paymentMethodType?: string;
565
- vaultedToken?: string;
566
- }
567
- interface SecureFieldsArgs {
568
- countryCode: string;
569
- checkoutSession?: string;
570
- installmentEnable?: boolean;
571
- customerSession?: string;
572
- enableMultiplesCard?: boolean;
573
- }
574
- type SecureFieldInstance = SecureFields;
575
- type OnChangeDataSF = OnChangeArgs['data'];
576
- type CreateArgsSF = CreateArgs;
577
- interface MountStatusPaymentArgs {
578
- checkoutSession: string;
579
- language: Language;
580
- countryCode: CountryCode;
581
- yunoPaymentResult?: YunoConfig['yunoPaymentResult'];
582
- yunoError?: YunoConfig['yunoError'];
583
- }
584
- interface YunoInstance {
585
- startCheckout(args: StartCheckoutArgs): void;
586
- mountCheckout(args: MountCheckoutArgs): void;
587
- mountCheckoutLite(args: MountCheckoutLiteArgs): void;
588
- mountSeamlessCheckoutLite(args: MountSeamlessCheckoutLiteArgs): void;
589
- updateCheckoutSession(checkout: string): void;
590
- submitOneTimeTokenForm(): void;
591
- startPayment(): void;
592
- continuePayment(): Promise<void>;
593
- notifyError(): void;
594
- mountEnrollmentLite(args: MountEnrollmentLiteArgs): void;
595
- showLoader(): void;
596
- hideLoader(): void;
597
- updateCheckoutSession(checkoutSession: string): void;
598
- mountFraud(args: mountFraudArgs): void;
599
- mountStatusPayment(args: MountStatusPaymentArgs): void;
600
- secureFields(args: SecureFieldsArgs): SecureFieldInstance;
601
- apiClientPayment: ApiClientPayment;
602
- apiClientEnroll: ApiClientEnroll;
603
- }
604
- interface Yuno {
605
- initialize(publicApiKey: string): YunoInstance;
606
- }
607
-
608
- export { type ButtonTextCard, type CardConfig, type CreateArgsSF, type ExternalPaymentButtons, ExternalPaymentButtonsTypes, type FormElementSelector, type Language, type LoadingType, type MountCheckoutArgs, type MountCheckoutLiteArgs, type MountEnrollmentLiteArgs, type MountSeamlessCheckoutLiteArgs, type MountStatusPaymentArgs, type OnChangeDataSF, type RenderMode, type SecureFieldInstance, type SecureFieldsArgs, type StartCheckoutArgs, type TextsCustom, type Yuno, type YunoConfig, type YunoInstance, type mountFraudArgs };