capacitor-gleap-plugin 7.0.0

package/ios/Plugin/GleapPlugin.m

@@ -0,0 +1,28 @@
+#import <Foundation/Foundation.h>
+#import <Capacitor/Capacitor.h>
+
+// Define the plugin using the CAP_PLUGIN Macro, and
+// each method the plugin supports using the CAP_PLUGIN_METHOD macro.
+CAP_PLUGIN(GleapPlugin, "Gleap",
+           CAP_PLUGIN_METHOD(initialize, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(identify, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(clearIdentity, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(attachCustomData, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setCustomData, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(removeCustomData, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(clearCustomData, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(logEvent, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(sendSilentCrashReport, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(open, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(close, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(isOpened, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(enableDebugConsoleLog, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(log, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(disableConsoleLogOverwrite, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(startFeedbackFlow, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setLanguage, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setEventCallback, CAPPluginReturnCallback);
+           CAP_PLUGIN_METHOD(preFillForm, CAPPluginReturnCallback);
+           CAP_PLUGIN_METHOD(addAttachment, CAPPluginReturnCallback);
+           CAP_PLUGIN_METHOD(removeAllAttachments, CAPPluginReturnCallback);
+)

package/ios/Plugin/GleapPlugin.swift

@@ -0,0 +1,380 @@
+import Foundation
+import Capacitor
+import Gleap
+
+/**
+ * Please read the Capacitor iOS Plugin Development Guide
+ * here: https://capacitorjs.com/docs/plugins/ios
+ */
+@objc(GleapPlugin)
+public class GleapPlugin: CAPPlugin, GleapDelegate {
+    enum CallType {
+        case event
+    }
+    
+    private var callQueue: [String: CallType] = [:]
+
+    @objc func initialize(_ call: CAPPluginCall) {
+        // Check if key is present
+        guard let api_key = call.options["API_KEY"] as? String else {
+            call.reject("Missing API Key")
+            return;
+        }
+        
+        // Initialize Gleap with API key
+        Gleap.initialize(withToken: api_key)
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "initialized": true
+        ])
+    }
+    
+    @objc func identify(_ call: CAPPluginCall) {
+        // If userId is empty, then pass back error
+        guard let userId = call.options["userId"] as? String else {
+            call.reject("Must provide an user ID")
+            return;
+        }
+        
+        // Map all values
+        let userProperty = GleapUserProperty()
+        if (call.getString("name") != nil) {
+            userProperty.name = call.getString("name") ?? ""
+        }
+        if (call.getString("email") != nil) {
+            userProperty.email = call.getString("email") ?? ""
+        }
+        if (call.getDouble("value") != nil) {
+            userProperty.value = (call.getDouble("value") ?? 0.0) as NSNumber
+        }
+        if (call.getString("phone") != nil) {
+            userProperty.phone = call.getString("phone") ?? ""
+        }
+        
+        if let userHash = call.getString("userHash") {
+            Gleap.identifyUser(with: userId, andData:  userProperty, andUserHash: userHash)
+        } else {
+            Gleap.identifyUser(with: userId, andData: userProperty)
+        }
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "identify": true
+        ])
+    }
+    
+    @objc func clearIdentity(_ call: CAPPluginCall) {
+        // Clear User Identity in Gleap
+        Gleap.clearIdentity()
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "clearIdentity": true
+        ])
+    }
+    
+    @objc func disableConsoleLogOverwrite(_ call: CAPPluginCall) {
+        call.resolve([
+            "consoleLogDisabled": true
+        ])
+    }
+    
+    @objc func enableDebugConsoleLog(_ call: CAPPluginCall) {
+        Gleap.enableDebugConsoleLog()
+        
+        call.resolve([
+            "debugConsoleLogEnabled": true
+        ])
+    }
+    
+    @objc func log(_ call: CAPPluginCall) {
+        guard let message = call.options["message"] as? String else {
+            call.reject("Must provide a log message")
+            return;
+        }
+        
+        var logLevel = INFO
+        switch call.getString("logLevel") ?? "INFO" {
+        case "INFO":
+            logLevel = INFO
+
+        case "WARNING":
+            logLevel = WARNING
+
+        case "ERROR":
+            logLevel = INFO
+
+        default:
+            logLevel = INFO
+        }
+        
+        Gleap.log(message, with: logLevel)
+        
+        call.resolve([
+            "logged": true
+        ])
+    }
+    
+    @objc func attachCustomData(_ call: CAPPluginCall) {
+        // If key is empty, then pass back error
+        guard let data = call.getObject("data") else {
+            call.reject("Must provide data")
+            return;
+        }
+        
+        // Set custom data
+        Gleap.attachCustomData(data)
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "addedCustomData": true
+        ])
+    }
+    
+    @objc func setCustomData(_ call: CAPPluginCall) {
+        // If key is empty, then pass back error
+        guard let key = call.options["key"] as? String else {
+            call.reject("Must provide a data key")
+            return;
+        }
+        
+        // If value is empty, then pass back error
+        guard let value = call.options["value"] as? String else {
+            call.reject("Must provide a data value")
+            return;
+        }
+        
+        // Append custom data
+        Gleap.setCustomData(value, forKey: key)
+        
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "setCustomData": true
+        ])
+    }
+    
+    @objc func removeCustomData(_ call: CAPPluginCall) {
+        // If key is empty, then pass back error
+        guard let key = call.options["key"] as? String else {
+            call.reject("Must provide a data key")
+            return;
+        }
+        
+        // Remove custom data
+        Gleap.removeCustomData(forKey: key)
+        
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "removedCustomData": true
+        ])
+    }
+    
+    @objc func clearCustomData(_ call: CAPPluginCall) {
+        // Clear custom data
+        Gleap.clearCustomData()
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "clearedCustomData": true
+        ])
+    }
+    
+    @objc func preFillForm(_ call: CAPPluginCall) {
+        // If key is empty, then pass back error
+        guard let data = call.getObject("data") else {
+            call.reject("Must provide data")
+            return;
+        }
+        
+        // Prefill the form
+        Gleap.preFillForm(data)
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "preFilledForm": true
+        ])
+    }
+    
+    @objc func logEvent(_ call: CAPPluginCall) {
+        guard let eventName = call.options["name"] as? String else {
+            call.reject("No event log subject provided")
+            return;
+        }
+        
+        if let eventData = call.getObject("data") {
+            Gleap.logEvent(eventName, withData: eventData)
+        } else {
+            Gleap.logEvent(eventName)
+        }
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "loggedEvent": true
+        ])
+    }
+    
+    @objc func addAttachment(_ call: CAPPluginCall) {
+        guard let base64data = call.options["base64data"] as? String else {
+            call.reject("No base64 file data provided")
+            return;
+        }
+        
+        guard let name = call.options["name"] as? String else {
+            call.reject("No file name provided")
+            return;
+        }
+        
+        guard let fileData = Data(base64Encoded: base64data, options: .ignoreUnknownCharacters) else {
+            call.reject("Invalid file data")
+            return;
+        }
+        
+        Gleap.addAttachment(with: fileData, andName: name)
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "attachmentAdded": true
+        ])
+    }
+    
+    @objc func removeAllAttachments(_ call: CAPPluginCall) {
+        Gleap.removeAllAttachments()
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "allAttachmentsRemoved": true
+        ])
+    }
+    
+    @objc func sendSilentCrashReport(_ call: CAPPluginCall) {
+        let dataExclusion = call.getObject("dataExclusion") ?? [:]
+        let severity = call.getString("severity") ?? "low"
+        
+        // If logEventSubject is empty, then pass back error
+        guard let description = call.options["description"] as? String else {
+            call.reject("No silent bug report description provided")
+            return;
+        }
+        
+        var severityType = MEDIUM
+        if (severity == "HIGH") {
+            severityType = HIGH
+        } else if (severity == "MEDIUM") {
+            severityType = MEDIUM
+        } else {
+            severityType = LOW
+        }
+        
+        Gleap.sendSilentCrashReport(with: description, andSeverity:  severityType, andDataExclusion:  dataExclusion) { success in
+            call.resolve([
+                "sentSilentBugReport": success
+            ])
+        }
+    }
+    
+    @objc func setEventCallback(_ call: CAPPluginCall) {
+        call.keepAlive = true
+        callQueue[call.callbackId] = .event
+
+        DispatchQueue.main.async {
+            Gleap.sharedInstance().delegate = self
+        }
+    }
+
+    @objc func open(_ call: CAPPluginCall) {
+        // Open widget
+        Gleap.open()
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "openedWidget": true
+        ])
+    }
+    
+    @objc func close(_ call: CAPPluginCall) {
+        // Open widget
+        Gleap.close()
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "closedWidget": true
+        ])
+    }
+    
+    @objc func isOpened(_ call: CAPPluginCall) {
+        // Provide feedback that it has been success
+        call.resolve([
+            "isOpened": Gleap.isOpened()
+        ])
+    }
+    
+    @objc func startFeedbackFlow(_ call: CAPPluginCall) {
+        let feedbackFlow = call.getString("feedbackFlow") ?? "bugreporting"
+        let showBackButton = call.getBool("showBackButton") ?? false
+        
+        Gleap.startFeedbackFlow(feedbackFlow, showBackButton: showBackButton)
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "startedFeedbackFlow": true
+        ])
+    }
+    
+    @objc func setLanguage(_ call: CAPPluginCall) {
+        
+        // If languageCode is empty, then pass back error
+        guard let languageCode = call.options["languageCode"] as? String else {
+            call.reject("No language provided")
+            return;
+        }
+        
+        // set language in Gleap
+        Gleap.setLanguage(languageCode)
+        
+        // Provide feedback that it has been success
+        call.resolve([
+            "setLanguage": languageCode
+        ])
+    }
+    
+    func notifyEventUpdate(name: String, data: Any?) {
+        var eventData: PluginCallResultData = [
+            "name": name
+        ];
+        if let data = data {
+            eventData["data"] = data
+        }
+        for (id, callType) in callQueue {
+            if let call = bridge?.savedCall(withID: id), callType == .event {
+                call.resolve(eventData)
+            }
+        }
+    }
+    
+    public func customActionCalled(_ customAction: String) {
+        notifyEventUpdate(name: "custom-action-called", data: nil)
+    }
+    
+    public func widgetClosed() {
+        notifyEventUpdate(name: "widget-closed", data: nil)
+    }
+    
+    public func widgetOpened() {
+        notifyEventUpdate(name: "widget-opened", data: nil)
+    }
+    
+    public func feedbackFlowStarted(_ feedbackAction: [AnyHashable : Any]) {
+        notifyEventUpdate(name: "flow-started", data: feedbackAction)
+    }
+    
+    public func feedbackSent(_ data: [AnyHashable : Any]) {
+        notifyEventUpdate(name: "feedback-sent", data: data)
+    }
+    
+    public func feedbackSendingFailed() {
+        notifyEventUpdate(name: "error-while-sending", data: nil)
+    }
+}

