@itwin/core-electron 4.0.0-dev.1 → 4.0.0-dev.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/CHANGELOG.md +59 -1
  2. package/lib/cjs/ElectronBackend.d.ts +1 -1
  3. package/lib/cjs/ElectronBackend.js +21 -17
  4. package/lib/cjs/ElectronBackend.js.map +1 -1
  5. package/lib/cjs/ElectronFrontend.d.ts +1 -1
  6. package/lib/cjs/ElectronFrontend.js +21 -17
  7. package/lib/cjs/ElectronFrontend.js.map +1 -1
  8. package/lib/cjs/__DOC_ONLY__.d.ts +19 -3
  9. package/lib/cjs/__DOC_ONLY__.d.ts.map +1 -1
  10. package/lib/cjs/__DOC_ONLY__.js +42 -22
  11. package/lib/cjs/__DOC_ONLY__.js.map +1 -1
  12. package/lib/cjs/backend/ElectronHost.d.ts +107 -104
  13. package/lib/cjs/backend/ElectronHost.d.ts.map +1 -1
  14. package/lib/cjs/backend/ElectronHost.js +240 -243
  15. package/lib/cjs/backend/ElectronHost.js.map +1 -1
  16. package/lib/cjs/backend/ElectronPreload.d.ts +1 -1
  17. package/lib/cjs/backend/ElectronPreload.js +39 -39
  18. package/lib/cjs/backend/ElectronPreload.js.map +1 -1
  19. package/lib/cjs/common/ElectronIpcInterface.d.ts +10 -7
  20. package/lib/cjs/common/ElectronIpcInterface.d.ts.map +1 -1
  21. package/lib/cjs/common/ElectronIpcInterface.js +12 -5
  22. package/lib/cjs/common/ElectronIpcInterface.js.map +1 -1
  23. package/lib/cjs/common/ElectronIpcTransport.d.ts +44 -44
  24. package/lib/cjs/common/ElectronIpcTransport.js +186 -186
  25. package/lib/cjs/common/ElectronIpcTransport.js.map +1 -1
  26. package/lib/cjs/common/ElectronPush.d.ts +17 -20
  27. package/lib/cjs/common/ElectronPush.d.ts.map +1 -1
  28. package/lib/cjs/common/ElectronPush.js +45 -48
  29. package/lib/cjs/common/ElectronPush.js.map +1 -1
  30. package/lib/cjs/common/ElectronRpcManager.d.ts +23 -26
  31. package/lib/cjs/common/ElectronRpcManager.d.ts.map +1 -1
  32. package/lib/cjs/common/ElectronRpcManager.js +56 -65
  33. package/lib/cjs/common/ElectronRpcManager.js.map +1 -1
  34. package/lib/cjs/common/ElectronRpcProtocol.d.ts +34 -34
  35. package/lib/cjs/common/ElectronRpcProtocol.js +58 -58
  36. package/lib/cjs/common/ElectronRpcProtocol.js.map +1 -1
  37. package/lib/cjs/common/ElectronRpcRequest.d.ts +19 -19
  38. package/lib/cjs/common/ElectronRpcRequest.js +56 -56
  39. package/lib/cjs/common/ITwinElectronApi.d.ts +13 -10
  40. package/lib/cjs/common/ITwinElectronApi.d.ts.map +1 -1
  41. package/lib/cjs/common/ITwinElectronApi.js +6 -6
  42. package/lib/cjs/common/ITwinElectronApi.js.map +1 -1
  43. package/lib/cjs/frontend/ElectronApp.d.ts +38 -35
  44. package/lib/cjs/frontend/ElectronApp.d.ts.map +1 -1
  45. package/lib/cjs/frontend/ElectronApp.js +76 -75
  46. package/lib/cjs/frontend/ElectronApp.js.map +1 -1
  47. package/package.json +27 -29
  48. package/lib/cjs/common/ElectronManagerLoggerCategory.d.ts +0 -11
  49. package/lib/cjs/common/ElectronManagerLoggerCategory.d.ts.map +0 -1
  50. package/lib/cjs/common/ElectronManagerLoggerCategory.js +0 -19
  51. package/lib/cjs/common/ElectronManagerLoggerCategory.js.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"ITwinElectronApi.js","sourceRoot":"","sources":["../../../src/common/ITwinElectronApi.ts"],"names":[],"mappings":";AAAA;;;+FAG+F","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\nimport type { IpcRendererEvent } from \"electron\";\r\n\r\n/** These methods are stored on `window.itwinjs` */\r\nexport interface ITwinElectronApi {\r\n addListener: (channel: string, listener: ElectronListener) => void;\r\n removeListener: (channel: string, listener: ElectronListener) => void;\r\n invoke: (channel: string, ...data: any[]) => Promise<any>;\r\n once: (channel: string, listener: (event: any, ...args: any[]) => void) => void;\r\n send: (channel: string, ...data: any[]) => void; // only valid for render -> main\r\n}\r\n\r\nexport type ElectronListener = (event: IpcRendererEvent, ...args: any[]) => void;\r\n"]}
