@3fv/electron-utility-process-manager 1.0.1

package/.prettierrc.js

@@ -0,0 +1,14 @@
+
+module.exports = {
+  "trailingComma": "none",
+  "tabWidth": 2,
+  embeddedLanguageFormatting: "auto",
+  printWidth: 60,
+  "semi": false,
+  "singleQuote": false,
+  // parser: "typescript",
+  parser: "babel",
+  bracketSpacing: true,
+  useTabs: false,
+  proseWrap: "always"
+}

package/README.md

@@ -0,0 +1,166 @@
+# @3fv/electron-utility-process-manager
+---
+
+## Overview
+
+`@3fv/electron-utility-process-manager` manages `1..n` `Electron.utilityProcess` instances/services/processes via a 
+single library & provides fully typed client facades automatically 
+
+## Install
+
+```shell
+yarn add @3fv/electron-utility-process-manager
+```
+
+## Usage
+
+This library integrates into the `node`, `main` and `renderer` processes to provide 
+transparent access from any process to a `node` (`Electron.utilityProcess`).
+
+### Possible Use-cases 
+
+- main -> node
+- renderer -> node
+- node -> node
+
+### Examples
+
+#### Simple Example
+
+> NOTE: The simple example uses the bare-bones approach
+> and basically avoids typing wherever possible.  For a 
+> fully typed example, checkout the [complex example](#complex-example)
+
+##### Node/Utility Process ([simple-node.ts](examples/simple/simple-node.ts))
+
+```typescript
+import upmNodeProcess from "@3fv/electron-utility-process-manager/node"
+
+upmNodeProcess.addEventHandler((clientId, port, payload) => {
+  console.info(`Received event from (${clientId})`, payload)
+  return true
+})
+
+upmNodeProcess.addRequestHandler("ping", async (type, messageId, what: string) => {
+  console.info(`Ping request received (${messageId})`, what)
+  return `pong: ${what}`
+})
+```
+
+##### Main Process ([simple-main.ts](examples/simple/simple-main.ts)) 
+
+```typescript
+import { app, BrowserWindow } from "electron"
+import { UPM } from "@3fv/electron-utility-process-manager"
+import type { UPMMainService } from "@3fv/electron-utility-process-manager/main"
+import Path from "path"
+
+let upmService: UPMMainService = null
+
+async function start() {
+  const upm = await import("@3fv/electron-utility-process-manager/main")
+  const upmManager = upm.upmMainServiceManager
+  
+  Object.assign(global, {
+    upm,
+    upmManager
+  })
+  
+  console.info("UPM manager ready, now creating service", upmManager)
+  upmService = await upmManager.createService("simple", Path.join(__dirname, "simple-node.js"))
+  console.info("UPM service ready")
+  
+  upmService.sendEvent("test123")
+  
+  const clientPort = upmManager.createMainChannel("simple", "main-channel-01")
+  console.info("Start the client port")
+  if (UPM.isMessagePort(clientPort))
+    clientPort.start()
+  
+  console.info("Post a message directly")
+  clientPort.postMessage({
+    channel: UPM.IPCChannel.UPMServiceMessage,
+    payload: { kind: UPM.MessageKind.Event, messageId: -1, data: { test: "test456" } }
+  })
+  
+  console.info("Send event via the UPMMainService wrapper")
+  upmService.sendEvent({ test: "test789" }, clientPort)
+  
+  console.info(`Creating port client`)
+  const client = upmManager.createMainClient("simple", "main-client-01")
+  console.info(`Send request/response: ping`)
+  
+  const pongResult = await client.executeRequest("ping", ["main"])
+  console.info(`Received pong response`, pongResult)
+  
+  await createWindow()
+  
+  app.on("activate", function() {
+    if (BrowserWindow.getAllWindows().length === 0) createWindow()
+  })
+}
+
+
+/**
+ * Boilerplate
+ *
+ * > Note: this can be done via a preload script,
+ *     but for the sake of simplicity, we are just
+ *     disabling all security here
+ *
+ * @returns {Promise<void>}
+ */
+async function createWindow(): Promise<void> {
+  const mainWindow = new BrowserWindow({
+    width: 1000,
+    height: 1000,
+    webPreferences: {
+      contextIsolation: false,
+      nodeIntegration: true,
+      sandbox: false,
+      devTools: true
+    }
+  })
+  
+  const htmlFile = Path.resolve(__dirname, "..", "..", "..", "examples", "simple", "simple-renderer.html")
+  mainWindow.webContents.openDevTools({ mode: "right" })
+  
+  await mainWindow.loadFile(htmlFile)
+}
+
+app.whenReady().then(start)
+
+app.on("window-all-closed", function() {
+  if (process.platform !== "darwin") app.quit()
+})
+
+```
+
+##### Renderer Process ([simple-renderer.ts](examples/simple/simple-renderer.ts))
+
+```typescript
+import UPMRendererClientFactory from "@3fv/electron-utility-process-manager/renderer"
+
+document.querySelector("#root").innerHTML = `simple-renderer-example`
+
+async function simpleExampleUPM() {
+  const client = await UPMRendererClientFactory.createClient("simple",`${process.type}-01`)
+  const result = await client.executeRequest("ping", [process.type])
+  console.info(`Result: ${result}`)
+}
+
+simpleExampleUPM()
+  .catch(err => console.error(`renderer error: ${err.message}`, err))
+
+export {}
+```
+
+#### Complex Example
+
+Checkout the [source here](examples/complex), it's basically the simple example,
+but fully typed
+
+## TODO
+
+- [ ] CI/CD
+- [ ] Tests

package/examples/lib-examples/complex/complex-main.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/lib-examples/complex/complex-main.js

@@ -0,0 +1,108 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Modules to control application life and create native browser window
+const electron_1 = require("electron");
+const electron_utility_process_manager_1 = require("@3fv/electron-utility-process-manager");
+const tracer_1 = __importDefault(require("tracer"));
+const path_1 = __importDefault(require("path"));
+const log = tracer_1.default.colorConsole();
+let upmService = null;
+/**
+ * Boilerplate
+ *
+ * > Note: this can be done via a preload script,
+ *     but for the sake of simplicity, we are just
+ *     disabling all security here
+ *
+ * @returns {Promise<void>}
+ */
+async function createWindow() {
+    const mainWindow = new electron_1.BrowserWindow({
+        width: 1000,
+        height: 1000,
+        webPreferences: {
+            contextIsolation: false,
+            nodeIntegration: true,
+            sandbox: false,
+            devTools: true
+        }
+    });
+    // Load the sample page
+    const htmlFile = path_1.default.resolve(__dirname, "..", "..", "..", "examples", "complex", "complex-renderer.html");
+    mainWindow.webContents.openDevTools({ mode: "right" });
+    await mainWindow.loadFile(htmlFile);
+}
+async function start() {
+    const upm = await Promise.resolve().then(() => __importStar(require("@3fv/electron-utility-process-manager/main")));
+    const upmManager = upm.upmMainServiceManager;
+    Object.assign(global, {
+        upm,
+        upmManager
+    });
+    log.info("UPM manager ready, now creating service", upmManager);
+    upmService = await upmManager.createService("complex", path_1.default.join(__dirname, "complex-node.js"));
+    log.info("UPM service ready");
+    upmService.sendEvent("test123");
+    const clientPort = upmManager.createMainChannel("complex", "main-channel-01");
+    log.info("Start the client port");
+    if (electron_utility_process_manager_1.UPM.isMessagePort(clientPort))
+        clientPort.start();
+    log.info("Post a message directly");
+    clientPort.postMessage({
+        channel: electron_utility_process_manager_1.UPM.IPCChannel.UPMServiceMessage,
+        payload: { kind: electron_utility_process_manager_1.UPM.MessageKind.Event, messageId: -1, data: { test: "test456" } }
+    });
+    log.info("Send event via the UPMMainService wrapper");
+    upmService.sendEvent({ test: "test789" }, clientPort);
+    log.info(`Creating port client`);
+    const messageClient = upmManager.createMainClient("complex", "main-client-01"), serviceClient = messageClient.getServiceClient();
+    log.info(`Send request/response: ping`);
+    const msgPongResult = await messageClient.executeRequest("ping", "main");
+    log.info(`msgPongResult=${msgPongResult}`);
+    const servicePongResult = await serviceClient.ping("main");
+    log.info(`servicePongResult=${servicePongResult}`);
+    log.info(`Create the window/renderer`);
+    await createWindow();
+    electron_1.app.on("activate", function () {
+        if (electron_1.BrowserWindow.getAllWindows().length === 0)
+            createWindow();
+    });
+}
+// When App is READY
+electron_1.app.whenReady().then(start);
+// Quit when all windows are closed, except on macOS. There, it's common
+// for applications and their menu bar to stay active until the user quits
+// explicitly with Cmd + Q.
+electron_1.app.on("window-all-closed", function () {
+    if (process.platform !== "darwin")
+        electron_1.app.quit();
+});
+// In this file you can include the rest of your app's specific main process
+// code. You can also put them in separate files and require them here.
+//# sourceMappingURL=complex-main.js.map

package/examples/lib-examples/complex/complex-main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complex-main.js","sourceRoot":"","sources":["../../complex/complex-main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uEAAuE;AACvE,uCAA6C;AAC7C,4FAA2D;AAE3D,oDAA2B;AAC3B,gDAAuB;AAGvB,MAAM,GAAG,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;AACjC,IAAI,UAAU,GAAmB,IAAI,CAAA;AAErC;;;;;;;;GAQG;AACH,KAAK,UAAU,YAAY;IACzB,MAAM,UAAU,GAAG,IAAI,wBAAa,CAAC;QACnC,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,IAAI;QACZ,cAAc,EAAE;YACd,gBAAgB,EAAE,KAAK;YACvB,eAAe,EAAE,IAAI;YACrB,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;SACf;KACF,CAAC,CAAA;IAEF,uBAAuB;IACvB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,uBAAuB,CAAC,CAAA;IAC1G,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAEtD,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAGrC,CAAC;AAED,KAAK,UAAU,KAAK;IAClB,MAAM,GAAG,GAAG,wDAAa,4CAA4C,GAAC,CAAA;IACtE,MAAM,UAAU,GAAG,GAAG,CAAC,qBAAqB,CAAA;IAE5C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACpB,GAAG;QACH,UAAU;KACX,CAAC,CAAA;IAEF,GAAG,CAAC,IAAI,CAAC,yCAAyC,EAAE,UAAU,CAAC,CAAA;IAC/D,UAAU,GAAG,MAAM,UAAU,CAAC,aAAa,CAAyB,SAAS,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAA;IACvH,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;IAE7B,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IAE/B,MAAM,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAA;IAC7E,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;IACjC,IAAI,sCAAG,CAAC,aAAa,CAAC,UAAU,CAAC;QAC/B,UAAU,CAAC,KAAK,EAAE,CAAA;IAEpB,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACnC,UAAU,CAAC,WAAW,CAAC;QACrB,OAAO,EAAE,sCAAG,CAAC,UAAU,CAAC,iBAAiB;QACzC,OAAO,EAAE,EAAE,IAAI,EAAE,sCAAG,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;KACnF,CAAC,CAAA;IAEF,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAA;IACrD,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC,CAAA;IAErD,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;IAChC,MAAM,aAAa,GAAG,UAAU,CAAC,gBAAgB,CAAyB,SAAS,EAAE,gBAAgB,CAAC,EACpG,aAAa,GAAG,aAAa,CAAC,gBAAgB,EAAE,CAAA;IAElD,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAA;IAEvC,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACxE,GAAG,CAAC,IAAI,CAAC,iBAAiB,aAAa,EAAE,CAAC,CAAA;IAE1C,MAAM,iBAAiB,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAC1D,GAAG,CAAC,IAAI,CAAC,qBAAqB,iBAAiB,EAAE,CAAC,CAAA;IAElD,GAAG,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;IACtC,MAAM,YAAY,EAAE,CAAA;IAEpB,cAAG,CAAC,EAAE,CAAC,UAAU,EAAE;QACjB,IAAI,wBAAa,CAAC,aAAa,EAAE,CAAC,MAAM,KAAK,CAAC;YAAE,YAAY,EAAE,CAAA;IAChE,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,oBAAoB;AACpB,cAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAE3B,wEAAwE;AACxE,0EAA0E;AAC1E,2BAA2B;AAC3B,cAAG,CAAC,EAAE,CAAC,mBAAmB,EAAE;IAC1B,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ;QAAE,cAAG,CAAC,IAAI,EAAE,CAAA;AAC/C,CAAC,CAAC,CAAA;AAEF,4EAA4E;AAC5E,uEAAuE"}

package/examples/lib-examples/complex/complex-node.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/lib-examples/complex/complex-node.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tracer_1 = __importDefault(require("tracer"));
+const node_1 = __importDefault(require("@3fv/electron-utility-process-manager/node"));
+const log = tracer_1.default.console();
+node_1.default.addEventHandler((clientId, port, payload) => {
+    log.info(`Received event from (${clientId})`, payload);
+    return true;
+});
+node_1.default.addRequestHandler("ping", async (type, messageId, what) => {
+    log.info(`Ping request received (${messageId})`, what);
+    return `pong: ${what}`;
+});
+//# sourceMappingURL=complex-node.js.map

package/examples/lib-examples/complex/complex-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complex-node.js","sourceRoot":"","sources":["../../complex/complex-node.ts"],"names":[],"mappings":";;;;;AACA,oDAA2B;AAC3B,sFAAuE;AAEvE,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,EAAE,CAAA;AAE5B,cAAc,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;IACzD,GAAG,CAAC,IAAI,CAAC,wBAAwB,QAAQ,GAAG,EAAE,OAAO,CAAC,CAAA;IACtD,OAAO,IAAI,CAAA;AACb,CAAC,CAAC,CAAA;AAEF,cAAc,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAY,EAAE,EAAE;IAC/E,GAAG,CAAC,IAAI,CAAC,0BAA0B,SAAS,GAAG,EAAE,IAAI,CAAC,CAAA;IACtD,OAAO,SAAS,IAAI,EAAE,CAAA;AACxB,CAAC,CAAC,CAAA"}

package/examples/lib-examples/complex/complex-renderer.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/lib-examples/complex/complex-renderer.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const renderer_1 = __importDefault(require("@3fv/electron-utility-process-manager/renderer"));
+const tracer_1 = __importDefault(require("tracer"));
+const log = tracer_1.default.colorConsole();
+document.querySelector("#root").innerHTML = `complex-renderer-example`;
+async function complexExampleUPM() {
+    const messageClient = await renderer_1.default.createClient("complex", `${process.type}-01`), serviceClient = messageClient.getServiceClient();
+    const messageResult = await messageClient.executeRequest("ping", process.type), serviceResult = await serviceClient.ping(process.type);
+    log.info(`messageResult=${messageResult}`);
+    log.info(`serviceResult=${serviceResult}`);
+}
+complexExampleUPM()
+    .catch(err => log.error(`renderer error: ${err.message}`, err));
+//# sourceMappingURL=complex-renderer.js.map

package/examples/lib-examples/complex/complex-renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complex-renderer.js","sourceRoot":"","sources":["../../complex/complex-renderer.ts"],"names":[],"mappings":";;;;;AAAA,8FAAqF;AACrF,oDAA2B;AAG3B,MAAM,GAAG,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;AAEjC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,GAAG,0BAA0B,CAAA;AAEtE,KAAK,UAAU,iBAAiB;IAC9B,MAAM,aAAa,GAAG,MAAM,kBAAwB,CAAC,YAAY,CAAyB,SAAS,EAAC,GAAG,OAAO,CAAC,IAAI,KAAK,CAAC,EACvH,aAAa,GAAG,aAAa,CAAC,gBAAgB,EAAE,CAAA;IAElD,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,EAC5E,aAAa,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAExD,GAAG,CAAC,IAAI,CAAC,iBAAiB,aAAa,EAAE,CAAC,CAAA;IAC1C,GAAG,CAAC,IAAI,CAAC,iBAAiB,aAAa,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED,iBAAiB,EAAE;KAChB,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA"}

package/examples/lib-examples/complex/complex-types.d.ts

@@ -0,0 +1,3 @@
+export interface PingPongExampleService {
+    ping(what: string): Promise<string>;
+}

package/examples/lib-examples/complex/complex-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=complex-types.js.map

package/examples/lib-examples/complex/complex-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"complex-types.js","sourceRoot":"","sources":["../../complex/complex-types.ts"],"names":[],"mappings":""}

