@dimensional-innovations/electron-background 2.3.1 → 3.0.0

package/dist/windows/KioskBrowserWindow.d.ts

@@ -0,0 +1,15 @@
+import { AppBrowserWindow, AppBrowserWindowConstructorOptions } from "./AppBrowserWindow";
+export interface KioskBrowserWindowConstructorOptions extends AppBrowserWindowConstructorOptions {
+    /**
+     * The screen the window should occupy. Use 'primary' for the primary display,
+     * 'secondary' for the first non-primary display, or a number for the display
+     * at that index in the list returned by screen.getAllDisplays(). Defaults to 'primary'.
+     */
+    screen?: 'primary' | 'secondary' | number;
+}
+/**
+ * Enables kiosk mode in the BrowserWindow when the application is packaged.
+ */
+export declare class KioskBrowserWindow extends AppBrowserWindow {
+    constructor({ screen: target, ...options }: KioskBrowserWindowConstructorOptions, enabled?: boolean);
+}

package/dist/windows/KioskBrowserWindow.js

@@ -0,0 +1,32 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KioskBrowserWindow = void 0;
+const electron_1 = require("electron");
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+const AppBrowserWindow_1 = require("./AppBrowserWindow");
+const util_1 = require("./util");
+/**
+ * Enables kiosk mode in the BrowserWindow when the application is packaged.
+ */
+class KioskBrowserWindow extends AppBrowserWindow_1.AppBrowserWindow {
+    constructor(_a, enabled) {
+        var { screen: target = 'primary' } = _a, options = __rest(_a, ["screen"]);
+        if (enabled === void 0) { enabled = electron_1.app.isPackaged; }
+        super((0, lodash_merge_1.default)(enabled ? Object.assign({ acceptFirstMouse: true, alwaysOnTop: true, autoHideMenuBar: true, fullscreen: true, kiosk: true, minimizable: false, movable: false }, (0, util_1.getTargetDisplay)(target).bounds) : {}, options));
+    }
+}
+exports.KioskBrowserWindow = KioskBrowserWindow;

package/dist/windows/util.d.ts

@@ -0,0 +1,11 @@
+import { Display } from "electron";
+/**
+ * Looks up the target display using the 'primary' or 'secondary' notions.
+ *
+ * @param target - The display to look up. The following values are supported:
+ *  - 'primary': Get the primary display, as defined by the os.
+ *  - 'secondary': Get the first display, not set as the primary display.
+ *  - number: Returns the display at the specified index, or the primary display if not found.
+ * @returns - The specified display.
+ */
+export declare function getTargetDisplay(target: 'primary' | 'secondary' | number): Display;

