fcad-core-dragon 2.1.0-beta.2 → 2.1.0-beta.3

package/src/components/AppCompSettingsMenu.vue

@@ -1,172 +1,172 @@
-<template>
-  <b-sidebar
-    id="sidebar-settings"
-    title="Settings"
-    right
-    shadow
-    backdrop
-    no-header
-    @hidden="onClose"
-  >
-    <div class="pl-3 pr-3">
-      <b-form-group :label="$t('user_settings.title')">
-        <b-form-checkbox
-          v-for="(setting, index) in Object.entries(settingsSelected)"
-          :key="index"
-          v-model="settingsSelected[setting[0]]"
-          :aria-describedby="ariaDescribedby"
-          :name="`parameter-${setting[0]}`"
-          :text-field="$t(`user_settings.${setting[0]}`)"
-          switch
-          stacked
-          size="lg"
-          @change="onSettingsChange"
-        >
-          <span>{{ $t(`user_settings.${setting[0]}`) }}</span>
-        </b-form-checkbox>
-      </b-form-group>
-      <app-base-button
-        v-b-toggle.sidebar-settings
-        class="float-right btn-primary"
-        :title="$t('user_settings.close')"
-      >
-        {{ $t('user_settings.close') }}
-      </app-base-button>
-    </div>
-  </b-sidebar>
-</template>
-
-<script>
-import { mapState, mapActions } from 'pinia'
-import { useAppStore } from '../module/stores/appStore'
-import AppBaseButton from './AppBaseButton.vue'
-
-export default {
-  components: { AppBaseButton },
-  props: {},
-  data() {
-    return {
-      settingsSelected: {},
-      settingsNeedUpdate: false
-    }
-  },
-  computed: {
-    ...mapState(useAppStore, [
-      'getApplicationSettings',
-      'getModuleInfo',
-      'getUserInteraction',
-      'getConnectionInfo',
-      'onboardingEnabled'
-    ]),
-    settingsOptions() {
-      return this.settingsOptionsELPlus
-    }
-  },
-  watch: {
-    getApplicationSettings: {
-      immediate: true,
-      deep: true,
-      handler() {
-        this.getAppSettingsInStore()
-      }
-    }
-  },
-  created() {
-    setTimeout(() => this.getAppSettingsInStore(), 1700)
-
-    this.$bus.$on('save-settings', (settings) => {
-      this.saveSettings(settings)
-    })
-  },
-  methods: {
-    ...mapActions(useAppStore, [
-      'setApplicationSettings',
-      'updateUserMetaData'
-    ]),
-    getAppSettingsInStore() {
-      this.settingsSelected = { ...this.getApplicationSettings }
-    },
-
-    //Save user settings to the store
-    onSettingsChange() {
-      this.settingsNeedUpdate = true
-      this.saveSettingsToStore(this.settingsSelected)
-    },
-    saveSettingsToStore(settings) {
-      this.setApplicationSettings(settings)
-    },
-    /**
-     * @description Save the user preferred settings to vue store and LRS or local store:
-     * LRS: Send a XAPI Statement to the LRS
-     * IndexedDB: Set a new Key for preferred settings in the userInteraction in store
-     * Update current value of settings
-     * @param {Object} appSettings - group of application settings {autoplay, subtitles, onboarding}
-     *
-     */
-    saveSettings(appSettings) {
-      this.saveSettingsToStore(appSettings) //save to store
-
-      if (
-        this.getModuleInfo.packageType === 'xapi' &&
-        this.getConnectionInfo &&
-        this.getConnectionInfo.remote
-      ) {
-        let text
-        //Defining the text to display for stmt description and definition
-        switch (this.$i18n.locale) {
-          case 'fr':
-            if (this.getModuleInfo.courseID)
-              text = `Le ${this.getModuleInfo.id} de ${this.getModuleInfo.courseID}`
-            else text = `Le ${this.getModuleInfo.id}`
-            break
-          case 'en':
-            if (this.getModuleInfo.courseID)
-              text = `The ${this.getModuleInfo.id} of ${this.getModuleInfo.courseID}`
-            else text = `The ${this.getModuleInfo.id}`
-            break
-        }
-        //Creating custom statement
-        const stmt = {
-          id: (() => {
-            return this.getModuleInfo.courseID
-              ? this.getModuleInfo.courseID
-              : null
-          })(),
-          verb: 'preferred',
-          definition: text,
-          description: text,
-          extensions: [
-            {
-              id: 'application-settings',
-              content: {
-                userSettings: { ...appSettings }
-              }
-            }
-          ]
-        }
-
-        setTimeout(() => {
-          this.$bus.$emit('send-xapi-statement', stmt) //send xapi statement
-        }, 1000)
-      } else {
-        this.$set(this.getUserInteraction, 'userSettings', appSettings) // adding the usersettings to user Interaction to save to save to the local DB
-        this.updateUserMetaData(this.getUserInteraction) //force update of the userInteraction to ensure saving of settings in local DB
-      }
-
-      //update sidebar data
-      this.getAppSettingsInStore()
-    },
-
-    /**
-     * @description -Action to perform when the sidebar closed- will require saving when changing occurred
-     */
-    onClose() {
-      if (this.settingsNeedUpdate) {
-        this.saveSettingsToStore(this.settingsSelected)
-        this.saveSettings(this.getApplicationSettings)
-        this.settingsNeedUpdate = false
-      }
-    }
-  }
-}
-</script>
+<template>
+  <b-sidebar
+    id="sidebar-settings"
+    title="Settings"
+    right
+    shadow
+    backdrop
+    no-header
+    @hidden="onClose"
+  >
+    <div class="pl-3 pr-3">
+      <b-form-group :label="$t('user_settings.title')">
+        <b-form-checkbox
+          v-for="(setting, index) in Object.entries(settingsSelected)"
+          :key="index"
+          v-model="settingsSelected[setting[0]]"
+          :aria-describedby="ariaDescribedby"
+          :name="`parameter-${setting[0]}`"
+          :text-field="$t(`user_settings.${setting[0]}`)"
+          switch
+          stacked
+          size="lg"
+          @change="onSettingsChange"
+        >
+          <span>{{ $t(`user_settings.${setting[0]}`) }}</span>
+        </b-form-checkbox>
+      </b-form-group>
+      <app-base-button
+        v-b-toggle.sidebar-settings
+        class="float-right btn-primary"
+        :title="$t('user_settings.close')"
+      >
+        {{ $t('user_settings.close') }}
+      </app-base-button>
+    </div>
+  </b-sidebar>
+</template>
+
+<script>
+import { mapState, mapActions } from 'pinia'
+import { useAppStore } from '../module/stores/appStore'
+import AppBaseButton from './AppBaseButton.vue'
+
+export default {
+  components: { AppBaseButton },
+  props: {},
+  data() {
+    return {
+      settingsSelected: {},
+      settingsNeedUpdate: false
+    }
+  },
+  computed: {
+    ...mapState(useAppStore, [
+      'getApplicationSettings',
+      'getModuleInfo',
+      'getUserInteraction',
+      'getConnectionInfo',
+      'onboardingEnabled'
+    ]),
+    settingsOptions() {
+      return this.settingsOptionsELPlus
+    }
+  },
+  watch: {
+    getApplicationSettings: {
+      immediate: true,
+      deep: true,
+      handler() {
+        this.getAppSettingsInStore()
+      }
+    }
+  },
+  created() {
+    setTimeout(() => this.getAppSettingsInStore(), 1700)
+
+    this.$bus.$on('save-settings', (settings) => {
+      this.saveSettings(settings)
+    })
+  },
+  methods: {
+    ...mapActions(useAppStore, [
+      'setApplicationSettings',
+      'updateUserMetaData'
+    ]),
+    getAppSettingsInStore() {
+      this.settingsSelected = { ...this.getApplicationSettings }
+    },
+
+    //Save user settings to the store
+    onSettingsChange() {
+      this.settingsNeedUpdate = true
+      this.saveSettingsToStore(this.settingsSelected)
+    },
+    saveSettingsToStore(settings) {
+      this.setApplicationSettings(settings)
+    },
+    /**
+     * @description Save the user preferred settings to vue store and LRS or local store:
+     * LRS: Send a XAPI Statement to the LRS
+     * IndexedDB: Set a new Key for preferred settings in the userInteraction in store
+     * Update current value of settings
+     * @param {Object} appSettings - group of application settings {autoplay, subtitles, onboarding}
+     *
+     */
+    saveSettings(appSettings) {
+      this.saveSettingsToStore(appSettings) //save to store
+
+      if (
+        this.getModuleInfo.packageType === 'xapi' &&
+        this.getConnectionInfo &&
+        this.getConnectionInfo.remote
+      ) {
+        let text
+        //Defining the text to display for stmt description and definition
+        switch (this.$i18n.locale) {
+          case 'fr':
+            if (this.getModuleInfo.courseID)
+              text = `Le ${this.getModuleInfo.id} de ${this.getModuleInfo.courseID}`
+            else text = `Le ${this.getModuleInfo.id}`
+            break
+          case 'en':
+            if (this.getModuleInfo.courseID)
+              text = `The ${this.getModuleInfo.id} of ${this.getModuleInfo.courseID}`
+            else text = `The ${this.getModuleInfo.id}`
+            break
+        }
+        //Creating custom statement
+        const stmt = {
+          id: (() => {
+            return this.getModuleInfo.courseID
+              ? this.getModuleInfo.courseID
+              : null
+          })(),
+          verb: 'preferred',
+          definition: text,
+          description: text,
+          extensions: [
+            {
+              id: 'application-settings',
+              content: {
+                userSettings: { ...appSettings }
+              }
+            }
+          ]
+        }
+
+        setTimeout(() => {
+          this.$bus.$emit('send-xapi-statement', stmt) //send xapi statement
+        }, 1000)
+      } else {
+        this.$set(this.getUserInteraction, 'userSettings', appSettings) // adding the usersettings to user Interaction to save to save to the local DB
+        this.updateUserMetaData(this.getUserInteraction) //force update of the userInteraction to ensure saving of settings in local DB
+      }
+
+      //update sidebar data
+      this.getAppSettingsInStore()
+    },
+
+    /**
+     * @description -Action to perform when the sidebar closed- will require saving when changing occurred
+     */
+    onClose() {
+      if (this.settingsNeedUpdate) {
+        this.saveSettingsToStore(this.settingsSelected)
+        this.saveSettings(this.getApplicationSettings)
+        this.settingsNeedUpdate = false
+      }
+    }
+  }
+}
+</script>

