@windward/core 0.13.0 → 0.15.0

package/i18n/sv-SE/shared/permission.ts

@@ -1,15 +1,19 @@
 export default {
     type_title: {
         'plugin->windward->core->organization->course->user->feedback':
-            'Feedback access for the current user',
+            'Feedback-åtkomst för den aktuella användaren',
         'plugin->windward->core->organization->course->user->userUpload':
-            'User upload block access for the current user',
+            'Användaruppladdning blockerar åtkomst för den aktuella användaren',
+        'plugin->windward->core->organization->course->glossary':
+            'Kursordlista',
     },
 
     type_description: {
         'plugin->windward->core->organization->course->user->feedback':
-            'The current users access to the feedback block',
+            'De nuvarande användarna har tillgång till feedbackblocket',
         'plugin->windward->core->organization->course->user->userUpload':
-            'The current users access to the user upload block',
+            'De nuvarande användarna har tillgång till användaruppladdningsblocket',
+        'plugin->windward->core->organization->course->glossary':
+            'Få tillgång till och hantera kursordlistan i den nuvarande organisationen för dina egna kurser',
     },
 }

package/jest.config.js

@@ -5,6 +5,8 @@ module.exports = {
         '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
             '<rootDir>/test/__mocks__/fileMock.js',
         '\\.(css|less)$': '<rootDir>/test/__mocks__/styleMock.js',
+        '^!raw-loader!sass-loader!(.*)$':
+            '<rootDir>/test/__mocks__/styleMock.js',
     },
     moduleFileExtensions: ['ts', 'js', 'vue', 'json'],
     transform: {
@@ -12,4 +14,5 @@ module.exports = {
         '^.+\\.js$': 'babel-jest',
         '.*\\.(vue)$': 'vue-jest',
     },
+    setupFiles: ['<rootDir>/test/setup/before.js'],
 }

package/models/BaseModel.ts

@@ -0,0 +1,16 @@
+// @ts-ignore
+import Model from '~/models/Model'
+
+export default class BaseModel extends Model {
+    constructor(...args: any) {
+        if (args.length === 0) {
+            super()
+        } else {
+            super(...args)
+
+            // Constructor level checks / overrides here
+        }
+
+        return this
+    }
+}

package/models/CourseGlossaryTerm.ts

@@ -0,0 +1,22 @@
+// @ts-ignore
+import BaseModel from './BaseModel'
+
+export default class CourseGlossaryTerm extends BaseModel {
+    public id!: string
+    // eslint-disable-next-line camelcase
+    public course_id!: string
+    public term!: string
+    public definition!: string
+    public tags!: string
+    // eslint-disable-next-line camelcase
+    public alternate_forms!: any
+    // eslint-disable-next-line camelcase
+    public related_terms!: any
+
+    private required: string[] = ['term', 'definition']
+
+    // Set the resource route of the model
+    resource() {
+        return 'course-glossary-terms'
+    }
+}

package/models/UserFileAsset.ts

