@capacitor/background-runner 1.0.0-rc.1

package/ios/Plugin/RunnerEngine/JSConsole.swift

@@ -0,0 +1,38 @@
+import Foundation
+import JavaScriptCore
+
+@objc protocol JSConsoleExports: JSExport {
+    func log (_ msg: String)
+    func info(_ msg: String)
+    func warn(_ msg: String)
+    func error(_ msg: String)
+    func debug(_ msg: String)
+}
+
+class JSConsole: NSObject, JSConsoleExports {
+    let contextName: String
+
+    init(name: String) {
+        contextName = name
+    }
+
+    func log(_ msg: String) {
+        print("[\(contextName)] [LOG] \(msg)")
+    }
+
+    func info(_ msg: String) {
+        print("[\(contextName)] [INFO] \(msg)")
+    }
+
+    func warn(_ msg: String) {
+        print("[\(contextName)] [WARN] \(msg)")
+    }
+
+    func error(_ msg: String) {
+        print("[\(contextName)] [ERR] \(msg)")
+    }
+
+    func debug(_ msg: String) {
+        debugPrint("[\(contextName)] [DEBUG] \(msg)")
+    }
+}

package/ios/Plugin/RunnerEngine/JSCrypto.swift

@@ -0,0 +1,38 @@
+import Foundation
+import JavaScriptCore
+
+@objc protocol JSCryptoExports: JSExport {
+    static func getRandomValues(_ arr: JSValue) -> JSValue
+    static func randomUUID() -> String
+}
+
+class JSCrypto: NSObject, JSCryptoExports {
+    static func getRandomValues(_ arr: JSValue) -> JSValue {
+        let size = arr.toArray().count
+
+        var rnd = [UInt8](repeating: 0, count: size)
+        _ = SecRandomCopyBytes(kSecRandomDefault, size, &rnd)
+
+        if arr.toArray() as? [UInt8] != nil {
+            for i in 0...(size - 1) {
+                arr.setObject(rnd[i], atIndexedSubscript: i)
+            }
+        }
+        if arr.toArray() as? [UInt16] != nil {
+            for i in 0...(size - 1) {
+                arr.setObject(UInt16(rnd[i]), atIndexedSubscript: i)
+            }
+        }
+        if arr.toArray() as? [UInt32] != nil {
+            for i in 0...(size - 1) {
+                arr.setObject(UInt32(rnd[i]), forKeyedSubscript: i)
+            }
+        }
+
+        return arr
+    }
+
+    static func randomUUID() -> String {
+        return UUID().uuidString
+    }
+}

package/ios/Plugin/RunnerEngine/JSError.swift

@@ -0,0 +1,33 @@
+import Foundation
+import JavaScriptCore
+
+// This is needed to do a problem with JavaScriptCore
+// JSValue(newErrorFromMessage:in:) always returns a nil object
+//
+// https://github.com/mihaibabusca/jscore-behaviour-mismatch
+
+@objc protocol JSErrorExports: JSExport {
+    var cause: Any? { get set }
+    var message: String { get set }
+
+    func toString() -> String
+}
+
+@objc public class JSError: NSObject, JSErrorExports {
+    dynamic var cause: Any?
+    dynamic var message: String
+
+    override public init() {
+        message = ""
+        cause = nil
+    }
+
+    public init(message: String) {
+        self.message = message
+        self.cause = nil
+    }
+
+    func toString() -> String {
+        return message
+    }
+}

package/ios/Plugin/RunnerEngine/JSFetch.swift

@@ -0,0 +1,50 @@
+import JavaScriptCore
+
+func fetch(resource: JSValue, options: JSValue) -> JSValue {
+    let session = URLSession.shared
+
+    var url: URL?
+
+    if resource.isString {
+        url = URL(string: resource.toString())
+    }
+
+    guard let url = url else {
+        return JSValue.init(newErrorFromMessage: "invalid url", in: JSContext.current())
+    }
+
+    var request = URLRequest(url: url)
+
+    if options.isObject, let optionsDict = options.toDictionary() as? [String: Any] {
+        request.httpMethod = (optionsDict["method"] as? String)?.uppercased()
+        request.allHTTPHeaderFields = optionsDict["headers"] as? [String: String]
+
+        if let bodyString = optionsDict["body"] as? String {
+            request.httpBody = bodyString.data(using: .utf8)
+        }
+    }
+
+    return JSValue(newPromiseIn: JSContext.current()) { resolve, reject in
+        let task = session.dataTask(with: request) { data, response, err in
+            if let err = err {
+                print("fetch failed: \(err.localizedDescription)")
+                let jsErr = JSError(message: err.localizedDescription)
+                reject?.call(withArguments: [jsErr as Any])
+                return
+            }
+
+            guard let httpResponse = response as? HTTPURLResponse else {
+                print("HTTPURLResponse was nil")
+                let jsErr = JSError(message: "native response was nil")
+                reject?.call(withArguments: [jsErr as Any])
+                return
+            }
+
+            let res = JSResponse(from: httpResponse, responseData: data)
+            resolve?.call(withArguments: [res])
+            return
+        }
+
+        task.resume()
+    }
+}

