@mintjamsinc/ichigojs 0.1.4 → 0.1.6

package/README.md

@@ -11,7 +11,8 @@ A simple and intuitive reactive framework. Lightweight, fast, and user-friendly
 - ⚡ **Reactive Proxy System** - Automatic change detection without manual triggers
 - 🎯 **Computed Properties** - Automatic dependency tracking and re-evaluation
 - 🔄 **Two-way Binding** - `v-model` with modifiers (`.lazy`, `.number`, `.trim`)
-- 🔌 **Lifecycle Hooks** - `@mount`, `@mounted`, `@update`, `@updated`, `@unmount`, `@unmounted`
+- 🔌 **Lifecycle Hooks** - `@mount`, `@mounted`, `@update`, `@updated`, `@unmount`, `@unmounted` with context (`$ctx`)
+- 💾 **userData Storage** - Proxy-free storage for third-party library instances with auto-cleanup
 - 📦 **Lightweight** - Minimal bundle size
 - 🚀 **High Performance** - Efficient batched updates via microtask queue
 - 💪 **TypeScript** - Written in TypeScript with full type support
@@ -161,7 +162,7 @@ Supported modifiers: `.stop`, `.prevent`, `.capture`, `.self`, `.once`
 
 #### Lifecycle Hooks
 
-Lifecycle hooks allow you to run code at specific stages of an element's lifecycle:
+Lifecycle hooks allow you to run code at specific stages of an element's lifecycle. Each hook receives a **lifecycle context** (`$ctx`) with access to the element, VNode, and userData storage.
 
 ```html
 <div v-if="show"
@@ -184,29 +185,83 @@ Lifecycle hooks allow you to run code at specific stages of an element's lifecyc
 - `@unmount` - Called before the element is removed from the DOM
 - `@unmounted` - Called after the element is removed from the DOM
 
-**Use cases:**
+**Lifecycle Context (`$ctx`):**
+
+Every lifecycle hook receives a context object with:
+
+- `$ctx.element` - The DOM element
+- `$ctx.vnode` - The VNode instance
+- `$ctx.userData` - Proxy-free storage Map for user data
+
+**userData Storage:**
+
+`$ctx.userData` is a safe space to store data associated with the element's lifecycle. It's not affected by Vue's reactive proxy system, making it perfect for storing third-party library instances.
 
 ```javascript
 methods: {
-  onMounted(el) {
-    // Initialize third-party library (el is the DOM element)
-    const canvas = el.querySelector('canvas');
-    canvas._chartInstance = new Chart(canvas.getContext('2d'), { /* ... */ });
+  onMounted($ctx) {
+    // Initialize third-party library
+    const canvas = $ctx.element.querySelector('canvas');
+    const chart = new Chart(canvas.getContext('2d'), {
+      type: 'line',
+      data: { /* ... */ }
+    });
+
+    // Store in userData (Proxy-free storage)
+    $ctx.userData.set('chart', chart);
   },
-  onUpdated(el) {
-    // Update chart with new data
-    const canvas = el.querySelector('canvas');
-    canvas._chartInstance?.update();
+
+  onUpdated($ctx) {
+    // Retrieve from userData
+    const chart = $ctx.userData.get('chart');
+    if (chart) {
+      chart.data.labels = [...this.labels];
+      chart.update();
+    }
   },
-  onUnmounted(el) {
-    // Clean up resources
-    const canvas = el.querySelector('canvas');
-    canvas._chartInstance?.destroy();
-    delete canvas._chartInstance;
+
+  onUnmount($ctx) {
+    // Clean up before removal
+    const chart = $ctx.userData.get('chart');
+    if (chart) {
+      chart.destroy();
+      $ctx.userData.delete('chart');
+    }
   }
 }
 ```
 
+**Automatic Cleanup:**
+
+Objects with a `close()` method stored in `userData` are automatically cleaned up during the destroy phase:
+
+```javascript
+methods: {
+  onMounted($ctx) {
+    // Object with close() method
+    const resource = {
+      data: someData,
+      close() {
+        // Custom cleanup logic
+        console.log('Resource cleaned up');
+      }
+    };
+
+    $ctx.userData.set('myResource', resource);
+    // resource.close() will be called automatically on unmount
+  }
+}
+```
+
+**Cleanup Order:**
+
+1. `@unmount` hook fires
+2. `userData` auto-cleanup (close() methods called)
+3. Child nodes destroyed
+4. Dependencies unregistered
+5. Directive manager cleanup
+6. `@unmounted` hook fires
+
 **Works with v-if and v-for:**
 
 ```html
@@ -324,7 +379,7 @@ VDOM.createApp<AppData>({
 
 ## Examples
 
-See the [docs](https://mintjamsinc.github.io/ichigojs/) for live examples:
+See the [docs](https://www.mintjams.jp/ichigojs/) for live examples:
 
 - **Basic Usage** - Getting started with ichigo.js
 - **Todo List** - Complete task management application

package/dist/ichigo.esm.js

@@ -7672,6 +7672,13 @@ class VNode {
      * This is optional and may be undefined if the node has not been templatized.
      */
     #templatized;
+    /**
+     * User data storage for lifecycle directives.
+     * This provides a Proxy-free space where developers can store arbitrary data
+     * associated with this VNode. The data is automatically cleaned up when the
+     * VNode is destroyed.
+     */
+    #userData;
     /**
      * Creates an instance of the virtual node.
      * @param args The initialization arguments for the virtual node.
@@ -7883,6 +7890,18 @@ class VNode {
         this.#preparableIdentifiers = preparableIdentifiers.length === 0 ? [] : [...new Set(preparableIdentifiers)];
         return this.#preparableIdentifiers;
     }
+    /**
+     * Gets the user data storage for this virtual node.
+     * This is lazily initialized and provides a Proxy-free space for storing
+     * arbitrary data associated with lifecycle directives.
+     * @returns A Map for storing user data.
+     */
+    get userData() {
+        if (!this.#userData) {
+            this.#userData = new Map();
+        }
+        return this.#userData;
+    }
     /**
      * The DOM path of this virtual node.
      * This is a string representation of the path from the root to this node,
@@ -8089,6 +8108,14 @@ class VNode {
     /**
      * Cleans up any resources used by this virtual node.
      * This method is called when the virtual node is no longer needed.
+     *
+     * Cleanup order:
+     * 1. Call onUnmount lifecycle hooks
+     * 2. Auto-cleanup userData (close() on Closeable objects)
+     * 3. Recursively destroy child nodes
+     * 4. Unregister dependencies
+     * 5. Clean up directive manager
+     * 6. Call onUnmounted lifecycle hooks
      */
     destroy() {
         // If no directive requires template preservation, call onUnmount for directives that do not templatize
@@ -8097,6 +8124,23 @@ class VNode {
                 d.onUnmount?.();
             });
         }
+        // Clean up user data, calling close() on any Closeable objects
+        // This happens after onUnmount but before other cleanup, allowing users to
+        // perform custom cleanup in onUnmount while having automatic cleanup of userData
+        if (this.#userData) {
+            for (const [key, value] of this.#userData.entries()) {
+                try {
+                    // If the value has a close() method (Closeable pattern), call it
+                    if (value && typeof value === 'object' && typeof value.close === 'function') {
+                        value.close();
+                    }
+                }
+                catch (error) {
+                    this.#vApplication.logManager.getLogger(this.constructor.name).error(`Error closing user data '${key}': ${error}`);
+                }
+            }
+            this.#userData.clear();
+        }
         // Recursively destroy child nodes
         if (this.#childVNodes) {
             for (const childVNode of this.#childVNodes) {
@@ -9501,7 +9545,7 @@ class VOnDirective {
         return ['mount', 'mounted', 'update', 'updated', 'unmount', 'unmounted'].includes(eventName);
     }
     /**
-     * Creates a wrapper function for lifecycle hooks (with element parameter).
+     * Creates a wrapper function for lifecycle hooks (with context parameter).
      * @param expression The expression string to evaluate.
      * @returns A function that handles the lifecycle hook.
      */
@@ -9511,22 +9555,27 @@ class VOnDirective {
         // Return a function that handles the lifecycle hook with proper scope
         return () => {
             const bindings = vNode.bindings;
-            const el = vNode.node;
+            const $ctx = {
+                element: vNode.node,
+                vnode: vNode,
+                userData: vNode.userData
+            };
             // If the expression is just a method name, call it with bindings as 'this'
             const trimmedExpr = expression.trim();
             if (identifiers.includes(trimmedExpr) && typeof bindings?.get(trimmedExpr) === 'function') {
                 const methodName = trimmedExpr;
                 const originalMethod = bindings?.get(methodName);
-                // Call the method with bindings as 'this' context and element as parameter
-                // This allows the method to access the DOM element and bindings
-                return originalMethod(el);
+                // Call the method with bindings as 'this' context and context as parameter
+                // This allows the method to access the DOM element, VNode, and userData
+                return originalMethod($ctx);
             }
-            // For inline expressions, evaluate normally with element parameter
+            // For inline expressions, evaluate normally with $ctx parameter
+            // Note: $ctx is a reserved variable name for lifecycle context
             const values = identifiers.map(id => vNode.bindings?.get(id));
-            const args = [...identifiers, 'el'].join(", ");
+            const args = [...identifiers, '$ctx'].join(", ");
             const funcBody = `return (${expression});`;
             const func = new Function(args, funcBody);
-            return func.call(bindings?.raw, ...values, el);
+            return func.call(bindings?.raw, ...values, $ctx);
         };
     }
     /**