Fix typing for loading hooks + HookManager

symfony · Jun 15, 2024 · 303bbe6 · 303bbe6
1 parent 29c4798
commit 303bbe6
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 11 deletions.
diff --git a/assets/dist/Component/index.d.ts b/assets/dist/Component/index.d.ts
@@ -13,8 +13,8 @@ export type ComponentHooks = {
     'response:error': (backendResponse: BackendResponse, controls: {
         displayError: boolean;
     }) => MaybePromise;
-    'loading.state.started': (element: HTMLElement, request: BackendRequest) => MaybePromise;
-    'loading.state.finished': (element: HTMLElement) => MaybePromise;
+    'loading.state:started': (element: HTMLElement, request: BackendRequest) => MaybePromise;
+    'loading.state:finished': (element: HTMLElement) => MaybePromise;
     'model:set': (model: string, value: any, component: Component) => MaybePromise;
 };
 export type ComponentHookName = keyof ComponentHooks;

diff --git a/assets/dist/HookManager.d.ts b/assets/dist/HookManager.d.ts
@@ -1,6 +1,7 @@
+import type { ComponentHookName, ComponentHookCallback } from './Component';
 export default class {
     private hooks;
-    register(hookName: string, callback: (...args: any[]) => void): void;
-    unregister(hookName: string, callback: (...args: any[]) => void): void;
-    triggerHook(hookName: string, ...args: any[]): void;
+    register<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void;
+    unregister<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void;
+    triggerHook<T extends string | ComponentHookName = ComponentHookName>(hookName: T, ...args: Parameters<ComponentHookCallback<T>>): void;
 }
diff --git a/assets/src/Component/index.ts b/assets/src/Component/index.ts
@@ -22,8 +22,8 @@ export type ComponentHooks = {
     'request:started': (requestConfig: any) => MaybePromise,
     'render:finished': (component: Component) => MaybePromise,
     'response:error': (backendResponse: BackendResponse, controls: { displayError: boolean }) => MaybePromise,
-    'loading.state.started': (element: HTMLElement, request: BackendRequest) => MaybePromise,
-    'loading.state.finished': (element: HTMLElement) => MaybePromise,
+    'loading.state:started': (element: HTMLElement, request: BackendRequest) => MaybePromise,
+    'loading.state:finished': (element: HTMLElement) => MaybePromise,
     'model:set': (model: string, value: any, component: Component) => MaybePromise,
 };
 

diff --git a/assets/src/HookManager.ts b/assets/src/HookManager.ts
@@ -1,13 +1,21 @@
+import type { ComponentHookName, ComponentHookCallback } from './Component';
+
 export default class {
-    private hooks: Map<string, Array<(...args: any[]) => void>> = new Map();
+    private hooks: Map<ComponentHookName | string, Array<(...args: any[]) => void>> = new Map();
 
-    register(hookName: string, callback: (...args: any[]) => void): void {
+    register<T extends string | ComponentHookName = ComponentHookName>(
+        hookName: T,
+        callback: ComponentHookCallback<T>
+    ): void {
         const hooks = this.hooks.get(hookName) || [];
         hooks.push(callback);
         this.hooks.set(hookName, hooks);
     }
 
-    unregister(hookName: string, callback: (...args: any[]) => void): void {
+    unregister<T extends string | ComponentHookName = ComponentHookName>(
+        hookName: T,
+        callback: ComponentHookCallback<T>
+    ): void {
         const hooks = this.hooks.get(hookName) || [];
         const index = hooks.indexOf(callback);
         if (index === -1) {
@@ -18,7 +26,10 @@ export default class {
         this.hooks.set(hookName, hooks);
     }
 
-    triggerHook(hookName: string, ...args: any[]): void {
+    triggerHook<T extends string | ComponentHookName = ComponentHookName>(
+        hookName: T,
+        ...args: Parameters<ComponentHookCallback<T>>
+    ): void {
         const hooks = this.hooks.get(hookName) || [];
         hooks.forEach((callback) => callback(...args));
     }