@windward/core 0.14.0 → 0.15.0

package/components/utils/glossary/CourseGlossary.vue

@@ -10,29 +10,21 @@
                     class="elevation-1"
                 >
                     <template #top>
-                        <v-toolbar flat>
+                        <v-toolbar
+                            v-if="
+                                $PermissionService.userHasAccessTo(
+                                    'plugin.windward.core.organization.course.glossary',
+                                    'writable'
+                                )
+                            "
+                            flat
+                        >
                             <DialogBox
                                 v-model="dialog"
                                 color="primary"
-                                max-width="600"
-                                :trigger="
-                                    $PermissionService.userHasAccessTo(
-                                        'windward.global.course,windward.organization.course.contentBlock',
-                                        'writable'
-                                    )
-                                "
-                                :action-save-new="
-                                    $PermissionService.userHasAccessTo(
-                                        'windward.global.course,windward.organization.course.contentBlock',
-                                        'writable'
-                                    )
-                                "
-                                :action-save="
-                                    $PermissionService.userHasAccessTo(
-                                        'windward.global.course,windward.organization.course.contentBlock',
-                                        'writable'
-                                    )
-                                "
+                                trigger
+                                action-save-new
+                                action-save
                                 :disabled="disabled"
                                 @click:save="save"
                                 @click:save-new="saveNew"
@@ -43,9 +35,9 @@
                             >
                                 <template #title>
                                     {{
-                                        $t('shared.forms.add') +
-                                        ' ' +
-                                        $t('windward.core.pages.glossary.term')
+                                        $t(
+                                            'windward.core.pages.glossary.add_term'
+                                        )
                                     }}
                                 </template>
                                 <template #trigger>
@@ -53,7 +45,7 @@
                                     {{ $t('shared.forms.add') }}
                                 </template>
                                 <template #form="{ on, attrs }">
-                                    <course-glossary-form
+                                    <CourseGlossaryForm
                                         v-model="selectedTerm"
                                         :glossary="glossaryTerms"
                                         :edit-mode="editMode"
@@ -92,16 +84,23 @@
                                     </div>
                                 </v-row>
                             </td>
-                            <td>{{ item.related_term }}</td>
+                            <td>
+                                <v-chip
+                                    v-for="related in item.related_terms"
+                                    :key="related.id"
+                                >
+                                    {{ related.term }}
+                                </v-chip>
+                            </td>
 
                             <td
                                 v-if="
                                     $PermissionService.userHasAccessTo(
-                                        'windward.global.course,windward.organization.contentBlock,windward.organization.course.contentBlock',
+                                        'plugin.windward.core.organization.course.glossary',
                                         'writable'
-                                    ) &&
+                                    ) ||
                                     $PermissionService.userHasAccessTo(
-                                        'windward.organization.current,windward.organization.section,windward.organization.course',
+                                        'plugin.windward.core.organization.course.glossary',
                                         'deletable'
                                     )
                                 "
@@ -112,16 +111,16 @@
                                     :disabled="disabled"
                                 >
                                     <v-btn
+                                        v-if="
+                                            $PermissionService.userHasAccessTo(
+                                                'plugin.windward.core.organization.course.glossary',
+                                                'deletable'
+                                            )
+                                        "
                                         color="error"
                                         class="outlined"
                                         elevation="0"
                                         outlined
-                                        :disabled="
-                                            !$PermissionService.userHasAccessTo(
-                                                'windward.global.course,windward.organization.course.contentBlock',
-                                                'writable'
-                                            )
-                                        "
                                         @click="onDelete(item)"
                                     >
                                         {{ $t('shared.forms.delete') }}
@@ -130,16 +129,16 @@
                                         }}</span>
                                     </v-btn>
                                     <v-btn
+                                        v-if="
+                                            $PermissionService.userHasAccessTo(
+                                                'plugin.windward.core.organization.course.glossary',
+                                                'writable'
+                                            )
+                                        "
                                         color="primary"
                                         class="outlined"
                                         elevation="0"
                                         outlined
-                                        :disabled="
-                                            !$PermissionService.userHasAccessTo(
-                                                'windward.global.course,windward.organization.course.contentBlock',
-                                                'writable'
-                                            )
-                                        "
                                         @click="editTerm(item)"
                                     >
                                         {{ $t('shared.forms.edit') }}
