npm - @twobirds/microcomponents - Versions diffs - 0.0.10 → 0.0.14 - Mend

@twobirds/microcomponents 0.0.10 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

package/README.md +27 -47
package/assets/documentation/ajaxian-1.png +0 -0
package/assets/documentation/ajaxian-2.png +0 -0
package/assets/documentation/ajaxian-3.png +0 -0
package/assets/documentation/history.md +436 -0
package/assets/documentation/how_tos.md +0 -0
package/assets/documentation/introduction.md +0 -0
package/{microcomponents_magic.md → assets/documentation/magic.md} +1 -1
package/assets/documentation/rnd0023-1.jpg +0 -0
package/assets/documentation/rnd0023-2.jpg +0 -0
package/assets/documentation/rnd0023-3.jpg +0 -0
package/assets/documentation/tB_react.md +369 -0
package/assets/test.html +11 -0
package/dist/microcomponents.d.ts +15 -231
package/dist/microcomponents.d.ts.map +1 -1
package/dist/microcomponents.es3.d.ts +5 -0
package/dist/microcomponents.es3.d.ts.map +1 -1
package/dist/microcomponents.js +143 -334
package/dist/microcomponents.min.js +32 -29
package/dist/microcomponents.ts +209 -395
package/package.json +3 -4
package/public/{docs/assets → assets}/highlight.css +29 -22
package/public/assets/search.js +1 -0
package/public/{docs/classes → classes}/microcomponents.MC.html +78 -241
package/public/{docs/classes → classes}/microcomponents_es3.MC.html +12 -12
package/public/documentation/ajaxian-1.png +0 -0
package/public/documentation/ajaxian-2.png +0 -0
package/public/documentation/ajaxian-3.png +0 -0
package/public/documentation/functional_requirements.md +8 -0
package/public/documentation/history.md +436 -0
package/public/documentation/how_tos.md +0 -0
package/public/documentation/introduction.md +0 -0
package/public/documentation/magic.md +87 -0
package/public/documentation/proposal_draft.md +37 -0
package/public/documentation/rnd0023-1.jpg +0 -0
package/public/documentation/rnd0023-2.jpg +0 -0
package/public/documentation/rnd0023-3.jpg +0 -0
package/public/documentation/tB_react.md +369 -0
package/public/documentation/usage.md +142 -0
package/public/documentation/why.md +25 -0
package/public/{docs/functions → functions}/microcomponents_es3.__isEmpty.html +1 -1
package/public/index.html +101 -11
package/public/microcomponents.js +176 -0
package/public/{docs/modules → modules}/microcomponents.html +2 -7
package/public/test.html +11 -0
package/public/test.js +216 -0
package/src/microcomponents.ts +209 -395
package/src/test.js +247 -0
package/typedoc.json +1 -1
package/assets/index.html +0 -11
package/jsdoc.conf.json +0 -19
package/public/docs/assets/search.js +0 -1
package/public/docs/index.html +0 -97
package/public/docs/interfaces/microcomponents.HTMLElementMc.html +0 -3605
package/public/jsdoc/es3/files.html +0 -216
package/public/jsdoc/es3/index.html +0 -210
package/public/jsdoc/es3/symbols/_global_.html +0 -368
package/public/jsdoc/es3/symbols/src/build_microcomponents.es3.js.html +0 -104
package/public/jsdoc/es5+/files.html +0 -218
package/public/jsdoc/es5+/index.html +0 -218
package/public/jsdoc/es5+/symbols/MC.html +0 -621
package/public/jsdoc/es5+/symbols/_global_.html +0 -720
package/public/jsdoc/es5+/symbols/microcomponents.MC.html +0 -323
package/public/jsdoc/es5+/symbols/src/build_microcomponents.js.html +0 -375
/package/{microcomponents_functional_requirements.md → assets/documentation/functional_requirements.md} +0 -0
/package/{MicroComponentProposal_draft.md → assets/documentation/proposal_draft.md} +0 -0
/package/{microcomponents_usage.md → assets/documentation/usage.md} +0 -0
/package/{microcomponents_why.md → assets/documentation/why.md} +0 -0
/package/public/{docs/.nojekyll → .nojekyll} +0 -0
/package/public/{docs/assets → assets}/main.js +0 -0
/package/public/{docs/assets → assets}/style.css +0 -0
/package/public/{docs/modules → modules}/microcomponents_es3.html +0 -0
/package/public/{docs/modules.html → modules.html} +0 -0

