@dimensional-innovations/electron-background 2.0.4 → 2.0.7

package/dist/AutoUpdater.d.ts

@@ -1,4 +1,4 @@
-import { InitContext, InitPlugin } from './init';
+import { BrowserWindowInitContext, InitPlugin } from './init';
 /**
  * Starts the auto update process, checking for updates every 3 minutes
  * and automatically installing the update once one is found.
@@ -13,6 +13,6 @@ export declare class AutoUpdater implements InitPlugin {
      * @param enabled - Indicates if the plugin is enabled. Used to disable the plugin in development. Defaults to `app.isPackaged`.
      */
     constructor(enabled?: boolean);
-    afterLoad(context: InitContext): Promise<void>;
+    afterLoad({ config, log }: BrowserWindowInitContext): Promise<void>;
     private startAutoUpdater;
 }

package/dist/AutoUpdater.js

@@ -13,9 +13,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutoUpdater = void 0;
-const electron_updater_1 = require("electron-updater");
-const electron_log_1 = __importDefault(require("electron-log"));
 const electron_1 = require("electron");
+const electron_log_1 = __importDefault(require("electron-log"));
+const electron_updater_1 = require("electron-updater");
 /**
  * Starts the auto update process, checking for updates every 3 minutes
  * and automatically installing the update once one is found.
@@ -31,14 +31,14 @@ class AutoUpdater {
     constructor(enabled = electron_1.app.isPackaged) {
         this.enabled = enabled;
     }
-    afterLoad(context) {
+    afterLoad({ config, log }) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { autoUpdaterChannel } = context.config;
+            const { autoUpdaterChannel } = config;
             if (this.enabled && autoUpdaterChannel) {
                 this.startAutoUpdater(autoUpdaterChannel);
             }
             else if (this.enabled) {
-                context.log.warn('autoUpdaterChannel was not set in the settings. AutoUpdater was not started.');
+                log.warn('autoUpdaterChannel was not set in the settings. AutoUpdater was not started.');
             }
         });
     }

package/dist/BrowserWindow.d.ts

@@ -1,5 +1,5 @@
 import { BrowserWindowConstructorOptions } from "electron";
-import { InitContext, InitPlugin } from "./init";
+import { BrowserWindowInitContext, InitContext, InitPlugin } from "./init";
 /**
  * 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.
@@ -43,6 +43,6 @@ export declare class FullScreenBrowserWindow extends DefaultBrowserWindow {
      * @param enabled - Indicates if the plugin is enabled. Used to disable the plugin in development. Defaults to `app.isPackaged`.
      */
     constructor(options?: BrowserWindowConstructorOptions, enabled?: boolean);
-    beforeLoad(context: InitContext): Promise<void>;
+    beforeLoad({ browserWindow }: BrowserWindowInitContext): Promise<void>;
     protected getDefaultWindowOptions(): BrowserWindowConstructorOptions;
 }

package/dist/BrowserWindow.js

@@ -113,16 +113,11 @@ class FullScreenBrowserWindow extends DefaultBrowserWindow {
         super(options);
         this.enabled = enabled;
     }
