@adaas/are-html 0.0.2

package/src/directives/AreDirectiveIf.directive.ts

@@ -0,0 +1,130 @@
+import { A_Caller, A_Inject, A_Scope } from "@adaas/a-concept";
+import { A_Logger } from "@adaas/a-utils/a-logger";
+import { AreDirectiveAttribute } from "@adaas/are-html/attributes/AreDirective.attribute";
+import {  AreScene, AreStore, AreSyntax } from "@adaas/are";
+import { AreDirective } from "@adaas/are-html/directive/AreDirective.component";
+import { AddCommentInstruction } from "@adaas/are-html/instructions/AddComment.instruction";
+import { AreDirectiveContext } from "@adaas/are-html/directive/AreDirective.context";
+
+
+
+@AreDirective.Priority(2)
+export class AreDirectiveIf extends AreDirective {
+
+
+    @AreDirective.Transform
+    transform(
+        @A_Inject(A_Caller) attribute: AreDirectiveAttribute,
+        @A_Inject(A_Scope) scope: A_Scope,
+
+        @A_Inject(AreStore) store: AreStore,
+        @A_Inject(AreScene) scene: AreScene,
+        @A_Inject(A_Logger) logger: A_Logger,
+        ...args: any[]
+    ) {
+        logger.debug(`[Transform] directive $IF for <${attribute.owner.aseid.toString()}>`)
+
+        const node = attribute.owner;
+
+        /**
+         * We have to keep this node as a group node, and copy all data into the child node that would be actual node. 
+         */
+        const ifTemplate = node.cloneWithScope();
+
+        const ifAttr = ifTemplate.attributes.find(d => d.name === attribute.name);
+
+        if (ifAttr) {
+            ifTemplate.scope.deregister(ifAttr);
+            node.scope.register(ifAttr);
+        }
+
+        node.init();
+
+        node.addChild(ifTemplate);
+
+        /**
+         * Resolve or create a directive context for the item node. This is needed to hold the item-specific store values (e.g. the "item" and "index" in a "for" loop) that the template's bindings will reference during compile and update. The context is shared among all clones of the same template, but that's fine because each clone gets its own scope values assigned here.
+         */
+        // let directiveContext = ifTemplate.scope.resolveFlat(AreDirectiveContext);
+
+        // if (!directiveContext) {
+        //     directiveContext = new AreDirectiveContext(ifTemplate.aseid);
+        //     ifTemplate.scope.register(directiveContext);
+        // }
+
+        ifTemplate.scene.deactivate();
+
+        attribute.template = ifTemplate;
+
+    }
+
+
+    @AreDirective.Compile
+    compile(
+        @A_Inject(A_Caller) attribute: AreDirectiveAttribute,
+        @A_Inject(AreStore) store: AreStore,
+        @A_Inject(AreScene) scene: AreScene,
+        @A_Inject(AreSyntax) syntax: AreSyntax,
+
+        @A_Inject(AreDirectiveContext) directiveContext?: AreDirectiveContext,
+        ...args: any[]
+    ): void {
+
+        console.log('Compiling directive "if" with attribute content:', attribute);
+
+        /**
+         * 1. Extract the value from the store based on the attribute content 
+         *    (which is the path to the value in the store)
+         */
+        attribute.value = syntax.evaluate(attribute.content, store, {
+            ...(directiveContext?.scope || {}),
+        });
+
+        /**
+         * 2. If the value is falsy, remove the node from the scene by planning a RemoveElement instruction.
+         *    If the value is truthy, ensure the node is in the scene by planning an AddElement instruction if it's not already planned.
+         */
+        const hostInstruction = scene.host!;
+        const commentIdentifier = ` --- if: ${attribute.template!.id} --- `;
+        const declaration = new AddCommentInstruction({ content: commentIdentifier })
+
+        scene.setHost(declaration);
+        scene.planBefore(declaration, hostInstruction);
+        scene.unPlan(hostInstruction);
+
+        if (attribute.value)
+            attribute.template!.scene.activate();
+        else
+            attribute.template!.scene.deactivate();
+    }
+
+
+
+    @AreDirective.Update
+    update(
+        @A_Inject(A_Caller) attribute: AreDirectiveAttribute,
+        @A_Inject(AreStore) store: AreStore,
+        @A_Inject(A_Scope) scope: A_Scope,
+        @A_Inject(AreSyntax) syntax: AreSyntax,
+        @A_Inject(AreScene) scene: AreScene,
+        ...args: any[]
+    ): void {
+        /**
+         * 1. Extract the value from the store based on the attribute content 
+         *    (which is the path to the value in the store)
+         */
+        attribute.value = syntax.evaluate(attribute.content, store);
+
+        if (attribute.value) {
+            attribute.template!.scene.activate();
+
+            attribute.template!.mount()
+        }
+        else {
+            attribute.template!.unmount();
+
+            attribute.template!.scene.deactivate();
+        }
+    }
+
+}

