cht-conf 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [5.4.0](https://github.com/medic/cht-conf/compare/v5.3.0...v5.4.0) (2025-09-11)
+
+
+### Features
+
+* **#561:** add form validation for `instance::db-doc-ref` ([#738](https://github.com/medic/cht-conf/issues/738)) ([941a6f5](https://github.com/medic/cht-conf/commit/941a6f5b7504d6ff8c1682845d6e38efd6ea017b)), closes [#561](https://github.com/medic/cht-conf/issues/561)
+
 # [5.3.0](https://github.com/medic/cht-conf/compare/v5.2.1...v5.3.0) (2025-09-04)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {

package/src/lib/validation/form/db-doc-is-valid.js

@@ -1,7 +1,6 @@
 const { getPrimaryInstanceNode, getNodes, getPrimaryInstanceNodeChildPath } = require('../../forms-utils');
 
 module.exports = {
-  name: 'db-doc-is-valid.js',
   requiresInstance: false,
   execute: async ({ xmlDoc, xformPath }) => {
     const errors = [];

package/src/lib/validation/form/db-doc-ref-is-valid.js

@@ -0,0 +1,28 @@
+const { getPrimaryInstanceNode, getNodes, getNode, getPrimaryInstanceNodeChildPath } = require('../../forms-utils');
+
+module.exports = {
+  requiresInstance: false,
+  execute: ({ xmlDoc, xformPath }) => {
+    const errors = [];
+    const primaryInstance = getPrimaryInstanceNode(xmlDoc);
+    const formRootNode = Array
+      .from(primaryInstance.childNodes)
+      .find(n => n.nodeType === 1);
+    const refNodes = getNodes(xmlDoc, '//*[@db-doc-ref]', primaryInstance);
+    refNodes.forEach(node => {
+      const refPath = node
+        .getAttribute('db-doc-ref')
+        .trim()
+        .replace(/^\//, '');
+      const targetNode = getNode(primaryInstance, refPath);
+      if (!targetNode || (targetNode !== formRootNode && targetNode.getAttribute('db-doc') !== 'true')) {
+        const nodeName = getPrimaryInstanceNodeChildPath(node);
+        errors.push(`  - ${nodeName}: the db-doc-ref value [${refPath}] does not reference a valid doc node.`);
+      }
+    });
+
+    const header = `Form at ${xformPath} contains invalid db-doc-ref configuration. A db-doc-ref value should point `
+      + `to either the root node of the form or to a group that is adding a new doc (with db-doc set to "true"):`;
+    return { errors: errors.length ? [header, ...errors]: errors };
+  },
+};