@itwin/core-electron 3.6.1 → 3.7.0-dev.2

package/CHANGELOG.md

@@ -1,11 +1,6 @@
 # Change Log - @itwin/core-electron
 
-This log was last generated on Fri, 24 Feb 2023 22:00:48 GMT and should not be manually modified.
-
-## 3.6.1
-Fri, 24 Feb 2023 22:00:48 GMT
-
-_Version update only_
+This log was last generated on Wed, 08 Feb 2023 14:58:39 GMT and should not be manually modified.
 
 ## 3.6.0
 Wed, 08 Feb 2023 14:58:39 GMT
@@ -517,7 +512,7 @@ Fri, 30 Apr 2021 12:36:58 GMT
 ### Updates
 
 - allow authConfig to be supplied from backend
-- Fixes to desktop and iOS apps. 
+- Fixes to desktop and iOS apps.
 - Saving & restoring Electron main window size, position & maximized state
 
 ## 2.14.4
@@ -724,7 +719,7 @@ Fri, 02 Oct 2020 18:03:32 GMT
 
 ### Updates
 
-- Fixed desktop authorization after recent changes. 
+- Fixed desktop authorization after recent changes.
 
 ## 2.6.5
 Sat, 26 Sep 2020 16:06:34 GMT
@@ -848,9 +843,9 @@ Wed, 06 May 2020 13:17:49 GMT
 
 - Update to Electron 8
 - react to changes in imodeljs-clients
-- FrontendAuthorizationClient does not extend IDisposable. 
+- FrontendAuthorizationClient does not extend IDisposable.
 - Update minimum Node version to 10.16.0
-- Renamed OIDC constructs for consistency; Removed SAML support. 
+- Renamed OIDC constructs for consistency; Removed SAML support.
 - order imports.
 - Upgrade to Rush 5.23.2
 - Update electron version to ^8.2.1
@@ -876,7 +871,7 @@ Wed, 12 Feb 2020 17:45:50 GMT
 
 ### Updates
 
-- Setup oidc client for backend use in electron applications. 
+- Setup oidc client for backend use in electron applications.
 
 ## 1.11.0
 Wed, 22 Jan 2020 19:24:12 GMT
@@ -958,7 +953,7 @@ Mon, 13 May 2019 15:52:05 GMT
 
 - Adds parameter for api-extractor to validate missing release tags
 - Fix broken links
-- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization. 
+- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization.
 - Upgrade TypeDoc dependency to 0.14.2
 
 ## 0.190.0

package/lib/cjs/ElectronBackend.d.ts

@@ -1,2 +1,2 @@
-export * from "./backend/ElectronHost";
+export * from "./backend/ElectronHost";
 //# sourceMappingURL=ElectronBackend.d.ts.map

package/lib/cjs/ElectronBackend.js

@@ -1,18 +1,18 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./backend/ElectronHost"), exports);
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./backend/ElectronHost"), exports);
 //# sourceMappingURL=ElectronBackend.js.map

package/lib/cjs/ElectronBackend.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElectronBackend.js","sourceRoot":"","sources":["../../src/ElectronBackend.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,yDAAuC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./backend/ElectronHost\";\r\n"]}
+{"version":3,"file":"ElectronBackend.js","sourceRoot":"","sources":["../../src/ElectronBackend.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,yDAAuC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nexport * from \"./backend/ElectronHost\";\n"]}

package/lib/cjs/ElectronFrontend.d.ts

@@ -1,2 +1,2 @@
-export * from "./frontend/ElectronApp";
+export * from "./frontend/ElectronApp";
 //# sourceMappingURL=ElectronFrontend.d.ts.map

package/lib/cjs/ElectronFrontend.js

@@ -1,18 +1,18 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./frontend/ElectronApp"), exports);
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./frontend/ElectronApp"), exports);
 //# sourceMappingURL=ElectronFrontend.js.map

package/lib/cjs/ElectronFrontend.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElectronFrontend.js","sourceRoot":"","sources":["../../src/ElectronFrontend.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,yDAAuC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./frontend/ElectronApp\";\r\n"]}
+{"version":3,"file":"ElectronFrontend.js","sourceRoot":"","sources":["../../src/ElectronFrontend.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,yDAAuC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nexport * from \"./frontend/ElectronApp\";\n"]}

