@dimensional-innovations/electron-background 2.0.8 → 2.1.0

package/README.md

@@ -18,21 +18,17 @@ yarn add @dimensional-innovations/electron-background
 
 If you are using the Vue CLI, add the following to your main or background file. 
 ```typescript
-import { AutoUpdater, DevTools, VueElectronSettings, init, KioskBrowserWindow, PrivilegedSchemes, StaticFileDir, TouchEvents, VueElectronVersion } from '@dimensional-innovations/electron-background';
-import { config } from '../package';
+import { AutoUpdater, DevTools, init, KioskBrowserWindow, PrivilegedSchemes, StaticFileDir, TouchEvents } from '@dimensional-innovations/electron-background';
 
 init({
   appUrl: process.env.WEBPACK_DEV_URL ? process.env.WEBPACK_DEV_URL : 'app://index.html',
-  config,
   plugins: [
-    new AutoUpdater(),
+    new AutoUpdater({ channel: 'stable' }),
     new DevTools(),
     new KioskBrowserWindow(),
     new PrivilegedSchemes(['app']),
     new StaticFileDir('app', __dirname),
     new TouchEvents(),
-    new VueElectronSettings(),
-    new VueElectronVersion()
   ]
 });
 ```
@@ -41,22 +37,18 @@ init({
 
 If you are using Vite, add the following to your main or background file. 
 ```typescript
-import { AutoUpdater, DevTools, VueElectronSettings, init, KioskBrowserWindow, PrivilegedSchemes, TouchEvents, VueElectronVersion } from '@dimensional-innovations/electron-background';
-import { app } from 'electron';
-import { config } from '../package';
+import { AutoUpdater, DevTools, init, KioskBrowserWindow, TouchEvents } from '@dimensional-innovations/electron-background';
+import { join } from 'path';
 
 init({
   appUrl: process.env['ELECTRON_RENDERER_URL']
     ? process.env['ELECTRON_RENDERER_URL']
     : `file://${join(__dirname, '../renderer/index.html')}`,
-  config,
   plugins: [
-    new AutoUpdater(),
+    new AutoUpdater({ channel: 'stable' }),
     new DevTools(),
     new KioskBrowserWindow(),
     new TouchEvents(),
-    new VueElectronSettings(),
-    new VueElectronVersion()
   ]
 });
 ```
@@ -67,13 +59,11 @@ By default, the init method creates a BrowserWindow and loads the specified appl
 
 If a feature you need isn't listed below, you can still add it to the init script by defining the plugin in your application. For example, if we wanted to customize the autoplay policy flag in electron, we would add the following to our init method.
 ```typescript
-import { init } from '@dimensional-innovations/vue-electron-background';
+import { init } from '@dimensional-innovations/electron-background';
 import { app } from 'electron';