package/src/engine/AreHTML.compiler.ts

@@ -0,0 +1,226 @@
+import { A_Caller, A_Dependency, A_Feature, A_FormatterHelper, A_Inject } from "@adaas/a-concept";
+import { A_Logger } from "@adaas/a-utils/a-logger";
+import { A_Frame } from "@adaas/a-frame";
+import { AreCompiler, AreScene, AreCompilerError, AreStore } from "@adaas/are";
+import { AreDirectiveAttribute } from "@adaas/are-html/attributes/AreDirective.attribute";
+import { AreStaticAttribute } from "@adaas/are-html/attributes/AreStatic.attribute";
+import { AreDirectiveFeatures } from "@adaas/are-html/directive/AreDirective.constants";
+import { AreEventAttribute } from "@adaas/are-html/attributes/AreEvent.attribute";
+import { AreBindingAttribute } from "@adaas/are-html/attributes/AreBinding.attribute";
+import { AreInterpolation } from "@adaas/are-html/nodes/AreInterpolation";
+import { AreText } from "@adaas/are-html/nodes/AreText";
+import { AddAttributeInstruction} from "@adaas/are-html/instructions/AddAttribute.instruction";
+import { AddTextInstruction} from "@adaas/are-html/instructions/AddText.instruction";
+import { AddListenerInstruction} from "@adaas/are-html/instructions/AddListener.instruction";
+
+
+
+
+@A_Frame.Component({
+    namespace: 'A-ARE',
+    name: 'AreHTMLCompiler',
+    description: 'HTML-specific compiler for A-Concept Rendering Engine (ARE) components, extending the base AreCompiler to handle HTML templates, styles, and rendering logic tailored for web environments.'
+})
+export class AreHTMLCompiler extends AreCompiler {
+
+    // compile(
+    //     @A_Inject(A_Caller) node: AreHTMLNode,
+    //     @A_Inject(AreScene) scene: AreScene,
+    //     ...args: any[]
+    // ): void {
+    //     super.compile(node, scene, ...args);
+    // }
+
+    // -----------------------------------------------------------------------------------------
+    // -------------------------Are-Interpolation Compile Section-----------------------------------
+    // -----------------------------------------------------------------------------------------
+    /**
+     * Default compile method for interpolations, which can be overridden by specific implementations if needed.
+     * 
+     * @param interpolation 
+     * @param scope 
+     * @param scene 
+     * @param store 
+     * @param feature 
+     */
+    @AreCompiler.Compile(AreInterpolation)
+    compileInterpolation(
+        @A_Inject(A_Caller) interpolation: AreInterpolation,
+        @A_Inject(AreScene) scene: AreScene,
+
+        @A_Inject(AreStore) store: AreStore,
+        @A_Inject(A_Logger) logger?: A_Logger,
+        ...args: any[]
+    ) {
+        // if (scene.host)
+        //     console.log('Scene Host: ', scene.host);
+
+        // let content = '';
+
+        // logger?.debug('green', `AreHTMLCompiler: compile interpolation <${interpolation.aseid.toString()}> with key: "${interpolation.content}"`, store.get(interpolation.content));
+
+        // try {
+        //     content = AreCommonHelper.evaluate(interpolation.content, store);
+
+        // } catch (error) {
+        //     content = ''
+        // }
+
+        scene.plan(new AddTextInstruction({ content: interpolation.content, evaluate: true }));
+    }
+
+    // -----------------------------------------------------------------------------------------
+    // ------------------------------Are-Text Compile Section-----------------------------------
+    // -----------------------------------------------------------------------------------------
+    @AreCompiler.Compile(AreText)
+    compileText(
+        @A_Inject(A_Caller) text: AreText,
+        @A_Inject(AreScene) scene: AreScene,
+        @A_Inject(A_Logger) logger?: A_Logger,
+        ...args: any[]
+    ) {
+        logger?.debug('cyan', `AreHTMLCompiler: compile text node <${text.aseid.toString()}> with content: "${text.content}"`);
+        if (scene.host)
+            scene.unPlan(scene.host);
+
+        scene.plan(new AddTextInstruction({ content: text.content }));
+
+    }
+
+    // -----------------------------------------------------------------------------------------
+    // -------------------------Are-Attribute Compile Section-----------------------------------
+    // -----------------------------------------------------------------------------------------
+
+    @AreCompiler.Compile(AreStaticAttribute)
+    compileStaticAttribute(
+        @A_Inject(A_Caller) attribute: AreStaticAttribute,
+        @A_Inject(AreScene) scene: AreScene,
+        ...args: any[]
+    ) {
+        if (!scene.host)
+            throw new AreCompilerError({
+                title: 'Scene Host Not Found',
+                description: `No host found for the scene with id: ${scene.id}. Please ensure that the scene is properly initialized and has a host before compiling binding attributes.`
+            });
+        /**
+         * Default case when attribute was not able to be identified as a binding, directive, or event, we just want to add it as a regular attribute to the node. This is the most basic case for attributes that don't have any special behavior or processing logic, and it ensures that they are still rendered on the node even if they don't have any dynamic functionality.
+         */
+        scene.plan(new AddAttributeInstruction(scene.host, {
+            name: attribute.name,
+            content: attribute.content
+        }));
+    }
+
+    @AreCompiler.Compile(AreDirectiveAttribute)
+    compileDirectiveAttribute(
+        @A_Inject(A_Caller) directive: AreDirectiveAttribute,
+        @A_Inject(AreStore) store: AreStore,
+        @A_Inject(A_Feature) feature: A_Feature,
+        @A_Inject(A_Logger) logger?: A_Logger,
+        ...args: any[]
+    ) {
+        store.watch(directive);
+
+        /**
+         * 3. If the attribute is a directive, then we should find a component that is responsible for
+         *    the directive compiling logic, and call it. 
+         *    In case component is not found we just want to log a warning, 
+         *    since the directive may be handled by some parent component or simply is a mistake in the template.
+         */
+        if (directive.component) {
+            feature.chain(directive.component, AreDirectiveFeatures.Compile, directive.owner.scope);
+        } else {
+            logger?.warning(`Directive handler component not found for directive: ${directive.name}. Make sure to create a component named "AreDirective${A_FormatterHelper.toPascalCase(directive.name)}" to handle this directive.`);
+        }
+
+        store.unwatch(directive);
+    }
+
+
+    @AreCompiler.Compile(AreEventAttribute)
+    compileEventAttribute(
+        @A_Inject(A_Caller) attribute: AreEventAttribute,
+        @A_Inject(AreScene) scene: AreScene,
+        ...args: any[]
+    ) {
+
+        if (!scene.host)
+            throw new AreCompilerError({
+                title: 'Scene Host Not Found',
+                description: `No host found for the scene with id: ${scene.id}. Please ensure that the scene is properly initialized and has a host before compiling binding attributes.`
+            });
+        /**
+         * 2. In case the attribute is an event listener, then 
+         *    we should simply add a callback handler that will be used to proxy an event 
+         *    into the ComponentNode component.  
+         *[!] In this case AreAttribute is AreEventAttribute that has prepared callback function to be used 
+         *    in the event listener. It is important to store callback function once 
+         *    to prevent duplicated functions in case of multiple compilations during development.
+         */
+        scene.plan(new AddListenerInstruction(scene.host, {
+            name: attribute.name,
+            handler: attribute.content
+        }));
+    }
+
+
+    @AreCompiler.Compile(AreBindingAttribute)
+    compileBindingAttribute(
+        @A_Inject(A_Caller) attribute: AreBindingAttribute,
+        @A_Inject(AreScene) scene: AreScene,
+        @A_Dependency.Parent()
+        @A_Inject(AreStore) parentStore: AreStore,
+        @A_Inject(AreStore) store: AreStore,
+        ...args: any[]
+    ) {
+        if (!scene.host)
+            throw new AreCompilerError({
+                title: 'Scene Host Not Found',
+                description: `No host found for the scene with id: ${scene.id}. Please ensure that the scene is properly initialized and has a host before compiling binding attributes.`
+            });
+
+
+        const node = attribute.owner;
+
+        /**
+         * 1. If the binding is related to a component prop, then we should set the value to the component props, so it can be used in the component logic and rendering.
+         *    This is a special case for component props, since they are not regular attributes and have a special meaning and usage in the component. By setting the value directly to the component props, we can ensure that it is properly reactive and can influence the component's behavior and rendering based on its value.
+         */
+        if (node.component && node.component.props[attribute.name]) {
+            const propDefinition = node.component.props[attribute.name];
+            let value = parentStore.get(attribute.content);
+
+            if (propDefinition.type) {
+                switch (propDefinition.type) {
+                    case 'string':
+                        value = String(value);
+                        break;
+                    case 'number':
+                        value = Number(value);
+                        break;
+                    case 'boolean':
+                        value = Boolean(value);
+                        break;
+                    default:
+                        break;
+                }
+            }
+
+            store.set(attribute.name, value);
+        }
+        /**
+         * 2. In other cases, we just want to add it as a regular attribute to the node, since it can be used in the template and rendering as a dynamic value that can change based on the store value. By adding it as a regular attribute, we can ensure that it is properly rendered and updated in the DOM based on its value in the store.
+         */
+        else {
+            const instruction = new AddAttributeInstruction(scene.host, {
+                name: attribute.name,
+                content: attribute.content,
+                evaluate: true
+            })
+
+            scene.plan(instruction);
+        }
+    }
+
+
+}