package/examples/lib-examples/simple/simple-main.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/lib-examples/simple/simple-main.js

@@ -0,0 +1,106 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Modules to control application life and create native browser window
+const electron_1 = require("electron");
+const electron_utility_process_manager_1 = require("@3fv/electron-utility-process-manager");
+const tracer_1 = __importDefault(require("tracer"));
+const path_1 = __importDefault(require("path"));
+const log = tracer_1.default.colorConsole();
+let upmService = null;
+/**
+ * Boilerplate
+ *
+ * > Note: this can be done via a preload script,
+ *     but for the sake of simplicity, we are just
+ *     disabling all security here
+ *
+ * @returns {Promise<void>}
+ */
+async function createWindow() {
+    const mainWindow = new electron_1.BrowserWindow({
+        width: 1000,
+        height: 1000,
+        webPreferences: {
+            contextIsolation: false,
+            nodeIntegration: true,
+            sandbox: false,
+            devTools: true
+        }
+    });
+    // Load the sample page
+    const htmlFile = path_1.default.resolve(__dirname, "..", "..", "..", "examples", "simple", "simple-renderer.html");
+    mainWindow.webContents.openDevTools({ mode: "right" });
+    await mainWindow.loadFile(htmlFile);
+}
+async function start() {
+    const upm = await Promise.resolve().then(() => __importStar(require("@3fv/electron-utility-process-manager/main")));
+    const upmManager = upm.upmMainServiceManager;
+    Object.assign(global, {
+        upm,
+        upmManager
+    });
+    log.info("UPM manager ready, now creating service", upmManager);
+    upmService = await upmManager.createService("simple", path_1.default.join(__dirname, "simple-node.js"));
+    log.info("UPM service ready");
+    upmService.sendEvent("test123");
+    const clientPort = upmManager.createMainChannel("simple", "main-channel-01");
+    log.info("Start the client port");
+    if (electron_utility_process_manager_1.UPM.isMessagePort(clientPort))
+        clientPort.start();
+    log.info("Post a message directly");
+    clientPort.postMessage({
+        channel: electron_utility_process_manager_1.UPM.IPCChannel.UPMServiceMessage,
+        payload: { kind: electron_utility_process_manager_1.UPM.MessageKind.Event, messageId: -1, data: { test: "test456" } }
+    });
+    log.info("Send event via the UPMMainService wrapper");
+    upmService.sendEvent({ test: "test789" }, clientPort);
+    log.info(`Creating port client`);
+    const client = upmManager.createMainClient("simple", "main-client-01");
+    log.info(`Send request/response: ping`);
+    const pongResult = await client.executeRequest("ping", ["main"]);
+    log.info(`Received pong response`, pongResult);
+    log.info(`Create the window/renderer`);
+    await createWindow();
+    electron_1.app.on("activate", function () {
+        if (electron_1.BrowserWindow.getAllWindows().length === 0)
+            createWindow();
+    });
+}
+// When App is READY
+electron_1.app.whenReady().then(start);
+// Quit when all windows are closed, except on macOS. There, it's common
+// for applications and their menu bar to stay active until the user quits
+// explicitly with Cmd + Q.
+electron_1.app.on("window-all-closed", function () {
+    if (process.platform !== "darwin")
+        electron_1.app.quit();
+});
+// In this file you can include the rest of your app's specific main process
+// code. You can also put them in separate files and require them here.
+//# sourceMappingURL=simple-main.js.map

