@capawesome/capacitor-live-update 8.4.4 → 8.6.0

package/electron/dist/plugin.mjs

@@ -0,0 +1,213 @@
+import { ElectronPlugin } from '@capawesome/capacitor-electron/plugin';
+import { LiveUpdateEngine } from '@capawesome/electron-live-update/engine';
+import { app, powerMonitor } from 'electron';
+import { createRequire } from 'node:module';
+import { join } from 'node:path';
+
+const AUTO_UPDATE_MIN_INTERVAL = 15 * 60 * 1000;
+const CAPACITOR_RUNTIME = 'capacitor';
+// Platform enum of the Capawesome Cloud API: 0 = Android, 1 = iOS, 2 = Electron.
+const ELECTRON_PLATFORM = '2';
+// The built file lives at `electron/dist/plugin.mjs`, so the package root is two levels up.
+const PLUGIN_VERSION = createRequire(import.meta.url)('../../package.json').version;
+class LiveUpdateElectron extends ElectronPlugin {
+    static __capacitorElectronPlugin = {
+        name: 'LiveUpdate',
+        methods: [
+            'clearBlockedBundles',
+            'deleteBundle',
+            'downloadBundle',
+            'fetchChannels',
+            'fetchLatestBundle',
+            'getBlockedBundles',
+            'getBundles',
+            'getChannel',
+            'getConfig',
+            'getCurrentBundle',
+            'getCustomId',
+            'getDeviceId',
+            'getDownloadedBundles',
+            'getNextBundle',
+            'getVersionCode',
+            'getVersionName',
+            'isSyncing',
+            'ready',
+            'reload',
+            'reset',
+            'resetConfig',
+            'setChannel',
+            'setConfig',
+            'setCustomId',
+            'setNextBundle',
+            'sync',
+        ],
+    };
+    config;
+    lastAutoUpdateCheck = 0;
+    loadedEngine;
+    constructor(context) {
+        super(context);
+        this.config =
+            context.config.plugins?.LiveUpdate ?? {};
+    }
+    async load() {
+        // A failing live update must never prevent the app from booting.
+        try {
+            this.loadedEngine = this.createEngine();
+            await this.loadedEngine.initialize();
+            this.context.services.bundles.setActiveBundle(this.loadedEngine.getCurrentBundlePath());
+        }
+        catch (error) {
+            console.error(`[LiveUpdate] Failed to load, serving the default bundle: ${error}`);
+            return;
+        }
+        if (this.config.autoUpdateStrategy === 'background') {
+            this.setUpBackgroundAutoUpdate();
+        }
+    }
+    async clearBlockedBundles() {
+        return this.engine.clearBlockedBundles();
+    }
+    async deleteBundle(options) {
+        return this.engine.deleteBundle(options);
+    }
+    async downloadBundle(options) {
+        const { artifactType } = options;
+        if (artifactType === 'manifest') {
+            throw new Error('The manifest artifact type is not supported.');
+        }
+        return this.engine.downloadBundle({ ...options, artifactType });
+    }
+    async fetchChannels(options) {
+        return this.engine.fetchChannels(options);
+    }
+    async fetchLatestBundle(options) {
+        return this.engine.fetchLatestBundle(options);
+    }
+    async getBlockedBundles() {
+        return this.engine.getBlockedBundles();
+    }
+    async getBundles() {
+        return this.getDownloadedBundles();
+    }
+    async getChannel() {
+        return this.engine.getChannel();
+    }
+    async getConfig() {
+        const { appId } = await this.engine.getConfig();
+        return {
+            appId,
+            autoUpdateStrategy: this.config.autoUpdateStrategy ?? 'none',
+        };
+    }
+    async getCurrentBundle() {
+        return this.engine.getCurrentBundle();
+    }
+    async getCustomId() {
+        return this.engine.getCustomId();
+    }
+    async getDeviceId() {
+        return this.engine.getDeviceId();
+    }
+    async getDownloadedBundles() {
+        return this.engine.getDownloadedBundles();
+    }
+    async getNextBundle() {
+        return this.engine.getNextBundle();
+    }
+    async getVersionCode() {
+        return this.engine.getVersionCode();
+    }
+    async getVersionName() {
+        return this.engine.getVersionName();
+    }
+    async isSyncing() {
+        return this.engine.isSyncing();
+    }
+    async ready() {
+        return this.engine.ready();
+    }
+    async reload() {
+        await this.engine.applyNextBundle();
+        this.reloadCurrentBundle();
+    }
+    async reset() {
+        return this.engine.reset();
+    }
+    async resetConfig() {
+        return this.engine.resetConfig();
+    }
+    async setChannel(options) {
+        return this.engine.setChannel(options);
+    }
+    async setConfig(options) {
+        return this.engine.setConfig(options);
+    }
+    async setCustomId(options) {
+        return this.engine.setCustomId(options);
+    }
+    async setNextBundle(options) {
+        return this.engine.setNextBundle(options);
+    }
+    async sync(options) {
+        return this.engine.sync(options);
+    }
+    get engine() {
+        if (!this.loadedEngine) {
+            throw new Error('LiveUpdate failed to load. See the logs for details.');
+        }
+        return this.loadedEngine;
+    }
+    createEngine() {
+        const engine = new LiveUpdateEngine({
+            appId: this.config.appId,
+            autoBlockRolledBackBundles: this.config.autoBlockRolledBackBundles,
+            autoDeleteBundles: this.config.autoDeleteBundles,
+            dataDirectory: join(app.getPath('userData'), 'capawesome-live-update'),
+            defaultChannel: this.config.defaultChannel,
+            httpTimeout: this.config.httpTimeout,
+            osVersion: process.getSystemVersion(),
+            platform: ELECTRON_PLATFORM,
+            pluginVersion: PLUGIN_VERSION,
+            publicKey: this.config.publicKey,
+            readyTimeout: this.config.readyTimeout,
+            runtime: CAPACITOR_RUNTIME,
+            serverDomain: this.config.serverDomain,
+            versionCode: app.getVersion(),
+            versionName: app.getVersion(),
+        });
+        engine.on('downloadBundleProgress', event => this.context.notifyListeners('downloadBundleProgress', event));
+        engine.on('nextBundleSet', event => this.context.notifyListeners('nextBundleSet', event));
+        engine.on('rolledBack', () => {
+            try {
+                this.reloadCurrentBundle();
+            }
+            catch (error) {
+                console.error(`[LiveUpdate] Failed to apply rollback: ${error}`);
+            }
+        });
+        return engine;
+    }
+    reloadCurrentBundle() {
+        this.context.services.bundles.setActiveBundle(this.engine.getCurrentBundlePath());
+        // Retained so that the freshly reloaded page receives the event.
+        this.context.notifyListeners('reloaded', {}, { retain: true });
+    }
+    setUpBackgroundAutoUpdate() {
+        const check = () => {
+            const now = Date.now();
+            if (now - this.lastAutoUpdateCheck < AUTO_UPDATE_MIN_INTERVAL) {
+                return;
+            }
+            this.lastAutoUpdateCheck = now;
+            void this.sync().catch(error => console.warn(`[LiveUpdate] Background sync failed: ${error}`));
+        };
+        void app.whenReady().then(() => {
+            check();
+            app.on('browser-window-focus', check);
+            powerMonitor.on('resume', check);
+        });
+    }
+}
+
+export { LiveUpdateElectron };

