@appboxo/capacitor-boxo-sdk 0.12.1 → 0.13.0

package/AppboxoCapacitorBoxoSdk.podspec

@@ -13,6 +13,6 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '14.0'
   s.dependency 'Capacitor'
-  s.dependency 'BoxoSDK', '1.25.0'
+  s.dependency 'BoxoSDK', '1.27.4'
   s.swift_version = '5.1'
 end

package/README.md

@@ -226,19 +226,20 @@ logout() => Promise<void>
 
 #### ConfigOptions
 
-| Prop                                | Type                                                                | Description                                                               |
-| ----------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
-| **`clientId`**                      | <code>string</code>                                                 | your client id from dashboard                                             |
-| **`userId`**                        | <code>string</code>                                                 | hostapp userId, will be used for the Consent Management                   |
-| **`language`**                      | <code>string</code>                                                 | language value will be passed to the miniapp                              |
-| **`sandboxMode`**                   | <code>boolean</code>                                                | switch to sandbox mode                                                    |
-| **`theme`**                         | <code>'light' \| 'dark' \| 'system'</code>                          | theme for splash screen and other native components used inside miniapp.  |
-| **`isDebug`**                       | <code>boolean</code>                                                | enables webview debugging                                                 |
-| **`showPermissionsPage`**           | <code>boolean</code>                                                | use it to hide "Settings" from Miniapp menu                               |
-| **`showClearCache`**                | <code>boolean</code>                                                | use it to hide "Clear cache" from Miniapp menu                            |
-| **`showAboutPage`**                 | <code>boolean</code>                                                | use it to hide "About Page" from Miniapp menu                             |
-| **`miniappSettingsExpirationTime`** | <code>number</code>                                                 | use it to change miniapp settings cache time in sec. By default is 60 sec |
-| **`splashScreenOptions`**           | <code><a href="#splashscreenoptions">SplashScreenOptions</a></code> | (optional) setup splash screen configs                                    |
+| Prop                                | Type                                                                    | Description                                                               |
+| ----------------------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| **`clientId`**                      | <code>string</code>                                                     | your client id from dashboard                                             |
+| **`userId`**                        | <code>string</code>                                                     | hostapp userId, will be used for the Consent Management                   |
+| **`language`**                      | <code>string</code>                                                     | language value will be passed to the miniapp                              |
+| **`sandboxMode`**                   | <code>boolean</code>                                                    | switch to sandbox mode                                                    |
+| **`theme`**                         | <code>'light' \| 'dark' \| 'system'</code>                              | theme for splash screen and other native components used inside miniapp.  |
+| **`isDebug`**                       | <code>boolean</code>                                                    | enables webview debugging                                                 |
+| **`showPermissionsPage`**           | <code>boolean</code>                                                    | use it to hide "Settings" from Miniapp menu                               |
+| **`showClearCache`**                | <code>boolean</code>                                                    | use it to hide "Clear cache" from Miniapp menu                            |
+| **`showAboutPage`**                 | <code>boolean</code>                                                    | use it to hide "About Page" from Miniapp menu                             |
+| **`miniappSettingsExpirationTime`** | <code>number</code>                                                     | use it to change miniapp settings cache time in sec. By default is 60 sec |
+| **`splashScreenOptions`**           | <code><a href="#splashscreenoptions">SplashScreenOptions</a></code>     | (optional) setup splash screen configs                                    |
+| **`lottieProgressOptions`**         | <code><a href="#lottieprogressoptions">LottieProgressOptions</a></code> | (optional) setup lottie progress indicator configs                        |
 
 
 #### SplashScreenOptions
@@ -253,6 +254,16 @@ logout() => Promise<void>
 | **`darkProgressTrack`**      | <code>string</code> |
 
 
+#### LottieProgressOptions
+
+| Prop         | Type                |
+| ------------ | ------------------- |
+| **`light`**  | <code>string</code> |
+| **`dark`**   | <code>string</code> |
+| **`width`**  | <code>number</code> |
+| **`height`** | <code>number</code> |
+
+
 #### OpenMiniappOptions
 
 | Prop                 | Type                                                                                               | Description                                                                                       |

package/android/build.gradle

@@ -56,7 +56,7 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
     implementation project(':capacitor-android')
