@appboxo/capacitor-boxo-sdk 0.13.0 → 0.13.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/AppboxoCapacitorBoxoSdk.podspec +1 -1
- package/README.md +13 -24
- package/android/build.gradle +1 -1
- package/android/src/main/java/io/boxo/sdk/capacitor/AppboxoPlugin.kt +0 -10
- package/dist/docs.json +0 -46
- package/dist/esm/definitions.d.ts +0 -10
- package/dist/esm/definitions.js.map +1 -1
- package/ios/Sources/AppboxoPlugin/AppboxoPlugin.swift +0 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -226,20 +226,19 @@ logout() => Promise<void>
|
|
|
226
226
|
|
|
227
227
|
#### ConfigOptions
|
|
228
228
|
|
|
229
|
-
| Prop | Type
|
|
230
|
-
| ----------------------------------- |
|
|
231
|
-
| **`clientId`** | <code>string</code>
|
|
232
|
-
| **`userId`** | <code>string</code>
|
|
233
|
-
| **`language`** | <code>string</code>
|
|
234
|
-
| **`sandboxMode`** | <code>boolean</code>
|
|
235
|
-
| **`theme`** | <code>'light' \| 'dark' \| 'system'</code>
|
|
236
|
-
| **`isDebug`** | <code>boolean</code>
|
|
237
|
-
| **`showPermissionsPage`** | <code>boolean</code>
|
|
238
|
-
| **`showClearCache`** | <code>boolean</code>
|
|
239
|
-
| **`showAboutPage`** | <code>boolean</code>
|
|
240
|
-
| **`miniappSettingsExpirationTime`** | <code>number</code>
|
|
241
|
-
| **`splashScreenOptions`** | <code><a href="#splashscreenoptions">SplashScreenOptions</a></code>
|
|
242
|
-
| **`lottieProgressOptions`** | <code><a href="#lottieprogressoptions">LottieProgressOptions</a></code> | (optional) setup lottie progress indicator configs |
|
|
229
|
+
| Prop | Type | Description |
|
|
230
|
+
| ----------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
|
231
|
+
| **`clientId`** | <code>string</code> | your client id from dashboard |
|
|
232
|
+
| **`userId`** | <code>string</code> | hostapp userId, will be used for the Consent Management |
|
|
233
|
+
| **`language`** | <code>string</code> | language value will be passed to the miniapp |
|
|
234
|
+
| **`sandboxMode`** | <code>boolean</code> | switch to sandbox mode |
|
|
235
|
+
| **`theme`** | <code>'light' \| 'dark' \| 'system'</code> | theme for splash screen and other native components used inside miniapp. |
|
|
236
|
+
| **`isDebug`** | <code>boolean</code> | enables webview debugging |
|
|
237
|
+
| **`showPermissionsPage`** | <code>boolean</code> | use it to hide "Settings" from Miniapp menu |
|
|
238
|
+
| **`showClearCache`** | <code>boolean</code> | use it to hide "Clear cache" from Miniapp menu |
|
|
239
|
+
| **`showAboutPage`** | <code>boolean</code> | use it to hide "About Page" from Miniapp menu |
|
|
240
|
+
| **`miniappSettingsExpirationTime`** | <code>number</code> | use it to change miniapp settings cache time in sec. By default is 60 sec |
|
|
241
|
+
| **`splashScreenOptions`** | <code><a href="#splashscreenoptions">SplashScreenOptions</a></code> | (optional) setup splash screen configs |
|
|
243
242
|
|
|
244
243
|
|
|
245
244
|
#### SplashScreenOptions
|
|
@@ -254,16 +253,6 @@ logout() => Promise<void>
|
|
|
254
253
|
| **`darkProgressTrack`** | <code>string</code> |
|
|
255
254
|
|
|
256
255
|
|
|
257
|
-
#### LottieProgressOptions
|
|
258
|
-
|
|
259
|
-
| Prop | Type |
|
|
260
|
-
| ------------ | ------------------- |
|
|
261
|
-
| **`light`** | <code>string</code> |
|
|
262
|
-
| **`dark`** | <code>string</code> |
|
|
263
|
-
| **`width`** | <code>number</code> |
|
|
264
|
-
| **`height`** | <code>number</code> |
|
|
265
|
-
|
|
266
|
-
|
|
267
256
|
#### OpenMiniappOptions
|
|
268
257
|
|
|
269
258
|
| Prop | Type | Description |
|
package/android/build.gradle
CHANGED
|
@@ -56,7 +56,7 @@ dependencies {
|
|
|
56
56
|
implementation fileTree(dir: 'libs', include: ['*.jar'])
|
|
57
57
|
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
|
|
58
58
|
implementation project(':capacitor-android')
|
|
59
|
-
implementation('io.boxo.sdk:boxo-android:1.41.
|
|
59
|
+
implementation('io.boxo.sdk:boxo-android:1.41.1')
|
|
60
60
|
implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
|
|
61
61
|
testImplementation "junit:junit:$junitVersion"
|
|
62
62
|
androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
|
|
@@ -52,7 +52,6 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
|
|
|
52
52
|
else -> Config.Theme.SYSTEM
|
|
53
53
|
}
|
|
54
54
|
val splashOptions = call.getObject("splashScreenOptions")
|
|
55
|
-
val lottieProgressOptions = call.getObject("lottieProgressOptions")
|
|
56
55
|
Boxo.setConfig(
|
|
57
56
|
Config.Builder()
|
|
58
57
|
.setClientId(clientId)
|
|
@@ -81,15 +80,6 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
|
|
|
81
80
|
dark = Color.parseColor(splashOptions.getString("darkBackground"))
|
|
82
81
|
)
|
|
83
82
|
}
|
|
84
|
-
|
|
85
|
-
lottieProgressOptions?.also { options ->
|
|
86
|
-
setProgressBarLottieFromAssets(
|
|
87
|
-
lightAssetPath = options.getString("light") ?: "",
|
|
88
|
-
darkAssetPath = options.getString("dark"),
|
|
89
|
-
widthDp = options.optDouble("width")?.toInt(),
|
|
90
|
-
heightDp = options.optDouble("height")?.toInt()
|
|
91
|
-
)
|
|
92
|
-
}
|
|
93
83
|
}
|
|
94
84
|
.build()
|
|
95
85
|
)
|
package/dist/docs.json
CHANGED
|
@@ -318,15 +318,6 @@
|
|
|
318
318
|
"SplashScreenOptions"
|
|
319
319
|
],
|
|
320
320
|
"type": "SplashScreenOptions"
|
|
321
|
-
},
|
|
322
|
-
{
|
|
323
|
-
"name": "lottieProgressOptions",
|
|
324
|
-
"tags": [],
|
|
325
|
-
"docs": "(optional) setup lottie progress indicator configs",
|
|
326
|
-
"complexTypes": [
|
|
327
|
-
"LottieProgressOptions"
|
|
328
|
-
],
|
|
329
|
-
"type": "LottieProgressOptions"
|
|
330
321
|
}
|
|
331
322
|
]
|
|
332
323
|
},
|
|
@@ -381,43 +372,6 @@
|
|
|
381
372
|
}
|
|
382
373
|
]
|
|
383
374
|
},
|
|
384
|
-
{
|
|
385
|
-
"name": "LottieProgressOptions",
|
|
386
|
-
"slug": "lottieprogressoptions",
|
|
387
|
-
"docs": "",
|
|
388
|
-
"tags": [],
|
|
389
|
-
"methods": [],
|
|
390
|
-
"properties": [
|
|
391
|
-
{
|
|
392
|
-
"name": "light",
|
|
393
|
-
"tags": [],
|
|
394
|
-
"docs": "",
|
|
395
|
-
"complexTypes": [],
|
|
396
|
-
"type": "string"
|
|
397
|
-
},
|
|
398
|
-
{
|
|
399
|
-
"name": "dark",
|
|
400
|
-
"tags": [],
|
|
401
|
-
"docs": "",
|
|
402
|
-
"complexTypes": [],
|
|
403
|
-
"type": "string | undefined"
|
|
404
|
-
},
|
|
405
|
-
{
|
|
406
|
-
"name": "width",
|
|
407
|
-
"tags": [],
|
|
408
|
-
"docs": "",
|
|
409
|
-
"complexTypes": [],
|
|
410
|
-
"type": "number | undefined"
|
|
411
|
-
},
|
|
412
|
-
{
|
|
413
|
-
"name": "height",
|
|
414
|
-
"tags": [],
|
|
415
|
-
"docs": "",
|
|
416
|
-
"complexTypes": [],
|
|
417
|
-
"type": "number | undefined"
|
|
418
|
-
}
|
|
419
|
-
]
|
|
420
|
-
},
|
|
421
375
|
{
|
|
422
376
|
"name": "OpenMiniappOptions",
|
|
423
377
|
"slug": "openminiappoptions",
|
|
@@ -99,10 +99,6 @@ export interface ConfigOptions {
|
|
|
99
99
|
* (optional) setup splash screen configs
|
|
100
100
|
*/
|
|
101
101
|
splashScreenOptions?: SplashScreenOptions;
|
|
102
|
-
/**
|
|
103
|
-
* (optional) setup lottie progress indicator configs
|
|
104
|
-
*/
|
|
105
|
-
lottieProgressOptions?: LottieProgressOptions;
|
|
106
102
|
}
|
|
107
103
|
export interface OpenMiniappOptions {
|
|
108
104
|
/**
|
|
@@ -150,12 +146,6 @@ export interface SplashScreenOptions {
|
|
|
150
146
|
darkProgressIndicator: string;
|
|
151
147
|
darkProgressTrack: string;
|
|
152
148
|
}
|
|
153
|
-
export interface LottieProgressOptions {
|
|
154
|
-
light: string;
|
|
155
|
-
dark?: string;
|
|
156
|
-
width?: number;
|
|
157
|
-
height?: number;
|
|
158
|
-
}
|
|
159
149
|
export interface ColorOptions {
|
|
160
150
|
primaryColor?: string;
|
|
161
151
|
secondaryColor?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport 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 * get AuthTokens from hostapp backend and send it to miniapp\n */\n setAuthTokens(options: { appId: string; tokens: { [key: string]: 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 */\n hideMiniapps(): Promise<void>;\n /**\n * When host app user logs out, it is highly important to clear all miniapp storage data.\n */\n addListener(\n eventName: 'custom_event',\n listenerFunc: (customEvent: CustomEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n addListener(\n eventName: 'payment_event',\n listenerFunc: (paymentEvent: PaymentEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n addListener(\n eventName: 'miniapp_lifecycle',\n listenerFunc: (lifecycle: LifecycleEvent) => void,\n ): Promise<PluginListenerHandle>;\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 * language value will be passed to the miniapp\n */\n language?: string;\n /**\n * switch to sandbox mode\n */\n sandboxMode?: 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 * use it to hide \"About Page\" from Miniapp menu\n */\n showAboutPage?: boolean;\n /**\n * use it to change miniapp settings cache time in sec. By default is 60 sec\n */\n miniappSettingsExpirationTime?: number;\n /**\n * (optional) setup splash screen configs\n */\n splashScreenOptions?: SplashScreenOptions;\n
|
|
1
|
+
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport 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 * get AuthTokens from hostapp backend and send it to miniapp\n */\n setAuthTokens(options: { appId: string; tokens: { [key: string]: 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 */\n hideMiniapps(): Promise<void>;\n /**\n * When host app user logs out, it is highly important to clear all miniapp storage data.\n */\n addListener(\n eventName: 'custom_event',\n listenerFunc: (customEvent: CustomEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n addListener(\n eventName: 'payment_event',\n listenerFunc: (paymentEvent: PaymentEvent) => void,\n ): Promise<PluginListenerHandle>;\n\n addListener(\n eventName: 'miniapp_lifecycle',\n listenerFunc: (lifecycle: LifecycleEvent) => void,\n ): Promise<PluginListenerHandle>;\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 * language value will be passed to the miniapp\n */\n language?: string;\n /**\n * switch to sandbox mode\n */\n sandboxMode?: 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 * use it to hide \"About Page\" from Miniapp menu\n */\n showAboutPage?: boolean;\n /**\n * use it to change miniapp settings cache time in sec. By default is 60 sec\n */\n miniappSettingsExpirationTime?: number;\n /**\n * (optional) setup splash screen configs\n */\n splashScreenOptions?: SplashScreenOptions;\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 * (optional) use to save state on close miniapp\n */\n saveState?: boolean;\n /**\n * (optional) use to change launch animation for miniapp.\n */\n pageAnimation?: 'BOTTOM_TO_TOP' | 'TOP_TO_BOTTOM' | 'LEFT_TO_RIGHT' | 'RIGHT_TO_LEFT' | 'FADE_IN';\n}\nexport interface SplashScreenOptions {\n lightBackground: string;\n darkBackground: string;\n lightProgressIndicator: string;\n lightProgressTrack: string;\n darkProgressIndicator: string;\n darkProgressTrack: string;\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 Boxo.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"]}
|
|
@@ -81,20 +81,6 @@ public class AppboxoPlugin: CAPPlugin, CAPBridgedPlugin {
|
|
|
81
81
|
}
|
|
82
82
|
}
|
|
83
83
|
|
|
84
|
-
if let lottieOptions = call.getObject("lottieProgressOptions"),
|
|
85
|
-
let lightPath = lottieOptions["light"] as? String,
|
|
86
|
-
!lightPath.isEmpty {
|
|
87
|
-
let darkPath = (lottieOptions["dark"] as? String) ?? ""
|
|
88
|
-
let width = lottieOptions.double(forKey: "width") ?? 100
|
|
89
|
-
let height = lottieOptions.double(forKey: "height") ?? 100
|
|
90
|
-
config.progressBarLottieAssets = .init(
|
|
91
|
-
lightAssetPath: lightPath,
|
|
92
|
-
darkAssetPath: darkPath,
|
|
93
|
-
width: width,
|
|
94
|
-
height: height
|
|
95
|
-
)
|
|
96
|
-
}
|
|
97
|
-
|
|
98
84
|
Boxo.shared.setConfig(config: config)
|
|
99
85
|
}
|
|
100
86
|
|
|
@@ -353,13 +339,6 @@ extension AppboxoPlugin : MiniappDelegate {
|
|
|
353
339
|
}
|
|
354
340
|
|
|
355
341
|
extension JSObject {
|
|
356
|
-
func double(forKey key: String) -> Double? {
|
|
357
|
-
if let d = self[key] as? Double { return d }
|
|
358
|
-
if let i = self[key] as? Int { return Double(i) }
|
|
359
|
-
if let n = self[key] as? NSNumber { return n.doubleValue }
|
|
360
|
-
return nil
|
|
361
|
-
}
|
|
362
|
-
|
|
363
342
|
func toMap() -> [String : Any] {
|
|
364
343
|
var dict = [String : Any]()
|
|
365
344
|
|