cht-conf 3.13.0 → 3.14.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.14.0](https://github.com/medic/cht-conf/compare/v3.13.0...v3.14.0) (2022-08-18)
+
+
+### Features
+
+* **#494:** validate notes are not required in forms ([#496](https://github.com/medic/cht-conf/issues/496)) ([a5a8e09](https://github.com/medic/cht-conf/commit/a5a8e096a478373a43e63f0f606a2919bade8982)), closes [#494](https://github.com/medic/cht-conf/issues/494)
+
 # [3.13.0](https://github.com/medic/cht-conf/compare/v3.12.0...v3.13.0) (2022-07-12)
 
 

package/package.json

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

package/src/fn/initialise-project-layout.js

@@ -5,10 +5,15 @@ const fs = require('../lib/sync-fs');
 const { info } = require('../lib/log');
 
 const LAYOUT = {
-  'contact-summary.js': '',
+  'contact-summary.templated.js': `module.exports = {
+  fields: [],
+  cards: [],
+  context: {}
+};`,
   'privacy-policies.json': {},
   'privacy-policies': {},
   'resources.json': {},
+  'harness.defaults.json': {},
   resources: {},
   'targets.js': 'module.exports = [];',
   'tasks.js': 'module.exports = [];',
@@ -32,6 +37,12 @@ const LAYOUT = {
     'forms.json': {},
     'schedules.json': [],
   },
+  test: {
+    forms: {},
+    'contact-summary': {},
+    tasks: {},
+    targets: {}
+  }
 };
 
 function createRecursively(dir, layout) {

package/src/lib/validation/form/no-required-notes.js

@@ -0,0 +1,23 @@
+const { getBindNodes } = require('../../forms-utils');
+
+module.exports = {
+  requiresInstance: false,
+  skipFurtherValidation: false,
+  execute: async({ xformPath, xmlDoc }) => {
+    const errors = [];
+
+    const requiredNotes = getBindNodes(xmlDoc)
+      .filter(bind => bind.getAttribute('readonly') === 'true()') // Notes will not be conditionally readonly
+      .filter(bind => {
+        const required = bind.getAttribute('required');
+        return required && required !== 'false()';
+      })
+      .filter(bind => bind.getAttribute('type') === 'string')
+      .filter(bind => !bind.getAttribute('calculate'))
+      .map(bind => bind.getAttribute('nodeset'));
+    if(requiredNotes.length) {
+      errors.push(`Form at ${xformPath} contains the following note fields with 'required' expressions: [${requiredNotes.join(', ')}]`);
+    }
+    return { errors, warnings: [] };
+  }
+};