package/examples/lib-examples/simple/simple-main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-main.js","sourceRoot":"","sources":["../../simple/simple-main.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uEAAuE;AACvE,uCAA6C;AAC7C,4FAA2D;AAG3D,oDAA2B;AAC3B,gDAAuB;AAEvB,MAAM,GAAG,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;AACjC,IAAI,UAAU,GAAmB,IAAI,CAAA;AAErC;;;;;;;;GAQG;AACH,KAAK,UAAU,YAAY;IACzB,MAAM,UAAU,GAAG,IAAI,wBAAa,CAAC;QACnC,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,IAAI;QACZ,cAAc,EAAE;YACd,gBAAgB,EAAE,KAAK;YACvB,eAAe,EAAE,IAAI;YACrB,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;SACf;KACF,CAAC,CAAA;IAEF,uBAAuB;IACvB,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,sBAAsB,CAAC,CAAA;IACxG,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAEtD,MAAM,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAGrC,CAAC;AAED,KAAK,UAAU,KAAK;IAClB,MAAM,GAAG,GAAG,wDAAa,4CAA4C,GAAC,CAAA;IACtE,MAAM,UAAU,GAAG,GAAG,CAAC,qBAAqB,CAAA;IAE5C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QACpB,GAAG;QACH,UAAU;KACX,CAAC,CAAA;IAEF,GAAG,CAAC,IAAI,CAAC,yCAAyC,EAAE,UAAU,CAAC,CAAA;IAC/D,UAAU,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAA;IAC7F,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;IAE7B,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IAE/B,MAAM,UAAU,GAAG,UAAU,CAAC,iBAAiB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAA;IAC5E,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;IACjC,IAAI,sCAAG,CAAC,aAAa,CAAC,UAAU,CAAC;QAC/B,UAAU,CAAC,KAAK,EAAE,CAAA;IAEpB,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACnC,UAAU,CAAC,WAAW,CAAC;QACrB,OAAO,EAAE,sCAAG,CAAC,UAAU,CAAC,iBAAiB;QACzC,OAAO,EAAE,EAAE,IAAI,EAAE,sCAAG,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE;KACnF,CAAC,CAAA;IAEF,GAAG,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAA;IACrD,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,UAAU,CAAC,CAAA;IAErD,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;IAChC,MAAM,MAAM,GAAG,UAAU,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAA;IACtE,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAA;IAEvC,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;IAChE,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAA;IAE9C,GAAG,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;IACtC,MAAM,YAAY,EAAE,CAAA;IAEpB,cAAG,CAAC,EAAE,CAAC,UAAU,EAAE;QACjB,IAAI,wBAAa,CAAC,aAAa,EAAE,CAAC,MAAM,KAAK,CAAC;YAAE,YAAY,EAAE,CAAA;IAChE,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,oBAAoB;AACpB,cAAG,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAE3B,wEAAwE;AACxE,0EAA0E;AAC1E,2BAA2B;AAC3B,cAAG,CAAC,EAAE,CAAC,mBAAmB,EAAE;IAC1B,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ;QAAE,cAAG,CAAC,IAAI,EAAE,CAAA;AAC/C,CAAC,CAAC,CAAA;AAEF,4EAA4E;AAC5E,uEAAuE"}

