feat: add jsonschema validator

Author: cyrng

lib/providers/BaseProvider.ts

@@ -1,7 +1,13 @@
+import Ajv, { ValidateFunction } from "ajv";
+import addFormats from "ajv-formats";
+
+import { JSONSchema7 } from "json-schema";
 import {
   BadRequestError,
   Inflector,
   JSONObject,
+  KuzzleError,
+  MultipleErrorsError,
   NotFoundError,
   PluginContext,
 } from "kuzzle";
@@ -31,7 +37,8 @@ export abstract class BaseProvider<T> {
   protected EVENT_ACCOUNT_ADD: string;
   protected EVENT_ACCOUNT_REMOVE: string;
 
-  protected jsonSchema: JSONObject;
+  protected paramsJsonSchema: JSONSchema7;
+  protected paramsJsonSchemaValidator: ValidateFunction;
 
   get sdk() {
     return this.context.accessors.sdk;
@@ -41,10 +48,14 @@ export abstract class BaseProvider<T> {
     return this.context.accessors.cluster;
   }
 
-  constructor(name: string, type: ProviderType, jsonSchema: JSONObject) {
+  constructor(name: string, type: ProviderType, jsonSchema: JSONSchema7) {
     this.name = name;
     this.type = type;
-    this.jsonSchema = jsonSchema;
+    this.paramsJsonSchema = jsonSchema;
+
+    const ajv = new Ajv();
+    addFormats(ajv);
+    this.paramsJsonSchemaValidator = ajv.compile(this.paramsJsonSchema);
 
     this.EVENT_ACCOUNT_ADD = `${this.name}:account:add`;
     this.EVENT_ACCOUNT_REMOVE = `${this.name}:account:remove`;
@@ -84,8 +95,8 @@ export abstract class BaseProvider<T> {
     return this.name;
   }
 
-  getJsonSchema(): JSONObject {
-    return this.jsonSchema;
+  getParamsJsonSchema(): JSONSchema7 {
+    return this.paramsJsonSchema;
   }
 
   abstract send(
@@ -131,6 +142,20 @@ export abstract class BaseProvider<T> {
     }
   }
 
+  validateParams(params: JSONObject): void {
+    const valid = this.paramsJsonSchemaValidator(params);
+
+    if (valid === false) {
+      const errors = this.paramsJsonSchemaValidator.errors.map(
+        (e) => new KuzzleError(e.message, 400),
+      );
+      throw new MultipleErrorsError(
+        "Parameters does not match with the json schema defined in the provider",
+        errors,
+      );
+    }
+  }
+
   private nodeAddAccount(name: string, contentType: string, ...args) {
     this.logInfo(`${Inflector.upFirst(this.name)}: register account "${name}"`);
 

package-lock.json

@@ -24,12 +24,16 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@sendgrid/mail": "8.1.5",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
     "lodash": "4.17.21",
     "nodemailer": "7.0.3",
     "twilio": "5.7.0"
   },
   "devDependencies": {
+    "@types/ajv": "^0.0.5",
     "@types/jest": "30.0.0",
+    "@types/json-schema": "^7.0.15",
     "@types/node": "22.15.21",
     "@types/nodemailer": "6.4.17",
     "cz-conventional-changelog": "3.3.0",