package/src/components/AppCompTableOfContent.vue

@@ -9,7 +9,7 @@
 
 <template>
   <div v-if="error" id="sidebar-submenu" :class="{ isOpen: isOpened }">
-    <focus-trap :active="isOpened">
+    <focus-trap :active="isOpened" :prevent-scroll="true">
       <div ref="target">
         <!-- <div class="submenu-header"> -->
         <app-base-button

package/src/components/AppCompViewDisplay.vue

@@ -1,6 +1,6 @@
-<template>
-  <router-view />
-</template>
-<script>
-export default {}
-</script>
+<template>
+  <router-view />
+</template>
+<script>
+export default {}
+</script>

package/src/components/tests__/useTimer.spec.js

@@ -0,0 +1,91 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+import { Timer } from '../../composables/useTimer'
+
+// vitest vi utility ref: https://vitest.dev/api/vi.html
+// vi fakeTimers ref: https://vitest.dev/api/vi.html#vi-usefaketimers
+
+describe('Timer class', () => {
+  let timer
+
+  beforeEach(() => {
+    Timer.timers.clear() // Clear existing timers before each test
+    timer = new Timer()
+    vi.useFakeTimers() // Enable fake timers before each test
+  })
+
+  afterEach(() => {
+    timer.destroy() // destroy created timer after each test
+    vi.useRealTimers() // Restore real timers after each test
+  })
+
+  it('should create a Timer instance with a unique ID', () => {
+    const timer2 = new Timer() //create a second instance
+    expect(timer2.getTimerID()).not.toBe(timer.getTimerID())
+    expect(Timer.timers.size).toBe(2) // Two timers should be registered
+  })
+
+  it('should return a timer instance by it ID', () => {
+    const timer2 = new Timer('timer22') //create a second instance with custom ID
+    expect(timer.getTimer('timer22')).toBeInstanceOf(Timer)
+  })
+
+  it('should throw error when a timer instance doesn`t exist', () => {
+    const id = 'noExistingTimer'
+    expect(() => timer.getTimer(id)).toThrowError(
+      `Timer with ID ${id} does not exist.`
+    )
+  })
+
+  it('should initialize timer at 0 seconds', () => {
+    expect(timer.getTime()).toBe(0)
+  })
+
+  it('should start the timer and increment time every second', () => {
+    timer.start()
+    expect(timer.getTimerState()).toBe('started')
+
+    vi.advanceTimersByTime(5000) // Fast-forward 3 seconds
+    expect(timer.getTime()).toBe(5) // Should be approximately 5 seconds
+  })
+
+  it('should display time in correct format when converting to ISOformats', () => {
+    timer.start()
+    expect(timer.getTimerState()).toBe('started')
+
+    vi.advanceTimersByTime(65000) // Fast-forward 3 seconds
+
+    const fullISOFormat = '1970-01-01T00:01:05.000Z'
+    const isoTimeStr = '00:01:05'
+
+    expect(timer.getTime()).toBe(65) // Should be approximately 1 min 5 seconds (00:01:05)
+    expect(timer.formatToISOString(timer.getTime())).toBe(fullISOFormat)
+    expect(timer.ISOTimeParser(timer.getTime())).toBe(isoTimeStr)
+  })
+
+  it('should pause the timer', () => {
+    timer.start()
+    vi.advanceTimersByTime(2000)
+    timer.pause()
+    const current = timer.getTime()
+
+    // Advance time but timer should stay paused
+    vi.advanceTimersByTime(3000)
+    expect(timer.getTime()).toBe(current) // about 2 seconds
+    expect(timer.ISOTimeParser(timer.getTime())).toBe('00:00:02')
+  })
+
+  it('should reset the timer to 0 when timer stops', () => {
+    timer.start()
+    vi.advanceTimersByTime(4000)
+    timer.stop()
+    expect(timer.getTime()).toBe(0)
+    expect(timer.getTimerState()).toBe('stopped')
+  })
+
+  it('should destroy timer', () => {
+    const id = timer.getTimerID()
+    timer.destroy()
+    expect(Timer.timers.get(id)).toBeUndefined()
+    expect(Timer.timers.size).toBe(0)
+  })
+})

