feat: Add cli message sender and the first use case for it (sending a request for showing a <press any key to continue> prompt

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.171",
+  "version": "1.0.173",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.74",
+    "codify-schemas": "1.0.76",
     "@npmcli/promise-spawn": "^7.0.1",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "uuid": "^10.0.0",

package.json

@@ -2,6 +2,7 @@ import { MessageHandler } from './messages/handlers.js';
 import { Plugin } from './plugin/plugin.js';
 
 export * from './errors.js'
+export * from './messages/sender.js'
 export * from './plan/change-set.js'
 export * from './plan/plan.js'
 export * from './plan/plan-types.js'

src/index.ts

@@ -0,0 +1,56 @@
+import { Ajv } from 'ajv';
+import { IpcMessageV2, IpcMessageV2Schema, MessageCmd, PressKeyToContinueRequestData } from 'codify-schemas';
+import { nanoid } from 'nanoid';
+
+const ajv = new Ajv({
+  strict: true,
+});
+
+/**
+ * Send requests to the Codify CLI
+ */
+class CodifyCliSenderImpl {
+  private readonly validateIpcMessageV2 = ajv.compile(IpcMessageV2Schema);
+
+  async requestPressKeyToContinuePrompt(message?: string): Promise<void> {
+    await this.sendAndWaitForResponse(<IpcMessageV2>{
+      cmd: MessageCmd.PRESS_KEY_TO_CONTINUE_REQUEST,
+      data: <PressKeyToContinueRequestData>{
+        promptMessage: message,
+      }
+    })
+  }
+
+  private async sendAndWaitForResponse(message: IpcMessageV2): Promise<IpcMessageV2> {
+    return new Promise((resolve) => {
+      const requestId = nanoid(8);
+      const listener = (data: IpcMessageV2) => {
+        if (data.requestId === requestId) {
+          process.removeListener('message', listener);
+
+          if (!this.validateIpcMessageV2(data)) {
+            throw new Error(`Invalid response for request.
+Request:                        
+${JSON.stringify(message, null, 2)}
+Response:
+${JSON.stringify(data, null, 2)}
+Error:
+${JSON.stringify(this.validateIpcMessageV2.errors, null, 2)}`);
+          }
+
+          resolve(data);
+        }
+      }
+
+      process.on('message', listener);
+
+      const ipcMessage = {
+        ...message,
+        requestId,
+      }
+      process.send!(ipcMessage)
+    })
+  }
+}
+
+export const CodifyCliSender = new CodifyCliSenderImpl();