codify-schemas 1.0.70 → 1.0.72

package/dist/index.d.ts

@@ -10,6 +10,8 @@ import GetResourceInfoRequestDataSchema from './messages/get-resource-info-reque
 import GetResourceInfoResponseDataSchema from './messages/get-resource-info-response-data-schema.json';
 import ImportRequestDataSchema from './messages/import-request-data-schema.json';
 import ImportResponseDataSchema from './messages/import-response-data-schema.json';
+import MatchRequestDataSchema from './messages/match-request-data-schema.json';
+import MatchResponseDataSchema from './messages/match-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';
@@ -18,6 +20,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, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
+export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, MatchRequestDataSchema, MatchResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
 export * from './types/index.js';
 export * from './messages/commands.js';

package/dist/index.js

@@ -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' };
@@ -18,7 +20,7 @@ import InitializeRequestDataSchema from './messages/initialize-request-data-sche
 import InitializeResponseDataSchema from './messages/initialize-response-data-schema.json' with { type: 'json' };
 import SudoRequestDataSchema from './messages/sudo-request-data-schema.json' with { type: 'json' };
 import SudoRequestResponseDataSchema from './messages/sudo-response-data-schema.json' with { type: 'json' };
-export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, PlanRequestDataSchema, PlanResponseDataSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, SudoRequestDataSchema, SudoRequestResponseDataSchema, };
+export { ConfigFileSchema, ProjectSchema, ResourceSchema, IpcMessageSchema, IpcMessageV2Schema, ApplyRequestDataSchema, ApplyResponseDataSchema, ErrorResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, MatchRequestDataSchema, MatchResponseDataSchema, 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":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,aAAa,MAAM,uBAAuB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACrE,OAAO,cAAc,MAAM,wBAAwB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,kBAAkB,MAAM,8BAA8B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACjF,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,gCAAgC,MAAM,uDAAuD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxH,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAChG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxG,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AACjG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAE1G,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,wBAAwB,EACxB,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":"AAAA,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,aAAa,MAAM,uBAAuB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACrE,OAAO,cAAc,MAAM,wBAAwB,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACvE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5E,OAAO,kBAAkB,MAAM,8BAA8B,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACjF,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,gCAAgC,MAAM,uDAAuD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxH,OAAO,iCAAiC,MAAM,wDAAwD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1H,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,wBAAwB,MAAM,6CAA6C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACtG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,uBAAuB,MAAM,4CAA4C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACpG,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAChG,OAAO,sBAAsB,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAClG,OAAO,yBAAyB,MAAM,8CAA8C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AACxG,OAAO,0BAA0B,MAAM,+CAA+C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC1G,OAAO,2BAA2B,MAAM,gDAAgD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC5G,OAAO,4BAA4B,MAAM,iDAAiD,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAA;AAC9G,OAAO,qBAAqB,MAAM,0CAA0C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AACjG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC,OAAM,IAAI,EAAE,MAAM,EAAC,CAAC;AAE1G,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,gCAAgC,EAChC,iCAAiC,EACjC,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EACtB,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"}

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

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

package/dist/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"]
+}

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

@@ -0,0 +1,21 @@
+{
+    "$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"]
+        }
+    },
+    "required": ["match"]
+}

package/dist/types/index.d.ts

@@ -100,8 +100,22 @@ export interface GetResourceInfoResponseData {
         requiredParameters: string[] | null;
         preventImport?: boolean;
     };
-    allowMultiple?: {
-        identifyingParameters: 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>;
     };
 }
 export interface ImportRequestData {

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;AA6CD,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;AAoFD,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;AA6CD,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;AAoGD,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.70",
+  "version": "1.0.72",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/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,

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

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

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

@@ -55,9 +55,7 @@ describe('Get resources response data schema', () => {
         preventImport: true,
         requiredParameters: ['plugin']
       },
-      allowMultiple: {
-        identifyingParameters: ['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,
     }
   })
 

package/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"]
+}

package/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;
+  })
+
+})

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

@@ -0,0 +1,21 @@
+{
+  "$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"]
+    }
+  },
+  "required": ["match"]
+}

package/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;
+  })
+
+})

package/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?: {
-    identifyingParameters: 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 {