feat: Add apply notes and improved error response data schemas

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/schemas",
-  "version": "1.1.0-beta6",
+  "version": "1.1.0-beta.10",
   "description": "JSON Schemas and types that govern the message format and Codify config formats for Codify",
   "type": "module",
   "main": "dist/index.js",

src/index.ts

@@ -23,6 +23,7 @@ import PressKeyToContinueRequestDataSchema from './messages/press-key-to-continu
 import PressKeyToContinueResponseDataSchema from './messages/press-key-to-continue-response-data-schema.json' with {type: 'json'};
 import SetVerbosityRequestDataSchema from './messages/set-verbosity-request-data-schema.json' with {type: 'json'};
 import EmptyResponseDataSchema from './messages/empty-response-data-schema.json' with {type: 'json'};
+import ApplyNoteRequestDataSchema from './messages/apply-note-request-data-schema.json' with {type: 'json'};
 
 export {
   ConfigFileSchema,
@@ -50,6 +51,7 @@ export {
   PressKeyToContinueResponseDataSchema,
   SetVerbosityRequestDataSchema,
   EmptyResponseDataSchema,
+  ApplyNoteRequestDataSchema,
 }
 
 export * from './types/index.js';

src/messages/apply-note-request-data-schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/apply-note-request.json",
+  "title": "Apply note request",
+  "description": "Sent by a plugin to leave a post-apply note for the user",
+  "type": "object",
+  "properties": {
+    "message": {
+      "type": "string",
+      "maxLength": 500
+    },
+    "resourceType": {
+      "type": "string",
+      "maxLength": 100
+    }
+  },
+  "required": ["message"],
+  "additionalProperties": false
+}

src/messages/commands.ts

@@ -5,5 +5,6 @@ export enum MessageCmd {
   APPLY = 'apply',
   COMMAND_REQUEST = 'command_request',
   PRESS_KEY_TO_CONTINUE_REQUEST = 'press_key_to_continue_request',
-  CODIFY_CREDENTIALS_REQUEST = 'codify_credentials_request'
+  CODIFY_CREDENTIALS_REQUEST = 'codify_credentials_request',
+  APPLY_NOTE_REQUEST = 'apply_note_request',
 }

src/messages/error-response-data-schema.json

@@ -4,10 +4,17 @@
   "title": "Error Response Schema Data",
   "type": "object",
   "properties": {
-    "reason": {
-      "description": "A human read-able reason for the error",
+    "errorType": {
+      "description": "A string identifier for the error type (e.g. 'apply_validation', 'sudo_error', 'unknown')",
       "type": "string"
+    },
+    "message": {
+      "description": "A human-readable error message, always present",
+      "type": "string"
+    },
+    "data": {
+      "description": "Optional structured payload whose shape depends on errorType"
     }
   },
-  "required": ["reason"]
+  "required": ["errorType", "message"]
 }

src/types/index.ts

@@ -33,6 +33,12 @@ export enum MessageStatus {
   ERROR = 'error',
 }
 
+export interface PluginErrorData {
+  errorType: string;
+  message: string;
+  data?: unknown;
+}
+
 export interface IpcMessage {
   cmd: string;
   status?: MessageStatus;
@@ -106,6 +112,7 @@ export interface PlanResponseData {
   }>
 }
 
+
 export interface GetResourceInfoRequestData {
   type: string;
 }
@@ -228,6 +235,11 @@ export interface SetVerbosityRequestData {
 
 export interface EmptyResponseData {}
 
+export interface ApplyNoteRequestData {
+  message: string;
+  resourceType?: string;
+}
+
 export enum SpawnStatus {
   SUCCESS = 'success',
   ERROR = 'error',