package/ios/Plugin/RunnerEngine/JSResponse.swift

@@ -0,0 +1,69 @@
+import JavaScriptCore
+
+@objc protocol JSResponseExports: JSExport {
+    // swiftlint:disable:next identifier_name
+    var ok: Bool { get }
+    var status: Int { get }
+    var url: String { get }
+
+    func text() -> JSValue
+    func json() -> JSValue
+}
+
+@objc public class JSResponse: NSObject, JSResponseExports {
+    dynamic var url: String
+    dynamic var status: Int
+    // swiftlint:disable:next identifier_name
+    dynamic var ok: Bool {
+        return status > 200 && status <= 299
+    }
+
+    private let data: Data?
+
+    public init(status: Int, responseData: Data?) {
+        self.status = status
+        self.data = responseData
+        self.url = ""
+    }
+
+    public init(from httpResponse: HTTPURLResponse, responseData: Data?) {
+        self.data = responseData
+        self.status = httpResponse.statusCode
+        self.url = httpResponse.url?.absoluteString ?? ""
+    }
+
+    func text() -> JSValue {
+        return JSValue(newPromiseIn: JSContext.current()) { resolve, _ in
+            guard let data = self.data else {
+                resolve?.call(withArguments: [""])
+                return
+            }
+
+            if let str = String(bytes: data, encoding: .utf8) {
+                resolve?.call(withArguments: [str])
+                return
+            }
+
+            resolve?.call(withArguments: [""])
+        }
+    }
+
+    func json() -> JSValue {
+        return JSValue(newPromiseIn: JSContext.current()) { resolve, reject in
+            do {
+                guard let data = self.data else {
+                    resolve?.call(withArguments: [JSValue(nullIn: JSContext.current()) as Any])
+                    return
+                }
+
+                let anyObj = try JSONSerialization.jsonObject(with: data)
+                let jsonObj = JSValue(object: anyObj, in: JSContext.current())
+                resolve?.call(withArguments: [jsonObj as Any])
+
+            } catch {
+                let err = JSError(message: error.localizedDescription)
+                reject?.call(withArguments: [err as Any])
+            }
+        }
+    }
+}

package/ios/Plugin/RunnerEngine/JSTextDecoder.swift

@@ -0,0 +1,60 @@
+import JavaScriptCore
+
+@objc protocol JSTextDecoderExports: JSExport {
+    var encoding: String { get }
+    func decode(_ buffer: JSValue) -> String?
+}
+
+class JSTextDecoder: NSObject, JSTextDecoderExports {
+    dynamic var encoding: String = "utf-8"
+
+    required init(encoding: String?, options: [AnyHashable: Any]?) {
+        if let enc = encoding {
+            self.encoding = enc
+        }
+    }
+
+    func decode(_ buffer: JSValue) -> String? {
+        let useEncoding = setEncoding(enc: encoding)
+
+        if let arr = buffer.toArray() as? [UInt8] {
+            return String(bytes: arr, encoding: useEncoding)
+        }
+
+        if let arr = buffer.toArray() as? [Int8] {
+            let data = Data(bytes: arr, count: arr.count)
+            return String(data: data, encoding: useEncoding)
+        }
+
+        return nil
+    }
+
+    func setEncoding(enc: String) -> String.Encoding {
+        switch enc {
+        case "windows-1250":
+            return .windowsCP1250
+        case "windows-1251":
+            return .windowsCP1251
+        case "windows-1252":
+            return .windowsCP1252
+        case "windows-1253":
+            return .windowsCP1253
+        case "windows-1254":
+            return .windowsCP1254
+        case "iso-2022-jp":
+            return .iso2022JP
+        case "euc-jp":
+            return .japaneseEUC
+        case "macintosh":
+            return .macOSRoman
+        case "iso-8859-2":
+            return .isoLatin2
+        case "utf-16be":
+            return .utf16BigEndian
+        case "utf-16le":
+            return .utf16LittleEndian
+        default:
+            return .utf8
+        }
+    }
+}

