fcad-core-dragon 2.0.1 → 2.0.2-beta.2

package/src/shared/generalfuncs.js

@@ -204,6 +204,140 @@ const fileAssets = {
     let formatted = string.replaceAll('_', ' ').toLowerCase()
     formatted = `${formatted.substring(0, 1).toUpperCase()}${formatted.slice(1).toLowerCase()}`
     return formatted
+  },
+
+  /**
+   * @description compares 2 array
+   * @param {Array} array1
+   * @param {Array} array2
+   * @returns {Boolean}
+   */
+  isEqual: (array1, array2) => {
+    // if length is not equal
+    if (array1.length != array2.length) {
+      return false
+    } else {
+      // comapring each element of array
+      for (let i = 0; i < array1.length; i++) {
+        if (array1[i] != array2[i]) {
+          return false
+        }
+      }
+      return true
+    }
+  },
+  /**
+   * @description used by the dropdown quiz
+   * @param {Array} answers what the user has answered
+   * @param {Array} solution the correct choices
+   * @returns {Boolean}
+   */
+  compareSelectedAnswers: (answers, solution) => {
+    for (let index = 0; index < answers.length; index++) {
+      const elementAnswers = answers[index]
+      const elementSolution = solution[index]
+      if (elementAnswers.reponse_id !== elementSolution) {
+        return false
+      }
+    }
+    return true
+  },
+
+  /**
+   * @description used by the texte_troue_select quiz
+   * @param {Array} answers what the user has answered
+   * @param {Array} solution the correct choices
+   * @returns {Boolean}
+   */
+  compareSelectedTextToFillAnswers: (answers, solution) => {
+    for (let index = 0; index < answers.length; index++) {
+      const elementAnswers = answers[index]
+      const elementSolution = Object.values(solution[index])[0]
+      if (elementAnswers.reponse_id !== elementSolution) {
+        return false
+      }
+    }
+    return true
+  },
+
+  /**
+   * @description used by the texte_tableau quiz and texte_troue quiz
+   * @param {Array} answers what the user has answered
+   * @param {Array} solution the correct choices
+   * @returns {Boolean}
+   */
+  compareTextAnswers: (answers, solution) => {
+    for (let index = 0; index < answers.length; index++) {
+      const elementAnswers = answers[index]
+      const elementSolution = solution[index]
+      if (
+        !this.$helper.containsValue(
+          elementSolution.reponse_value,
+          elementAnswers.reponse
+        )
+      ) {
+        return false
+      }
+    }
+    return true
+  },
+
+  /**
+   * @description used by the texte_tableau quiz and texte_troue quiz
+   * @param {Array} answers what the user has answered
+   * @param {Array} solution the correct choices
+   * @returns {Boolean}
+   */
+  compareTextAnswers2: (answers, solution) => {
+    for (let index = 0; index < answers.length; index++) {
+      const elementAnswers = answers[index]
+      const elementSolution = solution[index]
+      if (
+        !this.$helper.containsValue(
+          Object.values(elementSolution)[0],
+          elementAnswers.reponse
+        )
+      ) {
+        return false
+      }
+    }
+    return true
+  },
+
+  /**
+   * @description used by the association quiz
+   * @param {Object} answers what the user has answered
+   * @param {Object} solution the correct choices
+   * @returns {Boolean}
+   */
+  compareObjectAnswers: (answers, solution) => {
+    let answersKey = Object.keys(answers)
+    for (let index = 0; index < answersKey.length; index++) {
+      const elementAnswers = answers[answersKey[index]]
+      const elementSolution = solution[answersKey[index]]
+      if (elementAnswers !== elementSolution) {
+        return false
+      }
+    }
+    return true
+  },
+
+  /**
+   * @description used by the dragdrop quiz
+   * @param {Object} answers what the user has answered
+   * @param {Object} solution the correct choices
+   * @returns {Boolean}
+   */
+  compareObjectAnswers2: (answers, solution) => {
+    let answersKey = Object.keys(answers)
+    for (let index = 0; index < answersKey.length; index++) {
+      const elementAnswers = answers[answersKey[index]]
+      const elementSolution = solution[answersKey[index]]
+      if (!this.isEqual(elementAnswers, elementSolution)) {
+        return false
+      }
+    }
+    return true
   }
 }
 

package/src/shared/validators.js

