@capawesome/capacitor-square-mobile-payments 0.0.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.
Files changed (82) hide show
  1. package/CapawesomeCapacitorSquareMobilePayments.podspec +17 -0
  2. package/Package.swift +30 -0
  3. package/README.md +1183 -0
  4. package/android/build.gradle +63 -0
  5. package/android/src/main/AndroidManifest.xml +7 -0
  6. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/SquareMobilePayments.java +774 -0
  7. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/SquareMobilePaymentsPlugin.java +460 -0
  8. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/CustomException.java +20 -0
  9. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/CustomExceptions.java +41 -0
  10. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/AvailableCardInputMethodsDidChangeEvent.java +27 -0
  11. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/PaymentDidCancelEvent.java +24 -0
  12. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/PaymentDidFailEvent.java +34 -0
  13. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/PaymentDidFinishEvent.java +22 -0
  14. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/ReaderDidChangeEvent.java +27 -0
  15. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/ReaderPairingDidFailEvent.java +28 -0
  16. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/ReaderWasAddedEvent.java +22 -0
  17. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/events/ReaderWasRemovedEvent.java +22 -0
  18. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/AuthorizeOptions.java +29 -0
  19. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/ForgetReaderOptions.java +29 -0
  20. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/InitializeOptions.java +29 -0
  21. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/Money.java +29 -0
  22. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/PaymentParameters.java +126 -0
  23. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/PromptParameters.java +47 -0
  24. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/RetryConnectionOptions.java +29 -0
  25. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/options/StartPaymentOptions.java +39 -0
  26. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/Card.java +51 -0
  27. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/CardPaymentDetails.java +30 -0
  28. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/GetAvailableCardInputMethodsResult.java +29 -0
  29. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/GetReadersResult.java +29 -0
  30. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/GetSettingsResult.java +28 -0
  31. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/IsAuthorizedResult.java +22 -0
  32. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/IsPairingInProgressResult.java +22 -0
  33. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/MoneyResult.java +27 -0
  34. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/Payment.java +87 -0
  35. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/ReaderInfo.java +82 -0
  36. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/classes/results/UnavailableReasonInfo.java +30 -0
  37. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/interfaces/Callback.java +5 -0
  38. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/interfaces/EmptyCallback.java +5 -0
  39. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/interfaces/NonEmptyCallback.java +7 -0
  40. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/interfaces/NonEmptyResultCallback.java +7 -0
  41. package/android/src/main/java/io/capawesome/capacitorjs/plugins/squaremobilepayments/interfaces/Result.java +7 -0
  42. package/android/src/main/res/.gitkeep +0 -0
  43. package/dist/docs.json +2999 -0
  44. package/dist/esm/definitions.d.ts +1468 -0
  45. package/dist/esm/definitions.js +519 -0
  46. package/dist/esm/definitions.js.map +1 -0
  47. package/dist/esm/index.d.ts +4 -0
  48. package/dist/esm/index.js +7 -0
  49. package/dist/esm/index.js.map +1 -0
  50. package/dist/esm/web.d.ts +21 -0
  51. package/dist/esm/web.js +55 -0
  52. package/dist/esm/web.js.map +1 -0
  53. package/dist/plugin.cjs.js +588 -0
  54. package/dist/plugin.cjs.js.map +1 -0
  55. package/dist/plugin.js +591 -0
  56. package/dist/plugin.js.map +1 -0
  57. package/ios/Plugin/Classes/Options/AuthorizeOptions.swift +17 -0
  58. package/ios/Plugin/Classes/Options/ForgetReaderOptions.swift +17 -0
  59. package/ios/Plugin/Classes/Options/InitializeOptions.swift +17 -0
  60. package/ios/Plugin/Classes/Options/Money.swift +12 -0
  61. package/ios/Plugin/Classes/Options/PaymentParameters.swift +49 -0
  62. package/ios/Plugin/Classes/Options/PromptParameters.swift +17 -0
  63. package/ios/Plugin/Classes/Options/RetryConnectionOptions.swift +17 -0
  64. package/ios/Plugin/Classes/Options/StartPaymentOptions.swift +19 -0
  65. package/ios/Plugin/Classes/Results/Card.swift +34 -0
  66. package/ios/Plugin/Classes/Results/CardPaymentDetails.swift +34 -0
  67. package/ios/Plugin/Classes/Results/GetAvailableCardInputMethodsResult.swift +16 -0
  68. package/ios/Plugin/Classes/Results/GetReadersResult.swift +16 -0
  69. package/ios/Plugin/Classes/Results/GetSettingsResult.swift +19 -0
  70. package/ios/Plugin/Classes/Results/IsAuthorizedResult.swift +16 -0
  71. package/ios/Plugin/Classes/Results/IsPairingInProgressResult.swift +16 -0
  72. package/ios/Plugin/Classes/Results/MoneyResult.swift +19 -0
  73. package/ios/Plugin/Classes/Results/Payment.swift +58 -0
  74. package/ios/Plugin/Classes/Results/ReaderInfo.swift +46 -0
  75. package/ios/Plugin/Classes/Results/UnavailableReasonInfo.swift +19 -0
  76. package/ios/Plugin/Enums/CustomError.swift +81 -0
  77. package/ios/Plugin/Info.plist +24 -0
  78. package/ios/Plugin/Protocols/Result.swift +6 -0
  79. package/ios/Plugin/SquareMobilePayments.swift +632 -0
  80. package/ios/Plugin/SquareMobilePaymentsHelper.swift +212 -0
  81. package/ios/Plugin/SquareMobilePaymentsPlugin.swift +347 -0
  82. package/package.json +93 -0