-    beforeLoad(context) {
+    beforeLoad({ browserWindow }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.enabled) {
                 return;
             }
-            const browserWindow = context.browserWindow;
-            if (!browserWindow) {
-                context.log.error('browserWindow is undefined');
-                return;
-            }
             const { screen } = yield Promise.resolve().then(() => __importStar(require('electron')));
             const resizeWindow = () => {
                 browserWindow.setBounds(screen.getPrimaryDisplay().bounds);

package/dist/DevTools.d.ts

@@ -1,5 +1,5 @@
 import { VUEJS3_DEVTOOLS } from 'electron-devtools-installer';
-import { InitContext, InitPlugin } from './init';
+import { BrowserWindowInitContext, InitPlugin } from './init';
 export type Extension = string | typeof VUEJS3_DEVTOOLS;
 /**
  * Installs dev tools extensions and opens the devTools panel.
@@ -14,5 +14,5 @@ export declare class DevTools implements InitPlugin {
      * @param enabled - Indicates if the plugin is enabled. Used to disable the plugin when the app is packaged. Defaults to `!app.isPackaged`.
      */
     constructor(devTools: Array<Extension>, enabled?: boolean);
-    beforeLoad(context: InitContext): Promise<void>;
+    beforeLoad({ browserWindow }: BrowserWindowInitContext): Promise<void>;
 }

package/dist/DevTools.js

@@ -29,11 +29,12 @@ class DevTools {
         this.devTools = devTools;
         this.enabled = enabled;
     }
-    beforeLoad(context) {
+    beforeLoad({ browserWindow }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.enabled) {
                 return;
             }
+            browserWindow.on('ready-to-show', () => browserWindow.webContents.openDevTools());
             try {
                 yield (0, electron_devtools_installer_1.default)(this.devTools);
             }
@@ -41,10 +42,6 @@ class DevTools {
                 console.error(`Failed to install dev tools: ${this.devTools.join(',')}`);
                 console.error(error);
             }
-            if (context.browserWindow) {
-                const browserWindow = context.browserWindow;
-                browserWindow.on('ready-to-show', () => browserWindow.webContents.openDevTools());
-            }
         });
     }
 }

package/dist/init.d.ts

@@ -16,11 +16,6 @@ export declare class InitContext {
      * `beforeLoad` methods to change the created BrowserWindow.
      */
     browserWindowOptions: BrowserWindowConstructorOptions;
-    /**
-     * The main browser window that the app is loaded into. This is available in the context
-     * in the `afterLoad` method.
-     */
-    browserWindow: BrowserWindow | null;
     /**
      * The log instance. This should be used over `console` in plugin implementations.
      */
@@ -39,16 +34,26 @@ export declare class InitContext {
      * `beforeLoad` methods to change the created BrowserWindow.
      */
     browserWindowOptions: BrowserWindowConstructorOptions, 
-    /**
-     * The main browser window that the app is loaded into. This is available in the context
-     * in the `afterLoad` method.
-     */
-    browserWindow: BrowserWindow | null, 
     /**
      * The log instance. This should be used over `console` in plugin implementations.
      */
     log: Pick<Console, 'error' | 'warn' | 'info' | 'debug'>);
+    /**
+       * The main browser window that the app is loaded into. This is available in the context
+       * in the `beforeLoad` and `afterLoad` method.
+       */
+    browserWindow?: BrowserWindow;
 }
+/**
+ * Represents the InitContext before the BrowserWindow has been set. Used in the
+ * "beforeReady" and "afterReady" methods.
+ */
+export type NonBrowserWindowInitContext = Omit<InitContext, 'browserWindow'>;
+/**
+ * Represents the InitContext after the BrowserWindow has been set. Used in the
+ * "beforeLoad" and "afterLoad" methods.
+ */
+export type BrowserWindowInitContext = Omit<InitContext, 'browserWindow'> & Required<Pick<InitContext, 'browserWindow'>>;
 /**
  * A plugin is used to execute logic at various stages during the init process.
  *
@@ -61,33 +66,37 @@ export interface InitPlugin {
      *
      * @param context - The current InitContext instance.
      */
-    beforeReady?(context: InitContext): Promise<void>;
+    beforeReady?(context: NonBrowserWindowInitContext): Promise<void>;
     /**
      * afterReady is executed after the `app.whenReady()` promise resolves, but before the
      * BrowserWindow is created.
      *
      * @param context - The current InitContext instance.
      */
-    afterReady?(context: InitContext): Promise<void>;
+    afterReady?(context: NonBrowserWindowInitContext): Promise<void>;
     /**
      * beforeLoad is executed after the browserWindow is created, but before the application
      * has been loaded into the window.
      *
      * @param context - The current InitContext instance.
      */
-    beforeLoad?(context: InitContext): Promise<void>;
+    beforeLoad?(context: BrowserWindowInitContext): Promise<void>;
     /**
      * afterLoad is executed after the application has been loaded into the browserWindow.
      *
      * @param context - The current InitContext instance.
      */