@@ -1,3 +1,4 @@
+// @ts-ignore
 import Model from '~/models/Model'
 
 export default class UserFileAsset extends Model {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@windward/core",
-    "version": "0.13.0",
+    "version": "0.15.0",
     "description": "Windward UI Core Plugins",
     "main": "plugin.js",
     "scripts": {
@@ -21,7 +21,7 @@
     "license": "MIT",
     "homepage": "https://bitbucket.org/mindedge/windward-ui-plugin-core#readme",
     "dependencies": {
-        "@mindedge/vuetify-player": "^0.4.7",
+        "@mindedge/vuetify-player": "^0.4.9",
         "@tinymce/tinymce-vue": "^3.2.8",
         "accessibility-scanner": "^0.0.1",
         "eslint": "^8.11.0",
@@ -32,7 +32,8 @@
         "prettier": "^2.6.0",
         "raw-loader": "^4.0.2",
         "speechreader": "^1.1.5",
-        "tinymce": "^7.1.0"
+        "tinymce": "^7.1.0",
+        "vuedraggable": "^2.24.3"
     },
     "devDependencies": {
         "@babel/preset-env": "^7.16.11",

package/pages/glossary.vue

@@ -2,7 +2,12 @@
     <v-row justify="center" align="center">
         <v-col cols="12">
             <v-alert
-                v-if="!$ContextService.courseInSourceOrganization()"
+                v-if="
+                    $PermissionService.userHasAccessTo(
+                        'plugin.windward.core.organization.course.glossary',
+                        'writable'
+                    ) && !$ContextService.courseInSourceOrganization()
+                "
                 type="warning"
             >
                 {{ $t('shared.forms.source_organization_course_lock') }}
@@ -26,11 +31,14 @@ import { CourseGlossary } from '../utils/index'
 export default {
     name: 'Glossary',
     components: { CourseGlossary },
-    layout: 'authenticated',
+    layout: 'course',
     middleware: ['auth', 'privilege'],
     meta: {
         privilege: {
-            'windward.organization.course.contentBlock': {
+            'windward.organization.course.content': {
+                readable: true,
+            },
+            'plugin.windward.core.organization.course.glossary': {
                 readable: true,
             },
         },

package/pages/userUpload.vue

@@ -59,7 +59,7 @@ export default {
     name: 'PluginUserUploadPage',
     middleware: ['auth', 'privilege'],
     components: { CourseSectionSwitch, ManageDataTableUserFiles },
-    layout: 'authenticated',
+    layout: 'course',
     meta: {
         privilege: {
             'windward.organization.course.section.user': {

package/plugin.js

@@ -3,7 +3,6 @@ import locales from './i18n'
 // Content Blocks
 import Video from './components/Content/Blocks/Video'
 import Tab from './components/Content/Blocks/Tab'
-import Math from './components/Content/Blocks/Math'
 import MathExpressionEditor from './components/utils/MathExpressionEditor'
 import Accordion from './components/Content/Blocks/Accordion'
 import Feedback from './components/Content/Blocks/Feedback.vue'
@@ -47,29 +46,37 @@ import HorizontalRuleSettings from './components/Settings/HorizontalRuleSettings
 import UserUploadPage from './pages/userUpload.vue'
 import GlossaryToolTip from './components/utils/glossary/GlossaryToolTip.vue'
 import TextEditorSettings from './components/Settings/TextEditorSettings.vue'
-import MathSettings from './components/Settings/MathSettings.vue'
 import FillInTheBlanks from './components/utils/FillInBlank/FillInTheBlanksManager.vue'
 import FillInBlankInput from './components/utils/FillInBlank/FillInBlankInput.vue'
 
+import GlossaryStore from './store/glossary.js'
+
 export default {
     name: 'windward.core.name',
     version: null,
     hooks: {
-        beforeContent: (body) => {
-            console.log('Hello world from beforeContent hook')
-            return body
+        'clear:context': (app) => {
+            app.store.dispatch('glossary/clear')
+        },
+        'load:context': (app, context) => {
+            // If the context switched to a course then load the glossary terms
+            if (
+                context === 'course' &&
+                app.store.getters['course/get'] &&
+                app.store.getters['course/get'].id
+            ) {
+                app.store.dispatch(
+                    'glossary/load',
+                    app.store.getters['course/get']
+                )
+            }
         },
-        beforeDestroy: () => {},
-        beforeNavigate: () => {},
-        onNavigate: () => {},
-        onLoad: (page) => {},
-        onContent: () => {},
     },
     i18n: locales.messages,
     pages: [
         {
             page: 'user-uploads',
-            path: '/course/:course/user-uploads',
+            path: '/course/:course/section/:section/user-uploads',
             i18n: 'menu.user-upload',
             icon: 'mdi-cloud-upload',
             name: 'PluginUserUploadPage',
@@ -77,7 +84,7 @@ export default {
         },
         {
             page: 'glossary',
-            path: '/course/:course/glossary',
+            path: '/course/:course/section/:section/glossary',
             i18n: 'windward.core.shared.menu.course_glossary',
             icon: 'mdi-comment-text-multiple',
             name: 'CourseGlossaryPage',
@@ -119,7 +126,7 @@ export default {
                 display: ['menu'],
                 permissions: {
                     'windward.organization.course.file': {
-                        writeable: true,
+                        writable: true,
                     },
                 },
             },
@@ -169,6 +176,15 @@ export default {
                     grouping: 'components.content.blocks.group.multimedia',
                 },
             },
+            {
+                tag: 'core-user-upload',
+                template: UserUpload,
+                metadata: {
+                    icon: 'mdi-cloud-upload',
+                    name: 'windward.core.shared.content_blocks.title.user_upload',
+                    grouping: 'components.content.blocks.group.multimedia',
+                },
+            },
             {
                 tag: 'core-tab',
                 template: Tab,
@@ -214,15 +230,6 @@ export default {
                     grouping: 'components.content.blocks.group.multimedia',
                 },
             },
-            {
-                tag: 'core-user-upload',
-                template: UserUpload,
-                metadata: {
-                    icon: 'mdi-cloud-upload',
-                    name: 'windward.core.shared.content_blocks.title.user_upload',
-                    grouping: 'components.content.blocks.group.multimedia',
-                },
-            },
             {
                 tag: 'core-file-download',
                 template: FileDownload,
@@ -434,4 +441,7 @@ export default {
             },
         ],
     },
+    store: {
+        glossary: GlossaryStore,
+    },
 }

package/store/glossary.js

@@ -0,0 +1,57 @@
+import _ from 'lodash'
+import Course from '~/models/Course'
+import CourseGlossaryTerm from '../models/CourseGlossaryTerm'
+
+export default {
+    // Required so these states / methods are placed under glossary/get and not just get
+    namespaced: true,
+    state: () => ({
+        glossary: {
+            course: null,
+            terms: [],
+        },
+    }),
+
+    getters: {
+        get(state) {
+            return state.glossary
+        },
+        getCourse(state) {
+            return state.glossary.course
+        },
+        getTerms(state) {
+            return state.glossary.terms
+        },
+    },
+
+    mutations: {
+        setTerms(state, terms) {
+            state.glossary.terms = _.cloneDeep(terms)
+        },
+        setCourse(state, course) {
+            state.glossary.course = _.cloneDeep(course)
+        },
+    },
+
+    actions: {
+        clear(context) {
+            context.commit('setTerms', [])
+            context.commit('setCourse', null)
+        },
+        async load(context, course) {
+            try {
+                // Store the course that these terms are in context to
+                context.commit('setCourse', course)
+
+                const terms = await CourseGlossaryTerm.custom(
+                    new Course(course),
+                    new CourseGlossaryTerm()
+                ).get()
+
+                context.commit('setTerms', terms)
+            } catch (e) {
+                console.error('Error loading glossary terms:', e)
+            }
+        },
+    },
+}

package/test/Components/Content/Blocks/Feedback.spec.js

@@ -18,7 +18,9 @@ describe('Feedback', () => {
                         config: {
                             definition: {
                                 metadata: {
-                                    definition: { body: 'test', response: '' },
+                                    definition: [
+                                        { body: 'test', response: '' },
+                                    ],
                                 },
                             },
                         },

package/test/Components/Content/Blocks/Video.spec.js

@@ -1,7 +1,6 @@
 import { mount } from '@vue/test-utils'
-import Vuetify from 'vuetify'
 import Vue from 'vue'
-
+import Vuetify from 'vuetify'
 import { defaultMocks } from '@/test/mocks'
 
 jest.mock('@mindedge/vuetify-player', () => {
@@ -47,6 +46,7 @@ const metadata = {
                         type: 'video/mp4',
                     },
                 ],
+                tracks: [],
             },
         ],
     },

package/test/Components/Glossary/GlossaryVerification.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 GlossaryVerification from '@/components/Glossary/GlossaryVerification.vue'
+
+Vue.use(Vuetify)
+
+describe('GlossaryVerification component', () => {
+    test('is a Vue instance', () => {
+        const wrapper = shallowMount(GlossaryVerification, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+            propsData: {},
+        })
+
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/Components/utils/glossary/CourseGlossary.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 CourseGlossary from '@/components/utils/glossary/CourseGlossary.vue'
+
+Vue.use(Vuetify)
+
+describe('CourseGlossary component', () => {
+    test('is a Vue instance', () => {
+        const wrapper = shallowMount(CourseGlossary, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+            propsData: {},
+        })
+
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/Components/utils/glossary/CourseGlossaryForm.spec.js

@@ -0,0 +1,28 @@
+import { shallowMount } from '@vue/test-utils'
+import Vue from 'vue'
+import Vuetify from 'vuetify'
+import { defaultMocks } from '@/test/mocks'
+import CourseGlossaryForm from '@/components/utils/glossary/CourseGlossaryForm.vue'
+
+Vue.use(Vuetify)
+
+describe('CourseGlossaryForm component', () => {
+    test('is a Vue instance', () => {
+        const wrapper = shallowMount(CourseGlossaryForm, {
+            vuetify: new Vuetify(),
+            mocks: defaultMocks,
+            propsData: {
+                value: {
+                    term: '',
+                    definition: '',
+                    alternate_forms: [],
+                    related_terms: [],
+                },
+                glossary: [],
+                editMode: false,
+            },
+        })
+
+        expect(wrapper.vm).toBeTruthy()
+    })
+})

package/test/__mocks__/helpersMock.js

@@ -39,27 +39,3 @@ jest.mock(
     },
     { virtual: true }
 )
-
-jest.mock(
-    'lodash',
-    () => {
-        return {
-            cloneDeep: (v) => {
-                return JSON.parse(JSON.stringify(v))
-            },
-            isEmpty: () => {
-                return jest.fn()
-            },
-            isBoolean: () => {
-                return jest.fn()
-            },
-            flatten: () => {
-                return jest.fn()
-            },
-            get: () => {
-                return jest.fn()
-            },
-        }
-    },
-    { virtual: true }
-)

package/test/__mocks__/modelMock.js

@@ -55,7 +55,12 @@ const mockVirtualModels = [
 ]
 
 const mockModels = [
+    { path: '../../models/BaseModel', resource: '' },
     { path: '../../models/UserFileAsset', resource: 'user-files' },
+    {
+        path: '../../models/CourseGlossaryTerm',
+        resource: 'course-glossary-terms',
+    },
 ]
 
 // DO NOT ALTER THE BELOW CODE

package/test/helpers/GlossaryHelper.spec.js

@@ -1,5 +1,6 @@
+import { defaultMocks } from '@/test/mocks'
 import GlossaryHelper from '../../helpers/GlossaryHelper'
-import GlossaryTerm from '../../helpers/GlossaryTerm'
+import CourseGlossaryTerm from '../../models/CourseGlossaryTerm'
 
 const contentHtml =
     '<p>Voluptas est quis ut <strong>consequatur.</strong>' +
@@ -32,14 +33,16 @@ const glossary = [
     {
         term: 'veniam',
         definition: 'venom is venomus',
-        alternate_forms: null,
-        related_term: null,
+        alternate_forms: [],
+        related_terms: [],
     },
     {
         term: 'Architecto',
         definition: 'Architecto is a word that means architect of the universe',
         alternate_forms: ['Architect', 'universe'],
-        related_term: 'a,b,c,d',
+        related_terms: [
+            { id: '00000000-0000-0000-1000-000000000000', term: 'a,b,c,d' },
+        ],
     },
     {
         term: 'Voluptatem',
@@ -47,14 +50,14 @@ const glossary = [
             'Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of ' +
             'classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock,' +
             ' a Latin professor at Hampden-Sydney College in Virginia',
-        alternate_forms: null,
-        related_term: null,
+        alternate_forms: [],
+        related_terms: [],
     },
     {
         term: 'crisis change',
         definition: 'n/a',
         alternate_forms: ['crisis', 'change'],
-        related_term: null,
+        related_terms: [],
     },
     {
         term: 'valores periféricos',
@@ -62,6 +65,7 @@ const glossary = [
             'Valores que son importantes pero no esenciales para una organización.',
         tags: 'valores periféricos',
         alternate_forms: [],
+        related_terms: [],
     },
 ]
 const glossaryRender =
@@ -72,12 +76,14 @@ const glossaryRender =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term>Architecto</template>' +
     '<template v-slot:definition>Architecto is a word that means architect of the universe</template>' +
+    '<template v-slot:alternate_forms>Architect,universe</template>' +
     '<template v-slot:related_terms>a,b,c,d</template>' +
     '</plugin-core-glossary-tool-tip>'
 const glossaryRenderMultiple =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term>Architecto</template>' +
     '<template v-slot:definition>Architecto is a word that means architect of the universe</template>' +
+    '<template v-slot:alternate_forms>Architect,universe</template>' +
     '<template v-slot:related_terms>a,b,c,d</template>' +
     '</plugin-core-glossary-tool-tip>' +
     '<p>Voluptas est quis ut <strong>consequatur.</strong> ' +
@@ -87,14 +93,16 @@ const glossaryRenderMultiple =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term>Architecto</template>' +
     '<template v-slot:definition>Architecto is a word that means architect of the universe</template>' +
+    '<template v-slot:alternate_forms>Architect,universe</template>' +
     '<template v-slot:related_terms>a,b,c,d</template>' +
     '</plugin-core-glossary-tool-tip>'
 
-const term = new GlossaryTerm(glossary[1])
+const term = new CourseGlossaryTerm(glossary[1])
 const expectedToolTip =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term>Architecto</template>' +
     '<template v-slot:definition>Architecto is a word that means architect of the universe</template>' +
+    '<template v-slot:alternate_forms>Architect,universe</template>' +
     '<template v-slot:related_terms>a,b,c,d</template>' +
     '</plugin-core-glossary-tool-tip>'
 const glossaryRenderCapitalized =
@@ -105,6 +113,7 @@ const glossaryRenderCapitalized =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term>Crisis change</template>' +
     '<template v-slot:definition>n/a</template>' +
+    '<template v-slot:alternate_forms>crisis,change</template>' +
     '</plugin-core-glossary-tool-tip>'
 const glossaryRenderCapitalizedSpaceBefore =
     '<p>Voluptas est quis ut <strong>consequatur.</strong> ' +
@@ -114,6 +123,7 @@ const glossaryRenderCapitalizedSpaceBefore =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term> Crisis change</template>' +
     '<template v-slot:definition>n/a</template>' +
+    '<template v-slot:alternate_forms>crisis,change</template>' +
     '</plugin-core-glossary-tool-tip>'
 const glossaryRenderCapitalizedSpaceAfter =
     '<p>Voluptas est quis ut <strong>consequatur.</strong> ' +
@@ -123,6 +133,7 @@ const glossaryRenderCapitalizedSpaceAfter =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term>Crisis change </template>' +
     '<template v-slot:definition>n/a</template>' +
+    '<template v-slot:alternate_forms>crisis,change</template>' +
     '</plugin-core-glossary-tool-tip>'
 const glossaryRenderCapitalizedSpaceBeforeAfter =
     '<p>Voluptas est quis ut <strong>consequatur.</strong> ' +
@@ -132,6 +143,7 @@ const glossaryRenderCapitalizedSpaceBeforeAfter =
     '<plugin-core-glossary-tool-tip>' +
     '<template v-slot:term> Crisis change </template>' +
     '<template v-slot:definition>n/a</template>' +
+    '<template v-slot:alternate_forms>crisis,change</template>' +
     '</plugin-core-glossary-tool-tip>'
 describe('GlossaryHelper ', () => {
     test('detects text has glossary words', () => {
@@ -162,7 +174,7 @@ describe('GlossaryHelper ', () => {
                 accentedGlossaryTerm + contentHtml,
                 glossary
             )
-        ).toEqual([new GlossaryTerm(glossary[4])])
+        ).toEqual([new CourseGlossaryTerm(glossary[4])])
     })
     test('can retrieve un-verified glossary terms', () => {
         expect(
@@ -170,7 +182,9 @@ describe('GlossaryHelper ', () => {
                 glossaryWord2 + contentHtml + glossaryWord2,
                 glossary
             )
-        ).toEqual([new GlossaryTerm({ term: 'unverified', definition: 'n/a' })])
+        ).toEqual([
+            new CourseGlossaryTerm({ term: 'unverified', definition: 'n/a' }),
+        ])
     })
     test('does not mistake alternate forms for un-verified glossary terms', () => {
         expect(
@@ -178,7 +192,9 @@ describe('GlossaryHelper ', () => {
                 glossaryWord2 + contentHtml + glossaryWord4,
                 glossary
             )
-        ).toEqual([new GlossaryTerm({ term: 'unverified', definition: 'n/a' })])
+        ).toEqual([
+            new CourseGlossaryTerm({ term: 'unverified', definition: 'n/a' }),
+        ])
     })
 
     test('can retrieve un-verified glossary terms with space', () => {
@@ -188,8 +204,8 @@ describe('GlossaryHelper ', () => {
                 glossary
             )
         ).toEqual([
-            new GlossaryTerm({ term: 'Climate', definition: 'n/a' }),
-            new GlossaryTerm({ term: 'unverified', definition: 'n/a' }),
+            new CourseGlossaryTerm({ term: 'Climate', definition: 'n/a' }),
+            new CourseGlossaryTerm({ term: 'unverified', definition: 'n/a' }),
         ])
     })
 
@@ -199,7 +215,9 @@ describe('GlossaryHelper ', () => {
                 glossaryWord2 + contentHtml + glossaryWord,
                 glossary
             )
-        ).toEqual([new GlossaryTerm({ term: 'unverified', definition: 'n/a' })])
+        ).toEqual([
+            new CourseGlossaryTerm({ term: 'unverified', definition: 'n/a' }),
+        ])
     })
     test('can render glossary tooltip component', () => {
         expect(GlossaryHelper.makeToolTip(term, 'Architecto')).toEqual(

package/test/mocks.js

@@ -46,6 +46,17 @@ jest.mock(
                 // Just return an empty object
                 return getters
             },
+            mapActions(obj) {
+                const actions = {}
+                for (const [key, value] of Object.entries(obj)) {
+                    // Return a function  since mapActions only work in the methods section
+                    actions[key] = () => {
+                        return
+                    }
+                }
+                // Just return an empty object
+                return actions
+            },
         }
     },
     { virtual: true }