fcad-core-dragon 2.0.0-beta.1 → 2.0.0-beta.10

package/src/module/xapi/ADL.js

@@ -41,7 +41,7 @@ export default class ADL {
     let res = null
     const withResult =
       statement.verb.id.includes('answered') ||
-      statement.verb.id.includes('exited') ||
+      statement.verb.id.includes('suspended') ||
       statement.verb.id.includes('completed')
 
     if (statement.result && !withResult) {
@@ -56,11 +56,45 @@ export default class ADL {
 
     if (withFetch) this.XAPIWrapper.sendStatementWithFetch(statement)
     else {
-      this.XAPIWrapper.sendStatement(statement, function(response) {
+      this.XAPIWrapper.sendStatement(statement, function (response) {
         if (cb) cb()
         res = response
       })
+      return res
+    }
+  }
+
+  /*
+   * Helper function to Dispatch  statement to the LRS
+   * @params: Statement {Object}:xapi Statement
+   */
+  _sendStatements(statements, cb, withFetch = false) {
+    //remove the statement Result if it not answer action.
+    let res = null
+    statements.forEach((statement) => {
+      const withResult =
+        statement.verb.id.includes('answered') ||
+        statement.verb.id.includes('played') ||
+        statement.verb.id.includes('suspended') ||
+        statement.verb.id.includes('completed')
+
+      if (statement.result && !withResult) {
+        delete statement.result
+      }
+
+      //Clear existing id of the statement if any to allow xapi to generate new ID for the Statement.
+      if (statement.id) statement.id = ''
+    })
+
+    // Dispatch the statement to the LRS
+    if (!this.XAPIWrapper) return
 
+    if (withFetch) this.XAPIWrapper.sendStatementsWithFetch(statements)
+    else {
+      this.XAPIWrapper.sendStatements(statements, function (response) {
+        if (cb) cb()
+        res = response
+      })
       return res
     }
   }
@@ -102,58 +136,66 @@ export default class ADL {
    *
    * @Params {String} email: user email
    * @Params {String} activityId: the IRI string of the activity
-   * @Params {String} verb: the verb to search by completed | exited
+   * @Params {String} verb: the verb to search by completed | terminated
    */
-  _getProgress(email, activityId, verb) {
+
+  async _getProgress(email, activityId, verb) {
     let params
-    let vb
-    const validVerbs = ['completed', 'exited']
+    const validVerbs = [
+      'progressed',
+      'completed',
+      'suspended',
+      'terminated',
+      'exited'
+    ]
     if (this.XAPIWrapper) params = this.XAPIWrapper.searchParams()
 
-    verb && validVerbs.includes(verb) ? (vb = verb) : (vb = 'exited')
+    let vb = verb && validVerbs.includes(verb) ? verb : 'terminated'
 
     params['verb'] = this.verbs[vb].id // completed state
     params['activity'] = activityId // this current activity define by this id
     params['agent'] = `{"mbox": "mailto:${email}"}` // the user identify by this email
-    params['limit'] = 500 //limit of record to return by the LRS
+    params['limit'] = 200 //limit of record to return by the LRS
     params['ascending'] = true //ordered by the oldest statement recorded
 
     let date = new Date()
     let dd = new Date(date.setDate(date.getDate() + 1)).toISOString() //Date is set to next day(tomorrow) for Lrs to take in account statement registered today.
-
     params['until'] = dd
 
-    let completedStmts = this.XAPIWrapper.getStatements(params)
-    let userData //placeholder for user data
+    try {
+      let userData //placeholder for user data
+      let completedStmts = await this.XAPIWrapper.getStatements(params)
 
-    if (
-      completedStmts &&
-      completedStmts.statements &&
-      completedStmts.statements.length
-    ) {
-      let length = completedStmts.statements.length
-      let lastRecord = completedStmts.statements[length - 1] // get last recorded statement
-      // Verify that the extensions value of the statement as elements
       if (
-        lastRecord.object.definition.extensions &&
-        Object.keys(lastRecord.object.definition.extensions).length
+        completedStmts &&
+        completedStmts.statements &&
+        completedStmts.statements.length
       ) {
-        const allExtensionsKeys = Object.keys(
-          lastRecord.object.definition.extensions
-        )
-
-        //Search for the user-data entry in the extensions
-
-        const userDataExtension = allExtensionsKeys.filter((extension) =>
-          extension.includes('user-data')
-        )
-        userData = lastRecord.object.definition.extensions[userDataExtension[0]]
+        let lastRecord = completedStmts.statements.toReversed()[0] // get last recorded statement
+
+        // Verify that the extensions value of the statement as elements
+        if (
+          lastRecord.object.definition.extensions &&
+          Object.keys(lastRecord.object.definition.extensions).length
+        ) {
+          const allExtensionsKeys = Object.keys(
+            lastRecord.object.definition.extensions
+          )
+
+          //Search for the user-data entry in the extensions
+          const userDataExtension = allExtensionsKeys.filter((extension) =>
+            extension.includes('user-data')
+          )
+          userData =
+            lastRecord.object.definition.extensions[userDataExtension[0]]
+        }
+      } else {
+        userData = {}
       }
       return userData
-    } else {
-      userData = {}
+    } catch (err) {
+      console.log(err)
     }
-    return userData
   }
 
   /*@Description: Helper to The Lesson Status (result) -
@@ -161,24 +203,24 @@ export default class ADL {
    * @Params {String} email: user email
    * @Params {String} activityId: the IRI string of the activity
    */
-  _getLessonStatus(email, activityId) {
+  async _getLessonStatus(email, activityId, verb) {
     let params
+    const validVerbs = ['completed', 'suspended']
     if (this.XAPIWrapper) params = this.XAPIWrapper.searchParams()
-
-    params['verb'] = this.verbs.completed.id // completed state
+    let vb = verb && validVerbs.includes(verb) ? verb : 'suspended'
+    params['verb'] = this.verbs[vb].id // completed state
     params['activity'] = activityId // this current activity define by this id
     params['agent'] = `{"mbox": "mailto:${email}"}` // the user identify by this email
     params['ascending'] = true //ordered by the oldest statement recorded
 
-    let completedStmts = this.XAPIWrapper.getStatements(params)
+    let completedStmts = await this.XAPIWrapper.getStatements(params)
     let status //placeholder for user data
     if (
       completedStmts &&
       completedStmts.statements &&
       completedStmts.statements.length
     ) {
-      let length = completedStmts.statements.length
-      let lastRecord = completedStmts.statements[length - 1] // get last recorded statement
+      let lastRecord = completedStmts.statements.toReversed()[0] // get last recorded statement
 
       // Verify that result exist
       if (lastRecord.result) status = lastRecord.result
@@ -195,32 +237,32 @@ export default class ADL {
    * @Params {String} activityId: the IRI string of the activity
    */
 
-  _getLessonPosition(email, activityId) {
+  async _getLessonPosition(email, activityId) {
     let params
     let savedPoint = []
     if (this.XAPIWrapper) params = this.XAPIWrapper.searchParams()
 
-    params['verb'] = this.verbs.progressed.id // completed state
+    params['verb'] = this.verbs.terminated.id // completed state
     params['activity'] = activityId // this current activity define by this id
     params['agent'] = `{"mbox": "mailto:${email}"}` // the user identify by this email
     params['ascending'] = true //ordered by the oldest statement recorded
-    params['limit'] = 500 //limit of record to return by the LRS
+    params['limit'] = 200 //limit of record to return by the LRS
 
     let date = new Date()
     let dd = new Date(date.setDate(date.getDate() + 1)).toISOString() //Date is set to next day(tomorrow) for Lrs to take in account statement registered today.
 
     params['until'] = dd
 
-    let progressedStmts = this.XAPIWrapper.getStatements(params)
+    let progressedStmts = await this.XAPIWrapper.getStatements(params)
 
     if (
       progressedStmts &&
       progressedStmts.statements &&
       progressedStmts.statements.length
     ) {
-      let length = progressedStmts.statements.length
-      let lastRecord = progressedStmts.statements[length - 1] // get last recorded statement
+      let lastRecord = progressedStmts.statements.toReversed()[0] // get last recorded statement
       // Verify that the extensions value of the statement has elements
+
       if (
         lastRecord.object.definition.extensions &&
         Object.keys(lastRecord.object.definition.extensions).length
@@ -228,6 +270,7 @@ export default class ADL {
         const allExtensionsKeys = Object.keys(
           lastRecord.object.definition.extensions
         )
+
         //Search for the user-data entry in the extensions
         savedPoint = allExtensionsKeys.map((extension) => {
           if (extension.includes('ending-point'))
@@ -235,7 +278,8 @@ export default class ADL {
         })
       }
     }
-    return savedPoint
+
+    return savedPoint && savedPoint.length > 0 ? savedPoint[0] : ''
   }
 
   /* @description: Helper to get the Preferred Settings of the user
@@ -244,7 +288,7 @@ export default class ADL {
    * @Params {String} activityId: the IRI string of the activity
    */
 
-  _getPreferredSettings(email, activityId) {
+  async _getPreferredSettings(email, activityId) {
     let params
     let preferredSettings = []
     if (this.XAPIWrapper) params = this.XAPIWrapper.searchParams()
@@ -253,22 +297,21 @@ export default class ADL {
     params['activity'] = activityId // this current activity define by this id
     params['agent'] = `{"mbox": "mailto:${email}"}` // the user identify by this email
     params['ascending'] = true //ordered by the oldest statement recorded
-    params['limit'] = 500 //limit of record to return by the LRS
+    params['limit'] = 200 //limit of record to return by the LRS
 
     let date = new Date()
     let dd = new Date(date.setDate(date.getDate() + 1)).toISOString() //Date is set to next day(tomorrow) for Lrs to take in account statement registered today.
 
     params['until'] = dd
 
-    let preferredStmts = this.XAPIWrapper.getStatements(params)
+    let preferredStmts = await this.XAPIWrapper.getStatements(params)
 
     if (
       preferredStmts &&
       preferredStmts.statements &&
       preferredStmts.statements.length
     ) {
-      let length = preferredStmts.statements.length
-      let lastRecord = preferredStmts.statements[length - 1] // get last recorded statement
+      let lastRecord = preferredStmts.statements.toReversed()[0] // get last recorded statement
 
       // Verify that the extensions value of the statement has elements
       if (
@@ -278,6 +321,7 @@ export default class ADL {
         const allExtensionsKeys = Object.keys(
           lastRecord.object.definition.extensions
         )
+
         //Search for the user-data entry in the extensions
         preferredSettings = allExtensionsKeys.map((extension) => {
           if (extension.includes('application-settings'))
@@ -285,7 +329,7 @@ export default class ADL {
         })
       }
     }
-    return preferredSettings
+    return preferredSettings[0] ? preferredSettings[0] : {}
   }
 
   /* @description: Helper to get the Playbar values of the user
@@ -293,7 +337,7 @@ export default class ADL {
    * @Params {String} activityId: the IRI string of the activity
    */
 
-  _getPlaybarValues(email, activityId) {
+  async _getPlaybarValues(email, activityId) {
     let params
     let playbarValues = []
     if (this.XAPIWrapper) params = this.XAPIWrapper.searchParams()
@@ -302,23 +346,21 @@ export default class ADL {
     params['activity'] = activityId // this current activity define by this id
     params['agent'] = `{"mbox": "mailto:${email}"}` // the user identify by this email
     params['ascending'] = true //ordered by the oldest statement recorded
-    params['limit'] = 500 //limit of record to return by the LRS
+    params['limit'] = 200 //limit of record to return by the LRS
 
     let date = new Date()
     let dd = new Date(date.setDate(date.getDate() + 1)).toISOString() //Date is set to next day(tomorrow) for Lrs to take in account statement registered today.
 
     params['until'] = dd
 
-    let playedStmts = this.XAPIWrapper.getStatements(params)
+    let playedStmts = await this.XAPIWrapper.getStatements(params)
 
     if (
       playedStmts &&
       playedStmts.statements &&
       playedStmts.statements.length
     ) {
-      let length = playedStmts.statements.length
-      let lastRecord = playedStmts.statements[length - 1] // get last recorded statement
-
+      let lastRecord = playedStmts.statements.toReversed()[0] // get last recorded statement
       // Verify that the extensions value of the statement has elements
       if (
         lastRecord.object.definition.extensions &&
@@ -334,6 +376,145 @@ export default class ADL {
         })
       }
     }
-    return playbarValues
+    return playbarValues[0] ? playbarValues[0] : {}
+  }
+  /**
+   * Method to get a multiple concurent requests using promiseAll to the server
+   * and return all data at once.
+   * the following request are made to the server:
+   * get application-settings: saved value for the user preferred settings
+   * get user-data: saved values for user progression
+   * get playbar-value : saved value for the medias play-bar
+   * get lesson-status : saved value for the lession status
+   *
+   * @param {Array} searchParams - Array of Object with key value representing each search paremeter.
+   * a parameter object definition is expected to have the following signature:
+   *     {
+   *        email{String} agent email,
+   *        verb {String} verb for the request,
+   *        activityId {String} - activity id ,
+   *      }
+   * @example here is an exemple of the search param:
+   *  {email: 'wizardy0@mymailbox.com', verb: 'completed',activityId:'"http://localhost:5173/vuetify_p4/v3"' }
+   * @return {object} data with a collection of all the reponses
+   *            from the promiseAll  and the status of last request
+   */
+  async _getBulkData(searchParams) {
+    const validVerbs = [
+      'progressed',
+      'completed',
+      'suspended',
+      'terminated',
+      'preferred',
+      'played',
+      'exited'
+    ]
+
+    const paramList = []
+    // account statement registered today.
+    let date = new Date()
+    let dd = new Date(date.setDate(date.getDate() + 1)).toISOString() //Date is set to next day(tomorrow) for Lrs to take in
+
+    for (let param of searchParams) {
+      let { email, verb, activityId } = param
+      let vb = verb && validVerbs.includes(verb) ? verb : 'terminated'
+      const params = {}
+
+      params['verb'] = this.verbs[vb].id // completed state
+      params['activity'] = activityId // this current activity define by this id
+      params['agent'] = `{"mbox": "mailto:${email}"}` // the user identify by this email
+      params['ascending'] = true //ordered by the oldest statement recorded
+      params['limit'] = 250 //limit of record to return by the LRS
+
+      params['until'] = dd
+      paramList.push(params)
+    }
+    const { response } = await this.XAPIWrapper.getStatements(paramList)
+
+    let userData = {},
+      playbarValues = {},
+      preferredSettings = {},
+      lessonStatus = {},
+      savedPoint = ''
+
+    if (response && response.length > 0) {
+      for (const res of response) {
+        const { statements } = await res.json()
+        if (!statements || statements.length == 0) continue
+
+        let lastRecord = statements.toReversed()[0] // get last recorded statement
+        // Verify that the extensions value of the statement has elements
+
+        //Handeling Lession comppletion status
+        if (lastRecord.verb.id.includes('completed')) {
+          lessonStatus = lastRecord.result ? lastRecord.result : {}
+        }
+
+        if (
+          lastRecord.object.definition.extensions &&
+          Object.keys(lastRecord.object.definition.extensions).length
+        ) {
+          const allExtensionsKeys = Object.keys(
+            lastRecord.object.definition.extensions
+          )
+
+          //Search for the user-data entry in the extensions
+          allExtensionsKeys.forEach((extension) => {
+            switch (true) {
+              case extension.includes('user-data'): {
+                //Search for the user-data entry in the extensions
+                const userDataExtension = allExtensionsKeys.filter(
+                  (extension) => extension.includes('user-data')
+                )
+                userData =
+                  lastRecord.object.definition.extensions[userDataExtension[0]]
+
+                break
+              }
+              case extension.includes('ending-point'): {
+                const userDataExtension = allExtensionsKeys.filter(
+                  (extension) => extension.includes('ending-point')
+                )
+                savedPoint =
+                  lastRecord.object.definition.extensions[userDataExtension[0]]
+
+                break
+              }
+              case extension.includes('application-settings'): {
+                const userDataExtension = allExtensionsKeys.filter(
+                  (extension) => extension.includes('application-settings')
+                )
+
+                const settingsData =
+                  lastRecord.object.definition.extensions[userDataExtension[0]]
+
+                preferredSettings = settingsData ? settingsData : {}
+
+                break
+              }
+              case extension.includes('playbar-values'): {
+                const userDataExtension = allExtensionsKeys.filter(
+                  (extension) => extension.includes('playbar-values')
+                )
+
+                const playbarData =
+                  lastRecord.object.definition.extensions[userDataExtension[0]]
+                playbarValues = playbarData ? playbarData : {}
+
+                break
+              }
+            }
+          })
+        }
+      }
+    }
+
+    return {
+      userData,
+      savedPoint,
+      preferredSettings,
+      playbarValues,
+      lessonStatus
+    }
   }
 }

package/src/module/xapi/Crypto/Hasher.js

@@ -21,7 +21,7 @@ export const Hasher = BufferedBlockAlgorithm.extend({
    *
    *     var hasher = CryptoJS.algo.SHA256.create();
    */
-  init: function(cfg) {
+  init: function (cfg) {
     // Apply config defaults
     this.cfg = this.cfg.extend(cfg)
 
@@ -36,7 +36,7 @@ export const Hasher = BufferedBlockAlgorithm.extend({
    *
    *     hasher.reset();
    */
-  reset: function() {
+  reset: function () {
     // Reset data buffer
     BufferedBlockAlgorithm.reset.call(this)
 
@@ -56,7 +56,7 @@ export const Hasher = BufferedBlockAlgorithm.extend({
    *     hasher.update('message');
    *     hasher.update(wordArray);
    */
-  update: function(messageUpdate) {
+  update: function (messageUpdate) {
     // Append
     this._append(messageUpdate)
 
@@ -81,7 +81,7 @@ export const Hasher = BufferedBlockAlgorithm.extend({
    *     var hash = hasher.finalize('message');
    *     var hash = hasher.finalize(wordArray);
    */
-  finalize: function(messageUpdate) {
+  finalize: function (messageUpdate) {
     // Final message update
     if (messageUpdate) {
       this._append(messageUpdate)
@@ -108,8 +108,8 @@ export const Hasher = BufferedBlockAlgorithm.extend({
    *
    *     var SHA256 = CryptoJS.lib.Hasher._createHelper(CryptoJS.algo.SHA256);
    */
-  _createHelper: function(hasher) {
-    return function(message, cfg) {
+  _createHelper: function (hasher) {
+    return function (message, cfg) {
       return new hasher.init(cfg).finalize(message)
     }
   },
@@ -127,8 +127,8 @@ export const Hasher = BufferedBlockAlgorithm.extend({
    *
    *     var HmacSHA256 = CryptoJS.lib.Hasher._createHmacHelper(CryptoJS.algo.SHA256);
    */
-  _createHmacHelper: function(hasher) {
-    return function(message, key) {
+  _createHmacHelper: function (hasher) {
+    return function (message, key) {
       return new C_algo().HMAC.init(hasher, key).finalize(message)
     }
   }

package/src/module/xapi/Crypto/WordArray.js

@@ -19,7 +19,7 @@ export const WordArray = Base.extend({
    *     let wordArray = CryptoJS.lib.WordArray.create([0x00010203, 0x04050607]);
    *     let wordArray = CryptoJS.lib.WordArray.create([0x00010203, 0x04050607], 6);
    */
-  init: function(words, sigBytes) {
+  init: function (words, sigBytes) {
     words = this.words = words || []
 
     if (sigBytes != undefined) {
@@ -42,7 +42,7 @@ export const WordArray = Base.extend({
    *     let string = wordArray.toString();
    *     let string = wordArray.toString(CryptoJS.enc.Utf8);
    */
-  toString: function(encoder) {
+  toString: function (encoder) {
     return (encoder || Hex).stringify(this)
   },
 
@@ -57,7 +57,7 @@ export const WordArray = Base.extend({
    *
    *     wordArray1.concat(wordArray2);
    */
-  concat: function(wordArray) {
+  concat: function (wordArray) {
     // Shortcuts
     let thisWords = this.words
     let thatWords = wordArray.words
@@ -97,7 +97,7 @@ export const WordArray = Base.extend({
    *
    *     wordArray.clamp();
    */
-  clamp: function() {
+  clamp: function () {
     // Shortcuts
     let words = this.words
     let sigBytes = this.sigBytes
@@ -116,7 +116,7 @@ export const WordArray = Base.extend({
    *
    *     let clone = wordArray.clone();
    */
-  clone: function() {
+  clone: function () {
     let clone = Base.clone.call(this)
     clone.words = this.words.slice(0)
 
@@ -136,7 +136,7 @@ export const WordArray = Base.extend({
    *
    *     let wordArray = CryptoJS.lib.WordArray.random(16);
    */
-  random: function(nBytes) {
+  random: function (nBytes) {
     let words = []
     for (let i = 0; i < nBytes; i += 4) {
       words.push((Math.random() * 0x100000000) | 0)

package/src/module/xapi/Crypto/algorithms/BufferedBlockAlgorithm.js

@@ -12,7 +12,7 @@ export const BufferedBlockAlgorithm = Base.extend({
    * @example
    *     bufferedBlockAlgorithm.reset();
    */
-  reset: function() {
+  reset: function () {
     // Initial values
     this._data = new WordArray.init()
     this._nDataBytes = 0
@@ -25,7 +25,7 @@ export const BufferedBlockAlgorithm = Base.extend({
    *     bufferedBlockAlgorithm._append('data');
    *     bufferedBlockAlgorithm._append(wordArray);
    */
-  _append: function(data) {
+  _append: function (data) {
     // Convert string to WordArray, else assume WordArray already
     if (typeof data == 'string') {
       data = Utf8.parse(data)
@@ -46,7 +46,7 @@ export const BufferedBlockAlgorithm = Base.extend({
    *     var processedData = bufferedBlockAlgorithm._process();
    *     var processedData = bufferedBlockAlgorithm._process(!!'flush');
    */
-  _process: function(doFlush) {
+  _process: function (doFlush) {
     // Shortcuts
     var data = this._data
     var dataWords = data.words
@@ -93,7 +93,7 @@ export const BufferedBlockAlgorithm = Base.extend({
    * @example
    *     var clone = bufferedBlockAlgorithm.clone();
    */
-  clone: function() {
+  clone: function () {
     var clone = Base.clone.call(this)
     clone._data = this._data.clone()
     return clone