@epa-wg/custom-element 0.0.32 → 0.0.34

package/custom-element.js

@@ -5,7 +5,7 @@ const XSL_NS_URL  = 'http://www.w3.org/1999/XSL/Transform'
 
 // const log = x => console.debug( new XMLSerializer().serializeToString( x ) );
 
-const attr = (el, attr)=> el.getAttribute?.(attr)
+const attr = (el, attr)=> el?.getAttribute?.(attr)
 ,   isText = e => e.nodeType === 3
 ,   isString = s => typeof s === 'string'
 ,   isNode = e => e && typeof e.nodeType === 'number'
@@ -89,7 +89,12 @@ obj2node( o, tag, doc )
         return create(tag,o,doc);
     if( t === 'number' )
         return create(tag,''+o,doc);
-
+    if( isNode(o) )
+    {
+        const el = create(tag);
+        el.append(o);
+        return el;
+    }
     if( o instanceof Array )
     {   const ret = create('array','',doc);
         o.map( ae => ret.append( obj2node(ae,tag,doc)) );
@@ -103,13 +108,20 @@ obj2node( o, tag, doc )
     }
     const ret = create(tag,'',doc);
     for( let k in o )
-        if( isNode(o[k]) || typeof o[k] ==='function' || o[k] instanceof Window )
+    {
+        if( typeof o[ k ] === 'function' || o[ k ] instanceof Window )
             continue
-        else
-            if( typeof o[k] !== "object" && isValidTagName(k) )
-                ret.setAttribute(k, o[k] );
+        if( isNode( o[ k ] ) )
+        {   if( k === 'data' || k==='value' )
+                ;
             else
-                ret.append(obj2node(o[k], k, doc))
+                continue
+        }
+        if( typeof o[ k ] !== "object" && isValidTagName( k ) )
+            ret.setAttribute( k, o[ k ] )
+        else
+            ret.append( obj2node( o[ k ], k, doc ) )
+    }
     return ret;
 }
     export function
@@ -234,6 +246,8 @@ createXsltFromDom( templateNode, S = 'xsl:stylesheet' )
                 const d = xml2dom( '<xhtml/>' )
                 ,     n = d.importNode(r, true);
                 d.replaceChild(n,d.documentElement);
+                if( n.namespaceURI === HTML_NS_URL && !attr(n,'xmlns'))
+                    n.setAttribute('xmlns',HTML_NS_URL);
                 return xslHtmlNs(n);
             };
             if( e )
@@ -294,6 +308,16 @@ createXsltFromDom( templateNode, S = 'xsl:stylesheet' )
         fr.append(r)
     }
 
