@windward/integrations 0.17.0 → 0.19.0

package/plugin.js

@@ -1,13 +1,22 @@
+import _ from 'lodash'
 import locales from './i18n'
 
 import AdminVendorsPage from './pages/admin/vendors.vue'
 import AdminImportCoursePage from './pages/admin/importCourse.vue'
 import ExternalIntegrationIndexPage from './pages/course/externalIntegration/index.vue'
 import LoginLtiErrorPage from './pages/login/lti/error.vue'
+import LoginScormErrorPage from './pages/login/scorm/error.vue'
+import LoginScormPromptEmailPage from './pages/login/scorm/promptEmail.vue'
+
 import IntegrationHelper from './helpers/IntegrationHelper'
+import ExternalIntegrationScormHelper from './helpers/ExternalIntegration/ScormHelper'
 
 import LtiConsumerBlock from './components/Content/Blocks/ExternalIntegration/LtiConsumer'
 import LtiConsumerBlockSettings from './components/Settings/ExternalIntegration/LtiConsumerSettings'
+
+import ScormConsumerBlock from './components/Content/Blocks/ExternalIntegration/ScormConsumer'
+import ScormConsumerBlockSettings from './components/Settings/ExternalIntegration/ScormConsumerSettings'
+
 import ManageCourseIntegrationSettings from './components/Settings/ExternalIntegration/ManageCourseIntegrationSettings'
 
 import FileImportMenu from './components/FileImport/FileImportMenu.vue'
@@ -21,18 +30,81 @@ import ChatWindow from './components/Integration/AiAgentIntegration/ChatWindow.v
 import AssessmentQuestionGenerateButton from './components/LLM/GenerateContent/AssessmentQuestionGenerateButton.vue'
 import BlockQuestionGenerateButton from './components/LLM/GenerateContent/BlockQuestionGenerateButton.vue'
 