package/public/index.html CHANGED Viewed

@@ -1,11 +1,101 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Micro Components</title>
-</head>
-<body>
-    <a href="http://twobirds.gitlab.io/microcomponents/docs/modules.html" target="_blank">API</a>
-</body>
-</html>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Micro Components</title><meta name="description" content="Documentation for Micro Components"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<div class="tsd-toolbar-contents container">
+<div class="table-cell" id="tsd-search" data-base=".">
+<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
+<div class="field">
+<div id="tsd-toolbar-links"></div></div>
+<ul class="results">
+<li class="state loading">Preparing search index...</li>
+<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Micro Components</a></div>
+<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
+<div class="container container-main">
+<div class="col-8 col-content">
+<div class="tsd-page-title">
+<h2>Micro Components</h2></div>
+<div class="tsd-panel tsd-typography">
+<a href="#micro-components" id="micro-components" style="color: inherit; text-decoration: none;">
+  <h2>MICRO COMPONENTS</h2>
+</a>
+<p><img src="https://gitlab.com/twoBirds/microcomponents/-/raw/main/MicroComponents.svg" alt="Micro Components Logo"></p>
+<p><strong>This code aims at improving Javascript modularity and encapsulation</strong>.</p>
+<p>Importing a custom MC in your client side code:</p>
+<pre><code class="language-javascript"><span class="hl-0">import</span><span class="hl-1"> </span><span class="hl-2">MyButton</span><span class="hl-1"> </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@mySampleLib/Button&#39;</span><span class="hl-1">;</span>
+</code></pre>
+<p>... is equivalent to:</p>
+<pre><code class="language-javascript"><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> @</span><span class="hl-2">mySampleLib</span><span class="hl-1">/</span><span class="hl-2">Button</span><span class="hl-1">;</span>
+</code></pre>
+<p>... on the server side.</p>
+<p>Imagine your micro components to be organized like a &quot;node_modules&quot; directory that is attached to a DOM node.</p>
+<p><strong>On the client side</strong> MCs reside inside DOM nodes in a &quot;_mc&quot; property, or inside each other recursively. Usually they provide a direct interface to their inner code.</p>
+<p><strong>On the server side</strong> MCs can be used to organize your code, too.</p>
+<a href="#status" id="status" style="color: inherit; text-decoration: none;">
+  <h2>Status</h2>
+</a>
+<p>WIP. Micro components should be done soon, as in days.</p>
+<a href="#disclaimer" id="disclaimer" style="color: inherit; text-decoration: none;">
+  <h2>Disclaimer</h2>
+</a>
+<p>I decided to extract this functionality from the <a href="https://www.npmjs.com/package/twobirds-core">twoBirds framework</a>, since it is framework agnostic, and relies solely on the standard DOM and native javascript or typescript, and is a useful tool in itself. Later this will be backported into twoBirds as a dependency, and twoBirds will become completely modularized on the base of MCs.</p>
+<p>This is a massive undertaking. MCs are just the foundation of what I do. <strong>I am about to dump</strong> <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/main/microcomponents_magic.md?ref_type=heads#things-i-already-did-with-this-in-my-own-framework-twobirds-or-in-apps-that-i-developed-with-it">20+ years of javascript programming</a> <strong>into open source libraries</strong>, so feel free to <a href="https://gofund.me/076c614c">fund this</a>. The better this is funded, the faster it will be done. Given enough resources, I will start a crowdfunded company that will develop a new ecosystem for javascript/typescript programming.</p>
+<p>By <strong>&quot;Open Source&quot;</strong> I mean <strong>really free and open</strong>, as <strong>you get all my inner source code with it</strong>. Once you understand the Micro Component principle, you are back in command of your software, no matter what MC functionality you import in your system. Since <strong>Micro Components</strong> are encapsuled, off-shoring and near-shoring is no problem, and reusability is guaranteed. Your external coders do not need to access your code repository or your toolchain. They only need to understand MCs.</p>
+<p><strong>Established frameworks</strong>, as opposed to MCs, <strong>provide a documented interface to a hidden layer of closed source inner functionality</strong>. MCs can be used to <strong>add an interface to components you developed using other frameworks</strong>. So you can still use your existing code, and MCs in it. But you will want to migrate it ASAP, since MCs work with any FW.</p>
+<a href="#general" id="general" style="color: inherit; text-decoration: none;">
+  <h2>General</h2>
+</a>
+<p>Using micro components enforces <strong>DRY, KISS and SOLID</strong> principles in Javascript programming. Read this <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/main/MicroComponentProposal_draft.md?ref_type=heads">RFC</a> for the shortest info, and <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/main/microcomponents_why.md?ref_type=heads">click here to see why you may want to use it</a>.</p>
+<p>This is a low-level approach. It consists of a single class with 3 static methods and 5 selector methods, and weights in at ~2 kB. Also there is an ES3 version to help e.g. <a href="https://en.wikipedia.org/wiki/Hybrid_Broadcast_Broadband_TV">hbbtv</a> modular JS coding, or any other device that relies on ES3. The latter is WIP, backporting is currently last on my list.</p>
+<p>For a short usage description goto <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/main/microcomponents_usage.md?ref_type=heads">Micro Component Usage</a>.</p>
+<p>Check the <a href="http://twobirds.gitlab.io/microcomponents/classes/microcomponents.MC.html">typedoc API reference</a> if you want to drill into the source code.</p>
+<p>To see what can be done, go to <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/main/microcomponents_magic.md?ref_type=heads">additional concepts</a> which shows what it already has been used for.</p>
+<a href="#simple-usage" id="simple-usage" style="color: inherit; text-decoration: none;">
+  <h2>Simple Usage:</h2>
+</a>
+<p><strong>Micro Components</strong> can be added to to a DOM element like this:</p>
+<p>before:</p>
+<pre><code class="language-HTML"><span class="hl-4">&lt;</span><span class="hl-5">div</span><span class="hl-4">&gt;&lt;/</span><span class="hl-5">div</span><span class="hl-4">&gt;</span>
+</code></pre>
+<p>code:</p>
+<pre><code class="language-typescript"><span class="hl-6">// create an inner micro component class</span><br/><span class="hl-7">class</span><span class="hl-1"> </span><span class="hl-8">MyInnerMC</span><span class="hl-1"> </span><span class="hl-7">extends</span><span class="hl-1"> </span><span class="hl-8">MC</span><span class="hl-1">{</span><br/><br/><span class="hl-1">    </span><span class="hl-7">constructor</span><span class="hl-1">( </span><span class="hl-2">target</span><span class="hl-1"> ){</span><br/><span class="hl-1">        </span><span class="hl-7">super</span><span class="hl-1">( </span><span class="hl-2">target</span><span class="hl-1"> );</span><br/><span class="hl-1">    }</span><br/><br/><span class="hl-1">    </span><span class="hl-9">doSomething</span><span class="hl-1">(){</span><br/><span class="hl-1">        </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-9">log</span><span class="hl-1">( </span><span class="hl-7">this</span><span class="hl-1">, </span><span class="hl-3">&#39;something done&#39;</span><span class="hl-1"> )</span><br/><span class="hl-1">    }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">// create a custom micro component class</span><br/><span class="hl-7">class</span><span class="hl-1"> </span><span class="hl-8">MyMC</span><span class="hl-1"> </span><span class="hl-7">extends</span><span class="hl-1"> </span><span class="hl-8">MC</span><span class="hl-1">{</span><br/><br/><span class="hl-1">    </span><span class="hl-7">private</span><span class="hl-1"> </span><span class="hl-2">myInner</span><span class="hl-1">: </span><span class="hl-8">MyInnerMC</span><span class="hl-1">;</span><br/><br/><span class="hl-1">    </span><span class="hl-7">constructor</span><span class="hl-1">( </span><span class="hl-2">target</span><span class="hl-1"> ){</span><br/><span class="hl-1">        </span><span class="hl-7">super</span><span class="hl-1">( </span><span class="hl-2">target</span><span class="hl-1"> );</span><br/><span class="hl-1">        </span><span class="hl-7">this</span><span class="hl-1">.</span><span class="hl-2">target</span><span class="hl-1"> = </span><span class="hl-2">target</span><span class="hl-1">;</span><br/><br/><span class="hl-1">        </span><span class="hl-6">//add a private inner micro component</span><br/><span class="hl-1">        </span><span class="hl-7">this</span><span class="hl-1">.</span><span class="hl-2">myInner</span><span class="hl-1"> = </span><span class="hl-7">new</span><span class="hl-1"> </span><span class="hl-9">MyInnerMC</span><span class="hl-1">( </span><span class="hl-2">target</span><span class="hl-1"> );</span><br/><br/><span class="hl-1">        </span><span class="hl-6">//add a public micro component</span><br/><span class="hl-1">        </span><span class="hl-7">this</span><span class="hl-1">.</span><span class="hl-9">add</span><span class="hl-1">(</span><br/><span class="hl-1">            </span><span class="hl-3">&#39;myPublicInnerMC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">            </span><span class="hl-7">new</span><span class="hl-1"> </span><span class="hl-9">MyInnerMC</span><span class="hl-1">( </span><span class="hl-2">target</span><span class="hl-1"> )</span><br/><span class="hl-1">        );</span><br/><span class="hl-1">    }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">// get some element from the DOM</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-10">element</span><span class="hl-1"> = </span><span class="hl-2">document</span><span class="hl-1">.</span><span class="hl-9">querySelector</span><span class="hl-1">(</span><span class="hl-3">&#39;div&#39;</span><span class="hl-1">)</span><br/><br/><span class="hl-6">// Add the custom micro component instance to the target element</span><br/><span class="hl-7">let</span><span class="hl-1"> </span><span class="hl-2">topLevelMC</span><span class="hl-1"> = </span><span class="hl-10">MC</span><span class="hl-1">.</span><span class="hl-9">add</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-2">element</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-3">&#39;myMC&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-7">new</span><span class="hl-1"> </span><span class="hl-9">MyMC</span><span class="hl-1">( </span><span class="hl-2">element</span><span class="hl-1"> )</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-9">log</span><span class="hl-1">( </span><span class="hl-2">element</span><span class="hl-1">.</span><span class="hl-2">_mc</span><span class="hl-1"> );</span><br/><span class="hl-6">// { &#39;myMC&#39;: { target: (element), _mc: { myPublicInnerMC: {...} } } }</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-9">log</span><span class="hl-1">( </span><span class="hl-2">element</span><span class="hl-1">.</span><span class="hl-2">_mc</span><span class="hl-1">.</span><span class="hl-2">myMC</span><span class="hl-1"> );</span><br/><span class="hl-6">// { target: (element), _mc: { myPublicInnerMC: {...} } }</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-9">log</span><span class="hl-1">( </span><span class="hl-2">topLevelMC</span><span class="hl-1">.</span><span class="hl-9">siblings</span><span class="hl-1">() );</span><br/><span class="hl-6">// [ { target: (element), _mc: { myPublicInnerMC: {...} } } ]</span>
+</code></pre>
+<p>after:</p>
+<pre><code class="language-HTML"><span class="hl-4">&lt;</span><span class="hl-5">div</span><span class="hl-1"> </span><span class="hl-11">_mc</span><span class="hl-4">&gt;&lt;/</span><span class="hl-5">button</span><span class="hl-4">&gt;</span>
+</code></pre>
+<p>_mc indicates that this HTML element contains at least one micro component. This is needed for the <strong>selectors</strong>.</p>
+<a href="#contact" id="contact" style="color: inherit; text-decoration: none;">
+  <h2>Contact</h2>
+</a>
+<p>Feel free to contact me for any questions or inquiries:</p>
+<p>email <a href="mailto:fthuerigen@gmail.com?subject=Micro%20Components">Frank Thürigen</a> or <a href="skype:frank.thuerigen">Skype</a></p>
+<p>And yes, you can <a href="https://gofund.me/076c614c">fund this</a>.</p>
+</div></div>
+<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
+<div class="tsd-navigation settings">
+<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<ul id="tsd-filter-options">
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
+<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
+<nav class="tsd-navigation primary">
+<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
+<div class="tsd-accordion-details">
+<ul>
+<li class="current selected"><a href="modules.html">Micro <wbr/>Components</a>
+<ul>
+<li class="tsd-kind-module"><a href="modules/microcomponents.html">microcomponents</a></li>
+<li class="tsd-kind-module"><a href="modules/microcomponents_es3.html">microcomponents.es3</a></li></ul></li></ul></div></details></nav></div></div>
+<div class="container tsd-generator">
+<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
+<div class="overlay"></div><script src="assets/main.js"></script></body></html>

