codify-schemas 1.0.60 → 1.0.61

package/dist/index.d.ts

@@ -270,9 +270,12 @@ declare const ImportRequestDataSchema: {
     title: string;
     type: string;
     properties: {
-        config: {
+        core: {
             $ref: string;
         };
+        parameters: {
+            type: string;
+        };
     };
     required: string[];
 };
@@ -283,12 +286,28 @@ declare const ImportResponseDataSchema: {
     type: string;
     properties: {
         request: {
-            $ref: string;
+            type: string;
+            properties: {
+                core: {
+                    $ref: string;
+                };
+                parameters: {
+                    type: string;
+                };
+            };
         };
         result: {
             type: string;
             items: {
-                $ref: string;
+                type: string;
+                properties: {
+                    core: {
+                        $ref: string;
+                    };
+                    parameters: {
+                        type: string;
+                    };
+                };
             };
         };
     };
@@ -300,11 +319,16 @@ declare const PlanRequestDataSchema: {
     title: string;
     type: string;
     properties: {
-        desired: {
+        core: {
             $ref: string;
         };
+        desired: {
+            type: string;
+            description: string;
+        };
         state: {
-            $ref: string;
+            type: string;
+            description: string;
         };
         isStateful: {
             type: string;
@@ -382,7 +406,15 @@ declare const ValidateRequestDataSchema: {
         configs: {
             type: string;
             items: {
-                $ref: string;
+                type: string;
+                properties: {
+                    core: {
+                        $ref: string;
+                    };
+                    parameters: {
+                        type: string;
+                    };
+                };
             };
         };
     };

package/dist/messages/import-request-data-schema.json

@@ -4,9 +4,12 @@
     "title": "Import Request Schema Data",
     "type": "object",
     "properties": {
-        "config": {
+        "core": {
             "$ref": "resource-schema.json"
+        },
+        "parameters": {
+            "type": "object"
         }
     },
-    "required": ["config"]
+    "required": ["core", "parameters"]
 }

package/dist/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"
+                    }
+                }
             }
         }
     },

package/dist/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",
@@ -17,7 +22,7 @@
     },
     "additionalProperties": false,
     "anyOf": [
-        { "required": ["desired", "isStateful"] },
-        { "required": ["state", "isStateful"] }
+        { "required": ["core", "desired", "isStateful"] },
+        { "required": ["core", "state", "isStateful"] }
     ]
 }

package/dist/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"
+                    }
+                }
             }
         }
     },

package/dist/types/index.d.ts

@@ -31,8 +31,16 @@ export interface IpcMessageV2 {
     status?: MessageStatus;
     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 {
     resourceValidations: Array<{
@@ -44,8 +52,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;
 }
 export declare enum ResourceOperation {
@@ -87,11 +96,12 @@ 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 {
     planId?: string;
@@ -115,10 +125,7 @@ export interface ResourceDefinition {
 export interface InitializeRequestData {
 }
 export interface InitializeResponseData {
-    resourceDefinitions: Array<{
-        type: string;
-        dependencies: string[];
-    }>;
+    resourceDefinitions: Array<ResourceDefinition>;
 }
 export interface SudoRequestData {
     command: string;

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAmCD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA4ED,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AA6CD,MAAM,CAAN,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EANW,iBAAiB,KAAjB,iBAAiB,QAM5B;AAED,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iCAAW,CAAA;IACX,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,mCAAa,CAAA;AACf,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA0ED,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,8BAAe,CAAA;AACjB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-schemas",
-  "version": "1.0.60",
+  "version": "1.0.61",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

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

@@ -4,9 +4,12 @@
   "title": "Import Request Schema Data",
   "type": "object",
   "properties": {
-    "config": {
+    "core": {
       "$ref": "resource-schema.json"
+    },
+    "parameters": {
+      "type": "object"
     }
   },
-  "required": ["config"]
+  "required": ["core", "parameters"]
 }

package/src/messages/import-request-data-schema.test.ts

@@ -17,30 +17,34 @@ describe('Import request data schema', () => {
   it("Validates correct data", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      config: {
+      core: {
         type: "type"
       },
+      parameters: {},
     })).to.be.true;
     expect(validate({
-      config: {
+      core: {
         type: "type",
         name: "name",
+      },
+      parameters: {
         propA: "a",
         propB: { a: 'b' }
       },
     })).to.be.true;
     expect(validate({
-      config: {
+      core: {
         type: "type",
         dependsOn: ["a", "b"]
       },
+      parameters: {},
     })).to.be.true;
   })
 
   it("Errors on incorrect data", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      config: {},
+      core: {},
     })).to.be.false;
     expect(validate({})).to.be.false;
   })

package/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"
+          }
+        }
       }
     }
   },

package/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",
@@ -17,7 +22,7 @@
   },
   "additionalProperties": false,
   "anyOf": [
-    { "required": ["desired", "isStateful"] },
-    { "required": ["state", "isStateful"] }
+    { "required": ["core", "desired", "isStateful"] },
+    { "required": ["core", "state", "isStateful"] }
   ]
 }

package/src/messages/plan-request-data-schema.test.ts

@@ -17,23 +17,22 @@ describe('Plan request data schema', () => {
   it("It accepts either state, desired or both", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      desired: {
-        type: "type"
-      },
+      core: { type: "type" },
+      desired: {},
       isStateful: false
     })).to.be.true;
     expect(validate({
-      state: {
-        type: "type"
-      },
+      core: { type: "type" },
+      state: {},
       isStateful: false
     })).to.be.true;
     expect(validate({
+      core: { type: "type" },
       desired: {
-        type: "type"
+        parameter1: 'a'
       },
       state: {
-        type: "type"
+        parameter2: 'b'
       },
       isStateful: false
     })).to.be.true;
@@ -43,22 +42,34 @@ describe('Plan request data schema', () => {
   it ("name and type are alpha-numeric and follow variable naming conventions", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      desired: { type: "a234abcDEF_-" },
+      core: { type: "a234abcDEF_-" },
+      desired: { },
       isStateful: false
     })).to.be.true;
+
     expect(validate({
+      core: { type: "234" },
       desired: { type: "234" },
       isStateful: false
     })).to.be.false;
+
     expect(validate({
-      desired: { type: "ABCDEF$" },
+      core: { type: "ABCDEF$" },
+      desired: { },
       isStateful: false
     })).to.be.false;
 
     expect(validate({
-      desired: { type: "type", name: "a234abcDEF_-" },
+      core: { type: "type", name: "a234abcDEF_-" },
+      desired: {  },
       isStateful: false
     })).to.be.true;
+    expect(validate({
+      core: { type: "type", name: "ABCDEF$" },
+      desired: {},
+      isStateful: false
+    })).to.be.false;
+
     expect(validate({
       desired: { type: "type", name: "ABCDEF$" },
       isStateful: false

package/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"
+          }
+        }
       }
     }
   },

package/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 {