+import LoginSamlButton from './components/Integration/Driver/LoginSamlButton.vue'
+
 export default {
     name: 'windward.integrations.name',
     version: null,
     hooks: {
-        beforeContent: (body) => {
-            return body
+        'update:enrollment': (app, enrollment = {}) => {
+            // If this tracking is for a SCORM enrollment then tell the service to emit the progess back to the host LMS
+            if (
+                enrollment &&
+                _.get(enrollment, 'metadata.integration.type', '') ===
+                    'scorm' &&
+                _.get(enrollment, 'course_progress.id', null) !== null
+            ) {
+                try {
+                    app.$ExternalIntegrationScorm.trackEnrollment(enrollment)
+                } catch (e) {
+                    console.error('Cannot track updated SCORM progress', e)
+                }
+            } else if (
+                enrollment &&
+                _.get(enrollment, 'metadata.integration.type', '') ===
+                    'scorm' &&
+                _.get(enrollment, 'course_progress.id', null) === null
+            ) {
+                console.error(
+                    'Could not push initial data to host LMS. The enrollment is missing progress.'
+                )
+            }
+        },
+        'load:enrollment': (app, enrollment = {}) => {
+            // If this tracking is for a SCORM enrollment then tell the service to emit the progess back to the host LMS
+            if (
+                enrollment &&
+                _.get(enrollment, 'metadata.integration.type', '') ===
+                    'scorm' &&
+                _.get(enrollment, 'course_progress.id', null) !== null
+            ) {
+                try {
+                    app.$ExternalIntegrationScorm.trackEnrollment(enrollment)
+                } catch (e) {
+                    console.error('Cannot track SCORM progress', e)
+                }
+            } else if (
+                enrollment &&
+                _.get(enrollment, 'metadata.integration.type', '') ===
+                    'scorm' &&
+                _.get(enrollment, 'course_progress.id', null) === null
+            ) {
+                console.error(
+                    'Could not push initial data to host LMS. The enrollment is missing progress.'
+                )
+            }
+        },
+        'update:tracking': (app, courseUserTracking = {}) => {
+            const enrollment = _.get(
+                app,
+                "store.getters['enrollment/get']",
+                null
+            )
+
+            // If this tracking is for a SCORM enrollment then tell the service to emit the progess back to the host LMS
+            if (
+                enrollment &&
+                _.get(enrollment, 'metadata.integration.type', '') === 'scorm'
+            ) {
+                try {
+                    app.$ExternalIntegrationScorm.trackProgress(
+                        courseUserTracking
+                    )
+                } catch (e) {
+                    console.error('Cannot track SCORM progress', e)
+                }
+            }
         },
-        beforeDestroy: () => {},
-        beforeNavigate: () => {},
-        onNavigate: () => {},
-        onLoad: (_page) => {},
-        onContent: () => {},
     },
     i18n: locales.messages,
     pages: [
@@ -64,8 +136,37 @@ export default {
             name: 'PluginIntegrationsLoginLtiErrorPage',
             template: LoginLtiErrorPage,
         },
+        {
+            page: 'scorm-error',
+            path: '/login/scorm/error',
+            i18n: 'windward.integrations.pages.login.scorm.scorm_error',
+            name: 'PluginIntegrationsLoginScormErrorPage',
+            template: LoginScormErrorPage,
+        },
+        {
+            page: 'scorm-prompt-email',
+            path: '/login/scorm/prompt-email',
+            i18n: 'windward.integrations.pages.login.scorm.scorm_prompt_email',
+            name: 'PluginIntegrationsLoginScormPromptEmailPage',
+            template: LoginScormPromptEmailPage,
+        },
     ],
     components: {
+        userLogin: [
+            {
+                tag: 'windward-integrations-login-saml',
+                template: LoginSamlButton,
+            },
+            // Future SSO methods can be added here:
+            // {
+            //     tag: 'windward-integrations-login-oauth2',
+            //     template: LoginOAuth2Button,
+            // },
+            // {
+            //     tag: 'windward-integrations-login-google',
+            //     template: LoginGoogleButton,
+            // },
+        ],
         menu: [
             {
                 ref_page: 'admin',
@@ -178,6 +279,16 @@ export default {
                         'windward.integrations.shared.content_blocks.grouping.integrations',
                 },
             },
+            /*{
+                tag: 'windward-integrations-scorm-consumer',
+                template: ScormConsumerBlock,
+                metadata: {
+                    icon: 'mdi-shield-link-variant-outline',
+                    name: 'windward.integrations.shared.content_blocks.title.scorm_consumer',
+                    grouping:
+                        'windward.integrations.shared.content_blocks.grouping.integrations',
+                },
+            },*/
         ],
         contentBlockSetting: [
             {
@@ -189,6 +300,15 @@ export default {
                     name: 'windward.integrations.shared.settings.title.lti_consumer',
                 },
             },
+            {
+                tag: 'windward-integrations-scorm-consumer-settings',
+                template: ScormConsumerBlockSettings,
+                context: ['block.windward-integrations-scorm-consumer'],
+                metadata: {
+                    icon: 'mdi-cog',
+                    name: 'windward.integrations.shared.settings.title.scorm_consumer',
+                },
+            },
         ],
         courseSetting: [
             {
@@ -251,5 +371,6 @@ export default {
     },
     services: {
         Integration: IntegrationHelper,
+        ExternalIntegrationScorm: ExternalIntegrationScormHelper,
     },
 }

package/test/Components/ExternalIntegration/ManageScorm.spec.js

@@ -0,0 +1,19 @@
+import { shallowMount } from '@vue/test-utils'
+
+import Vue from 'vue'
+import Vuetify from 'vuetify'
+import { defaultMocks } from '@/test/mocks'
+
+import ManageScorm from '@/components/ExternalIntegration/Driver/ManageScorm.vue'
+
+Vue.use(Vuetify)
+
+describe('ManageScorm', () => {
+    test('ManageScorm is a Vue instance', () => {
+        const wrapper = shallowMount(ManageScorm, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+        })
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/Components/ExternalIntegration/Scorm/ManageConsumer.spec.js

@@ -0,0 +1,19 @@
+import { shallowMount } from '@vue/test-utils'
+
+import Vue from 'vue'
+import Vuetify from 'vuetify'
+import { defaultMocks } from '@/test/mocks'
+
+import ManageConsumer from '@/components/ExternalIntegration/Driver/Lti1p1/ManageConsumer.vue'
+
+Vue.use(Vuetify)
+
+describe('ManageConsumer', () => {
+    test('ManageConsumer is a Vue instance', () => {
+        const wrapper = shallowMount(ManageConsumer, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+        })
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/Components/ExternalIntegration/Scorm/ManageConsumers.spec.js

@@ -0,0 +1,19 @@
+import { shallowMount } from '@vue/test-utils'
+
+import Vue from 'vue'
+import Vuetify from 'vuetify'
+import { defaultMocks } from '@/test/mocks'
+
+import ManageConsumers from '@/components/ExternalIntegration/Driver/Scorm/ManageConsumers.vue'
+
+Vue.use(Vuetify)
+
+describe('ManageConsumers', () => {
+    test('ManageConsumers is a Vue instance', () => {
+        const wrapper = shallowMount(ManageConsumers, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+        })
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/Components/ExternalIntegration/Scorm/ManageProvider.spec.js

@@ -0,0 +1,19 @@
+import { shallowMount } from '@vue/test-utils'
+
+import Vue from 'vue'
+import Vuetify from 'vuetify'
+import { defaultMocks } from '@/test/mocks'
+
+import ManageProvider from '@/components/ExternalIntegration/Driver/Scorm/ManageProvider.vue'
+
+Vue.use(Vuetify)
+
+describe('ManageProvider', () => {
+    test('ManageProvider is a Vue instance', () => {
+        const wrapper = shallowMount(ManageProvider, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+        })
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/Components/ExternalIntegration/Scorm/ManageProviders.spec.js

@@ -0,0 +1,19 @@
+import { shallowMount } from '@vue/test-utils'
+
+import Vue from 'vue'
+import Vuetify from 'vuetify'
+import { defaultMocks } from '@/test/mocks'
+
+import ManageProviders from '@/components/ExternalIntegration/Driver/Scorm/ManageProviders.vue'
+
+Vue.use(Vuetify)
+
+describe('ManageProviders', () => {
+    test('ManageProviders is a Vue instance', () => {
+        const wrapper = shallowMount(ManageProviders, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+        })
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/__mocks__/componentsMock.js

@@ -1 +1,81 @@
-// Mock components from other repos
+import Vue from 'vue'
+
+Vue.component('SearchField', {
+    name: 'SearchField',
+    template: '<div>SearchField</div>',
+})
+
+Vue.component('v-expansion-panels', {
+    name: 'v-expansion-panels',
+    template: '<div>v-expansion-panels</div>',
+})
+
+Vue.component('v-expansion-panel', {
+    name: 'v-expansion-panel',
+    template: '<div>v-expansion-panel</div>',
+})
+
+Vue.component('v-expansion-panel-header', {
+    name: 'v-expansion-panel-header',
+    template: '<div>v-expansion-panel-header</div>',
+})
+
+Vue.component('v-expansion-panel-content', {
+    name: 'v-expansion-panel-content',
+    template: '<div>v-expansion-panel-content</div>',
+})
+
+Vue.component('v-tabs', {
+    name: 'v-tabs',
+    template: '<div>v-tabs</div>',
+})
+
+Vue.component('v-tabs-slider', {
+    name: 'v-tabs-slider',
+    template: '<div>v-tabs-slider</div>',
+})
+
+Vue.component('v-tab', {
+    name: 'v-tab',
+    template: '<div>v-tab</div>',
+})
+
+Vue.component('v-tabs-items', {
+    name: 'v-tabs-items',
+    template: '<div>v-tabs-items</div>',
+})
+
+Vue.component('v-tab-item', {
+    name: 'v-tab-item',
+    template: '<div>v-tab-item</div>',
+})
+
+Vue.component('v-select', {
+    name: 'v-select',
+    template: '<div>v-select</div>',
+})
+
+Vue.component('v-autocomplete', {
+    name: 'v-autocomplete',
+    template: '<div>v-autocomplete</div>',
+})
+
+Vue.component('v-switch', {
+    name: 'v-switch',
+    template: '<div>v-switch</div>',
+})
+
+Vue.component('v-divider', {
+    name: 'v-divider',
+    template: '<div>v-divider</div>',
+})
+
+Vue.component('v-progress-circular', {
+    name: 'v-progress-circular',
+    template: '<div>v-progress-circular</div>',
+})
+
+Vue.component('v-treeview', {
+    name: 'v-treeview',
+    template: '<div>v-treeview</div>',
+})

package/test/mocks.js

@@ -28,5 +28,17 @@ mocks.$Integration = {
     },
 }
 mocks.$PermissionService = { userHasAccessTo: () => true }
+mocks.$Validation = {
+    getRule() {
+        return []
+    },
+    getLimit() {
+        return 0
+    },
+    addLimit() {},
+    addRule() {},
+    addLimits() {},
+    addRules() {},
+}
 
 export const defaultMocks = mocks

package/test/setup.js

@@ -0,0 +1 @@
+// This file is intentionally left blank.