import { initVevet } from '@/global/initVevet'; import { cnAdd, cnHas, cnRemove } from '@/internal/cn'; import { mergeWithNoUndefined } from '@/internal/mergeWithNoUndefined'; import { noopIfDestroyed } from '@/internal/noopIfDestroyed'; import { TRequiredProps } from '@/internal/requiredProps'; import { Callbacks, ICallbacksSettings, TCallbacksAction } from '../Callbacks'; import { IModuleCallbacksMap, IModuleMutableProps, IModuleStaticProps, TModuleOnCallbacksProps, } from './types'; // todo: jsdoc export * from './types'; /** * A base class for modules that handle responsive properties, event listeners, and custom callbacks. * * @group Base */ export class Module< CallbacksMap extends IModuleCallbacksMap = IModuleCallbacksMap, StaticProps extends IModuleStaticProps = IModuleStaticProps, MutableProps extends IModuleMutableProps = IModuleMutableProps, > { /** Get default static props */ public _getStatic(): TRequiredProps { return { __staticProp: true } as TRequiredProps; } /** Set default mutable props */ public _getMutable(): TRequiredProps { return { __mutableProp: true } as TRequiredProps; } /** Current properties */ private _props: TRequiredProps; /** * Current properties. Do not mutate these directly, use {@linkcode updateProps} instead. */ get props() { return this._props; } /** Optional prefix for classnames used by the module */ get prefix() { return initVevet().prefix; } /** The name of the module, derived from the class name */ get name() { return this.constructor.name; } /** Tracks whether the module has been destroyed */ private _isDestroyed = false; /** * Checks if the module has been destroyed. */ get isDestroyed() { return this._isDestroyed; } /** Callbacks instance */ private _callbacks: Callbacks; /** * Retrieves the module's callbacks instance. */ get callbacks() { return this._callbacks; } /** Stores actions that need to be executed when the module is destroyed */ private _destroyable: (() => void)[] = []; /** * Creates a new instance of the Module class. */ constructor( props?: StaticProps & MutableProps, onCallbacksProp?: TModuleOnCallbacksProps< CallbacksMap, Module >, ) { this._callbacks = new Callbacks({ ctx: this }); this._props = mergeWithNoUndefined( { ...this._getStatic(), ...this._getMutable(), }, { ...props }, ) as TRequiredProps; // Initialize callbacks const onCallbacks = { ...props, ...onCallbacksProp, }; if (onCallbacks) { const callbacksProps = Object.keys(onCallbacks).filter( (key) => key.startsWith('on') && typeof onCallbacks[key as keyof typeof onCallbacks] === 'function', ); callbacksProps.forEach((key) => { let target = key.slice(2); target = target.charAt(0).toLowerCase() + target.slice(1); this._callbacks.on( target as keyof CallbacksMap, onCallbacks[key as keyof typeof props], ); }); } } /** * Method that is called when the module's properties mutate. In most cases, used to handle callbacks. */ protected _handleProps(diff: Partial) { this.callbacks.emit('props', diff); } /** Change module's mutable properties */ @noopIfDestroyed public updateProps(props: Partial) { const prevProps = { ...this._props }; const keys = Object.keys(this.props) as (keyof MutableProps)[]; this._props = { ...this._props, ...props, }; const diff: Partial = {}; // todo keys.forEach((key) => { // @ts-ignore const prevValue = prevProps[key]; // @ts-ignore const newValue = this._props[key]; if (prevValue !== newValue) { diff[key] = newValue; } }); this._handleProps(diff); } /** * Adds a callback on the module's destruction. * * @param action - The function to execute during destruction. */ public onDestroy(action: () => void) { if (this.isDestroyed) { action(); return; } this._destroyable.push(action); } /** * Adds a custom callback to the module. * * @param target - The event type to listen for (e.g., 'props', 'destroy'). * @param listener - The function to execute when the event is triggered. * @param settings - Additional settings for the callback. */ @noopIfDestroyed public on( target: T, listener: TCallbacksAction, settings: ICallbacksSettings = {}, ) { return this.callbacks.on(target, listener, settings); } /** * Helper function to generate classnames with the module's prefix. * * @param classNames - The class names to generate. * @returns A string of class names with the module's prefix applied. */ protected _cn(...classNames: string[]) { return classNames.map((value) => `${this.prefix}${value}`).join(' '); } /** * Adds a class name on an element, and keeps track of it for removal when the module is destroyed. * * @param element - The target DOM element. * @param className - The class name to toggle. */ protected _addTempClassName(element: Element, className: string) { const isAlreadyExists = cnHas(element, className); if (!isAlreadyExists) { cnAdd(element, className); this.onDestroy(() => cnRemove(element, className)); } } /** * Destroys the module, cleaning up resources, callbacks, and event listeners. */ @noopIfDestroyed public destroy() { this._destroy(); } /** * Internal method to handle the destruction of the module. * It removes all callbacks, destroys properties, and cleans up event listeners and class names. */ protected _destroy() { this._callbacks.emit('destroy', undefined); this._callbacks.destroy(); this._destroyable.forEach((action) => action()); this._isDestroyed = true; } }