package/public/microcomponents.js ADDED Viewed

@@ -0,0 +1,176 @@
+'use strict';
+/*
+helper methods
+*/
+// get all microcomponents from a list of HTMLElements
+function getMicroComponents(elements, search) {
+    let mcValues = [];
+    elements.forEach(e => {
+        if (e) {
+            if (e instanceof HTMLElement) {
+                const _mc = e?._mc;
+                if (!search && _mc) {
+                    mcValues = mcValues.concat(Object.values(e._mc));
+                }
+                else if (search && _mc && _mc[search]) {
+                    mcValues.push(_mc[search]);
+                }
+            }
+        }
+    });
+    return mcValues;
+}
+// get all ancestor DOM nodes up to the document
+function traverseNodes(node, search, firstonly = true) {
+    let mcValues = [];
+    while (node) {
+        if (node._mc) {
+            if (!search) {
+                mcValues = mcValues.concat(Object.values(node._mc));
+            }
+            else if (search && node._mc[search]) {
+                mcValues.push(node._mc[search]);
+            }
+            if (firstonly)
+                return mcValues;
+        }
+        node = node.parentNode;
+    }
+    return mcValues;
+}
+function isDOM(element) {
+    return element && element instanceof HTMLElement;
+}
+export class MC {
+    #target = {};
+    #_mc = {};
+    static debug = false;
+    constructor(target) {
+        this.#target = target;
+        this.#_mc = {};
+    }
+    get _mc() {
+        if (!MC.debug)
+            return undefined;
+        return this.#_mc;
+    }
+    get target() {
+        return this.#target;
+    }
+    // return all top-level micro components from an HTMLElement, or the searched one
+    static siblings(target, search = '') {
+        const mc = target;
+        if (!mc._mc) {
+            return [];
+        }
+        const _mc = mc._mc;
+        if (search.length) {
+            return _mc?.[search] || [];
+        }
+        return [...Object.values(_mc)];
+    }
+    // add a microcomponent to a target DOM node
+    static add(target, key, element = {}) {
+        let node = target;
+        // create the _mc property if necessary
+        if (!node._mc) {
+            node._mc = new MC(target);
+        }
+        const _mc = node._mc;
+        // add the element with the given property key to the _mc property
+        if (key.length && !_mc[key]) {
+            _mc[key] = element;
+            // add attribute if HTMLElement
+            if (target instanceof HTMLElement) {
+                target.setAttribute('_mc', '');
+            }
+        }
+        return element;
+    }
+    // remove a micro component from the DOM
+    static remove(target, key) {
+        if (!key)
+            return; // silent fail
+        const _mc = target?._mc || {};
+        // delete the property from the HTMLElement _mc collection
+        if (_mc && _mc[key]) {
+            delete _mc[key];
+        }
+        // remove the _mc attribute if the DOM collection is empty
+        if (!Object.keys(_mc).length && target instanceof HTMLElement && target.hasAttribute('_mc')) {
+            target.removeAttribute('_mc');
+        }
+        return;
+    }
+    // add a microcomponent to the collection
+    add(key, element, target) {
+        if (this.#_mc[key])
+            return;
+        // if target parameter exists ( a DOM node )
+        // you want a top level (public) MC
+        if (target) {
+            // ... add the new micro component to the DOM node _mc
+            MC.add(target, key, element);
+        }
+        // add the new micro component to the private collection anyway
+        this.#_mc[key] = element;
+        return element;
+    }
+    // remove a micro component from the collection
+    remove(key, target) {
+        const _mc = this.#_mc;
+        const t = target;
+        // if target parameter exists ( a DOM node )
+        // you want to remove a top level (public) MC
+        if (target) {
+            // ... remove the new micro component from the DOM node _mc
+            MC.remove(t, key);
+        }
+        // remove the new micro component from the private collection anyway
+        delete _mc?.[key];
+    }
+    // return all micro components from the collection, or the searched one
+    // in a top level DOM MC, this refers to the inner collection always
+    // use MC.siblings() to get the public MCs
+    siblings(search = '') {
+        const _mc = this.#_mc;
+        if (!_mc)
+            return [];
+        const result = _mc[search || ''];
+        return search && result ? [result] : [...Object.values(_mc)];
+    }
+    /*
+    the following selectors will only work for the DOM top level MCs and return [] otherwise
+    */
+    // first anchestor DOM node, all public MCs
+    parent(search = '') {
+        if (!isDOM(this.#target))
+            return [];
+        return traverseNodes(this.#target.parentNode, search, true);
+    }
+    // all anchestor DOM nodes, beginning with the closest, all public MCs
+    parents(search = '') {
+        if (!isDOM(this.#target))
+            return [];
+        return traverseNodes(this.#target.parentNode, search, false);
+    }
+    // nearest child DOM nodes, all puclic MCs
+    children(search = '') {
+        if (!isDOM(this.#target))
+            return [];
+        const id = Math.random().toString().replace('.', '');
+        const selector = '[_mc]:not([temp_id="' + id + '"] [_mc] [_mc])'; // HOTFIX: minifier or tsc compiler error, dont use backtick string, cuts out blanks
+        this.#target.setAttribute('temp_id', id);
+        const myDomElements = this.#target.querySelectorAll(selector);
+        const mcValues = getMicroComponents([...myDomElements], search);
+        this.#target.removeAttribute('temp-id');
+        return mcValues;
+    }
+    // all descendant DOM nodes, all puclic MCs
+    descendants(search = '') {
+        if (!isDOM(this.#target))
+            return [];
+        const myDomElements = this.#target.querySelectorAll('*[_mc]');
+        return getMicroComponents([...myDomElements], search);
+    }
+}

package/public/{docs/modules → modules}/microcomponents.html RENAMED Viewed

@@ -16,7 +16,7 @@
 <li><a href="microcomponents.html">microcomponents</a></li></ul>
 <h1>Module microcomponents</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/cb1aec4/src/microcomponents.ts#L1">src/microcomponents.ts:1</a></li></ul></aside>
+<li>Defined in <a href="https://gitlab.com/twoBirds/microcomponents/-/blob/f72dc84/src/microcomponents.ts#L1">microcomponents.ts:1</a></li></ul></aside>
 <section class="tsd-panel-group">
 <section class="tsd-panel tsd-typography"></section></section>
 <section class="tsd-panel-group tsd-index-group">
@@ -25,10 +25,6 @@
 <section class="tsd-index-section">
 <h3 class="tsd-index-heading">Classes</h3>
 <div class="tsd-index-list"><a href="../classes/microcomponents.MC.html" class="tsd-index-link tsd-kind-class tsd-parent-kind-module"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>MC</span></a>
-</div></section>
-<section class="tsd-index-section">
-<h3 class="tsd-index-heading">Interfaces</h3>
-<div class="tsd-index-list"><a href="../interfaces/microcomponents.HTMLElementMc.html" class="tsd-index-link tsd-kind-interface tsd-parent-kind-module"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>HTMLElement<wbr/>Mc</span></a>
 </div></section></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
@@ -55,8 +51,7 @@
 <li class="tsd-kind-module"><a href="microcomponents_es3.html">microcomponents.es3</a></li></ul></li></ul></div></details></nav>
 <nav class="tsd-navigation secondary menu-sticky">
 <ul>
-<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/microcomponents.MC.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>MC</a></li>
-<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/microcomponents.HTMLElementMc.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HTMLElement<wbr/>Mc</a></li></ul></nav></div></div>
+<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/microcomponents.MC.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>MC</a></li></ul></nav></div></div>
 <div class="container tsd-generator">
 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
 <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/public/test.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+    <html lang="en">
+        <head>
+            <meta charset="UTF-8">
+            <meta name="viewport" content="width=device-width, initial-scale=1.0">
+            <title>Micro Components Manual Test</title>
+        </head>
+    <body>
+        <script  type="module" src="./test.js"></script>
+    </body>
+</html>

package/public/test.js ADDED Viewed

@@ -0,0 +1,216 @@
+"use strict";
+function getMicroComponents(elements, search) {
+    let mcValues = [];
+    elements.forEach((e) => {
+        if (e) {
+            if (e instanceof HTMLElement) {
+                const _mc = e?._mc;
+                if (!search && _mc) {
+                    mcValues = mcValues.concat(Object.values(e._mc));
+                }
+                else if (search && _mc && _mc[search]) {
+                    mcValues.push(_mc[search]);
+                }
+            }
+        }
+    });
+    return mcValues;
+}
+function traverseNodes(node, search, firstonly = true) {
+    let mcValues = [];
+    while (node) {
+        if (node._mc) {
+            if (!search) {
+                mcValues = mcValues.concat(Object.values(node._mc));
+            }
+            else if (search && node._mc[search]) {
+                mcValues.push(node._mc[search]);
+            }
+            if (firstonly)
+                return mcValues;
+        }
+        node = node.parentNode;
+    }
+    return mcValues;
+}
+function isDOM(element) {
+    return element && element instanceof HTMLElement;
+}
+class MC {
+    #target = {};
+    #_mc = {};
+    static debug = false;
+    constructor(target) {
+        this.#target = target;
+        this.#_mc = {};
+    }
+    get _mc() {
+        if (!MC.debug)
+            return undefined;
+        return this.#_mc;
+    }
+    get target() {
+        return this.#target;
+    }
+    static siblings(target, search = "") {
+        const mc = target;
+        if (!mc._mc) {
+            return [];
+        }
+        const _mc = mc._mc;
+        if (search.length) {
+            return _mc?.[search] || [];
+        }
+        return [...Object.values(_mc)];
+    }
+    static add(target, key, element = {}) {
+        let node = target;
+        if (!node._mc) {
+            node._mc = new MC(target);
+        }
+        const _mc = node._mc;
+        if (key.length && !_mc[key]) {
+            _mc[key] = element;
+            if (target instanceof HTMLElement) {
+                target.setAttribute("_mc", "");
+            }
+        }
+        return element;
+    }
+    static remove(target, key) {
+        if (!key)
+            return;
+        const _mc = target?._mc || {};
+        if (_mc && _mc[key]) {
+            delete _mc[key];
+        }
+        if (!Object.keys(_mc).length &&
+            target instanceof HTMLElement &&
+            target.hasAttribute("_mc")) {
+            target.removeAttribute("_mc");
+        }
+        return;
+    }
+    add(key, element, target) {
+        if (this.#_mc[key])
+            return;
+        if (target) {
+            MC.add(target, key, element);
+        }
+        this.#_mc[key] = element;
+        return element;
+    }
+    remove(key, target) {
+        const _mc = this.#_mc;
+        const t = target;
+        if (target) {
+            MC.remove(t, key);
+        }
+        delete _mc?.[key];
+    }
+    siblings(search = "") {
+        const _mc = this.#_mc;
+        if (!_mc)
+            return [];
+        const result = _mc[search || ""];
+        return search && result ? [result] : [...Object.values(_mc)];
+    }
+    parent(search = "") {
+        if (!isDOM(this.#target))
+            return [];
+        return traverseNodes(this.#target.parentNode, search, true);
+    }
+    parents(search = "") {
+        if (!isDOM(this.#target))
+            return [];
+        return traverseNodes(this.#target.parentNode, search, false);
+    }
+    children(search = "") {
+        if (!isDOM(this.#target))
+            return [];
+        const id = Math.random().toString().replace(".", "");
+        const selector = '[_mc]:not([temp_id="' + id + '"] [_mc] [_mc])';
+        this.#target.setAttribute("temp_id", id);
+        const myDomElements = this.#target.querySelectorAll(selector);
+        const mcValues = getMicroComponents([...myDomElements], search);
+        this.#target.removeAttribute("temp-id");
+        return mcValues;
+    }
+    descendants(search = "") {
+        if (!isDOM(this.#target))
+            return [];
+        const myDomElements = this.#target.querySelectorAll("*[_mc]");
+        return getMicroComponents([...myDomElements], search);
+    }
+}
+// create test page if necessary, otherwise test what is present
+if (window.location.hostname.indexOf("gitlab") > -1) {
+    document.body.innerHTML = `<div class="level_1"><span><div class="level_2"><span><div class="level_3"><span><div class="level_4"><span><div class="level_5"></div><div class="level_5"></div><div class="level_5"></div><div class="level_5"></div><div class="level_5"></div></span></div></span></div></span></div></span></div>`;
+    let elements = [...document.querySelectorAll("div")].reverse();
+    elements.forEach((e) => (e.innerHTML = e.innerHTML.repeat(5)));
+    document.body.innerHTML = document.body.innerHTML.repeat(5);
+    document.body.innerHTML =
+        document.body.innerHTML +
+            "<span>F12 opens the debugger, console has some manual tests...</span>";
+}
+// create an inner micro component class
+class MyInnerMC extends MC {
+    constructor(target) {
+        super(target);
+    }
+    doSomething() {
+        console.log(this, " myInnerMC something done");
+        console.log(this.siblings());
+    }
+}
+// create a custom micro component class
+class MyMC extends MC {
+    #myInner;
+    constructor(target) {
+        super(target);
+        //add a micro component
+        this.add("myInnerMC", new MyInnerMC(target));
+        // add a private MC
+        this.#myInner = new MyInnerMC(target);
+    }
+    doSomething() {
+        console.log(this, "myMC something done");
+        this.#myInner.doSomething();
+    }
+}
+console.time("MC creation time");
+// get some element from the DOM
+const domElement = document.querySelector("div");
+// Add the custom micro component instance to the target element
+MC.add(domElement, "myFirstMC", new MyMC(domElement));
+// Add the custom micro component instance to every div
+document.querySelectorAll("div").forEach((e) => {
+    MC.add(e, "myPublicMC1", new MyMC(e));
+    MC.add(e, "myPublicMC2", new MyMC(e));
+});
+console.timeEnd("MC creation time");
+let c = document.querySelectorAll("[_mc]");
+console.info("number of DOM nodes:", document.querySelectorAll("*").length, "\nnumber of DOM nodes containing micro components:", c.length, "\nnumber of top level micro components:", c.length * 2 + 1, // TODO write reducer
+"\nnumber of top level & inner micro components:", c.length * 6 + 2 // TODO write reducer
+);
+console.warn("domElement = first DIV element:", domElement);
+console.log("domElement\n  ._mc", domElement._mc);
+console.log("domElement\n  ._mc\n  .myFirstMC", domElement._mc.myFirstMC);
+console.log("domElement\n  ._mc\n  .myFirstMC\n  ._mc (MC.debug = false)", domElement._mc.myFirstMC._mc);
+MC.debug = true;
+console.log("domElement\n  ._mc\n .myFirstMC\n  ._mc  (MC.debug = true)", domElement._mc.myFirstMC._mc);
+MC.debug = false;
+/*
+test selectors
+*/
+let sc = c[2]._mc.myPublicMC1; // 3rd level DIV micro component
+console.warn("sc = some div in the middle of the tree, level 3 of 5", sc);
+console.log("number of sc parents (expect 5)", sc.parents());
+console.log("number of sc parent (expect 2)", sc.parent());
+console.log("sc PUBLIC siblings (expect 2)", sc.target.className, Object.keys(sc.target._mc), sc.target._mc);
+console.log("sc PRIVATE siblings (MC.debug = false, expect undefined)", sc._mc);
+MC.debug = true;
+console.log("sc PRIVATE siblings (MC.debug = true, expect 1)", Object.keys(sc._mc).length, sc._mc);
+MC.debug = false;
+console.log("number of sc children (expect 10)", sc.children());
+console.log("number of sc descendants (expect 260)", sc.descendants());