feat: Separated core parameters and other parameters in ipc messages to make processing easier

Author: kevinwang5658

src/messages/import-request-data-schema.json

@@ -5,7 +5,16 @@
   "type": "object",
   "properties": {
     "config": {
-      "$ref": "resource-schema.json"
+      "type": "object",
+      "properties": {
+        "core": {
+          "$ref": "resource-schema.json"
+        },
+        "parameters": {
+          "type": "object"
+        }
+      },
+      "required": ["core", "parameters"]
     }
   },
   "required": ["config"]

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

@@ -5,12 +5,28 @@
   "type": "object",
   "properties": {
     "request": {
-      "$ref": "resource-schema.json"
+      "type": "object",
+      "properties": {
+        "core": {
+          "$ref": "resource-schema.json"
+        },
+        "parameters": {
+          "type": "object"
+        }
+      }
     },
     "result": {
       "type": "array",
       "items": {
-        "$ref": "resource-schema.json"
+        "type": "object",
+        "properties": {
+          "core": {
+            "$ref": "resource-schema.json"
+          },
+          "parameters": {
+            "type": "object"
+          }
+        }
       }
     }
   },

src/messages/plan-request-data-schema.json

@@ -4,11 +4,16 @@
   "title": "Plan Request Schema Data",
   "type": "object",
   "properties": {
-    "desired": {
+    "core": {
       "$ref": "resource-schema.json"
     },
+    "desired": {
+      "type": "object",
+      "description": "The desired parameters specified by the user. A null desired means this config was not specified (for deletes). Pass an empty object {} for no parameters."
+    },
     "state": {
-      "$ref": "resource-schema.json"
+      "type": "object",
+      "description": "The desired parameters specified by the user.  A null state means this config was not specified (non-stateful). Pass an empty object {} for no parameters."
     },
     "isStateful": {
       "type": "boolean",

src/messages/validate-request-data-schema.json

@@ -7,7 +7,15 @@
     "configs": {
       "type": "array",
       "items": {
-        "$ref": "resource-schema.json"
+        "type": "object",
+        "properties": {
+          "core": {
+            "$ref": "resource-schema.json"
+          },
+          "parameters": {
+            "type": "object"
+          }
+        }
       }
     }
   },

src/types/index.ts

@@ -38,8 +38,17 @@ export interface IpcMessageV2 {
   data: unknown | null;
 }
 
+/**
+ * Processed resource that is in a format suitable for sending. The core parameters (such as type and name) and other parameters
+ * are separate for easier processing.
+ */
+export interface ResourceJson {
+  core: ResourceConfig;
+  parameters: Record<string, unknown>;
+}
+
 export interface ValidateRequestData {
-  configs: ResourceConfig[];
+  configs: Array<ResourceJson>;
 }
 
 export interface ValidateResponseData {
@@ -53,8 +62,9 @@ export interface ValidateResponseData {
 }
 
 export interface PlanRequestData {
-  desired: ResourceConfig | undefined
-  state: ResourceConfig | undefined
+  core: ResourceConfig;
+  desired?: Record<string, unknown>;
+  state?: Record<string, unknown>;
   isStateful: boolean
 }
 
@@ -102,12 +112,13 @@ export interface GetResourceInfoResponseData {
 }
 
 export interface ImportRequestData {
-  config: ResourceConfig;
+  core: ResourceConfig;
+  parameters: Record<string, unknown>;
 }
 
 export interface ImportResponseData {
-  request: ResourceConfig;
-  result: ResourceConfig[];
+  request: ResourceJson
+  result: Array<ResourceJson>,
 }
 
 export interface ApplyRequestData {
@@ -134,10 +145,7 @@ export interface ResourceDefinition {
 export interface InitializeRequestData {}
 
 export interface InitializeResponseData {
-  resourceDefinitions: Array<{
-    type: string;
-    dependencies: string[];
-  }>;
+  resourceDefinitions: Array<ResourceDefinition>;
 }
 
 export interface SudoRequestData {