@bpmn-io/element-templates-validator 2.7.0 → 2.8.0

package/README.md

@@ -27,7 +27,6 @@ const {
 if (!valid) {
   console.error('Invalid JSON detected:', errors);
 }
-
 ```
 
 This will print detailed information about errors inside the sample:
@@ -59,7 +58,28 @@ This will print detailed information about errors inside the sample:
 ]
 ```
 
-It's also possible to validate multiple objects at once
+You can also pass a stringified template to ensure that the `dataPointers` of the errors reflect the correct position in the original string.
+
+```js
+import { validate } from '@bpmn-io/element-templates-validator';
+
+import { readFileSync } from 'node:fs';
+
+const sample = readFileSync('./test/fixtures/rpa-broken.json', 'utf-8');
+
+const {
+  valid,
+  errors
+} = validate(sample);
+
+if (!valid) {
+  console.error('Invalid JSON detected:', errors);
+}
+```
+
+If a parsed JSON object is passed, the `dataPointers` will assume that the source template is formatted with `JSON.stringify(template, null, 2)`.
+
+It's also possible to validate multiple objects at once. In this case, the list of templates supports only objects, not strings.
 
 ```js
 import { validateAll } from '@bpmn-io/element-templates-validator';

package/dist/index.cjs

@@ -570,8 +570,22 @@ function requireJsonSourceMap () {
 var jsonSourceMapExports = requireJsonSourceMap();
 var jsonMap = /*@__PURE__*/getDefaultExportFromCjs(jsonSourceMapExports);
 
-function _validate(object, validateFn) {
-  const dataPointerMap = generateDataPointerMap(object);
+function _validate(jsonString, validateFn) {
+  let dataPointerMap;
+
+  try {
+    dataPointerMap = generateDataPointerMap(jsonString);
+  } catch (err) {
+    return {
+      valid: false,
+      object: null,
+      errors: [ err ]
+    };
+  }
+
+  let object;
+
+  object = JSON.parse(jsonString);
 
   const valid = validateFn(object);
 
@@ -651,7 +665,7 @@ function ignoreSupportiveErrors(errors) {
 }
 
 /**
- * Generates a key-pointer map for the object.
+ * Generates a key-pointer map for the JSON string.
  *
  * Example:
  *
@@ -674,11 +688,11 @@ function ignoreSupportiveErrors(errors) {
  *  }
  * }
  *
- * @param {Object} object
+ * @param {string} jsonString
  * @return {Object}
  */
-function generateDataPointerMap(object) {
-  return jsonMap.stringify(object, null, 2).pointers;
+function generateDataPointerMap(jsonString) {
+  return jsonMap.parse(jsonString).pointers;
 }
 
 function getSchemaVersion() {
@@ -690,13 +704,17 @@ function getSchemaPackage() {
 }
 
 /**
- * Validate a single object.
- *
- * @param {Object} object
- * @return {Object} single object validation result
+ * Validate a single template, which can be either a string or an object.
+ * If an **object** is passed, the data pointers assume double-space nesting, and empty lines will be discarded.
+ * @param {Object|string} template
+ * @return {Object} single template validation result
  */
-function validate(object) {
-  return _validate(object, validateTemplate$1);
+function validate(template) {
+  if (typeof template !== 'string') {
+    template = JSON.stringify(template, null, 2);
+  }
+
+  return _validate(template, validateTemplate$1);
 }
 
 /**
@@ -735,13 +753,17 @@ function getZeebeSchemaVersion() {
 }
 
 /**
- * Validate a single object.
- *
- * @param {Object} object
- * @return {Object} single object validation result
+ * Validate a single template, which can be either a string or an object.
+ * If an **object** is passed, the data pointers assume double-space nesting, and empty lines will be discarded.
+ * @param {Object|string} template
+ * @return {Object} single template validation result
  */
-function validateZeebe(object) {
-  return _validate(object, validateTemplate);
+function validateZeebe(template) {
+  if (typeof template !== 'string') {
+    template = JSON.stringify(template, null, 2);
+  }
+
+  return _validate(template, validateTemplate);
 }
 
 /**

package/dist/index.js

@@ -568,8 +568,22 @@ function requireJsonSourceMap () {
 var jsonSourceMapExports = requireJsonSourceMap();
 var jsonMap = /*@__PURE__*/getDefaultExportFromCjs(jsonSourceMapExports);
 
-function _validate(object, validateFn) {
-  const dataPointerMap = generateDataPointerMap(object);
+function _validate(jsonString, validateFn) {
+  let dataPointerMap;
+
+  try {
+    dataPointerMap = generateDataPointerMap(jsonString);
+  } catch (err) {
+    return {
+      valid: false,
+      object: null,
+      errors: [ err ]
+    };
+  }
+
+  let object;
+
+  object = JSON.parse(jsonString);
 
   const valid = validateFn(object);
 
@@ -649,7 +663,7 @@ function ignoreSupportiveErrors(errors) {
 }
 
 /**
- * Generates a key-pointer map for the object.
+ * Generates a key-pointer map for the JSON string.
  *
  * Example:
  *
@@ -672,11 +686,11 @@ function ignoreSupportiveErrors(errors) {
  *  }
  * }
  *
- * @param {Object} object
+ * @param {string} jsonString
  * @return {Object}
  */
-function generateDataPointerMap(object) {
-  return jsonMap.stringify(object, null, 2).pointers;
+function generateDataPointerMap(jsonString) {
+  return jsonMap.parse(jsonString).pointers;
 }
 
 function getSchemaVersion() {
@@ -688,13 +702,17 @@ function getSchemaPackage() {
 }
 
 /**
- * Validate a single object.
- *
- * @param {Object} object
- * @return {Object} single object validation result
+ * Validate a single template, which can be either a string or an object.
+ * If an **object** is passed, the data pointers assume double-space nesting, and empty lines will be discarded.
+ * @param {Object|string} template
+ * @return {Object} single template validation result
  */
-function validate(object) {
-  return _validate(object, validateTemplate$1);
+function validate(template) {
+  if (typeof template !== 'string') {
+    template = JSON.stringify(template, null, 2);
+  }
+
+  return _validate(template, validateTemplate$1);
 }
 
 /**
@@ -733,13 +751,17 @@ function getZeebeSchemaVersion() {
 }
 
 /**
- * Validate a single object.
- *
- * @param {Object} object
- * @return {Object} single object validation result
+ * Validate a single template, which can be either a string or an object.
+ * If an **object** is passed, the data pointers assume double-space nesting, and empty lines will be discarded.
+ * @param {Object|string} template
+ * @return {Object} single template validation result
  */
-function validateZeebe(object) {
-  return _validate(object, validateTemplate);
+function validateZeebe(template) {
+  if (typeof template !== 'string') {
+    template = JSON.stringify(template, null, 2);
+  }
+
+  return _validate(template, validateTemplate);
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmn-io/element-templates-validator",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Validate element templates based on JSON Schema",
   "type": "module",
   "main": "dist/index.cjs",