package/dist/windows/util.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTargetDisplay = getTargetDisplay;
+const electron_1 = require("electron");
+/**
+ * Looks up the target display using the 'primary' or 'secondary' notions.
+ *
+ * @param target - The display to look up. The following values are supported:
+ *  - 'primary': Get the primary display, as defined by the os.
+ *  - 'secondary': Get the first display, not set as the primary display.
+ *  - number: Returns the display at the specified index, or the primary display if not found.
+ * @returns - The specified display.
+ */
+function getTargetDisplay(target) {
+    var _a, _b;
+    const displays = electron_1.screen.getAllDisplays();
+    if (target === 'primary') {
+        return electron_1.screen.getPrimaryDisplay();
+    }
+    if (target === 'secondary') {
+        const primaryId = electron_1.screen.getPrimaryDisplay().id;
+        return (_a = displays.find(d => d.id !== primaryId)) !== null && _a !== void 0 ? _a : electron_1.screen.getPrimaryDisplay();
+    }
+    return (_b = displays[target]) !== null && _b !== void 0 ? _b : electron_1.screen.getPrimaryDisplay();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dimensional-innovations/electron-background",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "the background script for electron apps",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/BrowserWindow.d.ts

@@ -1,47 +0,0 @@
-import { BrowserWindowConstructorOptions } from "electron";
-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.
- */
-export declare class DefaultBrowserWindow implements InitPlugin {
-    protected readonly options: BrowserWindowConstructorOptions;
-    /**
-     * @constructor
-     *
-     * @param options - Additional options to apply to the browser window.
-     */
-    constructor(options?: BrowserWindowConstructorOptions);
-    afterReady(context: InitContext): Promise<void>;
-    protected getDefaultWindowOptions(): BrowserWindowConstructorOptions;
-}
-/**
- * Enables kiosk mode in the BrowserWindow when the application is packaged.
- */
-export declare class KioskBrowserWindow extends DefaultBrowserWindow {
-    private readonly enabled;
-    /**
-     * @constructor
-     *
-     * @param options - Additional options to apply to the BrowserWindow.
-     * @param enableKioskMode - Indicates if the plugin is enabled. Used to disabled kiosk mode in development. Defaults to `app.isPackaged`
-     */
-    constructor(options?: BrowserWindowConstructorOptions, enabled?: boolean);
-    protected getDefaultWindowOptions(): BrowserWindowConstructorOptions;
-}
-/**
- * Ensures the browser window will always be fullscreen. Generally, KioskBrowserWindow is preferred
- * over this plugin, but there are times when app cannot be in kiosk mode.
- */
-export declare class FullScreenBrowserWindow extends DefaultBrowserWindow {
-    private readonly enabled;
-    /**
-     * @constructor
-     *
-     * @param options - Additional options to apply to the BrowserWindow.
-     * @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({ browserWindow }: BrowserWindowInitContext): Promise<void>;
-    protected getDefaultWindowOptions(): BrowserWindowConstructorOptions;
-}

package/dist/BrowserWindow.js

@@ -1,139 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        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.
- */
-class DefaultBrowserWindow {
-    /**
-     * @constructor
-     *
-     * @param options - Additional options to apply to the browser window.
-     */
-    constructor(options = {}) {
-        this.options = options;
-    }
-    afterReady(context) {
-        return __awaiter(this, void 0, void 0, function* () {
-            context.browserWindowOptions = (0, lodash_merge_1.default)({}, this.getDefaultWindowOptions(), context.browserWindowOptions, this.options, { closable: true });
-        });
-    }
-    getDefaultWindowOptions() {
-        return {
-            webPreferences: {
-                nodeIntegration: true,
-                contextIsolation: false,
-                webSecurity: false
-            }
-        };
-    }
-}
-exports.DefaultBrowserWindow = DefaultBrowserWindow;
-/**
- * Enables kiosk mode in the BrowserWindow when the application is packaged.
- */
-class KioskBrowserWindow extends DefaultBrowserWindow {
-    /**
-     * @constructor
-     *
-     * @param options - Additional options to apply to the BrowserWindow.
-     * @param enableKioskMode - Indicates if the plugin is enabled. Used to disabled kiosk mode in development. Defaults to `app.isPackaged`
-     */
-    constructor(options = {}, enabled = electron_1.app.isPackaged) {
-        super(options);
-        this.enabled = enabled;
-    }
-    getDefaultWindowOptions() {
-        if (!this.enabled) {
-            return super.getDefaultWindowOptions();
-        }
-        return Object.assign(Object.assign({}, super.getDefaultWindowOptions()), { acceptFirstMouse: true, alwaysOnTop: true, autoHideMenuBar: true, fullscreen: true, kiosk: true, minimizable: false, movable: false, x: 0, y: 0 });
-    }
-}
-exports.KioskBrowserWindow = KioskBrowserWindow;
-/**
- * Ensures the browser window will always be fullscreen. Generally, KioskBrowserWindow is preferred
- * over this plugin, but there are times when app cannot be in kiosk mode.
- */
-class FullScreenBrowserWindow extends DefaultBrowserWindow {
-    /**
-     * @constructor
-     *
-     * @param options - Additional options to apply to the BrowserWindow.
-     * @param enabled - Indicates if the plugin is enabled. Used to disable the plugin in development. Defaults to `app.isPackaged`.
-     */
-    constructor(options = {}, enabled = electron_1.app.isPackaged) {
-        super(options);
-        this.enabled = enabled;
-    }
-    beforeLoad(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ browserWindow }) {
-            if (!this.enabled) {
-                return;
-            }
-            const { screen } = yield Promise.resolve().then(() => __importStar(require('electron')));
-            const resizeWindow = () => {
-                browserWindow.setBounds(screen.getPrimaryDisplay().bounds);
-            };
-            resizeWindow();
-            screen.on('display-added', resizeWindow);
-            screen.on('display-metrics-changed', resizeWindow);
-            screen.on('display-removed', resizeWindow);
-        });
-    }
-    getDefaultWindowOptions() {
-        if (!this.enabled) {
-            return super.getDefaultWindowOptions();
-        }
-        return Object.assign(Object.assign({}, super.getDefaultWindowOptions()), { alwaysOnTop: true, resizable: false, movable: false, frame: false });
-    }
-}
-exports.FullScreenBrowserWindow = FullScreenBrowserWindow;

package/dist/PrivilegedSchemes.js

@@ -1,37 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivilegedSchemes = void 0;
-const electron_1 = require("electron");
-/**
- * Registers schemes as privileged.
- */
-class PrivilegedSchemes {
-    /**
-     * @constructor
-     *
-     * @param schemes - The schemes to register as privileged.
-     */
-    constructor(schemes) {
-        this.schemes = schemes;
-    }
-    beforeReady() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const customSchemes = this.schemes
-                .map((scheme) => ({
-                scheme,
-                privileges: { secure: true, standard: true, supportFetchAPI: true },
-            }));
-            electron_1.protocol.registerSchemesAsPrivileged(customSchemes);
-        });
-    }
-}
-exports.PrivilegedSchemes = PrivilegedSchemes;

package/dist/StaticFileDir.d.ts

@@ -1,26 +0,0 @@
-import { InitPlugin } from './init';
-/**
- * Registers a custom scheme to serve static files.
- */
-export declare class StaticFileDir implements InitPlugin {
-    private readonly scheme;
-    private readonly dir;
-    /**
-     * @constructor
-     *
-     * @param scheme - The scheme to serve the files from.
-     * @param dir - The directory where the static files are located.
-     */
-    constructor(scheme: string, dir: string);
-    afterReady(): Promise<void>;
-}
-/**
- * Wrapper around `protocol.registerFileProtocol` that serves files from the given source directory.
- * The handler will convert any url with the custom scheme to a file path in the source directory in
- * order to find the file to serve. For example, with "media" passed in for scheme and `/public` passed
- * in for sourceDirectory "media://videos/demo.mp4" would resolve to "/public/media/videos/demo.mp4".
- *
- * @param scheme - The scheme to register.
- * @param sourceDirectory - The directory where files are served from.
- */
-export declare function createFileProtocol(scheme: string, sourceDirectory: string): void;