@jasonshimmy/custom-elements-runtime 0.1.12 → 0.1.13

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Custom Elements Runtime
  * Lightweight, strongly typed, functional custom element runtime for two-way binding, event, and prop support.
- * Supports: state, computed, props, style, render, lifecycle hooks, #model-* and data-on-* attributes.
+ * Supports: state, computed, props, style, render, lifecycle hooks, :model and @event attributes.
  * No external dependencies. Mobile-first, secure, and developer friendly.
  */
 export * from "./runtime/types";

package/dist/runtime/template-compiler.d.ts

@@ -12,7 +12,7 @@ export declare function parseProps(str: string, values?: unknown[], context?: Re
     }>;
 };
 /**
- * Internal implementation allowing an optional compile context for #model.
+ * Internal implementation allowing an optional compile context for :model.
  * Fixes:
  *  - Recognize interpolation markers embedded in text ("World{{1}}") and replace them.
  *  - Skip empty arrays from directives so markers don't leak as text.

package/dist/runtime/vdom.d.ts

@@ -6,35 +6,78 @@
 import type { VNode, VDomRefs } from "./types";
 /**
  * Recursively clean up refs for all descendants of a node
+ * @param node The node to clean up.
+ * @param refs The refs to clean up.
+ * @returns
  */
 export declare function cleanupRefs(node: Node, refs?: VDomRefs): void;
 /**
  * Get nested property value from object using dot notation
+ * @param obj The object to search.
+ * @param path The dot-separated path to the property.
+ * @returns The value of the nested property, or undefined if not found.
  */
 export declare function getNestedValue(obj: any, path: string): any;
 /**
  * Set nested property value in object using dot notation
+ * @param obj
+ * @param path
+ * @param value
+ * @returns
  */
 export declare function setNestedValue(obj: any, path: string, value: any): void;
 /**
- * Process #model directive for two-way data binding
+ * Process :model directive for two-way data binding
+ * @param value
+ * @param modifiers
+ * @param props
+ * @param attrs
+ * @param listeners
+ * @param context
+ * @param el
+ * @returns
  */
 export declare function processModelDirective(value: string, modifiers: string[], props: Record<string, any>, attrs: Record<string, any>, listeners: Record<string, EventListener>, context?: any, el?: HTMLElement): void;
 /**
- * Process #bind directive for attribute/property binding
+ * Process :bind directive for attribute/property binding
+ * @param value
+ * @param props
+ * @param attrs
+ * @param context
+ * @returns
  */
 export declare function processBindDirective(value: string, props: Record<string, any>, attrs: Record<string, any>, context?: any): void;
 /**
- * Process #show directive for conditional display
+ * Process :show directive for conditional display
+ * @param value
+ * @param attrs
+ * @param context
+ * @returns
  */
 export declare function processShowDirective(value: string, attrs: Record<string, any>, context?: any): void;
 /**
- * Process #class directive for conditional CSS classes
+ * Process :class directive for conditional CSS classes
+ * @param value
+ * @param attrs
+ * @param context
+ * @returns
  */
 export declare function processClassDirective(value: string, attrs: Record<string, any>, context?: any): void;
+/**
+ * Process :style directive for dynamic inline styles
+ * @param value
+ * @param attrs
+ * @param context
+ * @returns
+ */
 export declare function processStyleDirective(value: any, attrs: Record<string, any>, context?: any): void;
 /**
  * Process directives and return merged props, attrs, and event listeners
+ * @param directives
+ * @param context
+ * @param el
+ * @param vnodeAttrs
+ * @returns
  */
 export declare function processDirectives(directives: Record<string, {
     value: any;
@@ -44,24 +87,61 @@ export declare function processDirectives(directives: Record<string, {
     attrs: Record<string, any>;
     listeners: Record<string, EventListener>;
 };
+/**
+ * Assign unique keys to VNodes for efficient rendering
+ * @param nodeOrNodes
+ * @param baseKey
+ * @returns
+ */
 export declare function assignKeysDeep(nodeOrNodes: VNode | VNode[], baseKey: string): VNode | VNode[];
 /**
  * Patch props on an element.
  * Only update changed props, remove old, add new.
+ * @param el
+ * @param oldProps
+ * @param newProps
+ * @param context
  */
 export declare function patchProps(el: HTMLElement, oldProps: Record<string, any>, newProps: Record<string, any>, context?: any): void;
+/**
+ * Create a DOM element from a VNode.
+ * @param vnode
+ * @param context
+ * @param refs
+ * @returns
+ */
 export declare function createElement(vnode: VNode | string, context?: any, refs?: VDomRefs): Node;
 /**
  * Patch children using keys for node matching.
+ * @param parent
+ * @param oldChildren
+ * @param newChildren
+ * @param context
+ * @param refs
+ * @returns
  */
 export declare function patchChildren(parent: HTMLElement, oldChildren: VNode[] | string | undefined, newChildren: VNode[] | string | undefined, context?: any, refs?: VDomRefs): void;
 /**
  * Patch a node using keys for node matching.
+ * @param dom
+ * @param oldVNode
+ * @param newVNode
+ * @param context
+ * @param refs
+ * @returns
  */
 export declare function patch(dom: Node, oldVNode: VNode | string | null, newVNode: VNode | string | null, context?: any, refs?: VDomRefs): Node;
 /**
- * Main renderer: uses patching and keys for node reuse.
- * Never uses innerHTML. Only updates what has changed.
+ * Virtual DOM renderer.
+ * @param root The root element to render into.
+ * @param vnodeOrArray The virtual node or array of virtual nodes to render.
+ * @param context The context to use for rendering.
+ * @param refs The refs to use for rendering.
  */
 export declare function vdomRenderer(root: ShadowRoot, vnodeOrArray: VNode | VNode[], context?: any, refs?: VDomRefs): void;
+/**
+ * Render a VNode to a string.
+ * @param vnode The virtual node to render.
+ * @returns The rendered HTML string.
+ */
 export declare function renderToString(vnode: VNode): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jasonshimmy/custom-elements-runtime",
   "description": "A powerful, modern, and lightweight runtime for creating reactive web components with TypeScript",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "type": "module",
   "keywords": [
     "web-components",