feat: Updated new match schema. This is used to match resources when multiple exists

Author: kevinwang5658

package.json

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

src/index.ts

@@ -10,6 +10,8 @@ import GetResourceInfoRequestDataSchema from './messages/get-resource-info-reque
 import GetResourceInfoResponseDataSchema from './messages/get-resource-info-response-data-schema.json' with {type: 'json'}
 import ImportRequestDataSchema from './messages/import-request-data-schema.json' with {type: 'json'}
 import ImportResponseDataSchema from './messages/import-response-data-schema.json' with {type: 'json'}
+import MatchRequestDataSchema from './messages/match-request-data-schema.json' with {type: 'json'}
+import MatchResponseDataSchema from './messages/match-response-data-schema.json' with {type: 'json'}
 import PlanRequestDataSchema from './messages/plan-request-data-schema.json' with {type: 'json'}
 import PlanResponseDataSchema from './messages/plan-response-data-schema.json' with {type: 'json'}
 import ValidateRequestDataSchema from './messages/validate-request-data-schema.json' with {type: 'json'}
@@ -32,6 +34,8 @@ export {
   GetResourceInfoResponseDataSchema,
   ImportRequestDataSchema,
   ImportResponseDataSchema,
+  MatchRequestDataSchema,
+  MatchResponseDataSchema,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
   ValidateRequestDataSchema,

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

@@ -36,7 +36,7 @@
     "importAndDestroy": {
       "type": "object",
       "properties": {
-        "requiredProperties": {
+        "requiredParameters": {
           "type": "array",
           "items": {
             "type": "string"
@@ -50,16 +50,7 @@
       }
     },
     "allowMultiple": {
-      "type": "object",
-      "properties": {
-        "requiredProperties": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        }
-      },
-      "required": ["requiredProperties"]
+      "type": "boolean"
     }
   },
   "required": ["type", "plugin"]

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

@@ -53,11 +53,9 @@ describe('Get resources response data schema', () => {
       },
       importAndDestroy: {
         preventImport: true,
-        requiredProperties: ['plugin']
+        requiredParameters: ['plugin']
       },
-      allowMultiple: {
-        requiredProperties: ['plugin']
-      }
+      allowMultiple: true,
     })).to.be.true;
 
     expect(validate({
@@ -106,9 +104,7 @@ describe('Get resources response data schema', () => {
         preventImport: true,
         requiredParameters: ['plugin'],
       },
-      allowMultiple: {
-        requiredParameters: ['plugin']
-      }
+      allowMultiple: false,
     }
   })
 
@@ -143,6 +139,12 @@ describe('Get resources response data schema', () => {
       }
 
     })).to.be.false;
+
+    expect(validate({
+      type: 'type',
+      plugin: 'core-plugin',
+      allowMultiple: {}
+    })).to.be.false;
   })
 
 })

src/messages/match-request-data-schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/match-request-data-schema.json",
+  "title": "Match resources request data",
+  "type": "object",
+  "properties": {
+    "resource": {
+      "type": "object",
+      "properties": {
+        "core": {
+          "$ref": "resource-schema.json"
+        },
+        "parameters": {
+          "type": "object"
+        }
+      },
+      "required": ["core", "parameters"]
+    },
+    "array": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "core": {
+            "$ref": "resource-schema.json"
+          },
+          "parameters": {
+            "type": "object"
+          }
+        },
+        "required": ["core", "parameters"]
+      }
+    }
+  },
+  "required": ["resource", "array"]
+}

src/messages/match-request-data-schema.test.ts

