cht-conf 3.15.3 → 3.16.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.16.0](https://github.com/medic/cht-conf/compare/v3.15.3...v3.16.0) (2023-03-09)
+
+
+### Features
+
+* **medic/cht-core#6598:** Command line to convert and upload training forms ([#529](https://github.com/medic/cht-conf/issues/529)) ([fb700ef](https://github.com/medic/cht-conf/commit/fb700ef94fc8a0b86bb9bdeab36f42bc93970d20)), closes [medic/cht-core#6598](https://github.com/medic/cht-core/issues/6598)
+
 ## [3.15.3](https://github.com/medic/cht-conf/compare/v3.15.2...v3.15.3) (2023-02-28)
 
 

package/package.json

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

package/src/fn/convert-training-forms.js

@@ -0,0 +1,17 @@
+const convertForms = require('../lib/convert-forms').execute;
+const environment = require('../lib/environment');
+const { TRAINING_FORMS_PATH } = require('../lib/project-paths');
+
+const convertTrainingForms = (forms) => {
+  return convertForms(environment.pathToProject, 'training', {
+    enketo: true,
+    forms: forms,
+  });
+};
+
+module.exports = {
+  requiresInstance: false,
+  convertTrainingForms,
+  TRAINING_FORMS_PATH,
+  execute: () => convertTrainingForms(environment.extraArgs)
+};

package/src/fn/upload-training-forms.js

@@ -0,0 +1,17 @@
+const environment = require('../lib/environment');
+const uploadForms = require('../lib/upload-forms').execute;
+const { TRAINING_FORMS_PATH } = require('../lib/project-paths');
+
+const uploadTrainingForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'training', {
+    id_prefix: 'training:',
+    forms: forms,
+  });
+};
+
+module.exports = {
+  requiresInstance: true,
+  uploadTrainingForms,
+  TRAINING_FORMS_PATH,
+  execute: () => uploadTrainingForms(environment.extraArgs)
+};

package/src/fn/validate-training-forms.js

@@ -0,0 +1,12 @@
+const validateForms = require('../lib/validate-forms');
+const environment = require('../lib/environment');
+
+const validateTrainingForms = (forms) => {
+  return validateForms(environment.pathToProject, 'training', { forms });
+};
+
+module.exports = {
+  requiresInstance: false,
+  validateTrainingForms,
+  execute: () => validateTrainingForms(environment.extraArgs)
+};

package/src/fn/watch-project.js

@@ -8,14 +8,17 @@ const watcher = require('@parcel/watcher');
 const { validateAppForms } = require('./validate-app-forms');
 const { validateContactForms } = require('./validate-contact-forms');
 const { validateCollectForms } = require('./validate-collect-forms');
+const { validateTrainingForms } = require('./validate-training-forms');
 const { uploadAppForms } = require('./upload-app-forms');
 const { uploadContactForms } = require('./upload-contact-forms');
 const { uploadCollectForms } = require('./upload-collect-forms');
+const { uploadTrainingForms } = require('./upload-training-forms');
 const convertForms = require('../lib/convert-forms');
 const uploadForms = require('../lib/upload-forms');
 const { deleteForms } = require('../fn/delete-forms');
 const { convertAppForms, APP_FORMS_PATH } = require('./convert-app-forms');
 const { convertContactForm, CONTACT_FORMS_PATH } = require('./convert-contact-forms');