-import { config } from '../package';
 
 init({
   appUrl: ...,
-  config,
   plugins: [
     ...,
     { beforeReady: () => app.commandLine.appendSwitch('autoplay-policy', 'no-user-gesture-required') }
@@ -93,8 +83,8 @@ Installs dev tools extensions and opens the devTools panel.
 ### KioskBrowserWindow
 Enables kiosk mode in the BrowserWindow when the application is packaged.
 
-### BetterUptimeHeartbeat
-Starts a heartbeat, which reports uptime to betteruptime.com. Requires that "heartbeatApiKey" is set in the settings.
+### BetterStackHeartbeat
+Starts a heartbeat, which reports uptime to betteruptime.com. Requires `heartbeatApiKey` in options.
 
 ### PrivilegedSchemes
 Registers schemes as privileged.

package/dist/AutoUpdater.d.ts

@@ -1,4 +1,14 @@
 import { BrowserWindowInitContext, InitPlugin } from './init';
+/**
+ * Options for configuring the AutoUpdater plugin.
+ */
+export interface AutoUpdaterOptions {
+    /**
+     * The update channel to use (e.g., 'stable', 'beta', 'alpha').
+     * This determines which release channel the app will receive updates from.
+     */
+    channel?: string;
+}
 /**
  * Starts the auto update process, checking for updates every 3 minutes
  * and automatically installing the update once one is found.
@@ -7,12 +17,13 @@ import { BrowserWindowInitContext, InitPlugin } from './init';
  */
 export declare class AutoUpdater implements InitPlugin {
     private readonly enabled;
+    private readonly options;
     /**
      * @constructor
      *
      * @param enabled - Indicates if the plugin is enabled. Used to disable the plugin in development. Defaults to `app.isPackaged`.
      */
-    constructor(enabled?: boolean);
-    afterLoad({ config, log }: BrowserWindowInitContext): Promise<void>;
+    constructor(enabled?: boolean, options?: AutoUpdaterOptions);
+    afterLoad({ log }: BrowserWindowInitContext): Promise<void>;
     private startAutoUpdater;
 }

package/dist/AutoUpdater.js

@@ -28,17 +28,18 @@ class AutoUpdater {
      *
      * @param enabled - Indicates if the plugin is enabled. Used to disable the plugin in development. Defaults to `app.isPackaged`.
      */
-    constructor(enabled = electron_1.app.isPackaged) {
+    constructor(enabled = electron_1.app.isPackaged, options = {}) {
         this.enabled = enabled;
+        this.options = options;
     }
-    afterLoad({ config, log }) {
+    afterLoad({ log }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { autoUpdaterChannel } = config;
-            if (this.enabled && autoUpdaterChannel) {
-                this.startAutoUpdater(autoUpdaterChannel);
+            const { channel } = this.options;
+            if (this.enabled && channel) {
+                this.startAutoUpdater(channel);
             }
             else if (this.enabled) {
-                log.warn('autoUpdaterChannel was not set in the settings. AutoUpdater was not started.');
+                log.warn('channel was not set in the passed in options. AutoUpdater was not started.');
             }
         });
     }

package/dist/BrowserWindow.d.ts

@@ -14,7 +14,6 @@ export declare class DefaultBrowserWindow implements InitPlugin {
     constructor(options?: BrowserWindowConstructorOptions);
     afterReady(context: InitContext): Promise<void>;
     protected getDefaultWindowOptions(): BrowserWindowConstructorOptions;
-    protected getWindowOptionsFromConfig({ appHeight, appWidth, backgroundColor }: Record<string, string | number | boolean>): BrowserWindowConstructorOptions;
 }
 /**
  * Enables kiosk mode in the BrowserWindow when the application is packaged.

package/dist/BrowserWindow.js

@@ -31,9 +31,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FullScreenBrowserWindow = exports.KioskBrowserWindow = exports.DefaultBrowserWindow = void 0;
 const electron_1 = require("electron");
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
 /**
  * Applies default options to the browser window. If `appHeight`, `appWidth`, or `backgroundColor` are included in
  * app config, they will be added to the window options as well.
@@ -49,7 +53,7 @@ class DefaultBrowserWindow {
     }
     afterReady(context) {
         return __awaiter(this, void 0, void 0, function* () {
-            context.browserWindowOptions = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, context.browserWindowOptions), this.getDefaultWindowOptions()), this.getWindowOptionsFromConfig(context.config)), this.options), { closable: true });
+            context.browserWindowOptions = (0, lodash_merge_1.default)({}, this.getDefaultWindowOptions(), context.browserWindowOptions, this.options, { closable: true });
         });
     }
     getDefaultWindowOptions() {
@@ -61,19 +65,6 @@ class DefaultBrowserWindow {
             }
         };
     }
-    getWindowOptionsFromConfig({ appHeight, appWidth, backgroundColor }) {
-        const options = {};
-        if (appHeight !== undefined && typeof appHeight === 'number') {
-            options.height = appHeight;
-        }
-        if (appWidth !== undefined && typeof appWidth === 'number') {
-            options.width = appWidth;
-        }
-        if (backgroundColor !== undefined && typeof backgroundColor === 'string') {
-            options.backgroundColor = backgroundColor;
-        }
-        return options;
-    }
 }
 exports.DefaultBrowserWindow = DefaultBrowserWindow;
 /**

package/dist/NodeHeartbeat.js

@@ -57,7 +57,7 @@ class BetterStackHeartbeat {
     }
     afterLoad(context) {
         return __awaiter(this, void 0, void 0, function* () {
-            const heartbeatApiKey = context.config.heartbeatApiKey || this.options.heartbeatApiKey;
+            const heartbeatApiKey = this.options.heartbeatApiKey;
             if (this.enabled && heartbeatApiKey && typeof heartbeatApiKey === 'string') {
                 const url = this.options.isBetterStack
                     ? `https://uptime.betterstack.com/api/v1/heartbeat/${heartbeatApiKey}`

package/dist/init.d.ts

@@ -7,10 +7,6 @@ export declare class InitContext {
      * The url used to load the application.
      */
     appUrl: string;
-    /**
-     * Application config used by the app and/or plugins.
-     */
-    config: Record<string, string | number | boolean>;
     /**
      * Options used to create the BrowserWindow. These can be modified in `beforeReady` or
      * `beforeLoad` methods to change the created BrowserWindow.
@@ -25,10 +21,6 @@ export declare class InitContext {
      * The url used to load the application.
      */
     appUrl: string, 
-    /**
-     * Application config used by the app and/or plugins.
-     */
-    config: Record<string, string | number | boolean>, 
     /**
      * Options used to create the BrowserWindow. These can be modified in `beforeReady` or
      * `beforeLoad` methods to change the created BrowserWindow.
@@ -97,10 +89,6 @@ export interface InitOptions {
      * The default browser window options
      */
     browserWindowOptions?: BrowserWindowConstructorOptions;
-    /**
-     * The default application settings.
-     */
-    config?: Record<string, string | number | boolean>;
     /**
      * The list of plugins to load with the application.
      */
@@ -112,4 +100,4 @@ export interface InitOptions {
  * @param options - Options used to define how the application is initialized.
  * @returns - The final state of the init context, including the created browser window for additional setup.
  */
-export declare function init({ appUrl, browserWindowOptions, config, plugins, }: InitOptions): Promise<InitContext>;
+export declare function init({ appUrl, browserWindowOptions, plugins, }: InitOptions): Promise<InitContext>;

package/dist/init.js

@@ -24,10 +24,6 @@ class InitContext {
      * The url used to load the application.
      */
     appUrl, 
-    /**
-     * Application config used by the app and/or plugins.
-     */
-    config, 
     /**
      * Options used to create the BrowserWindow. These can be modified in `beforeReady` or
      * `beforeLoad` methods to change the created BrowserWindow.
@@ -38,7 +34,6 @@ class InitContext {
      */
     log) {
         this.appUrl = appUrl;
-        this.config = config;
         this.browserWindowOptions = browserWindowOptions;
         this.log = log;
     }
@@ -50,7 +45,7 @@ exports.InitContext = InitContext;
  * @param options - Options used to define how the application is initialized.
  * @returns - The final state of the init context, including the created browser window for additional setup.
  */
-function init({ appUrl, browserWindowOptions = { height: 1920, width: 1080, backgroundColor: '#000' }, config = {}, plugins = [], }) {
+function init({ appUrl, browserWindowOptions = { height: 1920, width: 1080, backgroundColor: '#000' }, plugins = [], }) {
     return __awaiter(this, void 0, void 0, function* () {
         process.env.ELECTRON_DISABLE_SECURITY_WARNINGS = 'true';
         electron_1.app.on('window-all-closed', electron_1.app.quit);
@@ -59,7 +54,7 @@ function init({ appUrl, browserWindowOptions = { height: 1920, width: 1080, back
                 electron_1.app.quit();
         });
         process.on('SIGTERM', electron_1.app.quit);
-        const context = new InitContext(appUrl, config, browserWindowOptions, electron_log_1.default);
+        const context = new InitContext(appUrl, browserWindowOptions, electron_log_1.default);
         for (const plugin of plugins) {
             if (plugin.beforeReady) {
                 yield plugin.beforeReady(context);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimensional-innovations/electron-background",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "description": "the background script for electron apps",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,9 +33,11 @@
     "axios": "^1.6.7",
     "electron-devtools-installer": "^4.0.0",
     "electron-log": "^5.1.1",
-    "electron-updater": "^6.1.7"
+    "electron-updater": "^6.1.7",
+    "lodash.merge": "^4.6.2"
   },
   "devDependencies": {
+    "@types/lodash.merge": "^4.6.9",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
     "electron": "^28.2.1",