@appboxo/capacitor-boxo-sdk 0.1.5 → 0.1.6

package/CapacitorBoxoSdk.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  = '13.0'
   s.dependency 'Capacitor'
-  s.dependency 'AppBoxoSDK', '1.5.14'
+  s.dependency 'AppBoxoSDK', '1.5.16'
   s.swift_version = '5.1'
 end

package/README.md

@@ -222,6 +222,7 @@ logout() => Promise<void>
 | **`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                                            |
 
 
 #### OpenMiniappOptions

package/android/build.gradle

@@ -73,7 +73,7 @@ dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
     implementation project(':capacitor-android')
-    implementation('com.appboxo:sdk:1.5.19') {
+    implementation('com.appboxo:sdk:1.6.0') {
         exclude group: 'com.google.android.gms', module: 'play-services-location'
     }
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"

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

@@ -42,6 +42,7 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
         val isDebug = call.getBoolean("isDebug", false)!!
         val showPermissionsPage = call.getBoolean("showPermissionsPage", true)!!
         val showClearCache = call.getBoolean("showClearCache", true)!!
+        val showAboutPage = call.getBoolean("showAboutPage", true)!!
         val globalTheme: Config.Theme = when (theme) {
             "light" -> Config.Theme.LIGHT
             "dark" -> Config.Theme.DARK
@@ -58,6 +59,7 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
                     .setLanguage(language)
                     .permissionsPage(showPermissionsPage)
                     .showClearCache(showClearCache)
+                    .showAboutPage(showAboutPage)
                     .debug(isDebug)
                     .build()
             )
@@ -73,43 +75,45 @@ class AppboxoPlugin : Plugin(), Miniapp.LifecycleListener,
         val colors = call.getObject("colors")
         val enableSplash = call.getBoolean("enableSplash")
         val saveState = call.getBoolean("saveState") ?: true
-        val miniapp: Miniapp = Appboxo.getMiniapp(appId)
-            .setCustomEventListener(this)
-            .setPaymentEventListener(this)
-            .setAuthListener(this)
-            .setLifecycleListener(this)
-        if (data != null) miniapp.setData(data.toMap())
-        val configBuilder = MiniappConfig.Builder()
-        if (theme != null) {
-            val miniappTheme: Config.Theme? = when (theme) {
-                "light" -> Config.Theme.LIGHT
-                "dark" -> Config.Theme.DARK
-                "system" -> Config.Theme.SYSTEM
-                else -> null
+        handler?.post {
+            val miniapp: Miniapp = Appboxo.getMiniapp(appId)
+                .setCustomEventListener(this)
+                .setPaymentEventListener(this)
+                .setAuthListener(this)
+                .setLifecycleListener(this)
+            if (data != null) miniapp.setData(data.toMap())
+            val configBuilder = MiniappConfig.Builder()
+            if (theme != null) {
+                val miniappTheme: Config.Theme? = when (theme) {
+                    "light" -> Config.Theme.LIGHT
+                    "dark" -> Config.Theme.DARK
+                    "system" -> Config.Theme.SYSTEM
+                    else -> null
+                }
+                if (miniappTheme != null) {
+                    configBuilder.setTheme(miniappTheme)
+                }
             }
-            if (miniappTheme != null) {
-                configBuilder.setTheme(miniappTheme)
+            if (extraUrlParams != null) {
+                val map: Map<String, Any> = extraUrlParams.toMap()
+                val stringMap: MutableMap<String, String> = HashMap()
+                for ((key, value) in map) stringMap[key] = value.toString()
+                configBuilder.setExtraUrlParams(stringMap)
             }
+            urlSuffix?.also { suffix -> configBuilder.setUrlSuffix(suffix) }
+            if (colors != null) {
+                configBuilder.setColors(
+                    colors.getString("primaryColor") ?: "",
+                    colors.getString("secondaryColor") ?: "",
+                    colors.getString("tertiaryColor") ?: "",
+                )
+            }
+            if (enableSplash != null)
+                configBuilder.enableSplash(enableSplash)
+            configBuilder.saveState(saveState)
+            miniapp.setConfig(configBuilder.build())
+            miniapp.open(bridge.activity)
         }
-        if (extraUrlParams != null) {
-            val map: Map<String, Any> = extraUrlParams.toMap()
-            val stringMap: MutableMap<String, String> = HashMap()
-            for ((key, value) in map) stringMap[key] = value.toString()
-            configBuilder.setExtraUrlParams(stringMap)
-        }
-        urlSuffix?.also { suffix -> configBuilder.setUrlSuffix(suffix) }
-        if (colors != null) {
-            configBuilder.setColors(
-                colors.getString("primaryColor") ?: "",
-                colors.getString("secondaryColor") ?: "",
-                colors.getString("tertiaryColor") ?: "",
-            )
-        }
-        if (enableSplash != null)
-            configBuilder.enableSplash(enableSplash)
-        configBuilder.saveState(saveState)
-        miniapp.setConfig(configBuilder.build())
-        miniapp.open(bridge.activity)
     }
 
     @PluginMethod

package/dist/docs.json

@@ -286,6 +286,13 @@
           "docs": "use it to hide \"Clear cache\" from Miniapp menu",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "showAboutPage",
+          "tags": [],
+          "docs": "use it to hide \"About Page\" from Miniapp menu",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -84,6 +84,10 @@ export interface ConfigOptions {
      * use it to hide "Clear cache" from Miniapp menu
      */
     showClearCache?: boolean;
+    /**
+     * use it to hide "About Page" from Miniapp menu
+     */
+    showAboutPage?: boolean;
 }
 export interface OpenMiniappOptions {
     /**

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   * 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  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   * 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   * (optional) use to save state on close miniapp\n   */\n  saveState?: 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"]}
+{"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   * 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  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   * 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   * use it to hide \"About Page\" from Miniapp menu\n   */\n  showAboutPage?: 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   * (optional) use to save state on close miniapp\n   */\n  saveState?: 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"]}

package/ios/Sources/AppboxoPlugin/AppboxoPlugin.swift

@@ -34,6 +34,7 @@ public class AppboxoPlugin: CAPPlugin, CAPBridgedPlugin {
         let theme = call.getString("theme", "system")
         let showPermissionsPage = call.getBool("showPermissionsPage", true)
         let showClearCache = call.getBool("showClearCache", true)
+        let showAboutPage = call.getBool("showAboutPage", true)
         var globalTheme : Theme = .System
         switch (theme) {
         case "dark":
@@ -49,6 +50,7 @@ public class AppboxoPlugin: CAPPlugin, CAPBridgedPlugin {
         config.sandboxMode = sandboxMode
         config.permissionsPage = showPermissionsPage
         config.showClearCache = showClearCache
+        config.showAboutPage = showAboutPage
         config.setUserId(id: userId)
 
         Appboxo.shared.setConfig(config: config)
@@ -62,6 +64,7 @@ public class AppboxoPlugin: CAPPlugin, CAPBridgedPlugin {
         let colors = call.getObject("colors")?.toMap() ?? nil
         let enableSplash = call.getBool("enableSplash")
         let saveState = call.getBool("saveState", true)
+        let urlSuffix = call.getString("urlSuffix", "")
 
         let miniApp = Appboxo.shared.getMiniapp(appId: appId)
         miniApp.setData(data: data)
@@ -69,6 +72,7 @@ public class AppboxoPlugin: CAPPlugin, CAPBridgedPlugin {
 
         let miniappConfig = MiniappConfig()
         miniappConfig.saveState = saveState
+        miniappConfig.urlSuffix = urlSuffix
 
         if let enableSplash = enableSplash {
             miniappConfig.enableSplash(isSplashEnabled: enableSplash)

package/package.json

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