Support client inputs (#238)

Author: itaihanski

README.md

@@ -9,7 +9,7 @@ written for Android. You can read more on the [Descope Website](https://descope.
 Add the following to your `build.gradle` dependencies:
 
 ```groovy
-implementation 'com.descope:descope-kotlin:0.16.1'
+implementation 'com.descope:descope-kotlin:0.17.0'
 ```
 
 ## Quickstart

descopesdk/src/main/java/com/descope/android/DescopeFlow.kt

@@ -32,6 +32,14 @@ class DescopeFlow {
      */
     var hooks: List<DescopeFlowHook> = emptyList()
 
+    /**
+     * An optional map of client inputs that will be provided to the flow.
+     * 
+     * These values can be used in the flow editor to customize the flow's behavior
+     * during execution. The values set on the map must be valid JSON types.
+     */
+    var clientInputs: Map<String, Any> = emptyMap()
+
     /**
      * An object that provides the [DescopeSession] value for the currently authenticated
      * user if there is one, or `null` otherwise.

descopesdk/src/main/java/com/descope/android/DescopeFlowCoordinator.kt

@@ -37,6 +37,7 @@ import com.descope.internal.others.debug
 import com.descope.internal.others.error
 import com.descope.internal.others.info
 import com.descope.internal.others.isUnsafeEnabled
+import com.descope.internal.others.toJsonObject
 import com.descope.internal.others.with
 import com.descope.internal.routes.convert
 import com.descope.internal.routes.getPackageOrigin
@@ -272,6 +273,7 @@ class DescopeFlowCoordinator(val webView: WebView) {
                             ssoRedirect = pickRedirectUrl(flow?.ssoRedirect, flow?.ssoRedirectCustomScheme, useCustomSchemeFallback),
                             magicLinkRedirect = flow?.magicLinkRedirect ?: "",
                             isWebAuthnSupported = isWebAuthnSupported,
+                            clientJson = flow?.clientInputs?.toJsonObject()?.toString()?.escapeForBackticks() ?: "{}"
                         )
                     ) {}
                 }
@@ -537,6 +539,7 @@ private fun setupScript(
     ssoRedirect: String,
     magicLinkRedirect: String,
     isWebAuthnSupported: Boolean,
+    clientJson: String,
 ) = """
     
 window.descopeBridge = {}
@@ -590,6 +593,18 @@ function flowBridgeSetRefreshJwt(wc, refreshJwt) {
     }
 }
 
+function flowBridgeMergeClientJson(wc, clientJson) {
+    let client = {}
+    try {
+        client = JSON.parse(wc.getAttribute('client') || '{}')
+    } catch (e) {}
+    client = {
+        ...client,
+        ...JSON.parse(clientJson),
+    }
+    wc.setAttribute('client', JSON.stringify(client))
+}
+
 function flowBridgePrepareWebComponent(wc) {
     flowBridgeSetRefreshJwt(wc, '$refreshJwt')
       
@@ -623,6 +638,9 @@ function flowBridgePrepareWebComponent(wc) {
         flow.native(JSON.stringify(e.detail), window.location.href);
     })
     
+    // add incoming client params to any already existing client parameters on the web-component
+    flowBridgeMergeClientJson(wc, '$clientJson')
+    
     // ensure we support old web-components without this function
     wc.lazyInit?.()
 }

descopesdk/src/main/java/com/descope/sdk/Sdk.kt

@@ -78,6 +78,6 @@ class DescopeSdk(context: Context, projectId: String, configure: DescopeConfig.(
         const val NAME = "DescopeAndroid"
 
         /** The Descope SDK version */
-        const val VERSION = "0.16.1"
+        const val VERSION = "0.17.0"
     }
 }