@@ -1,3 +1,248 @@
+// Errors message to display in the console
+const ERR_TYPE = {
+  err0: `\n 💥 Missing \x1B[1m$attr$ \x1B[0mfor $comp$. \x1B[1m$attr$ \x1B[0m should be provided with following attributes: \x1B[1m{$data$}`,
+  err1: `\n 💥 Invalid declaration for \x1B[1m$wrd$ \x1B[0m object`,
+  err2: `\n 💥 Invalid type declaration for 👉\x1B[1m$attr$ \x1B[0m👈 in \x1B[1m$el$\x1B[0m. Expected is \x1B[3m$type$ \x1B[0mtype with some value`,
+  err3: `\n 💥 Missing required argument  👉\x1B[1m$key$\x1B[0m👈 in \x1B[1m$el$\x1B[0m. Required arguments are: \x1B[1m$args$`,
+  err4: `\n 💥 Missing required argument  👉\x1B[1m$key$\x1B[0m👈 in \x1B[1m$el$\x1B[0m. Required arguments are: \x1B[1m$args$`
+}
+
+// Errors message to display in Appplication UI
+const ERR_TYPE_MSG = {
+  err0: `\n Données manquantes pour <span style='text-transform: uppercase;'>$comp$</span>. Assurez-vous que le composant reçoit l'attribut <b>$attr$</b> avec des données pour: <b>$data$</b>`,
+  err1: `\n Déclaration invalide pour <b>$wrd$</b>. Assurez-vous que l'application a du data.`,
+  err2: `\n Vous avez une declaration invalide dans <b>$attr$</b>. 👉<b>$el$</b>👈 n'accepte que le type <i>$type$</i> et ne peut pas être vide`,
+  err3: `\n L'attribut 👉<b>$key$</b>👈 est manquant dans <b>$el$</b>. Les attributs requis sont: <b>$args$</b>`
+}
+
+//Get all the invalids properties from the object
+/*Add element from target array that are NOT in arr to the wrongArray*/
+const checkerWrong = (arr, target) => {
+  let wrongArray = []
+  target.every((v) => {
+    if (arr.includes(v)) {
+      return true
+    } else {
+      wrongArray.push(v)
+      return true
+    }
+  })
+  return wrongArray
+}
+//Get all the required properties that are missing from the object
+/*Add element from the arr that are NOT in target arr to the missingArray*/
+const checkerMissing = (arr, target) => {
+  let missingArray = []
+  arr.every((v) => {
+    if (target.includes(v)) {
+      return true
+    } else {
+      missingArray.push(v)
+      return true
+    }
+  })
+  return missingArray
+}
+
+/**
+ * @description - Method to validate that given object attributes hold expected types
+ * @param {Object} Obj - object to validate
+ * @param {Object} Args - List of expected type groups - each type group must be an array of attributes with the same type
+ * @param {Array} notRequiredArgs - list of field that should be considered as optional in the object. Will not give error if not * provided but will be validated if they are present with wrong type or empty
+ * @param {Array} compName - Name of the component- will be display in error message
+ * @param {Array}   err - list off errors to be added to
+ * @return {Object} list of errors - {errorInConsole, errorList} : errorlist can be used to display messages on template and
+ * errorInConsole to display messages in browser console
+ * @exemple - Given $user= {name:'toto', username:'totoEscargot', id:'id001', age:23, books:['one', 'two', 'three']  }
+ * Use validator on $user:  validateObjType($user, {stringType:['name', 'username' , 'id'], numbType:['age'], arrayType:['books']})
+ * Will fail if any listed attribute not in $user or have wrong value. Error messages will be in console
+ *
+ */
+
+const validateObjType = (
+  Obj,
+  Args = {
+    boolType: null,
+    arrayType: null,
+    stringType: null,
+    objectType: null,
+    numbType: null
+  },
+  notRequiredArgs = null,
+  compName = 'component',
+  err = null
+) => {
+  let errorInConsole = err && err.errorInConsole ? err.errorInConsole : []
+  let errorList = err && err.errorList ? err.errorLIst : []
+  let optionalArgs =
+    notRequiredArgs && notRequiredArgs.length ? notRequiredArgs : []
+  //=====Expected Arguments validation =================//
+  //Should have an object argument
+  if (!Obj) throw new Error(`No valid arguments provided`)
+
+  //List required attributes
+  const required = []
+
+  for (const _type in Args) {
+    // Should be a required type
+    if (
+      ![
+        'boolType',
+        'arrayType',
+        'stringType',
+        'objectType',
+        'numberType'
+      ].includes(_type)
+    )
+      throw new Error(`Unknown types declaration : ${_type}`)
+
+    if (Args[_type] && Args[_type].length) {
+      for (let el of Args[_type]) {
+        //Check that each given element is a string
+        if (el.constructor !== String)
+          throw new Error(
+            `Invalid type detected in ${JSON.stringify(
+              Args[_type]
+            )}. Item ${Args[_type].indexOf(el) + 1} should be a String`
+          )
+
+        if (!optionalArgs.includes(el)) required.push(el)
+      }
+    }
+  }
+
+  //validate Args Keys type
+  for (const _type in Args) {
+    for (let el of Args[_type]) {
+      let reg = /(\$el\$)|(\$type\$)|(\$attr\$)/g
+
+      switch (true) {
+        // Check That each given element exist in data if not optional
+        case Obj[el] === undefined && required.includes(el): {
+          reg = /(\$key\$)|(\$el\$)|(\$args\$)/g
+          const reg2 = /\[|\]|/g
+
+          errorInConsole.push(
+            ERR_TYPE.err3.replace(reg, (e) => {
+              if (e == '$key$') return el
+              if (e == '$el$') return compName
+              if (e == '$args$') return JSON.stringify(required)
+            })
+          )
+
+          errorList.push(
+            ERR_TYPE_MSG.err3.replace(reg, (e) => {
+              if (e == '$key$') return el
+              if (e == '$el$') return compName || 'Composant'
+              if (e == '$args$')
+                return JSON.stringify(required).replaceAll(reg2, '')
+            })
+          )
+          break
+        }
+        //Should have Correct Types $attr$ $el$ $type$
+        case _type == 'boolType' &&
+          Obj[el] !== undefined &&
+          Obj[el].constructor !== Boolean:
+          errorInConsole.push(
+            ERR_TYPE.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Boolean'
+            })
+          )
+          errorList.push(
+            ERR_TYPE_MSG.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Boolean'
+            })
+          )
+          break
+
+        case _type == 'stringType' &&
+          Obj[el] !== undefined &&
+          (Obj[el].constructor !== String || !Obj[el].trim().length):
+          errorInConsole.push(
+            ERR_TYPE.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'String'
+            })
+          )
+          errorList.push(
+            ERR_TYPE_MSG.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'String'
+            })
+          )
+          break
+
+        case _type == 'arrayType' &&
+          Obj[el] !== null &&
+          Obj[el] !== undefined &&
+          (Obj[el].constructor !== Array || !Obj[el].length):
+          errorInConsole.push(
+            ERR_TYPE.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Array'
+            })
+          )
+          errorList.push(
+            ERR_TYPE_MSG.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Array'
+            })
+          )
+          break
+
+        case _type == 'numberType' &&
+          Obj[el] !== undefined &&
+          Obj[el].constructor !== Number:
+          errorInConsole.push(
+            ERR_TYPE.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Number'
+            })
+          )
+          errorList.push(
+            ERR_TYPE_MSG.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Number'
+            })
+          )
+          break
+
+        case _type == 'objectType' &&
+          Obj[el] !== undefined &&
+          Obj[el].constructor !== Object:
+          errorInConsole.push(
+            ERR_TYPE.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Object'
+            })
+          )
+          errorList.push(
+            ERR_TYPE_MSG.err2.replace(reg, (e) => {
+              if (e == '$attr$') return compName || 'Composant'
+              if (e == '$el$') return el
+              if (e == '$type$') return 'Object'
+            })
+          )
+          break
+      }
+    }
+  }
+
+  return { errorInConsole, errorList }
+}
+
 /**
  * @description Validator for the content of menu setting file
  * @param {String} fName- name of the file for use case
@@ -475,49 +720,6 @@ const validateAudioData = (data) => {
   }
   return errorList
 }
-//Get all the invalids properties from the object
-/*Add element from target array that are NOT in arr to the wrongArray*/
-const checkerWrong = (arr, target) => {
-  let wrongArray = []
-  target.every((v) => {
-    if (arr.includes(v)) {
-      return true
-    } else {
-      wrongArray.push(v)
-      return true
-    }
-  })
-  return wrongArray
-}
-//Get all the required properties that are missing from the object
-/*Add element from the arr that are NOT in target arr to the missingArray*/
-const checkerMissing = (arr, target) => {
-  let missingArray = []
-  arr.every((v) => {
-    if (target.includes(v)) {
-      return true
-    } else {
-      missingArray.push(v)
-      return true
-    }
-  })
-  return missingArray
-}
-
-const ERR_TYPE = {
-  err0: `\n 💥 Missing \x1B[1m$attr$ \x1B[0mfor $comp$. \x1B[1m$attr$ \x1B[0m should be provided with following attributes: \x1B[1m{$data$}`,
-  err1: `\n 💥 Invalid declaration for \x1B[1m$wrd$ \x1B[0m object`,
-  err2: `\n 💥 Invalid type declaration for 👉\x1B[1m$attr$ \x1B[0m👈 in \x1B[1m$el$\x1B[0m. Expected is \x1B[3m$type$ \x1B[0mtype with some value`,
-  err3: `\n 💥 Missing required argument 👉\x1B[1m$key$\x1B[0m👈 in \x1B[1m$el$\x1B[0m. Required arguments are: \x1B[1m$args$`,
-  err4: `\n 💥 Missing required argument 👉\x1B[1m$key$\x1B[0m👈 in \x1B[1m$el$\x1B[0m. Required arguments are: \x1B[1m$args$`
-}
-
-const ERR_TYPE_MSG = {
-  err0: `\n Données manquantes pour <span style='text-transform: uppercase;'>$comp$</span>. Assurez-vous que le composant reçoit l'attribut <b>$attr$</b> avec des données pour: <b>$data$</b>`,
-  err1: `\n Déclaration invalide pour <b>$wrd$</b>. Assurez-vous que l'application a du data.`,
-  err2: `\n Vous avez une declaration invalide dans <b>$attr$</b>. 👉<b>$el$</b>👈 n'accepte que le type <i>$type$</i> et ne peut pas être vide`,
-  err3: `\n L'attribut 👉<b>$key$</b>👈 est manquant dans <b>$el$</b>. Les attributs requis sont: <b>$args$</b>`
-}
 
 /**
  * @description Validator for the content of app data.
@@ -643,196 +845,6 @@ const validateAppContent = (data, silent = false) => {
   return errorList
 }
 
-/**
- * @description - Method to validate that given object attributes hold expected types
- * @param {Object} Obj - object to validate
- * @param {Object} Args - List of expected type groups - each type group must be an array of attributes with the same type
- * @param {Array} notRequiredArgs - list of field that should be considered as optional in the object. Will not give error if not * provided but will be validated if they are present with wrong type or empty
- * @param {Array} compName - Name of the component- will be display in error message
- * @param {Array}   err - list off errors to be added to
- * @return {Object} list of errors - {errorInConsole, errorList} : errorlist can be used to display messages on template and
- * errorInConsole to display messages in browser console
- * @exemple - Given $user= {name:'toto', username:'totoEscargot', id:'id001', age:23, books:['one', 'two', 'three']  }
- * Use validator on $user:  validateObjType($user, {stringType:['name', 'username' , 'id'], numbType:['age'], arrayType:['books']})
- * Will fail if any listed attribute not in $user or have wrong value. Error messages will be in console
- *
- */
-
-const validateObjType = (
-  Obj,
-  Args = {
-    boolType: null,
-    arrayType: null,
-    stringType: null,
-    objectType: null,
-    numbType: null
-  },
-  notRequiredArgs = null,
-  compName = 'component',
-  err = null
-) => {
-  let errorInConsole = err && err.errorInConsole ? err.errorInConsole : []
-  let errorList = err && err.errorList ? err.errorLIst : []
-  let optionalArgs =
-    notRequiredArgs && notRequiredArgs.length ? notRequiredArgs : []
-  //=====Expected Arguments validation =================//
-  //Should have an object argument
-  if (!Obj) throw new Error(`No valid arguments provided`)
-
-  //validate Args Keys type
-  for (const _type in Args) {
-    // Should be a required type
-    if (
-      ![
-        'boolType',
-        'arrayType',
-        'stringType',
-        'objectType',
-        'numbType'
-      ].includes(_type)
-    )
-      throw new Error(`Unknown types declaration : ${_type}`)
-
-    if (Args[_type] && Args[_type].length) {
-      for (let el of Args[_type]) {
-        //Check that each given element is a string
-        if (el.constructor !== String)
-          throw new Error(
-            `Invalid type detected in ${JSON.stringify(
-              Args[_type]
-            )}. Item ${Args[_type].indexOf(el) + 1} should be a String`
-          )
-
-        let reg = /(\$el\$)|(\$type\$)|(\$attr\$)/g
-
-        let isOptionalArg = optionalArgs.includes(el) ? true : false
-
-        switch (true) {
-          // Check That each given element exist in data if not optional
-          case Obj[el] === undefined && !isOptionalArg: {
-            reg = /(\$key\$)|(\$el\$)|(\$args\$)/g
-            const reg2 = /\[|\]|/g
-
-            errorInConsole.push(
-              ERR_TYPE.err3.replace(reg, (e) => {
-                if (e == '$key$') return el
-                if (e == '$el$') return compName
-                if (e == '$args$') return JSON.stringify(Args[_type])
-              })
-            )
-
-            errorList.push(
-              ERR_TYPE_MSG.err3.replace(reg, (e) => {
-                if (e == '$key$') return el
-                if (e == '$el$') return compName || 'Composant'
-                if (e == '$args$')
-                  return JSON.stringify(Args[_type]).replaceAll(reg2, '')
-              })
-            )
-            break
-          }
-          //Should have Correct Types $attr$ $el$ $type$
-          case _type == 'boolType' &&
-            Obj[el] !== undefined &&
-            Obj[el].constructor !== Boolean:
-            errorInConsole.push(
-              ERR_TYPE.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Boolean'
-              })
-            )
-            errorList.push(
-              ERR_TYPE_MSG.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Boolean'
-              })
-            )
-            break
-
-          case _type == 'stringType' &&
-            Obj[el] !== undefined &&
-            (Obj[el].constructor !== String || !Obj[el].trim().length):
-            errorInConsole.push(
-              ERR_TYPE.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'String'
-              })
-            )
-            errorList.push(
-              ERR_TYPE_MSG.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'String'
-              })
-            )
-            break
-
-          case _type == 'arrayType' &&
-            Obj[el] !== undefined &&
-            (Obj[el].constructor !== Array || !Obj[el].length):
-            errorInConsole.push(
-              ERR_TYPE.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Array'
-              })
-            )
-            errorList.push(
-              ERR_TYPE_MSG.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Array'
-              })
-            )
-            break
-
-          case _type == 'numberType' &&
-            Obj[el] !== undefined &&
-            Obj[el].constructor !== Number:
-            errorInConsole.push(
-              ERR_TYPE.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Number'
-              })
-            )
-            errorList.push(
-              ERR_TYPE_MSG.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Number'
-              })
-            )
-            break
-
-          case _type == 'objectType' &&
-            Obj[el] !== undefined &&
-            Obj[el].constructor !== Object:
-            errorInConsole.push(
-              ERR_TYPE.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Object'
-              })
-            )
-            errorList.push(
-              ERR_TYPE_MSG.err2.replace(reg, (e) => {
-                if (e == '$attr$') return compName || 'Composant'
-                if (e == '$el$') return el
-                if (e == '$type$') return 'Object'
-              })
-            )
-            break
-        }
-      }
-    }
-  }
-
-  return { errorInConsole, errorList }
-}
 /**
  * @description - Method validate the definition of SVG data.
  * @param {Array || Object } SVGData - the data defining the SVG to render
@@ -918,11 +930,73 @@ const validateSvgDefinition = (SVGData) => {
   return true
 }
 
+/**
+ * @description - Method validate the definition data forthe quiz.
+ * @param {Object} data - the data defining the SVG to render
+ * @return true - if valid
+ * */
+const validateQuizData = (data) => {
+  let errors
+  let stringType = ['ennonce', 'id', 'type_question', 'texte_base']
+  let arrayType = ['choix_reponse', 'solution']
+  let objectType = ['retroaction']
+  let numberType = ['valeur_point', 'max_tentative']
+  let optionalArgs = ['valeur_point', 'max_tentative', 'texte_base']
+
+  errors = validateObjType(
+    data,
+    { stringType, arrayType, objectType, numberType },
+    optionalArgs,
+    'quizData'
+  )
+
+  let hasError = errors.errorInConsole.length || errors.errorList.length
+
+  if (hasError) return errors
+
+  //validate Containt for retroaction
+
+  switch (true) {
+    case data.retroaction != null:
+      objectType = ['retro_positive', 'retro_negative', 'retro_neutre']
+
+      errors = validateObjType(
+        data.retroaction,
+        { objectType },
+        null,
+        'quizData retraoction'
+      )
+      hasError = errors.errorInConsole.length || errors.errorList.length
+
+      if (hasError) return errors
+
+      //  Validate containt of retroaction attributes
+      stringType = ['title', 'hypertext']
+
+      for (const key of Object.keys(data.retroaction)) {
+        errors = validateObjType(
+          data.retroaction[key],
+          { stringType },
+          null,
+          key
+        )
+
+        hasError = errors.errorInConsole.length || errors.errorList.length
+
+        if (hasError) return errors
+      }
+
+      break
+  }
+  return errors
+}
+
 export {
   validateObjType,
   validateVideoData,
   validateAudioData,
   validatefileContent,
   validateAppContent,
-  validateSvgDefinition
+  validateSvgDefinition,
+  validateQuizData
 }