codify-schemas 1.0.45 → 1.0.47

package/README.md

@@ -0,0 +1,3 @@
+## Codify Schemas
+
+JSON schemas for config validation for [codify CLI](https://codifycli.com).

package/dist/index.d.ts

@@ -1,10 +1,11 @@
-import ConfigFileSchema from './config-file-schema.json';
 import ProjectSchema from './project-schema.json';
 import ResourceSchema from './resource-schema.json';
 import IpcMessageSchema from './ipc-message-schema.json';
 import ApplyRequestDataSchema from './messages/apply-request-data-schema.json';
 import ApplyResponseDataSchema from './messages/apply-response-data-schema.json';
 import ErrorResponseDataSchema from './messages/error-response-data-schema.json';
+import GetResourceInfoRequestDataSchema from './messages/get-resource-info-request-data-schema.json';
+import GetResourceInfoResponseDataSchema from './messages/get-resource-info-response-data-schema.json';
 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';
@@ -13,6 +14,6 @@ import InitializeRequestDataSchema from './messages/initialize-request-data-sche
 import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json';
 import SudoRequestDataSchema from './messages/sudo-request-data-schema.json';
 import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json';
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
+export { ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
 export * from './types/index.js';
 export * from './messages/commands.js';

package/dist/index.js

@@ -1,10 +1,11 @@
-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 GetResourceInfoRequestDataSchema from './messages/get-resource-info-request-data-schema.json' assert { type: 'json' };
+import GetResourceInfoResponseDataSchema from './messages/get-resource-info-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' };
@@ -13,7 +14,7 @@ import InitializeRequestDataSchema from './messages/initialize-request-data-sche
 import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' assert { type: 'json' };
 import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' assert { type: 'json' };
 import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' assert { type: 'json' };
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
+export { ProjectSchema, ResourceSchema, IpcMessageSchema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
 export * from './types/index.js';
 export * from './messages/commands.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,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;AAChH,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AACnG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AAE5G,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,EAC5B,qBAAqB,EACrB,6BAA6B,GAC9B,CAAA;AAED,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,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,gCAAgC,MAAM,uDAAuD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5H,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;AAChH,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AACnG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,SAAQ,IAAI,EAAE,MAAM,EAAC,CAAC;AAE5G,OAAO,EAEL,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,gCAAgC,EAChC,iCAAiC,EACjC,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,6BAA6B,GAC9B,CAAA;AAED,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC"}

package/dist/messages/get-resource-info-request-data-schema.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+    "title": "Get Resource Schema",
+    "type": "object",
+    "properties": {
+        "type": {
+            "type": "string",
+            "description": "The id/type of the resource"
+        }
+    },
+    "required": ["type"]
+}

package/dist/messages/get-resource-info-response-data-schema.json

@@ -0,0 +1,27 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+    "title": "Get Resource Schema",
+    "type": "object",
+    "properties": {
+        "plugin": {
+            "type": "string",
+            "description": "The plugin the resource is from"
+        },
+        "type": {
+            "type": "string",
+            "description": "The id/type of the resource"
+        },
+        "schema": {
+            "type": "object",
+            "description": "The JSON Schema validation schema for the resource."
+        },
+        "dependencies": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        }
+    },
+    "required": ["type", "plugin"]
+}

package/dist/types/index.d.ts

@@ -67,6 +67,15 @@ export interface PlanResponseData {
         newValue: unknown | null;
     }>;
 }
+export interface GetResourceInfoRequestData {
+    type: string;
+}
+export interface GetResourceInfoResponseData {
+    plugin: string;
+    type: string;
+    schema?: Record<string, unknown>;
+    dependencies?: string[];
+}
 export interface ApplyRequestData {
     planId?: string;
     plan?: {

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;AA4BD,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;AA4BD,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;AA8DD,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.45",
+  "version": "1.0.47",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/index.ts

@@ -1,11 +1,13 @@
 // @ts-ignore
-import ConfigFileSchema from './config-file-schema.json' assert {type: 'json'}
+// import ConfigFileSchema from './config-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 GetResourceInfoRequestDataSchema from './messages/get-resource-info-request-data-schema.json' assert {type: 'json'}
+import GetResourceInfoResponseDataSchema from './messages/get-resource-info-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'}
@@ -16,13 +18,15 @@ import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' ass
 import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' assert {type: 'json'};
 
 export {
-  ConfigFileSchema,
+  // ConfigFileSchema,
   ProjectSchema,
   ResourceSchema,
   IpcMessageSchema,
   ApplyRequestDataSchema,
   ApplyResponseDataSchema,
   ErrorResponseDataSchema,
+  GetResourceInfoRequestDataSchema,
+  GetResourceInfoResponseDataSchema,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
   ValidateRequestDataSchema,

package/src/messages/get-resource-info-request-data-schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+  "title": "Get Resource Schema",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "description": "The id/type of the resource"
+    }
+  },
+  "required": ["type"]
+}