1
+ {"version":3,"file":"ITwinElectronApi.js","sourceRoot":"","sources":["../../../src/common/ITwinElectronApi.ts"],"names":[],"mappings":";AAAA;;;+FAG+F","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/** @packageDocumentation\r\n * @module RpcInterface\r\n */\r\n\r\nimport type { IpcRendererEvent } from \"electron\";\r\n\r\n/** These methods are stored on `window.itwinjs` */\r\nexport interface ITwinElectronApi {\r\n addListener: (channel: string, listener: ElectronListener) => void;\r\n removeListener: (channel: string, listener: ElectronListener) => void;\r\n invoke: (channel: string, ...data: any[]) => Promise<any>;\r\n once: (channel: string, listener: (event: any, ...args: any[]) => void) => void;\r\n send: (channel: string, ...data: any[]) => void; // only valid for render -> main\r\n}\r\n\r\nexport type ElectronListener = (event: IpcRendererEvent, ...args: any[]) => void;\r\n"]}
@@ -1,36 +1,39 @@
1
- import { PromiseReturnType } from "@itwin/core-bentley";
2
- import { NativeAppOpts } from "@itwin/core-frontend";
3
- import { DialogModuleMethod } from "../common/ElectronIpcInterface";
4
- import type { ITwinElectronApi } from "../common/ITwinElectronApi";
5
- declare global {
6
- interface Window {
7
- itwinjs: ITwinElectronApi;
8
- }
9
- }
10
- /** @beta */
11
- export declare type ElectronAppOpts = NativeAppOpts;
12
- /**
13
- * Frontend of an Electron App.
14
- * @beta
15
- */
16
- export declare class ElectronApp {
17
- private static _ipc?;
18
- static get isValid(): boolean;
19
- /**
20
- * Start the frontend of an Electron application.
21
- * @param opts Options for your ElectronApp
22
- * @note This method must only be called from the frontend of an Electron app (i.e. when [ProcessDetector.isElectronAppFrontend]($bentley) is `true`).
23
- */
24
- static startup(opts?: ElectronAppOpts): Promise<void>;
25
- static shutdown(): Promise<void>;
26
- /**
27
- * Call an asynchronous method in the [Electron.Dialog](https://www.electronjs.org/docs/api/dialog) interface from a previously initialized ElectronFrontend.
28
- * @param methodName the name of the method to call
29
- * @param args arguments to method
30
- * @deprecated in 3.x. use [[dialogIpc]]
31
- */
32
- static callDialog<T extends DialogModuleMethod>(methodName: T, ...args: Parameters<Electron.Dialog[T]>): Promise<PromiseReturnType<Electron.Dialog[T]>>;
33
- /** Proxy object for calling methods of `Electron.Dialog` */
34
- static dialogIpc: import("@itwin/core-bentley").PickAsyncMethods<Electron.Dialog>;
35
- }
1
+ /** @packageDocumentation
2
+ * @module Renderer
3
+ */
4
+ import { PromiseReturnType } from "@itwin/core-bentley";
5
+ import { NativeAppOpts } from "@itwin/core-frontend";
6
+ import { DialogModuleMethod } from "../common/ElectronIpcInterface";
7
+ import type { ITwinElectronApi } from "../common/ITwinElectronApi";
8
+ declare global {
9
+ interface Window {
10
+ itwinjs: ITwinElectronApi;
11
+ }
12
+ }
13
+ /** @beta */
14
+ export type ElectronAppOpts = NativeAppOpts;
15
+ /**
16
+ * Frontend of an Electron App.
17
+ * @beta
18
+ */
19
+ export declare class ElectronApp {
20
+ private static _ipc?;
21
+ static get isValid(): boolean;
22
+ /**
23
+ * Start the frontend of an Electron application.
24
+ * @param opts Options for your ElectronApp
25
+ * @note This method must only be called from the frontend of an Electron app (i.e. when [ProcessDetector.isElectronAppFrontend]($bentley) is `true`).
26
+ */
27
+ static startup(opts?: ElectronAppOpts): Promise<void>;
28
+ static shutdown(): Promise<void>;
29
+ /**
30
+ * Call an asynchronous method in the [Electron.Dialog](https://www.electronjs.org/docs/api/dialog) interface from a previously initialized ElectronFrontend.
31
+ * @param methodName the name of the method to call
32
+ * @param args arguments to method
33
+ * @deprecated in 3.x. use [[dialogIpc]]
34
+ */
35
+ static callDialog<T extends DialogModuleMethod>(methodName: T, ...args: Parameters<Electron.Dialog[T]>): Promise<PromiseReturnType<Electron.Dialog[T]>>;
36
+ /** Proxy object for calling methods of `Electron.Dialog` */
37
+ static dialogIpc: import("@itwin/core-bentley").PickAsyncMethods<Electron.Dialog>;
38
+ }
36
39
  //# sourceMappingURL=ElectronApp.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ElectronApp.d.ts","sourceRoot":"","sources":["../../../src/frontend/ElectronApp.ts"],"names":[],"mappings":"AAIA,OAAO,EAAmB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAqB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAiB,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEnF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,OAAO,EAAE,gBAAgB,CAAC;KAC3B;CACF;AA4BD,YAAY;AACZ,oBAAY,eAAe,GAAG,aAAa,CAAC;AAE5C;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAc;IAClC,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;OAIG;WACiB,OAAO,CAAC,IAAI,CAAC,EAAE,eAAe;WAU9B,QAAQ;IAM5B;;;;;OAKG;WACiB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAInH,4DAA4D;IAC5D,OAAc,SAAS,kEAA6E;CACrG"}