package/lib/cjs/__DOC_ONLY__.d.ts

@@ -1,4 +1,4 @@
-export * from "./backend/ElectronHost";
-export * from "./common/ElectronIpcInterface";
-export * from "./frontend/ElectronApp";
+export * from "./backend/ElectronHost";
+export * from "./common/ElectronIpcInterface";
+export * from "./frontend/ElectronApp";
 //# sourceMappingURL=__DOC_ONLY__.d.ts.map

package/lib/cjs/__DOC_ONLY__.js

@@ -1,23 +1,23 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// THIS FILE EXISTS ONLY FOR DOCUMENTATION GENERATION.
-// It imports both frontend and backend code, which is not legal anywhere.
-// Do not import it in real code!
-__exportStar(require("./backend/ElectronHost"), exports);
-__exportStar(require("./common/ElectronIpcInterface"), exports);
-__exportStar(require("./frontend/ElectronApp"), exports);
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// THIS FILE EXISTS ONLY FOR DOCUMENTATION GENERATION.
+// It imports both frontend and backend code, which is not legal anywhere.
+// Do not import it in real code!
+__exportStar(require("./backend/ElectronHost"), exports);
+__exportStar(require("./common/ElectronIpcInterface"), exports);
+__exportStar(require("./frontend/ElectronApp"), exports);
 //# sourceMappingURL=__DOC_ONLY__.js.map

package/lib/cjs/__DOC_ONLY__.js.map

@@ -1 +1 @@
-{"version":3,"file":"__DOC_ONLY__.js","sourceRoot":"","sources":["../../src/__DOC_ONLY__.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,sDAAsD;AACtD,0EAA0E;AAC1E,iCAAiC;AAEjC,yDAAuC;AACvC,gEAA8C;AAC9C,yDAAuC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n// THIS FILE EXISTS ONLY FOR DOCUMENTATION GENERATION.\r\n// It imports both frontend and backend code, which is not legal anywhere.\r\n// Do not import it in real code!\r\n\r\nexport * from \"./backend/ElectronHost\";\r\nexport * from \"./common/ElectronIpcInterface\";\r\nexport * from \"./frontend/ElectronApp\";\r\n"]}
+{"version":3,"file":"__DOC_ONLY__.js","sourceRoot":"","sources":["../../src/__DOC_ONLY__.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,sDAAsD;AACtD,0EAA0E;AAC1E,iCAAiC;AAEjC,yDAAuC;AACvC,gEAA8C;AAC9C,yDAAuC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n// THIS FILE EXISTS ONLY FOR DOCUMENTATION GENERATION.\n// It imports both frontend and backend code, which is not legal anywhere.\n// Do not import it in real code!\n\nexport * from \"./backend/ElectronHost\";\nexport * from \"./common/ElectronIpcInterface\";\nexport * from \"./frontend/ElectronApp\";\n"]}

package/lib/cjs/backend/ElectronHost.d.ts