package/ios/Plugin/RunnerEngine/JSTextEncoder.swift

@@ -0,0 +1,12 @@
+import JavaScriptCore
+
+@objc protocol JSTextEncoderExports: JSExport {
+    func encode(_ str: String) -> [UInt8]
+    //    func encodeInto(_ str: String, _ arr: JSValue) -> [AnyHashable: Any]
+}
+
+class JSTextEncoder: NSObject, JSTextEncoderExports {
+    func encode(_ str: String) -> [UInt8] {
+        return Array(str.utf8)
+    }
+}

package/ios/Plugin/RunnerEngine/Runner.swift

@@ -0,0 +1,23 @@
+import Foundation
+import JavaScriptCore
+
+public class Runner {
+    var machine: JSVirtualMachine
+    var contexts: [String: Context]
+    public init() {
+        machine = JSVirtualMachine()
+        contexts = [:]
+    }
+
+    func createContext(name: String) throws -> Context {
+        let ctx = try Context(vm: machine, ctxName: name)
+
+        contexts[name] = ctx
+
+        return ctx
+    }
+
+    func destroyContext(name: String) {
+        contexts.removeValue(forKey: name)
+    }
+}

package/ios/Plugin/WatchConnectivtySessionDelegate.swift

@@ -0,0 +1,34 @@
+import Foundation
+import WatchConnectivity
+
+extension BackgroundRunnerPlugin: WCSessionDelegate {
+    public func session(_ session: WCSession, activationDidCompleteWith activationState: WCSessionActivationState, error: Error?) {
+        var args: [String: Any] = [:]
+        args["activationState"] = activationState.rawValue
+        args["error"] = error
+
+        try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_activationDidCompleteWith", inputArgs: args)
+    }
+
+    public func sessionDidBecomeInactive(_ session: WCSession) {
+        try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_sessionDidBecomeInactive", inputArgs: nil)
+    }
+
+    public func sessionDidDeactivate(_ session: WCSession) {
+        try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_sessionDidDeactivate", inputArgs: nil)
+    }
+
+    public func session(_ session: WCSession, didReceiveUserInfo userInfo: [String: Any] = [:]) {
+        var args: [String: Any] = [:]
+        args["userInfo"] = userInfo
+
+        try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_didReceiveUserInfo", inputArgs: args)
+    }
+
+    public func session(_ session: WCSession, didReceiveMessage message: [String: Any]) {
+        var args: [String: Any] = [:]
+        args["message"] = message
+
+        try? BackgroundRunner.shared.dispatchEvent(event: "WatchConnectivity_didReceiveMessage", inputArgs: args)
+    }
+}

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@capacitor/background-runner",
+  "version": "1.0.0-rc.1",
+  "description": "Capacitor Background Runner",
+  "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/",
+    "CapacitorBackgroundRunner.podspec"
+  ],
+  "author": "Ionic Team",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ionic-team/capacitor-background-runner.git"
+  },
+  "bugs": {
+    "url": "https://ionic.io/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "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 -destination generic/platform=iOS && 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 BackgroundRunnerPlugin --output-readme README.md --output-json dist/docs.json",
+    "build-sdk": "./scripts/build-native-sdks.sh",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js && npm run build-sdk && ./scripts/copy-native-sdks.sh && npm pack && mv ./capacitor-background-runner-*.tgz ../../",
+    "pack": "npm run build && && ./scripts/copy-native-sdks.sh && npm pack && mv ./capacitor-background-runner-*.tgz ../../",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "postinstall": "mkdir -p $INIT_CWD/android/app/libs/ && cp -f android/src/main/libs/android-js-engine-release.aar $INIT_CWD/android/app/libs/"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^5.2.1",
+    "@capacitor/cli": "^5.2.1",
+    "@capacitor/core": "^5.2.1",
+    "@capacitor/docgen": "^0.0.18",
+    "@capacitor/ios": "^5.2.1",
+    "@ionic/eslint-config": "^0.3.0",
+    "@ionic/prettier-config": "^1.0.1",
+    "@ionic/swiftlint-config": "^1.1.2",
+    "eslint": "^7.11.0",
+    "prettier": "~2.3.0",
+    "prettier-plugin-java": "~2.1.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.32.0",
+    "swiftlint": "^1.0.2",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "@capacitor/core": "^5.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}