@3fv/electron-utility-process-manager 1.0.2 → 1.0.4

package/README.md

@@ -1,10 +1,9 @@
-# @3fv/electron-utility-process-manager
----
+# Electron UPM (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 
+`@3fv/electron-utility-process-manager` manages `1..n` `Electron.utilityProcess` instances/services/processes via a
+single library & provides fully typed client facades automatically
 
 ## Install
 
@@ -14,21 +13,42 @@ yarn add @3fv/electron-utility-process-manager
 
 ## Usage
 
-This library integrates into the `node`, `main` and `renderer` processes to provide 
+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 
+### Possible Use-cases
 
 - main -> node
 - renderer -> node
 - node -> node
 
+
+### Debugging Config (Applies to all examples)
+
+In order to debug a service/utility process, simply add the following to
+the `options` argument passed to `createService`
+
+```typescript
+// ENABLE DEBUGGING (standard node.js inspect config)
+const options = {
+  inspect: {
+    break: true, 
+    port: 9449
+  }
+}
+upmMainServiceManager.createService("example-service", "/path/to/entry.js", options)
+```
+> NOTE: If `break` is `true` the utility/service process
+>  will not be paused until a debugger is attached.
+>  the process will print a chrome debugging url (i.e. `ws://`)
+
+
 ### Examples
 
 #### Simple Example
 
 > NOTE: The simple example uses the bare-bones approach
-> and basically avoids typing wherever possible.  For a 
+> 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))
@@ -41,13 +61,13 @@ upmNodeProcess.addEventHandler((clientId, port, payload) => {
   return true
 })
 
-upmNodeProcess.addRequestHandler("ping", async (type, messageId, what: string) => {
+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)) 
+##### Main Process ([simple-main.ts](examples/simple/simple-main.ts))
 
 ```typescript
 import { app, BrowserWindow } from "electron"
@@ -55,15 +75,14 @@ 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
+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
+    upm, upmManager
   })
   
   console.info("UPM manager ready, now creating service", upmManager)
@@ -74,8 +93,7 @@ async function start() {
   
   const clientPort = upmManager.createMainChannel("simple", "main-channel-01")
   console.info("Start the client port")
-  if (UPM.isMessagePort(clientPort))
-    clientPort.start()
+  if (UPM.isMessagePort(clientPort)) clientPort.start()
   
   console.info("Post a message directly")
   clientPort.postMessage({
@@ -90,7 +108,7 @@ async function start() {
   const client = upmManager.createMainClient("simple", "main-client-01")
   console.info(`Send request/response: ping`)
   
-  const pongResult = await client.executeRequest("ping", ["main"])
+  const pongResult = await client.executeRequest("ping", "main")
   console.info(`Received pong response`, pongResult)
   
   await createWindow()
@@ -110,15 +128,10 @@ async function start() {
  *
  * @returns {Promise<void>}
  */
-async function createWindow(): Promise<void> {
+async function createWindow():Promise<void> {
   const mainWindow = new BrowserWindow({
-    width: 1000,
-    height: 1000,
-    webPreferences: {
-      contextIsolation: false,
-      nodeIntegration: true,
-      sandbox: false,
-      devTools: true
+    width: 1000, height: 1000, webPreferences: {
+      contextIsolation: false, nodeIntegration: true, sandbox: false, devTools: true
     }
   })
   
@@ -144,13 +157,13 @@ import UPMRendererClientFactory from "@3fv/electron-utility-process-manager/rend
 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])
+  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))
+    .catch(err => console.error(`renderer error: ${err.message}`, err))
 
 export {}
 ```

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

@@ -66,7 +66,14 @@ async function start() {
         upmManager
     });
     log.info("UPM manager ready, now creating service", upmManager);
-    upmService = await upmManager.createService("simple", path_1.default.join(__dirname, "simple-node.js"));
+    const entryFile = path_1.default.join(__dirname, "simple-node.js");
+    upmService = await upmManager.createService("simple", entryFile, {
+    // ENABLE DEBUGGING (standard node.js inspect config)
+    // inspect: {
+    //   break: true,
+    //   port: 9449
+    // }
+    });
     log.info("UPM service ready");
     upmService.sendEvent("test123");
     const clientPort = upmManager.createMainChannel("simple", "main-channel-01");
@@ -83,7 +90,7 @@ async function start() {
     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"]);
+    const pongResult = await client.executeRequest("ping", "main");
     log.info(`Received pong response`, pongResult);
     log.info(`Create the window/renderer`);
     await createWindow();

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

@@ -1 +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"}
+{"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,MAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IACxD,UAAU,GAAG,MAAM,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE;IAC/D,qDAAqD;IACrD,aAAa;IACb,iBAAiB;IACjB,eAAe;IACf,IAAI;KACL,CAAC,CAAA;IACF,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,MAAM,CAAC,CAAA;IAC9D,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-renderer.js

@@ -9,7 +9,7 @@ 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]);
+    const result = await client.executeRequest("ping", process.type);
     log.info(`Result: ${result}`);
 }
 simpleExampleUPM()

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