package/src/composables/useIdleDetector.js

@@ -0,0 +1,56 @@
+export class IdleDetector {
+  constructor() {
+    this.idleCounter = 0
+    this.idleTimeoutID = null
+    this.detectorState = 'stopped' // can be 'pause' or 'stop'
+    this.idleTimer = null
+  }
+
+  /**
+   * @description Start the idle timer -
+   * creates an interval to track idle time and a timeout to trigger actions
+   * after a specified period of inactivity.
+   * @param {Function} action - a callback function to execute when the idle timeout is reached.
+   * @param {Number} timeout - the duration in milliseconds before the action is triggered.
+   */
+  startIdleTimer(action = null, timeout = 0) {
+    this.idleTimer = setInterval(() => {
+      this.idleCounter += 1
+    }, 1000)
+    this.detectorState = 'started'
+
+    if (!action || typeof action !== 'function') return
+
+    this.idleTimeoutID = setTimeout(() => action(), timeout)
+  }
+
+  /**
+   * @description Reset the idle timer -
+   * clears the current idle timer and timeout,
+   */
+  stopIdleTimer() {
+    this.idleCounter = 0
+    clearInterval(this.idleTimer)
+    clearTimeout(this.idleTimeoutID)
+    this.detectorState = 'stopped'
+  }
+
+  /**
+   * @description Get the current state of the timer
+   *
+   * @returns {String} - timer state, can be 'started' or 'stopped'
+   */
+  getDectorState() {
+    return this.detectorState
+  }
+
+  /**
+   * @description Get the elapsed time for the idle timer.
+   *               This is the time the idle detector has been running since it was started.
+   *
+   * @returns {Number} - the time count in seconds
+   */
+  getElapsedTime() {
+    return this.idleCounter
+  }
+}

package/src/composables/useQuiz.js

@@ -1,4 +1,4 @@
-//This composable sould Extend the functionality of a the quiz
+//This composable should Extend the functionality of a the quiz
 
 import i18n from '@/i18n' //Must import directly the local from project app because vue-18in does not work in legacy mode with composable