+const { convertTrainingForms, TRAINING_FORMS_PATH } = require('./convert-training-forms');
 const { convertCollectForms, COLLECT_FORMS_PATH } = require('./convert-collect-forms');
 const { uploadAppSettings, APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('./upload-app-settings');
 const { execute: compileAppSettings, configFileMatcher } = require('./compile-app-settings');
@@ -39,8 +42,10 @@ const uploadInitialState = async (api) => {
     await uploadResources();
     await runValidation(validateAppForms, environment.extraArgs);
     await runValidation(validateContactForms, environment.extraArgs);
+    await runValidation(validateTrainingForms, environment.extraArgs);
     await uploadAppForms(environment.extraArgs);
     await uploadContactForms(environment.extraArgs);
+    await uploadTrainingForms(environment.extraArgs);
     await uploadCustomTranslations();
     await uploadAppSettings(api);
 };
@@ -87,62 +92,64 @@ const deleteForm = (fileName, formDir) => {
     return false;
 };
 
-const processAppForm = (eventType, fileName) => {
-    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, APP_FORMS_PATH)) {
-        return true;
+const getFormCommandContext = (parsedPath) => {
+    if (parsedPath.dir === path.join(environment.pathToProject, APP_FORMS_PATH)) {
+        return {
+            path: APP_FORMS_PATH,
+            validateForms: validateAppForms,
+            uploadForms: uploadAppForms,
+            convertForms: convertAppForms,
+        };
     }
-    let form = uploadForms.formFileMatcher(fileName);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await runValidation(validateAppForms, [form]);
-            await uploadAppForms([form]);
-            return fileName;
-        });
-        return true;
+
+    if (parsedPath.dir === path.join(environment.pathToProject, TRAINING_FORMS_PATH)) {
+        return {
+            path: TRAINING_FORMS_PATH,
+            validateForms: validateTrainingForms,
+            uploadForms: uploadTrainingForms,
+            convertForms: convertTrainingForms,
+        };
     }
 
-    form = convertForms.formFileMatcher(fileName);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await convertAppForms([form]);
-            return fileName;
-        });
-        return true;
+    if (parsedPath.dir === path.join(environment.pathToProject, CONTACT_FORMS_PATH)) {
+        return {
+            path: CONTACT_FORMS_PATH,
+            validateForms: validateContactForms,
+            uploadForms: uploadContactForms,
+            convertForms: convertContactForm,
+        };
     }
-    return false;
-};
 
-const processAppFormMedia = (formMediaDir, fileName) => {
-    const form = uploadForms.formMediaMatcher(formMediaDir);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await runValidation(validateAppForms,[form]);
-            await uploadAppForms([form]);
-            return fileName;
-        });
-        return true;
+    if (parsedPath.dir === path.join(environment.pathToProject, COLLECT_FORMS_PATH)) {
+        return {
+            path: COLLECT_FORMS_PATH,
+            validateForms: validateCollectForms,
+            uploadForms: uploadCollectForms,
+            convertForms: convertCollectForms,
+        };
     }
-    return false;
+
+    return;
 };
 
-const processContactForm = (eventType, fileName) => {
-    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, CONTACT_FORMS_PATH)) {
+const processForm = (eventType, fileName, commandContext) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, commandContext.path)) {
         return true;
     }
-    let form = convertForms.formFileMatcher(fileName);
+    let form = uploadForms.formFileMatcher(fileName);
     if (form) {
         eventQueue.enqueue(async () => {
-            await convertContactForm([form]);
+            await runValidation(commandContext.validateForms, [form]);
+            await commandContext.uploadForms([form]);
             return fileName;
         });
         return true;
     }
 
-    form = uploadForms.formFileMatcher(fileName);
+    form = convertForms.formFileMatcher(fileName);
     if (form) {
         eventQueue.enqueue(async () => {
-            await runValidation(validateContactForms,[form]);
-            await uploadContactForms([form]);
+            await commandContext.convertForms([form]);
             return fileName;
         });
         return true;
@@ -150,24 +157,34 @@ const processContactForm = (eventType, fileName) => {
     return false;
 };
 
-const processCollectForm = (eventType, fileName) => {
-    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, COLLECT_FORMS_PATH)) {
-        return true;
+const getFormMediaCommandContext = (parsedPath) => {
+    if (parsedPath.dir.startsWith(path.join(environment.pathToProject, APP_FORMS_PATH))
+      && path.parse(parsedPath.dir).dir.endsWith(APP_FORMS_PATH)) {
+        // Check if the directory's immediate parent is forms/app
+        return {
+            validateForms: validateAppForms,
+            uploadForms: uploadAppForms,
+        };
     }
-    let form = uploadForms.formFileMatcher(fileName);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await runValidation(validateCollectForms,[form]);
-            await uploadCollectForms([form]);
-            return fileName;
-        });
-        return true;
+
+    if (parsedPath.dir.startsWith(path.join(environment.pathToProject, TRAINING_FORMS_PATH))
+      && path.parse(parsedPath.dir).dir.endsWith(TRAINING_FORMS_PATH)) {
+        // Check if the directory's immediate parent is forms/training
+        return {
+            validateForms: validateTrainingForms,
+            uploadForms: uploadTrainingForms,
+        };
     }
 
