codify-schemas 1.0.25 → 1.0.27

package/dist/index.d.ts

@@ -9,5 +9,7 @@ import PlanRequestDataSchema from './messages/plan-request-data-schema.json';
 import PlanResponseDataSchema from './messages/plan-response-data-schema.json';
 import ValidateRequestDataSchema from './messages/validate-request-data-schema.json';
 import ValidateResponseDataSchema from './messages/validate-response-data-schema.json';
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, };
+import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json';
+import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json';
+export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, };
 export * from './types/index.js';

package/dist/index.js

@@ -9,6 +9,8 @@ import PlanRequestDataSchema from './messages/plan-request-data-schema.json' ass
 import PlanResponseDataSchema from './messages/plan-response-data-schema.json' assert { type: 'json' };
 import ValidateRequestDataSchema from './messages/validate-request-data-schema.json' assert { type: 'json' };
 import ValidateResponseDataSchema from './messages/validate-response-data-schema.json' assert { type: 'json' };
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, };
+import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json' assert { type: 'json' };
+import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' assert { type: 'json' };
+export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, };
 export * from './types/index.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AAC/E,OAAO,aAAa,MAAM,uBAAuB,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AACxE,OAAO,cAAc,MAAM,wBAAwB,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1E,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AAC/E,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AACrG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AACvG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AACvG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AACnG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AACrG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AAC3G,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,SAAS,IAAI,EAAE,MAAM,EAAC,CAAA;AAE7G,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,CAAA;AAED,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9E,OAAO,aAAa,MAAM,uBAAuB,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,cAAc,MAAM,wBAAwB,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACzE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9E,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAGhH,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,GAC7B,CAAA;AAED,cAAc,kBAAkB,CAAC"}

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

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/initialize-request-data-schema.json",
+    "title": "Initialize Request Schema Data",
+    "description": "Initialize the plugin",
+    "type": "object",
+    "properties": {},
+    "additionalProperties": false
+}

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

@@ -0,0 +1,31 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://www.codify.com/initialize-response-data-schema.json",
+    "title": "Initialize Request Schema Data",
+    "description": "Initialize the plugin",
+    "type": "object",
+    "properties": {
+        "resourceDefinitions": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "type": {
+                        "type": "string"
+                    },
+                    "dependencies": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "required": [
+                    "type",
+                    "dependencies"
+                ]
+            }
+        }
+    },
+    "required": ["resourceDefinitions"]
+}

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

@@ -2,5 +2,16 @@
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://www.codify.com/validate-response-data-schema.json",
     "title": "Validate Response Schema Data",
-    "type": "null"
+    "type": "object",
+    "properties": {
+        "isValid": {
+            "type": "boolean"
+        },
+        "errors": {
+            "type": "array",
+            "description": "Any errors in validation"
+        }
+    },
+    "required": ["isValid"],
+    "additionalProperties": false
 }

package/dist/types/index.d.ts

