feat: add backend validation of json field

AdminForth/1797/implement-jsonformplugin-using

Author: yaroslav8765

index.ts

@@ -1,6 +1,7 @@
 import { AdminForthPlugin, AdminForthDataTypes } from "adminforth";
 import type { IAdminForth, AdminForthResource } from "adminforth";
 import type { PluginOptions } from './types.js';
+import Validator from 'jsonschema';
 
 export default class JsonFormPlugin extends AdminForthPlugin {
   options: PluginOptions;
@@ -61,5 +62,58 @@ export default class JsonFormPlugin extends AdminForthPlugin {
 
     column.components.create = formComponent;
     column.components.edit = formComponent;
+
+    if (!resourceConfig.hooks) {
+      resourceConfig.hooks = {};
+    }
+    if (!resourceConfig.hooks.create) {
+      resourceConfig.hooks.create = {};
+    }
+    if (!resourceConfig.hooks.edit) {
+      resourceConfig.hooks.edit = {};
+    }
+
+    const pushHook = (hooks: { beforeSave?: any }, fn: any) => {
+      if (Array.isArray(hooks.beforeSave)) {
+        hooks.beforeSave.push(fn);
+      } else if (hooks.beforeSave) {
+        hooks.beforeSave = [hooks.beforeSave, fn];
+      } else {
+        hooks.beforeSave = [fn];
+      }
+    };
+
+    pushHook(resourceConfig.hooks.create, async ({ record }: { record: any }) => {
+      return this.validateRecord(record);
+    });
+    pushHook(resourceConfig.hooks.edit, async ({ updates }: { updates: any }) => {
+      if (!(this.options.fieldName in updates)) {
+        return { ok: true };
+      }
+      return this.validateRecord(updates);
+    });
+  }
+
+  validateRecord(record: any): { ok: boolean; error?: string } {
+    const value = record?.[this.options.fieldName];
+
+    if (value === undefined || value === null) {
+      return { ok: true };
+    }
+
+    const validator = new Validator.Validator();
+    const result = validator.validate(value, this.options.schema, { nestedErrors: true });
+
+    if (!result.valid) {
+      const message = result.errors
+        .map((e) => `${e.property.replace(/^instance/, this.options.fieldName)} ${e.message}`)
+        .join('; ');
+      return {
+        ok: false,
+        error: `[JsonForm] Invalid value for "${this.options.fieldName}": ${message}`,
+      };
+    }
+
+    return { ok: true };
   }
 }

package.json

@@ -59,5 +59,8 @@
         "prerelease": true
       }
     ]
+  },
+  "dependencies": {
+    "jsonschema": "^1.5.0"
   }
 }