@@ -1,105 +1,105 @@
-import type { BrowserWindow, BrowserWindowConstructorOptions } from "electron";
-import type * as ElectronModule from "electron";
-import { IpcHandler, NativeHostOpts } from "@itwin/core-backend";
-import { RpcConfiguration, RpcInterfaceDefinition } from "@itwin/core-common";
-/**
- * Options for  [[ElectronHost.startup]]
- * @beta
- */
-export interface ElectronHostOptions {
-    /** the path to find web resources  */
-    webResourcesPath?: string;
-    /** filename for the app's icon, relative to [[webResourcesPath]] */
-    iconName?: string;
-    /** name of frontend url to open.  */
-    frontendURL?: string;
-    /** use a development server rather than the "electron" protocol for loading frontend (see https://www.electronjs.org/docs/api/protocol) */
-    developmentServer?: boolean;
-    /** port number for development server. Default is 3000 */
-    frontendPort?: number;
-    /** list of RPC interface definitions to register */
-    rpcInterfaces?: RpcInterfaceDefinition[];
-    /** list of [IpcHandler]($common) classes to register */
-    ipcHandlers?: (typeof IpcHandler)[];
-}
-/** @beta */
-export interface ElectronHostOpts extends NativeHostOpts {
-    electronHost?: ElectronHostOptions;
-}
-/** @beta */
-export interface ElectronHostWindowOptions extends BrowserWindowConstructorOptions {
-    storeWindowName?: string;
-    /** The style of window title bar. Default is `default`. */
-    titleBarStyle?: ("default" | "hidden" | "hiddenInset" | "customButtonsOnHover");
-}
-/** the size and position of a window as stored in the settings file.
- * @beta
- */
-export interface WindowSizeAndPositionProps {
-    width: number;
-    height: number;
-    x: number;
-    y: number;
-}
-/**
- * The backend for Electron-based desktop applications
- * @beta
- */
-export declare class ElectronHost {
-    private static readonly _deprecatedSizeAndPosStoreKey;
-    private static readonly _sizeAndPosStoreKey;
-    private static _ipc;
-    private static _developmentServer;
-    private static _electron;
-    private static _electronFrontend;
-    private static _mainWindow?;
-    static webResourcesPath: string;
-    static appIconPath: string;
-    static frontendURL: string;
-    static rpcConfig: RpcConfiguration;
-    static get ipcMain(): Electron.IpcMain;
-    static get app(): Electron.App;
-    static get electron(): typeof ElectronModule;
-    private constructor();
-    /**
-     * Converts an "electron://frontend/" URL to an absolute file path.
-     *
-     * We use this protocol in production builds because our frontend must be built with absolute URLs,
-     * however, since we're loading everything directly from the install directory, we cannot know the
-     * absolute path at build time.
-     */
-    private static parseElectronUrl;
-    private static _openWindow;
-    /** The "main" BrowserWindow for this application. */
-    static get mainWindow(): BrowserWindow | undefined;
-    /**
-     * Gets window size and position for a window, by name, from settings file, if present.
-     * @note Size and position values in the settings file will be updated differently depending on platform.
-     *       On Linux values are only updated on window "unmaximize".
-     *       On Windows and MacOS values are also updated on window manual resize or move.
-     *       To get consistent behavior across different platforms, use [[ElectronHost.getWindowSizeAndPositionSetting]].
-     * @deprecated in 3.6. Use [[ElectronHost.getWindowSizeAndPositionSetting]].
-     */
-    static getWindowSizeSetting(windowName: string): WindowSizeAndPositionProps | undefined;
-    /**
-     * Gets window size and position for a window, by name, from settings file, if present.
-     */
-    static getWindowSizeAndPositionSetting(windowName: string): WindowSizeAndPositionProps | undefined;
-    /** Gets "window maximized" flag for a window, by name, from settings file if present */
-    static getWindowMaximizedSetting(windowName: string): boolean | undefined;
-    /**
-     * Open the main Window when the app is ready.
-     * @param windowOptions Options for constructing the main BrowserWindow. See: https://electronjs.org/docs/api/browser-window#new-browserwindowoptions
-     */
-    static openMainWindow(windowOptions?: ElectronHostWindowOptions): Promise<void>;
-    static get isValid(): boolean;
-    /**
-     * Initialize the backend of an Electron app.
-     * This method configures the backend for all of the inter-process communication (RPC and IPC) for an
-     * Electron app. It should be called from your Electron main function.
-     * @param opts Options that control aspects of your backend.
-     * @note This method must only be called from the backend of an Electron app (i.e. when [ProcessDetector.isElectronAppBackend]($bentley) is `true`).
-     */
-    static startup(opts?: ElectronHostOpts): Promise<void>;
-}
+import type { BrowserWindow, BrowserWindowConstructorOptions } from "electron";
+import type * as ElectronModule from "electron";
+import { IpcHandler, NativeHostOpts } from "@itwin/core-backend";
+import { RpcConfiguration, RpcInterfaceDefinition } from "@itwin/core-common";
+/**
+ * Options for  [[ElectronHost.startup]]
+ * @beta
+ */
+export interface ElectronHostOptions {
+    /** the path to find web resources  */
+    webResourcesPath?: string;
+    /** filename for the app's icon, relative to [[webResourcesPath]] */
+    iconName?: string;
+    /** name of frontend url to open.  */
+    frontendURL?: string;
+    /** use a development server rather than the "electron" protocol for loading frontend (see https://www.electronjs.org/docs/api/protocol) */
+    developmentServer?: boolean;
+    /** port number for development server. Default is 3000 */
+    frontendPort?: number;
+    /** list of RPC interface definitions to register */
+    rpcInterfaces?: RpcInterfaceDefinition[];
+    /** list of [IpcHandler]($common) classes to register */
+    ipcHandlers?: (typeof IpcHandler)[];
+}
+/** @beta */
+export interface ElectronHostOpts extends NativeHostOpts {
+    electronHost?: ElectronHostOptions;
+}
+/** @beta */
+export interface ElectronHostWindowOptions extends BrowserWindowConstructorOptions {
+    storeWindowName?: string;
+    /** The style of window title bar. Default is `default`. */
+    titleBarStyle?: ("default" | "hidden" | "hiddenInset" | "customButtonsOnHover");
+}
+/** the size and position of a window as stored in the settings file.
+ * @beta
+ */
+export interface WindowSizeAndPositionProps {
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+}
+/**
+ * The backend for Electron-based desktop applications
+ * @beta
+ */
+export declare class ElectronHost {
+    private static readonly _deprecatedSizeAndPosStoreKey;
+    private static readonly _sizeAndPosStoreKey;
+    private static _ipc;
+    private static _developmentServer;
+    private static _electron;
+    private static _electronFrontend;
+    private static _mainWindow?;
+    static webResourcesPath: string;
+    static appIconPath: string;
+    static frontendURL: string;
+    static rpcConfig: RpcConfiguration;
+    static get ipcMain(): Electron.IpcMain;
+    static get app(): Electron.App;
+    static get electron(): typeof ElectronModule;
+    private constructor();
+    /**
+     * Converts an "electron://frontend/" URL to an absolute file path.
+     *
+     * We use this protocol in production builds because our frontend must be built with absolute URLs,
+     * however, since we're loading everything directly from the install directory, we cannot know the
+     * absolute path at build time.
+     */
+    private static parseElectronUrl;
+    private static _openWindow;
+    /** The "main" BrowserWindow for this application. */
+    static get mainWindow(): BrowserWindow | undefined;
+    /**
+     * Gets window size and position for a window, by name, from settings file, if present.
+     * @note Size and position values in the settings file will be updated differently depending on platform.
+     *       On Linux values are only updated on window "unmaximize".
+     *       On Windows and MacOS values are also updated on window manual resize or move.
+     *       To get consistent behavior across different platforms, use [[ElectronHost.getWindowSizeAndPositionSetting]].
+     * @deprecated in 3.6. Use [[ElectronHost.getWindowSizeAndPositionSetting]].
+     */
+    static getWindowSizeSetting(windowName: string): WindowSizeAndPositionProps | undefined;
+    /**
+     * Gets window size and position for a window, by name, from settings file, if present.
+     */
+    static getWindowSizeAndPositionSetting(windowName: string): WindowSizeAndPositionProps | undefined;
+    /** Gets "window maximized" flag for a window, by name, from settings file if present */
+    static getWindowMaximizedSetting(windowName: string): boolean | undefined;
+    /**
+     * Open the main Window when the app is ready.
+     * @param windowOptions Options for constructing the main BrowserWindow. See: https://electronjs.org/docs/api/browser-window#new-browserwindowoptions
+     */
+    static openMainWindow(windowOptions?: ElectronHostWindowOptions): Promise<void>;
+    static get isValid(): boolean;
+    /**
+     * Initialize the backend of an Electron app.
+     * This method configures the backend for all of the inter-process communication (RPC and IPC) for an
+     * Electron app. It should be called from your Electron main function.
+     * @param opts Options that control aspects of your backend.
+     * @note This method must only be called from the backend of an Electron app (i.e. when [ProcessDetector.isElectronAppBackend]($bentley) is `true`).
+     */
+    static startup(opts?: ElectronHostOpts): Promise<void>;
+}
 //# sourceMappingURL=ElectronHost.d.ts.map