@@ -1 +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"}
+{"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,OAAO,CAAC,IAAI,CAAC,CAAA;IAChE,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/lib/cjs/common/types.d.ts

@@ -21,7 +21,7 @@ export type MessageRequestMap = {};
 export type MessageRequestNames<ReqMap extends MessageRequestMap> = keyof ReqMap;
 export type MessageRequestFn<ReqMap extends MessageRequestMap, Name extends MessageRequestNames<ReqMap>> = ReqMap[Name] extends MessageRequestFnBase ? ReqMap[Name] : never;
 export type MessageRequestParams<ReqMap extends MessageRequestMap, Name extends MessageRequestNames<ReqMap>> = ReqMap[Name] extends MessageRequestFnBase ? Parameters<ReqMap[Name]> : never;
-export type MessageRequestReturnType<ReqMap extends MessageRequestMap, Name extends MessageRequestNames<ReqMap>> = ReqMap[Name] extends MessageRequestFnBase ? ReturnType<ReqMap[Name]> : never;
+export type MessageRequestReturnType<ReqMap extends MessageRequestMap, Name extends MessageRequestNames<ReqMap>> = ReqMap[Name] extends MessageRequestFnBase ? Awaited<ReturnType<ReqMap[Name]>> : never;
 export interface Message<ReqMap extends MessageRequestMap = any, Type extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>, Args extends MessageRequestParams<ReqMap, Type> = MessageRequestParams<ReqMap, Type>, R extends MessageRequestReturnType<ReqMap, Type> = MessageRequestReturnType<ReqMap, Type>> {
     type: Type;
     kind: MessageKind;
@@ -35,7 +35,7 @@ export interface NodeEnvelope<Payload extends {} = any> {
     channel: IPCChannel;
     payload: Payload;
 }
-export type RequestHandler<ReqMap extends MessageRequestMap = any, Type extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>, Args extends MessageRequestParams<ReqMap, Type> = MessageRequestParams<ReqMap, Type>, R extends MessageRequestReturnType<ReqMap, Type> = MessageRequestReturnType<ReqMap, Type>> = (type: Type, messageId: number, ...args: Args) => R;
+export type RequestHandler<ReqMap extends MessageRequestMap = any, Type extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>, Args extends MessageRequestParams<ReqMap, Type> = MessageRequestParams<ReqMap, Type>, R extends MessageRequestReturnType<ReqMap, Type> = MessageRequestReturnType<ReqMap, Type>> = (type: Type, messageId: number, ...args: Args) => Promise<R>;
 export type NodeMessage<ReqMap extends MessageRequestMap = any, Type extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>> = NodeEnvelope<Message<ReqMap, Type>>;
 export interface PendingRequestMessage<ReqMap extends MessageRequestMap = any, Type extends MessageRequestNames<ReqMap> = MessageRequestNames<ReqMap>, R extends MessageRequestReturnType<ReqMap, Type> = MessageRequestReturnType<ReqMap, Type>> {
     deferred: Deferred<R>;
@@ -46,4 +46,26 @@ export interface PendingRequestMessage<ReqMap extends MessageRequestMap = any, T
  * @returns true if payload was handled, false if not
  */
 export type EventHandler = (clientId: string, port: Port, payload: any) => boolean;
+/**
+ * Port of any kind
+ */
 export type Port = MessagePort | Electron.MessagePortMain | Electron.ParentPort | UtilityProcess;
+/**
+ * Debugging & Inspection config
+ */
+export type ServiceInspectConfig = number | {
+    port: number;
+    break?: boolean;
+};
+/**
+ * Configuration to use when creating/launching
+ * a service (`Electron.UtilityProcess`)
+ */
+export interface CreateServiceConfig {
+    serviceName: string;
+    inspect: false | ServiceInspectConfig;
+}
+/**
+ * Optional/Partial `CreateServiceConfig`
+ */
+export type CreateServiceOptions = Partial<CreateServiceConfig>;

package/lib/cjs/common/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/common/types.ts"],"names":[],"mappings":";;;AAKa,QAAA,QAAQ,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,CAAA;AAElD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;AACvB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAED,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,qDAAuC,CAAA;IACvC,yDAA2C,CAAA;AAC7C,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAED,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,8DAA2C,CAAA;IAC3C,2EAAwD,CAAA;AAC1D,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/common/types.ts"],"names":[],"mappings":";;;AAIa,QAAA,QAAQ,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,CAAA;AAElD,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;AACvB,CAAC,EAJW,WAAW,2BAAX,WAAW,QAItB;AAED,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,qDAAuC,CAAA;IACvC,yDAA2C,CAAA;AAC7C,CAAC,EAHW,UAAU,0BAAV,UAAU,QAGrB;AAED,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,8DAA2C,CAAA;IAC3C,2EAAwD,CAAA;AAC1D,CAAC,EAHW,eAAe,+BAAf,eAAe,QAG1B"}

package/lib/cjs/main/UPMMainService.d.ts

@@ -1,22 +1,35 @@
 import { MessagePortMain } from "electron";
 import * as UPM from "../common/index.js";
-import { IServiceClient } from "../common/index.js";
-export interface UPMMainServiceConfig {
-}
-export type UPMMainServiceOptions = Partial<UPMMainServiceConfig>;
+/**
+ * Contains & Manages a `Utility/Process`
+ * providing simplified messaging & event
+ * propagation.
+ */
 export declare class UPMMainService<ReqMap extends UPM.MessageRequestMap = any, MType extends UPM.MessageRequestNames<ReqMap> = UPM.MessageRequestNames<ReqMap>> implements UPM.IMessageClient<ReqMap, MType> {
     readonly serviceName: string;
     readonly entryFile: string;
+    /**
+     * As this container/wrapper implements
+     * `IMessageClient`, it needs to provide
+     * a `clientId`, which is constant in the
+     * main process
+     */
     readonly clientId: string;
-    private readonly config_;
-    private readyDeferred_;
-    private killDeferred_;
-    private lastMessageId_;
-    private childProcess_;
-    private pendingMessages_;
-    private messageChannels_;
-    private init;
-    private onMessage;
+    /**
+     * Send an event as `fire-and-forget`
+     *
+     * @param data
+     * @param port
+     */
+    sendEvent(data: any, port?: UPM.Port): void;
+    /**
+     * Send request
+     *
+     * @param type
+     * @param args
+     */
+    executeRequest<Type extends MType, R extends UPM.MessageRequestReturnType<ReqMap, Type> = UPM.MessageRequestReturnType<ReqMap, Type>>(type: Type, ...args: UPM.MessageRequestParams<ReqMap, Type>): Promise<R>;
+    close(): void;
     /**
      * Resolves when ready
      *
@@ -27,7 +40,15 @@ export declare class UPMMainService<ReqMap extends UPM.MessageRequestMap = any,
      * Return a simple proxy facade wrapping
      * `executeRequest` into individual methods
      */
-    getServiceClient(): IServiceClient<ReqMap, MType>;
+    getServiceClient(): UPM.IServiceClient<ReqMap, MType>;
+    private readonly config_;
+    private readyDeferred_;
+    private killDeferred_;
+    private messageIdSeq_;
+    private childProcess_;
+    private pendingMessages_;
+    private messageChannels_;
+    private onServiceExit;
     /**
      * Returned client side port (for Renderer)
      * @param clientId
@@ -38,33 +59,93 @@ export declare class UPMMainService<ReqMap extends UPM.MessageRequestMap = any,
      * (useful to avoid congestion on default child_process channel)
      *
      * @param {string} clientId
-     * @returns {UPM.MessagePortClient<MessageRequestMap, MessageType>}
+     * @returns {UPM.MessagePortClient}
      */
     createMainClient(clientId: string): UPM.MessagePortClient<ReqMap, MType>;
+    /**
+     * Service is still in a healthy/running/runnable state
+     */
+    get isRunning(): boolean;
+    /**
+     * Stop the service (kill)
+     */
+    stop(): Promise<void>;
+    /**
+     * Resource management & cleanup
+     */
+    [Symbol.asyncDispose](): Promise<void>;
+    /**
+     * Initialize the service
+     *
+     * @private
+     */
+    private init;
+    /**
+     * OnMessage really only handles `results` from
+     * `executeRequest(...)`; this may be expanded in
+     * the future
+     *
+     * @param payload
+     * @private
+     */
+    private onMessage;
+    /**
+     * This handler is currently unused, but
+     * could be attached to a `MessagePort.on('close')`
+     * event
+     *
+     * @param id
+     * @param channel
+     * @private
+     */
     private onPortClose;
-    private closeMessageChannel;
-    close(): void;
     /**
-     * Send an event as `fire-and-forget`
+     * Close a message channel
      *
-     * @param data
-     * @param port
+     * @param id
+     * @param channel
+     * @private
      */
-    sendEvent(data: any, port?: UPM.Port): void;
+    private closeMessageChannel;
     /**
-     * Send request
+     * Kill the service
      *
-     * @param type
-     * @param args
+     * @private
      */
-    executeRequest<Type extends MType, R extends UPM.MessageRequestReturnType<ReqMap, Type> = UPM.MessageRequestReturnType<ReqMap, Type>>(type: Type, ...args: UPM.MessageRequestParams<ReqMap, Type>): Promise<R>;
-    stop(): Promise<void>;
     private kill;
+    /**
+     * Close all message channels
+     *
+     * @private
+     */
     private removeAllMessageChannels;
+    /**
+     * Remove all pending messages
+     *
+     * @private
+     */
     private cancelAllPendingMessages;
-    constructor(serviceName: string, entryFile: string, options?: UPMMainServiceOptions);
+    /**
+     * Remove a pending message from the queue,
+     * whether settled or not
+     *
+     * @param messageId
+     * @private
+     */
     private removePendingMessage;
+    /**
+     * Generate next message id
+     *
+     * @private
+     */
     private generateMessageId;
-    [Symbol.asyncDispose](): Promise<void>;
+    /**
+     * Construct a new service
+     *
+     * @param serviceName
+     * @param entryFile
+     * @param options
+     */
+    constructor(serviceName: string, entryFile: string, options?: UPM.CreateServiceOptions);
 }
 export default UPMMainService;