]> BookStack Code Mirror - bookstack/blob - resources/js/services/events.ts
Adapt tests with displayName array
[bookstack] / resources / js / services / events.ts
1 import {HttpError} from "./http";
2
3 export class EventManager {
4     protected listeners: Record<string, ((data: any) => void)[]> = {};
5     protected stack: {name: string, data: {}}[] = [];
6
7     /**
8      * Emit a custom event for any handlers to pick-up.
9      */
10     emit(eventName: string, eventData: {} = {}): void {
11         this.stack.push({name: eventName, data: eventData});
12
13         const listenersToRun = this.listeners[eventName] || [];
14         for (const listener of listenersToRun) {
15             listener(eventData);
16         }
17     }
18
19     /**
20      * Listen to a custom event and run the given callback when that event occurs.
21      */
22     listen<T>(eventName: string, callback: (data: T) => void): void {
23         if (typeof this.listeners[eventName] === 'undefined') this.listeners[eventName] = [];
24         this.listeners[eventName].push(callback);
25     }
26
27     /**
28      * Emit an event for public use.
29      * Sends the event via the native DOM event handling system.
30      */
31     emitPublic(targetElement: Element, eventName: string, eventData: {}): void {
32         const event = new CustomEvent(eventName, {
33             detail: eventData,
34             bubbles: true,
35         });
36         targetElement.dispatchEvent(event);
37     }
38
39     /**
40      * Emit a success event with the provided message.
41      */
42     success(message: string): void {
43         this.emit('success', message);
44     }
45
46     /**
47      * Emit an error event with the provided message.
48      */
49     error(message: string): void {
50         this.emit('error', message);
51     }
52
53     /**
54      * Notify of standard server-provided validation errors.
55      */
56     showValidationErrors(responseErr: {status?: number, data?: object}): void {
57         if (!responseErr.status) return;
58         if (responseErr.status === 422 && responseErr.data) {
59             const message = Object.values(responseErr.data).flat().join('\n');
60             this.error(message);
61         }
62     }
63
64     /**
65      * Notify standard server-provided error messages.
66      */
67     showResponseError(responseErr: {status?: number, data?: Record<any, any>}|HttpError): void {
68         if (!responseErr.status) return;
69         if (responseErr.status >= 400 && typeof responseErr.data === 'object' && responseErr.data.message) {
70             this.error(responseErr.data.message);
71         }
72     }
73 }