+    [...fr.querySelectorAll('[test]')].forEach( n=>{
+        const t = attr(n,'test')
+        ,     r = t.replace(/hasBoolAttribute\((.*?)\)/g,
+            (match, p1, p2,p3,p4)=>
+            {   const a = p1.substring(1);
+                return `(not($${a} = \'false\') and ($${a} = '' or $${a} = '${a}' or $${a} = 'true' ))`
+            });
+        t!== r && n.setAttribute('test',r);
+    });
+
     [...fr.querySelectorAll('dce-root>attribute')].forEach( a=>
     {
         keepAttributes(a,'namespace,name,select');
@@ -301,7 +325,7 @@ createXsltFromDom( templateNode, S = 'xsl:stylesheet' )
         ,  name = attr(a,'name');
 
         declaredAttributes.push(name);
-        if( a.childNodes.length)
+        if( a.childNodes.length )
             hardcodedAttributes[name] = a.textContent;
 
         payload.append(p);
@@ -317,10 +341,15 @@ createXsltFromDom( templateNode, S = 'xsl:stylesheet' )
             if( select?.length>1 )
             {   p.removeAttribute('select');
                 const c = $( xslDom, 'template[match="ignore"]>choose').cloneNode(true);
-                // todo multiple ?? operators
                 emptyNode(c.firstElementChild).append( createText(c,'{'+select[0]+'}'));
-                emptyNode(c.lastElementChild ).append( createText(c,'{'+select[1]+'}'));
-                c.firstElementChild.setAttribute('test','string-length('+select[0]+')');
+                c.firstElementChild.setAttribute('test',select[0]);
+                for( let i=1; i<select.length-1; i++)
+                {   const when = c.firstElementChild.cloneNode(true);
+                    emptyNode(when).append( createText(c,'{'+select[i]+'}'));
+                    when.setAttribute('test',select[i]);
+                    c.insertBefore(when, c.lastElementChild);
+                }
+                emptyNode(c.lastElementChild ).append( createText(c,'{'+select[select.length-1]+'}'));
                 p.append(c);
                 val = c.cloneNode(true);
             }else
@@ -329,8 +358,12 @@ createXsltFromDom( templateNode, S = 'xsl:stylesheet' )
             a.append(val);
             a.removeAttribute('select');
         }else
-        {   keepAttributes( p, 'name' );
+        {
+            keepAttributes( p, 'name' );
             p.setAttribute('select','/datadom/attributes/'+name)
+
+            if( !hardcodedAttributes[name] )
+                a.remove();
         }
     });
     [...fr.querySelectorAll('[value]')].filter(el=>el.getAttribute('value').match( /\{(.*)\?\?(.*)\}/g )).forEach(el=>
@@ -460,12 +493,15 @@ event2slice( x, sliceNames, ev, dce )
             const v = notChecked? '' : el.value ?? attr( el, 'value' );
             cleanSliceValue();
             if( v === null || v === undefined )
+            {
                 [...s.childNodes].filter(n=>n.localName!=='event').map(n=>n.remove());
+                s.removeAttribute('value');
+            }
             else
-                if( isString(v) )
-                    s.append( createText( d, v) );
-                else
-                    s.append( obj2node(v,'value',s.ownerDocument) )
+            {   const ve = isString(v) ? createText( d, v) : obj2node(v,'value',s.ownerDocument);
+                s.append( ve );
+                s.setAttribute('value',v);
+            }
         }
         return s
     })
