@capgo/capacitor-updater 3.0.3

package/ios/Plugin/CapacitorUpdaterPlugin.swift

@@ -0,0 +1,307 @@
+import Foundation
+import Capacitor
+import Version
+
+/**
+ * Please read the Capacitor iOS Plugin Development Guide
+ * here: https://capacitorjs.com/docs/plugins/ios
+ */
+@objc(CapacitorUpdaterPlugin)
+public class CapacitorUpdaterPlugin: CAPPlugin {
+    private var implementation = CapacitorUpdater()
+    static let autoUpdateUrlDefault = "https://capgo.app/api/auto_update"
+    static let statsUrlDefault = "https://capgo.app/api/stats"
+    private var autoUpdateUrl = ""
+    private var currentVersionNative: Version = "0.0.0"
+    private var autoUpdate = false
+    private var statsUrl = ""
+    private var resetWhenUpdate = true;
+    
+    override public func load() {
+        do {
+            currentVersionNative = try Version(Bundle.main.buildVersionNumber ?? "0.0.0")
+        } catch {
+            print("✨  Capacitor-updater: Cannot get version native \(currentVersionNative)")
+        }
+        autoUpdateUrl = getConfigValue("autoUpdateUrl") as? String ?? CapacitorUpdaterPlugin.autoUpdateUrlDefault
+        autoUpdate = getConfigValue("autoUpdate") as? Bool ?? false
+        implementation.appId = Bundle.main.bundleIdentifier ?? ""
+        implementation.notifyDownload = notifyDownload
+        let config = (self.bridge?.viewController as? CAPBridgeViewController)?.instanceDescriptor().legacyConfig
+        if (config?["appId"] != nil) {
+            implementation.appId = config?["appId"] as! String
+        }
+        implementation.statsUrl = getConfigValue("statsUrl") as? String ?? CapacitorUpdaterPlugin.statsUrlDefault
+        if (resetWhenUpdate) {
+            var LatestVersionNative: Version = "0.0.0"
+            do {
+                LatestVersionNative = try Version(UserDefaults.standard.string(forKey: "LatestVersionNative") ?? "0.0.0")
+            } catch {
+                print("✨  Capacitor-updater: Cannot get version native \(currentVersionNative)")
+            }
+            if (LatestVersionNative != "0.0.0" && currentVersionNative.major > LatestVersionNative.major) {
+                _ = self._reset(toAutoUpdate: false)
+                UserDefaults.standard.set("", forKey: "LatestVersionAutoUpdate")
+                UserDefaults.standard.set("", forKey: "LatestVersionNameAutoUpdate")
+                let res = implementation.list()
+                res.forEach { version in
+                    _ = implementation.delete(version: version, versionName: "")
+                }
+            }
+            UserDefaults.standard.set( Bundle.main.buildVersionNumber, forKey: "LatestVersionNative")
+        }
+        if (!autoUpdate || autoUpdateUrl == "") { return }
+        resetWhenUpdate = getConfigValue("resetWhenUpdate") as? Bool ?? true
+        let nc = NotificationCenter.default
+        nc.addObserver(self, selector: #selector(appMovedToBackground), name: UIApplication.didEnterBackgroundNotification, object: nil)
+        nc.addObserver(self, selector: #selector(appMovedToForeground), name: UIApplication.willEnterForegroundNotification, object: nil)
+        self.appMovedToForeground()
+    }
+    
+    @objc func notifyDownload(percent: Int) {
+        self.notifyListeners("download", data: ["percent": percent])
+    }
+
+    @objc func getId(_ call: CAPPluginCall) {
+        call.resolve(["id": implementation.deviceID])
+    }
+    
+    @objc func download(_ call: CAPPluginCall) {
+        let url = URL(string: call.getString("url") ?? "")
+        let res = implementation.download(url: url!)
+        if ((res) != nil) {
+            call.resolve([
+                "version": res!
+            ])
+        } else {
+            call.reject("download failed")
+        }
+    }
+
+    private func _reload() -> Bool {
+        guard let bridge = self.bridge else { return false }
+
+        if let vc = bridge.viewController as? CAPBridgeViewController {
+            let pathHot = implementation.getLastPathHot()
+            let pathPersist = implementation.getLastPathPersist()
+            if (pathHot != "" && pathPersist != "") {
+                UserDefaults.standard.set(String(pathPersist.suffix(10)), forKey: "serverBasePath")
+                vc.setServerBasePath(path: pathHot)
+                print("✨  Capacitor-updater: Reload app done")
+                return true
+            } else {
+                return false
+            }
+        }
+        return false
+    }
+    
+    @objc func reload(_ call: CAPPluginCall) {
+        if (self._reload()) {
+            call.resolve()
+        } else {
+            call.reject("Cannot reload")
+        }
+    }
+    
+    @objc func set(_ call: CAPPluginCall) {
+        let version = call.getString("version") ?? ""
+        let versionName = call.getString("versionName") ?? version
+        let res = implementation.set(version: version, versionName: versionName)
+        
+        if (res && self._reload()) {
+            print("✨  Capacitor-updater: Set to version: \(version) versionName: \(versionName)")
+            call.resolve()
+        } else {
+            call.reject("Update failed, version \(version) doesn't exist")
+        }
+    }
+
+    @objc func delete(_ call: CAPPluginCall) {
+        let version = call.getString("version") ?? ""
+        let res = implementation.delete(version: version, versionName: "")
+        if (res) {
+            call.resolve()
+        } else {
+            call.reject("Delete failed, version \(version) doesn't exist")
+        }
+    }
+
+    @objc func list(_ call: CAPPluginCall) {
+        let res = implementation.list()
+        call.resolve([
+            "versions": res
+        ])
+    }
+
+    @objc func _reset(toAutoUpdate: Bool) -> Bool {
+        guard let bridge = self.bridge else { return false }
+        if let vc = bridge.viewController as? CAPBridgeViewController {
+            let LatestVersionAutoUpdate = UserDefaults.standard.string(forKey: "LatestVersionAutoUpdate") ?? ""
+            let LatestVersionNameAutoUpdate = UserDefaults.standard.string(forKey: "LatestVersionNameAutoUpdate") ?? ""
+            if(toAutoUpdate && LatestVersionAutoUpdate != "" && LatestVersionNameAutoUpdate != "") {
+                let res = implementation.set(version: LatestVersionAutoUpdate, versionName: LatestVersionNameAutoUpdate)
+                return res && self._reload()
+            }
+            implementation.reset()
+            let pathPersist = implementation.getLastPathPersist()
+            vc.setServerBasePath(path: pathPersist)
+            UserDefaults.standard.set(pathPersist, forKey: "serverBasePath")
+            DispatchQueue.main.async {
+                vc.loadView()
+                vc.viewDidLoad()
+                print("✨  Capacitor-updater: Reset to original version")
+            }
+            return true
+        }
+        return false
+    }
+
+    @objc func reset(_ call: CAPPluginCall) {
+        let toAutoUpdate = call.getBool("toAutoUpdate") ?? false
+        if (self._reset(toAutoUpdate: toAutoUpdate)) {
+            return call.resolve()
+        }
+        call.reject("✨  Capacitor-updater: Reset failed")
+    }
+
+    @objc func versionName(_ call: CAPPluginCall) {
+        let name = implementation.getVersionName()
+        call.resolve([
+            "versionName": name
+        ])
+    }
+    
+    @objc func current(_ call: CAPPluginCall) {
+        let pathHot = implementation.getLastPathHot()
+        let current  = pathHot.count >= 10 ? pathHot.suffix(10) : "builtin"
+        call.resolve([
+            "current": current,
+            "currentNative": currentVersionNative
+        ])
+    }
+
+    @objc func notifyAppReady(_ call: CAPPluginCall) {
+        UserDefaults.standard.set(true, forKey: "notifyAppReady")
+        call.resolve()
+    }
+    
+    @objc func delayUpdate(_ call: CAPPluginCall) {
+        UserDefaults.standard.set(true, forKey: "delayUpdate")
+        call.resolve()
+    }
+    
+    @objc func cancelDelay(_ call: CAPPluginCall) {
+        UserDefaults.standard.set(false, forKey: "delayUpdate")
+        call.resolve()
+    }
+
+    @objc func appMovedToForeground() {
+        DispatchQueue.global(qos: .background).async {
+            print("✨  Capacitor-updater: Check for update in the server")
+            let url = URL(string: self.autoUpdateUrl)!
+            let res = self.implementation.getLatest(url: url)
+            if (res == nil) {
+                return
+            }
+            guard let downloadUrl = URL(string: res?.url ?? "") else {
+                print("✨  Capacitor-updater: Error \(res?.message ?? "Unknow error")")
+                if (res?.major == true) {
+                    self.notifyListeners("majorAvailable", data: ["version": res?.version ?? "0.0.0"])
+                }
+                return
+            }
+            let currentVersion = self.implementation.getVersionName()
+            var failingVersion: Version = "0.0.0"
+            var newVersion: Version = "0.0.0"
+            do {
+                newVersion = try Version(res?.version ?? "0.0.0")
+                failingVersion = try Version(UserDefaults.standard.string(forKey: "failingVersion") ?? "0.0.0")
+            } catch {
+                print("✨  Capacitor-updater: Cannot get version \(failingVersion) \(newVersion)")
+            }
+            if (newVersion != "0.0.0" && newVersion != failingVersion) {
+                let dlOp = self.implementation.download(url: downloadUrl)
+                if let dl = dlOp {
+                    print("✨  Capacitor-updater: New version: \(newVersion) found. Current is \(currentVersion == "" ? "builtin" : currentVersion), next backgrounding will trigger update")
+                    UserDefaults.standard.set(dl, forKey: "nextVersion")
+                    UserDefaults.standard.set(newVersion.description, forKey: "nextVersionName")
+                    self.notifyListeners("updateAvailable", data: ["version": newVersion])
+                } else {
+                    print("✨  Capacitor-updater: Download version \(newVersion) fail")
+                }
+            } else {
+                print("✨  Capacitor-updater: No need to update, \(currentVersion) is the latest")
+            }
+        }
+    }
+
+    @objc func appMovedToBackground() {
+        print("✨  Capacitor-updater: Check for waiting update")
+        let delayUpdate = UserDefaults.standard.bool(forKey: "delayUpdate")
+        UserDefaults.standard.set(false, forKey: "delayUpdate")
+        if (delayUpdate) {
+            print("✨  Capacitor-updater: Update delayed to next backgrounding")
+            return
+        }
+        let nextVersion = UserDefaults.standard.string(forKey: "nextVersion") ?? ""
+        let nextVersionName = UserDefaults.standard.string(forKey: "nextVersionName") ?? ""
+        let pastVersion = UserDefaults.standard.string(forKey: "pastVersion") ?? ""
+        let pastVersionName = UserDefaults.standard.string(forKey: "pastVersionName") ?? ""
+        let notifyAppReady = UserDefaults.standard.bool(forKey: "notifyAppReady")
+        let curVersion = implementation.getLastPathPersist().components(separatedBy: "/").last!
+        let curVersionName = implementation.getVersionName()
+        if (nextVersion != "" && nextVersionName != "") {
+            let res = implementation.set(version: nextVersion, versionName: nextVersionName)
+            if (res && self._reload()) {
+                print("✨  Capacitor-updater: Auto update to version: \(nextVersionName)")
+                UserDefaults.standard.set(nextVersion, forKey: "LatestVersionAutoUpdate")
+                UserDefaults.standard.set(nextVersionName, forKey: "LatestVersionNameAutoUpdate")
+                UserDefaults.standard.set("", forKey: "nextVersion")
+                UserDefaults.standard.set("", forKey: "nextVersionName")
+                UserDefaults.standard.set(curVersion, forKey: "pastVersion")
+                UserDefaults.standard.set(curVersionName, forKey: "pastVersionName")
+                UserDefaults.standard.set(false, forKey: "notifyAppReady")
+            } else {
+                print("✨  Capacitor-updater: Auto update to version: \(nextVersionName) Failed");
+            }
+        } else if (!notifyAppReady && curVersionName != "") {
+            print("✨  Capacitor-updater: notifyAppReady never trigger")
+            print("✨  Capacitor-updater: Version: \(curVersionName), is considered broken")
+            print("✨  Capacitor-updater: Will downgraded to version: \(pastVersionName == "" ? "builtin" : pastVersionName) for next start")
+            print("✨  Capacitor-updater: Don't forget to trigger 'notifyAppReady()' in js code to validate a version.")
+            implementation.sendStats(action: "revert", version: curVersionName)
+            if (pastVersion != "" && pastVersionName != "") {
+                let res = implementation.set(version: pastVersion, versionName: pastVersionName)
+                if (res && self._reload()) {
+                    print("✨  Capacitor-updater: Revert to version: \(pastVersionName == "" ? "builtin" : pastVersionName)")
+                    UserDefaults.standard.set(pastVersion, forKey: "LatestVersionAutoUpdate")
+                    UserDefaults.standard.set(pastVersionName, forKey: "LatestVersionNameAutoUpdate")
+                    UserDefaults.standard.set("", forKey: "pastVersion")
+                    UserDefaults.standard.set("", forKey: "pastVersionName")
+                } else {
+                    print("✨  Capacitor-updater: Revert to version: \(pastVersionName == "" ? "builtin" : pastVersionName) Failed");
+                }
+            } else {
+                if self._reset(toAutoUpdate: false) {
+                    UserDefaults.standard.set("", forKey: "LatestVersionAutoUpdate")
+                    UserDefaults.standard.set("", forKey: "LatestVersionNameAutoUpdate")
+                    print("✨  Capacitor-updater: Auto reset done")
+                }
+            }
+            UserDefaults.standard.set(curVersionName, forKey: "failingVersion")
+            let res = implementation.delete(version: curVersion, versionName: curVersionName)
+            if (res) {
+                print("✨  Capacitor-updater: Delete failing version: \(curVersionName)")
+            }
+        } else if (pastVersion != "") {
+            print("✨  Capacitor-updater: Validated version: \(curVersionName)")
+            let res = implementation.delete(version: pastVersion, versionName: curVersionName)
+            if (res) {
+                print("✨  Capacitor-updater: Delete past version: \(pastVersionName)")
+            }
+            UserDefaults.standard.set("", forKey: "pastVersion")
+            UserDefaults.standard.set("", forKey: "pastVersionName")
+        }
+    }
+}

package/ios/Plugin/Info.plist

@@ -0,0 +1,28 @@
+<?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>
+	<key>UIFileSharingEnabled</key>
+	<true/>
+	<key>LSSupportsOpeningDocumentsInPlace</key>
+	<true/>
+</dict>
+</plist>

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@capgo/capacitor-updater",
+  "version": "3.0.3",
+  "license": "AGPL-3.0-only",
+  "description": "OTA update for capacitor apps",
+  "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/",
+    "CapacitorUpdater.podspec"
+  ],
+  "author": "Martin Donadieu",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Cap-go/capacitor-updater.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Cap-go/capacitor-updater/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "OTA",
+    "manual update",
+    "live update",
+    "auto update",
+    "ionic",
+    "appflow alternative",
+    "capgo",
+    "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 && 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 -- autocorrect --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api CapacitorUpdaterPlugin --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"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^3.4.3",
+    "@capacitor/core": "^3.4.3",
+    "@capacitor/docgen": "^0.1.1",
+    "@capacitor/ios": "^3.4.3",
+    "@ionic/eslint-config": "^0.3.0",
+    "@ionic/prettier-config": "^2.0.0",
+    "@ionic/swiftlint-config": "^1.1.2",
+    "eslint": "^7.32.0",
+    "prettier": "^2.5.1",
+    "prettier-plugin-java": "^1.6.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.70.0",
+    "swiftlint": "^1.0.1",
+    "typescript": "^4.6.2"
+  },
+  "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"
+    }
+  }
+}