1
+ {"version":3,"file":"ElectronApp.d.ts","sourceRoot":"","sources":["../../../src/frontend/ElectronApp.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAmB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAqB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAiB,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEnF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,OAAO,EAAE,gBAAgB,CAAC;KAC3B;CACF;AA4BD,YAAY;AACZ,MAAM,MAAM,eAAe,GAAG,aAAa,CAAC;AAE5C;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAc;IAClC,WAAkB,OAAO,IAAI,OAAO,CAAoC;IAExE;;;;OAIG;WACiB,OAAO,CAAC,IAAI,CAAC,EAAE,eAAe;WAU9B,QAAQ;IAM5B;;;;;OAKG;WACiB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAInH,4DAA4D;IAC5D,OAAc,SAAS,kEAA6E;CACrG"}
@@ -1,76 +1,77 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ElectronApp = void 0;
4
- /*---------------------------------------------------------------------------------------------
5
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
6
- * See LICENSE.md in the project root for license terms and full copyright notice.
7
- *--------------------------------------------------------------------------------------------*/
8
- const core_bentley_1 = require("@itwin/core-bentley");
9
- const core_frontend_1 = require("@itwin/core-frontend");
10
- const ElectronIpcInterface_1 = require("../common/ElectronIpcInterface");
11
- const ElectronRpcManager_1 = require("../common/ElectronRpcManager");
12
- /**
13
- * Frontend Ipc support for Electron apps.
14
- */
15
- class ElectronIpc {
16
- constructor() {
17
- var _a;
18
- // use the methods on window.itwinjs exposed by ElectronPreload.ts, or ipcRenderer directly if running with nodeIntegration=true (**only** for tests).
19
- // Note that `require("electron")` doesn't work with nodeIntegration=false - that's what it stops
20
- // eslint-disable-next-line @typescript-eslint/no-var-requires
21
- this._api = (_a = window.itwinjs) !== null && _a !== void 0 ? _a : require("electron").ipcRenderer;
22
- }
23
- addListener(channelName, listener) {
24
- this._api.addListener(channelName, listener);
25
- return () => this._api.removeListener(channelName, listener);
26
- }
27
- removeListener(channelName, listener) {
28
- this._api.removeListener(channelName, listener);
29
- }
30
- send(channel, ...data) {
31
- this._api.send(channel, ...data);
32
- }
33
- async invoke(channel, ...args) {
34
- return this._api.invoke(channel, ...args);
35
- }
36
- }
37
- /**
38
- * Frontend of an Electron App.
39
- * @beta
40
- */
41
- class ElectronApp {
42
- static get isValid() { return undefined !== this._ipc; }
43
- /**
44
- * Start the frontend of an Electron application.
45
- * @param opts Options for your ElectronApp
46
- * @note This method must only be called from the frontend of an Electron app (i.e. when [ProcessDetector.isElectronAppFrontend]($bentley) is `true`).
47
- */
48
- static async startup(opts) {
49
- var _a;
50
- if (!core_bentley_1.ProcessDetector.isElectronAppFrontend)
51
- throw new Error("Not running under Electron");
52
- if (!this.isValid) {
53
- this._ipc = new ElectronIpc();
54
- ElectronRpcManager_1.ElectronRpcManager.initializeFrontend(this._ipc, (_a = opts === null || opts === void 0 ? void 0 : opts.iModelApp) === null || _a === void 0 ? void 0 : _a.rpcInterfaces);
55
- }
56
- await core_frontend_1.NativeApp.startup(this._ipc, opts);
57
- }
58
- static async shutdown() {
59
- this._ipc = undefined;
60
- await core_frontend_1.NativeApp.shutdown();
61
- ElectronRpcManager_1.ElectronRpcManager.terminateFrontend();
62
- }
63
- /**
64
- * Call an asynchronous method in the [Electron.Dialog](https://www.electronjs.org/docs/api/dialog) interface from a previously initialized ElectronFrontend.
65
- * @param methodName the name of the method to call
66
- * @param args arguments to method
67
- * @deprecated in 3.x. use [[dialogIpc]]
68
- */
69
- static async callDialog(methodName, ...args) {
70
- return core_frontend_1.IpcApp.callIpcChannel(ElectronIpcInterface_1.dialogChannel, "callDialog", methodName, ...args);
71
- }
72
- }
73
- exports.ElectronApp = ElectronApp;
74
- /** Proxy object for calling methods of `Electron.Dialog` */
75
- ElectronApp.dialogIpc = core_frontend_1.IpcApp.makeIpcFunctionProxy(ElectronIpcInterface_1.dialogChannel, "callDialog");
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.ElectronApp = void 0;
8
+ /** @packageDocumentation
9
+ * @module Renderer
10
+ */
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_frontend_1 = require("@itwin/core-frontend");
13
+ const ElectronIpcInterface_1 = require("../common/ElectronIpcInterface");
14
+ const ElectronRpcManager_1 = require("../common/ElectronRpcManager");
15
+ /**
16
+ * Frontend Ipc support for Electron apps.
17
+ */
18
+ class ElectronIpc {
19
+ addListener(channelName, listener) {
20
+ this._api.addListener(channelName, listener);
21
+ return () => this._api.removeListener(channelName, listener);
22
+ }
23
+ removeListener(channelName, listener) {
24
+ this._api.removeListener(channelName, listener);
25
+ }
26
+ send(channel, ...data) {
27
+ this._api.send(channel, ...data);
28
+ }
29
+ async invoke(channel, ...args) {
30
+ return this._api.invoke(channel, ...args);
31
+ }
32
+ constructor() {
33
+ // use the methods on window.itwinjs exposed by ElectronPreload.ts, or ipcRenderer directly if running with nodeIntegration=true (**only** for tests).
34
+ // Note that `require("electron")` doesn't work with nodeIntegration=false - that's what it stops
35
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
36
+ this._api = window.itwinjs ?? require("electron").ipcRenderer;
37
+ }
38
+ }
39
+ /**
40
+ * Frontend of an Electron App.
41
+ * @beta
42
+ */
43
+ class ElectronApp {
44
+ static get isValid() { return undefined !== this._ipc; }
45
+ /**
46
+ * Start the frontend of an Electron application.
47
+ * @param opts Options for your ElectronApp
48
+ * @note This method must only be called from the frontend of an Electron app (i.e. when [ProcessDetector.isElectronAppFrontend]($bentley) is `true`).
49
+ */
50
+ static async startup(opts) {
51
+ if (!core_bentley_1.ProcessDetector.isElectronAppFrontend)
52
+ throw new Error("Not running under Electron");
53
+ if (!this.isValid) {
54
+ this._ipc = new ElectronIpc();
55
+ ElectronRpcManager_1.ElectronRpcManager.initializeFrontend(this._ipc, opts?.iModelApp?.rpcInterfaces); // eslint-disable-line deprecation/deprecation
56
+ }
57
+ await core_frontend_1.NativeApp.startup(this._ipc, opts);
58
+ }
59
+ static async shutdown() {
60
+ this._ipc = undefined;
61
+ await core_frontend_1.NativeApp.shutdown();
62
+ ElectronRpcManager_1.ElectronRpcManager.terminateFrontend();
63
+ }
64
+ /**
65
+ * Call an asynchronous method in the [Electron.Dialog](https://www.electronjs.org/docs/api/dialog) interface from a previously initialized ElectronFrontend.
66
+ * @param methodName the name of the method to call
67
+ * @param args arguments to method
68
+ * @deprecated in 3.x. use [[dialogIpc]]
69
+ */
70
+ static async callDialog(methodName, ...args) {
71
+ return core_frontend_1.IpcApp.callIpcChannel(ElectronIpcInterface_1.dialogChannel, "callDialog", methodName, ...args);
72
+ }
73
+ }
74
+ /** Proxy object for calling methods of `Electron.Dialog` */
75
+ ElectronApp.dialogIpc = core_frontend_1.IpcApp.makeIpcFunctionProxy(ElectronIpcInterface_1.dialogChannel, "callDialog");
76
+ exports.ElectronApp = ElectronApp;
76
77
  //# sourceMappingURL=ElectronApp.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"ElectronApp.js","sourceRoot":"","sources":["../../../src/frontend/ElectronApp.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,sDAAyE;AAEzE,wDAAwE;AAExE,yEAAmF;AACnF,qEAAkE;AASlE;;GAEG;AACH,MAAM,WAAW;IAef;;QACE,sJAAsJ;QACtJ,iGAAiG;QACjG,8DAA8D;QAC9D,IAAI,CAAC,IAAI,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC;IAChE,CAAC;IAlBM,WAAW,CAAC,WAAmB,EAAE,QAAqB;QAC3D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IACM,cAAc,CAAC,WAAmB,EAAE,QAAqB;QAC9D,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IACM,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IACM,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAG,IAAW;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;CAOF;AAKD;;;GAGG;AACH,MAAa,WAAW;IAEf,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAsB;;QAChD,IAAI,CAAC,8BAAe,CAAC,qBAAqB;YACxC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,uCAAkB,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,0CAAE,aAAa,CAAC,CAAC;SAClF;QACD,MAAM,yBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,yBAAS,CAAC,QAAQ,EAAE,CAAC;QAC3B,uCAAkB,CAAC,iBAAiB,EAAE,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAA+B,UAAa,EAAE,GAAG,IAAoC;QACjH,OAAO,sBAAM,CAAC,cAAc,CAAC,oCAAa,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAA0C,CAAC;IAC1H,CAAC;;AAjCH,kCAqCC;AAFC,4DAA4D;AAC9C,qBAAS,GAAG,sBAAM,CAAC,oBAAoB,CAAkB,oCAAa,EAAE,YAAY,CAAC,CAAC","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\nimport { ProcessDetector, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport { IpcListener, IpcSocketFrontend } from \"@itwin/core-common\";\r\nimport { IpcApp, NativeApp, NativeAppOpts } from \"@itwin/core-frontend\";\r\nimport type { IpcRenderer } from \"electron\";\r\nimport { dialogChannel, DialogModuleMethod } from \"../common/ElectronIpcInterface\";\r\nimport { ElectronRpcManager } from \"../common/ElectronRpcManager\";\r\nimport type { ITwinElectronApi } from \"../common/ITwinElectronApi\";\r\n\r\ndeclare global {\r\n interface Window {\r\n itwinjs: ITwinElectronApi;\r\n }\r\n}\r\n\r\n/**\r\n * Frontend Ipc support for Electron apps.\r\n */\r\nclass ElectronIpc implements IpcSocketFrontend {\r\n private _api: ITwinElectronApi | IpcRenderer;\r\n public addListener(channelName: string, listener: IpcListener) {\r\n this._api.addListener(channelName, listener);\r\n return () => this._api.removeListener(channelName, listener);\r\n }\r\n public removeListener(channelName: string, listener: IpcListener) {\r\n this._api.removeListener(channelName, listener);\r\n }\r\n public send(channel: string, ...data: any[]) {\r\n this._api.send(channel, ...data);\r\n }\r\n public async invoke(channel: string, ...args: any[]) {\r\n return this._api.invoke(channel, ...args);\r\n }\r\n constructor() {\r\n // use the methods on window.itwinjs exposed by ElectronPreload.ts, or ipcRenderer directly if running with nodeIntegration=true (**only** for tests).\r\n // Note that `require(\"electron\")` doesn't work with nodeIntegration=false - that's what it stops\r\n // eslint-disable-next-line @typescript-eslint/no-var-requires\r\n this._api = window.itwinjs ?? require(\"electron\").ipcRenderer;\r\n }\r\n}\r\n\r\n/** @beta */\r\nexport type ElectronAppOpts = NativeAppOpts;\r\n\r\n/**\r\n * Frontend of an Electron App.\r\n * @beta\r\n */\r\nexport class ElectronApp {\r\n private static _ipc?: ElectronIpc;\r\n public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n /**\r\n * Start the frontend of an Electron application.\r\n * @param opts Options for your ElectronApp\r\n * @note This method must only be called from the frontend of an Electron app (i.e. when [ProcessDetector.isElectronAppFrontend]($bentley) is `true`).\r\n */\r\n public static async startup(opts?: ElectronAppOpts) {\r\n if (!ProcessDetector.isElectronAppFrontend)\r\n throw new Error(\"Not running under Electron\");\r\n if (!this.isValid) {\r\n this._ipc = new ElectronIpc();\r\n ElectronRpcManager.initializeFrontend(this._ipc, opts?.iModelApp?.rpcInterfaces);\r\n }\r\n await NativeApp.startup(this._ipc!, opts);\r\n }\r\n\r\n public static async shutdown() {\r\n this._ipc = undefined;\r\n await NativeApp.shutdown();\r\n ElectronRpcManager.terminateFrontend();\r\n }\r\n\r\n /**\r\n * Call an asynchronous method in the [Electron.Dialog](https://www.electronjs.org/docs/api/dialog) interface from a previously initialized ElectronFrontend.\r\n * @param methodName the name of the method to call\r\n * @param args arguments to method\r\n * @deprecated in 3.x. use [[dialogIpc]]\r\n */\r\n public static async callDialog<T extends DialogModuleMethod>(methodName: T, ...args: Parameters<Electron.Dialog[T]>) {\r\n return IpcApp.callIpcChannel(dialogChannel, \"callDialog\", methodName, ...args) as PromiseReturnType<Electron.Dialog[T]>;\r\n }\r\n\r\n /** Proxy object for calling methods of `Electron.Dialog` */\r\n public static dialogIpc = IpcApp.makeIpcFunctionProxy<Electron.Dialog>(dialogChannel, \"callDialog\");\r\n}\r\n"]}
1
+ {"version":3,"file":"ElectronApp.js","sourceRoot":"","sources":["../../../src/frontend/ElectronApp.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH,sDAAyE;AAEzE,wDAAwE;AAExE,yEAAmF;AACnF,qEAAkE;AASlE;;GAEG;AACH,MAAM,WAAW;IAER,WAAW,CAAC,WAAmB,EAAE,QAAqB;QAC3D,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;IACM,cAAc,CAAC,WAAmB,EAAE,QAAqB;QAC9D,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IACM,IAAI,CAAC,OAAe,EAAE,GAAG,IAAW;QACzC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IACM,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,GAAG,IAAW;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAC5C,CAAC;IACD;QACE,sJAAsJ;QACtJ,iGAAiG;QACjG,8DAA8D;QAC9D,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC;IAChE,CAAC;CACF;AAKD;;;GAGG;AACH,MAAa,WAAW;IAEf,MAAM,KAAK,OAAO,KAAc,OAAO,SAAS,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAsB;QAChD,IAAI,CAAC,8BAAe,CAAC,qBAAqB;YACxC,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,uCAAkB,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,8CAA8C;SACjI;QACD,MAAM,yBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,QAAQ;QAC1B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,MAAM,yBAAS,CAAC,QAAQ,EAAE,CAAC;QAC3B,uCAAkB,CAAC,iBAAiB,EAAE,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAA+B,UAAa,EAAE,GAAG,IAAoC;QACjH,OAAO,sBAAM,CAAC,cAAc,CAAC,oCAAa,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,IAAI,CAA0C,CAAC;IAC1H,CAAC;;AAED,4DAA4D;AAC9C,qBAAS,GAAG,sBAAM,CAAC,oBAAoB,CAAkB,oCAAa,EAAE,YAAY,CAAC,CAAC;AApCzF,kCAAW","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/** @packageDocumentation\r\n * @module Renderer\r\n */\r\n\r\nimport { ProcessDetector, PromiseReturnType } from \"@itwin/core-bentley\";\r\nimport { IpcListener, IpcSocketFrontend } from \"@itwin/core-common\";\r\nimport { IpcApp, NativeApp, NativeAppOpts } from \"@itwin/core-frontend\";\r\nimport type { IpcRenderer } from \"electron\";\r\nimport { dialogChannel, DialogModuleMethod } from \"../common/ElectronIpcInterface\";\r\nimport { ElectronRpcManager } from \"../common/ElectronRpcManager\";\r\nimport type { ITwinElectronApi } from \"../common/ITwinElectronApi\";\r\n\r\ndeclare global {\r\n interface Window {\r\n itwinjs: ITwinElectronApi;\r\n }\r\n}\r\n\r\n/**\r\n * Frontend Ipc support for Electron apps.\r\n */\r\nclass ElectronIpc implements IpcSocketFrontend {\r\n private _api: ITwinElectronApi | IpcRenderer;\r\n public addListener(channelName: string, listener: IpcListener) {\r\n this._api.addListener(channelName, listener);\r\n return () => this._api.removeListener(channelName, listener);\r\n }\r\n public removeListener(channelName: string, listener: IpcListener) {\r\n this._api.removeListener(channelName, listener);\r\n }\r\n public send(channel: string, ...data: any[]) {\r\n this._api.send(channel, ...data);\r\n }\r\n public async invoke(channel: string, ...args: any[]) {\r\n return this._api.invoke(channel, ...args);\r\n }\r\n constructor() {\r\n // use the methods on window.itwinjs exposed by ElectronPreload.ts, or ipcRenderer directly if running with nodeIntegration=true (**only** for tests).\r\n // Note that `require(\"electron\")` doesn't work with nodeIntegration=false - that's what it stops\r\n // eslint-disable-next-line @typescript-eslint/no-var-requires\r\n this._api = window.itwinjs ?? require(\"electron\").ipcRenderer;\r\n }\r\n}\r\n\r\n/** @beta */\r\nexport type ElectronAppOpts = NativeAppOpts;\r\n\r\n/**\r\n * Frontend of an Electron App.\r\n * @beta\r\n */\r\nexport class ElectronApp {\r\n private static _ipc?: ElectronIpc;\r\n public static get isValid(): boolean { return undefined !== this._ipc; }\r\n\r\n /**\r\n * Start the frontend of an Electron application.\r\n * @param opts Options for your ElectronApp\r\n * @note This method must only be called from the frontend of an Electron app (i.e. when [ProcessDetector.isElectronAppFrontend]($bentley) is `true`).\r\n */\r\n public static async startup(opts?: ElectronAppOpts) {\r\n if (!ProcessDetector.isElectronAppFrontend)\r\n throw new Error(\"Not running under Electron\");\r\n if (!this.isValid) {\r\n this._ipc = new ElectronIpc();\r\n ElectronRpcManager.initializeFrontend(this._ipc, opts?.iModelApp?.rpcInterfaces); // eslint-disable-line deprecation/deprecation\r\n }\r\n await NativeApp.startup(this._ipc!, opts);\r\n }\r\n\r\n public static async shutdown() {\r\n this._ipc = undefined;\r\n await NativeApp.shutdown();\r\n ElectronRpcManager.terminateFrontend();\r\n }\r\n\r\n /**\r\n * Call an asynchronous method in the [Electron.Dialog](https://www.electronjs.org/docs/api/dialog) interface from a previously initialized ElectronFrontend.\r\n * @param methodName the name of the method to call\r\n * @param args arguments to method\r\n * @deprecated in 3.x. use [[dialogIpc]]\r\n */\r\n public static async callDialog<T extends DialogModuleMethod>(methodName: T, ...args: Parameters<Electron.Dialog[T]>) {\r\n return IpcApp.callIpcChannel(dialogChannel, \"callDialog\", methodName, ...args) as PromiseReturnType<Electron.Dialog[T]>;\r\n }\r\n\r\n /** Proxy object for calling methods of `Electron.Dialog` */\r\n public static dialogIpc = IpcApp.makeIpcFunctionProxy<Electron.Dialog>(dialogChannel, \"callDialog\");\r\n}\r\n"]}
package/package.json CHANGED
@@ -1,14 +1,15 @@
1
1
  {
2
2
  "name": "@itwin/core-electron",
3
- "version": "4.0.0-dev.1",
3
+ "version": "4.0.0-dev.100",
4
4
  "description": "iTwin.js ElectronHost and ElectronApp",
5
5
  "license": "MIT",
6
6
  "engines": {
7
- "node": ">=12.22.0 < 14.0 || >=14.17.0 < 19.0"
7
+ "node": "^18.0.0"
8
8
  },
9
9
  "repository": {
10
10
  "type": "git",
11
- "url": "https://github.com/iTwin/itwinjs-core/tree/master/core/core-electron"
11
+ "url": "https://github.com/iTwin/itwinjs-core.git",
12
+ "directory": "core/electron"
12
13
  },
13
14
  "keywords": [
14
15
  "Bentley",
@@ -20,33 +21,33 @@
20
21
  "url": "http://www.bentley.com"
21
22
  },
22
23
  "peerDependencies": {
23
- "@itwin/core-backend": "^4.0.0-dev.1",
24
- "@itwin/core-bentley": "^4.0.0-dev.1",
25
- "@itwin/core-common": "^4.0.0-dev.1",
26
- "@itwin/core-frontend": "^4.0.0-dev.1",
27
- "@itwin/presentation-common": "^4.0.0-dev.1",
28
- "electron": ">=14.0.0 <18.0.0 || >=22.0.0 <23.0.0"
24
+ "@itwin/core-backend": "^4.0.0-dev.100",
25
+ "@itwin/core-bentley": "^4.0.0-dev.100",
26
+ "@itwin/core-common": "^4.0.0-dev.100",
27
+ "@itwin/core-frontend": "^4.0.0-dev.100",
28
+ "electron": ">=23.0.0 <25.0.0"
29
29
  },
30
30
  "devDependencies": {
31
- "@itwin/build-tools": "4.0.0-dev.1",
32
- "@itwin/certa": "4.0.0-dev.1",
33
- "@itwin/core-backend": "4.0.0-dev.1",
34
- "@itwin/core-bentley": "4.0.0-dev.1",
35
- "@itwin/core-common": "4.0.0-dev.1",
36
- "@itwin/core-frontend": "4.0.0-dev.1",
37
- "@itwin/eslint-plugin": "4.0.0-dev.1",
38
- "@itwin/presentation-common": "4.0.0-dev.1",
31
+ "@itwin/eslint-plugin": "^4.0.0-dev.33",
39
32
  "@types/chai": "4.3.1",
40
33
  "@types/mocha": "^8.2.2",
41
- "@types/node": "18.11.5",
34
+ "@types/node": "^18.11.5",
42
35
  "chai": "^4.1.2",
43
- "electron": "^22.0.0",
44
- "eslint": "^7.11.0",
36
+ "electron": "^24.0.0",
37
+ "eslint": "^8.36.0",
38
+ "glob": "^7.1.2",
45
39
  "mocha": "^10.0.0",
46
40
  "rimraf": "^3.0.2",
47
41
  "source-map-loader": "^4.0.0",
48
- "typescript": "~4.4.0",
49
- "webpack": "^5.64.4"
42
+ "typescript": "~5.0.2",
43
+ "webpack": "^5.76.0",
44
+ "webpack-cli": "^5.0.1",
45
+ "@itwin/build-tools": "4.0.0-dev.100",
46
+ "@itwin/certa": "4.0.0-dev.100",
47
+ "@itwin/core-bentley": "4.0.0-dev.100",
48
+ "@itwin/core-backend": "4.0.0-dev.100",
49
+ "@itwin/core-common": "4.0.0-dev.100",
50
+ "@itwin/core-frontend": "4.0.0-dev.100"
50
51
  },
51
52
  "dependencies": {
52
53
  "@openid/appauth": "^1.2.6",
@@ -60,20 +61,17 @@
60
61
  "extends": "plugin:@itwin/itwinjs-recommended"
61
62
  },
62
63
  "scripts": {
63
- "build": "npm run -s build:cjs",
64
- "build:ci": "npm run -s build",
64
+ "build": "npm run -s build:cjs && npm run -s webpack:test",
65
65
  "build:cjs": "tsc 1>&2 --outDir lib/cjs",
66
66
  "clean": "rimraf lib .rush/temp/package-deps*.json",
67
67
  "docs": "betools docs --includes=../../generated-docs/extract --json=../../generated-docs/core/core-electron/file.json --tsIndexFile=./__DOC_ONLY__.ts --onlyJson",
68
68
  "extract-api": "betools extract-api --entry=__DOC_ONLY__",
69
69
  "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
70
70
  "test": "",
71
- "test:integration": "npm run test:integration:backend && npm run test:integration:frontend:ci",
71
+ "test:integration": "npm run test:integration:backend && npm run test:integration:frontend",
72
72
  "test:integration:backend": "mocha --config src/test/backend/.mocharc.json",
73
- "test:integration:frontend:ci": "npm run -s webpack:frontend-test && npm run test:integration:frontend",
74
73
  "test:integration:frontend": "certa -r electron --config src/test/frontend/utils/certa.json",
75
- "webpack:frontend-test": "webpack --config ./src/test/frontend/utils/webpack.config.js 1>&2",
74
+ "webpack:test": "webpack --config ./src/test/frontend/utils/webpack.config.js 1>&2",
76
75
  "cover": ""
77
- },
78
- "readme": "# @itwin/core-electron\r\n\r\nCopyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.\r\n\r\n## Description\r\n\r\nThe __@itwin/core-electron__ package contains the electron utilities to write an iTwin.js application based on Electron.\r\n\r\n## Documentation\r\n\r\nSee the [iTwin.js](https://www.itwinjs.org) documentation for more information.\r\n"
76
+ }
79
77
  }