package/ios/Plugin/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+</dict>
+</plist>

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "capacitor-gleap-plugin",
+  "version": "7.0.0",
+  "description": "Gleap SDK for Capacitor is the easiest way to integrate Gleap into your Ionic apps! Achieve better app quality with comprehensive in-app bug reporting & customer feedback for your web-apps and websites. Many thanks to Stephan Nagel (congrapp) for his work on the Gleap capacitor plugin.",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Plugin/",
+    "CapacitorGleapPlugin.podspec"
+  ],
+  "author": "Gleap GmbH",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GleapSDK/Capacitor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/GleapSDK/Capacitor/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native",
+    "gleap",
+    "bugreporting",
+    "customerfeedback",
+    "inappbugreporting"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api GleapPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "gleap": "7.0.25"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^3.0.0",
+    "@capacitor/core": "^3.0.0",
+    "@capacitor/docgen": "^0.0.10",
+    "@capacitor/ios": "^3.0.0",
+    "@ionic/eslint-config": "^0.3.0",
+    "@ionic/prettier-config": "^1.0.1",
+    "@ionic/swiftlint-config": "^1.1.2",
+    "eslint": "^7.11.0",
+    "prettier": "~2.2.0",
+    "prettier-plugin-java": "~1.0.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.32.0",
+    "swiftlint": "^1.0.1",
+    "typescript": "~4.0.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": "^3.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}