-    implementation('io.boxo.sdk:boxo-android:1.40.4')
+    implementation('io.boxo.sdk:boxo-android:1.41.0')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"

package/android/src/main/java/io/boxo/sdk/capacitor/AppboxoPlugin.kt

@@ -52,6 +52,7 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
             else -> Config.Theme.SYSTEM
         }
         val splashOptions = call.getObject("splashScreenOptions")
+        val lottieProgressOptions = call.getObject("lottieProgressOptions")
         Boxo.setConfig(
             Config.Builder()
                 .setClientId(clientId)
@@ -80,6 +81,15 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
                             dark = Color.parseColor(splashOptions.getString("darkBackground"))
                         )
                     }
+
+                    lottieProgressOptions?.also { options ->
+                        setProgressBarLottieFromAssets(
+                            lightAssetPath = options.getString("light") ?: "",
+                            darkAssetPath = options.getString("dark"),
+                            widthDp = options.optDouble("width")?.toInt(),
+                            heightDp = options.optDouble("height")?.toInt()
+                        )
+                    }
                 }
                 .build()
         )

package/dist/docs.json

@@ -318,6 +318,15 @@
             "SplashScreenOptions"
           ],
           "type": "SplashScreenOptions"
+        },
+        {
+          "name": "lottieProgressOptions",
+          "tags": [],
+          "docs": "(optional) setup lottie progress indicator configs",
+          "complexTypes": [
+            "LottieProgressOptions"
+          ],
+          "type": "LottieProgressOptions"
         }
       ]
     },
@@ -372,6 +381,43 @@
         }
       ]
     },
+    {
+      "name": "LottieProgressOptions",
+      "slug": "lottieprogressoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "light",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "dark",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "width",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "height",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
     {
       "name": "OpenMiniappOptions",
       "slug": "openminiappoptions",

package/dist/esm/definitions.d.ts

@@ -99,6 +99,10 @@ export interface ConfigOptions {
     * (optional) setup splash screen configs
     */
     splashScreenOptions?: SplashScreenOptions;
+    /**
+    * (optional) setup lottie progress indicator configs
+    */
+    lottieProgressOptions?: LottieProgressOptions;
 }
 export interface OpenMiniappOptions {
     /**
@@ -146,6 +150,12 @@ export interface SplashScreenOptions {
     darkProgressIndicator: string;
     darkProgressTrack: string;
 }
+export interface LottieProgressOptions {
+    light: string;
+    dark?: string;
+    width?: number;
+    height?: number;
+}
 export interface ColorOptions {
     primaryColor?: string;
     secondaryColor?: string;

package/dist/esm/definitions.js.map

@@ -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}\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"]}
+{"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  * (optional) setup lottie progress indicator configs\n  */\n  lottieProgressOptions?: LottieProgressOptions;\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}\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 LottieProgressOptions {\n  light: string;\n  dark?: string;\n  width?: number;\n  height?: number;\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"]}

package/ios/Sources/AppboxoPlugin/AppboxoPlugin.swift

@@ -81,6 +81,20 @@ public class AppboxoPlugin: CAPPlugin, CAPBridgedPlugin {
             }
         }
 
+        if let lottieOptions = call.getObject("lottieProgressOptions"),
+           let lightPath = lottieOptions["light"] as? String,
+           !lightPath.isEmpty {
+            let darkPath = (lottieOptions["dark"] as? String) ?? ""
+            let width = lottieOptions.double(forKey: "width") ?? 100
+            let height = lottieOptions.double(forKey: "height") ?? 100
+            config.progressBarLottieAssets = .init(
+                lightAssetPath: lightPath,
+                darkAssetPath: darkPath,
+                width: width,
+                height: height
+            )
+        }
+
         Boxo.shared.setConfig(config: config)
     }
 
@@ -339,6 +353,13 @@ extension AppboxoPlugin : MiniappDelegate {
 }
 
 extension JSObject {
+    func double(forKey key: String) -> Double? {
+        if let d = self[key] as? Double { return d }
+        if let i = self[key] as? Int { return Double(i) }
+        if let n = self[key] as? NSNumber { return n.doubleValue }
+        return nil
+    }
+
     func toMap() -> [String : Any] {
         var dict = [String : Any]()
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appboxo/capacitor-boxo-sdk",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "A capacitor wrapper over Appboxo SDK for IOS and Android.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",