-    afterLoad?(context: InitContext): Promise<void>;
+    afterLoad?(context: BrowserWindowInitContext): Promise<void>;
 }
 export interface InitOptions {
     /**
      * The url to load once the the app has been created.
      */
     appUrl: string;
+    /**
+     * The default browser window options
+     */
+    browserWindowOptions?: BrowserWindowConstructorOptions;
     /**
      * The default application settings.
      */
@@ -103,4 +112,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, config, plugins, }: InitOptions): Promise<InitContext>;
+export declare function init({ appUrl, browserWindowOptions, config, plugins, }: InitOptions): Promise<InitContext>;

package/dist/init.js

@@ -33,11 +33,6 @@ class InitContext {
      * `beforeLoad` methods to change the created BrowserWindow.
      */
     browserWindowOptions, 
-    /**
-     * The main browser window that the app is loaded into. This is available in the context
-     * in the `afterLoad` method.
-     */
-    browserWindow, 
     /**
      * The log instance. This should be used over `console` in plugin implementations.
      */
@@ -45,7 +40,6 @@ class InitContext {
         this.appUrl = appUrl;
         this.config = config;
         this.browserWindowOptions = browserWindowOptions;
-        this.browserWindow = browserWindow;
         this.log = log;
     }
 }
@@ -56,7 +50,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, config = {}, plugins = [], }) {
+function init({ appUrl, browserWindowOptions = { height: 1920, width: 1080, backgroundColor: '#000' }, config = {}, 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);
@@ -65,7 +59,7 @@ function init({ appUrl, config = {}, plugins = [], }) {
                 electron_1.app.quit();
         });
         process.on('SIGTERM', electron_1.app.quit);
-        const context = new InitContext(appUrl, config, { height: 1920, width: 1080, backgroundColor: '#000' }, null, electron_log_1.default);
+        const context = new InitContext(appUrl, config, browserWindowOptions, electron_log_1.default);
         for (const plugin of plugins) {
             if (plugin.beforeReady) {
                 yield plugin.beforeReady(context);
@@ -78,7 +72,6 @@ function init({ appUrl, config = {}, plugins = [], }) {
             }
         }
         context.browserWindow = new electron_1.BrowserWindow(context.browserWindowOptions);
-        context.browserWindow.on('closed', () => context.browserWindow = null);
         for (const plugin of plugins) {
             if (plugin.beforeLoad) {
                 yield plugin.beforeLoad(context);
@@ -87,9 +80,10 @@ function init({ appUrl, config = {}, plugins = [], }) {
         yield context.browserWindow.loadURL(context.appUrl);
         for (const plugin of plugins) {
             if (plugin.afterLoad) {
-                plugin.afterLoad(context);
+                yield plugin.afterLoad(context);
             }
         }
+        context.browserWindow.on('closed', () => context.browserWindow = undefined);
         return context;
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimensional-innovations/electron-background",
-  "version": "2.0.4",
+  "version": "2.0.7",
   "description": "the background script for electron apps",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,11 +11,12 @@
     "build": "tsc",
     "lint": "eslint ./src/**/*",
     "lint:fix": "eslint ./src/**/* --fix",
-    "generate:docs": "jsdoc2md ./dist/* > API.md"
+    "generate:docs": "jsdoc2md ./dist/* > API.md",
+    "prepublish": "tsc"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://gitlab.com/dimensional-innovations/electron-background.git"
+    "url": "git+https://github.com/ditech/electron-background.git"
   },
   "keywords": [
     "vue",
@@ -25,9 +26,9 @@
   "author": "Edgar Esparza",
   "license": "ISC",
   "bugs": {
-    "url": "https://gitlab.com/dimensional-innovations/electron-background/issues"
+    "url": "https://github.com/ditech/electron-background/issues"
   },
-  "homepage": "https://gitlab.com/dimensional-innovations/electron-background#readme",
+  "homepage": "https://github.com/ditech/electron-background",
   "dependencies": {
     "axios": "^1.6.7",
     "electron-devtools-installer": "^3.1.1",