@windward/integrations 0.17.0 → 0.19.0

package/components/ExternalIntegration/Driver/Scorm/ManageProvider.vue

@@ -0,0 +1,475 @@
+<template>
+    <div>
+        <div v-if="!render" class="integration-loading">
+            <v-progress-circular size="128" indeterminate />
+        </div>
+        <div v-if="render">
+            <v-form
+                :id="formId"
+                ref="form"
+                :key="updateKey"
+                v-model="formValid"
+                @submit="onFormSubmit"
+            >
+                <v-row justify="center" align="center">
+                    <v-col cols="12">
+                        <ProviderTargetPicker
+                            v-model="provider"
+                        ></ProviderTargetPicker>
+                        <v-text-field
+                            id="target-url"
+                            v-model="provider.target"
+                            disabled
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.target_url'
+                                )
+                            "
+                            :hint="
+                                $t(
+                                    'windward.integrations.components.external_integration.target_url'
+                                )
+                            "
+                            :rules="$Validation.getRule('exists')"
+                        ></v-text-field>
+
+                        <v-select
+                            v-model="provider.version"
+                            :disabled="!isNew"
+                            :items="versions"
+                            item-text="name"
+                            item-value="value"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.version'
+                                )
+                            "
+                            outlined
+                            :rules="$Validation.getRule('exists')"
+                        ></v-select>
+
+                        <v-switch
+                            v-model="provider.enabled"
+                            :label="$t('shared.forms.enabled')"
+                        />
+
+                        <v-switch
+                            v-model="provider.metadata.anonymize_users"
+                            :disabled="provider.metadata.email_prompt"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.anonymize_users'
+                                )
+                            "
+                        />
+
+                        <v-switch
+                            v-model="provider.metadata.email_prompt"
+                            :disabled="provider.metadata.anonymize_users"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.email_prompt'
+                                )
+                            "
+                        />
+
+                        <v-switch
+                            v-model="provider.metadata.incomplete_until_passed"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.incomplete_until_passed'
+                                )
+                            "
+                        />
+
+                        <v-switch
+                            v-model="provider.metadata.has_mastery_score"
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.has_mastery_score'
+                                )
+                            "
+                        />
+
+                        <v-text-field
+                            id="scorm-mastery-score"
+                            v-model="provider.metadata.mastery_score"
+                            type="number"
+                            :disabled="!provider.metadata.has_mastery_score"
+                            :placeholder="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.mastery_score'
+                                )
+                            "
+                            :label="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.mastery_score'
+                                )
+                            "
+                            :hint="
+                                $t(
+                                    'windward.integrations.components.external_integration.driver.scorm.mastery_score'
+                                )
+                            "
+                            :rules="[
+                                ...$Validation.getRule('wholePositiveNumber'),
+                                ...$Validation.getRule(
+                                    'lessThanOrEqualTo',
+                                    100
+                                ),
+                            ]"
+                        ></v-text-field>
+                    </v-col>
+                </v-row>
+                <v-row>
+                    <v-col cols="12">
+                        <v-expansion-panels v-model="rolePanel">
+                            <v-expansion-panel>
+                                <v-expansion-panel-header>
+                                    {{
+                                        $t(
+                                            'windward.integrations.components.external_integration.role_map_panel'
+                                        )
+                                    }}
+                                </v-expansion-panel-header>
+                                <v-expansion-panel-content>
+                                    <p>
+                                        <strong>
+                                            {{
+                                                $t(
+                                                    'windward.integrations.components.external_integration.role_map_instructions'
+                                                )
+                                            }}
+                                        </strong>
+                                    </p>
+                                    <p>
+                                        {{
+                                            $t(
+                                                'windward.integrations.components.external_integration.role_map_warning'
+                                            )
+                                        }}
+                                    </p>
+                                    <v-simple-table>
+                                        <template #default>
+                                            <thead>
+                                                <tr>
+                                                    <th>
+                                                        {{
+                                                            $t(
+                                                                'windward.integrations.components.external_integration.role_in_host'
+                                                            )
+                                                        }}
+                                                    </th>
+                                                    <th>
+                                                        {{
+                                                            $t(
+                                                                'windward.integrations.components.external_integration.role_in_local'
+                                                            )
+                                                        }}
+                                                    </th>
+                                                </tr>
+                                            </thead>
+                                            <tbody>
+                                                <tr
+                                                    v-for="(
+                                                        id, externalName
+                                                    ) in provider.role_metadata"
+                                                    :key="externalName"
+                                                >
+                                                    <td>
+                                                        {{
+                                                            uppercase(
+                                                                externalName
+                                                            )
+                                                        }}
+                                                    </td>
+                                                    <td>
+                                                        <v-select
+                                                            v-model="
+                                                                provider
+                                                                    .role_metadata[
+                                                                    externalName
+                                                                ]
+                                                            "
+                                                            :items="roles"
+                                                            item-value="id"
+                                                            item-text="name"
+                                                            :label="
+                                                                $t(
+                                                                    'windward.integrations.components.external_integration.map_to_role'
+                                                                )
+                                                            "
+                                                        ></v-select>
+                                                    </td>
+                                                    <td>
+                                                        <v-btn
+                                                            icon
+                                                            elevation="0"
+                                                            @click="
+                                                                deleteMapItem(
+                                                                    externalName
+                                                                )
+                                                            "
+                                                        >
+                                                            <v-icon>
+                                                                mdi-delete
+                                                            </v-icon>
+                                                            <span
+                                                                class="sr-only"
+                                                            >
+                                                                {{
+                                                                    $t(
+                                                                        'windward.integrations.components.external_integration.delete_role_map_item'
+                                                                    )
+                                                                }}
+                                                            </span>
+                                                        </v-btn>
+                                                    </td>
+                                                </tr>
+                                                <tr>
+                                                    <td>
+                                                        <v-text-field
+                                                            v-model="
+                                                                newMap.name
+                                                            "
+                                                            :label="
+                                                                $t(
+                                                                    'windward.integrations.components.external_integration.remote_role'
+                                                                )
+                                                            "
+                                                        ></v-text-field>
+                                                    </td>
+                                                    <td>
+                                                        <v-select
+                                                            v-model="newMap.id"
+                                                            :items="roles"
+                                                            :label="
+                                                                $t(
+                                                                    'windward.integrations.components.external_integration.map_to_role'
+                                                                )
+                                                            "
+                                                            item-value="id"
+                                                            item-text="name"
+                                                        ></v-select>
+                                                    </td>
+                                                    <td>
+                                                        <v-btn
+                                                            icon
+                                                            elevation="0"
+                                                            :disabled="
+                                                                !newMap.id ||
+                                                                !newMap.name
+                                                            "
+                                                            @click="addMapItem"
+                                                        >
+                                                            <v-icon>
+                                                                mdi-plus
+                                                            </v-icon>
+                                                            <span
+                                                                class="sr-only"
+                                                            >
+                                                                {{
+                                                                    $t(
+                                                                        'windward.integrations.components.external_integration.add_role_map_item'
+                                                                    )
+                                                                }}
+                                                            </span>
+                                                        </v-btn>
+                                                    </td>
+                                                </tr>
+                                            </tbody>
+                                        </template>
+                                    </v-simple-table>
+                                </v-expansion-panel-content>
+                            </v-expansion-panel>
+                        </v-expansion-panels>
+                    </v-col>
+                </v-row>
+            </v-form>
+        </div>
+    </div>
+</template>
+
+<script>
+import _ from 'lodash'
+import { mapGetters } from 'vuex'
+import ProviderTargetPicker from '../../ProviderTargetPicker.vue'
+import Provider from '../../../../models/ExternalIntegration/Provider'
+import FormVue from '~/components/Core/Form.vue'
+import Role from '~/models/Role'
+import Organization from '~/models/Organization'
+import Course from '~/models/Course'
+import Crypto from '~/helpers/Crypto'
+import Uuid from '~/helpers/Uuid'
+
+export default {
+    name: 'ManageScormProviderDriver',
+    components: { ProviderTargetPicker },
+    extends: FormVue,
+    props: {
+        value: {
+            type: [Provider, null],
+            required: false,
+            default: null,
+        },
+    },
+    emits: ['update:provider'],
+    meta: {
+        privilege: {
+            '': {
+                writable: true,
+            },
+        },
+    },
+    data() {
+        return {
+            render: false,
+            provider: {
+                role_metadata: {},
+                metadata: {},
+                version: '2004v4',
+                type: 'scorm',
+            },
+            versions: [
+                { name: '1.2', value: '1.2' },
+                { name: '2004v4', value: '2004v4' },
+                // { name: 'Custom', value: 'custom' }, // TODO: When this is selected provide direct access to check off LTI fields
+            ],
+            rolePanel: false,
+            roles: [],
+            newMap: {
+                name: null,
+                id: null,
+            },
+            updateKey: Crypto.id(),
+        }
+    },
+    async fetch() {
+        // Get available roles but filter out default high level roles since they'll be ignore anyways from the api
+        this.roles = await Role.whereIn('name,ne', [
+            'admin',
+            'editor',
+            'instructor',
+            'student',
+        ]).all()
+    },
+    computed: {
+        ...mapGetters({
+            organization: 'organization/get',
+            course: 'course/get',
+            contentTree: 'content/getTree',
+        }),
+        isNew() {
+            return !Uuid.test(this.provider.id)
+        },
+    },
+    created() {
+        if (_.isEmpty(this.value)) {
+            this.provider = new Provider({
+                role_metadata: {},
+                metadata: {},
+                version: '2004v4',
+                type: 'scorm',
+            })
+        } else {
+            this.provider = _.cloneDeep(this.value)
+        }
+
+        // Set the default mastery to disabled
+        if (typeof this.provider.metadata.has_mastery_score === 'undefined') {
+            this.provider.metadata.has_mastery_score = false
+        }
+        // Set the default score to 70
+        if (typeof this.provider.metadata.mastery_score === 'undefined') {
+            this.provider.metadata.mastery_score = 70
+        }
+    },
+    mounted() {
+        if (
+            !this.$PermissionService.userHasAccessTo(
+                'plugin.windward.integrations.course.externalIntegration',
+                'writable'
+            )
+        ) {
+            // Display an angry error that they can't view this driver
+            this.$dialog.error(this.$t('shared.error.description_401'), {
+                duration: null,
+                action: {
+                    text: this.$t('shared.forms.close'),
+                    onClick: (_e, toastObject) => {
+                        toastObject.goAway(0)
+                    },
+                },
+            })
+            // eslint-disable-next-line no-console
+            console.error('You do not have access to this provider!')
+
+            // Return so we don't even attempt loading
+            return false
+        }
+
+        this.render = true
+    },
+    methods: {
+        uppercase(value) {
+            return _.startCase(value)
+        },
+        deleteMapItem(key) {
+            this.$delete(this.provider.role_metadata, key)
+        },
+        addMapItem() {
+            this.provider.role_metadata[this.newMap.name] = this.newMap.id
+            this.newMap.name = null
+            this.newMap.id = null
+        },
+        async save() {
+            let provider = new Provider(this.provider).for(
+                new Organization({ id: this.organization.id }),
+                new Course({ id: this.course.id })
+            )
+
+            try {
+                console.log('SAVE PROVIDER', provider)
+                provider = await provider.save()
+                this.provider = provider
+
+                // Clone and delete the metadata since we don't need to share that around
+                // Also include the vendor going back for easier mapping
+                const providerEvent = _.cloneDeep(provider)
+
+                this.$dialog.success(this.$t('shared.forms.saved'))
+                this.$emit('update:provider', providerEvent)
+                this.$emit('input', provider)
+            } catch (e) {
+                this.$dialog.error(
+                    this.$t('windward.integrations.shared.error.save_failed')
+                )
+            }
+
+            // Create a new provider to clear the form if the original value is empty aka new
+            if (_.isEmpty(this.value)) {
+                this.provider = new Provider({
+                    role_metadata: {},
+                    metadata: {},
+                    version: '2004v4',
+                    type: 'scorm',
+                })
+            }
+            this.updateKey = Crypto.id()
+        },
+        async onSave() {
+            this.$refs.form.validate()
+            if (this.formValid) {
+                await this.save()
+            }
+        },
+
+        async onSaveAndNew() {
+            this.$refs.form.validate()
+            if (this.formValid) {
+                await this.save()
+            }
+        },
+    },
+}
+</script>