eleva 0.1.0-alpha → 1.1.0-alpha

package/README.md

@@ -1 +1,409 @@
-# eleva
+# Eleva
+
+**A minimalist, lightweight, pure vanilla JavaScript frontend runtime framework.**  
+_Built with love for native JavaScript—because sometimes, less really is more!_ 😊
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Version](https://img.shields.io/npm/v/eleva.svg?style=flat)](https://www.npmjs.com/package/eleva)
+![100% Javascript](https://img.shields.io/github/languages/top/TarekRaafat/eleva?color=yellow)
+![Zero Dependencies](https://img.shields.io/badge/Dependencies-0-green.svg)
+[![Minified Size](https://badgen.net/bundlephobia/min/eleva@latest)](https://bundlephobia.com/package/eleva@latest)
+[![Gzipped Size](https://badgen.net/bundlephobia/minzip/eleva@latest)](https://bundlephobia.com/package/eleva@latest)
+
+<!-- [![](https://data.jsdelivr.com/v1/package/npm/eleva/badge)](https://www.jsdelivr.com/package/npm/eleva) -->
+
+> **Stability Notice**: This is `v1.1.0-alpha` - APIs may change significantly until the stable release.  
+> Not recommended for production use yet. Follow the [versioning guide](#version-guide) for updates.
+
+**Version:** `1.1.0-alpha`
+
+Welcome to Eleva! This is my humble, experimental playground for a fresh approach to frontend development. Eleva was born out of my genuine passion for pure vanilla JavaScript—no frameworks, no bloat, just the power of native code. I hope you'll have fun exploring, testing, and contributing to make Eleva even better. 🚀
+
+---
+
+## Table of Contents
+
+- [Eleva](#eleva)
+  - [Table of Contents](#table-of-contents)
+  - [Introduction](#introduction)
+  - [Design Philosophy](#design-philosophy)
+  - [Handcrafted \& Developer-Centric Design](#handcrafted--developer-centric-design)
+  - [Features](#features)
+  - [When to Use Eleva](#when-to-use-eleva)
+  - [Version Strategy](#version-strategy)
+  - [Version Guide](#version-guide)
+  - [Performance](#performance)
+  - [Performance Benchmarks](#performance-benchmarks)
+  - [Eleva vs. Popular Frameworks](#eleva-vs-popular-frameworks)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [ES Module Example](#es-module-example)
+    - [UMD Example](#umd-example)
+  - [API Reference](#api-reference)
+    - [TemplateEngine](#templateengine)
+    - [Signal](#signal)
+    - [Emitter](#emitter)
+    - [Renderer](#renderer)
+    - [Eleva (Core)](#eleva-core)
+  - [Development](#development)
+  - [Testing](#testing)
+  - [Contributing](#contributing)
+  - [License](#license)
+  - [Contact](#contact)
+
+---
+
+## Introduction
+
+Eleva is a lightweight, no-nonsense runtime framework for frontend applications. Built with love for **pure vanilla JavaScript**, Eleva lets you create highly modular and scalable applications without the overhead of large frameworks. I built Eleva to prove that you don't need heavy libraries to build amazing user interfaces—sometimes, the simplest approach is the most powerful.
+
+**My Inspiration:**  
+The idea behind Eleva comes from a deep appreciation for native JavaScript. I wanted to create a tool that stays true to the language without introducing new syntax or complexity, making it easy to integrate into your projects.
+
+**Core Principles:**
+
+- **🌱 Minimalism:** Only the essentials, so you can build without clutter.
+- **🔌 Extensibility:** Plug in your own ideas—custom state management, routing, and more.
+- **🚀 Performance:** Fast, efficient, and designed with modern browsers in mind.
+- **🍦 Pure Vanilla:** No dependencies, no magic—just plain JavaScript.
+
+---
+
+## Design Philosophy
+
+**Eleva is an unopinionated library.**
+
+Unlike many frameworks that enforce a specific project structure or coding paradigm, Eleva provides a minimal core with a flexible plugin system. This means:
+
+- **🔄 Flexibility:** Architect your application your way—no rigid structure required.
+- **🎯 Native JavaScript:** Built using pure vanilla JavaScript, Eleva integrates seamlessly with your existing code without unfamiliar syntax.
+- **⚙️ Configurability:** Extend Eleva's functionality with a simple API and optional plugins.
+- **🆓 Freedom:** Decide the best way to implement features without unnecessary constraints.
+
+This unopinionated approach makes Eleva versatile and ideal for developers who want full control over their application's design.
+
+---
+
+## Handcrafted & Developer-Centric Design
+
+Eleva is built with meticulous attention to detail and a deep passion for pure vanilla JavaScript. Every aspect of its design and architecture is handcrafted with the developer in mind. This makes Eleva not only innovative but also a solid foundation for your projects.
+
+- **🎨 Craftsmanship:** Every line of code is written with care, keeping the library lightweight, efficient, and easy to understand.
+- **🛠️ Developer-Centric:** Its intuitive API and minimal core mean you spend less time wrestling with the framework and more time building your application.
+- **🌟 Innovative & Fresh:** Stick to pure vanilla JavaScript and avoid unnecessary abstractions.
+- **🏗️ Solid & Reliable:** Focused on performance and modularity, Eleva scales with your project’s needs.
+
+This unique, developer-first approach makes Eleva a standout choice for building high-performance frontend applications without compromising on simplicity or control.
+
+---
+
+## Features
+
+- **🧩 Component-Based Architecture:** Create reusable UI components effortlessly.
+- **⚡ Signal-Based Reactivity:** Fine-grained reactivity that updates only what’s needed.
+- **🔔 Event Handling:** Built-in event emitter for robust inter-component communication.
+- **📝 Template Parsing:** Secure and dynamic interpolation with a custom TemplateEngine.
+- **🔄 DOM Diffing & Patching:** High-performance updates without a virtual DOM.
+- **📦 UMD & ES Module Builds:** Supports modern build tools and browser environments.
+- **🤝 Friendly API:** A gentle learning curve for both beginners and seasoned developers.
+- **💎 Tiny Footprint & TypeScript Support:** Approximately ~4 KB minified with built-in TypeScript declarations, to keep your bundle lean and your codebase strongly typed.
+
+---
+
+## When to Use Eleva
+
+Eleva is ideal for developers seeking a lightweight, flexible, and high-performance solution for building frontend applications. Here are some scenarios where Eleva shines:
+
+- **🚀 Small to Medium Projects:** Perfect for web apps or websites that don’t require the overhead of a full-fledged framework.
+- **⚡ Performance-Critical Applications:** Optimized reactivity and DOM diffing ensure smooth performance without bloat.
+- **🔄 Unopinionated & Flexible:** Architect your application your way with a straightforward API and plugin system.
+- **🎯 Developer-Friendly:** Stick to pure vanilla JavaScript with familiar syntax and built-in TypeScript support.
+- **🧪 Rapid Prototyping:** Quickly prototype ideas with a minimal and extendable framework.
+- **🔌 Extensible:** Easily add features like routing or state management through plugins.
+
+---
+
+## Version Strategy
+
+I believe in clear versioning that reflects the maturity of the project:
+
+- **Pre-release Versions (Alpha/Beta):** Early versions like `1.1.0-alpha` indicate the API is still evolving. Expect frequent updates and share your feedback!
+- **Semantic Versioning:** Once stable, I’ll follow semantic versioning strictly to clearly communicate any breaking changes.
+- **Fresh Start:** This release (`1.1.0-alpha`) marks a significant update with new features and improvements.
+
+---
+
+## Version Guide
+
+I follow [Semantic Versioning (SemVer)](https://semver.org/):
+
+- **🔢 Major Version:** Breaking changes or major overhauls (e.g., from `1.0.0` to `2.0.0`).
+- **🔢 Minor Version:** New features in a backward-compatible manner (e.g., from `1.0.0` to `1.1.0`).
+- **🔢 Patch Version:** Backward-compatible bug fixes and minor improvements (e.g., `1.0.1`).
+- **📌 Pre-release Identifiers:** Suffixes like `-alpha`, `-beta`, or `-rc` denote unstable releases (e.g., `1.1.0-alpha`).
+
+---
+
+## Performance
+
+Eleva is crafted for performance:
+
+- **Lightweight:** Approximately ~4 KB minified and ~1.9 KB gzipped.
+- **Efficient Reactivity:** Signal-based updates ensure only necessary DOM parts are updated.
+- **Optimized Diffing:** Renderer efficiently patches changes without the overhead of a virtual DOM.
+- **No Bloat:** Pure vanilla JavaScript with zero dependencies keeps your project nimble.
+
+---
+
+## Performance Benchmarks
+
+Preliminary benchmarks illustrate Eleva’s efficiency compared to popular frameworks:
+
+| Framework | Bundle Size (minified) | Initial Load Time | DOM Update Speed |
+| --------- | ---------------------- | ----------------- | ---------------- |
+| **Eleva** | **~4 KB**              | **~35 ms**        | **~2 ms**        |
+| React     | ~110 KB                | ~100 ms           | ~4 ms            |
+| Vue       | ~80 KB                 | ~80 ms            | ~3 ms            |
+| Angular   | ~500 KB                | ~250 ms           | ~6 ms            |
+
+> ⚠️ **Disclaimer:** Benchmarks are based on internal tests with a minimal counter component and may vary by project and environment.
+
+---
+
+## Eleva vs. Popular Frameworks
+
+Eleva offers a refreshing alternative to frameworks like React, Vue, and Angular:
+
+- **Simplicity:** No virtual DOM, JSX, or complex state management—just plain JavaScript.
+- **Modularity:** Easily extend via plugins to suit your project’s needs.
+- **Size:** A fraction of the size of mainstream frameworks.
+- **Learning Curve:** Familiar syntax and a clear API make it accessible to all developers.
+
+_Note:_ Eleva isn’t trying to replace these giants but provides a lightweight option when you want simplicity and speed. 🌟
+
+---
+
+## Installation
+
+Eleva is available on npm. Try it out and share your thoughts!
+
+```bash
+npm install eleva
+```
+
+Or include it directly via CDN:
+
+```html
+<!-- unpkg -->
+<script src="https://unpkg.com/eleva/dist/eleva.min.js"></script>
+```
+
+```html
+<!-- jsDelivr -->
+<script src="https://cdn.jsdelivr.net/npm/eleva/dist/eleva.min.js"></script>
+```
+
+---
+
+## Usage
+
+### ES Module Example
+
+```js
+// Import Eleva (using ES modules)
+import Eleva from "eleva";
+
+// Create a new Eleva instance
+const app = new Eleva("MyApp");
+
+// Define a component
+app.component("HelloWorld", {
+  // The setup method is optional; if omitted, an empty state is used.
+  setup({ signal }) {
+    const count = signal(0);
+    return { count };
+  },
+  template: ({ count }) => `
+    <div>
+      <h1>Hello, Eleva! 👋</h1>
+      <p>Count: ${count}</p>
+      <button @click="() => count++">Increment</button>
+    </div>
+  `,
+});
+
+// Mount the component to a DOM element (not a selector).
+app.mount(document.getElementById("app"), "HelloWorld");
+```
+
+### UMD Example
+
+Include Eleva via a script tag and use the global variable:
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Eleva Example</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script src="https://unpkg.com/eleva/dist/eleva.min.js"></script>
+    <script>
+      const app = new Eleva("MyApp");
+      app.component("HelloWorld", {
+        setup({ signal }) {
+          const count = signal(0);
+          return { count };
+        },
+        template: ({ count }) => `
+          <div>
+            <h1>Hello, Eleva! 👋</h1>
+            <p>Count: ${count}</p>
+            <button @click="() => count++">Increment</button>
+          </div>
+        `,
+      });
+      app.mount(document.getElementById("app"), "HelloWorld");
+    </script>
+  </body>
+</html>
+```
+
+---
+
+## API Reference
+
+### TemplateEngine
+
+- **`TemplateEngine.parse(template, data)`**  
+  Replaces `{{ expression }}` patterns in the template with evaluated values.
+- **`TemplateEngine.evaluate(expr, data)`**  
+  Safely evaluates JavaScript expressions within a given context.
+
+### Signal
+
+- **`new Signal(value)`**  
+  Creates a reactive data holder.
+- **`.value` (getter/setter)**  
+  Get or update the current value and trigger watchers.
+- **`.watch(fn)`**  
+  Registers a function to run when the value updates.
+
+### Emitter
+
+- **`.on(event, handler)`**  
+  Listen to events.
+- **`.off(event, handler)`**  
+  Remove event listeners.
+- **`.emit(event, ...args)`**  
+  Trigger events with additional arguments.
+
+### Renderer
+
+- **`patchDOM(container, newHtml)`**  
+  Efficiently update the DOM.
+- **`diff(oldParent, newParent)`**  
+  Compare and update DOM trees.
+- **`updateAttributes(oldEl, newEl)`**  
+  Sync element attributes.
+
+### Eleva (Core)
+
+- **`new Eleva(name, config)`**  
+  Create an Eleva instance.
+- **`.use(plugin, options)`**  
+  Install plugins.
+- **`.component(name, definition)`**  
+  Register a component.
+- **`.mount(container, compName, props)`**  
+  Mount a component to the DOM.  
+  _Note:_ This method now expects a DOM element (not a CSS selector) and supports both global component names (strings) and direct component definitions (objects). It returns a Promise, ensuring consistent asynchronous handling.
+
+For detailed API documentation, please check the [docs](docs/index.md) folder.
+
+---
+
+## Development
+
+I welcome developers to dive in and experiment with Eleva! Here’s how to get started locally:
+
+1. **Clone the Repository:**
+
+   ```bash
+   git clone https://github.com/TarekRaafat/eleva.git
+   cd eleva
+   ```
+
+2. **Install Dependencies:**
+
+   ```bash
+   npm install
+   ```
+
+3. **Run in Development Mode (Watch):**
+
+   ```bash
+   npm run dev
+   ```
+
+4. **Build for Production:**
+
+   ```bash
+   npm run build
+   ```
+
+5. **Generate and Bundle TypeScript Declarations:**
+
+   ```bash
+   npm run build:types
+   npm run build:types:bundle
+   ```
+
+---
+
+## Testing
+
+I use Jest for testing. Run the test suite with:
+
+```bash
+npm test
+```
+
+Contributions to tests are very welcome! 🧪
+
+---
+
+## Contributing
+
+I’d love to have you onboard as a contributor! Whether you're adding new features, squashing bugs, or sharing ideas, your input is invaluable. Please check out [CONTRIBUTING](CONTRIBUTING.md) for guidelines on getting started.
+
+---
+
+## License
+
+Eleva is open-source and available under the [MIT License](LICENSE).
+
+---
+
+## Contact
+
+- **Author:** [Tarek Raafat](https://github.com/TarekRaafat)
+- **Email:** [tarek.m.raafat@gmail.com](mailto:tarek.m.raafat@gmail.com)
+- **Website:** [tarekraafat.com](https://www.tarekraafat.com)
+
+---
+
+**Note:** This is an alpha release. I'm still polishing things up, so expect some bumps along the way. Your feedback and contributions will help shape Eleva into something truly amazing. Let’s build something great together! 💪✨
+
+---
+
+[![NPM](https://nodei.co/npm/eleva.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/eleva/)
+
+---
+
+[Documentation](/docs/index.md) |
+[Examples](/examples) |
+[Changelog](/changelog.md) |
+[GitHub Discussions](https://github.com/TarekRaafat/eleva/discussions)

package/dist/eleva.d.ts

@@ -0,0 +1,207 @@
+/**
+ * @class 🎙️ Emitter
+ * @classdesc Robust inter-component communication with event bubbling.
+ * Implements a basic publish-subscribe pattern for event handling, allowing components
+ * to communicate through custom events.
+ */
+declare class Emitter {
+    /** @type {Object.<string, Function[]>} */
+    events: {
+        [x: string]: Function[];
+    };
+    /**
+     * Registers an event handler for the specified event.
+     *
+     * @param {string} event - The name of the event.
+     * @param {function(...any): void} handler - The function to call when the event is emitted.
+     */
+    on(event: string, handler: (...args: any[]) => void): void;
+    /**
+     * Removes a previously registered event handler.
+     *
+     * @param {string} event - The name of the event.
+     * @param {function(...any): void} handler - The handler function to remove.
+     */
+    off(event: string, handler: (...args: any[]) => void): void;
+    /**
+     * Emits an event, invoking all handlers registered for that event.
+     *
+     * @param {string} event - The event name.
+     * @param {...any} args - Additional arguments to pass to the event handlers.
+     */
+    emit(event: string, ...args: any[]): void;
+}
+
+/**
+ * @class 🎨 Renderer
+ * @classdesc Handles DOM patching, diffing, and attribute updates.
+ * Provides methods for efficient DOM updates by diffing the new and old DOM structures
+ * and applying only the necessary changes.
+ */
+declare class Renderer {
+    /**
+     * Patches the DOM of a container element with new HTML content.
+     *
+     * @param {HTMLElement} container - The container element to patch.
+     * @param {string} newHtml - The new HTML content to apply.
+     */
+    patchDOM(container: HTMLElement, newHtml: string): void;
+    /**
+     * Diffs two DOM trees (old and new) and applies updates to the old DOM.
+     *
+     * @param {HTMLElement} oldParent - The original DOM element.
+     * @param {HTMLElement} newParent - The new DOM element.
+     */
+    diff(oldParent: HTMLElement, newParent: HTMLElement): void;
+    /**
+     * Updates the attributes of an element to match those of a new element.
+     *
+     * @param {HTMLElement} oldEl - The element to update.
+     * @param {HTMLElement} newEl - The element providing the updated attributes.
+     */
+    updateAttributes(oldEl: HTMLElement, newEl: HTMLElement): void;
+}
+
+/**
+ * @typedef {Object} ComponentDefinition
+ * @property {function(Object<string, any>): (Object<string, any>|Promise<Object<string, any>>)} [setup]
+ *           A setup function that initializes the component state and returns an object or a promise that resolves to an object.
+ * @property {function(Object<string, any>): string} template
+ *           A function that returns the HTML template string for the component.
+ * @property {function(Object<string, any>): string} [style]
+ *           An optional function that returns scoped CSS styles as a string.
+ * @property {Object<string, ComponentDefinition>} [children]
+ *           An optional mapping of CSS selectors to child component definitions.
+ */
+/**
+ * @class 🧩 Eleva
+ * @classdesc Signal-based component runtime framework with lifecycle hooks, scoped styles, and plugin support.
+ * Manages component registration, plugin integration, event handling, and DOM rendering.
+ */
+declare class Eleva {
+    /**
+     * Creates a new Eleva instance.
+     *
+     * @param {string} name - The name of the Eleva instance.
+     * @param {Object<string, any>} [config={}] - Optional configuration for the instance.
+     */
+    constructor(name: string, config?: {
+        [x: string]: any;
+    });
+    /** @type {string} */
+    name: string;
+    /** @type {Object<string, any>} */
+    config: {
+        [x: string]: any;
+    };
+    /** @type {Object<string, ComponentDefinition>} */
+    _components: {
+        [x: string]: ComponentDefinition;
+    };
+    /** @type {Array<Object>} */
+    _plugins: Array<Object>;
+    /** @private */
+    private _lifecycleHooks;
+    /** @private {boolean} */
+    private _isMounted;
+    emitter: Emitter;
+    renderer: Renderer;
+    /**
+     * Integrates a plugin with the Eleva framework.
+     *
+     * @param {Object} plugin - The plugin object which should have an `install` function.
+     * @param {Object<string, any>} [options={}] - Optional options to pass to the plugin.
+     * @returns {Eleva} The Eleva instance (for chaining).
+     */
+    use(plugin: Object, options?: {
+        [x: string]: any;
+    }): Eleva;
+    /**
+     * Registers a component with the Eleva instance.
+     *
+     * @param {string} name - The name of the component.
+     * @param {ComponentDefinition} definition - The component definition including setup, template, style, and children.
+     * @returns {Eleva} The Eleva instance (for chaining).
+     */
+    component(name: string, definition: ComponentDefinition): Eleva;
+    /**
+     * Mounts a registered component to a DOM element.
+     *
+     * @param {HTMLElement} container - A DOM element where the component will be mounted.
+     * @param {string|ComponentDefinition} compName - The name of the component to mount or a component definition.
+     * @param {Object<string, any>} [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 {Error} If the container is not found or if the component is not registered.
+     */
+    mount(container: HTMLElement, compName: string | ComponentDefinition, props?: {
+        [x: string]: any;
+    }): object | Promise<object>;
+    /**
+     * Prepares default no-operation lifecycle hook functions.
+     *
+     * @returns {Object<string, function(): void>} An object with keys for lifecycle hooks mapped to empty functions.
+     * @private
+     */
+    private _prepareLifecycleHooks;
+    /**
+     * Processes DOM elements for event binding based on attributes starting with "@".
+     *
+     * @param {HTMLElement} container - The container element in which to search for events.
+     * @param {Object<string, any>} context - The current context containing event handler definitions.
+     * @private
+     */
+    private _processEvents;
+    /**
+     * Injects scoped styles into the component's container.
+     *
+     * @param {HTMLElement} container - The container element.
+     * @param {string} compName - The component name used to identify the style element.
+     * @param {function(Object<string, any>): string} [styleFn] - A function that returns CSS styles as a string.
+     * @param {Object<string, any>} context - The current context for style interpolation.
+     * @private
+     */
+    private _injectStyles;
+    /**
+     * Mounts child components within the parent component's container.
+     *
+     * @param {HTMLElement} container - The parent container element.
+     * @param {Object<string, ComponentDefinition>} [children] - An object mapping child component selectors to their definitions.
+     * @param {Array<object>} childInstances - An array to store the mounted child component instances.
+     * @private
+     */
+    private _mountChildren;
+}
+type ComponentDefinition = {
+    /**
+     * A setup function that initializes the component state and returns an object or a promise that resolves to an object.
+     */
+    setup?: ((arg0: {
+        [x: string]: any;
+    }) => ({
+        [x: string]: any;
+    } | Promise<{
+        [x: string]: any;
+    }>)) | undefined;
+    /**
+     *           A function that returns the HTML template string for the component.
+     */
+    template: (arg0: {
+        [x: string]: any;
+    }) => string;
+    /**
+     * An optional function that returns scoped CSS styles as a string.
+     */
+    style?: ((arg0: {
+        [x: string]: any;
+    }) => string) | undefined;
+    /**
+     * An optional mapping of CSS selectors to child component definitions.
+     */
+    children?: {
+        [x: string]: ComponentDefinition;
+    } | undefined;
+};
+
+//# sourceMappingURL=index.d.ts.map
+
+export { Eleva as default };