package/examples/lib-examples/simple/simple-node.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/lib-examples/simple/simple-node.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tracer_1 = __importDefault(require("tracer"));
+const node_1 = __importDefault(require("@3fv/electron-utility-process-manager/node"));
+const log = tracer_1.default.console();
+node_1.default.addEventHandler((clientId, port, payload) => {
+    log.info(`Received event from (${clientId})`, payload);
+    return true;
+});
+node_1.default.addRequestHandler("ping", async (type, messageId, what) => {
+    log.info(`Ping request received (${messageId})`, what);
+    return `pong: ${what}`;
+});
+//# sourceMappingURL=simple-node.js.map

package/examples/lib-examples/simple/simple-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-node.js","sourceRoot":"","sources":["../../simple/simple-node.ts"],"names":[],"mappings":";;;;;AACA,oDAA2B;AAC3B,sFAAuE;AAEvE,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,EAAE,CAAA;AAE5B,cAAc,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;IACzD,GAAG,CAAC,IAAI,CAAC,wBAAwB,QAAQ,GAAG,EAAE,OAAO,CAAC,CAAA;IACtD,OAAO,IAAI,CAAA;AACb,CAAC,CAAC,CAAA;AAEF,cAAc,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAY,EAAE,EAAE;IAC/E,GAAG,CAAC,IAAI,CAAC,0BAA0B,SAAS,GAAG,EAAE,IAAI,CAAC,CAAA;IACtD,OAAO,SAAS,IAAI,EAAE,CAAA;AACxB,CAAC,CAAC,CAAA"}