package/src/messages/get-resource-info-request-data-schema.test.ts

@@ -0,0 +1,26 @@
+import schema from './get-resource-info-request-data-schema.json';
+import { describe, it, expect } from 'vitest'
+import Ajv from 'ajv'
+
+const ajv = new Ajv.default({
+  strict: true,
+})
+
+describe('Get resources response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("Validates a correct response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      type: 'type',
+    })).to.be.true;
+  })
+
+  it("Rejects an invalid response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({})).to.be.false;
+  })
+
+})

package/src/messages/get-resource-info-response-data-schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+  "title": "Get Resource Schema",
+  "type": "object",
+  "properties": {
+    "plugin": {
+      "type": "string",
+      "description": "The plugin the resource is from"
+    },
+    "type": {
+      "type": "string",
+      "description": "The id/type of the resource"
+    },
+    "schema": {
+      "type": "object",
+      "description": "The JSON Schema validation schema for the resource."
+    },
+    "dependencies": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": ["type", "plugin"]
+}

package/src/messages/get-resource-info-response-data-schema.test.ts

@@ -0,0 +1,126 @@
+import schema from './get-resource-info-response-data-schema.json';
+import { describe, it, expect } from 'vitest'
+import Ajv from 'ajv'
+import {GetResourceInfoResponseData} from "../types";
+
+const ajv = new Ajv.default({
+  strict: true,
+})
+
+describe('Get resources response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("Validates a correct response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      type: 'type',
+      plugin: 'core-plugin',
+      schema: {
+        "$schema": "http://json-schema.org/draft-07/schema",
+        "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+        "title": "Get Resource Schema",
+        "type": "object",
+        "properties": {
+          "plugin": {
+            "type": "string",
+            "description": "The plugin the resource is from"
+          },
+          "type": {
+            "type": "string",
+            "description": "The id/type of the resource"
+          },
+          "schema": {
+            "type": "object",
+            "description": "The JSON Schema validation schema for the resource."
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        dependencies: [
+          "typeA",
+          "typeB"
+        ]
+      }
+    })).to.be.true;
+
+    expect(validate({
+      type: 'type',
+      plugin: 'core-plugin',
+    })).to.be.true;
+
+    const a: GetResourceInfoResponseData = {
+      type: 'type',
+      plugin: 'core-plugin',
+      schema: {
+        "$schema": "http://json-schema.org/draft-07/schema",
+        "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+        "title": "Get Resource Schema",
+        "type": "object",
+        "properties": {
+          "plugin": {
+            "type": "string",
+            "description": "The plugin the resource is from"
+          },
+          "type": {
+            "type": "string",
+            "description": "The id/type of the resource"
+          },
+          "schema": {
+            "type": "object",
+            "description": "The JSON Schema validation schema for the resource."
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        dependencies: [
+          "typeA",
+          "typeB"
+        ]
+      }
+    }
+  })
+
+  it("Rejects an invalid response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      schema: {
+        "$schema": "http://json-schema.org/draft-07/schema",
+        "$id": "https://www.codifycli.com/get-resource-schema-data-schema.json",
+        "title": "Get Resource Schema",
+        "type": "object",
+        "properties": {
+          "plugin": {
+            "type": "string",
+            "description": "The plugin the resource is from"
+          },
+          "type": {
+            "type": "string",
+            "description": "The id/type of the resource"
+          },
+          "schema": {
+            "type": "object",
+            "description": "The JSON Schema validation schema for the resource."
+          },
+          "dependencies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      }
+
+    })).to.be.false;
+  })
+
+})

