codify-schemas 1.0.39 → 1.0.41

package/dist/config-file-schema.json

@@ -4,6 +4,14 @@
     "title": "Config file Schema",
     "type": "array",
     "items": {
-        "$ref": "resource-schema.json"
+        "type": "object",
+        "properties": {
+            "type": {
+                "type": "string",
+                "description": "All config blocks must contain the keyword type",
+                "pattern": "^[a-zA-Z][\\w-]+$"
+            }
+        },
+        "required": ["type"]
     }
 }

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

@@ -4,7 +4,7 @@
     "title": "Validate Response Schema Data",
     "type": "object",
     "properties": {
-        "validationResults": {
+        "resourceValidations": {
             "type": "array",
             "items": {
                 "type": "object",
@@ -15,15 +15,23 @@
                     "resourceName": {
                         "type": "string"
                     },
-                    "isValid": {
-                        "type": "boolean"
-                    },
-                    "errors": {
+                    "schemaValidationErrors": {
                         "type": "array",
-                        "description": "Any errors in validation"
+                        "description": "Schema validation errors. Right now only ajv schemas are supported",
+                        "items": {
+                            "type": "object"
+                        }
+                    },
+                    "customValidationErrorMessage": {
+                        "type": "string",
+                        "description": "Custom plugin validation errors. These are a string that should be displayed to the user"
+                    },
+                    "isValid": {
+                        "type": "boolean",
+                        "description": "Indicates if the resources are valid. True if no errors, false if there are"
                     }
                 },
-                "required": ["resourceType", "isValid"]
+                "required": ["resourceType", "isValid", "schemaValidationErrors"]
             }
         }
     },

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 import { SpawnOptions } from "node:child_process";
+import { ErrorObject } from "ajv";
 export interface StringIndexedObject {
     [x: string]: unknown;
 }
@@ -28,11 +29,12 @@ export interface ValidateRequestData {
     configs: ResourceConfig[];
 }
 export interface ValidateResponseData {
-    validationResults: Array<{
+    resourceValidations: Array<{
         resourceType: string;
         resourceName?: string;
+        schemaValidationErrors?: ErrorObject[] | null;
+        customValidationErrorMessage: string;
         isValid: boolean;
-        errors?: unknown[] | null;
     }>;
 }
 export interface PlanRequestData extends ResourceConfig {

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAqBA,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;AAmDD,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;AAwBD,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;AAmDD,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.39",
+  "version": "1.0.41",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/config-file-schema.json

@@ -4,6 +4,14 @@
   "title": "Config file Schema",
   "type": "array",
   "items": {
-    "$ref": "resource-schema.json"
+    "type": "object",
+    "properties": {
+      "type": {
+        "type": "string",
+        "description": "All config blocks must contain the keyword type",
+        "pattern": "^[a-zA-Z][\\w-]+$"
+      }
+    },
+    "required": ["type"]
   }
 }

package/src/config-file-schema.test.ts

@@ -1,20 +1,20 @@
-import configSchema from './config-file-schema.json';
-import resourceSchema from './resource-schema.json';
+import configFileSchema from './config-file-schema.json';
 import { describe, it, expect } from 'vitest'
 import Ajv2020 from 'ajv/dist/2020.js'
 
 const ajv = new Ajv2020.default({
   strict: true,
 })
-ajv.addSchema(resourceSchema);
 
-describe("config file schema tests", () => {
-  it('compiles', () => {
-    ajv.compile(configSchema);
+describe("Config file schema tests", () => {
+  it('Compiles', () => {
+    ajv.compile(configFileSchema);
   })
 
-  it('accepts resource blocks', () => {
-    const validator = ajv.compile(configSchema);
+  it('And successfully validate blocks with type', () => {
+    const validator = ajv.compile(configFileSchema);
+
+    expect(validator([])).to.be.true;
 
     expect(validator([
       {
@@ -33,18 +33,39 @@ describe("config file schema tests", () => {
     expect(validator([
       {
         "type": "resource1",
-      },
-      {}
-    ])).to.be.false;
+      }
+    ])).to.be.true;
 
     expect(validator([
       {
         "type": "project",
-      },
-      {
-        "type": "resource2"
+        "description": "description",
       }
     ])).to.be.true;
   })
 
+  it('And errors on improper json', () => {
+    const validator = ajv.compile(configFileSchema);
+
+    expect(validator({
+      "a": {},
+      "b": {},
+    })).to.be.false;
+
+    expect(validator([
+      {
+        "type": "resource1"
+      },
+      "homebrew"
+    ])).to.be.false;
+
+    validator([
+      {
+        "type": "resource1"
+      },
+      {}
+    ])
+
+    console.log(validator.errors)
+  })
 })

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

@@ -4,7 +4,7 @@
   "title": "Validate Response Schema Data",
   "type": "object",
   "properties": {
-    "validationResults": {
+    "resourceValidations": {
       "type": "array",
       "items": {
         "type": "object",
@@ -15,15 +15,23 @@
           "resourceName": {
             "type": "string"
           },
-          "isValid": {
-            "type": "boolean"
-          },
-          "errors": {
+          "schemaValidationErrors": {
             "type": "array",
-            "description": "Any errors in validation"
+            "description": "Schema validation errors. Right now only ajv schemas are supported",
+            "items": {
+              "type": "object"
+            }
+          },
+          "customValidationErrorMessage": {
+            "type": "string",
+            "description": "Custom plugin validation errors. These are a string that should be displayed to the user"
+          },
+          "isValid": {
+            "type": "boolean",
+            "description": "Indicates if the resources are valid. True if no errors, false if there are"
           }
         },
-        "required": ["resourceType", "isValid"]
+        "required": ["resourceType", "isValid", "schemaValidationErrors"]
       }
     }
   },

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

@@ -17,9 +17,24 @@ describe('Plan response data 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"] },
+      resourceValidations: [
+        {
+          resourceType: 'abc',
+          schemaValidationErrors: [],
+          isValid: true
+        },
+        {
+          resourceType: 'abc',
+          resourceName: 'def',
+          schemaValidationErrors: [
+            {
+              schemaPath: '/0',
+              instancePath: '/0'
+            }
+          ],
+          customValidationErrorMessage: "this is also an error message",
+          isValid: false,
+        },
       ]
     } as ValidateResponseData)).to.be.true;
   })
@@ -27,7 +42,7 @@ describe('Plan response data schema', () => {
   it ("validates incorrect config", () => {
     const validate = ajv.compile(schema);
     expect(validate({
-      validationResults: [
+      resourceValidations: [
         { resourceName: 'abc', isValid: true },
       ]
     } as ValidateResponseData)).to.be.false;

package/src/types/index.ts

@@ -1,4 +1,5 @@
-import {SpawnOptions} from "node:child_process";
+import { SpawnOptions } from "node:child_process";
+import { ErrorObject } from "ajv";
 
 export interface StringIndexedObject {
   [x: string]: unknown;
@@ -35,11 +36,12 @@ export interface ValidateRequestData {
 }
 
 export interface ValidateResponseData {
-  validationResults: Array<{
+  resourceValidations: Array<{
     resourceType: string;
     resourceName?: string;
+    schemaValidationErrors?: ErrorObject[] | null;
+    customValidationErrorMessage: string;
     isValid: boolean;
-    errors?: unknown[] | null;
   }>;
 }