@@ -22,7 +22,10 @@ export interface IpcMessage {
 export interface ValidateRequestData {
     configs: ResourceConfig[];
 }
-export type ValidateResponseData = null;
+export interface ValidateResponseData {
+    isValid: boolean;
+    errors: unknown[] | null;
+}
 export interface PlanRequestData extends ResourceConfig {
 }
 export declare enum ResourceOperation {
@@ -53,3 +56,13 @@ export interface PlanResponseData {
 export interface ApplyRequestData {
     planId: string;
 }
+export interface ResourceDefinition {
+    type: string;
+    dependencies: string[];
+}
+export interface InitializeRequestData {
+}
+export interface InitializeResponseData {
+    type: string;
+    dependencies: string[];
+}

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;AAgBD,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":"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"}

package/package.json

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

package/src/index.ts

@@ -1,15 +1,18 @@
 // @ts-ignore
-import ConfigFileSchema from './config-file-schema.json' assert { type: 'json'}
-import ProjectSchema from './project-schema.json' assert { type: 'json'}
-import ResourceSchema from './resource-schema.json' assert { type: 'json'}
-import IpcMessageSchema from './ipc-message-schema.json' assert { type: 'json'}
-import ApplyRequestDataSchema from './messages/apply-request-data-schema.json' assert { type: 'json'}
-import ApplyResponseDataSchema from './messages/apply-response-data-schema.json' assert { type: 'json'}
-import ErrorResponseDataSchema from './messages/error-response-data-schema.json' assert { type: 'json'}
-import PlanRequestDataSchema from './messages/plan-request-data-schema.json' assert { type: 'json'}
-import PlanResponseDataSchema from './messages/plan-response-data-schema.json' assert { type: 'json'}
-import ValidateRequestDataSchema from './messages/validate-request-data-schema.json' assert { type: 'json'}
-import ValidateResponseDataSchema from './messages/validate-response-data-schema.json' assert { type: 'json'}
+import ConfigFileSchema from './config-file-schema.json' assert {type: 'json'}
+import ProjectSchema from './project-schema.json' assert {type: 'json'}
+import ResourceSchema from './resource-schema.json' assert {type: 'json'}
+import IpcMessageSchema from './ipc-message-schema.json' assert {type: 'json'}
+import ApplyRequestDataSchema from './messages/apply-request-data-schema.json' assert {type: 'json'}
+import ApplyResponseDataSchema from './messages/apply-response-data-schema.json' assert {type: 'json'}
+import ErrorResponseDataSchema from './messages/error-response-data-schema.json' assert {type: 'json'}
+import PlanRequestDataSchema from './messages/plan-request-data-schema.json' assert {type: 'json'}
+import PlanResponseDataSchema from './messages/plan-response-data-schema.json' assert {type: 'json'}
+import ValidateRequestDataSchema from './messages/validate-request-data-schema.json' assert {type: 'json'}
+import ValidateResponseDataSchema from './messages/validate-response-data-schema.json' assert {type: 'json'}
+import InitializeRequestDataSchema from './messages/initialize-request-data-schema.json' assert {type: 'json'}
+import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' assert {type: 'json'}
+
 
 export {
   ConfigFileSchema,
@@ -23,6 +26,8 @@ export {
   PlanResponseDataSchema,
   ValidateRequestDataSchema,
   ValidateResponseDataSchema,
+  InitializeRequestDataSchema,
+  InitializeResponseDataSchema,
 }
 
 export * from './types/index.js';

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

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/initialize-request-data-schema.json",
+  "title": "Initialize Request Schema Data",
+  "description": "Initialize the plugin",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

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

@@ -0,0 +1,19 @@
+import schema from './initialize-request-data-schema.json';
+import {describe, expect, it} from 'vitest'
+import Ajv2020 from 'ajv/dist/2020.js'
+
+const ajv = new Ajv2020.default({
+  strict: true,
+})
+
+describe('Get resources response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("requires an empty object", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({})).to.be.true;
+  })
+
+})

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

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://www.codify.com/initialize-response-data-schema.json",
+  "title": "Initialize Request Schema Data",
+  "description": "Initialize the plugin",
+  "type": "object",
+  "properties": {
+    "resourceDefinitions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string"
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "type",
+          "dependencies"
+        ]
+      }
+    }
+  },
+  "required": ["resourceDefinitions"]
+}

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

@@ -0,0 +1,41 @@
+import schema from './initialize-response-data-schema.json';
+import {describe, expect, it} from 'vitest'
+import Ajv2020 from 'ajv/dist/2020.js'
+
+const ajv = new Ajv2020.default({
+  strict: true,
+})
+
+describe('Get resources response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("requires type and dependencies to be defined", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      resourceDefinitions: [
+        {
+          type: 'typeA',
+          dependencies: ['typeB']
+        },
+        {
+          type: 'typeB',
+          dependencies: [],
+        }
+      ]
+    })).to.be.true;
+
+    expect(validate({
+      resourceDefinitions: [
+        {
+          dependencies: ['typeB']
+        },
+        {
+          type: 'typeB',
+        }
+      ]
+    })).to.be.false;
+  });
+
+})

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

@@ -2,5 +2,16 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://www.codify.com/validate-response-data-schema.json",
   "title": "Validate Response Schema Data",
-  "type": "null"
+  "type": "object",
+  "properties": {
+    "isValid": {
+      "type": "boolean"
+    },
+    "errors": {
+      "type": "array",
+      "description": "Any errors in validation"
+    }
+  },
+  "required": ["isValid"],
+  "additionalProperties": false
 }

package/src/types/index.ts

@@ -28,7 +28,10 @@ export interface ValidateRequestData {
   configs: ResourceConfig[];
 }
 
-export type ValidateResponseData = null;
+export interface ValidateResponseData {
+  isValid: boolean;
+  errors: unknown[] | null;
+}
 
 export interface PlanRequestData extends ResourceConfig {}
 
@@ -63,3 +66,15 @@ export interface PlanResponseData {
 export interface ApplyRequestData {
   planId: string;
 }
+
+export interface ResourceDefinition {
+  type: string;
+  dependencies: string[];
+}
+
+export interface InitializeRequestData {}
+
+export interface InitializeResponseData {
+  type: string;
+  dependencies: string[];
+}