@codifycli/plugin-core 1.1.0-beta17 → 1.1.0-beta19

package/dist/messages/handlers.js

@@ -1,6 +1,7 @@
 import { ApplyRequestDataSchema, EmptyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, IpcMessageV2Schema, MatchRequestDataSchema, MatchResponseDataSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, SetVerbosityRequestDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from '@codifycli/schemas';
 import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
+import { ApplyValidationError } from '../common/errors.js';
 import { SudoError } from '../errors.js';
 const SupportedRequests = {
     'initialize': {
@@ -113,22 +114,30 @@ export class MessageHandler {
         }
         // @ts-expect-error TS2239
         const cmd = message.cmd + '_Response';
+        // @ts-expect-error TS2239
+        const requestId = message.requestId || undefined;
+        let errorPayload;
         if (e instanceof SudoError) {
-            return process.send?.({
-                cmd,
-                // @ts-expect-error TS2239
-                requestId: message.requestId || undefined,
-                data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
-                status: MessageStatus.ERROR,
-            });
+            errorPayload = {
+                errorType: 'sudo_error',
+                message: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
+                data: { command: e.command, pluginName: this.plugin.name },
+            };
+        }
+        else if (e instanceof ApplyValidationError) {
+            errorPayload = {
+                errorType: 'apply_validation',
+                message: e.message,
+                data: { plan: e.plan.toResponse() },
+            };
+        }
+        else {
+            const isDebug = process.env.DEBUG?.includes('*') ?? false;
+            errorPayload = {
+                errorType: 'unknown',
+                message: isDebug ? (e.stack ?? e.message) : e.message,
+            };
         }
-        const isDebug = process.env.DEBUG?.includes('*') ?? false;
-        process.send?.({
-            cmd,
-            // @ts-expect-error TS2239
-            requestId: message.requestId || undefined,
-            data: isDebug ? e.stack : e.message,
-            status: MessageStatus.ERROR,
-        });
+        process.send?.({ cmd, requestId, data: errorPayload, status: MessageStatus.ERROR });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.1.0-beta17",
+  "version": "1.1.0-beta19",
   "description": "TypeScript library for building Codify plugins to manage system resources (applications, CLI tools, settings) through infrastructure-as-code",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -35,7 +35,7 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@codifycli/schemas": "1.1.0-beta6",
+    "@codifycli/schemas": "^1.1.0-beta8",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.13.1",
     "ajv": "^8.18.0",
     "ajv-formats": "^2.1.1",

package/src/messages/handlers.ts

@@ -14,6 +14,7 @@ import {
   MatchRequestDataSchema,
   MatchResponseDataSchema,
   MessageStatus,
+  PluginErrorData,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
   ResourceSchema,
@@ -24,6 +25,7 @@ import {
 import { Ajv, SchemaObject, ValidateFunction } from 'ajv';
 import addFormats from 'ajv-formats';
 
+import { ApplyValidationError } from '../common/errors.js';
 import { SudoError } from '../errors.js';
 import { Plugin } from '../plugin/plugin.js';
 
@@ -157,25 +159,31 @@ export class MessageHandler {
 
     // @ts-expect-error TS2239
     const cmd = message.cmd + '_Response';
+    // @ts-expect-error TS2239
+    const requestId = message.requestId || undefined;
+
+    let errorPayload: PluginErrorData;
 
     if (e instanceof SudoError) {
-      return process.send?.({
-        cmd,
-        // @ts-expect-error TS2239
-        requestId: message.requestId || undefined,
-        data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
-        status: MessageStatus.ERROR,
-      })
+      errorPayload = {
+        errorType: 'sudo_error',
+        message: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
+        data: { command: e.command, pluginName: this.plugin.name },
+      };
+    } else if (e instanceof ApplyValidationError) {
+      errorPayload = {
+        errorType: 'apply_validation',
+        message: e.message,
+        data: { plan: e.plan.toResponse() },
+      };
+    } else {
+      const isDebug = process.env.DEBUG?.includes('*') ?? false;
+      errorPayload = {
+        errorType: 'unknown',
+        message: isDebug ? (e.stack ?? e.message) : e.message,
+      };
     }
 
-    const isDebug = process.env.DEBUG?.includes('*') ?? false;
-
-    process.send?.({
-      cmd,
-      // @ts-expect-error TS2239
-      requestId: message.requestId || undefined,
-      data: isDebug ? e.stack : e.message,
-      status: MessageStatus.ERROR,
-    })
+    process.send?.({ cmd, requestId, data: errorPayload, status: MessageStatus.ERROR });
   }
 }