@@ -513,11 +549,26 @@ const loadTemplateRoots = async ( src, dce )=>
 export function mergeAttr( from, to )
 {   for( let a of from.attributes)
         try
-        {   a.namespaceURI? to.setAttributeNS( a.namespaceURI, a.name, a.value ) : to.setAttribute( a.name, a.value )
+        {   const name = a.name;
+            if( name.startsWith('xmlns') )
+                continue;
+            if( a.namespaceURI )
+            {   if( !to.hasAttributeNS(a.namespaceURI, name) || to.getAttributeNS(a.namespaceURI, name) !== a.value )
+                    to.setAttributeNS( a.namespaceURI, name, a.value )
+            }else
+            {   if( !to.hasAttribute(name) || to.getAttribute(name) !== a.value )
+                    to.setAttribute( a.name, a.value )
+            }
             if( a.name === 'value')
                 to.value = a.value
         }catch(e)
             { console.warn('attribute assignment error',e?.message || e); }
+    const ea = to.dceExportedAttributes
+        , aa = to.getAttribute('dce-exported-attributes')
+        , em = aa ? new Set( aa.split(' ') ) : null;
+    for( let a of to.getAttributeNames() )
+        if( !from.hasAttribute(a) && !ea?.has(a) && !em?.has(a) )
+            to.removeAttribute(a)
 }
 export function assureUnique(n, id=0)
 {
@@ -630,14 +681,19 @@ export const toXsl = (el, defParent) => {
         x.setAttribute( a.name, a.value );
     while(el.firstChild)
         x.append(el.firstChild);
+    const replacement = el.localName === 'if' || el.localName === 'choose' ? (() => {
+        const span = create('span');
+        span.append(x);
+        return span;
+    })() : x;
     if( el.parentElement )
-        el.parentElement.replaceChild( x, el );
+        el.parentElement.replaceChild( replacement, el );
     else
     {  const p = (el.parentElement || defParent)
         ,  arr = [...p.childNodes];
         arr.forEach((n, i) => {
             if (n === el)
-                arr[i] = x;
+                arr[i] = replacement;
         });
         p.replaceChildren(...arr);
     }
@@ -650,7 +706,7 @@ CustomElement extends HTMLElement
     async connectedCallback()
     {
         if(this.firstElementChild && this.firstElementChild.localName !== 'template')
-            console.warn('custom-element used without template wrapping content\n', this.outerHTML);
+            console.log('custom-element used without template wrapping content\n', this.outerHTML);
         const templateRoots = await loadTemplateRoots( attr( this, 'src' ), this )
         ,               tag = attr( this, 'tag' )
         ,           tagName = tag ? tag : 'dce-'+crypto.randomUUID();
@@ -681,11 +737,13 @@ CustomElement extends HTMLElement
                                 .map(splitSliceNames).flat();
 
         const { declaredAttributes, hardcodedAttributes, exposedAttributes } = templateDocs[0];
+        const dceExportedAttributes = new Set([...Object.keys(hardcodedAttributes), ...Object.keys(exposedAttributes)]);
 
         class DceElement extends HTMLElement
         {
             static get observedAttributes(){ return declaredAttributes; }
             #inTransform = 0;
+            get dceExportedAttributes(){ return dceExportedAttributes; }
             connectedCallback()
             {   let payload = sanitizeBlankText(this.childNodes);
                 if( this.firstElementChild?.tagName === 'TEMPLATE' )
@@ -719,8 +777,9 @@ CustomElement extends HTMLElement
                 this.innerHTML='';
                 const attrsRoot = injectData( x, 'attributes' , this.attributes, e => createXmlNode( e.nodeName, e.value ) )
                 , inAttrs = a=> this.hasAttribute(a) || [...attrsRoot.children].find(e=>e.localName === a);
+                mergeAttr( this, attrsRoot );
                 Object.keys(hardcodedAttributes).map(a=> inAttrs(a) || attrsRoot.append(createXmlNode(a,hardcodedAttributes[a])) );
-                declaredAttributes.map(a=> inAttrs(a) || attrsRoot.append(createXmlNode(a)) );
+                Object.keys(exposedAttributes).map(a=> inAttrs(a) || attrsRoot.append(createXmlNode(a)) );
 
                 injectData( x, 'dataset', Object.keys( this.dataset ), k => createXmlNode( k, this.dataset[ k ] ) );
                 const sliceRoot = injectData( x, 'slice', sliceNames, k => createXmlNode( k, '' ) )
@@ -753,34 +812,42 @@ CustomElement extends HTMLElement
                 const transform = this.transform = ()=>
                 {   if(this.#inTransform){ debugger }
                     this.#inTransform = 1;
-
-                    const ff = xp.map( (p,i) =>
-                    {   const f = p.transformToFragment(x.ownerDocument, document)
-                        if( !f )
-                            console.error( "XSLT transformation error. xsl:\n", xmlString(templateDocs[i]), '\nxml:\n', xmlString(x) );
-                        return f
-                    });
-                    ff.map( f =>
-                    {   if( !f )
-                            return;
-                        assureUnique(f);
-                        merge( this, f.childNodes )
-                    })
-
-                    Object.entries(hardcodedAttributes).map(( [a,v] )=>
-                    {   if( !this.hasAttribute(a) && v !== attr(this,a) )
-                        {   this.setAttribute( a, v );
-                            this.#applyAttribute( a, v );
-                        }
-                    });
-
-                    Object.keys(exposedAttributes).map( a =>
-                    {   let v = attr(this.firstElementChild,a);
-                        if( v !== attr(this,a) )
-                        {   this.setAttribute( a, v );
-                            this.#applyAttribute( a, v );
-                        }
-                    });
+                    const renderModel = ()=>
+                    {
+                        const ff = xp.map( (p,i) =>
+                        {   const f = p.transformToFragment(x.ownerDocument, document)
+                            if( !f )
+                                console.error( "XSLT transformation error. xsl:\n", xmlString(templateDocs[i]), '\nxml:\n', xmlString(x) );
+                            return f
+                        });
+                        ff.map( f =>
+                        {   if( !f )
+                                return;
+                            assureUnique(f);
+                            merge( this, f.childNodes )
+                        })
+                        let attrChangedCount = 0;
+                        Object.entries(hardcodedAttributes).map(( [a,v] )=>
+                        {   if( !this.hasAttribute(a) && v !== attr(this,a) )
+                            {   this.setAttribute( a, v );
+                                this.#applyAttribute( a, v );
+                                attrChangedCount++;
+                            }
+                        });
+
+                        Object.keys(exposedAttributes).map( a =>
+                        {   let v = attr(this.firstElementChild,a);
+                            if( v !== attr(this,a) )
+                            {   this.setAttribute( a, v );
+                                this.#applyAttribute( a, v );
+                                attrChangedCount++;
+                            }
+                        });
+                        return attrChangedCount;
+                    };
+                    if( renderModel() )
+                        if( renderModel() )
+                            console.warn("model update should not be the result of transform more than once");
 
                     function getSliceTarget(el)
                     {   let r = el;
@@ -868,13 +935,15 @@ CustomElement extends HTMLElement
             #applyAttribute(name, newValue)
             {   if( 'value' === name )
                     this.value = newValue;
+                const attrs = this.xml.querySelector('attributes');
                 let a = this.xml.querySelector(`attributes>${name}`);
                 if( a )
                     emptyNode(a).append( createText(a,newValue) );
                 else
                 {   a = create( name, newValue, this.xml );
-                    this.xml.querySelector('attributes').append( a );
+                    attrs.append( a );
                 }
+                this.#inTransform || attrs.setAttribute(name,newValue);
 
                 this.dispatchEvent(new CustomEvent('change', { bubbles: true,detail: { [name]: newValue }}))
             }

package/demo/a.html

@@ -63,11 +63,18 @@
 <body>
 
 
+<custom-element tag="dce-link2" >
+        <template>
 
-        <custom-element src="./html-template.html#dwc-logo">
-            <template><i>loading SVG from templates file ...</i></template>
-        </custom-element>
+            <attribute name="p3" select="//attributes/p3 ?? 'def_P3' "></attribute>
 
+            p3: <code data-testid="t3">{$p3}</code>
+        </template>
+    </custom-element>
+    <section>
+        <dce-link2  id="dce2" p1="123" p2="override ignored as select is defined"></dce-link2>
+
+    </section>
 
 </body>
 </html>

package/demo/{parameters.html → attributes.html}

@@ -22,14 +22,30 @@
 <nav>
     <a href="../index.html"><h3><code>custom-element</code> demo</h3></a>
 </nav>
-<html-demo-element legend="param as attributes definition" description="
-params needed to declare DCE attributes and track the attributes changes. It also be used by IDE and validation.
-">
+<main>
+    <p><code>attribute</code> is used for DCE attributes declaration and track the attributes changes. It also be used by IDE and validation.</p>
+    <p>The attribute can be changed by component itself and used as output to the container.
+        Usual case is when <code>value</code> attribute is updated from inside.</p>
+    <p>Initial value of attribute is available on the <code>attributes</code> node attribute as in <code>/datadom/attributes/@attr1</code></p>
+    <p>The current, i.e. including the changes by component itself, attribute value is a child node of <code>attributes</code> as in <code>/datadom/attributes/attr1</code>.</p>
+    <p>To define the attribute which is modified from within,  the 3 parts are usually used as in <code>//s[//s/event] ?? //attributes/@v ?? 'def' </code>
+    <ol>
+    <li><code>//s[//s/event]</code> the slice <code>s</code> with event gives the slice value which was modified by user event like input</li>
+    <li><code>//attributes/@v</code> the attribute passed by container</li>
+    <li><code>'def' </code> the default value which used when no user input or attribute set by container</li>
+</ol>
+    </p>
+</main>
+<html-demo-element legend="attributes definition" >
+    <p slot="description">
+    <code>attribute</code> is used for DCE attributes declaration and track the attributes changes. It also be used by IDE and validation.
+
+</p>
     <template>
         <custom-element tag="dce-link" hidden>
             <attribute name="p1" >default_P1                </attribute>
             <attribute name="p2" select="'always_p2'"       ></attribute>
-            <attribute name="p3" select="//p3 ?? 'def_P3' " ></attribute>
+            <attribute name="p3" select="//attributes/@p3 ?? 'def_P3' " ></attribute>
             p1:{$p1} <br/> p2: {$p2} <br/> p3: {$p3}
         </custom-element>
         <dce-link id="dce1" ></dce-link>
@@ -44,13 +60,15 @@ params needed to declare DCE attributes and track the attributes changes. It als
     </template>
 </html-demo-element>
 
-<html-demo-element legend="attribute from slice" description="
-when slice value points to attribute, it would be populated on slice change
-">
+<html-demo-element legend="attribute from slice">
+    <p slot="description">
+When slice value points to attribute, it would be populated on slice change.<br/>
     Type in the input field to see the variable $title change. <br/>
     Hover the mouse to see the title attribute text popup.<br/>
     Inspect DCE node in dev tools to see `title` attribute updated while typing.
 
+</p>
+
     <template>
         <custom-element>
             <template>
@@ -62,6 +80,52 @@ when slice value points to attribute, it would be populated on slice change
     </template>
 </html-demo-element>
 
+
+<html-demo-element legend="V attribute matches input value" description="
+    Type in the input field and observe in DevTools the V attribute changed.
+">
+    <template>
+<custom-element tag="x-input" >
+    <template>
+        <attribute name="is-changed" select="count(//s/event) &gt; 0"></attribute>
+        <attribute name="v" select="//s[//s/event] ?? //attributes/@v ?? 'def' "></attribute>
+        /datadom/attributes/v='{/datadom/attributes/v}'<br/>
+        same as v='{v}'<br/>
+        same as $v='{$v}'<br/>
+        //attributes/@v='{//attributes/@v}'<br/>
+        //s='{//s}'<br/>
+        is-changed ={ is-changed }<br/>
+        <input slice="s" slice-event="input" value="{//attributes/v}"/>
+    </template>
+</custom-element>
+<x-input></x-input>
+<x-input v="V1"></x-input>
+    </template>
+</html-demo-element>
+
+<html-demo-element legend="attribute defaults, from container, and from slice" description="
+    Type in the input field and observe in DevTools the V attribute changed.
+">
+    <template>
+<custom-element tag="attr-demo">
+    <template>
+        <variable name="has-input" select="count(//s/*) &gt; 0"></variable>
+        <attribute name="v" select="//s[//s/event] ?? //attributes/@v ?? 'def' "></attribute>
+        //attributes/v='{//attributes/v}'<br/>
+        //attributes/@v='{//attributes/@v}'<br/>
+        $v='{$v}'<br/>
+        //s='{//s}'<br/>
+        A='{//s[//s/event] | //attributes/v[not(//s/event)]}'<br/>
+        has-input ={ $has-input }<br/>
+        <input slice="s" slice-event="input" />
+    </template>
+</custom-element>
+
+<attr-demo></attr-demo>
+<attr-demo v="From Container"></attr-demo>
+    </template>
+</html-demo-element>
+
 <details>
     <summary>Attributes processing</summary>
     To be available in template, <code>custom-element</code> attributes should be

package/demo/html-template.html

@@ -1,6 +1,7 @@
 <!DOCTYPE html>
 <html lang="en" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 <head>
+  <meta charset="utf-8">
     <title>template based on HTML file</title>
     <style>svg {
         width: 4rem;
@@ -8,9 +9,9 @@
 </head>
 <body>
 <script>console.error('Stranger danger!')</script>
-<b id="wave">👋</b>
-<b id="ok">👌</b>
-<svg id="dwc-logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 216 209.18">
+<b id="wave" data-testid="wave" >👋</b>
+<b id="ok"   data-testid="ok"   >👌</b>
+<svg id="dwc-logo" data-testid="dwc-logo"  xmlns="http://www.w3.org/2000/svg" viewBox="0 0 216 209.18">
     <defs>
         <style>.cls-1 {
             fill: #c2e6f1;
@@ -73,7 +74,7 @@
     <path class="cls-1"
           d="m184.02,96.93l20.64-11.92c.47-.27.47-.79,0-1.06l-20.65-11.92h0c-4.44-2.57-8.22-2.57-12.67,0l-20.65,11.92c-.47.27-.47.79,0,1.06l20.64,11.92c4.44,2.57,8.22,2.57,12.67,0h0Z"/>
 </svg>
-<math id="sophomores-dream" display="block">
+<math id="sophomores-dream"  data-testid="ml-test" display="block">
     <mrow>
         <msubsup>
             <mo>∫</mo>