eleva 1.0.0-alpha → 1.0.0-rc.2

package/src/core/Eleva.js

@@ -6,241 +6,489 @@ import { Emitter } from "../modules/Emitter.js";
 import { Renderer } from "../modules/Renderer.js";
 
 /**
- * 🧩 Eleva Core: Signal-based component runtime framework with lifecycle, scoped styles, and plugins.
+ * @typedef {Object} ComponentDefinition
+ * @property {function(ComponentContext): (Record<string, unknown>|Promise<Record<string, unknown>>)} [setup]
+ *           Optional setup function that initializes the component's state and returns reactive data
+ * @property {(function(ComponentContext): string|Promise<string>)} template
+ *           Required function that defines the component's HTML structure
+ * @property {(function(ComponentContext): string)|string} [style]
+ *           Optional function or string that provides component-scoped CSS styles
+ * @property {Record<string, ComponentDefinition>} [children]
+ *           Optional object defining nested child components
+ */
+
+/**
+ * @typedef {Object} ComponentContext
+ * @property {Record<string, unknown>} props
+ *           Component properties passed during mounting
+ * @property {Emitter} emitter
+ *           Event emitter instance for component event handling
+ * @property {function<T>(value: T): Signal<T>} signal
+ *           Factory function to create reactive Signal instances
+ * @property {function(LifecycleHookContext): Promise<void>} [onBeforeMount]
+ *           Hook called before component mounting
+ * @property {function(LifecycleHookContext): Promise<void>} [onMount]
+ *           Hook called after component mounting
+ * @property {function(LifecycleHookContext): Promise<void>} [onBeforeUpdate]
+ *           Hook called before component update
+ * @property {function(LifecycleHookContext): Promise<void>} [onUpdate]
+ *           Hook called after component update
+ * @property {function(UnmountHookContext): Promise<void>} [onUnmount]
+ *           Hook called during component unmounting
+ */
+
+/**
+ * @typedef {Object} LifecycleHookContext
+ * @property {HTMLElement} container
+ *           The DOM element where the component is mounted
+ * @property {ComponentContext} context
+ *           The component's reactive state and context data
+ */
+
+/**
+ * @typedef {Object} UnmountHookContext
+ * @property {HTMLElement} container
+ *           The DOM element where the component is mounted
+ * @property {ComponentContext} context
+ *           The component's reactive state and context data
+ * @property {{
+ *   watchers: Array<() => void>,    // Signal watcher cleanup functions
+ *   listeners: Array<() => void>,   // Event listener cleanup functions
+ *   children: Array<MountResult>    // Child component instances
+ * }} cleanup
+ *           Object containing cleanup functions and instances
+ */
+
+/**
+ * @typedef {Object} MountResult
+ * @property {HTMLElement} container
+ *           The DOM element where the component is mounted
+ * @property {ComponentContext} data
+ *           The component's reactive state and context data
+ * @property {function(): Promise<void>} unmount
+ *           Function to clean up and unmount the component
+ */
+
+/**
+ * @typedef {Object} ElevaPlugin
+ * @property {function(Eleva, Record<string, unknown>): void} install
+ *           Function that installs the plugin into the Eleva instance
+ * @property {string} name
+ *           Unique identifier name for the plugin
+ */
+
+/**
+ * @class 🧩 Eleva
+ * @classdesc A modern, signal-based component runtime framework that provides lifecycle hooks,
+ * scoped styles, and plugin support. Eleva manages component registration, plugin integration,
+ * event handling, and DOM rendering with a focus on performance and developer experience.
  *
- * The Eleva class is the core of the framework. It manages component registration,
- * plugin integration, lifecycle hooks, event handling, and DOM rendering.
+ * @example
+ * // Basic component creation and mounting
+ * const app = new Eleva("myApp");
+ * app.component("myComponent", {
+ *   setup: (ctx) => ({ count: ctx.signal(0) }),
+ *   template: (ctx) => `<div>Hello ${ctx.props.name}</div>`
+ * });
+ * app.mount(document.getElementById("app"), "myComponent", { name: "World" });
+ *
+ * @example
+ * // Using lifecycle hooks
+ * app.component("lifecycleDemo", {
+ *   setup: () => {
+ *     return {
+ *       onMount: ({ container, context }) => {
+ *         console.log('Component mounted!');
+ *       }
+ *     };
+ *   },
+ *   template: `<div>Lifecycle Demo</div>`
+ * });
  */
 export class Eleva {
   /**
-   * Creates a new Eleva instance.
+   * Creates a new Eleva instance with the specified name and configuration.
+   *
+   * @public
+   * @param {string} name - The unique identifier name for this Eleva instance.
+   * @param {Record<string, unknown>} [config={}] - Optional configuration object for the instance.
+   *        May include framework-wide settings and default behaviors.
+   * @throws {Error} If the name is not provided or is not a string.
+   * @returns {Eleva} A new Eleva instance.
+   *
+   * @example
+   * const app = new Eleva("myApp");
+   * app.component("myComponent", {
+   *   setup: (ctx) => ({ count: ctx.signal(0) }),
+   *   template: (ctx) => `<div>Hello ${ctx.props.name}!</div>`
+   * });
+   * app.mount(document.getElementById("app"), "myComponent", { name: "World" });
    *
-   * @param {string} name - The name of the Eleva instance.
-   * @param {object} [config={}] - Optional configuration for the instance.
    */
   constructor(name, config = {}) {
+    /** @public {string} The unique identifier name for this Eleva instance */
     this.name = name;
+    /** @public {Object<string, unknown>} Optional configuration object for the Eleva instance */
     this.config = config;
-    this._components = {};
-    this._plugins = [];
-    this._lifecycleHooks = [
-      "onBeforeMount",
-      "onMount",
-      "onBeforeUpdate",
-      "onUpdate",
-      "onUnmount",
-    ];
-    this._isMounted = false;
+    /** @public {Emitter} Instance of the event emitter for handling component events */
     this.emitter = new Emitter();
+    /** @public {typeof Signal} Static reference to the Signal class for creating reactive state */
+    this.signal = Signal;
+    /** @public {Renderer} Instance of the renderer for handling DOM updates and patching */
     this.renderer = new Renderer();
+
+    /** @private {Map<string, ComponentDefinition>} Registry of all component definitions by name */
+    this._components = new Map();
+    /** @private {Map<string, ElevaPlugin>} Collection of installed plugin instances by name */
+    this._plugins = new Map();
+    /** @private {boolean} Flag indicating if the root component is currently mounted */
+    this._isMounted = false;
+    /** @private {number} Counter for generating unique component IDs */
+    this._componentCounter = 0;
   }
 
   /**
    * Integrates a plugin with the Eleva framework.
+   * The plugin's install function will be called with the Eleva instance and provided options.
+   * After installation, the plugin will be available for use by components.
    *
-   * @param {object} [plugin] - The plugin object which should have an install function.
-   * @param {object} [options={}] - Optional options to pass to the plugin.
-   * @returns {Eleva} The Eleva instance (for chaining).
+   * @public
+   * @param {ElevaPlugin} plugin - The plugin object which must have an `install` function.
+   * @param {Object<string, unknown>} [options={}] - Optional configuration options for the plugin.
+   * @returns {Eleva} The Eleva instance (for method chaining).
+   * @example
+   * app.use(myPlugin, { option1: "value1" });
    */
   use(plugin, options = {}) {
-    if (typeof plugin.install === "function") {
-      plugin.install(this, options);
-    }
-    this._plugins.push(plugin);
+    plugin.install(this, options);
+    this._plugins.set(plugin.name, plugin);
+
     return this;
   }
 
   /**
-   * Registers a component with the Eleva instance.
+   * Registers a new component with the Eleva instance.
+   * The component will be available for mounting using its registered name.
    *
-   * @param {string} name - The name of the component.
-   * @param {object} definition - The component definition including setup, template, style, and children.
-   * @returns {Eleva} The Eleva instance (for chaining).
+   * @public
+   * @param {string} name - The unique name of the component to register.
+   * @param {ComponentDefinition} definition - The component definition including setup, template, style, and children.
+   * @returns {Eleva} The Eleva instance (for method chaining).
+   * @throws {Error} If the component name is already registered.
+   * @example
+   * app.component("myButton", {
+   *   template: (ctx) => `<button>${ctx.props.text}</button>`,
+   *   style: `button { color: blue; }`
+   * });
    */
   component(name, definition) {
-    this._components[name] = definition;
+    /** @type {Map<string, ComponentDefinition>} */
+    this._components.set(name, definition);
     return this;
   }
 
   /**
    * Mounts a registered component to a DOM element.
+   * This will initialize the component, set up its reactive state, and render it to the DOM.
    *
-   * @param {string|HTMLElement} selectorOrElement - A CSS selector string or DOM element where the component will be mounted.
-   * @param {string} compName - The name of the component to mount.
-   * @param {object} [props={}] - Optional properties to pass to the component.
-   * @returns {object|Promise<object>} An object representing the mounted component instance, or a Promise that resolves to it for asynchronous setups.
-   * @throws Will throw an error if the container or component is not found.
+   * @public
+   * @param {HTMLElement} container - The DOM element where the component will be mounted.
+   * @param {string|ComponentDefinition} compName - The name of the registered component or a direct component definition.
+   * @param {Object<string, unknown>} [props={}] - Optional properties to pass to the component.
+   * @returns {Promise<MountResult>}
+   *          A Promise that resolves to an object containing:
+   *          - container: The mounted component's container element
+   *          - data: The component's reactive state and context
+   *          - unmount: Function to clean up and unmount the component
+   * @throws {Error} If the container is not found, or component is not registered.
+   * @example
+   * const instance = await app.mount(document.getElementById("app"), "myComponent", { text: "Click me" });
+   * // Later...
+   * instance.unmount();
    */
-  mount(selectorOrElement, compName, props = {}) {
-    const container =
-      typeof selectorOrElement === "string"
-        ? document.querySelector(selectorOrElement)
-        : selectorOrElement;
-    if (!container)
-      throw new Error(`Container not found: ${selectorOrElement}`);
-
-    const definition = this._components[compName];
+  async mount(container, compName, props = {}) {
+    if (!container) throw new Error(`Container not found: ${container}`);
+
+    if (container._eleva_instance) return container._eleva_instance;
+
+    /** @type {ComponentDefinition} */
+    const definition =
+      typeof compName === "string" ? this._components.get(compName) : compName;
     if (!definition) throw new Error(`Component "${compName}" not registered.`);
 
+    /** @type {string} */
+    const compId = `c${++this._componentCounter}`;
+
+    /**
+     * Destructure the component definition to access core functionality.
+     * - setup: Optional function for component initialization and state management
+     * - template: Required function or string that returns the component's HTML structure
+     * - style: Optional function or string for component-scoped CSS styles
+     * - children: Optional object defining nested child components
+     */
     const { setup, template, style, children } = definition;
+
+    /** @type {ComponentContext} */
     const context = {
       props,
-      emit: this.emitter.emit.bind(this.emitter),
-      on: this.emitter.on.bind(this.emitter),
-      signal: (v) => new Signal(v),
-      ...this._prepareLifecycleHooks(),
+      emitter: this.emitter,
+      /** @type {(v: unknown) => Signal<unknown>} */
+      signal: (v) => new this.signal(v),
     };
 
     /**
      * Processes the mounting of the component.
+     * This function handles:
+     * 1. Merging setup data with the component context
+     * 2. Setting up reactive watchers
+     * 3. Rendering the component
+     * 4. Managing component lifecycle
      *
-     * @param {object} data - Data returned from the component's setup function.
-     * @returns {object} An object with the container, merged context data, and an unmount function.
+     * @param {Object<string, unknown>} data - Data returned from the component's setup function
+     * @returns {Promise<MountResult>} An object containing:
+     *   - container: The mounted component's container element
+     *   - data: The component's reactive state and context
+     *   - unmount: Function to clean up and unmount the component
      */
-    const processMount = (data) => {
+    const processMount = async (data) => {
+      /** @type {ComponentContext} */
       const mergedContext = { ...context, ...data };
-      const watcherUnsubscribers = [];
+      /** @type {Array<() => void>} */
+      const watchers = [];
+      /** @type {Array<MountResult>} */
       const childInstances = [];
+      /** @type {Array<() => void>} */
+      const listeners = [];
 
+      // Execute before hooks
       if (!this._isMounted) {
-        mergedContext.onBeforeMount && mergedContext.onBeforeMount();
+        /** @type {LifecycleHookContext} */
+        await mergedContext.onBeforeMount?.({
+          container,
+          context: mergedContext,
+        });
       } else {
-        mergedContext.onBeforeUpdate && mergedContext.onBeforeUpdate();
+        /** @type {LifecycleHookContext} */
+        await mergedContext.onBeforeUpdate?.({
+          container,
+          context: mergedContext,
+        });
       }
 
       /**
-       * Renders the component by parsing the template, patching the DOM,
-       * processing events, injecting styles, and mounting child components.
+       * Renders the component by:
+       * 1. Processing the template
+       * 2. Updating the DOM
+       * 3. Processing events, injecting styles, and mounting child components.
        */
-      const render = () => {
-        const newHtml = TemplateEngine.parse(
-          template(mergedContext),
-          mergedContext
-        );
+      const render = async () => {
+        const templateResult =
+          typeof template === "function"
+            ? await template(mergedContext)
+            : template;
+        const newHtml = TemplateEngine.parse(templateResult, mergedContext);
         this.renderer.patchDOM(container, newHtml);
-        this._processEvents(container, mergedContext);
-        this._injectStyles(container, compName, style, mergedContext);
-        this._mountChildren(container, children, childInstances);
+        this._processEvents(container, mergedContext, listeners);
+        if (style) this._injectStyles(container, compId, style, mergedContext);
+        if (children)
+          await this._mountComponents(container, children, childInstances);
+
         if (!this._isMounted) {
-          mergedContext.onMount && mergedContext.onMount();
+          /** @type {LifecycleHookContext} */
+          await mergedContext.onMount?.({
+            container,
+            context: mergedContext,
+          });
           this._isMounted = true;
         } else {
-          mergedContext.onUpdate && mergedContext.onUpdate();
+          /** @type {LifecycleHookContext} */
+          await mergedContext.onUpdate?.({
+            container,
+            context: mergedContext,
+          });
         }
       };
 
-      Object.values(data).forEach((val) => {
-        if (val instanceof Signal) watcherUnsubscribers.push(val.watch(render));
-      });
+      /**
+       * Sets up reactive watchers for all Signal instances in the component's data.
+       * When a Signal's value changes, the component will re-render to reflect the updates.
+       * Stores unsubscribe functions to clean up watchers when component unmounts.
+       */
+      for (const val of Object.values(data)) {
+        if (val instanceof Signal) watchers.push(val.watch(render));
+      }
 
-      render();
+      await render();
 
-      return {
+      const instance = {
         container,
         data: mergedContext,
         /**
-         * Unmounts the component, cleaning up watchers, child components, and clearing the container.
+         * Unmounts the component, cleaning up watchers and listeners, child components, and clearing the container.
+         *
+         * @returns {void}
          */
-        unmount: () => {
-          watcherUnsubscribers.forEach((fn) => fn());
-          childInstances.forEach((child) => child.unmount());
-          mergedContext.onUnmount && mergedContext.onUnmount();
+        unmount: async () => {
+          /** @type {UnmountHookContext} */
+          await mergedContext.onUnmount?.({
+            container,
+            context: mergedContext,
+            cleanup: {
+              watchers: watchers,
+              listeners: listeners,
+              children: childInstances,
+            },
+          });
+          for (const fn of watchers) fn();
+          for (const fn of listeners) fn();
+          for (const child of childInstances) await child.unmount();
           container.innerHTML = "";
+          delete container._eleva_instance;
         },
       };
+
+      container._eleva_instance = instance;
+      return instance;
     };
 
-    // Handle asynchronous setup if needed.
-    const setupResult = setup(context);
-    if (setupResult && typeof setupResult.then === "function") {
-      return setupResult.then((data) => processMount(data));
-    } else {
-      const data = setupResult || {};
-      return processMount(data);
-    }
+    // Handle asynchronous setup.
+    const setupResult = typeof setup === "function" ? await setup(context) : {};
+    return await processMount(setupResult);
   }
 
   /**
-   * Prepares default no-operation lifecycle hook functions.
+   * Processes DOM elements for event binding based on attributes starting with "@".
+   * This method handles the event delegation system and ensures proper cleanup of event listeners.
    *
-   * @returns {object} An object with keys for lifecycle hooks mapped to empty functions.
    * @private
+   * @param {HTMLElement} container - The container element in which to search for event attributes.
+   * @param {ComponentContext} context - The current component context containing event handler definitions.
+   * @param {Array<() => void>} listeners - Array to collect cleanup functions for each event listener.
+   * @returns {void}
    */
-  _prepareLifecycleHooks() {
-    return this._lifecycleHooks.reduce((acc, hook) => {
-      acc[hook] = () => {};
-      return acc;
-    }, {});
+  _processEvents(container, context, listeners) {
+    /** @type {NodeListOf<Element>} */
+    const elements = container.querySelectorAll("*");
+    for (const el of elements) {
+      /** @type {NamedNodeMap} */
+      const attrs = el.attributes;
+      for (let i = 0; i < attrs.length; i++) {
+        /** @type {Attr} */
+        const attr = attrs[i];
+
+        if (!attr.name.startsWith("@")) continue;
+
+        /** @type {keyof HTMLElementEventMap} */
+        const event = attr.name.slice(1);
+        /** @type {string} */
+        const handlerName = attr.value;
+        /** @type {(event: Event) => void} */
+        const handler =
+          context[handlerName] || TemplateEngine.evaluate(handlerName, context);
+        if (typeof handler === "function") {
+          el.addEventListener(event, handler);
+          el.removeAttribute(attr.name);
+          listeners.push(() => el.removeEventListener(event, handler));
+        }
+      }
+    }
   }
 
   /**
-   * Processes DOM elements for event binding based on attributes starting with "@".
+   * Injects scoped styles into the component's container.
+   * The styles are automatically prefixed to prevent style leakage to other components.
    *
-   * @param {HTMLElement} container - The container element in which to search for events.
-   * @param {object} context - The current context containing event handler definitions.
    * @private
+   * @param {HTMLElement} container - The container element where styles should be injected.
+   * @param {string} compId - The component ID used to identify the style element.
+   * @param {(function(ComponentContext): string)|string} styleDef - The component's style definition (function or string).
+   * @param {ComponentContext} context - The current component context for style interpolation.
+   * @returns {void}
    */
-  _processEvents(container, context) {
-    container.querySelectorAll("*").forEach((el) => {
-      [...el.attributes].forEach(({ name, value }) => {
-        if (name.startsWith("@")) {
-          const event = name.slice(1);
-          const handler = TemplateEngine.evaluate(value, context);
-          if (typeof handler === "function") {
-            el.addEventListener(event, handler);
-            el.removeAttribute(name);
-          }
-        }
-      });
-    });
+  _injectStyles(container, compId, styleDef, context) {
+    /** @type {string} */
+    const newStyle =
+      typeof styleDef === "function"
+        ? TemplateEngine.parse(styleDef(context), context)
+        : styleDef;
+
+    /** @type {HTMLStyleElement|null} */
+    let styleEl = container.querySelector(`style[data-e-style="${compId}"]`);
+
+    if (styleEl && styleEl.textContent === newStyle) return;
+    if (!styleEl) {
+      styleEl = document.createElement("style");
+      styleEl.setAttribute("data-e-style", compId);
+      container.appendChild(styleEl);
+    }
+
+    styleEl.textContent = newStyle;
   }
 
   /**
-   * Injects scoped styles into the component's container.
+   * Extracts props from an element's attributes that start with the specified prefix.
+   * This method is used to collect component properties from DOM elements.
    *
-   * @param {HTMLElement} container - The container element.
-   * @param {string} compName - The component name used to identify the style element.
-   * @param {Function} styleFn - A function that returns CSS styles as a string.
-   * @param {object} context - The current context for style interpolation.
    * @private
+   * @param {HTMLElement} element - The DOM element to extract props from
+   * @param {string} prefix - The prefix to look for in attributes
+   * @returns {Record<string, string>} An object containing the extracted props
+   * @example
+   * // For an element with attributes:
+   * // <div :name="John" :age="25">
+   * // Returns: { name: "John", age: "25" }
    */
-  _injectStyles(container, compName, styleFn, context) {
-    if (styleFn) {
-      let styleEl = container.querySelector(
-        `style[data-eleva-style="${compName}"]`
-      );
-      if (!styleEl) {
-        styleEl = document.createElement("style");
-        styleEl.setAttribute("data-eleva-style", compName);
-        container.appendChild(styleEl);
+  _extractProps(element, prefix) {
+    if (!element.attributes) return {};
+
+    const props = {};
+    const attrs = element.attributes;
+
+    for (let i = attrs.length - 1; i >= 0; i--) {
+      const attr = attrs[i];
+      if (attr.name.startsWith(prefix)) {
+        const propName = attr.name.slice(prefix.length);
+        props[propName] = attr.value;
+        element.removeAttribute(attr.name);
       }
-      styleEl.textContent = TemplateEngine.parse(styleFn(context), context);
     }
+    return props;
   }
 
   /**
-   * Mounts child components within the parent component's container.
+   * Mounts all components within the parent component's container.
+   * This method handles mounting of explicitly defined children components.
+   *
+   * The mounting process follows these steps:
+   * 1. Cleans up any existing component instances
+   * 2. Mounts explicitly defined children components
    *
-   * @param {HTMLElement} container - The parent container element.
-   * @param {object} children - An object mapping child component selectors to their definitions.
-   * @param {Array} childInstances - An array to store the mounted child component instances.
    * @private
+   * @param {HTMLElement} container - The container element to mount components in
+   * @param {Object<string, ComponentDefinition>} children - Map of selectors to component definitions for explicit children
+   * @param {Array<MountResult>} childInstances - Array to store all mounted component instances
+   * @returns {Promise<void>}
+   *
+   * @example
+   * // Explicit children mounting:
+   * const children = {
+   *   'UserProfile': UserProfileComponent,
+   *   '#settings-panel': "settings-panel"
+   * };
    */
-  _mountChildren(container, children, childInstances) {
-    childInstances.forEach((child) => child.unmount());
-    childInstances.length = 0;
-
-    Object.keys(children || {}).forEach((childName) => {
-      container.querySelectorAll(childName).forEach((childEl) => {
-        const props = {};
-        [...childEl.attributes].forEach(({ name, value }) => {
-          if (name.startsWith("eleva-prop-")) {
-            props[name.slice("eleva-prop-".length)] = value;
-          }
-        });
-        const instance = this.mount(childEl, childName, props);
-        childInstances.push(instance);
-      });
-    });
+  async _mountComponents(container, children, childInstances) {
+    for (const [selector, component] of Object.entries(children)) {
+      if (!selector) continue;
+      for (const el of container.querySelectorAll(selector)) {
+        if (!(el instanceof HTMLElement)) continue;
+        /** @type {Record<string, string>} */
+        const props = this._extractProps(el, ":");
+        /** @type {MountResult} */
+        const instance = await this.mount(el, component, props);
+        if (instance && !childInstances.includes(instance)) {
+          childInstances.push(instance);
+        }
+      }
+    }
   }
 }