@@ -0,0 +1,519 @@
1
+ /**
2
+ * @since 0.0.1
3
+ */
4
+ export var Environment;
5
+ (function (Environment) {
6
+ /**
7
+ * Production environment.
8
+ *
9
+ * @since 0.0.1
10
+ */
11
+ Environment["Production"] = "production";
12
+ /**
13
+ * Sandbox environment for testing.
14
+ *
15
+ * @since 0.0.1
16
+ */
17
+ Environment["Sandbox"] = "sandbox";
18
+ })(Environment || (Environment = {}));
19
+ /**
20
+ * @since 0.0.1
21
+ */
22
+ export var CardInputMethod;
23
+ (function (CardInputMethod) {
24
+ /**
25
+ * Contactless card tap (NFC).
26
+ *
27
+ * @since 0.0.1
28
+ */
29
+ CardInputMethod["Tap"] = "TAP";
30
+ /**
31
+ * EMV chip card insertion.
32
+ *
33
+ * @since 0.0.1
34
+ */
35
+ CardInputMethod["Dip"] = "DIP";
36
+ /**
37
+ * Magnetic stripe swipe.
38
+ *
39
+ * @since 0.0.1
40
+ */
41
+ CardInputMethod["Swipe"] = "SWIPE";
42
+ /**
43
+ * Manually keyed card entry.
44
+ *
45
+ * @since 0.0.1
46
+ */
47
+ CardInputMethod["Keyed"] = "KEYED";
48
+ })(CardInputMethod || (CardInputMethod = {}));
49
+ /**
50
+ * @since 0.0.1
51
+ */
52
+ export var ProcessingMode;
53
+ (function (ProcessingMode) {
54
+ /**
55
+ * Automatically detect the best processing mode (online or offline).
56
+ *
57
+ * @since 0.0.1
58
+ */
59
+ ProcessingMode["AutoDetect"] = "AUTO_DETECT";
60
+ /**
61
+ * Process the payment online only.
62
+ *
63
+ * @since 0.0.1
64
+ */
65
+ ProcessingMode["OnlineOnly"] = "ONLINE_ONLY";
66
+ /**
67
+ * Allow offline payment processing.
68
+ *
69
+ * @since 0.0.1
70
+ */
71
+ ProcessingMode["OfflineOnly"] = "OFFLINE_ONLY";
72
+ })(ProcessingMode || (ProcessingMode = {}));
73
+ /**
74
+ * @since 0.0.1
75
+ */
76
+ export var PromptMode;
77
+ (function (PromptMode) {
78
+ /**
79
+ * Use the default Square payment UI.
80
+ *
81
+ * @since 0.0.1
82
+ */
83
+ PromptMode["Default"] = "DEFAULT";
84
+ /**
85
+ * Use a custom payment UI.
86
+ *
87
+ * @since 0.0.1
88
+ */
89
+ PromptMode["Custom"] = "CUSTOM";
90
+ })(PromptMode || (PromptMode = {}));
91
+ /**
92
+ * @since 0.0.1
93
+ */
94
+ export var AdditionalPaymentMethod;
95
+ (function (AdditionalPaymentMethod) {
96
+ /**
97
+ * Allow manually keyed card entry.
98
+ *
99
+ * @since 0.0.1
100
+ */
101
+ AdditionalPaymentMethod["Keyed"] = "KEYED";
102
+ /**
103
+ * Allow cash payments.
104
+ *
105
+ * @since 0.0.1
106
+ */
107
+ AdditionalPaymentMethod["Cash"] = "CASH";
108
+ })(AdditionalPaymentMethod || (AdditionalPaymentMethod = {}));
109
+ /**
110
+ * @since 0.0.1
111
+ */
112
+ export var DelayAction;
113
+ (function (DelayAction) {
114
+ /**
115
+ * Automatically complete the payment when the delay expires.
116
+ *
117
+ * @since 0.0.1
118
+ */
119
+ DelayAction["Complete"] = "COMPLETE";
120
+ /**
121
+ * Automatically cancel the payment when the delay expires.
122
+ *
123
+ * @since 0.0.1
124
+ */
125
+ DelayAction["Cancel"] = "CANCEL";
126
+ })(DelayAction || (DelayAction = {}));
127
+ /**
128
+ * @since 0.0.1
129
+ */
130
+ export var ReaderModel;
131
+ (function (ReaderModel) {
132
+ /**
133
+ * Square Reader for contactless and chip.
134
+ *
135
+ * @since 0.0.1
136
+ */
137
+ ReaderModel["ContactlessAndChip"] = "CONTACTLESS_AND_CHIP";
138
+ /**
139
+ * Square Reader for magstripe.
140
+ *
141
+ * @since 0.0.1
142
+ */
143
+ ReaderModel["Magstripe"] = "MAGSTRIPE";
144
+ /**
145
+ * Square Stand.
146
+ *
147
+ * @since 0.0.1
148
+ */
149
+ ReaderModel["Stand"] = "STAND";
150
+ /**
151
+ * Unknown reader model.
152
+ *
153
+ * @since 0.0.1
154
+ */
155
+ ReaderModel["Unknown"] = "UNKNOWN";
156
+ })(ReaderModel || (ReaderModel = {}));
157
+ /**
158
+ * @since 0.0.1
159
+ */
160
+ export var ReaderStatus;
161
+ (function (ReaderStatus) {
162
+ /**
163
+ * Reader is paired, connected, and ready to accept payments.
164
+ *
165
+ * @since 0.0.1
166
+ */
167
+ ReaderStatus["Ready"] = "READY";
168
+ /**
169
+ * Reader is connecting to Square servers.
170
+ *
171
+ * @since 0.0.1
172
+ */
173
+ ReaderStatus["ConnectingToSquare"] = "CONNECTING_TO_SQUARE";
174
+ /**
175
+ * Reader is connecting to the mobile device.
176
+ *
177
+ * @since 0.0.1
178
+ */
179
+ ReaderStatus["ConnectingToDevice"] = "CONNECTING_TO_DEVICE";
180
+ /**
181
+ * Reader has a hardware or connection error in an unrecoverable state.
182
+ *
183
+ * @since 0.0.1
184
+ */
185
+ ReaderStatus["Faulty"] = "FAULTY";
186
+ /**
187
+ * Reader is connected but unable to process payments.
188
+ *
189
+ * @since 0.0.1
190
+ */
191
+ ReaderStatus["ReaderUnavailable"] = "READER_UNAVAILABLE";
192
+ })(ReaderStatus || (ReaderStatus = {}));
193
+ /**
194
+ * @since 0.0.1
195
+ */
196
+ export var ReaderChange;
197
+ (function (ReaderChange) {
198
+ /**
199
+ * Reader battery started charging.
200
+ *
201
+ * Only available on iOS.
202
+ *
203
+ * @since 0.0.1
204
+ */
205
+ ReaderChange["BatteryDidBeginCharging"] = "BATTERY_DID_BEGIN_CHARGING";
206
+ /**
207
+ * Reader battery stopped charging.
208
+ *
209
+ * Only available on iOS.
210
+ *
211
+ * @since 0.0.1
212
+ */
213
+ ReaderChange["BatteryDidEndCharging"] = "BATTERY_DID_END_CHARGING";
214
+ /**
215
+ * Reader battery level changed.
216
+ *
217
+ * Only available on iOS.
218
+ *
219
+ * @since 0.0.1
220
+ */
221
+ ReaderChange["BatteryLevelDidChange"] = "BATTERY_LEVEL_DID_CHANGE";
222
+ /**
223
+ * Reader battery charging status changed.
224
+ *
225
+ * Only available on Android.
226
+ *
227
+ * @since 0.0.1
228
+ */
229
+ ReaderChange["BatteryCharging"] = "BATTERY_CHARGING";
230
+ /**
231
+ * Reader was added.
232
+ *
233
+ * Only available on Android.
234
+ *
235
+ * @since 0.0.1
236
+ */
237
+ ReaderChange["Added"] = "ADDED";
238
+ /**
239
+ * Reader was removed.
240
+ *
241
+ * Only available on Android.
242
+ *
243
+ * @since 0.0.1
244
+ */
245
+ ReaderChange["Removed"] = "REMOVED";
246
+ /**
247
+ * Reader status changed.
248
+ *
249
+ * @since 0.0.1
250
+ */
251
+ ReaderChange["StatusDidChange"] = "STATUS_DID_CHANGE";
252
+ })(ReaderChange || (ReaderChange = {}));
253
+ /**
254
+ * @since 0.0.1
255
+ */
256
+ export var UnavailableReason;
257
+ (function (UnavailableReason) {
258
+ /**
259
+ * Bluetooth connection issue.
260
+ *
261
+ * Only available on iOS.
262
+ *
263
+ * @since 0.0.1
264
+ */
265
+ UnavailableReason["BluetoothError"] = "BLUETOOTH_ERROR";
266
+ /**
267
+ * Bluetooth failure.
268
+ *
269
+ * Only available on Android.
270
+ *
271
+ * @since 0.0.1
272
+ */
273
+ UnavailableReason["BluetoothFailure"] = "BLUETOOTH_FAILURE";
274
+ /**
275
+ * Bluetooth is disabled.
276
+ *
277
+ * Only available on Android.
278
+ *
279
+ * @since 0.0.1
280
+ */
281
+ UnavailableReason["BluetoothDisabled"] = "BLUETOOTH_DISABLED";
282
+ /**
283
+ * Reader firmware is updating.
284
+ *
285
+ * Only available on iOS.
286
+ *
287
+ * @since 0.0.1
288
+ */
289
+ UnavailableReason["FirmwareUpdate"] = "FIRMWARE_UPDATE";
290
+ /**
291
+ * Blocking firmware update.
292
+ *
293
+ * Only available on Android.
294
+ *
295
+ * @since 0.0.1
296
+ */
297
+ UnavailableReason["BlockingUpdate"] = "BLOCKING_UPDATE";
298
+ /**
299
+ * Reader is unavailable offline.
300
+ *
301
+ * Only available on Android.
302
+ *
303
+ * @since 0.0.1
304
+ */
305
+ UnavailableReason["ReaderUnavailableOffline"] = "READER_UNAVAILABLE_OFFLINE";
306
+ /**
307
+ * Device is in developer mode.
308
+ *
309
+ * Only available on Android.
310
+ *
311
+ * @since 0.0.1
312
+ */
313
+ UnavailableReason["DeviceDeveloperMode"] = "DEVICE_DEVELOPER_MODE";
314
+ /**
315
+ * Unknown reason.
316
+ *
317
+ * @since 0.0.1
318
+ */
319
+ UnavailableReason["Unknown"] = "UNKNOWN";
320
+ })(UnavailableReason || (UnavailableReason = {}));
321
+ /**
322
+ * @since 0.0.1
323
+ */
324
+ export var PaymentType;
325
+ (function (PaymentType) {
326
+ /**
327
+ * Payment processed online.
328
+ *
329
+ * @since 0.0.1
330
+ */
331
+ PaymentType["Online"] = "ONLINE";
332
+ /**
333
+ * Payment processed offline.
334
+ *
335
+ * @since 0.0.1
336
+ */
337
+ PaymentType["Offline"] = "OFFLINE";
338
+ })(PaymentType || (PaymentType = {}));
339
+ /**
340
+ * @since 0.0.1
341
+ */
342
+ export var PaymentStatus;
343
+ (function (PaymentStatus) {
344
+ /**
345
+ * Payment was completed successfully.
346
+ *
347
+ * @since 0.0.1
348
+ */
349
+ PaymentStatus["Completed"] = "COMPLETED";
350
+ /**
351
+ * Payment was approved but not yet completed.
352
+ *
353
+ * @since 0.0.1
354
+ */
355
+ PaymentStatus["Approved"] = "APPROVED";
356
+ /**
357
+ * Payment was canceled.
358
+ *
359
+ * @since 0.0.1
360
+ */
361
+ PaymentStatus["Canceled"] = "CANCELED";
362
+ /**
363
+ * Payment failed.
364
+ *
365
+ * @since 0.0.1
366
+ */
367
+ PaymentStatus["Failed"] = "FAILED";
368
+ /**
369
+ * Payment is pending.
370
+ *
371
+ * @since 0.0.1
372
+ */
373
+ PaymentStatus["Pending"] = "PENDING";
374
+ })(PaymentStatus || (PaymentStatus = {}));
375
+ /**
376
+ * @since 0.0.1
377
+ */
378
+ export var CardBrand;
379
+ (function (CardBrand) {
380
+ /**
381
+ * Visa card.
382
+ *
383
+ * @since 0.0.1
384
+ */
385
+ CardBrand["Visa"] = "VISA";
386
+ /**
387
+ * Mastercard.
388
+ *
389
+ * @since 0.0.1
390
+ */
391
+ CardBrand["Mastercard"] = "MASTERCARD";
392
+ /**
393
+ * American Express card.
394
+ *
395
+ * @since 0.0.1
396
+ */
397
+ CardBrand["AmericanExpress"] = "AMERICAN_EXPRESS";
398
+ /**
399
+ * Discover card.
400
+ *
401
+ * @since 0.0.1
402
+ */
403
+ CardBrand["Discover"] = "DISCOVER";
404
+ /**
405
+ * Discover Diners card.
406
+ *
407
+ * @since 0.0.1
408
+ */
409
+ CardBrand["DiscoverDiners"] = "DISCOVER_DINERS";
410
+ /**
411
+ * JCB card.
412
+ *
413
+ * @since 0.0.1
414
+ */
415
+ CardBrand["Jcb"] = "JCB";
416
+ /**
417
+ * UnionPay card.
418
+ *
419
+ * @since 0.0.1
420
+ */
421
+ CardBrand["UnionPay"] = "UNION_PAY";
422
+ /**
423
+ * Interac card.
424
+ *
425
+ * @since 0.0.1
426
+ */
427
+ CardBrand["Interac"] = "INTERAC";
428
+ /**
429
+ * Eftpos card.
430
+ *
431
+ * @since 0.0.1
432
+ */
433
+ CardBrand["Eftpos"] = "EFTPOS";
434
+ /**
435
+ * Other or unknown card brand.
436
+ *
437
+ * @since 0.0.1
438
+ */
439
+ CardBrand["Other"] = "OTHER";
440
+ })(CardBrand || (CardBrand = {}));
441
+ /**
442
+ * @since 0.0.1
443
+ */
444
+ export var ErrorCode;
445
+ (function (ErrorCode) {
446
+ /**
447
+ * The location ID is missing.
448
+ *
449
+ * @since 0.0.1
450
+ */
451
+ ErrorCode["LocationIdMissing"] = "LOCATION_ID_MISSING";
452
+ /**
453
+ * The access token is missing.
454
+ *
455
+ * @since 0.0.1
456
+ */
457
+ ErrorCode["AccessTokenMissing"] = "ACCESS_TOKEN_MISSING";
458
+ /**
459
+ * The serial number is missing.
460
+ *
461
+ * @since 0.0.1
462
+ */
463
+ ErrorCode["SerialNumberMissing"] = "SERIAL_NUMBER_MISSING";
464
+ /**
465
+ * The payment parameters are missing.
466
+ *
467
+ * @since 0.0.1
468
+ */
469
+ ErrorCode["PaymentParametersMissing"] = "PAYMENT_PARAMETERS_MISSING";
470
+ /**
471
+ * The prompt parameters are missing.
472
+ *
473
+ * @since 0.0.1
474
+ */
475
+ ErrorCode["PromptParametersMissing"] = "PROMPT_PARAMETERS_MISSING";
476
+ /**
477
+ * The amount money is missing.
478
+ *
479
+ * @since 0.0.1
480
+ */
481
+ ErrorCode["AmountMoneyMissing"] = "AMOUNT_MONEY_MISSING";
482
+ /**
483
+ * The payment attempt ID is missing.
484
+ *
485
+ * @since 0.0.1
486
+ */
487
+ ErrorCode["PaymentAttemptIdMissing"] = "PAYMENT_ATTEMPT_ID_MISSING";
488
+ /**
489
+ * The SDK is not initialized.
490
+ *
491
+ * @since 0.0.1
492
+ */
493
+ ErrorCode["NotInitialized"] = "NOT_INITIALIZED";
494
+ /**
495
+ * The SDK is not authorized.
496
+ *
497
+ * @since 0.0.1
498
+ */
499
+ ErrorCode["NotAuthorized"] = "NOT_AUTHORIZED";
500
+ /**
501
+ * A pairing process is already in progress.
502
+ *
503
+ * @since 0.0.1
504
+ */
505
+ ErrorCode["PairingAlreadyInProgress"] = "PAIRING_ALREADY_IN_PROGRESS";
506
+ /**
507
+ * No payment is in progress.
508
+ *
509
+ * @since 0.0.1
510
+ */
511
+ ErrorCode["NoPaymentInProgress"] = "NO_PAYMENT_IN_PROGRESS";
512
+ /**
513
+ * Reader not found.
514
+ *
515
+ * @since 0.0.1
516
+ */
517
+ ErrorCode["ReaderNotFound"] = "READER_NOT_FOUND";
518
+ })(ErrorCode || (ErrorCode = {}));
519
+ //# sourceMappingURL=definitions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AA28BA;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,wCAAyB,CAAA;IACzB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAyBX;AAzBD,WAAY,eAAe;IACzB;;;;OAIG;IACH,8BAAW,CAAA;IACX;;;;OAIG;IACH,8BAAW,CAAA;IACX;;;;OAIG;IACH,kCAAe,CAAA;IACf;;;;OAIG;IACH,kCAAe,CAAA;AACjB,CAAC,EAzBW,eAAe,KAAf,eAAe,QAyB1B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAmBX;AAnBD,WAAY,cAAc;IACxB;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,8CAA4B,CAAA;AAC9B,CAAC,EAnBW,cAAc,KAAd,cAAc,QAmBzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB;;;;OAIG;IACH,iCAAmB,CAAA;IACnB;;;;OAIG;IACH,+BAAiB,CAAA;AACnB,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,uBAaX;AAbD,WAAY,uBAAuB;IACjC;;;;OAIG;IACH,0CAAe,CAAA;IACf;;;;OAIG;IACH,wCAAa,CAAA;AACf,CAAC,EAbW,uBAAuB,KAAvB,uBAAuB,QAalC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,oCAAqB,CAAA;IACrB;;;;OAIG;IACH,gCAAiB,CAAA;AACnB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAyBX;AAzBD,WAAY,WAAW;IACrB;;;;OAIG;IACH,0DAA2C,CAAA;IAC3C;;;;OAIG;IACH,sCAAuB,CAAA;IACvB;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAzBW,WAAW,KAAX,WAAW,QAyBtB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YA+BX;AA/BD,WAAY,YAAY;IACtB;;;;OAIG;IACH,+BAAe,CAAA;IACf;;;;OAIG;IACH,2DAA2C,CAAA;IAC3C;;;;OAIG;IACH,2DAA2C,CAAA;IAC3C;;;;OAIG;IACH,iCAAiB,CAAA;IACjB;;;;OAIG;IACH,wDAAwC,CAAA;AAC1C,CAAC,EA/BW,YAAY,KAAZ,YAAY,QA+BvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,YAuDX;AAvDD,WAAY,YAAY;IACtB;;;;;;OAMG;IACH,sEAAsD,CAAA;IACtD;;;;;;OAMG;IACH,kEAAkD,CAAA;IAClD;;;;;;OAMG;IACH,kEAAkD,CAAA;IAClD;;;;;;OAMG;IACH,oDAAoC,CAAA;IACpC;;;;;;OAMG;IACH,+BAAe,CAAA;IACf;;;;;;OAMG;IACH,mCAAmB,CAAA;IACnB;;;;OAIG;IACH,qDAAqC,CAAA;AACvC,CAAC,EAvDW,YAAY,KAAZ,YAAY,QAuDvB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,iBA+DX;AA/DD,WAAY,iBAAiB;IAC3B;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,2DAAsC,CAAA;IACtC;;;;;;OAMG;IACH,6DAAwC,CAAA;IACxC;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,uDAAkC,CAAA;IAClC;;;;;;OAMG;IACH,4EAAuD,CAAA;IACvD;;;;;;OAMG;IACH,kEAA6C,CAAA;IAC7C;;;;OAIG;IACH,wCAAmB,CAAA;AACrB,CAAC,EA/DW,iBAAiB,KAAjB,iBAAiB,QA+D5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,gCAAiB,CAAA;IACjB;;;;OAIG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,aA+BX;AA/BD,WAAY,aAAa;IACvB;;;;OAIG;IACH,wCAAuB,CAAA;IACvB;;;;OAIG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,kCAAiB,CAAA;IACjB;;;;OAIG;IACH,oCAAmB,CAAA;AACrB,CAAC,EA/BW,aAAa,KAAb,aAAa,QA+BxB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SA6DX;AA7DD,WAAY,SAAS;IACnB;;;;OAIG;IACH,0BAAa,CAAA;IACb;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,iDAAoC,CAAA;IACpC;;;;OAIG;IACH,kCAAqB,CAAA;IACrB;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,wBAAW,CAAA;IACX;;;;OAIG;IACH,mCAAsB,CAAA;IACtB;;;;OAIG;IACH,gCAAmB,CAAA;IACnB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;OAIG;IACH,4BAAe,CAAA;AACjB,CAAC,EA7DW,SAAS,KAAT,SAAS,QA6DpB;AAqED;;GAEG;AACH,MAAM,CAAN,IAAY,SAyEX;AAzED,WAAY,SAAS;IACnB;;;;OAIG;IACH,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;;;OAIG;IACH,0DAA6C,CAAA;IAC7C;;;;OAIG;IACH,oEAAuD,CAAA;IACvD;;;;OAIG;IACH,kEAAqD,CAAA;IACrD;;;;OAIG;IACH,wDAA2C,CAAA;IAC3C;;;;OAIG;IACH,mEAAsD,CAAA;IACtD;;;;OAIG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,6CAAgC,CAAA;IAChC;;;;OAIG;IACH,qEAAwD,CAAA;IACxD;;;;OAIG;IACH,2DAA8C,CAAA;IAC9C;;;;OAIG;IACH,gDAAmC,CAAA;AACrC,CAAC,EAzEW,SAAS,KAAT,SAAS,QAyEpB","sourcesContent":["import type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\n/**\n * @since 0.0.1\n */\nexport interface SquareMobilePaymentsPlugin {\n /**\n * Initialize the Square Mobile Payments SDK.\n *\n * This method must be called before any other method.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n initialize(options: InitializeOptions): Promise<void>;\n /**\n * Authorize the SDK with a Square access token.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n authorize(options: AuthorizeOptions): Promise<void>;\n /**\n * Check if the SDK is currently authorized.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n isAuthorized(): Promise<IsAuthorizedResult>;\n /**\n * Deauthorize the SDK and clear the current authorization.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n deauthorize(): Promise<void>;\n /**\n * Show the Square settings screen.\n *\n * This displays a pre-built settings UI where merchants can view and manage\n * their paired readers.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n showSettings(): Promise<void>;\n /**\n * Get the current SDK settings.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getSettings(): Promise<GetSettingsResult>;\n /**\n * Start pairing with a Square reader.\n *\n * This initiates the reader pairing process. The SDK will search for nearby\n * readers and pair with the first one found.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n startPairing(): Promise<void>;\n /**\n * Stop the reader pairing process.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n stopPairing(): Promise<void>;\n /**\n * Check if a pairing process is currently in progress.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n isPairingInProgress(): Promise<IsPairingInProgressResult>;\n /**\n * Get a list of all paired readers.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getReaders(): Promise<GetReadersResult>;\n /**\n * Forget a paired reader.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n forgetReader(options: ForgetReaderOptions): Promise<void>;\n /**\n * Retry connecting to a reader.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n retryConnection(options: RetryConnectionOptions): Promise<void>;\n /**\n * Start a payment flow.\n *\n * This presents the payment UI and processes the payment using the specified\n * parameters. Only one payment can be active at a time.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n startPayment(options: StartPaymentOptions): Promise<void>;\n /**\n * Cancel an ongoing payment.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n cancelPayment(): Promise<void>;\n /**\n * Get the currently available card input methods.\n *\n * This returns the card entry methods that are available based on the\n * connected readers (e.g., TAP, DIP, SWIPE, KEYED).\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n getAvailableCardInputMethods(): Promise<GetAvailableCardInputMethodsResult>;\n /**\n * Check the current permission status.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n checkPermissions(): Promise<PermissionStatus>;\n /**\n * Request the required permissions.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n requestPermissions(): Promise<PermissionStatus>;\n /**\n * Listen for reader pairing events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'readerPairingDidBegin',\n listenerFunc: ReaderPairingDidBeginListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for successful reader pairing events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'readerPairingDidSucceed',\n listenerFunc: ReaderPairingDidSucceedListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for failed reader pairing events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'readerPairingDidFail',\n listenerFunc: ReaderPairingDidFailListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for reader added events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'readerWasAdded',\n listenerFunc: ReaderWasAddedListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for reader removed events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'readerWasRemoved',\n listenerFunc: ReaderWasRemovedListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for reader status and property changes.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'readerDidChange',\n listenerFunc: ReaderDidChangeListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for available card input method changes.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'availableCardInputMethodsDidChange',\n listenerFunc: AvailableCardInputMethodsDidChangeListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for successful payment completion events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'paymentDidFinish',\n listenerFunc: PaymentDidFinishListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for failed payment events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'paymentDidFail',\n listenerFunc: PaymentDidFailListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Listen for cancelled payment events.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n addListener(\n eventName: 'paymentDidCancel',\n listenerFunc: PaymentDidCancelListener,\n ): Promise<PluginListenerHandle>;\n /**\n * Remove all listeners for this plugin.\n *\n * Only available on Android and iOS.\n *\n * @since 0.0.1\n */\n removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface InitializeOptions {\n /**\n * The Square location ID.\n *\n * @since 0.0.1\n * @example 'LOCATION_ID'\n */\n locationId: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface AuthorizeOptions {\n /**\n * The Square access token.\n *\n * @since 0.0.1\n * @example 'EAAAEOuLQPDbLd...'\n */\n accessToken: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface IsAuthorizedResult {\n /**\n * Whether the SDK is currently authorized.\n *\n * @since 0.0.1\n */\n authorized: boolean;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetSettingsResult {\n /**\n * The SDK version.\n *\n * @since 0.0.1\n * @example '2.0.0'\n */\n version: string;\n /**\n * The current environment.\n *\n * @since 0.0.1\n * @example 'production'\n */\n environment: Environment;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface IsPairingInProgressResult {\n /**\n * Whether a pairing process is currently in progress.\n *\n * @since 0.0.1\n */\n inProgress: boolean;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetReadersResult {\n /**\n * The list of paired readers.\n *\n * @since 0.0.1\n */\n readers: ReaderInfo[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface ForgetReaderOptions {\n /**\n * The serial number of the reader to forget.\n *\n * @since 0.0.1\n * @example 'CRR123456789'\n */\n serialNumber: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface RetryConnectionOptions {\n /**\n * The serial number of the reader to retry connection.\n *\n * @since 0.0.1\n * @example 'CRR123456789'\n */\n serialNumber: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface StartPaymentOptions {\n /**\n * The payment parameters.\n *\n * @since 0.0.1\n */\n paymentParameters: PaymentParameters;\n /**\n * The prompt parameters.\n *\n * @since 0.0.1\n */\n promptParameters: PromptParameters;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface PaymentParameters {\n /**\n * The amount of money to charge.\n *\n * @since 0.0.1\n */\n amountMoney: Money;\n /**\n * A unique identifier for this payment attempt.\n *\n * This is used for idempotent payment requests.\n *\n * @since 0.0.1\n * @example 'a1b2c3d4-e5f6-4a5b-8c9d-1e2f3a4b5c6d'\n */\n paymentAttemptId: string;\n /**\n * The processing mode for this payment.\n *\n * @since 0.0.1\n * @default ProcessingMode.AutoDetect\n */\n processingMode?: ProcessingMode;\n /**\n * A user-defined reference ID to associate with the payment.\n *\n * @since 0.0.1\n * @example 'ORDER-12345'\n */\n referenceId?: string;\n /**\n * An optional note to add to the payment.\n *\n * @since 0.0.1\n * @example 'Birthday gift'\n */\n note?: string;\n /**\n * The Square order ID to associate with this payment.\n *\n * @since 0.0.1\n * @example 'CAISENgvlJ6jLWAzERDzjyHVybY'\n */\n orderId?: string;\n /**\n * The tip amount.\n *\n * @since 0.0.1\n */\n tipMoney?: Money;\n /**\n * The application fee.\n *\n * @since 0.0.1\n */\n applicationFee?: Money;\n /**\n * Whether to automatically complete the payment.\n *\n * If false, the payment will be authorized but not captured, requiring\n * manual completion via the Payments API.\n *\n * @since 0.0.1\n * @default true\n */\n autocomplete?: boolean;\n /**\n * The duration to delay before automatically completing or canceling the payment.\n *\n * Only applicable when autocomplete is false.\n *\n * @since 0.0.1\n * @example 'PT1H'\n */\n delayDuration?: string;\n /**\n * The action to take when the delay duration expires.\n *\n * Only applicable when autocomplete is false.\n *\n * @since 0.0.1\n */\n delayAction?: DelayAction;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface PromptParameters {\n /**\n * The prompt mode.\n *\n * @since 0.0.1\n * @default PromptMode.Default\n */\n mode?: PromptMode;\n /**\n * Additional payment methods to allow.\n *\n * @since 0.0.1\n * @default []\n */\n additionalMethods?: AdditionalPaymentMethod[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface Money {\n /**\n * The amount in the smallest currency unit (e.g., cents for USD).\n *\n * @since 0.0.1\n * @example 100\n */\n amount: number;\n /**\n * The ISO 4217 currency code.\n *\n * @since 0.0.1\n * @example 'USD'\n */\n currency: CurrencyCode;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface GetAvailableCardInputMethodsResult {\n /**\n * The available card input methods.\n *\n * @since 0.0.1\n */\n cardInputMethods: CardInputMethod[];\n}\n\n/**\n * @since 0.0.1\n */\nexport interface ReaderInfo {\n /**\n * The reader's serial number.\n *\n * @since 0.0.1\n * @example 'CRR123456789'\n */\n serialNumber: string;\n /**\n * The reader's model.\n *\n * @since 0.0.1\n */\n model: ReaderModel;\n /**\n * The reader's current status.\n *\n * @since 0.0.1\n */\n status: ReaderStatus;\n /**\n * The reader's firmware version.\n *\n * @since 0.0.1\n * @example '1.2.3'\n */\n firmwareVersion?: string;\n /**\n * The reader's battery level (0-100).\n *\n * @since 0.0.1\n * @example 85\n */\n batteryLevel?: number;\n /**\n * Whether the reader is currently charging.\n *\n * @since 0.0.1\n */\n isCharging?: boolean;\n /**\n * The card input methods supported by this reader.\n *\n * @since 0.0.1\n */\n supportedCardInputMethods: CardInputMethod[];\n /**\n * Additional information about why the reader is unavailable.\n *\n * Only present when status is ReaderUnavailable.\n *\n * @since 0.0.1\n */\n unavailableReasonInfo?: UnavailableReasonInfo;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface UnavailableReasonInfo {\n /**\n * The reason code why the reader is unavailable.\n *\n * @since 0.0.1\n */\n reason: UnavailableReason;\n /**\n * A human-readable message describing why the reader is unavailable.\n *\n * @since 0.0.1\n */\n message?: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface Payment {\n /**\n * The unique identifier for this payment.\n *\n * For offline payments, this may be null until synced.\n *\n * @since 0.0.1\n * @example 'AbCdEfGhIjKlMnOpQrStUvWxYz'\n */\n id: string | null;\n /**\n * The payment type.\n *\n * @since 0.0.1\n */\n type: PaymentType;\n /**\n * The payment status.\n *\n * @since 0.0.1\n */\n status: PaymentStatus;\n /**\n * The amount paid.\n *\n * @since 0.0.1\n */\n amountMoney: Money;\n /**\n * The tip amount.\n *\n * @since 0.0.1\n */\n tipMoney?: Money;\n /**\n * The application fee.\n *\n * @since 0.0.1\n */\n applicationFee?: Money;\n /**\n * The reference ID provided in the payment parameters.\n *\n * @since 0.0.1\n */\n referenceId?: string;\n /**\n * The order ID associated with this payment.\n *\n * @since 0.0.1\n */\n orderId?: string;\n /**\n * Card payment details.\n *\n * Only present for card payments.\n *\n * @since 0.0.1\n */\n cardDetails?: CardPaymentDetails;\n /**\n * The time the payment was created (ISO 8601 format).\n *\n * @since 0.0.1\n * @example '2024-01-15T10:30:00Z'\n */\n createdAt?: string;\n /**\n * The time the payment was updated (ISO 8601 format).\n *\n * @since 0.0.1\n * @example '2024-01-15T10:30:00Z'\n */\n updatedAt?: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface CardPaymentDetails {\n /**\n * The card information.\n *\n * @since 0.0.1\n */\n card: Card;\n /**\n * The card entry method used.\n *\n * @since 0.0.1\n */\n entryMethod: CardInputMethod;\n /**\n * The authorization code.\n *\n * @since 0.0.1\n * @example '123456'\n */\n authorizationCode?: string;\n /**\n * The EMV application name.\n *\n * @since 0.0.1\n * @example 'VISA CREDIT'\n */\n applicationName?: string;\n /**\n * The EMV application identifier.\n *\n * @since 0.0.1\n * @example 'A0000000031010'\n */\n applicationId?: string;\n}\n\n/**\n * @since 0.0.1\n */\nexport interface Card {\n /**\n * The card brand.\n *\n * @since 0.0.1\n */\n brand: CardBrand;\n /**\n * The last four digits of the card number.\n *\n * @since 0.0.1\n * @example '1234'\n */\n lastFourDigits: string;\n /**\n * The cardholder name.\n *\n * @since 0.0.1\n * @example 'John Doe'\n */\n cardholderName?: string;\n /**\n * The card expiration month (1-12).\n *\n * @since 0.0.1\n * @example 12\n */\n expirationMonth?: number;\n /**\n * The card expiration year.\n *\n * @since 0.0.1\n * @example 2025\n */\n expirationYear?: number;\n}\n\n/**\n * Callback to receive reader pairing start notifications.\n *\n * @since 0.0.1\n */\nexport type ReaderPairingDidBeginListener = () => void;\n\n/**\n * Callback to receive reader pairing success notifications.\n *\n * @since 0.0.1\n */\nexport type ReaderPairingDidSucceedListener = () => void;\n\n/**\n * Callback to receive reader pairing failure notifications.\n *\n * @since 0.0.1\n */\nexport type ReaderPairingDidFailListener = (\n event: ReaderPairingDidFailEvent,\n) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface ReaderPairingDidFailEvent {\n /**\n * The error code.\n *\n * @since 0.0.1\n */\n code?: string;\n /**\n * The error message.\n *\n * @since 0.0.1\n */\n message: string;\n}\n\n/**\n * Callback to receive reader added notifications.\n *\n * @since 0.0.1\n */\nexport type ReaderWasAddedListener = (event: ReaderWasAddedEvent) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface ReaderWasAddedEvent {\n /**\n * The reader that was added.\n *\n * @since 0.0.1\n */\n reader: ReaderInfo;\n}\n\n/**\n * Callback to receive reader removed notifications.\n *\n * @since 0.0.1\n */\nexport type ReaderWasRemovedListener = (event: ReaderWasRemovedEvent) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface ReaderWasRemovedEvent {\n /**\n * The reader that was removed.\n *\n * @since 0.0.1\n */\n reader: ReaderInfo;\n}\n\n/**\n * Callback to receive reader change notifications.\n *\n * @since 0.0.1\n */\nexport type ReaderDidChangeListener = (event: ReaderDidChangeEvent) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface ReaderDidChangeEvent {\n /**\n * The reader that changed.\n *\n * @since 0.0.1\n */\n reader: ReaderInfo;\n /**\n * The type of change that occurred.\n *\n * @since 0.0.1\n */\n change: ReaderChange;\n}\n\n/**\n * Callback to receive available card input method change notifications.\n *\n * @since 0.0.1\n */\nexport type AvailableCardInputMethodsDidChangeListener = (\n event: AvailableCardInputMethodsDidChangeEvent,\n) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface AvailableCardInputMethodsDidChangeEvent {\n /**\n * The available card input methods.\n *\n * @since 0.0.1\n */\n cardInputMethods: CardInputMethod[];\n}\n\n/**\n * Callback to receive payment completion notifications.\n *\n * @since 0.0.1\n */\nexport type PaymentDidFinishListener = (event: PaymentDidFinishEvent) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface PaymentDidFinishEvent {\n /**\n * The completed payment.\n *\n * @since 0.0.1\n */\n payment: Payment;\n}\n\n/**\n * Callback to receive payment failure notifications.\n *\n * @since 0.0.1\n */\nexport type PaymentDidFailListener = (event: PaymentDidFailEvent) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface PaymentDidFailEvent {\n /**\n * The failed payment.\n *\n * @since 0.0.1\n */\n payment?: Payment;\n /**\n * The error code.\n *\n * @since 0.0.1\n */\n code?: string;\n /**\n * The error message.\n *\n * @since 0.0.1\n */\n message: string;\n}\n\n/**\n * Callback to receive payment cancellation notifications.\n *\n * @since 0.0.1\n */\nexport type PaymentDidCancelListener = (event: PaymentDidCancelEvent) => void;\n\n/**\n * @since 0.0.1\n */\nexport interface PaymentDidCancelEvent {\n /**\n * The cancelled payment.\n *\n * @since 0.0.1\n */\n payment?: Payment;\n}\n\n/**\n * @since 0.0.1\n */\nexport enum Environment {\n /**\n * Production environment.\n *\n * @since 0.0.1\n */\n Production = 'production',\n /**\n * Sandbox environment for testing.\n *\n * @since 0.0.1\n */\n Sandbox = 'sandbox',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum CardInputMethod {\n /**\n * Contactless card tap (NFC).\n *\n * @since 0.0.1\n */\n Tap = 'TAP',\n /**\n * EMV chip card insertion.\n *\n * @since 0.0.1\n */\n Dip = 'DIP',\n /**\n * Magnetic stripe swipe.\n *\n * @since 0.0.1\n */\n Swipe = 'SWIPE',\n /**\n * Manually keyed card entry.\n *\n * @since 0.0.1\n */\n Keyed = 'KEYED',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum ProcessingMode {\n /**\n * Automatically detect the best processing mode (online or offline).\n *\n * @since 0.0.1\n */\n AutoDetect = 'AUTO_DETECT',\n /**\n * Process the payment online only.\n *\n * @since 0.0.1\n */\n OnlineOnly = 'ONLINE_ONLY',\n /**\n * Allow offline payment processing.\n *\n * @since 0.0.1\n */\n OfflineOnly = 'OFFLINE_ONLY',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum PromptMode {\n /**\n * Use the default Square payment UI.\n *\n * @since 0.0.1\n */\n Default = 'DEFAULT',\n /**\n * Use a custom payment UI.\n *\n * @since 0.0.1\n */\n Custom = 'CUSTOM',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum AdditionalPaymentMethod {\n /**\n * Allow manually keyed card entry.\n *\n * @since 0.0.1\n */\n Keyed = 'KEYED',\n /**\n * Allow cash payments.\n *\n * @since 0.0.1\n */\n Cash = 'CASH',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum DelayAction {\n /**\n * Automatically complete the payment when the delay expires.\n *\n * @since 0.0.1\n */\n Complete = 'COMPLETE',\n /**\n * Automatically cancel the payment when the delay expires.\n *\n * @since 0.0.1\n */\n Cancel = 'CANCEL',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum ReaderModel {\n /**\n * Square Reader for contactless and chip.\n *\n * @since 0.0.1\n */\n ContactlessAndChip = 'CONTACTLESS_AND_CHIP',\n /**\n * Square Reader for magstripe.\n *\n * @since 0.0.1\n */\n Magstripe = 'MAGSTRIPE',\n /**\n * Square Stand.\n *\n * @since 0.0.1\n */\n Stand = 'STAND',\n /**\n * Unknown reader model.\n *\n * @since 0.0.1\n */\n Unknown = 'UNKNOWN',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum ReaderStatus {\n /**\n * Reader is paired, connected, and ready to accept payments.\n *\n * @since 0.0.1\n */\n Ready = 'READY',\n /**\n * Reader is connecting to Square servers.\n *\n * @since 0.0.1\n */\n ConnectingToSquare = 'CONNECTING_TO_SQUARE',\n /**\n * Reader is connecting to the mobile device.\n *\n * @since 0.0.1\n */\n ConnectingToDevice = 'CONNECTING_TO_DEVICE',\n /**\n * Reader has a hardware or connection error in an unrecoverable state.\n *\n * @since 0.0.1\n */\n Faulty = 'FAULTY',\n /**\n * Reader is connected but unable to process payments.\n *\n * @since 0.0.1\n */\n ReaderUnavailable = 'READER_UNAVAILABLE',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum ReaderChange {\n /**\n * Reader battery started charging.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n BatteryDidBeginCharging = 'BATTERY_DID_BEGIN_CHARGING',\n /**\n * Reader battery stopped charging.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n BatteryDidEndCharging = 'BATTERY_DID_END_CHARGING',\n /**\n * Reader battery level changed.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n BatteryLevelDidChange = 'BATTERY_LEVEL_DID_CHANGE',\n /**\n * Reader battery charging status changed.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n BatteryCharging = 'BATTERY_CHARGING',\n /**\n * Reader was added.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n Added = 'ADDED',\n /**\n * Reader was removed.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n Removed = 'REMOVED',\n /**\n * Reader status changed.\n *\n * @since 0.0.1\n */\n StatusDidChange = 'STATUS_DID_CHANGE',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum UnavailableReason {\n /**\n * Bluetooth connection issue.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n BluetoothError = 'BLUETOOTH_ERROR',\n /**\n * Bluetooth failure.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n BluetoothFailure = 'BLUETOOTH_FAILURE',\n /**\n * Bluetooth is disabled.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n BluetoothDisabled = 'BLUETOOTH_DISABLED',\n /**\n * Reader firmware is updating.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n FirmwareUpdate = 'FIRMWARE_UPDATE',\n /**\n * Blocking firmware update.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n BlockingUpdate = 'BLOCKING_UPDATE',\n /**\n * Reader is unavailable offline.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n ReaderUnavailableOffline = 'READER_UNAVAILABLE_OFFLINE',\n /**\n * Device is in developer mode.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n DeviceDeveloperMode = 'DEVICE_DEVELOPER_MODE',\n /**\n * Unknown reason.\n *\n * @since 0.0.1\n */\n Unknown = 'UNKNOWN',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum PaymentType {\n /**\n * Payment processed online.\n *\n * @since 0.0.1\n */\n Online = 'ONLINE',\n /**\n * Payment processed offline.\n *\n * @since 0.0.1\n */\n Offline = 'OFFLINE',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum PaymentStatus {\n /**\n * Payment was completed successfully.\n *\n * @since 0.0.1\n */\n Completed = 'COMPLETED',\n /**\n * Payment was approved but not yet completed.\n *\n * @since 0.0.1\n */\n Approved = 'APPROVED',\n /**\n * Payment was canceled.\n *\n * @since 0.0.1\n */\n Canceled = 'CANCELED',\n /**\n * Payment failed.\n *\n * @since 0.0.1\n */\n Failed = 'FAILED',\n /**\n * Payment is pending.\n *\n * @since 0.0.1\n */\n Pending = 'PENDING',\n}\n\n/**\n * @since 0.0.1\n */\nexport enum CardBrand {\n /**\n * Visa card.\n *\n * @since 0.0.1\n */\n Visa = 'VISA',\n /**\n * Mastercard.\n *\n * @since 0.0.1\n */\n Mastercard = 'MASTERCARD',\n /**\n * American Express card.\n *\n * @since 0.0.1\n */\n AmericanExpress = 'AMERICAN_EXPRESS',\n /**\n * Discover card.\n *\n * @since 0.0.1\n */\n Discover = 'DISCOVER',\n /**\n * Discover Diners card.\n *\n * @since 0.0.1\n */\n DiscoverDiners = 'DISCOVER_DINERS',\n /**\n * JCB card.\n *\n * @since 0.0.1\n */\n Jcb = 'JCB',\n /**\n * UnionPay card.\n *\n * @since 0.0.1\n */\n UnionPay = 'UNION_PAY',\n /**\n * Interac card.\n *\n * @since 0.0.1\n */\n Interac = 'INTERAC',\n /**\n * Eftpos card.\n *\n * @since 0.0.1\n */\n Eftpos = 'EFTPOS',\n /**\n * Other or unknown card brand.\n *\n * @since 0.0.1\n */\n Other = 'OTHER',\n}\n\n/**\n * @since 0.0.1\n */\nexport interface PermissionStatus {\n /**\n * Permission state for accessing location.\n *\n * Required to confirm that payments are occurring in a supported Square location.\n *\n * @since 0.0.1\n */\n location: PermissionState;\n /**\n * Permission state for recording audio.\n *\n * Required to receive data from magstripe readers.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n recordAudio?: PermissionState;\n /**\n * Permission state for Bluetooth connect.\n *\n * Required to receive data from contactless and chip readers.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n bluetoothConnect?: PermissionState;\n /**\n * Permission state for Bluetooth scan.\n *\n * Required to store information during checkout.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n bluetoothScan?: PermissionState;\n /**\n * Permission state for reading phone state.\n *\n * Required to identify the device sending information to Square servers.\n *\n * Only available on Android.\n *\n * @since 0.0.1\n */\n readPhoneState?: PermissionState;\n /**\n * Permission state for using Bluetooth.\n *\n * Only available on iOS.\n *\n * @since 0.0.1\n */\n bluetooth?: PermissionState;\n}\n\n/**\n * @since 0.0.1\n */\nexport type CurrencyCode = string;\n\n/**\n * @since 0.0.1\n */\nexport enum ErrorCode {\n /**\n * The location ID is missing.\n *\n * @since 0.0.1\n */\n LocationIdMissing = 'LOCATION_ID_MISSING',\n /**\n * The access token is missing.\n *\n * @since 0.0.1\n */\n AccessTokenMissing = 'ACCESS_TOKEN_MISSING',\n /**\n * The serial number is missing.\n *\n * @since 0.0.1\n */\n SerialNumberMissing = 'SERIAL_NUMBER_MISSING',\n /**\n * The payment parameters are missing.\n *\n * @since 0.0.1\n */\n PaymentParametersMissing = 'PAYMENT_PARAMETERS_MISSING',\n /**\n * The prompt parameters are missing.\n *\n * @since 0.0.1\n */\n PromptParametersMissing = 'PROMPT_PARAMETERS_MISSING',\n /**\n * The amount money is missing.\n *\n * @since 0.0.1\n */\n AmountMoneyMissing = 'AMOUNT_MONEY_MISSING',\n /**\n * The payment attempt ID is missing.\n *\n * @since 0.0.1\n */\n PaymentAttemptIdMissing = 'PAYMENT_ATTEMPT_ID_MISSING',\n /**\n * The SDK is not initialized.\n *\n * @since 0.0.1\n */\n NotInitialized = 'NOT_INITIALIZED',\n /**\n * The SDK is not authorized.\n *\n * @since 0.0.1\n */\n NotAuthorized = 'NOT_AUTHORIZED',\n /**\n * A pairing process is already in progress.\n *\n * @since 0.0.1\n */\n PairingAlreadyInProgress = 'PAIRING_ALREADY_IN_PROGRESS',\n /**\n * No payment is in progress.\n *\n * @since 0.0.1\n */\n NoPaymentInProgress = 'NO_PAYMENT_IN_PROGRESS',\n /**\n * Reader not found.\n *\n * @since 0.0.1\n */\n ReaderNotFound = 'READER_NOT_FOUND',\n}\n"]}
@@ -0,0 +1,4 @@
1
+ import type { SquareMobilePaymentsPlugin } from './definitions';
2
+ declare const SquareMobilePayments: SquareMobilePaymentsPlugin;
3
+ export * from './definitions';
4
+ export { SquareMobilePayments };
@@ -0,0 +1,7 @@
1
+ import { registerPlugin } from '@capacitor/core';
2
+ const SquareMobilePayments = registerPlugin('SquareMobilePayments', {
3
+ web: () => import('./web').then(m => new m.SquareMobilePaymentsWeb()),
4
+ });
5
+ export * from './definitions';
6
+ export { SquareMobilePayments };
7
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,oBAAoB,GAAG,cAAc,CACzC,sBAAsB,EACtB;IACE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,uBAAuB,EAAE,CAAC;CACtE,CACF,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,oBAAoB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { SquareMobilePaymentsPlugin } from './definitions';\n\nconst SquareMobilePayments = registerPlugin<SquareMobilePaymentsPlugin>(\n 'SquareMobilePayments',\n {\n web: () => import('./web').then(m => new m.SquareMobilePaymentsWeb()),\n },\n);\n\nexport * from './definitions';\nexport { SquareMobilePayments };\n"]}
@@ -0,0 +1,21 @@
1
+ import { WebPlugin } from '@capacitor/core';
2
+ import type { AuthorizeOptions, ForgetReaderOptions, GetAvailableCardInputMethodsResult, GetReadersResult, GetSettingsResult, InitializeOptions, IsAuthorizedResult, IsPairingInProgressResult, PermissionStatus, RetryConnectionOptions, SquareMobilePaymentsPlugin, StartPaymentOptions } from './definitions';
3
+ export declare class SquareMobilePaymentsWeb extends WebPlugin implements SquareMobilePaymentsPlugin {
4
+ initialize(_options: InitializeOptions): Promise<void>;
5
+ authorize(_options: AuthorizeOptions): Promise<void>;
6
+ isAuthorized(): Promise<IsAuthorizedResult>;
7
+ deauthorize(): Promise<void>;
8
+ showSettings(): Promise<void>;
9
+ getSettings(): Promise<GetSettingsResult>;
10
+ startPairing(): Promise<void>;
11
+ stopPairing(): Promise<void>;
12
+ isPairingInProgress(): Promise<IsPairingInProgressResult>;
13
+ getReaders(): Promise<GetReadersResult>;
14
+ forgetReader(_options: ForgetReaderOptions): Promise<void>;
15
+ retryConnection(_options: RetryConnectionOptions): Promise<void>;
16
+ startPayment(_options: StartPaymentOptions): Promise<void>;
17
+ cancelPayment(): Promise<void>;
18
+ getAvailableCardInputMethods(): Promise<GetAvailableCardInputMethodsResult>;
19
+ checkPermissions(): Promise<PermissionStatus>;
20
+ requestPermissions(): Promise<PermissionStatus>;
21
+ }
@@ -0,0 +1,55 @@
1
+ import { WebPlugin } from '@capacitor/core';
2
+ export class SquareMobilePaymentsWeb extends WebPlugin {
3
+ async initialize(_options) {
4
+ throw this.unimplemented('Not implemented on web.');
5
+ }
6
+ async authorize(_options) {
7
+ throw this.unimplemented('Not implemented on web.');
8
+ }
9
+ async isAuthorized() {
10
+ throw this.unimplemented('Not implemented on web.');
11
+ }
12
+ async deauthorize() {
13
+ throw this.unimplemented('Not implemented on web.');
14
+ }
15
+ async showSettings() {
16
+ throw this.unimplemented('Not implemented on web.');
17
+ }
18
+ async getSettings() {
19
+ throw this.unimplemented('Not implemented on web.');
20
+ }
21
+ async startPairing() {
22
+ throw this.unimplemented('Not implemented on web.');
23
+ }
24
+ async stopPairing() {
25
+ throw this.unimplemented('Not implemented on web.');
26
+ }
27
+ async isPairingInProgress() {
28
+ throw this.unimplemented('Not implemented on web.');
29
+ }
30
+ async getReaders() {
31
+ throw this.unimplemented('Not implemented on web.');
32
+ }
33
+ async forgetReader(_options) {
34
+ throw this.unimplemented('Not implemented on web.');
35
+ }
36
+ async retryConnection(_options) {
37
+ throw this.unimplemented('Not implemented on web.');
38
+ }
39
+ async startPayment(_options) {
40
+ throw this.unimplemented('Not implemented on web.');
41
+ }
42
+ async cancelPayment() {
43
+ throw this.unimplemented('Not implemented on web.');
44
+ }
45
+ async getAvailableCardInputMethods() {
46
+ throw this.unimplemented('Not implemented on web.');
47
+ }
48
+ async checkPermissions() {
49
+ throw this.unimplemented('Not implemented on web.');
50
+ }
51
+ async requestPermissions() {
52
+ throw this.unimplemented('Not implemented on web.');
53
+ }
54
+ }
55
+ //# sourceMappingURL=web.js.map