Skip to content

[Live] Add signature overload for on and off methods of component #1685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 30, 2024
Merged

[Live] Add signature overload for on and off methods of component #1685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/LiveComponent/assets/dist/Component/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
import { BackendInterface } from '../Backend/Backend';
import ValueStore from './ValueStore';
import BackendRequest from '../Backend/BackendRequest';
import { ElementDriver } from './ElementDriver';
import { PluginInterface } from './plugins/PluginInterface';
import BackendResponse from '../Backend/BackendResponse';
type MaybePromise<T = void> = T | Promise<T>;
export type ComponentHooks = {
'connect': (component: Component) => MaybePromise;
'disconnect': (component: Component) => MaybePromise;
'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;
'model:set': (model: string, value: any, component: Component) => MaybePromise;
};
export type ComponentHookName = keyof ComponentHooks;
export type ComponentHookCallback<T extends string = ComponentHookName> = T extends ComponentHookName ? ComponentHooks[T] : (...args: any[]) => MaybePromise;
export default class Component {
readonly element: HTMLElement;
readonly name: string;
Expand Down Expand Up @@ -30,8 +46,8 @@ export default class Component {
addPlugin(plugin: PluginInterface): void;
connect(): void;
disconnect(): void;
on(hookName: string, callback: (...args: any[]) => void): void;
off(hookName: string, callback: (...args: any[]) => void): void;
on<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void;
off<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void;
set(model: string, value: any, reRender?: boolean, debounce?: number | boolean): Promise<BackendResponse>;
getData(model: string): any;
action(name: string, args?: any, debounce?: number | boolean): Promise<BackendResponse>;
Expand All @@ -55,3 +71,4 @@ export default class Component {
_updateFromParentProps(props: any): void;
}
export declare function proxifyComponent(component: Component): Component;
export {};
4 changes: 2 additions & 2 deletions src/LiveComponent/assets/dist/HookManager.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export default class {
private hooks;
register(hookName: string, callback: () => void): void;
unregister(hookName: string, callback: () => void): void;
register(hookName: string, callback: (...args: any[]) => void): void;
unregister(hookName: string, callback: (...args: any[]) => void): void;
triggerHook(hookName: string, ...args: any[]): void;
}
3 changes: 1 addition & 2 deletions src/LiveComponent/assets/dist/PollingDirector.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/// <reference types="node" />
import Component from './Component';
export default class {
component: Component;
Expand All @@ -7,7 +6,7 @@ export default class {
actionName: string;
duration: number;
}>;
pollingIntervals: NodeJS.Timer[];
pollingIntervals: number[];
constructor(component: Component);
addPoll(actionName: string, duration: number): void;
startAllPolling(): void;
Expand Down
2 changes: 1 addition & 1 deletion src/LiveComponent/assets/dist/live_controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2625,7 +2625,7 @@ class PollingDirector {
this.component.action(actionName, {}, 0);
};
}
const timer = setInterval(() => {
const timer = window.setInterval(() => {
callback();
}, duration);
this.pollingIntervals.push(timer);
Expand Down
36 changes: 21 additions & 15 deletions src/LiveComponent/assets/src/Component/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ import { findComponents, registerComponent, unregisterComponent } from '../Compo

declare const Turbo: any;

type MaybePromise<T = void> = T | Promise<T>;

export type ComponentHooks = {
'connect': (component: Component) => MaybePromise,
'disconnect': (component: Component) => MaybePromise,
'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,
'model:set': (model: string, value: any, component: Component) => MaybePromise,
};

export type ComponentHookName = keyof ComponentHooks;

export type ComponentHookCallback<T extends string = ComponentHookName> = T extends ComponentHookName
? ComponentHooks[T]
: (...args: any[]) => MaybePromise;

export default class Component {
readonly element: HTMLElement;
readonly name: string;
Expand Down Expand Up @@ -109,24 +128,11 @@ export default class Component {
this.externalMutationTracker.stop();
}

/**
* Add a named hook to the component. Available hooks are:
*
* * connect (component: Component) => {}
* * disconnect (component: Component) => {}
* * request:started (requestConfig: any) => {}
* * render:started (html: string, response: BackendResponse, controls: { shouldRender: boolean }) => {}
* * render:finished (component: Component) => {}
* * response:error (backendResponse: BackendResponse, controls: { displayError: boolean }) => {}
* * loading.state:started (element: HTMLElement, request: BackendRequest) => {}
* * loading.state:finished (element: HTMLElement) => {}
* * model:set (model: string, value: any, component: Component) => {}
*/
on(hookName: string, callback: (...args: any[]) => void): void {
on<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void {
this.hooks.register(hookName, callback);
}

off(hookName: string, callback: (...args: any[]) => void): void {
off<T extends string | ComponentHookName = ComponentHookName>(hookName: T, callback: ComponentHookCallback<T>): void {
this.hooks.unregister(hookName, callback);
}

Expand Down
4 changes: 2 additions & 2 deletions src/LiveComponent/assets/src/HookManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
export default class {
private hooks: Map<string, Array<(...args: any[]) => void>> = new Map();

register(hookName: string, callback: () => void): void {
register(hookName: string, callback: (...args: any[]) => void): void {
const hooks = this.hooks.get(hookName) || [];
hooks.push(callback);
this.hooks.set(hookName, hooks);
}

unregister(hookName: string, callback: () => void): void {
unregister(hookName: string, callback: (...args: any[]) => void): void {
const hooks = this.hooks.get(hookName) || [];
const index = hooks.indexOf(callback);
if (index === -1) {
Expand Down
4 changes: 2 additions & 2 deletions src/LiveComponent/assets/src/PollingDirector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export default class {
component: Component;
isPollingActive = true;
polls: Array<{ actionName: string; duration: number }>;
pollingIntervals: NodeJS.Timer[] = [];
pollingIntervals: number[] = [];

constructor(component: Component) {
this.component = component;
Expand Down Expand Up @@ -55,7 +55,7 @@ export default class {
};
}

const timer = setInterval(() => {
const timer = window.setInterval(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about this fix. setInterval is native function well supported why use the one from window?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using setInterval or window.setInterval results in the same thing in a browser context. However, when using setInterval, TypeScript was mistakenly thinking that this was the Nodejs setInterval function, which doesn't return a number like in a browser, which was causing a typing error warning during builds.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok thanks for your answer!

callback();
}, duration);
this.pollingIntervals.push(timer);
Expand Down