fcad-core-dragon 2.0.0-beta.3 → 2.0.0-beta.5

package/src/plugins/helper.js

@@ -1,308 +1,355 @@
-import routes from '../router/routes'
-import { useAppStore } from '../module/stores/appStore'
-import { name as fcadName, version as fcadVersion } from '../../package.json'
-
-import axios from 'axios'
-
-import locale_en from '../$locales/en.json'
-import locale_fr from '../$locales/fr.json'
-
-export default function helper(app, name) {
-  Object.defineProperty(app.config.globalProperties, name, {
-    value: {
-      /***
-       * @description: helper to get the collection of routes of activies from vue-Router.
-       * @note If need more info from the router , use directly the vue-router
-       * @param {String} ID [optional] - ID of an activity (ex: A01).
-       * @return {Array} - return all routes for an activity Or all the routes of the module
-       *
-       */
-      getRoutesFromVueRouter: (ID) => {
-        //let all_routes
-        //const appStore = useAppStore()
-        //const routes = appStore.$state.allModuleRoutes
-        //let { children: all_routes, meta } = routes[0]
-        let { children: all_routes, meta } = routes[1].children[0]
-
-        if (ID) {
-          let f = all_routes.find((route) => route.meta.id === ID)
-          if (f) {
-            all_routes = f.children
-            meta = f.meta
-          }
-        }
-        return { all_routes, meta }
-      },
-      /** @description: helper to get the build timestamp. Useful for QA
-       *
-       */
-      getBuildTime() {
-        return document.documentElement.dataset.buildTime
-      },
-      /**
-       * @description: helper to get the FCAD version full string. Useful for QA
-       *
-       */
-      getFcadVersionString() {
-        return `${fcadName} v${fcadVersion}`
-      },
-      /** @description: helper to get the FCAD version number. Useful for QA
-       *
-       */
-      getFcadVersion() {
-        return `${fcadVersion}`
-      },
-
-      /**
-       * @description: helper to get App setting information from the store.
-       * @param {String} sName - a key of specific value from the settings
-       * ex: 'specification' to return the specification of the app: xapi |scorm
-       * @return {Object|null} -
-       */
-      getSettingsFromStore(sName = null) {
-        const store = useAppStore()
-        if (
-          !store.$state.appConfigs ||
-          store.$state.appConfigs[sName] == undefined
-        )
-          return null
-
-        if (sName) return store.$state.appConfigs[sName]
-        else return store.$state.appConfigs
-      },
-
-      /**
-       * @description: helper to get the menu information from the store.
-       *
-       */
-      getMenuInfoFromStore() {
-        const store = useAppStore()
-        if (store.$state.menuSetting) return store.$state.menuSetting
-        else return null
-      },
-      /***
-       * @description Method to return a myme time of a document
-       * @param {String} aType extension of the document exemple: doc , pdf ect...
-       * @return {String} mime
-       */
-      mimeTypeFor(aType) {
-        let mimeType = false
-        switch (aType) {
-          case 'doc':
-            mimeType = 'application/msword'
-            break
-
-          case 'docx':
-            mimeType =
-              'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-            break
-
-          case 'pdf':
-            mimeType = 'application/pdf'
-            break
-
-          case 'txt':
-            mimeType = 'text/plain'
-            break
-
-          case 'jpeg' || 'jpg':
-            mimeType = 'image/jpeg'
-            break
-
-          case 'png':
-            mimeType = 'image/png'
-            break
-        }
-        return mimeType
-      },
-      /***
-       * @description method to download a file.
-       * @param {String} filePath url of the file to download
-       * @param {String} outputName 'the default name for the download file'
-       * @summary Use axios to simulate a file request from server.
-       *          Create <a> tag with downloadable link and download the element to user PC.
-       *          Remove a element after download
-       * @usage:
-       *  - case 1: the file is in the public folder of your project. Use full path ex: downloadFile('./public/
-       *             myfile')
-       *  - case 2: file is in another folder in a src of your project. Use relative path. File is handle  as webpack
-       *             module requirement with method require(). ex: downloadFile(require('@/accets/another_folder/**                myfile'))
-       *
-       */
-      async downloadFile(filepath, outputName) {
-        try {
-          if (filepath && filepath.constructor === String) {
-            const res = await axios.get(filepath, { responseType: 'blob' }) // use http request
-
-            const blob = new Blob([res.data], {
-              type: res.data.type
-            }) // create a blob element
-
-            const alink = document.createElement('a') //create a element
-
-            alink.href = URL.createObjectURL(blob) //create url reference for the object
-            alink.download = outputName || `myFile` // set download name
-            alink.click() //symulate click event to download the object
-
-            URL.revokeObjectURL(alink.href) //release the url referrence of the object
-          } else throw new Error('No URL provided for download')
-        } catch (err) {
-          // plugin has access to $bus through the Vue.proptotype
-          const msg = this.getKeyFromLocal('message.err_download_file')
-
-          app.config.globalProperties.$bus.$emit('open-popup', {
-            type: 'popup-info',
-            value: { text_1: `⚠️ ${msg}` }
-          })
-          console.error('DOWNLOAD ERROR: 💥', err)
-        }
-      },
-      /***
-       * @description - helper methode to retrive a word from a local file.
-       * @param {String} key - key of the word to retrive ex: 'a.b.c'
-       * @return {String } - return the value of the key ex: 'hello world' if exist or the key ('a.b.c')
-       */
-      getKeyFromLocal(key) {
-        if (!key) throw new Error('Missing Key for search')
-        const store = useAppStore()
-        const lang = store.state.appConfigs.lang // get lang from the store
-        const dic = { en: locale_en, fr: locale_fr } //contents of the json locales
-        const keys = key.split('.')
-
-        let value
-        for (let i = 0; i < keys.length; i++) {
-          let n = keys[i]
-          if (i === 0 && dic[lang][n]) value = dic[lang][n]
-          else if (value[n]) value = value[n]
-          else return (value = key)
-        }
-
-        return value
-      },
-
-      /***
-       * @description: Insert line break opportunities into a URL
-       * @param {String} url - original url string to formate
-       * @credit - https://css-tricks.com/better-line-breaks-for-long-urls/
-       */
-      breakUrlString(url) {
-        // Split the URL into an array to distinguish double slashes from single slashes
-        const doubleSlash = url.split('//')
-
-        // Format the strings on either side of double slashes separately
-        let formatted = doubleSlash
-          .map(
-            (str) =>
-              // Insert a word break opportunity after a colon
-              str
-                .replace(/(?<after>:)/giu, '$1<wbr>')
-                // Before a single slash, tilde, period, comma, hyphen, underline, question mark, number sign, or percent symbol
-                .replace(/(?<before>[/~.,\-_?#%])/giu, '<wbr>$1')
-                // Before and after an equals sign or ampersand
-                .replace(/(?<beforeAndAfter>[=&])/giu, '<wbr>$1<wbr>')
-            // Reconnect the strings with word break opportunities after double slashes
-          )
-          .join('//<wbr>')
-
-        return formatted
-      },
-      /***
-       * @description: Creates the right url and id for the next lesson, depending on the environment (projets/campus)
-       * Works with full url (ex: https://projets...) or a partial url (ex: 109-101-MQ-60-TP/M1Intro/index.php) set in app.
-       * When working locally, uses the projets.cegepadistance.ca environment
-       * @param {Object} linkedResource - Setting from app.settings.js
-       * @return {Object} - linkedResource object with the right url and id values according to current environment
-       */
-      getNextLessonEnv(linkedResource) {
-        let courseLocation, host, courseId
-        /**ID*/
-        if (linkedResource.id.startsWith('http')) {
-          courseId = linkedResource.id.split('lrs-xapi/')[1]
-        } else {
-          courseId = linkedResource.id
-          if (courseId.startsWith('/')) {
-            courseId = courseId.substring(1)
-          }
-        }
-
-        /**URL*/
-        //If the value is a complete url, split and keep the end only ex: 109-101-MQ-60-TP/M1Intro/index.php
-        if (linkedResource.url.startsWith('http')) {
-          courseLocation = linkedResource.url.split('lrs-xapi/')[1]
-        } else {
-          courseLocation = linkedResource.url
-          if (courseLocation.startsWith('/')) {
-            courseLocation = courseLocation.substring(1)
-          }
-        }
-
-        host = import.meta.env.PROD
-          ? window.location.host
-          : 'projets.cegepadistance.ca'
-
-        linkedResource.id = `https://${host}/lrs-xapi/${courseId}`
-        linkedResource.url = `https://${host}/lrs-xapi/${courseLocation}`
-
-        return linkedResource
-      },
-
-      //Method to get let last activity
-      getlastItemInMap(map) {
-        return [...map][map.size - 1]
-      },
-
-      /***
-       * Method to format Time to ISOS String
-       * @param {String} T - time Iso Time
-       * @return {String} - time PT Format
-       */
-
-      formatToISOSTime(t) {
-        if (!t) return
-        let regex = new RegExp(':', 'gm')
-        let T = !regex.test(t) ? this.formatTime(t) : t
-
-        // let timeStr = `PT${t}S`
-
-        let timeStr =
-          T.match(regex).length > 1
-            ? `PT${T.split(':')[0]}H${T.split(':')[1]}M${T.split(':')[2]}S`
-            : `PT00H${T.split(':')[0]}M${T.split(':')[1]}S`
-
-        return timeStr
-      },
-      /***
-       * Method to format Time to ISOS String
-       * @param {String} T - time Iso Time
-       * @return {String} - time PT Format
-       */
-      formatTime(time) {
-        let returnStr = ``
-        // format a time from second to 00:00:00
-        const option = { minimumIntegerDigits: 2, useGrouping: false }
-        const minutes = Math.floor(time / 60).toLocaleString('en-US', option)
-        const seconds = Math.floor(time - minutes * 60).toLocaleString(
-          'en-US',
-          option
-        )
-        const hours = Math.floor(time / 3600).toLocaleString('en-US', option)
-        if (hours == '00') {
-          returnStr = `${minutes}:${seconds}`
-        } else {
-          returnStr = `${hours}:${minutes}:${seconds}`
-        }
-        return returnStr
-      }, // END formatTime
-
-      /**
-       * @description check if a values exists in a array
-       * @param {Array} array
-       * @param value
-       * @returns {Boolean}
-       */
-      containsValue(array, value) {
-        return array.includes(value)
-      }
-    }
-  })
-}
+import routes from '../router/routes'
+import { useAppStore } from '../module/stores/appStore'
+import { name as fcadName, version as fcadVersion } from '../../package.json'
+
+import axios from 'axios'
+
+import locale_en from '../$locales/en.json'
+import locale_fr from '../$locales/fr.json'
+
+export default function helper(app, name) {
+  Object.defineProperty(app.config.globalProperties, name, {
+    value: {
+      /***
+       * @description: helper to get the collection of routes of activies from vue-Router.
+       * @note If need more info from the router , use directly the vue-router
+       * @param {String} ID [optional] - ID of an activity (ex: A01).
+       * @return {Array} - return all routes for an activity Or all the routes of the module
+       *
+       */
+      getRoutesFromVueRouter: (ID) => {
+        //let all_routes
+        //const appStore = useAppStore()
+        //const routes = appStore.$state.allModuleRoutes
+        //let { children: all_routes, meta } = routes[0]
+        let { children: all_routes, meta } = routes[1].children[0]
+
+        if (ID) {
+          let f = all_routes.find((route) => route.meta.id === ID)
+          if (f) {
+            all_routes = f.children
+            meta = f.meta
+          }
+        }
+        return { all_routes, meta }
+      },
+      /** @description: helper to get the build timestamp. Useful for QA
+       *
+       */
+      getBuildTime() {
+        return document.documentElement.dataset.buildTime
+      },
+      /** @description: helper to get the template version used by projgen to create this project. Useful for QA
+       *
+       */
+      getTemplateVersion() {
+        return document.documentElement.dataset.templateVersion
+      },
+      /**
+       * @description: helper to get the FCAD version full string. Useful for QA
+       *
+       */
+      getFcadVersionString() {
+        return `[${fcadName} v${fcadVersion}] [fcad-template v${this.getTemplateVersion()}] [build ${this.getBuildTime()}]`
+      },
+      /** @description: helper to get the FCAD version number. Useful for QA
+       *
+       */
+      getFcadVersion() {
+        return `${fcadVersion}`
+      },
+
+      /**
+       * @description: helper to get App setting information from the store.
+       * @param {String} sName - a key of specific value from the settings
+       * ex: 'specification' to return the specification of the app: xapi |scorm
+       * @return {Object|null} -
+       */
+      getSettingsFromStore(sName = null) {
+        const store = useAppStore()
+        if (
+          !store.$state.appConfigs ||
+          store.$state.appConfigs[sName] == undefined
+        )
+          return null
+
+        if (sName) return store.$state.appConfigs[sName]
+        else return store.$state.appConfigs
+      },
+
+      /**
+       * @description: helper to get the menu information from the store.
+       *
+       */
+      getMenuInfoFromStore() {
+        const store = useAppStore()
+        if (store.$state.menuSetting) return store.$state.menuSetting
+        else return null
+      },
+      /***
+       * @description Method to return a myme time of a document
+       * @param {String} aType extension of the document exemple: doc , pdf ect...
+       * @return {String} mime
+       * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types
+       */
+      mimeTypeFor(aType) {
+        let mimeType = false
+
+        switch (true) {
+          case aType.endsWith('.doc'):
+            // Microsoft Word
+            mimeType = 'application/msword'
+            break
+
+          case aType.endsWith('.docx'):
+            // Microsoft Word (OpenXML)
+            mimeType =
+              'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+            break
+
+          case aType.endsWith('.pdf'):
+            //Adobe Portable Document Format (PDF)
+            mimeType = 'application/pdf'
+            break
+          case aType.endsWith('.odt'):
+            // OpenDocument text document
+            mimeType = 'application/vnd.oasis.opendocument.text'
+            break
+
+          case aType.endsWith('.txt'):
+            // Text, (generally ASCII or ISO 8859-n)
+            mimeType = 'text/plain'
+            break
+
+          case aType.endsWith('.jpeg') || aType.endsWith('.jpg'):
+            // JPEG images
+            mimeType = 'image/jpeg'
+            break
+
+          case aType.endsWith('.png'):
+            // Portable Network Graphics
+            mimeType = 'image/png'
+            break
+          case aType.endsWith('.csv'):
+            // Comma-separated values (CSV)
+            mimeType = 'text/csv'
+            break
+
+          case aType.endsWith('.xls'):
+            // Microsoft Excel
+            mimeType = 'application/vnd.ms-excel'
+            break
+          case aType.endsWith('.xlsx'):
+            // Microsoft Excel (OpenXML)
+            mimeType =
+              'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+            break
+          case aType.endsWith('.ppt'):
+            //Microsoft PowerPoint
+            mimeType = 'application/vnd.ms-powerpoint'
+            break
+          case aType.endsWith('.pptx'):
+            //Microsoft PowerPoint (OpenXML)
+            mimeType =
+              'tapplication/vnd.openxmlformats-officedocument.presentationml.presentation'
+            break
+          case aType.endsWith('.htm') || aType.endsWith('.html'):
+            // HyperText Markup Language (HTML)
+            mimeType = 'text/html'
+            break
+        }
+
+        return mimeType
+      },
+      /***
+       * @description method to download a file.
+       * @param {String} filePath url of the file to download
+       * @param {String} outputName 'the default name for the download file'
+       * @summary Use axios to simulate a file request from server.
+       *          Create <a> tag with downloadable link and download the element to user PC.
+       *          Remove a element after download
+       * @usage:
+       *  - case 1: the file is in the public folder of your project. Use full path ex: downloadFile('./public/
+       *             myfile')
+       *  - case 2: file is in another folder in a src of your project. Use relative path. import the file  and provide it to the * downloader fonction ex: downloadFile(require('@/accets/another_folder
+       * )
+       *
+       */
+      async downloadFile(filepath, outputName) {
+        try {
+          if (filepath && filepath.constructor === String) {
+            const res = await axios.get(filepath, { responseType: 'blob' }) // use http request
+            console.log(' Download res: ', res)
+            const blob = new Blob([res.data], {
+              // type: res.data.type
+              type: this.mimeTypeFor(filepath)
+            }) // create a blob element
+
+            const alink = document.createElement('a') //create a element
+
+            alink.href = URL.createObjectURL(blob) //create url reference for the object
+            alink.download = outputName || `myFile` // set download name
+            alink.click() //symulate click event to download the object
+
+            URL.revokeObjectURL(alink.href) //release the url referrence of the object
+          } else throw new Error('No URL provided for download')
+        } catch (err) {
+          // plugin has access to $bus through the Vue.proptotype
+          const msg = this.getKeyFromLocal('message.err_download_file')
+
+          app.config.globalProperties.$bus.$emit('open-popup', {
+            type: 'popup-info',
+            value: { text_1: `⚠️ ${msg}` }
+          })
+          console.error('DOWNLOAD ERROR: 💥', err)
+        }
+      },
+      /***
+       * @description - helper methode to retrive a word from a local file.
+       * @param {String} key - key of the word to retrive ex: 'a.b.c'
+       * @return {String } - return the value of the key ex: 'hello world' if exist or the key ('a.b.c')
+       */
+      getKeyFromLocal(key) {
+        if (!key) throw new Error('Missing Key for search')
+        const store = useAppStore()
+        const lang = store.$state.appConfigs.lang // get lang from the store
+        const dic = { en: locale_en, fr: locale_fr } //contents of the json locales
+        const keys = key.split('.')
+
+        let value
+        for (let i = 0; i < keys.length; i++) {
+          let n = keys[i]
+          if (i === 0 && dic[lang][n]) value = dic[lang][n]
+          else if (value[n]) value = value[n]
+          else return (value = key)
+        }
+
+        return value
+      },
+
+      /***
+       * @description: Insert line break opportunities into a URL
+       * @param {String} url - original url string to formate
+       * @credit - https://css-tricks.com/better-line-breaks-for-long-urls/
+       */
+      breakUrlString(url) {
+        // Split the URL into an array to distinguish double slashes from single slashes
+        const doubleSlash = url.split('//')
+
+        // Format the strings on either side of double slashes separately
+        let formatted = doubleSlash
+          .map(
+            (str) =>
+              // Insert a word break opportunity after a colon
+              str
+                .replace(/(?<after>:)/giu, '$1<wbr>')
+                // Before a single slash, tilde, period, comma, hyphen, underline, question mark, number sign, or percent symbol
+                .replace(/(?<before>[/~.,\-_?#%])/giu, '<wbr>$1')
+                // Before and after an equals sign or ampersand
+                .replace(/(?<beforeAndAfter>[=&])/giu, '<wbr>$1<wbr>')
+            // Reconnect the strings with word break opportunities after double slashes
+          )
+          .join('//<wbr>')
+
+        return formatted
+      },
+      /***
+       * @description: Creates the right url and id for the next lesson, depending on the environment (projets/campus)
+       * Works with full url (ex: https://projets...) or a partial url (ex: 109-101-MQ-60-TP/M1Intro/index.php) set in app.
+       * When working locally, uses the projets.cegepadistance.ca environment
+       * @param {Object} linkedResource - Setting from app.settings.js
+       * @return {Object} - linkedResource object with the right url and id values according to current environment
+       */
+      getNextLessonEnv(linkedResource) {
+        let courseLocation, host, courseId
+        /**ID*/
+        if (linkedResource.id.startsWith('http')) {
+          courseId = linkedResource.id.split('lrs-xapi/')[1]
+        } else {
+          courseId = linkedResource.id
+          if (courseId.startsWith('/')) {
+            courseId = courseId.substring(1)
+          }
+        }
+
+        /**URL*/
+        //If the value is a complete url, split and keep the end only ex: 109-101-MQ-60-TP/M1Intro/index.php
+        if (linkedResource.url.startsWith('http')) {
+          courseLocation = linkedResource.url.split('lrs-xapi/')[1]
+        } else {
+          courseLocation = linkedResource.url
+          if (courseLocation.startsWith('/')) {
+            courseLocation = courseLocation.substring(1)
+          }
+        }
+
+        host = import.meta.env.PROD
+          ? window.location.host
+          : 'projets.cegepadistance.ca'
+
+        linkedResource.id = `https://${host}/lrs-xapi/${courseId}`
+        linkedResource.url = `https://${host}/lrs-xapi/${courseLocation}`
+
+        return linkedResource
+      },
+
+      //Method to get let last activity
+      getlastItemInMap(map) {
+        return [...map][map.size - 1]
+      },
+
+      /***
+       * Method to format Time to ISOS String
+       * @param {String} T - time Iso Time
+       * @return {String} - time PT Format
+       */
+
+      formatToISOSTime(t) {
+        if (!t) return
+        let regex = new RegExp(':', 'gm')
+        let T = !regex.test(t) ? this.formatTime(t) : t
+
+        // let timeStr = `PT${t}S`
+
+        let timeStr =
+          T.match(regex).length > 1
+            ? `PT${T.split(':')[0]}H${T.split(':')[1]}M${T.split(':')[2]}S`
+            : `PT00H${T.split(':')[0]}M${T.split(':')[1]}S`
+
+        return timeStr
+      },
+      /***
+       * Method to format Time to ISOS String
+       * @param {String} T - time Iso Time
+       * @return {String} - time PT Format
+       */
+      formatTime(time) {
+        let returnStr = ``
+        // format a time from second to 00:00:00
+        const option = { minimumIntegerDigits: 2, useGrouping: false }
+        const minutes = Math.floor(time / 60).toLocaleString('en-US', option)
+        const seconds = Math.floor(time - minutes * 60).toLocaleString(
+          'en-US',
+          option
+        )
+        const hours = Math.floor(time / 3600).toLocaleString('en-US', option)
+        if (hours == '00') {
+          returnStr = `${minutes}:${seconds}`
+        } else {
+          returnStr = `${hours}:${minutes}:${seconds}`
+        }
+        return returnStr
+      }, // END formatTime
+
+      /**
+       * @description check if a values exists in a array
+       * @param {Array} array
+       * @param value
+       * @returns {Boolean}
+       */
+      containsValue(array, value) {
+        return array.includes(value)
+      }
+    }
+  })
+}