package/examples/lib-examples/simple/simple-renderer.d.ts

@@ -0,0 +1 @@
+export {};

package/examples/lib-examples/simple/simple-renderer.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const renderer_1 = __importDefault(require("@3fv/electron-utility-process-manager/renderer"));
+const tracer_1 = __importDefault(require("tracer"));
+const log = tracer_1.default.colorConsole();
+document.querySelector("#root").innerHTML = `simple-renderer-example`;
+async function simpleExampleUPM() {
+    const client = await renderer_1.default.createClient("simple", `${process.type}-01`);
+    const result = await client.executeRequest("ping", [process.type]);
+    log.info(`Result: ${result}`);
+}
+simpleExampleUPM()
+    .catch(err => log.error(`renderer error: ${err.message}`, err));
+//# sourceMappingURL=simple-renderer.js.map

package/examples/lib-examples/simple/simple-renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-renderer.js","sourceRoot":"","sources":["../../simple/simple-renderer.ts"],"names":[],"mappings":";;;;;AAAA,8FAAqF;AACrF,oDAA2B;AAE3B,MAAM,GAAG,GAAG,gBAAM,CAAC,YAAY,EAAE,CAAA;AAEjC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,SAAS,GAAG,yBAAyB,CAAA;AAErE,KAAK,UAAU,gBAAgB;IAC7B,MAAM,MAAM,GAAG,MAAM,kBAAwB,CAAC,YAAY,CAAC,QAAQ,EAAC,GAAG,OAAO,CAAC,IAAI,KAAK,CAAC,CAAA;IACzF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IAClE,GAAG,CAAC,IAAI,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;AAC/B,CAAC;AAED,gBAAgB,EAAE;KACf,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,mBAAmB,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC,CAAA"}