@@ -0,0 +1,86 @@
+import schema from './match-request-data-schema.json';
+import resourceSchema from '../resource-schema.json'
+import { describe, it, expect } from 'vitest'
+import Ajv from 'ajv'
+
+const ajv = new Ajv({
+  strict: true,
+  strictRequired: false,
+})
+ajv.addSchema(resourceSchema);
+
+describe('Matches request data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("Validates a correct request", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      resource: {
+        core: {
+          type: "type"
+        },
+        parameters: {
+          param1: 'a',
+          param2: 2
+        }
+      },
+      array: [
+        {
+          core: {
+            type: "type"
+          },
+          parameters: {
+            param1: 'a',
+            param2: 2
+          }
+        },
+        {
+          core: {
+            type: "type2"
+          },
+          parameters: {
+            param1: 'a',
+            param2: 2
+          }
+        }
+      ]
+    })).to.be.true;
+  })
+
+  it("Rejects an invalid request", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      resource: {
+        core: {
+          type: "type"
+        },
+        parameters: {
+          param1: 'a',
+          param2: 2
+        }
+      },
+      array: [
+        {
+          core: {
+            type: "type"
+          },
+          parameters: {
+            param1: 'a',
+            param2: 2
+          }
+        },
+        {
+          core: {
+          },
+          parameters: {
+            param1: 'a',
+            param2: 2
+          }
+        }
+      ]
+    })).to.be.false;
+  })
+
+})

src/messages/match-response-data-schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/match-response-data-schema.json",
+  "title": "Match resources response data",
+  "type": "object",
+  "properties": {
+    "match": {
+      "type": "object",
+      "properties": {
+        "core": {
+          "$ref": "resource-schema.json"
+        },
+        "parameters": {
+          "type": "object"
+        }
+      },
+      "required": ["core", "parameters"]
+    }
+  }
+}

src/messages/match-response-data-schema.test.ts

@@ -0,0 +1,46 @@
+import schema from './match-response-data-schema.json';
+import resourceSchema from '../resource-schema.json'
+import { describe, it, expect } from 'vitest'
+import Ajv from 'ajv'
+
+const ajv = new Ajv({
+  strict: true,
+  strictRequired: false,
+})
+ajv.addSchema(resourceSchema);
+
+describe('Match response data schema', () => {
+  it('compiles', () => {
+    ajv.compile(schema);
+  })
+
+  it("Validates a correct response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      match: {
+        core: {
+          type: "type"
+        },
+        parameters: {
+          param1: 'a',
+          param2: 2
+        }
+      }
+    })).to.be.true;
+  })
+
+  it("Rejects an invalid response", () => {
+    const validate = ajv.compile(schema);
+    expect(validate({
+      match: {
+        core: {
+        },
+        parameters: {
+          param1: 'a',
+          param2: 2
+        }
+      }
+    })).to.be.false;
+  })
+
+})

src/types/index.ts

@@ -104,20 +104,36 @@ export interface GetResourceInfoRequestData {
 export interface GetResourceInfoResponseData {
   plugin: string;
   type: string;
-  schema?: Record<string, unknown>,
-  dependencies?: string[],
+  schema?: Record<string, unknown>;
+  dependencies?: string[];
   /**
    * @deprecated: Use import and destroy instead.
    */
   import?: {
-    requiredParameters: string[] | null,
+    requiredParameters: string[] | null;
   },
   importAndDestroy?: {
-    requiredParameters: string[] | null,
-    preventImport?: boolean,
+    requiredParameters: string[] | null;
+    preventImport?: boolean;
   },
-  allowMultiple?: {
-    requiredParameters: string[]
+  allowMultiple: boolean;
+}
+
+export interface MatchRequestData {
+  resource: {
+    core: ResourceConfig;
+    parameters: Record<string, unknown>;
+  };
+  array: Array<{
+    core: ResourceConfig;
+    parameters: Record<string, unknown>;
+  }>
+}
+
+export interface MatchResponseData {
+  match?: {
+    core: ResourceConfig;
+    parameters: Record<string, unknown>;
   }
 }
 
@@ -127,8 +143,8 @@ export interface ImportRequestData {
 }
 
 export interface ImportResponseData {
-  request: ResourceJson
-  result: Array<ResourceJson>,
+  request: ResourceJson;
+  result: Array<ResourceJson>;
 }
 
 export interface ApplyRequestData {