@appboxo/capacitor-boxo-sdk 0.0.2
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/CapacitorBoxoSdk.podspec +18 -0
- package/Package.swift +28 -0
- package/README.md +240 -0
- package/android/build.gradle +84 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/java/io/boxo/sdk/capacitor/AppboxoPlugin.kt +322 -0
- package/android/src/main/res/.gitkeep +0 -0
- package/dist/docs.json +485 -0
- package/dist/esm/definitions.d.ts +156 -0
- package/dist/esm/definitions.js +2 -0
- package/dist/esm/definitions.js.map +1 -0
- package/dist/esm/index.d.ts +4 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/plugin.cjs.js +10 -0
- package/dist/plugin.cjs.js.map +1 -0
- package/dist/plugin.js +13 -0
- package/dist/plugin.js.map +1 -0
- package/ios/Sources/AppboxoPlugin/AppboxoPlugin.swift +293 -0
- package/ios/Tests/AppboxoPluginTests/AppboxoPluginTests.swift +15 -0
- package/package.json +80 -0
|
File without changes
|
package/dist/docs.json
ADDED
|
@@ -0,0 +1,485 @@
|
|
|
1
|
+
{
|
|
2
|
+
"api": {
|
|
3
|
+
"name": "AppboxoPlugin",
|
|
4
|
+
"slug": "appboxoplugin",
|
|
5
|
+
"docs": "",
|
|
6
|
+
"tags": [],
|
|
7
|
+
"methods": [
|
|
8
|
+
{
|
|
9
|
+
"name": "setConfig",
|
|
10
|
+
"signature": "(options: ConfigOptions) => Promise<void>",
|
|
11
|
+
"parameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "options",
|
|
14
|
+
"docs": "",
|
|
15
|
+
"type": "ConfigOptions"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
"returns": "Promise<void>",
|
|
19
|
+
"tags": [],
|
|
20
|
+
"docs": "Set global configs",
|
|
21
|
+
"complexTypes": [
|
|
22
|
+
"ConfigOptions"
|
|
23
|
+
],
|
|
24
|
+
"slug": "setconfig"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"name": "openMiniapp",
|
|
28
|
+
"signature": "(options: OpenMiniappOptions) => Promise<void>",
|
|
29
|
+
"parameters": [
|
|
30
|
+
{
|
|
31
|
+
"name": "options",
|
|
32
|
+
"docs": "",
|
|
33
|
+
"type": "OpenMiniappOptions"
|
|
34
|
+
}
|
|
35
|
+
],
|
|
36
|
+
"returns": "Promise<void>",
|
|
37
|
+
"tags": [],
|
|
38
|
+
"docs": "Open miniapp with options",
|
|
39
|
+
"complexTypes": [
|
|
40
|
+
"OpenMiniappOptions"
|
|
41
|
+
],
|
|
42
|
+
"slug": "openminiapp"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"name": "setAuthCode",
|
|
46
|
+
"signature": "(options: { appId: string; authCode: string; }) => Promise<void>",
|
|
47
|
+
"parameters": [
|
|
48
|
+
{
|
|
49
|
+
"name": "options",
|
|
50
|
+
"docs": "",
|
|
51
|
+
"type": "{ appId: string; authCode: string; }"
|
|
52
|
+
}
|
|
53
|
+
],
|
|
54
|
+
"returns": "Promise<void>",
|
|
55
|
+
"tags": [],
|
|
56
|
+
"docs": "get AuthCode from hostapp backend and send it to miniapp",
|
|
57
|
+
"complexTypes": [],
|
|
58
|
+
"slug": "setauthcode"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"name": "closeMiniapp",
|
|
62
|
+
"signature": "(options: { appId: string; }) => Promise<void>",
|
|
63
|
+
"parameters": [
|
|
64
|
+
{
|
|
65
|
+
"name": "options",
|
|
66
|
+
"docs": "",
|
|
67
|
+
"type": "{ appId: string; }"
|
|
68
|
+
}
|
|
69
|
+
],
|
|
70
|
+
"returns": "Promise<void>",
|
|
71
|
+
"tags": [],
|
|
72
|
+
"docs": "close miniapp by appId",
|
|
73
|
+
"complexTypes": [],
|
|
74
|
+
"slug": "closeminiapp"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"name": "sendCustomEvent",
|
|
78
|
+
"signature": "(customEvent: CustomEvent) => Promise<void>",
|
|
79
|
+
"parameters": [
|
|
80
|
+
{
|
|
81
|
+
"name": "customEvent",
|
|
82
|
+
"docs": "",
|
|
83
|
+
"type": "CustomEvent"
|
|
84
|
+
}
|
|
85
|
+
],
|
|
86
|
+
"returns": "Promise<void>",
|
|
87
|
+
"tags": [],
|
|
88
|
+
"docs": "send custom event to miniapp",
|
|
89
|
+
"complexTypes": [
|
|
90
|
+
"CustomEvent"
|
|
91
|
+
],
|
|
92
|
+
"slug": "sendcustomevent"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "sendPaymentEvent",
|
|
96
|
+
"signature": "(paymentEvent: PaymentEvent) => Promise<void>",
|
|
97
|
+
"parameters": [
|
|
98
|
+
{
|
|
99
|
+
"name": "paymentEvent",
|
|
100
|
+
"docs": "",
|
|
101
|
+
"type": "PaymentEvent"
|
|
102
|
+
}
|
|
103
|
+
],
|
|
104
|
+
"returns": "Promise<void>",
|
|
105
|
+
"tags": [],
|
|
106
|
+
"docs": "send payment event to miniapp",
|
|
107
|
+
"complexTypes": [
|
|
108
|
+
"PaymentEvent"
|
|
109
|
+
],
|
|
110
|
+
"slug": "sendpaymentevent"
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "getMiniapps",
|
|
114
|
+
"signature": "() => Promise<MiniappListResult>",
|
|
115
|
+
"parameters": [],
|
|
116
|
+
"returns": "Promise<MiniappListResult>",
|
|
117
|
+
"tags": [],
|
|
118
|
+
"docs": "Get list of miniapps",
|
|
119
|
+
"complexTypes": [
|
|
120
|
+
"MiniappListResult"
|
|
121
|
+
],
|
|
122
|
+
"slug": "getminiapps"
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
"name": "hideMiniapps",
|
|
126
|
+
"signature": "() => Promise<void>",
|
|
127
|
+
"parameters": [],
|
|
128
|
+
"returns": "Promise<void>",
|
|
129
|
+
"tags": [],
|
|
130
|
+
"docs": "Miniapp opens on a native screen. To show payment processing page need to hide miniapp screen.\nTo use this function need to enable 'enableMultitaskMode: true' in Appboxo.setConfigs()",
|
|
131
|
+
"complexTypes": [],
|
|
132
|
+
"slug": "hideminiapps"
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"name": "logout",
|
|
136
|
+
"signature": "() => Promise<void>",
|
|
137
|
+
"parameters": [],
|
|
138
|
+
"returns": "Promise<void>",
|
|
139
|
+
"tags": [],
|
|
140
|
+
"docs": "When host app user logs out, it is highly important to clear all miniapp storage data.",
|
|
141
|
+
"complexTypes": [],
|
|
142
|
+
"slug": "logout"
|
|
143
|
+
}
|
|
144
|
+
],
|
|
145
|
+
"properties": []
|
|
146
|
+
},
|
|
147
|
+
"interfaces": [
|
|
148
|
+
{
|
|
149
|
+
"name": "ConfigOptions",
|
|
150
|
+
"slug": "configoptions",
|
|
151
|
+
"docs": "",
|
|
152
|
+
"tags": [],
|
|
153
|
+
"methods": [],
|
|
154
|
+
"properties": [
|
|
155
|
+
{
|
|
156
|
+
"name": "clientId",
|
|
157
|
+
"tags": [],
|
|
158
|
+
"docs": "your client id from dashboard",
|
|
159
|
+
"complexTypes": [],
|
|
160
|
+
"type": "string"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"name": "userId",
|
|
164
|
+
"tags": [],
|
|
165
|
+
"docs": "hostapp userId, will be used for the Consent Management",
|
|
166
|
+
"complexTypes": [],
|
|
167
|
+
"type": "string | undefined"
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"name": "sandboxMode",
|
|
171
|
+
"tags": [],
|
|
172
|
+
"docs": "switch to sandbox mode",
|
|
173
|
+
"complexTypes": [],
|
|
174
|
+
"type": "boolean | undefined"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"name": "enableMultitaskMode",
|
|
178
|
+
"tags": [],
|
|
179
|
+
"docs": "Each miniapp appears as a task in the Recents screen.\n!It works only on android devices.",
|
|
180
|
+
"complexTypes": [],
|
|
181
|
+
"type": "boolean | undefined"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "theme",
|
|
185
|
+
"tags": [],
|
|
186
|
+
"docs": "theme for splash screen and other native components used inside miniapp.",
|
|
187
|
+
"complexTypes": [],
|
|
188
|
+
"type": "'light' | 'dark' | 'system' | undefined"
|
|
189
|
+
},
|
|
190
|
+
{
|
|
191
|
+
"name": "isDebug",
|
|
192
|
+
"tags": [],
|
|
193
|
+
"docs": "enables webview debugging",
|
|
194
|
+
"complexTypes": [],
|
|
195
|
+
"type": "boolean | undefined"
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "showPermissionsPage",
|
|
199
|
+
"tags": [],
|
|
200
|
+
"docs": "use it to hide \"Settings\" from Miniapp menu",
|
|
201
|
+
"complexTypes": [],
|
|
202
|
+
"type": "boolean | undefined"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "showClearCache",
|
|
206
|
+
"tags": [],
|
|
207
|
+
"docs": "use it to hide \"Clear cache\" from Miniapp menu",
|
|
208
|
+
"complexTypes": [],
|
|
209
|
+
"type": "boolean | undefined"
|
|
210
|
+
}
|
|
211
|
+
]
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"name": "OpenMiniappOptions",
|
|
215
|
+
"slug": "openminiappoptions",
|
|
216
|
+
"docs": "",
|
|
217
|
+
"tags": [],
|
|
218
|
+
"methods": [],
|
|
219
|
+
"properties": [
|
|
220
|
+
{
|
|
221
|
+
"name": "appId",
|
|
222
|
+
"tags": [],
|
|
223
|
+
"docs": "miniapp id",
|
|
224
|
+
"complexTypes": [],
|
|
225
|
+
"type": "string"
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"name": "data",
|
|
229
|
+
"tags": [],
|
|
230
|
+
"docs": "(optional) data as Map that is sent to miniapp",
|
|
231
|
+
"complexTypes": [],
|
|
232
|
+
"type": "object | undefined"
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "theme",
|
|
236
|
+
"tags": [],
|
|
237
|
+
"docs": "(optional) miniapp theme \"dark\" | \"light\" (by default is system theme)",
|
|
238
|
+
"complexTypes": [],
|
|
239
|
+
"type": "'light' | 'dark' | 'system' | undefined"
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "extraUrlParams",
|
|
243
|
+
"tags": [],
|
|
244
|
+
"docs": "(optional) extra query params to append to miniapp URL (like: http://miniapp-url.com/?param=test)",
|
|
245
|
+
"complexTypes": [],
|
|
246
|
+
"type": "object | undefined"
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
"name": "urlSuffix",
|
|
250
|
+
"tags": [],
|
|
251
|
+
"docs": "(optional) suffix to append to miniapp URL (like: http://miniapp-url.com/?param=test)",
|
|
252
|
+
"complexTypes": [],
|
|
253
|
+
"type": "string | undefined"
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "colors",
|
|
257
|
+
"tags": [],
|
|
258
|
+
"docs": "(optional) provide colors to miniapp if miniapp supports",
|
|
259
|
+
"complexTypes": [
|
|
260
|
+
"ColorOptions"
|
|
261
|
+
],
|
|
262
|
+
"type": "ColorOptions"
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "enableSplash",
|
|
266
|
+
"tags": [],
|
|
267
|
+
"docs": "(optional) use to skip miniapp splash screen",
|
|
268
|
+
"complexTypes": [],
|
|
269
|
+
"type": "boolean | undefined"
|
|
270
|
+
}
|
|
271
|
+
]
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"name": "ColorOptions",
|
|
275
|
+
"slug": "coloroptions",
|
|
276
|
+
"docs": "",
|
|
277
|
+
"tags": [],
|
|
278
|
+
"methods": [],
|
|
279
|
+
"properties": [
|
|
280
|
+
{
|
|
281
|
+
"name": "primaryColor",
|
|
282
|
+
"tags": [],
|
|
283
|
+
"docs": "",
|
|
284
|
+
"complexTypes": [],
|
|
285
|
+
"type": "string | undefined"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"name": "secondaryColor",
|
|
289
|
+
"tags": [],
|
|
290
|
+
"docs": "",
|
|
291
|
+
"complexTypes": [],
|
|
292
|
+
"type": "string | undefined"
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
"name": "tertiaryColor",
|
|
296
|
+
"tags": [],
|
|
297
|
+
"docs": "",
|
|
298
|
+
"complexTypes": [],
|
|
299
|
+
"type": "string | undefined"
|
|
300
|
+
}
|
|
301
|
+
]
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "CustomEvent",
|
|
305
|
+
"slug": "customevent",
|
|
306
|
+
"docs": "",
|
|
307
|
+
"tags": [],
|
|
308
|
+
"methods": [],
|
|
309
|
+
"properties": [
|
|
310
|
+
{
|
|
311
|
+
"name": "appId",
|
|
312
|
+
"tags": [],
|
|
313
|
+
"docs": "",
|
|
314
|
+
"complexTypes": [],
|
|
315
|
+
"type": "string"
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
"name": "requestId",
|
|
319
|
+
"tags": [],
|
|
320
|
+
"docs": "",
|
|
321
|
+
"complexTypes": [],
|
|
322
|
+
"type": "number"
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"name": "type",
|
|
326
|
+
"tags": [],
|
|
327
|
+
"docs": "",
|
|
328
|
+
"complexTypes": [],
|
|
329
|
+
"type": "string"
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "errorType",
|
|
333
|
+
"tags": [],
|
|
334
|
+
"docs": "",
|
|
335
|
+
"complexTypes": [],
|
|
336
|
+
"type": "string | undefined"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"name": "payload",
|
|
340
|
+
"tags": [],
|
|
341
|
+
"docs": "",
|
|
342
|
+
"complexTypes": [],
|
|
343
|
+
"type": "object | undefined"
|
|
344
|
+
}
|
|
345
|
+
]
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"name": "PaymentEvent",
|
|
349
|
+
"slug": "paymentevent",
|
|
350
|
+
"docs": "",
|
|
351
|
+
"tags": [],
|
|
352
|
+
"methods": [],
|
|
353
|
+
"properties": [
|
|
354
|
+
{
|
|
355
|
+
"name": "appId",
|
|
356
|
+
"tags": [],
|
|
357
|
+
"docs": "",
|
|
358
|
+
"complexTypes": [],
|
|
359
|
+
"type": "string"
|
|
360
|
+
},
|
|
361
|
+
{
|
|
362
|
+
"name": "transactionToken",
|
|
363
|
+
"tags": [],
|
|
364
|
+
"docs": "",
|
|
365
|
+
"complexTypes": [],
|
|
366
|
+
"type": "string | undefined"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"name": "miniappOrderId",
|
|
370
|
+
"tags": [],
|
|
371
|
+
"docs": "",
|
|
372
|
+
"complexTypes": [],
|
|
373
|
+
"type": "string | undefined"
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"name": "amount",
|
|
377
|
+
"tags": [],
|
|
378
|
+
"docs": "",
|
|
379
|
+
"complexTypes": [],
|
|
380
|
+
"type": "number"
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "currency",
|
|
384
|
+
"tags": [],
|
|
385
|
+
"docs": "",
|
|
386
|
+
"complexTypes": [],
|
|
387
|
+
"type": "string | undefined"
|
|
388
|
+
},
|
|
389
|
+
{
|
|
390
|
+
"name": "status",
|
|
391
|
+
"tags": [],
|
|
392
|
+
"docs": "",
|
|
393
|
+
"complexTypes": [],
|
|
394
|
+
"type": "string | undefined"
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"name": "hostappOrderId",
|
|
398
|
+
"tags": [],
|
|
399
|
+
"docs": "",
|
|
400
|
+
"complexTypes": [],
|
|
401
|
+
"type": "string | undefined"
|
|
402
|
+
},
|
|
403
|
+
{
|
|
404
|
+
"name": "extraParams",
|
|
405
|
+
"tags": [],
|
|
406
|
+
"docs": "",
|
|
407
|
+
"complexTypes": [],
|
|
408
|
+
"type": "object | undefined"
|
|
409
|
+
}
|
|
410
|
+
]
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"name": "MiniappListResult",
|
|
414
|
+
"slug": "miniapplistresult",
|
|
415
|
+
"docs": "",
|
|
416
|
+
"tags": [],
|
|
417
|
+
"methods": [],
|
|
418
|
+
"properties": [
|
|
419
|
+
{
|
|
420
|
+
"name": "miniapps",
|
|
421
|
+
"tags": [],
|
|
422
|
+
"docs": "",
|
|
423
|
+
"complexTypes": [
|
|
424
|
+
"MiniappData"
|
|
425
|
+
],
|
|
426
|
+
"type": "[MiniappData] | undefined"
|
|
427
|
+
},
|
|
428
|
+
{
|
|
429
|
+
"name": "error",
|
|
430
|
+
"tags": [],
|
|
431
|
+
"docs": "",
|
|
432
|
+
"complexTypes": [],
|
|
433
|
+
"type": "string | undefined"
|
|
434
|
+
}
|
|
435
|
+
]
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "MiniappData",
|
|
439
|
+
"slug": "miniappdata",
|
|
440
|
+
"docs": "",
|
|
441
|
+
"tags": [],
|
|
442
|
+
"methods": [],
|
|
443
|
+
"properties": [
|
|
444
|
+
{
|
|
445
|
+
"name": "appId",
|
|
446
|
+
"tags": [],
|
|
447
|
+
"docs": "",
|
|
448
|
+
"complexTypes": [],
|
|
449
|
+
"type": "string"
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"name": "name",
|
|
453
|
+
"tags": [],
|
|
454
|
+
"docs": "",
|
|
455
|
+
"complexTypes": [],
|
|
456
|
+
"type": "string"
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"name": "category",
|
|
460
|
+
"tags": [],
|
|
461
|
+
"docs": "",
|
|
462
|
+
"complexTypes": [],
|
|
463
|
+
"type": "string"
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "description",
|
|
467
|
+
"tags": [],
|
|
468
|
+
"docs": "",
|
|
469
|
+
"complexTypes": [],
|
|
470
|
+
"type": "string"
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "logo",
|
|
474
|
+
"tags": [],
|
|
475
|
+
"docs": "",
|
|
476
|
+
"complexTypes": [],
|
|
477
|
+
"type": "string"
|
|
478
|
+
}
|
|
479
|
+
]
|
|
480
|
+
}
|
|
481
|
+
],
|
|
482
|
+
"enums": [],
|
|
483
|
+
"typeAliases": [],
|
|
484
|
+
"pluginConfigs": []
|
|
485
|
+
}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
export interface AppboxoPlugin {
|
|
2
|
+
/**
|
|
3
|
+
* Set global configs
|
|
4
|
+
*/
|
|
5
|
+
setConfig(options: ConfigOptions): Promise<void>;
|
|
6
|
+
/**
|
|
7
|
+
* Open miniapp with options
|
|
8
|
+
*/
|
|
9
|
+
openMiniapp(options: OpenMiniappOptions): Promise<void>;
|
|
10
|
+
/**
|
|
11
|
+
* get AuthCode from hostapp backend and send it to miniapp
|
|
12
|
+
*/
|
|
13
|
+
setAuthCode(options: {
|
|
14
|
+
appId: string;
|
|
15
|
+
authCode: string;
|
|
16
|
+
}): Promise<void>;
|
|
17
|
+
/**
|
|
18
|
+
* close miniapp by appId
|
|
19
|
+
*/
|
|
20
|
+
closeMiniapp(options: {
|
|
21
|
+
appId: string;
|
|
22
|
+
}): Promise<void>;
|
|
23
|
+
/**
|
|
24
|
+
* send custom event to miniapp
|
|
25
|
+
*/
|
|
26
|
+
sendCustomEvent(customEvent: CustomEvent): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* send payment event to miniapp
|
|
29
|
+
*/
|
|
30
|
+
sendPaymentEvent(paymentEvent: PaymentEvent): Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
* Get list of miniapps
|
|
33
|
+
*/
|
|
34
|
+
getMiniapps(): Promise<MiniappListResult>;
|
|
35
|
+
/**
|
|
36
|
+
* Miniapp opens on a native screen. To show payment processing page need to hide miniapp screen.
|
|
37
|
+
* To use this function need to enable 'enableMultitaskMode: true' in Appboxo.setConfigs()
|
|
38
|
+
*/
|
|
39
|
+
hideMiniapps(): Promise<void>;
|
|
40
|
+
/**
|
|
41
|
+
* When host app user logs out, it is highly important to clear all miniapp storage data.
|
|
42
|
+
*/
|
|
43
|
+
logout(): Promise<void>;
|
|
44
|
+
}
|
|
45
|
+
export interface ConfigOptions {
|
|
46
|
+
/**
|
|
47
|
+
* your client id from dashboard
|
|
48
|
+
*/
|
|
49
|
+
clientId: string;
|
|
50
|
+
/**
|
|
51
|
+
* hostapp userId, will be used for the Consent Management
|
|
52
|
+
*/
|
|
53
|
+
userId?: string;
|
|
54
|
+
/**
|
|
55
|
+
* switch to sandbox mode
|
|
56
|
+
*/
|
|
57
|
+
sandboxMode?: boolean;
|
|
58
|
+
/**
|
|
59
|
+
* Each miniapp appears as a task in the Recents screen.
|
|
60
|
+
* !It works only on android devices.
|
|
61
|
+
*/
|
|
62
|
+
enableMultitaskMode?: boolean;
|
|
63
|
+
/**
|
|
64
|
+
* theme for splash screen and other native components used inside miniapp.
|
|
65
|
+
*/
|
|
66
|
+
theme?: 'light' | 'dark' | 'system';
|
|
67
|
+
/**
|
|
68
|
+
* enables webview debugging
|
|
69
|
+
*/
|
|
70
|
+
isDebug?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
* use it to hide "Settings" from Miniapp menu
|
|
73
|
+
*/
|
|
74
|
+
showPermissionsPage?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* use it to hide "Clear cache" from Miniapp menu
|
|
77
|
+
*/
|
|
78
|
+
showClearCache?: boolean;
|
|
79
|
+
}
|
|
80
|
+
export interface OpenMiniappOptions {
|
|
81
|
+
/**
|
|
82
|
+
* miniapp id
|
|
83
|
+
*/
|
|
84
|
+
appId: string;
|
|
85
|
+
/**
|
|
86
|
+
* (optional) data as Map that is sent to miniapp
|
|
87
|
+
*/
|
|
88
|
+
data?: object;
|
|
89
|
+
/**
|
|
90
|
+
* (optional) miniapp theme "dark" | "light" (by default is system theme)
|
|
91
|
+
*/
|
|
92
|
+
theme?: 'light' | 'dark' | 'system';
|
|
93
|
+
/**
|
|
94
|
+
* (optional) extra query params to append to miniapp URL (like: http://miniapp-url.com/?param=test)
|
|
95
|
+
*/
|
|
96
|
+
extraUrlParams?: object;
|
|
97
|
+
/**
|
|
98
|
+
* (optional) suffix to append to miniapp URL (like: http://miniapp-url.com/?param=test)
|
|
99
|
+
*/
|
|
100
|
+
urlSuffix?: string;
|
|
101
|
+
/**
|
|
102
|
+
* (optional) provide colors to miniapp if miniapp supports
|
|
103
|
+
*/
|
|
104
|
+
colors?: ColorOptions;
|
|
105
|
+
/**
|
|
106
|
+
* (optional) use to skip miniapp splash screen
|
|
107
|
+
*/
|
|
108
|
+
enableSplash?: boolean;
|
|
109
|
+
}
|
|
110
|
+
export interface ColorOptions {
|
|
111
|
+
primaryColor?: string;
|
|
112
|
+
secondaryColor?: string;
|
|
113
|
+
tertiaryColor?: string;
|
|
114
|
+
}
|
|
115
|
+
export interface CustomEvent {
|
|
116
|
+
appId: string;
|
|
117
|
+
requestId: number;
|
|
118
|
+
type: string;
|
|
119
|
+
errorType?: string;
|
|
120
|
+
payload?: object;
|
|
121
|
+
}
|
|
122
|
+
export interface PaymentEvent {
|
|
123
|
+
appId: string;
|
|
124
|
+
transactionToken?: string;
|
|
125
|
+
miniappOrderId?: string;
|
|
126
|
+
amount: number;
|
|
127
|
+
currency?: string;
|
|
128
|
+
status?: string;
|
|
129
|
+
hostappOrderId?: string;
|
|
130
|
+
extraParams?: object;
|
|
131
|
+
}
|
|
132
|
+
export interface LifecycleEvent {
|
|
133
|
+
appId: string;
|
|
134
|
+
/**
|
|
135
|
+
* onLaunch - Called when the miniapp will launch with Appboxo.open(...)
|
|
136
|
+
* onResume - Called when the miniapp will start interacting with the user
|
|
137
|
+
* onPause - Called when the miniapp loses foreground state
|
|
138
|
+
* onClose - Called when clicked close button in miniapp or when destroyed miniapp page
|
|
139
|
+
* onError - Called when miniapp fails to launch due to internet connection issues
|
|
140
|
+
* onUserInteraction - Called whenever touch event is dispatched to the miniapp page.
|
|
141
|
+
* onAuth - Called when the miniapp starts login and user allows it
|
|
142
|
+
*/
|
|
143
|
+
lifecycle: string;
|
|
144
|
+
error?: string;
|
|
145
|
+
}
|
|
146
|
+
export interface MiniappListResult {
|
|
147
|
+
miniapps?: [MiniappData];
|
|
148
|
+
error?: string;
|
|
149
|
+
}
|
|
150
|
+
export interface MiniappData {
|
|
151
|
+
appId: string;
|
|
152
|
+
name: string;
|
|
153
|
+
category: string;
|
|
154
|
+
description: string;
|
|
155
|
+
logo: string;
|
|
156
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface AppboxoPlugin {\n /**\n * Set global configs\n */\n setConfig(options: ConfigOptions): Promise<void>;\n /**\n * Open miniapp with options\n */\n openMiniapp(options: OpenMiniappOptions): Promise<void>;\n /**\n * get AuthCode from hostapp backend and send it to miniapp\n */\n setAuthCode(options: { appId: string; authCode: string }): Promise<void>;\n /**\n * close miniapp by appId\n */\n closeMiniapp(options: { appId: string }): Promise<void>;\n /**\n * send custom event to miniapp\n */\n sendCustomEvent(customEvent: CustomEvent): Promise<void>;\n /**\n * send payment event to miniapp\n */\n sendPaymentEvent(paymentEvent: PaymentEvent): Promise<void>;\n /**\n * Get list of miniapps\n */\n getMiniapps(): Promise<MiniappListResult>;\n /**\n * Miniapp opens on a native screen. To show payment processing page need to hide miniapp screen.\n * To use this function need to enable 'enableMultitaskMode: true' in Appboxo.setConfigs()\n */\n hideMiniapps(): Promise<void>;\n /**\n * When host app user logs out, it is highly important to clear all miniapp storage data.\n */\n logout(): Promise<void>;\n}\n\nexport interface ConfigOptions {\n /**\n * your client id from dashboard\n */\n clientId: string;\n /**\n * hostapp userId, will be used for the Consent Management\n */\n userId?: string;\n /**\n * switch to sandbox mode\n */\n sandboxMode?: boolean;\n /**\n * Each miniapp appears as a task in the Recents screen.\n * !It works only on android devices.\n */\n enableMultitaskMode?: boolean;\n /**\n * theme for splash screen and other native components used inside miniapp.\n */\n theme?: 'light' | 'dark' | 'system';\n /**\n * enables webview debugging\n */\n isDebug?: boolean;\n /**\n * use it to hide \"Settings\" from Miniapp menu\n */\n showPermissionsPage?: boolean;\n /**\n * use it to hide \"Clear cache\" from Miniapp menu\n */\n showClearCache?: boolean;\n}\n\nexport interface OpenMiniappOptions {\n /**\n * miniapp id\n */\n appId: string;\n /**\n * (optional) data as Map that is sent to miniapp\n */\n data?: object;\n /**\n * (optional) miniapp theme \"dark\" | \"light\" (by default is system theme)\n */\n theme?: 'light' | 'dark' | 'system';\n /**\n * (optional) extra query params to append to miniapp URL (like: http://miniapp-url.com/?param=test)\n */\n extraUrlParams?: object;\n /**\n * (optional) suffix to append to miniapp URL (like: http://miniapp-url.com/?param=test)\n */\n urlSuffix?: string;\n /**\n * (optional) provide colors to miniapp if miniapp supports\n */\n colors?: ColorOptions;\n /**\n * (optional) use to skip miniapp splash screen\n */\n enableSplash?: boolean;\n}\n\nexport interface ColorOptions {\n primaryColor?: string;\n secondaryColor?: string;\n tertiaryColor?: string;\n}\n\nexport interface CustomEvent {\n appId: string;\n requestId: number;\n type: string;\n errorType?: string;\n payload?: object;\n}\n\nexport interface PaymentEvent {\n appId: string;\n transactionToken?: string;\n miniappOrderId?: string;\n amount: number;\n currency?: string;\n status?: string;\n hostappOrderId?: string;\n extraParams?: object;\n}\n\nexport interface LifecycleEvent {\n appId: string;\n /**\n * onLaunch - Called when the miniapp will launch with Appboxo.open(...)\n * onResume - Called when the miniapp will start interacting with the user\n * onPause - Called when the miniapp loses foreground state\n * onClose - Called when clicked close button in miniapp or when destroyed miniapp page\n * onError - Called when miniapp fails to launch due to internet connection issues\n * onUserInteraction - Called whenever touch event is dispatched to the miniapp page.\n * onAuth - Called when the miniapp starts login and user allows it\n */\n lifecycle: string;\n error?: string;\n}\n\nexport interface MiniappListResult {\n miniapps?: [MiniappData];\n error?: string;\n}\n\nexport interface MiniappData {\n appId: string;\n name: string;\n category: string;\n description: string;\n logo: string;\n}\n"]}
|
|
@@ -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,OAAO,GAAG,cAAc,CAAgB,SAAS,CAAC,CAAC;AAEzD,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { AppboxoPlugin } from './definitions';\n\nconst Appboxo = registerPlugin<AppboxoPlugin>('Appboxo');\n\nexport * from './definitions';\nexport { Appboxo };\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Appboxo = registerPlugin('Appboxo');\nexport * from './definitions';\nexport { Appboxo };\n//# sourceMappingURL=index.js.map"],"names":["registerPlugin"],"mappings":";;;;;;AACK,MAAC,OAAO,GAAGA,mBAAc,CAAC,SAAS;;;;"}
|