package/src/schemastore/codify-schema.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/codify-schema.json",
+  "title": "JSON schema for Codify configuration files",
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "type": {
+        "type": "string",
+        "description": "Specifies the type of the config block. Ex: project, homebrew",
+        "pattern": "^[a-zA-Z][\\w-]+$"
+      }
+    },
+    "required": ["type"],
+    "allOf": [
+      {
+        "if": {
+          "properties": {
+            "type": { "enum": ["project"] }
+          },
+          "required": ["type"]
+        },
+        "then": {
+          "description": "Represents a project configuration block\nhttps://docs.codifycli.com/user-guide/codify-json/#project-configs",
+          "properties": {
+            "type": {},
+            "version": {
+              "description": "Specifies a CLI version constraint. An error will be throw if the CLI version is outside of the semver range",
+              "type": "string",
+              "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-]+)?$"
+            },
+            "plugins": {
+              "description": "A list of third party plugins to include.",
+              "type": "object",
+              "patternProperties": {
+                ".*": {
+                  "type": "string"
+                }
+              }
+            },
+            "description": {
+              "description": "An optional description of the project. This value is not applied.",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      {
+        "if": {
+          "not": {
+            "properties": {
+              "type": {
+                "enum": ["project"]
+              }
+            }
+          },
+          "required": ["type"]
+        },
+        "then": {
+          "description": "Represents a resource configuration block\nhttps://docs.codifycli.com/user-guide/codify-json/#resource-configs",
+          "properties": {
+            "name": {
+              "type": "string",
+              "pattern": "^[\\w-]+$",
+              "description": "Optionally specify a name. Useful for specifying multiple resources of the same type"
+            },
+            "dependsOn": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "uniqueItems": true,
+              "description": "Specify resource dependencies. Must be the type or id of another resource"
+            }
+          },
+          "additionalProperties": true
+        }
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,87 @@
+import schema from './codify-schema.json';
+import { describe, it, expect } from 'vitest'
+import Ajv from 'ajv'
+
+const ajv = new Ajv.default({
+  strict: true,
+})
+
+describe("Config file schema tests", () => {
+  it('Compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it('And successfully validate blocks with type', () => {
+    const validator = ajv.compile(schema);
+
+    expect(validator([])).to.be.true;
+
+    expect(validator([
+      {
+        "type": "resource1",
+      },
+      {
+        "type": "resource2",
+        "name": "abc",
+        "prop1": {
+          "a": "b",
+        },
+        "prop2": "c"
+      }
+    ])).to.be.true;
+
+    expect(validator([
+      {
+        "type": "resource1",
+        "dependsOn": [
+          "resource2"
+        ]
+      }
+    ])).to.be.true;
+
+    expect(validator([
+      {
+        "type": "project",
+        "version": "0.0.1",
+        "description": "description",
+      }
+    ])).to.be.true;
+  })
+
+  it('And errors on improper json', () => {
+    const validator = ajv.compile(schema);
+
+    expect(validator({
+      "a": {},
+      "b": {},
+    })).to.be.false;
+
+    expect(validator([
+      {
+        "type": "resource1"
+      },
+      "homebrew"
+    ])).to.be.false;
+
+    expect(validator([
+      {
+        "type": "resource1"
+      },
+      {}
+    ])).to.be.false;
+
+    expect(validator([
+      {
+        "type": "resource1",
+        "dependsOn": {}
+      }
+    ])).to.be.false;
+
+    expect(validator([
+      {
+        "type": "project",
+        "additionalProperty": true
+      }
+    ])).to.be.false;
+  })
+})

package/src/types/index.ts

@@ -1,5 +1,5 @@
 import { SpawnOptions } from "node:child_process";
-import { ErrorObject } from "ajv";
+import {ErrorObject, JSONSchemaType} from "ajv";
 
 export interface StringIndexedObject {
   [x: string]: unknown;
@@ -79,6 +79,17 @@ export interface PlanResponseData {
   }>
 }
 
+export interface GetResourceInfoRequestData {
+  type: string;
+}
+
+export interface GetResourceInfoResponseData {
+  plugin: string;
+  type: string;
+  schema?: Record<string, unknown>,
+  dependencies?: string[],
+}
+
 export interface ApplyRequestData {
   planId?: string;
   plan?: {

package/src/messages/get-resources-response-data-schema.json

@@ -1,28 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema",
-  "$id": "https://www.codifycli.com/get-resources-response-data-schema.json",
-  "title": "Get Resources Response Schema Data",
-  "type": "object",
-  "properties": {
-    "resources": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "type": {
-            "$ref": "resource-schema.json#/properties/type"
-          },
-          "dependencies": {
-            "type": "array",
-            "items":  {
-              "type": "string"
-            }
-          }
-        },
-        "required": ["type"]
-      }
-    }
-  },
-  "required": ["resources"],
-  "additionalProperties": false
-}

package/src/messages/get-resources-response-data-schema.test.ts

@@ -1,43 +0,0 @@
-import schema from './get-resources-response-data-schema.json';
-import resourceSchema from '../resource-schema.json'
-import { describe, it, expect } from 'vitest'
-import Ajv from 'ajv'
-
-const ajv = new Ajv.default({
-  strict: true,
-})
-ajv.addSchema(resourceSchema);
-
-describe('Get resources response data schema', () => {
-  it('compiles', () => {
-    ajv.compile(schema);
-  })
-
-  it("requires a type field to be specified", () => {
-    const validate = ajv.compile(schema);
-    expect(validate({ resources: [
-        {
-          type: "typeA",
-          dependencies: [
-            "typeB"
-          ]
-        },
-        {
-          type: "typeB"
-        }
-    ]})).to.be.true;
-
-    expect(validate({
-      resources: [
-        {
-          type: "typeA",
-          dependencies: [
-            "typeB"
-          ]
-        },
-        {}
-      ]
-    })).to.be.false;
-  })
-
-})