package/ios/Plugin/LiveUpdatePlugin.swift

@@ -8,7 +8,7 @@ import Capacitor
 @objc(LiveUpdatePlugin)
 public class LiveUpdatePlugin: CAPPlugin, CAPBridgedPlugin {
     public static let tag = "LiveUpdate"
-    public static let version = "8.4.4"
+    public static let version = "8.6.0"
     public static let userDefaultsPrefix = "CapawesomeLiveUpdate" // DO NOT CHANGE
 
     public let identifier = "LiveUpdatePlugin"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capawesome/capacitor-live-update",
-  "version": "8.4.4",
-  "description": "Capacitor plugin to update your app remotely in real-time on Android and iOS.",
+  "version": "8.6.0",
+  "description": "Capacitor plugin to update your app remotely in real-time on Android, iOS and Electron.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
   "types": "dist/esm/index.d.ts",
@@ -10,6 +10,7 @@
     "android/src/main/",
     "android/build.gradle",
     "dist/",
+    "electron/dist/",
     "ios/Plugin/",
     "CapawesomeCapacitorLiveUpdate.podspec",
     "Package.swift"
@@ -41,6 +42,7 @@
     "ionic",
     "android",
     "ios",
+    "electron",
     "live update",
     "remote update",
     "ota",
@@ -60,36 +62,51 @@
     "verify:web": "npm run build",
     "e2e:android": "npm install --prefix example && npm run build && npm --prefix example run e2e:android",
     "e2e:ios": "npm install --prefix example && npm run build && npm --prefix example run e2e:ios",
+    "e2e:electron": "npm install --prefix example && npm run build && npm --prefix example run e2e:electron",
     "lint": "npm run version:check && 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 LiveUpdatePlugin --output-readme README.md --output-json dist/docs.json",
-    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
-    "clean": "rimraf ./dist",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs && npm run build:electron",
+    "build:electron": "rollup -c electron/rollup.config.mjs",
+    "clean": "rimraf ./dist ./electron/dist",
     "watch": "tsc --watch",
     "version": "node scripts/sync-plugin-version.mjs",
     "version:check": "node scripts/sync-plugin-version.mjs --check",
     "ios:pod:install": "cd ios && pod install --repo-update && cd ..",
     "prepublishOnly": "npm run build"
   },
+  "dependencies": {
+    "@capawesome/electron-live-update": "^0.1.0"
+  },
   "devDependencies": {
     "@capacitor/android": "8.0.0",
     "@capacitor/cli": "8.4.2",
     "@capacitor/core": "8.0.0",
     "@capacitor/docgen": "0.3.1",
     "@capacitor/ios": "8.0.0",
+    "@capawesome/capacitor-electron": "0.2.0",
     "@ionic/eslint-config": "0.4.0",
+    "@rollup/plugin-typescript": "12.3.0",
+    "electron": "44.5.1",
     "eslint": "8.57.0",
     "prettier-plugin-java": "2.9.7",
     "rimraf": "6.1.2",
     "rollup": "4.62.3",
     "swiftlint": "2.0.0",
+    "tslib": "2.8.1",
     "typescript": "5.9.3"
   },
   "peerDependencies": {
-    "@capacitor/core": ">=8.0.0"
+    "@capacitor/core": ">=8.0.0",
+    "@capawesome/capacitor-electron": ">=0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@capawesome/capacitor-electron": {
+      "optional": true
+    }
   },
   "eslintConfig": {
     "extends": "@ionic/eslint-config/recommended"
@@ -100,6 +117,9 @@
     },
     "android": {
       "src": "android"
+    },
+    "electron": {
+      "src": "electron"
     }
   }
 }