aboutsummaryrefslogtreecommitdiff
path: root/resources/assets/javascripts/lib/studip-vue.js
blob: c8aa096d4dbaa2dee34d1ff189bd7bf7f6bd6ddb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
class Vue
{
    static async load()
    {
        return STUDIP.loadChunk('vue');
    }

    static async on(...args)
    {
        const { eventBus } = await this.load();
        eventBus.on(...args);
    }

    static async off(...args) {
        const { eventBus } = await this.load();
        eventBus.off(...args);
}

    static async emit(...args)
    {
        const { eventBus } = await this.load();
        eventBus.emit(...args);
    }

    static async mountApp(node, appConfig = null) {
        node.dataset.vueAppCreated = 'true';

        const config = appConfig
            ? Object.assign(
                {
                    appPath: null,
                    plugins: [],
                    props: {},
                    slots: {},
                    stores: {},
                    storeData: {},
                    vuexStores: {},
                    vuexStoreData: {},
                },
                JSON.parse(appConfig),
            )
            : this.parseVueAppConfig(node);
        if (!config) {
            return;
        }

        const { createApp, h, store } = await STUDIP.Vue.load();

        const [appComponent, plugins] = await this.loadAppDependencies(config, store);
        const app = createApp({
            render: () =>
                h(
                    this.addDialogButtonRemoval(appComponent),
                    config.props,
                    Object.fromEntries(
                        Object.entries(config.slots).map(([slot, template]) => {
                            return [slot, () => h({ template })];
                        }),
                    ),
                ),
            ...this.createLifecycleHooks(),
        });

        plugins.forEach((plugin) => app.use(plugin, { store }));

        const instance = app.mount(node);

        STUDIP.Vue.emit('vueApp.mounted', { config: config, app: app, instance: instance});

        this.handleDialogClose(node, app);
    }

    static parseVueAppConfig(node) {
        const dataElement = node.querySelector('script[type="application/json"]');
        if (!dataElement) {
            console.error('Missing data for vue app');
            return null;
        }

        return Object.assign(
            {
                appPath: null,
                plugins: [],
                props: {},
                slots: {},
                stores: {},
                storeData: {},
                vuexStores: {},
                vuexStoreData: {},
            },
            JSON.parse(dataElement.innerText),
        );
    }

    static async loadAppDependencies(config, store) {
        const promises = [
            import(`@/vue/apps/${config.appPath}.vue`),
            this.initializePlugins(config),
            ...this.initializeVuexStores(config, store),
            ...this.initializePiniaStores(config),
        ];

        const [{ default: appComponent }, plugins = []] = await Promise.all(promises);
        return [appComponent, plugins];
    }

    static createLifecycleHooks() {
        return {
            beforeCreate() {
                STUDIP.Vue.emit('VueAppWillCreate', this);
            },
            created() {
                STUDIP.Vue.emit('VueAppDidCreate', this);
            },
            beforeMount() {
                STUDIP.Vue.emit('VueAppWillMount', this);
            },
            mounted() {
                STUDIP.Vue.emit('VueAppDidMount', this);
            },
            beforeUpdate() {
                STUDIP.Vue.emit('VueAppWillUpdate', this);
            },
            updated() {
                STUDIP.Vue.emit('VueAppDidUpdate', this);
            },
            beforeUnmount() {
                STUDIP.Vue.emit('VueAppWillUnmount', this);
            },
            unmounted() {
                STUDIP.Vue.emit('VueAppDidUnmount', this);
            },
        };
    }

    static handleDialogClose(node, app) {
        const dialog = node.closest('.studip-dialog');
        if (dialog !== null) {
            $(dialog).on('dialogclose', () => app.unmount());
        }
    }

    static initializeVuexStores(config, store) {
        return Object.entries(config.vuexStores).map(([index, name]) =>
            import(`@/vue/store/${name}`).then(({ default: storeConfig }) => {
                if (!store.hasModule(index)) {
                    store.registerModule(index, storeConfig);
                }
                Object.entries(config.vuexStoreData[index]).forEach(([type, payload]) =>
                    store.commit(`${index}/${type}`, payload),
                );
            }),
        );
    }

    static initializePiniaStores(config) {
        return Object.entries(config.stores).map(([name, command]) =>
            import(`@/vue/store/pinia/${name}`).then((storeConfig) => {
                const piniaStore = storeConfig[command]();
                this.applyPiniaStoreData(piniaStore, config.storeData);
            }),
        );
    }

    static applyPiniaStoreData(piniaStore, data) {
        Object.entries(data).forEach(([command, value]) => {
            if (_.isFunction(piniaStore[command])) {
                piniaStore[command](value);
            } else {
                piniaStore[command] = value;
            }
        });
    }

    static initializePlugins(config) {
        return Promise.all(
            Object.entries(config.plugins).map(([plugin, filename]) =>
                import(`@/vue/plugins/${filename}.js`).then((temp) => temp[plugin]),
            ),
        );
    }

    static addDialogButtonRemoval(component) {
        const originalMounted = component.mounted;
        component.mounted = function (...args) {
            if (
                this.$el instanceof Element &&
                this.$el.closest('.studip-dialog') &&
                this.$el.querySelector('[data-dialog-button]')
            ) {
                this.$el.closest('.studip-dialog').querySelector('.ui-dialog-buttonpane')?.remove();
            }
            if (originalMounted) {
                originalMounted.call(this, args);
            }
        };
        return component;
    }
}

export default Vue;