package/jest.config.js

@@ -0,0 +1,20 @@
+
+const { defaults: tsjPreset } = require('ts-jest/presets');
+
+module.exports = {
+    verbose: true,
+    testMatch: ["**/lib/cjs/**/*.spec.js"],
+    moduleDirectories: [
+      "node_modules",
+      "lib/cjs"
+    ],
+    
+    transform: {
+    
+    },
+    moduleFileExtensions: [
+      "ts",
+      "tsx",
+      "js"
+    ]
+  }

package/lib/cjs/common/clients.d.ts

@@ -0,0 +1,103 @@
+import { MessageRequestFn, MessageRequestMap, MessageRequestNames, MessageRequestParams, MessageRequestReturnType, Port } from "./types";
+/**
+ * Service client interface maps a `MessageRequestMap`
+ * to its functional methods
+ */
+export type IServiceClient<ReqMap extends MessageRequestMap, MType extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>> = {
+    [Type in MType]: MessageRequestFn<ReqMap, Type>;
+};
+/**
+ * Messaging client interface
+ */
+export interface IMessageClient<ReqMap extends MessageRequestMap, MType extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>> {
+    /**
+     * A very low level function for sending `any` data
+     * to the `utilityProcess`
+     *
+     * @param data
+     */
+    sendEvent(data: any): void;
+    /**
+     * Execute a request, with a response expected
+     *
+     * @param type
+     * @param args determined by the typed `MessageRequestMap` & `Type` parameters
+     */
+    executeRequest<Type extends MType, R extends MessageRequestReturnType<ReqMap, Type> = MessageRequestReturnType<ReqMap, Type>>(type: Type, ...args: MessageRequestParams<ReqMap, Type>): Promise<R>;
+    /**
+     * Close the message client
+     */
+    close(): void;
+    /**
+     * Resolve when client is ready to use
+     */
+    whenReady(): Promise<IMessageClient<ReqMap, MType>>;
+    /**
+     * Get service client from message client
+     */
+    getServiceClient(): IServiceClient<ReqMap, MType>;
+}
+/**
+ * Generic `MessagePort` client implementation, which
+ * is functional in any process.
+ *
+ * > NOTE: Aside from the main & renderer processes,
+ * >   an `utilityProcess` could potentially also
+ * >   use this client to communicate with a separate
+ * >   `utilityProcess`
+ */
+export declare class MessagePortClient<ReqMap extends MessageRequestMap, MType extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>> implements IMessageClient<ReqMap, MType> {
+    readonly clientId: string;
+    readonly port: Port;
+    /**
+     * Used to generate IDS
+     *
+     * @private
+     */
+    private idSequence_;
+    /**
+     * A `Map` responsible for mapping `messageId`
+     * values to a `PendingRequestMessage`
+     *
+     * @private
+     */
+    private readonly pendingMessages_;
+    /**
+     * Get the next `messageId`
+     *
+     * @returns {number}
+     * @private
+     */
+    private generateMessageId;
+    /**
+     * Remove a pending message mapping based on supplied ID
+     *
+     * @param {number} messageId
+     * @private
+     */
+    private removePendingMessage;
+    /**
+     * Handle messages posted by the `utilityProcess` via
+     * either `process.parentPort` or a specific `MessagePort`
+     *
+     * @param payloadOrEnvelopeOrData
+     * @private
+     */
+    private onMessage;
+    sendEvent(data: any): void;
+    executeRequest<Type extends MType, R extends MessageRequestReturnType<ReqMap, Type> = MessageRequestReturnType<ReqMap, Type>>(type: Type, ...args: MessageRequestParams<ReqMap, Type>): Promise<R>;
+    close(): void;
+    whenReady(): Promise<this>;
+    /**
+     * Return a simple proxy facade wrapping
+     * `executeRequest` into individual methods
+     */
+    getServiceClient(): IServiceClient<ReqMap, MType>;
+    /**
+     * Create a new `MessagePortClient`
+     *
+     * @param clientId
+     * @param port
+     */
+    constructor(clientId: string, port: Port);
+}