codify-schemas 1.0.30 → 1.0.32

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

@@ -49,12 +49,16 @@
                             },
                             "newValue": {
                                 "description": "The new value"
+                            },
+                            "previousValue": {
+                                "description": "The new value"
                             }
                         },
                         "required": [
                             "name",
                             "operation",
-                            "newValue"
+                            "newValue",
+                            "previousValue"
                         ]
                     }
                 }

package/dist/messages/validate-response-data-schema.json

@@ -4,14 +4,28 @@
     "title": "Validate Response Schema Data",
     "type": "object",
     "properties": {
-        "isValid": {
-            "type": "boolean"
-        },
-        "errors": {
+        "validationResults": {
             "type": "array",
-            "description": "Any errors in validation"
+            "items": {
+                "type": "object",
+                "properties": {
+                    "resourceType": {
+                        "type": "string"
+                    },
+                    "resourceName": {
+                        "type": "string"
+                    },
+                    "isValid": {
+                        "type": "boolean"
+                    },
+                    "errors": {
+                        "type": "array",
+                        "description": "Any errors in validation"
+                    }
+                },
+                "required": ["resourceType", "isValid"]
+            }
         }
     },
-    "required": ["isValid"],
     "additionalProperties": false
 }

package/dist/types/index.d.ts

@@ -1,4 +1,7 @@
-export interface Config {
+export interface StringIndexedObject {
+    [x: string]: unknown;
+}
+export interface Config extends StringIndexedObject {
     type: string;
 }
 export interface ProjectConfig extends Config {
@@ -23,8 +26,12 @@ export interface ValidateRequestData {
     configs: ResourceConfig[];
 }
 export interface ValidateResponseData {
-    isValid: boolean;
-    errors: unknown[] | null;
+    validationResults: Array<{
+        resourceType: string;
+        resourceName?: string;
+        isValid: boolean;
+        errors?: unknown[] | null;
+    }>;
 }
 export interface PlanRequestData extends ResourceConfig {
 }
@@ -63,6 +70,7 @@ export interface ApplyRequestData {
             name: string;
             operation: ParameterOperation;
             newValue: unknown | null;
+            previousValue: unknown | null;
         }>;
     };
 }

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAeA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAmBD,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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAmBA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;AACjB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAuBD,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"}

package/package.json

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

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

@@ -49,12 +49,16 @@
               },
               "newValue": {
                 "description": "The new value"
+              },
+              "previousValue": {
+                "description": "The new value"
               }
             },
             "required": [
               "name",
               "operation",
-              "newValue"
+              "newValue",
+              "previousValue"
             ]
           }
         }

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

@@ -32,7 +32,24 @@ describe('Apply request data schema', () => {
         parameters: [{
           name: 'parameter1',
           operation: ParameterOperation.ADD,
-          newValue: 'abc'
+          newValue: 'abc',
+          previousValue: null,
+        }]
+      }
+    } as ApplyRequestData)).to.be.true;
+  })
+
+  it("validates correct empty config (plan)", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      plan: {
+        operation: ResourceOperation.CREATE,
+        resourceType: 'type1',
+        parameters: [{
+          name: 'parameter1',
+          operation: ParameterOperation.NOOP,
+          newValue: null,
+          previousValue: null,
         }]
       }
     } as ApplyRequestData)).to.be.true;

package/src/messages/validate-response-data-schema.json

@@ -4,14 +4,28 @@
   "title": "Validate Response Schema Data",
   "type": "object",
   "properties": {
-    "isValid": {
-      "type": "boolean"
-    },
-    "errors": {
+    "validationResults": {
       "type": "array",
-      "description": "Any errors in validation"
+      "items": {
+        "type": "object",
+        "properties": {
+          "resourceType": {
+            "type": "string"
+          },
+          "resourceName": {
+            "type": "string"
+          },
+          "isValid": {
+            "type": "boolean"
+          },
+          "errors": {
+            "type": "array",
+            "description": "Any errors in validation"
+          }
+        },
+        "required": ["resourceType", "isValid"]
+      }
     }
   },
-  "required": ["isValid"],
   "additionalProperties": false
 }

package/src/messages/validate-response-data-schema.test.ts

@@ -0,0 +1,36 @@
+import schema from './validate-response-data-schema.json';
+import {describe, expect, it} from 'vitest'
+import Ajv2020 from 'ajv/dist/2020.js'
+import addFormats from 'ajv-formats';
+import {ValidateResponseData} from "../types/index.js";
+
+const ajv = new Ajv2020.default({
+  strict: true,
+})
+addFormats.default(ajv);
+
+describe('Plan response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("validates correct config", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      validationResults: [
+        { resourceType: 'abc', isValid: true },
+        { resourceType: 'abc', resourceName: 'def', isValid: false, errors: ["error1", "error2"] },
+      ]
+    } as ValidateResponseData)).to.be.true;
+  })
+
+  it ("validates incorrect config", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      validationResults: [
+        { resourceName: 'abc', isValid: true },
+      ]
+    } as ValidateResponseData)).to.be.false;
+  });
+
+})

package/src/types/index.ts

@@ -1,4 +1,8 @@
-export interface Config {
+export interface StringIndexedObject {
+  [x: string]: unknown;
+}
+
+export interface Config extends StringIndexedObject {
   type: string;
 }
 
@@ -29,8 +33,12 @@ export interface ValidateRequestData {
 }
 
 export interface ValidateResponseData {
-  isValid: boolean;
-  errors: unknown[] | null;
+  validationResults: Array<{
+    resourceType: string;
+    resourceName?: string;
+    isValid: boolean;
+    errors?: unknown[] | null;
+  }>;
 }
 
 export interface PlanRequestData extends ResourceConfig {}
@@ -73,6 +81,7 @@ export interface ApplyRequestData {
       name: string;
       operation: ParameterOperation;
       newValue: unknown | null;
+      previousValue: unknown | null;
     }>
   }
 }