@@ -1,11 +0,0 @@
1
- /** @packageDocumentation
2
- * @module Logging
3
- */
4
- /** Logger categories used by this package
5
- * @note All logger categories in this package start with the `core-electron` prefix.
6
- * @see [Logger]($bentley)
7
- * @public
8
- */
9
- export declare enum ElectronManagerLoggerCategory {
10
- }
11
- //# sourceMappingURL=ElectronManagerLoggerCategory.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ElectronManagerLoggerCategory.d.ts","sourceRoot":"","sources":["../../../src/common/ElectronManagerLoggerCategory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;GAIG;AACH,oBAAY,6BAA6B;CAAI"}
@@ -1,19 +0,0 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Logging
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.ElectronManagerLoggerCategory = void 0;
11
- /** Logger categories used by this package
12
- * @note All logger categories in this package start with the `core-electron` prefix.
13
- * @see [Logger]($bentley)
14
- * @public
15
- */
16
- var ElectronManagerLoggerCategory;
17
- (function (ElectronManagerLoggerCategory) {
18
- })(ElectronManagerLoggerCategory = exports.ElectronManagerLoggerCategory || (exports.ElectronManagerLoggerCategory = {}));
19
- //# sourceMappingURL=ElectronManagerLoggerCategory.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ElectronManagerLoggerCategory.js","sourceRoot":"","sources":["../../../src/common/ElectronManagerLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,6BAAiC;AAA7C,WAAY,6BAA6B;AAAG,CAAC,EAAjC,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAAI","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/** @packageDocumentation\r\n * @module Logging\r\n */\r\n\r\n/** Logger categories used by this package\r\n * @note All logger categories in this package start with the `core-electron` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum ElectronManagerLoggerCategory { }\r\n"]}