package/src/engine/AreHTML.constants.ts

@@ -0,0 +1,2 @@
+
+

package/src/engine/AreHTML.context.ts

@@ -0,0 +1,196 @@
+import { AreContext, AreInstruction, AreNode } from "@adaas/are";
+import { AreHTMLContextConstructor } from "./AreHTML.types";
+
+
+export class AreHTMLEngineContext extends AreContext {
+
+    /**
+     * Index structure mapping:
+     * 
+     *        Node                ->       Group ID        ->  Element
+     * -----------------------------------------------------------------------------------
+     *  | - Attribute             |   group: string       |   Node
+     *  | - Directive (e.g. for)  |                       |   Node
+     */
+
+    protected index = {
+        /**
+         * 1 AreNode = 1 Dom Node
+         * 
+         * uses ASEID
+         */
+        nodeToHostElements: new Map<string, Node>(),
+        /**
+         * 1 Group Instruction = MANY Dom Nodes (e.g. for loop)
+         * 
+         * uses ASEID
+         */
+        groupToElements: new Map<string, Set<Node>>(),
+        /**
+         * 1 Dom Node = 1 Instruction 
+         * 
+         * uses ASEID
+         */
+        elementToInstruction: new WeakMap<Node, string>(),
+        /**
+         * 1 Instruction = 1 Dom Node (for CreateElement instructions, for example)
+         * 
+         * uses ASEID
+         */
+        instructionToElement: new Map<string, Node>(),
+        /**
+         * Event listeners attached to elements, used for proper cleanup when reverting instructions. Maps a DOM element to a map of event names and their corresponding listeners, allowing the engine to track which listeners are attached to which elements and remove them when necessary (e.g., when an instruction is reverted).
+         */
+        elementListeners: new WeakMap<Node, Map<string, EventListenerOrEventListenerObject>>()
+    }
+
+    /**
+     * The root container for the HTML engine, which can be either a Document or a ShadowRoot. This is where the engine will mount the generated DOM elements. The context uses this container to manage the relationship between AreNodes, instructions, and their corresponding DOM elements, allowing for efficient updates and cleanups as the application state changes.
+     */
+    protected _container: Document;
+
+
+    constructor(props: Partial<AreHTMLContextConstructor>) {
+        super(props.container?.body.innerHTML || props.source || '');
+        this._container = props.container!;
+    }
+
+    get container(): Document {
+        return this._container;
+    }
+
+
+    /**
+     * Retrieves the DOM element associated with a given AreNode. This method looks up the node's ASEID in the nodeToHostElements map to find the corresponding DOM element. If the node is not found, it returns undefined. This allows the engine to efficiently access and manipulate the DOM elements that correspond to specific nodes in the AreNode tree, enabling dynamic updates and interactions based on the application state.
+     * 
+     * @param nodeASEID 
+     */
+    getNodeElement(nodeASEID: string): Node | undefined
+    getNodeElement(node: AreNode): Node | undefined
+    getNodeElement(node: AreNode | string): Node | undefined {
+        if (typeof node === 'string') {
+            return this.index.nodeToHostElements.get(node);
+        } else {
+            return this.index.nodeToHostElements.get(node.aseid.toString());
+        }
+    }
+
+    /**
+     * Associates a DOM element with a given instruction and its owner node. This method updates the context's index to map the instruction's ASEID to the provided DOM element, and also maps the element back to the instruction's ASEID for reverse lookup. If the instruction has an owner node, it also maps the node's ASEID to the element. Additionally, if the instruction belongs to a group, it adds the element to the set of elements associated with that group. This indexing allows the engine to efficiently manage and update DOM elements based on instructions and their corresponding nodes, enabling dynamic rendering and interaction in response to application state changes.
+     * 
+     * @param instruction 
+     * @param element 
+     */
+    setInstructionElement(instruction: AreInstruction, element: Node): void {
+        const node = instruction.owner;
+
+        this.index.instructionToElement.set(instruction.aseid.toString(), element);
+        this.index.elementToInstruction.set(element, instruction.aseid.toString());
+
+        if (node) {
+            this.index.nodeToHostElements.set(node.aseid.toString(), element);
+        }
+
+        if (instruction.group) {
+            const groupId = instruction.group;
+            if (!this.index.groupToElements.has(groupId)) {
+                this.index.groupToElements.set(groupId, new Set());
+            }
+            this.index.groupToElements.get(groupId)!.add(element);
+        }
+    }
+
+
+    /**
+     * Retrieves the DOM element associated with a given instruction. This method looks up the instruction's ASEID in the instructionToElement map to find the corresponding DOM element. If the instruction is not found, it returns undefined. This allows the engine to efficiently access and manipulate the DOM elements that correspond to specific instructions, enabling dynamic updates and interactions based on the application state.
+     * 
+     * @param instructionASEID 
+     */
+    getElementByInstruction(instructionASEID: string): Node | undefined
+    getElementByInstruction(instruction: AreInstruction): Node | undefined
+    getElementByInstruction(instruction: AreInstruction | string): Node | undefined {
+        if (typeof instruction === 'string') {
+            return this.index.instructionToElement.get(instruction);
+        } else {
+            return this.index.instructionToElement.get(instruction.aseid.toString());
+        }
+    }
+
+
+    /**
+     * Removes the association between a given instruction and its corresponding DOM element. This method looks up the instruction's ASEID to find the associated DOM element, and if found, it deletes the mapping from both instructionToElement and elementToInstruction. If the instruction has an owner node, it also removes the mapping from nodeToHostElements. Additionally, if the instruction belongs to a group, it removes the element from the set of elements associated with that group, and if the group has no more elements, it deletes the group from the index. This cleanup is essential for maintaining an accurate and efficient mapping of instructions to DOM elements, especially when instructions are reverted or when nodes are removed from the DOM.
+     * 
+     * @param instruction 
+     */
+    removeInstructionElement(instruction: AreInstruction): void {
+        const element = this.index.instructionToElement.get(instruction.aseid.toString());
+        if (element) {
+            this.index.instructionToElement.delete(instruction.aseid.toString());
+            this.index.elementToInstruction.delete(element);
+
+            const node = instruction.owner;
+            if (node) {
+                this.index.nodeToHostElements.delete(node.aseid.toString());
+            }
+
+            if (instruction.group) {
+                const groupId = instruction.group;
+                const groupElements = this.index.groupToElements.get(groupId);
+                if (groupElements) {
+                    groupElements.delete(element);
+                    if (groupElements.size === 0) {
+                        this.index.groupToElements.delete(groupId);
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Retrieves the set of DOM elements associated with a given group. This method looks up the group name or instruction's ASEID in the groupToElements map to find the corresponding set of DOM elements. If the group is not found, it returns undefined. This allows the engine to efficiently access and manipulate all DOM elements that belong to a specific group (e.g., all elements generated by a particular loop instruction), enabling dynamic updates and interactions based on the application state.
+     * 
+     * @param groupName 
+     */
+    getElementsByGroup(groupName: string): Set<Node> | undefined
+    getElementsByGroup(instruction: AreInstruction): Set<Node> | undefined
+    getElementsByGroup(instruction: AreInstruction | string): Set<Node> | undefined {
+        if (typeof instruction === 'string') {
+            return this.index.groupToElements.get(instruction);
+        } else {
+            return this.index.groupToElements.get(instruction.aseid.toString());
+        }
+    }
+
+    /**
+     * Adds an event listener to a specific DOM element and keeps track of it in the context's index for proper cleanup later. This method takes a DOM element, an event name, and a listener function or object, and stores this information in the elementListeners map. This allows the engine to efficiently manage event listeners attached to dynamically created elements, ensuring that they can be removed when the associated instructions are reverted or when nodes are removed from the DOM, preventing memory leaks and unintended behavior.
+     * 
+     * @param element 
+     * @param eventName 
+     * @param listener 
+     */
+    addListener(element: Node, eventName: string, listener: EventListenerOrEventListenerObject): void {
+        if (!this.index.elementListeners.has(element)) {
+            this.index.elementListeners.set(element, new Map());
+        }
+        this.index.elementListeners.get(element)!.set(eventName, listener);
+    }
+    /**
+     * Retrieves the event listener associated with a specific DOM element and event name from the context's index. This method looks up the element in the elementListeners map and then retrieves the listener for the specified event name. If no listener is found for the given element and event, it returns undefined. This allows the engine to efficiently access and manage event listeners that have been attached to dynamically created elements, enabling proper cleanup when instructions are reverted or when nodes are removed from the DOM.
+     * 
+     * @param element 
+     * @param eventName 
+     * @returns 
+     */
+    getListener(element: Node, eventName: string): EventListenerOrEventListenerObject | undefined {
+        return this.index.elementListeners.get(element)?.get(eventName);
+    }
+    /**
+     * Removes an event listener from a specific DOM element and updates the context's index accordingly. This method looks up the element in the elementListeners map and deletes the listener for the specified event name. This is typically called when an instruction is reverted or when a node is removed from the DOM, ensuring that any attached event listeners are properly cleaned up to prevent memory leaks and unintended behavior.
+     * 
+     * @param element 
+     * @param eventName 
+     */
+    removeListener(element: Node, eventName: string): void {
+        this.index.elementListeners.get(element)?.delete(eventName);
+    }
+}