capacitor-gleap-plugin 19.0.0 → 19.1.0

package/ios/Sources/GleapPlugin/GleapPlugin.swift

@@ -29,6 +29,7 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
         CAPPluginMethod(name: "setEnvDataPropsToIgnore", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "attachNetworkLogs", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "attachConsoleLogs", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "logsFlushed", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "attachCustomData", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setCustomData", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "removeCustomData", returnType: CAPPluginReturnPromise),
@@ -73,10 +74,13 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
         CAPPluginMethod(name: "setDisableInAppNotifications", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setDisableEnvData", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setColorScheme", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setCaptureEnabled", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setRemoteLogCollectionEnabled", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "startClassicForm", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "startConversation", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "openConversations", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "openConversation", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "openProtectedFileFromUrl", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setNotificationContainerOffset", returnType: CAPPluginReturnPromise)
     ]
 
@@ -90,6 +94,9 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
     private var lastLogConfig: [String: Any]?
     // Set by disableConsoleLogOverwrite: WebView console logs are no longer attached.
     private var webViewConsoleLogsDisabled = false
+    // Capture requests: log flushes the native SDK waits for (at most 500 ms) until the WebView log capture handed
+    // over what it buffers, by flush id (main queue only).
+    private var pendingLogFlushes: [String: () -> Void] = [:]
 
     @objc func initialize(_ call: CAPPluginCall) {
         // Check if key is present
@@ -111,6 +118,8 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
         // Initialize Gleap with API key
         Gleap.initialize(withToken: api_key)
         
+        registerLogFlushHandler()
+        
         // A reloaded WebView calls initialize again: hand it the config that was already loaded.
         DispatchQueue.main.async {
             if let logConfig = self.lastLogConfig {
@@ -124,6 +133,38 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
         ])
     }
     
+    // Capture requests: before the native SDK collects the logs for a request, the WebView log capture hands over
+    // what it buffers (pushed at most every 500 ms otherwise). The SDK waits at most 500 ms for done; without a
+    // flushLogs listener it does not wait.
+    private func registerLogFlushHandler() {
+        Gleap.setLogFlushHandler { [weak self] done in
+            DispatchQueue.main.async {
+                guard let self = self, self.hasListeners("flushLogs") else {
+                    done()
+                    return
+                }
+                let flushId = UUID().uuidString
+                self.pendingLogFlushes[flushId] = done
+                self.notifyListeners("flushLogs", data: ["flushId": flushId])
+                // An unanswered flush (e.g. the page reloaded) is forgotten; the SDK stopped waiting long before.
+                DispatchQueue.main.asyncAfter(deadline: .now() + 1) { [weak self] in
+                    self?.pendingLogFlushes.removeValue(forKey: flushId)
+                }
+            }
+        }
+    }
+    
+    // The WebView log capture handed over what it buffered for the flush with this id.
+    @objc func logsFlushed(_ call: CAPPluginCall) {
+        let flushId = call.getString("flushId")
+        DispatchQueue.main.async {
+            if let flushId = flushId, let done = self.pendingLogFlushes.removeValue(forKey: flushId) {
+                done()
+            }
+        }
+        call.resolve()
+    }
+    
     // Data region & host overrides. All of them must be called before initialize.
     @objc func setRegion(_ call: CAPPluginCall) {
         guard let region = call.options["region"] as? String else {
@@ -757,6 +798,34 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
         ])
     }
     
+    // Enables or disables screenshots and screen recordings for capture requests.
+    @objc func setCaptureEnabled(_ call: CAPPluginCall) {
+        guard let enabled = call.getBool("enabled") else {
+            call.reject("No enabled value provided")
+            return
+        }
+        
+        Gleap.setCaptureEnabled(enabled)
+        
+        call.resolve([
+            "captureEnabled": enabled
+        ])
+    }
+    
+    // Enables or disables sending the app's logs for capture requests.
+    @objc func setRemoteLogCollectionEnabled(_ call: CAPPluginCall) {
+        guard let enabled = call.getBool("enabled") else {
+            call.reject("No enabled value provided")
+            return
+        }
+        
+        Gleap.setRemoteLogCollectionEnabled(enabled)
+        
+        call.resolve([
+            "remoteLogCollectionEnabled": enabled
+        ])
+    }
+    
     @objc func showFeedbackButton(_ call: CAPPluginCall) {
         let showFeedbackButton = call.getBool("show") ?? false
 
@@ -1027,6 +1096,29 @@ public class GleapPlugin: CAPPlugin, CAPBridgedPlugin, GleapDelegate {
         openConversations(call)
     }
     
+    // Emailed protected file link (`gleapFile` query parameter). The SDK opens the conversation
+    // once a verified identify (user hash) gave the session file access.
+    @objc func openProtectedFileFromUrl(_ call: CAPPluginCall) {
+        guard let urlString = call.getString("url") else {
+            call.reject("No url provided")
+            return;
+        }
+        
+        // A string that is no URL carries no file reference.
+        guard let url = URL(string: urlString) else {
+            call.resolve([
+                "opened": false
+            ])
+            return;
+        }
+        
+        let opened = Gleap.openProtectedFile(from: url)
+        
+        call.resolve([
+            "opened": opened
+        ])
+    }
+    
     @objc func startFeedbackFlow(_ call: CAPPluginCall) {
         let feedbackFlow = call.getString("feedbackFlow") ?? "bugreporting"
         let showBackButton = call.getBool("showBackButton") ?? true

package/package.json

@@ -1,7 +1,7 @@
 {
   "homepage": "https://www.gleap.ai",
   "name": "capacitor-gleap-plugin",
-  "version": "19.0.0",
+  "version": "19.1.0",
   "description": "Gleap SDK for Capacitor and Ionic: AI customer support, live chat, in-app bug reporting and customer feedback.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -97,6 +97,6 @@
     }
   },
   "dependencies": {
-    "gleap": "^19.0.0"
+    "gleap": "^19.1.0"
   }
 }