@hestia-earth/schema-validation 15.2.0 → 17.0.0

package/README.md

@@ -1,9 +1,33 @@
 # Hestia Schema Validation
 
-Module to validate data using the Hestia Schema and Ajv
+Module to validate data using the Hestia Schema and Ajv.
 
 ## Install
 
 ```sh
-npm install @hestia-earth/schema-validation
+npm install @hestia-earth/schema @hestia-earth/schema-validation
+```
+
+## Example validating JSON
+
+```javascript
+const { SchemaType } = require('@hestia-earth/schema');
+const { validator } = require('@hestia-earth/schema-validation/validate');
+
+// Set to `true` to validate existing Nodes (@type/@id) or `false` for Nodes to upload (type/id)
+const strictMode = false;
+// Initialise the validation function, do this only once
+const schemaValidation = validator(undefined, strictMode);
+
+const node = {
+  type: SchemaType.Cycle,
+  id: 'my first cycle'
+};
+
+(async () => {
+  const { success, errors } = await schemaValidation(node);
+  console.log(success);
+  // list of errors in Ajv formatting. See https://github.com/ajv-validator/ajv/tree/v6.12.6#validation-errors
+  console.log(errors);
+})();
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/schema-validation",
-  "version": "15.2.0",
+  "version": "17.0.0",
   "description": "Hestia Schema Validation",
   "main": "index.js",
   "typings": "index.d.ts",

package/validate.d.ts

@@ -13,8 +13,9 @@ export declare const validateContent: (ajv: Ajv.Ajv, schemas: definitions) => (c
     errors: Ajv.ErrorObject[];
 }>;
 declare function uniqueArrayItemValidate(keys: string[], items: any[], _schema?: any, dataPath?: string): boolean;
-declare function arraySameSizeValidate(keys: string[], items: any[], _schema: any, dataPath: any, item: any): boolean;
-export { uniqueArrayItemValidate, arraySameSizeValidate };
+declare function arraySameSizeValidate(keys: string[], items: any[], _schema: any, dataPath: string, item: any): boolean;
+declare function datePatternValidate(_enabled: boolean, value: string | string[], _schema: any, dataPath: string): boolean;
+export { uniqueArrayItemValidate, arraySameSizeValidate, datePatternValidate };
 export declare const initAjv: () => Ajv.Ajv;
 /**
  * Create a validator instance. Call with a Node to validate it.

package/validate.js

@@ -47,7 +47,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validator = exports.initAjv = exports.arraySameSizeValidate = exports.uniqueArrayItemValidate = exports.validateContent = void 0;
+exports.validator = exports.initAjv = exports.datePatternValidate = exports.arraySameSizeValidate = exports.uniqueArrayItemValidate = exports.validateContent = void 0;
 var Ajv = require("ajv");
 var schema_1 = require("@hestia-earth/schema");
 var json_schema_1 = require("@hestia-earth/json-schema");
@@ -132,6 +132,21 @@ function arraySameSizeValidate(keys, items, _schema, dataPath, item) {
     return errors.length === 0;
 }
 exports.arraySameSizeValidate = arraySameSizeValidate;
+var datePatternKeyword = 'datePattern';
+var isValidDate = function (date) { return isFinite(new Date(date).getTime()); };
+function datePatternValidate(_enabled, value, _schema, dataPath) {
+    var values = Array.isArray(value) ? value : [value];
+    var errors = values
+        .map(function (v, index) { return isValidDate(v) ? null : {
+        dataPath: "".concat(dataPath).concat(Array.isArray(value) ? "[".concat(index, "]") : ''),
+        keyword: datePatternKeyword,
+        message: 'not a valid date'
+    }; })
+        .filter(Boolean);
+    datePatternValidate.errors = errors;
+    return errors.length === 0;
+}
+exports.datePatternValidate = datePatternValidate;
 var initAjv = function () {
     var ajv = new Ajv({
         schemaId: 'auto',
@@ -149,6 +164,11 @@ var initAjv = function () {
         errors: 'full',
         validate: arraySameSizeValidate
     });
+    ajv.addKeyword(datePatternKeyword, {
+        type: ['string', 'array'],
+        errors: 'full',
+        validate: datePatternValidate
+    });
     return ajv;
 };
 exports.initAjv = initAjv;