@@ -158,13 +157,14 @@
 </template>
 
 <script>
-import { mapGetters, mapMutations } from 'vuex'
+import { mapGetters, mapMutations, mapActions } from 'vuex'
 import _ from 'lodash'
 import { encode } from 'he'
 import CourseGlossaryForm from './CourseGlossaryForm'
 import DialogBox from '~/components/Core/DialogBox.vue'
 import Crypto from '~/helpers/Crypto'
 import Course from '~/models/Course'
+import CourseGlossaryTerm from '../../../models/CourseGlossaryTerm'
 import SpeedDial from '~/components/Core/SpeedDial.vue'
 import TextViewer from '~/components/Text/TextViewer.vue'
 
@@ -180,22 +180,21 @@ export default {
         return {
             dialog: false,
             editMode: false,
-            glossaryTerms: [],
             selectedTerm: {},
             search: '',
             tableKey: Crypto.id(),
             defaultTerm: {
                 term: '',
                 definition: '',
-                alternate_forms: '',
-                related_term: '',
+                alternate_forms: [],
+                related_terms: [],
             },
         }
     },
-
     computed: {
         ...mapGetters({
             course: 'course/get',
+            glossaryTerms: 'glossary/getTerms',
         }),
         ...mapMutations({
             saveCourse: 'course/set',
@@ -223,19 +222,19 @@ export default {
                     value: 'alternate_forms',
                 },
                 {
-                    text: this.$t('windward.core.pages.glossary.related_term'),
+                    text: this.$t('windward.core.pages.glossary.related_terms'),
                     align: 'start',
                     sortable: true,
-                    value: 'related_term',
+                    value: 'related_terms',
                 },
             ]
             if (
                 this.$PermissionService.userHasAccessTo(
-                    'windward.global.course,windward.organization.contentBlock,windward.organization.course.contentBlock',
+                    'plugin.windward.core.organization.course.glossary',
                     'writable'
-                ) &&
+                ) ||
                 this.$PermissionService.userHasAccessTo(
-                    'windward.organization.current,windward.organization.section,windward.organization.course',
+                    'plugin.windward.core.organization.course.glossary',
                     'deletable'
                 )
             ) {
@@ -248,40 +247,19 @@ export default {
             return headers
         },
     },
-
-    beforeMount() {
-        if (this.course.metadata && _.isArray(this.course.metadata.glossary)) {
-            this.glossaryTerms = _.cloneDeep(this.course.metadata.glossary)
-        }
-    },
     methods: {
+        ...mapActions({
+            reloadGlossary: 'glossary/load',
+        }),
         async save() {
-            let currentGlossaryItemIndex = -1
-            this.glossaryTerms.filter((item, index) => {
-                if (item.term === this.selectedTerm.term) {
-                    currentGlossaryItemIndex = index
-                    return item
-                }
-            })
-            if (currentGlossaryItemIndex > -1) {
-                this.glossaryTerms[currentGlossaryItemIndex] = this.selectedTerm
-            } else {
-                this.glossaryTerms.push(this.selectedTerm)
-            }
-            const course = new Course(_.cloneDeep(this.course))
-            if (
-                !course.hasOwnProperty('metadata') ||
-                course.metadata === null
-            ) {
-                course.metadata = {}
-                course.metadata.glossary = {}
-            }
+            // Save the term
+            await new CourseGlossaryTerm(_.cloneDeep(this.selectedTerm))
+                .for(new Course(this.course))
+                .save()
+
+            // And update our local list
+            this.reloadGlossary(this.course)
 
-            if (course.metadata.glossary !== undefined) {
-                course.metadata.glossary = this.glossaryTerms
-            }
-            const updatedCourse = await course.save()
-            this.$store.commit('course/set', updatedCourse)
             this.$toast.success(this.$t('shared.forms.saved'))
             // force update on datatable
             this.tableKey = Crypto.id()
@@ -327,16 +305,13 @@ export default {
             })
         },
         async deleteTerm(item) {
-            const deleteIndex = this.glossaryTerms.indexOf(item)
-            this.glossaryTerms.splice(deleteIndex, 1)
-            const course = new Course(this.course)
-            if (_.isEmpty(course.metadata)) {
-                course.metadata = {}
-                course.metadata.glossary = {}
-            }
-            course.metadata.glossary = this.glossaryTerms
-            const updatedCourse = await course.save()
-            this.$store.commit('course/set', updatedCourse)
+            // Delete the term
+            await new CourseGlossaryTerm(_.cloneDeep(item))
+                .for(new Course(this.course))
+                .delete()
+
+            // And update our local list
+            this.reloadGlossary(this.course)
             this.$toast.success(this.$t('shared.response.deleted'))
         },
         close() {

package/components/utils/glossary/CourseGlossaryForm.vue

@@ -7,7 +7,7 @@
             :label="$t('windward.core.pages.glossary.term')"
             required
             :rules="validation.termRules"
-            :disabled="editMode"
+            :disabled="editMode || disabled"
         ></v-text-field>
         <br />
         <v-textarea
@@ -16,6 +16,7 @@
             outlined
             required
             :rules="validation.definitionRules"
+            :disabled="disabled"
         ></v-textarea>
         <br />
         <v-combobox
@@ -25,12 +26,14 @@
             :label="$t('windward.core.pages.glossary.alternate_forms')"
             multiple
             solo
+            :disabled="disabled"
         >
-            <template v-slot:selection="{ attrs, item, select, selected }">
+            <template #selection="{ attrs, item, select, selected }">
                 <v-chip
                     v-bind="attrs"
                     :input-value="selected"
                     close
+                    :disabled="disabled"
                     @click:close="removeAlternateForm(item)"
                 >
                     <strong>{{ item }}</strong>
@@ -38,17 +41,22 @@
             </template>
         </v-combobox>
         <br />
-        <v-select
-            v-model="selectedTerm.related_term"
+        <v-autocomplete
+            v-model="selectedTerm.related_terms"
             :items="termList"
+            item-text="term"
+            return-object
             outlined
             clearable
-            :label="$t('windward.core.pages.glossary.related_term')"
-        ></v-select>
+            multiple
+            :disabled="disabled"
+            :label="$t('windward.core.pages.glossary.related_terms')"
+        ></v-autocomplete>
     </v-form>
 </template>
 
 <script>
+import _ from 'lodash'
 import Form from '~/components/Core/Form'
 export default {
     name: 'CourseGlossaryForm',
@@ -57,17 +65,23 @@ export default {
         value: { type: Object, required: true },
         glossary: { type: Array, required: true },
         editMode: { type: Boolean, required: false, default: false },
+        disabled: { type: Boolean, required: false, default: false },
     },
     data() {
         return {
-            selectedTerm: {},
+            selectedTerm: {
+                term: '',
+                definition: '',
+                alternate_forms: [],
+                related_terms: [],
+            },
             relatedTerm: [],
             validation: {
                 termRules: [
                     (v) => !!v || this.$t('shared.forms.errors.required'),
                     (v) =>
                         (v && v.length <= 50) ||
-                        this.$t('forms.errors.text_lt', [50]),
+                        this.$t('shared.forms.errors.text_lt', [50]),
                     (v) =>
                         (v && this.termIsUnique(v)) ||
                         this.$t('shared.forms.errors.field_unique'),
@@ -84,18 +98,33 @@ export default {
     computed: {
         termList() {
             return this.glossary.flatMap((item) => {
-                if (this.selectedTerm.term !== item.term) return item.term
+                if (this.selectedTerm.term !== item.term) return item
             })
         },
     },
     watch: {
-        value() {
-            // Refresh the question model when we open / close the dialog
-            this.selectedTerm = this.value
+        value: {
+            deep: true,
+            handler(newValue) {
+                // Refresh the question model when we open / close the dialog
+                this.selectedTerm = _.merge(
+                    this.selectedTerm,
+                    _.cloneDeep(newValue)
+                )
+            },
+        },
+        selectedTerm: {
+            deep: true,
+            handler(newValue) {
+                if (!_.isEqual(newValue, this.value)) {
+                    this.$emit('input', newValue)
+                }
+            },
         },
     },
     mounted() {
-        this.selectedTerm = this.value
+        // Merge to preserve keys in case the value is an empty object for new glossary terms
+        this.selectedTerm = _.merge(this.selectedTerm, _.cloneDeep(this.value))
     },
     methods: {
         termIsUnique(term) {

package/components/utils/glossary/GlossaryToolTip.vue

@@ -8,11 +8,7 @@
             :z-index="20"
         >
             <template #activator="{ on }">
-                <span 
-                    tabindex="0"
-                    v-on="on"
-                    @click.stop="show = !show"
-                >
+                <span tabindex="0" v-on="on" @click.stop="show = !show">
                     <slot name="term"></slot>
                 </span>
             </template>
@@ -34,7 +30,7 @@
                         </p>
                     </div>
                     <div v-if="$slots['alternate_forms']">
-                        <h4 class="text-capitalize">
+                        <h6 class="text-capitalize">
                             <slot name="term"></slot>
                             {{
                                 $t(
@@ -42,19 +38,19 @@
                                 )
                             }}
                             :
-                        </h4>
+                        </h6>
                         <p><slot name="alternate_forms"></slot></p>
                     </div>
 
                     <div v-if="$slots['related_terms']">
-                        <h4 class="text-capitalize">
+                        <h6 class="text-capitalize">
                             {{
                                 $t(
                                     'windward.core.components.utils.tiny_mce_wrapper.related_terms'
                                 )
                             }}
                             :
-                        </h4>
+                        </h6>
                         <p><slot name="related_terms"></slot></p>
                     </div>
                 </v-card-text>
@@ -68,12 +64,12 @@ export default {
     name: 'GlossaryToolTip',
     data() {
         return {
-            show: false
+            show: false,
         }
     },
     beforeDestroy() {
         this.show = false
-    }
+    },
 }
 </script>
 

package/helpers/GlossaryHelper.ts

@@ -1,28 +1,30 @@
 import * as _ from 'lodash'
 import { decode } from 'he'
-import GlossaryTerm from '../helpers/GlossaryTerm'
+import CourseGlossaryTerm from '../models/CourseGlossaryTerm'
 
 export default class GlossaryHelper {
     private static glossaryRegex =
         /<span.*?.class="glossary-word".*?>(.*?)<\/span>/g
 
-    public static makeToolTip(term: GlossaryTerm, text: String): string {
+    public static makeToolTip(term: CourseGlossaryTerm, text: String): string {
         const word = _.isString(term.term)
             ? '<template v-slot:term>' + text + '</template>'
             : ''
         const definition = _.isString(term.definition)
             ? '<template v-slot:definition>' + term.definition + '</template>'
             : ''
-        const alternate_forms = _.isString(term.alternate_forms)
-            ? '<template v-slot:alternate_forms>' +
-              term.alternate_forms +
-              '</template>'
-            : ''
-        const related_terms = _.isString(term.related_term)
-            ? '<template v-slot:related_terms>' +
-              term.related_term +
-              '</template>'
-            : ''
+        const alternate_forms =
+            _.isArray(term.alternate_forms) && term.alternate_forms.length > 0
+                ? '<template v-slot:alternate_forms>' +
+                  term.alternate_forms.join(',') +
+                  '</template>'
+                : ''
+        const related_terms =
+            _.isArray(term.related_terms) && term.related_terms.length > 0
+                ? '<template v-slot:related_terms>' +
+                  term.related_terms.map((t) => t.term).join(',') +
+                  '</template>'
+                : ''
         return (
             '<plugin-core-glossary-tool-tip>' +
             word +
@@ -47,7 +49,7 @@ export default class GlossaryHelper {
         const currentGlossary = glossary
 
         let match: any
-        const verifiedTerms: GlossaryTerm[] = []
+        const verifiedTerms: CourseGlossaryTerm[] = []
         while ((match = regex.exec(content)) !== null) {
             // This is necessary to avoid infinite loops with zero-width matches
             if (match.index === regex.lastIndex) {
@@ -78,7 +80,7 @@ export default class GlossaryHelper {
                             ))) &&
                     addTerm
                 ) {
-                    verifiedTerms.push(new GlossaryTerm(term))
+                    verifiedTerms.push(new CourseGlossaryTerm(term))
                 }
             })
         }
@@ -97,7 +99,7 @@ export default class GlossaryHelper {
             content,
             glossary
         )
-        const unVerifiedTerms: GlossaryTerm[] = []
+        const unVerifiedTerms: CourseGlossaryTerm[] = []
         while ((match = regex.exec(content)) !== null) {
             // This is necessary to avoid infinite loops with zero-width matches
             if (match.index === regex.lastIndex) {
@@ -134,7 +136,7 @@ export default class GlossaryHelper {
             })
             if (inGlossary.length === 0 && !inUnverifiedArray) {
                 unVerifiedTerms.push(
-                    new GlossaryTerm({
+                    new CourseGlossaryTerm({
                         term: _.trim(match[1]),
                         definition: 'n/a',
                     })

package/i18n/en-US/pages/glossary.ts

@@ -1,7 +1,9 @@
 export default {
     title: 'Course Glossary',
     term: 'Term',
-    related_term: 'Related Term',
+    add_term: 'Add Term',
+    edit_term: 'Edit Term',
+    related_terms: 'Related Terms',
     definition: 'definition',
     alternate_forms: 'Alternate Forms',
 }

package/i18n/en-US/shared/notification.ts

@@ -9,5 +9,10 @@ export default {
             'windward-core-ask-the-expert': 'Course Ask the Expert',
             'windward-core-contact-support': 'Course Contact Support',
         },
+
+        type_recipient_address: {
+            'windward-core-ask-the-expert': '{{courseowner->email}}',
+            'windward-core-contact-support': '',
+        },
     },
 }

package/i18n/en-US/shared/permission.ts

@@ -4,6 +4,8 @@ export default {
             'Feedback access for the current user',
         'plugin->windward->core->organization->course->user->userUpload':
             'User upload block access for the current user',
+        'plugin->windward->core->organization->course->glossary':
+            'Course Glossary',
     },
 
     type_description: {
@@ -11,5 +13,7 @@ export default {
             'The current users access to the feedback block',
         'plugin->windward->core->organization->course->user->userUpload':
             'The current users access to the user upload block',
+        'plugin->windward->core->organization->course->glossary':
+            'Access and manage the course glossary in the current organization for your own courses',
     },
 }

package/i18n/es-ES/pages/glossary.ts

@@ -1,7 +1,9 @@
 export default {
     title: 'Glosario del curso',
     term: 'Plazo',
-    related_term: 'Término relacionado',
+    add_term: 'Agregar término',
+    edit_term: 'Editar término',
+    related_terms: 'Términos relacionados',
     definition: 'definición',
     alternate_forms: 'Formas alternativas',
 }

package/i18n/es-ES/shared/notification.ts

@@ -10,5 +10,10 @@ export default {
             'windward-core-ask-the-expert': 'Curso Pregúntele al experto',
             'windward-core-contact-support': 'Soporte de contacto del curso',
         },
+        type_recipient_address: {
+            'windward-core-ask-the-expert':
+                'Correo electrónico del autor del curso',
+            'windward-core-contact-support': '',
+        },
     },
 }

package/i18n/es-ES/shared/permission.ts

@@ -1,15 +1,19 @@
 export default {
     type_title: {
         'plugin->windward->core->organization->course->user->feedback':
-            'Feedback access for the current user',
+            'Acceso a comentarios para el usuario actual',
         'plugin->windward->core->organization->course->user->userUpload':
-            'User upload block access for the current user',
+            'Acceso bloqueado a la carga de usuarios para el usuario actual',
+        'plugin->windward->core->organization->course->glossary':
+            'Glosario del curso',
     },
 
     type_description: {
         'plugin->windward->core->organization->course->user->feedback':
-            'The current users access to the feedback block',
+            'Los usuarios actuales tienen acceso al bloque de comentarios',
         'plugin->windward->core->organization->course->user->userUpload':
-            'The current users access to the user upload block',
+            'Los usuarios actuales tienen acceso al bloque de subida de usuarios',
+        'plugin->windward->core->organization->course->glossary':
+            'Accede y gestiona el glosario del curso en la organización actual para tus propios cursos',
     },
 }

package/i18n/sv-SE/pages/glossary.ts

@@ -1,7 +1,9 @@
 export default {
     title: 'Kursordlista',
     term: 'Term',
-    related_term: 'Relaterad term',
+    add_term: 'Lägg till term',
+    edit_term: 'Redigera term',
+    related_terms: 'Relaterade villkor',
     definition: 'definition',
     alternate_forms: 'Alternativa formulär',
 }

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

@@ -9,5 +9,9 @@ export default {
             'windward-core-ask-the-expert': 'Kurs Fråga experten',
             'windward-core-contact-support': 'Course Contact Support',
         },
+        type_recipient_address: {
+            'windward-core-ask-the-expert': 'Kursägarens e-post',
+            'windward-core-contact-support': '',
+        },
     },
 }