fcad-core-dragon 2.0.0-beta.0 → 2.0.0-beta.2

package/src/module/xapi/xapiStatement.js

@@ -64,7 +64,7 @@ export function xapiStatement(ADL) {
    * "result": {
    *      "An optional property that represents a measured outcome related to the Statement in which it is included."}}
    */
-  var XAPIStatement = function(actor, verb, object, context, result) {
+  var XAPIStatement = function (actor, verb, object, context, result) {
     // initialize
 
     // if first arg is an xapi statement, parse
@@ -122,12 +122,12 @@ export function xapiStatement(ADL) {
       this.context = context
     }
 
-    this.generateId = function() {
+    this.generateId = function () {
       this.id = ADL.ruuid()
     }
   }
 
-  XAPIStatement.prototype.toString = function() {
+  XAPIStatement.prototype.toString = function () {
     return (
       this.actor.toString() +
       ' ' +
@@ -139,7 +139,7 @@ export function xapiStatement(ADL) {
     )
   }
 
-  XAPIStatement.prototype.isValid = function() {
+  XAPIStatement.prototype.isValid = function () {
     return (
       this.actor &&
       this.actor.isValid() &&
@@ -152,30 +152,30 @@ export function xapiStatement(ADL) {
     )
   }
 
-  XAPIStatement.prototype.generateRegistration = function() {
+  XAPIStatement.prototype.generateRegistration = function () {
     _getobj(this, 'context').registration = ADL.ruuid()
   }
 
-  XAPIStatement.prototype.addParentActivity = function(activity) {
+  XAPIStatement.prototype.addParentActivity = function (activity) {
     _getobj(this, 'context.contextActivities.parent[]').push(
       new Activity(activity)
     )
   }
 
-  XAPIStatement.prototype.addGroupingActivity = function(activity) {
+  XAPIStatement.prototype.addGroupingActivity = function (activity) {
     _getobj(this, 'context.contextActivities.grouping[]').push(
       new Activity(activity)
     )
   }
 
-  XAPIStatement.prototype.addOtherContextActivity = function(activity) {
+  XAPIStatement.prototype.addOtherContextActivity = function (activity) {
     _getobj(this, 'context.contextActivities.other[]').push(
       new Activity(activity)
     )
   }
 
   ///////////////////////////////////////////////////////////////
-  XAPIStatement.prototype._setActor = function(email, name, objectType) {
+  XAPIStatement.prototype._setActor = function (email, name, objectType) {
     let actor = {
       mbox: 'mailto:' + email,
       name: name,
@@ -190,13 +190,13 @@ export function xapiStatement(ADL) {
    * @Params {String | Object} verb
    *
    */
-  XAPIStatement.prototype._setVerb = function(verb) {
+  XAPIStatement.prototype._setVerb = function (verb) {
     if (verb instanceof Verb) this.verb = verb
     else if (verbs[verb]) this.verb = verbs[verb]
     else this.verb = new Verb(verb)
   }
 
-  XAPIStatement.prototype._setObject = function(object) {
+  XAPIStatement.prototype._setObject = function (object) {
     if (object.objectType === 'Activity' || !object.objectType) {
       if (object instanceof Activity) this.object = object
       else this.object = new Activity(object)
@@ -215,7 +215,7 @@ export function xapiStatement(ADL) {
     } else this.object = null
   }
 
-  XAPIStatement.prototype._setResultScore = function(
+  XAPIStatement.prototype._setResultScore = function (
     score,
     scoreScale,
     scoreMin,
@@ -230,7 +230,7 @@ export function xapiStatement(ADL) {
     }
   }
 
-  XAPIStatement.prototype._setResultKey = function(key, value) {
+  XAPIStatement.prototype._setResultKey = function (key, value) {
     if (!this.result) this.result = {} //define the result key
     //define the extra keys of the result
     if (key == 'success') this.result.success = value
@@ -240,7 +240,7 @@ export function xapiStatement(ADL) {
     else if (key == 'completion') this.result.completion = value
   }
 
-  XAPIStatement.prototype._setContext = function(context) {
+  XAPIStatement.prototype._setContext = function (context) {
     if (typeof context !== 'object') throw 'this not a valid context'
     if (!this.context)
       Object.defineProperty(this, 'context', { value: {}, writable: true })
@@ -259,7 +259,7 @@ export function xapiStatement(ADL) {
    *     See (https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md#inversefunctional)
    * @param {string} [name]   The natural-language name of the agent
    */
-  var Agent = function(identifier, name) {
+  var Agent = function (identifier, name) {
     this.objectType = 'Agent'
     this.name = name
 
@@ -284,7 +284,7 @@ export function xapiStatement(ADL) {
       this.account = identifier
     }
   }
-  Agent.prototype.toString = function() {
+  Agent.prototype.toString = function () {
     return (
       this.name ||
       this.mbox ||
@@ -293,7 +293,7 @@ export function xapiStatement(ADL) {
       this.account.name
     )
   }
-  Agent.prototype.isValid = function() {
+  Agent.prototype.isValid = function () {
     return (
       this.mbox ||
       this.mbox_sha1sum ||
@@ -309,7 +309,7 @@ export function xapiStatement(ADL) {
    * @param {string} [members]    An array of Agents describing the membership of the group
    * @param {string} [name]   The natural-language name of the agent
    */
-  var Group = function(identifier, members, name) {
+  var Group = function (identifier, members, name) {
     Agent.call(this, identifier, name)
     this.member = members
     this.objectType = 'Group'
@@ -321,7 +321,7 @@ export function xapiStatement(ADL) {
    * @param {string} id   The IRI of the action taken
    * @param {string} [description]    An English-language description, or a Language Map
    */
-  var Verb = function(id, description) {
+  var Verb = function (id, description) {
     // if passed a verb object then copy and return
     if (id && id.id) {
       for (var i in id) {
@@ -340,12 +340,12 @@ export function xapiStatement(ADL) {
       }
     }
   }
-  Verb.prototype.toString = function() {
+  Verb.prototype.toString = function () {
     if (this.display && (this.display['en-US'] || this.display['en']))
       return this.display['en-US'] || this.display['en']
     else return this.id
   }
-  Verb.prototype.isValid = function() {
+  Verb.prototype.isValid = function () {
     return this.id
   }
 
@@ -355,7 +355,7 @@ export function xapiStatement(ADL) {
    * @param {string} name   An English-language identifier for the activity, or a Language Map
    * @param {string} description   An English-language description of the activity, or a Language Map
    */
-  var Activity = function(id, name, description) {
+  var Activity = function (id, name, description) {
     // if first arg is activity, copy everything over
     if (id && id.id) {
       var act = id
@@ -379,7 +379,7 @@ export function xapiStatement(ADL) {
       else if (description) this.definition.description = description
     }
   }
-  Activity.prototype.toString = function() {
+  Activity.prototype.toString = function () {
     if (
       this.definition &&
       this.definition.name &&
@@ -388,7 +388,7 @@ export function xapiStatement(ADL) {
       return this.definition.name['en-US'] || this.definition.name['en']
     else return this.id
   }
-  Activity.prototype.isValid = function() {
+  Activity.prototype.isValid = function () {
     return this.id && (!this.objectType || this.objectType === 'Activity')
   }
 
@@ -396,7 +396,7 @@ export function xapiStatement(ADL) {
    * An object that refers to a separate statement
    * @param {string} id   The UUID of another xAPI statement
    */
-  var StatementRef = function(id) {
+  var StatementRef = function (id) {
     if (id && id.id) {
       for (var i in id) {
         this[i] = id[i]
@@ -406,10 +406,10 @@ export function xapiStatement(ADL) {
       this.id = id
     }
   }
-  StatementRef.prototype.toString = function() {
+  StatementRef.prototype.toString = function () {
     return 'statement(' + this.id + ')'
   }
-  StatementRef.prototype.isValid = function() {
+  StatementRef.prototype.isValid = function () {
     return this.id && this.objectType && this.objectType === 'StatementRef'
   }
 
@@ -420,7 +420,7 @@ export function xapiStatement(ADL) {
    * @param {string} verb   The Verb for the action described by the statement
    * @param {string} object   The receiver of the action. An Agent, Group, Activity, or StatementRef
    */
-  var SubStatement = function(actor, verb, object) {
+  var SubStatement = function (actor, verb, object) {
     XAPIStatement.call(this, actor, verb, object)
     this.objectType = 'SubStatement'
 
@@ -430,7 +430,7 @@ export function xapiStatement(ADL) {
     delete this.authority
   }
   SubStatement.prototype = new XAPIStatement()
-  SubStatement.prototype.toString = function() {
+  SubStatement.prototype.toString = function () {
     return '"' + SubStatement.prototype.prototype.toString.call(this) + '"'
   }
 

package/src/plugins/gsap.js

@@ -6,7 +6,10 @@
 */
 import gsap from 'gsap'
 import { MotionPathPlugin } from 'gsap/MotionPathPlugin'
-gsap.registerPlugin(MotionPathPlugin)
+import { ScrollTrigger } from 'gsap/ScrollTrigger'
+import { Flip } from 'gsap/Flip'
+
+gsap.registerPlugin(MotionPathPlugin, ScrollTrigger, Flip)
 export default function GsapPlugin(Vue, name) {
   Object.defineProperty(Vue.prototype, name, {
     value: gsap

package/src/plugins/helper.js

@@ -1,16 +1,16 @@
-import routes from '../routes'
+import routes from '../router/routes'
 import store from '../module/store'
+import { name as fcadName, version as fcadVersion } from '../../package.json'
 
 import axios from 'axios'
 
-const { routes: _routes } = routes
-const locale_en = require('../$locales/en.json')
-const locale_fr = require('../$locales/fr.json')
+import locale_en from '../$locales/en.json'
+import locale_fr from '../$locales/fr.json'
 
 export default function helper(Vue, name) {
   Object.defineProperty(Vue.prototype, 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).
@@ -19,7 +19,7 @@ export default function helper(Vue, name) {
        */
       getRoutesFromVueRouter: (ID) => {
         //let all_routes
-        let { children: all_routes, meta } = _routes[1].children[0]
+        let { children: all_routes, meta } = routes[1].children[0]
 
         if (ID) {
           let f = all_routes.find((route) => route.meta.id === ID)
@@ -31,14 +31,52 @@ export default function helper(Vue, name) {
 
         return { all_routes, meta }
       },
-      /* @Description: helper to get the menu information from the store.
+      /** @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) {
+        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() {
         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
@@ -73,7 +111,7 @@ export default function helper(Vue, name) {
         }
         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'
@@ -84,7 +122,7 @@ export default function helper(Vue, name) {
        *  - 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'))
+       *             module requirement with method require(). ex: downloadFile(require('@/accets/another_folder/**                myfile'))
        *
        */
       async downloadFile(filepath, outputName) {
@@ -115,7 +153,7 @@ export default function helper(Vue, name) {
           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')
@@ -138,7 +176,7 @@ export default function helper(Vue, name) {
         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/
@@ -164,7 +202,7 @@ export default function helper(Vue, name) {
 
         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
@@ -173,7 +211,7 @@ export default function helper(Vue, name) {
        */
       getNextLessonEnv(linkedResource) {
         let courseLocation, host, courseId
-        /*ID*/
+        /**ID*/
         if (linkedResource.id.startsWith('http')) {
           courseId = linkedResource.id.split('lrs-xapi/')[1]
         } else {
@@ -183,7 +221,7 @@ export default function helper(Vue, name) {
           }
         }
 
-        /*URL*/
+        /**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]
@@ -194,10 +232,9 @@ export default function helper(Vue, name) {
           }
         }
 
-        host =
-          process.env.NODE_ENV === 'production'
-            ? window.location.host
-            : 'projets.cegepadistance.ca'
+        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}`
@@ -210,30 +247,27 @@ export default function helper(Vue, name) {
         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) {
-        console.log('My TIME : ', t)
         if (!t) return
         let regex = new RegExp(':', 'gm')
         let T = !regex.test(t) ? this.formatTime(t) : t
 
         // let timeStr = `PT${t}S`
-        console.log('TEST---', T, T.match(regex))
 
         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`
-        console.log('ISO TIME: ', timeStr)
 
         return timeStr
       },
-      /**
+      /***
        * Method to format Time to ISOS String
        * @param {String} T - time Iso Time
        * @return {String} - time PT Format

package/src/plugins/i18n.js

@@ -1,10 +1,12 @@
+import _ from 'lodash'
+
 /**
  * Merge locales message in project.
  * @summary To merge the locales dictionnary of this library with the locales that user will create
  * @param {Object} i18n - vue-i18n internalization object.
  */
 export default function mergeLocales(i18n) {
-  const deep = require('lodash') // provide deep merge of Object cf: https://attacomsian.com/blog/javascript-merge-objects
+  //const deep = import('lodash') // provide deep merge of Object cf: https://attacomsian.com/blog/javascript-merge-objects
 
   /* I18n internal methods for mutating messages property
    * mergeLocaleMessage: ƒ mergeLocaleMessage(locale, message)// will merge message with new message object. But does not do a deep merge of object
@@ -12,20 +14,31 @@ export default function mergeLocales(i18n) {
    */
 
   // This library locales files
-  const thisLocales = require.context(
-    '../$locales',
-    true,
-    /[A-Za-z0-9-_,\s]+\.json$/i
-  )
+  // const thisLocales = require.context(
+  //   '../$locales',
+  //   true,
+  //   /[A-Za-z0-9-_,\s]+\.json$/i
+  // )
 
-  thisLocales.keys().forEach((key) => {
-    const matched = key.match(/([A-Za-z0-9-_]+)\./i)
+  const thisLocales = import.meta.glob('../$locales/*.json', { eager: true })
+  for (const path in thisLocales) {
+    const matched = path.match(/([A-Za-z0-9-_]+)\./i)
     if (matched && matched.length > 1) {
       const locale = matched[1]
       // Using lodash to deeply merge objects
-      const mergedMessages = deep.merge(i18n.messages[locale], thisLocales(key))
+      const mergedMessages = _.merge(i18n.messages[locale], thisLocales[path])
       // Since merLocalMessage will do a shallow merge of the object. We will use setLocalMessage to replace the message with new message object
       i18n.setLocaleMessage(locale, mergedMessages)
     }
-  })
+  }
+  // thisLocales.keys().forEach((key) => {
+  //   const matched = key.match(/([A-Za-z0-9-_]+)\./i)
+  //   if (matched && matched.length > 1) {
+  //     const locale = matched[1]
+  //     // Using lodash to deeply merge objects
+  //     const mergedMessages = deep.merge(i18n.messages[locale], thisLocales(key))
+  //     // Since merLocalMessage will do a shallow merge of the object. We will use setLocalMessage to replace the message with new message object
+  //     i18n.setLocaleMessage(locale, mergedMessages)
+  //   }
+  // })
 }

package/src/plugins/idb.js

@@ -64,6 +64,7 @@ export const $idb = {
             searchIndex,
             data[searchIndex]
           )
+
           //Add entry to database if does not exist
           if (!value) {
             const addedItem = await dataBase.add(storeName, data)

package/src/plugins/scorm.js

@@ -4,7 +4,7 @@
  */
 
 export const scormPlugin = {
-  install: function(Vue) {
+  install: function (Vue) {
     {
       Vue.prototype.$scorm = {
         nFindAPITries: 0,
@@ -41,7 +41,7 @@ export const scormPlugin = {
         // value to the win parameter passed in, based on the number of
         // parents.  At the end of the function call, the win variable will be
         // set to the upper most parent in the chain of parents.
-        ScanForAPI: function(win) {
+        ScanForAPI: function (win) {
           while (win.API == null && win.parent != null && win.parent != win) {
             this.nFindAPITries++
             if (this.nFindAPITries > this.maxTries) {
@@ -60,7 +60,7 @@ export const scormPlugin = {
         // function then checks to see if there are any opener windows.  If
         // the window has an opener, the function begins to look for the
         // this.API Instance in the opener window.
-        GetAPI: function(win) {
+        GetAPI: function (win) {
           if (win.parent != null && win.parent != win) {
             this.API = this.ScanForAPI(win.parent)
           }
@@ -70,7 +70,7 @@ export const scormPlugin = {
         },
 
         // Initalize
-        Initialize: function() {
+        Initialize: function () {
           let result
 
           this.GetAPI(window)
@@ -104,7 +104,7 @@ export const scormPlugin = {
           this.initialized = true
         },
         //Termitate the communication with the LMS
-        Finish: function(finalState) {
+        Finish: function (finalState) {
           let result
           //Don't terminate if we haven't initialized or if we've already terminated
           if (this.initialized === false || this.terminateCalled === true) {
@@ -144,7 +144,7 @@ export const scormPlugin = {
         //There are situations where a GetValue call is expected to have an error
         //and should not alert the user.
 
-        GetValue: function(element, checkError) {
+        GetValue: function (element, checkError) {
           let result
 
           if (this.initialized == false || this.terminateCalled == true) {
@@ -179,7 +179,7 @@ export const scormPlugin = {
           return result
         },
 
-        SetValue: function(element, value) {
+        SetValue: function (element, value) {
           let result
 
           if (this.initialized == false || this.terminateCalled == true) {
@@ -209,7 +209,7 @@ export const scormPlugin = {
           }
         },
 
-        Commit: function() {
+        Commit: function () {
           let result
 
           result = this.API.LMSCommit('')
@@ -235,7 +235,7 @@ export const scormPlugin = {
           }
         },
         //==================== CUSTOME METHODS =============================
-        checkForError: function() {
+        checkForError: function () {
           let error_type = null
           let errorNumber = this.API.LMSGetLastError()
           if (errorNumber !== '' || errorNumber !== '0') {
@@ -249,24 +249,24 @@ export const scormPlugin = {
           } else return error_type
         },
 
-        formateMsg: function(msg, data) {
+        formateMsg: function (msg, data) {
           msg.replace('$@errorDescription', data)
         },
 
-        getScormStatus: function() {
+        getScormStatus: function () {
           return this.initialized
         },
 
-        getScormAPI: function() {
+        getScormAPI: function () {
           return this.API
         },
 
-        setCompletionStatus: function(newStatus) {
+        setCompletionStatus: function (newStatus) {
           this.API.RunTimeData.CompletionStatus = newStatus
           this.Commit()
         },
 
-        setSucessStatus: function(newStatus) {
+        setSucessStatus: function (newStatus) {
           this.API.RunTimeData.SuccessStatus = newStatus
           this.Commit()
         },

package/src/public/index.html

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="en">
+<html lang="en" data-build-time="<%= new Date().toLocaleString() %>">
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">

package/src/router/index.js

@@ -0,0 +1,40 @@
+import Vue from 'vue'
+import VueRouter from 'vue-router'
+import routes from './routes'
+
+Vue.use(VueRouter)
+
+const router = new VueRouter({
+  base: import.meta.env.BASE_URL,
+  routes,
+  scrollBehavior(to, from, savedPosition) {
+    if (to.hash) {
+      from, savedPosition
+      return {
+        selector: to.hash
+        // , offset: { x: 0, y: 10 }
+      }
+    }
+  }
+})
+
+router.beforeResolve((to, from, next) => {
+  const noNavigationToMenu =
+    Vue.prototype.$helper.getSettingsFromStore('no_menu')
+
+  Vue.prototype.$bus.$emit('update-route-history', from)
+  Vue.prototype.$bus.$emit('update-content', to, from, next)
+
+  if (noNavigationToMenu && to.name == 'menu') {
+    const r = Vue.prototype.$helper.getRoutesFromVueRouter() //This return all the routes defined for the module
+    let safeRoute = r.meta.children[0] //get the first navigable route from the module routes
+
+    return next({
+      name: safeRoute._namedRoute // redirect to safety route //
+    })
+  }
+
+  return next(true)
+})
+
+export default router