-    form = convertForms.formFileMatcher(fileName);
+    return;
+};
+
+const processFormMedia = (formMediaDir, fileName, commandContext) => {
+    const form = uploadForms.formMediaMatcher(formMediaDir);
     if (form) {
         eventQueue.enqueue(async () => {
-            await convertCollectForms([form]);
+            await runValidation(commandContext.validateForms,[form]);
+            await commandContext.uploadForms([form]);
             return fileName;
         });
         return true;
@@ -212,29 +229,19 @@ const watchProject = {
                 const parsedPath = path.parse(changePath);
                 const fileName = parsedPath.base;
 
-                if (parsedPath.dir === path.join(environment.pathToProject, APP_FORMS_PATH)) {
-                    processAppForm(event.type, fileName);
+                const formContext = getFormCommandContext(parsedPath);
+                if (formContext) {
+                    processForm(event.type, fileName, formContext);
                     continue;
                 }
 
-                if (parsedPath.dir.startsWith(path.join(environment.pathToProject, APP_FORMS_PATH))
-                    && path.parse(parsedPath.dir).dir.endsWith(APP_FORMS_PATH)) { // check if the directory's immediate parent is forms/app
+                const formMediaContext = getFormMediaCommandContext(parsedPath);
+                if (formMediaContext) {
                     const dirName = path.parse(parsedPath.dir).base;
-                    processAppFormMedia(dirName, fileName);
+                    processFormMedia(dirName, fileName, formMediaContext);
                     continue;
                 }
 
-                if (parsedPath.dir === path.join(environment.pathToProject, CONTACT_FORMS_PATH)) {
-                    processContactForm(event.type, fileName);
-                    continue;
-                }
-
-                if (parsedPath.dir === path.join(environment.pathToProject, COLLECT_FORMS_PATH)) {
-                    processCollectForm(event.type, fileName);
-                    continue;
-                }
-
-
                 if (parsedPath.dir === path.join(environment.pathToProject, TRANSLATIONS_DIR_PATH)) {
                     eventQueue.enqueue(async () => {
                         await uploadCustomTranslations();

package/src/lib/main.js

@@ -21,14 +21,17 @@ const defaultActions = [
   'convert-app-forms',
   'convert-collect-forms',
   'convert-contact-forms',
+  'convert-training-forms',
   'validate-app-forms',
   'validate-collect-forms',
   'validate-contact-forms',
+  'validate-training-forms',
   'backup-all-forms',
   'delete-all-forms',
   'upload-app-forms',
   'upload-collect-forms',
   'upload-contact-forms',
+  'upload-training-forms',
   'upload-resources',
   'upload-branding',
   'upload-partners',
@@ -41,12 +44,15 @@ const defaultArchiveActions = [
   'convert-app-forms',
   'convert-collect-forms',
   'convert-contact-forms',
+  'convert-training-forms',
   'validate-app-forms',
   'validate-collect-forms',
   'validate-contact-forms',
+  'validate-training-forms',
   'upload-app-forms',
   'upload-collect-forms',
   'upload-contact-forms',
+  'upload-training-forms',
   'upload-resources',
   'upload-branding',
   'upload-partners',
@@ -148,7 +154,8 @@ module.exports = async (argv, env) => {
     const validateActions = [
       'validate-app-forms',
       'validate-collect-forms',
-      'validate-contact-forms'
+      'validate-contact-forms',
+      'validate-training-forms',
     ];
     actions = actions.filter(action => !validateActions.includes(action));
   } else {
@@ -161,6 +168,7 @@ module.exports = async (argv, env) => {
     addFormValidationIfNecessary('app');
     addFormValidationIfNecessary('collect');
     addFormValidationIfNecessary('contact');
+    addFormValidationIfNecessary('training');
   }
 
   actions = actions.map(actionName => {

package/src/lib/project-paths.js

@@ -6,6 +6,7 @@ module.exports = {
     APP_FORMS_PATH: path.join('forms', 'app'),
     CONTACT_FORMS_PATH: path.join('forms', 'contact'),
     COLLECT_FORMS_PATH: path.join('forms', 'collect'),
+    TRAINING_FORMS_PATH: path.join('forms', 'training'),
     TRANSLATIONS_DIR_PATH: 'translations',
     RESOURCE_CONFIG_PATH: 'resources.json',
     RESOURCES_DIR_PATH: 'resources'