@peter.naydenov/morph 0.0.1

package/Changelog.md

@@ -0,0 +1,7 @@
+## Release History
+
+### 1.0.0 (2017-11-30)
+
+ - [x] Initial code;
+ - [x] Test package;
+ - [x] Documentation;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Peter Naydenov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Migration.guide.md

@@ -0,0 +1,3 @@
+# Migration Guides
+
+No migration guide available yet

package/README.md

@@ -0,0 +1,207 @@
+# Morph (@peter.naydenov/morph)
+**Experimental stage. Not tested well yet.**
+
+![version](https://img.shields.io/github/package-json/v/peterNaydenov/morph)
+![license](https://img.shields.io/github/license/peterNaydenov/morph)
+![GitHub issues](https://img.shields.io/github/issues/peterNaydenov/morph)
+![GitHub top language](https://img.shields.io/github/languages/top/peterNaydenov/morph)
+![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/%40peter.naydenov%2Fmorph)
+
+
+
+## General Information
+
+`Morph` has a logic-less template syntax. Placeholders are places surrounded by double curly braces `{{ }}` and they represents the pleces where the data will be inserted.
+
+Engine is text based, so it can be used for HTML, CSS, config files, source code, etc.
+Some features of Morph:
+- Simple logic-less template syntax;
+- Builtin storage;
+- Powerfull action system for data decoration;
+- Nesting templates as part of the action system;
+- Partial rendering (render only available data);
+- Option to connect templates to external data sources;
+- Post process plugin mechanism;
+
+
+
+
+
+## Installation
+
+```
+npm install @peter.naydenov/morph
+```
+
+Morph can be used in browser and node.js.
+```js
+import morph from "@peter.naydenov/morph"
+// Morpho supports also require:
+// const morph = require("@peter.naydenov/morph")
+```
+
+
+
+
+
+## Basic Usage
+
+```js
+import morph from "@peter.naydenov/morph"
+
+const myTemplateDescription = {
+                 template: `Hello, {{name}}!` // simple template - a string with a placeholder
+            }
+const myTemplate = morph.build ( myTemplateDescription ); // myTemplate is a render function
+const htmlBlock = myTemplate ( { name: 'Peter' } )        // Provide data to the render function and get the result
+// htmlBlock === 'Hello, Peter!'
+```
+
+Morph contains also a builtin template storage. Instead of creating variable for each template, we can use the storage.
+
+```js
+morph.add ( 'myTemplate', myTemplateDescription ) // add template to the storage. Automatically builds the render function
+const htmlBlock = morph.get ( 'myTemplate' )({ name: 'Peter' }) // get template from the storage and render it
+```
+
+Let's see a more complex example before we go into details:
+```js
+const myTemplateDescription = {
+              template: `Hello, {{ person : a, >getReady }}! Your age is {{ person : >getAge}}.` 
+            , helpers: {
+                            getReady: (person) => {
+                                            return {
+                                                      text: person.name
+                                                    , href: person.web
+                                                }
+                                        }
+                          , a: `<a href="{{href}}">{{text}}</a>`
+                          , getAge: (person) => person.age
+                    }
+            }
+const myTemplate = morph.build ( myTemplateDescription );
+const htmlBlock = myTemplate ( { person: {
+                                              name: 'Peter'
+                                            , age : 40
+                                            , web : 'example.com'
+                                        } 
+                                })
+// htmlBlock === Hello, <a href="example.com">Peter</a>! Your age is 40.
+```
+
+
+
+
+
+## Template structure
+Templates are objects with tree properties: `template`, `helpers`, and `handshake`:
+```js
+const myTemplateDescription = {
+      template: `` // (required) Template string
+    , helpers: {
+                // (optional) Functions and templates used by actions to decorate the data
+        }
+    , handshake: {
+                // (optional) Example data used to render the template.
+        }
+}
+```
+`Template` is a string with placeholders where we render our external data. It's a skeleton of the template. Placeholders are the dynamic parts of the template.
+
+Helpers are a extra templates or functions needed for rendering the template. Example:
+```js
+const myTemplateDescription = {
+      template: `
+                <h1>{{title}}</h1>
+                <ul>
+                    {{list:li,a}}
+                </ul>
+            `
+    , helpers: {
+                a: `<a href="{{href}}">{{text}}</a>`,
+                li: `<li>{{text}}</li>`
+            }
+    , handshake: {
+                title: 'My title'
+              , list: [
+                          { text: 'Item 1', href: 'item1.com' }
+                        , { text: 'Item 2', href: 'item2.com' }
+                        , { text: 'Item 3', href: 'item3.com' }
+                    ]
+            }
+}
+```
+Helpers will be discussed in details in next documentation section - 'Helper Functions'.
+
+
+
+
+
+## Placeholders
+
+Template placeholders can contain data-source and actions separated by ':'. Data-source is a field of the data object used for the placeholder. Actions describe how the data should be decorated. Action is a list of operations separated by comma. Result from the first action is going as a argument to the second and so on. Executetion of actions is from right to left. Actions are optional.
+
+```js
+`{{ name : act2, act1 }}`
+// placeholder should take data from field 'name', execute 'act1' and 'act2' over it
+// actions are separated by ',' and are executed from right to left
+
+`{{ list : li, a }}`
+// take data from 'list' and render each element first with 'a' then with 'li' actions
+
+`{{ name }}` // render data from 'name'. Only data is provided to this placeholder
+`{{ :someAction}}` // no data, but the result of the action will fill the placeholder
+`{{ @all : someAction }}` // provide all the data to the action 'someAction'
+```
+
+
+
+## Actions
+
+Actions are concise representations of a sequence of function calls. Some functions pertain to `data` manipulation, others to `rendering`, and some to `mixing`. We use a prefix system for enhanced readability and maintainability.
+
+- `Render` functions are most used so they don't have any prefix;
+- `Data` functions start with '>';
+- `Mixing` functions start with '[]';
+- `Conditional render` actions start with '?';
+- `Extended render` start with '+';
+
+Here are some examples: 
+```js
+`
+{{ : li }} // example for render actions
+{{ : >setup}} // example for data actions
+{{ friends : []coma }} // example for mixing action
+{{ list : ul, [], li, a}} // example with render and mixing actions
+`
+// NOTE: See that mixing function has no name after the prefix. 
+// Anonymous mixing is a build in function that will do -> resultList.join ( '' )
+// The data will be rendered with 'a', then with 'li'
+// then all 'li' elements will be merged and will be provided to 'ul'
+```
+
+When input data is array, the result will be an array. Result for each element will stay separated until come the mixing function.
+
+Learn more about how actions work in the section 'helper functions' below.
+
+
+
+
+
+
+## Links
+- [Release history](Changelog.md)
+- [ Migration guide ](https://github.com/PeterNaydenov/morph/blob/master/Migration.guide.md)
+
+
+
+## Credits
+'@peter.naydenov/morph' was created and supported by Peter Naydenov.
+
+## License
+'@peter.naydenov/morph' is released under the MIT License.
+
+
+
+
+

package/dist/morph.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("@peter.naydenov/walk"),t=require("@peter.naydenov/stack");function r(e){return function t(r){const{TG_PRX:a,TG_SFX:o,TG_SIZE_P:s,TG_SIZE_S:c}=e;let i,l,u,f=[];if("string"!=typeof r)return n("notAString");if(0==r.length)return[];if(i=r.indexOf(a),0<i&&f.push(r.slice(0,i)),-1==i)return f.push(r),f;{if(u=r.indexOf(a,i+s),l=r.indexOf(o),-1==l)return n("missingClosing");if(l<i)return n("closedBeforeOpened");if(l+=c,-1!=u&&u<l)return n("newBeforeClosed");f.push(r.slice(i,l));let e=t(r.slice(l));return f.concat(e)}}}function n(e){switch(e){case"notAString":return"Error: Template is not a string.";case"missingClosing":return"Error: Placeholder with missing closing tag.";case"closedBeforeOpened":return"Error: Placeholder closing tag without starting one.";case"newBeforeClosed":return"Error: Nested placeholders. Close placeholder before open new one.";default:return"Error: Unknown template error."}}function a(t){const r={};let n=0;if(t instanceof Function)return{dataDeepLevel:0,nestedData:[t()]};if(null==t)return{dataDeepLevel:0,nestedData:[null]};if("string"==typeof t)return{dataDeepLevel:0,nestedData:[t]};return e({data:t,objectCallback:function({key:e,value:t,breadcrumbs:a}){let o=!1;return n=a.split("/").length-1,isNaN(e)||(o=!0),r[n]||(r[n]=o?[]:{}),"root"===e?r[n]=t:o?r[n].push(t):r[n][a]=t,t}}),{dataDeepLevel:n,nestedData:r}}var o={TG_PRX:"{{",TG_SFX:"}}",TG_SIZE_P:2,TG_SIZE_S:2};function s(e){return null==e?"null":"string"==typeof e||"number"==typeof e||"boolean"==typeof e?"primitive":"function"==typeof e?"function":e instanceof Array?"array":e instanceof Object?"object":void 0}function c(e,t,n){e instanceof Object&&Object.entries(e).forEach((([t,r])=>{r instanceof Object&&(e[t]=r.text)}));const a="function"==typeof n[t];return e=function(e={}){return"string"==typeof e?{text:e}:e}(e),a?n[t](e):function(e,t){if(null==t)return null;const n=r(o)(e),a=o;return n.forEach(((e,r)=>{if(e.includes(a.TG_PRX)){const o=e.replace(a.TG_PRX,"").replace(a.TG_SFX,"").trim();t[o]&&(n[r]=t[o])}})),n.join("")}(n[t],e)}function i(n){const{hasError:i,placeholders:l,chop:u,helpers:f,handshake:d}=function(e){const{template:t,helpers:n,handshake:a}=e,{TG_PRX:s,TG_SFX:c,TG_SIZE_P:i,TG_SIZE_S:l}=o,u=[];let f=null;const d=r(o)(t);return"string"==typeof d?f=d:d.forEach(((e,t)=>{const r=RegExp(s+"\\s*(.*?)\\s*(?::\\s*(.*?)\\s*)?"+c,"g");if(e.includes(s)){const a=r.exec(e);u.push({index:t,data:(n=a[1],n||null),action:a[2]?a[2].split(",").map((e=>e.trim())):null})}var n})),u.forEach((e=>{e.action&&e.action.every((e=>"#"===e||(e.startsWith("?")&&(e=e.replace("?","")),e.startsWith("+")&&(e=e.replace("+","")),e.startsWith("[]")&&(e=e.replace("[]","")),e.startsWith(">")&&(e=e.replace(">","")),""===e||!!n[e]||(f=`Error: Missing helper: ${e}`,!1))))})),{hasError:f,placeholders:u,chop:d,helpers:n,handshake:a}}(n);if(i)return function(){return i};{let r=structuredClone(u);return function(n={},...o){const i=s(n),u=[];if("null"===i)return r.join("");if("string"==typeof n)switch(n){case"raw":return r.join("");case"demo":if(!d)return"Error: No handshake data.";n=d;break;case"handshake":return d?structuredClone(d):"Error: No handshake data.";case"placeholders":return l.map((e=>r[e.index])).join(", ");default:return`Error: Wrong command "${n}". Available commands: raw, demo, handshake, placeholders.`}return"array"!==i&&(n=[n]),n.forEach((n=>{l.forEach((o=>{const{index:i,data:l,action:u}=o;if(!u&&l){const d=n[l];switch(s(d)){case"function":return void(r[i]=d());case"primitive":return void(r[i]=d);case"array":return void("primitive"===s(d[0])&&(r[i]=d[0]));case"object":return void(d.text&&(r[i]=d.text))}}else{const{dataDeepLevel:p,nestedData:h}=a("@all"===l||null===l||"@root"===l?n:n[l]),b=function*(e,r){let n=t({type:"LIFO"});for(let t=0;t<=r;t++)n.push(e[t]);for(;n&&!n.isEmpty();){let e=yield n.pull();e&&n.push(e)}}(function(e,t=10){let r={},n=0,a=[...e],o=0;do{r[o]=[],o++}while(o<=t);return a.every((e=>"#"===e?(n++,!(n>t)):e.startsWith("?")?(r[n].push({type:"route",name:e.replace("?",""),level:n}),!0):e.startsWith("+")?(r[n].push({type:"extendedRender",name:e.replace("+",""),level:n}),!0):e.startsWith("[]")?(r[n].push({type:"mix",name:e.replace("[]",""),level:n}),!0):e.startsWith(">")?(r[n].push({type:"data",name:e.replace(">",""),level:n}),!0):(""===e||r[n].push({type:"render",name:e,level:n}),!0))),r}(u,p),p);for(let E of b){let{type:v,name:k,level:j}=E,x=h[j],g=s(x);switch(v){case"route":switch(g){case"array":x.forEach(((e,t)=>{if(null==e)return;const r=s(e),n=f[k](e);null!=n&&("object"===r?x[t].text=c(e,n,f):x[t]=c(e,n,f))}));break;case"object":x.text=c(x,routeName,f);break;case"primitive":h[j]=c(x,routeName,f)}break;case"data":switch(g){case"array":x.forEach(((e,t)=>x[t]=e instanceof Function?f[k](e()):f[k](e)));break;case"object":case"primitive":h[j]=f[k](x);break;case"function":h[j]=f[k](x())}break;case"render":const _="function"==typeof f[k];switch(g){case"array":_?x.forEach(((e,t)=>{if(null==e)return;const r=s(e),n=f[k](e);null==n&&(x[t]=null),"object"===r?e.text=n:x[t]=n})):x.forEach(((e,t)=>{if(null==e)return;const r=s(e),n=c(e,k,f);null==n&&(x[t]=null),"object"===r?e.text=n:x[t]=n}));break;case"primitive":h[j]=c(x,k,f);break;case"object":Object.keys(x).find((e=>e.includes("/")))?Object.entries(x).forEach((([e,t])=>t.text=c(t,k,f))):x.text=c(x,k,f)}break;case"extendedRender":"function"==typeof f[k]&&(h[j]=f[k](h[0]));break;case"mix":if(""===k)switch(g){case"object":Object.keys(x).find((e=>e.includes("/")))?Object.entries(x).forEach((([e,t])=>h[j][e]=t.text)):h[j]=x.text;for(let T=j-1;T>=0;T--)h[T]=e({data:h[T],objectCallback:w});function w({value:e,breadcrumbs:t}){return h[j][t]?h[j][t]:e}break;case"array":h[j]=x.map((e=>"object"===s(e)?e.text:e)).filter((e=>null!=e)).join("")}else h[j]=f[k](x)}}let m=s(h[0]),y=h[0];switch(m){case"primitive":if(null==y)return;r[i]=y;break;case"object":if(null==y.text)return;r[i]=y.text;break;case"array":r[i]=y.join("")}}})),u.push(r.join(""))})),"array"===i?u:o?o.reduce(((e,t)=>t(e)),u.join("")):u.join("")}}}const l={default:{}};const u={build:i,get:function(e,t="default"){return l[t]?l[t][e]?l[t][e]:function(){return`Error: Template "${e}" does not exist in storage "${t}".`}:function(){return`Error: Storage "${t}" does not exist.`}},add:function(e,t,r="default"){let n=t;l[r]||(l[r]={}),"function"!=typeof t&&(n=i(t)),"success"===n.name?l[r][e]=n:console.error(`Error: Template "${e}" looks broken and is not added to storage.`)},list:function(e="default"){return l[e]?Object.keys(l[e]):[]},clear:function(){Object.keys(l).forEach((e=>{"default"!=e?delete l[e]:l.default={}}))},remove:function(e,t="default"){return l[t]?l[t][e]?void delete l[t][e]:`Error: Template "${e}" does not exist in storage "${t}".`:`Error: Storage "${t}" does not exist.`}};module.exports=u;

package/dist/morph.esm.mjs

@@ -0,0 +1 @@
+import e from"@peter.naydenov/walk";import t from"@peter.naydenov/stack";function r(e){return function t(r){const{TG_PRX:a,TG_SFX:o,TG_SIZE_P:s,TG_SIZE_S:c}=e;let i,l,u,f=[];if("string"!=typeof r)return n("notAString");if(0==r.length)return[];if(i=r.indexOf(a),0<i&&f.push(r.slice(0,i)),-1==i)return f.push(r),f;{if(u=r.indexOf(a,i+s),l=r.indexOf(o),-1==l)return n("missingClosing");if(l<i)return n("closedBeforeOpened");if(l+=c,-1!=u&&u<l)return n("newBeforeClosed");f.push(r.slice(i,l));let e=t(r.slice(l));return f.concat(e)}}}function n(e){switch(e){case"notAString":return"Error: Template is not a string.";case"missingClosing":return"Error: Placeholder with missing closing tag.";case"closedBeforeOpened":return"Error: Placeholder closing tag without starting one.";case"newBeforeClosed":return"Error: Nested placeholders. Close placeholder before open new one.";default:return"Error: Unknown template error."}}function a(t){const r={};let n=0;if(t instanceof Function)return{dataDeepLevel:0,nestedData:[t()]};if(null==t)return{dataDeepLevel:0,nestedData:[null]};if("string"==typeof t)return{dataDeepLevel:0,nestedData:[t]};return e({data:t,objectCallback:function({key:e,value:t,breadcrumbs:a}){let o=!1;return n=a.split("/").length-1,isNaN(e)||(o=!0),r[n]||(r[n]=o?[]:{}),"root"===e?r[n]=t:o?r[n].push(t):r[n][a]=t,t}}),{dataDeepLevel:n,nestedData:r}}var o={TG_PRX:"{{",TG_SFX:"}}",TG_SIZE_P:2,TG_SIZE_S:2};function s(e){return null==e?"null":"string"==typeof e||"number"==typeof e||"boolean"==typeof e?"primitive":"function"==typeof e?"function":e instanceof Array?"array":e instanceof Object?"object":void 0}function c(e,t,n){e instanceof Object&&Object.entries(e).forEach((([t,r])=>{r instanceof Object&&(e[t]=r.text)}));const a="function"==typeof n[t];return e=function(e={}){return"string"==typeof e?{text:e}:e}(e),a?n[t](e):function(e,t){if(null==t)return null;const n=r(o)(e),a=o;return n.forEach(((e,r)=>{if(e.includes(a.TG_PRX)){const o=e.replace(a.TG_PRX,"").replace(a.TG_SFX,"").trim();t[o]&&(n[r]=t[o])}})),n.join("")}(n[t],e)}function i(n){const{hasError:i,placeholders:l,chop:u,helpers:f,handshake:d}=function(e){const{template:t,helpers:n,handshake:a}=e,{TG_PRX:s,TG_SFX:c,TG_SIZE_P:i,TG_SIZE_S:l}=o,u=[];let f=null;const d=r(o)(t);return"string"==typeof d?f=d:d.forEach(((e,t)=>{const r=RegExp(s+"\\s*(.*?)\\s*(?::\\s*(.*?)\\s*)?"+c,"g");if(e.includes(s)){const a=r.exec(e);u.push({index:t,data:(n=a[1],n||null),action:a[2]?a[2].split(",").map((e=>e.trim())):null})}var n})),u.forEach((e=>{e.action&&e.action.every((e=>"#"===e||(e.startsWith("?")&&(e=e.replace("?","")),e.startsWith("+")&&(e=e.replace("+","")),e.startsWith("[]")&&(e=e.replace("[]","")),e.startsWith(">")&&(e=e.replace(">","")),""===e||!!n[e]||(f=`Error: Missing helper: ${e}`,!1))))})),{hasError:f,placeholders:u,chop:d,helpers:n,handshake:a}}(n);if(i)return function(){return i};{let r=structuredClone(u);return function(n={},...o){const i=s(n),u=[];if("null"===i)return r.join("");if("string"==typeof n)switch(n){case"raw":return r.join("");case"demo":if(!d)return"Error: No handshake data.";n=d;break;case"handshake":return d?structuredClone(d):"Error: No handshake data.";case"placeholders":return l.map((e=>r[e.index])).join(", ");default:return`Error: Wrong command "${n}". Available commands: raw, demo, handshake, placeholders.`}return"array"!==i&&(n=[n]),n.forEach((n=>{l.forEach((o=>{const{index:i,data:l,action:u}=o;if(!u&&l){const d=n[l];switch(s(d)){case"function":return void(r[i]=d());case"primitive":return void(r[i]=d);case"array":return void("primitive"===s(d[0])&&(r[i]=d[0]));case"object":return void(d.text&&(r[i]=d.text))}}else{const{dataDeepLevel:p,nestedData:h}=a("@all"===l||null===l||"@root"===l?n:n[l]),b=function*(e,r){let n=t({type:"LIFO"});for(let t=0;t<=r;t++)n.push(e[t]);for(;n&&!n.isEmpty();){let e=yield n.pull();e&&n.push(e)}}(function(e,t=10){let r={},n=0,a=[...e],o=0;do{r[o]=[],o++}while(o<=t);return a.every((e=>"#"===e?(n++,!(n>t)):e.startsWith("?")?(r[n].push({type:"route",name:e.replace("?",""),level:n}),!0):e.startsWith("+")?(r[n].push({type:"extendedRender",name:e.replace("+",""),level:n}),!0):e.startsWith("[]")?(r[n].push({type:"mix",name:e.replace("[]",""),level:n}),!0):e.startsWith(">")?(r[n].push({type:"data",name:e.replace(">",""),level:n}),!0):(""===e||r[n].push({type:"render",name:e,level:n}),!0))),r}(u,p),p);for(let E of b){let{type:v,name:k,level:j}=E,x=h[j],g=s(x);switch(v){case"route":switch(g){case"array":x.forEach(((e,t)=>{if(null==e)return;const r=s(e),n=f[k](e);null!=n&&("object"===r?x[t].text=c(e,n,f):x[t]=c(e,n,f))}));break;case"object":x.text=c(x,routeName,f);break;case"primitive":h[j]=c(x,routeName,f)}break;case"data":switch(g){case"array":x.forEach(((e,t)=>x[t]=e instanceof Function?f[k](e()):f[k](e)));break;case"object":case"primitive":h[j]=f[k](x);break;case"function":h[j]=f[k](x())}break;case"render":const _="function"==typeof f[k];switch(g){case"array":_?x.forEach(((e,t)=>{if(null==e)return;const r=s(e),n=f[k](e);null==n&&(x[t]=null),"object"===r?e.text=n:x[t]=n})):x.forEach(((e,t)=>{if(null==e)return;const r=s(e),n=c(e,k,f);null==n&&(x[t]=null),"object"===r?e.text=n:x[t]=n}));break;case"primitive":h[j]=c(x,k,f);break;case"object":Object.keys(x).find((e=>e.includes("/")))?Object.entries(x).forEach((([e,t])=>t.text=c(t,k,f))):x.text=c(x,k,f)}break;case"extendedRender":"function"==typeof f[k]&&(h[j]=f[k](h[0]));break;case"mix":if(""===k)switch(g){case"object":Object.keys(x).find((e=>e.includes("/")))?Object.entries(x).forEach((([e,t])=>h[j][e]=t.text)):h[j]=x.text;for(let T=j-1;T>=0;T--)h[T]=e({data:h[T],objectCallback:w});function w({value:e,breadcrumbs:t}){return h[j][t]?h[j][t]:e}break;case"array":h[j]=x.map((e=>"object"===s(e)?e.text:e)).filter((e=>null!=e)).join("")}else h[j]=f[k](x)}}let m=s(h[0]),y=h[0];switch(m){case"primitive":if(null==y)return;r[i]=y;break;case"object":if(null==y.text)return;r[i]=y.text;break;case"array":r[i]=y.join("")}}})),u.push(r.join(""))})),"array"===i?u:o?o.reduce(((e,t)=>t(e)),u.join("")):u.join("")}}}const l={default:{}};const u={build:i,get:function(e,t="default"){return l[t]?l[t][e]?l[t][e]:function(){return`Error: Template "${e}" does not exist in storage "${t}".`}:function(){return`Error: Storage "${t}" does not exist.`}},add:function(e,t,r="default"){let n=t;l[r]||(l[r]={}),"function"!=typeof t&&(n=i(t)),"success"===n.name?l[r][e]=n:console.error(`Error: Template "${e}" looks broken and is not added to storage.`)},list:function(e="default"){return l[e]?Object.keys(l[e]):[]},clear:function(){Object.keys(l).forEach((e=>{"default"!=e?delete l[e]:l.default={}}))},remove:function(e,t="default"){return l[t]?l[t][e]?void delete l[t][e]:`Error: Template "${e}" does not exist in storage "${t}".`:`Error: Storage "${t}" does not exist.`}};export{u as default};

package/dist/morph.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t(require("@peter.naydenov/walk")):"function"==typeof define&&define.amd?define(["@peter.naydenov/walk"],t):(e="undefined"!=typeof globalThis?globalThis:e||self).morph=t(e.walk)}(this,(function(e){"use strict";function t(e){return function t(n){const{TG_PRX:o,TG_SFX:a,TG_SIZE_P:i,TG_SIZE_S:s}=e;let l,c,u,f=[];if("string"!=typeof n)return r("notAString");if(0==n.length)return[];if(l=n.indexOf(o),0<l&&f.push(n.slice(0,l)),-1==l)return f.push(n),f;{if(u=n.indexOf(o,l+i),c=n.indexOf(a),-1==c)return r("missingClosing");if(c<l)return r("closedBeforeOpened");if(c+=s,-1!=u&&u<c)return r("newBeforeClosed");f.push(n.slice(l,c));let e=t(n.slice(c));return f.concat(e)}}}function r(e){switch(e){case"notAString":return"Error: Template is not a string.";case"missingClosing":return"Error: Placeholder with missing closing tag.";case"closedBeforeOpened":return"Error: Placeholder closing tag without starting one.";case"newBeforeClosed":return"Error: Nested placeholders. Close placeholder before open new one.";default:return"Error: Unknown template error."}}function n(t){const r={};let n=0;if(t instanceof Function)return{dataDeepLevel:0,nestedData:[t()]};if(null==t)return{dataDeepLevel:0,nestedData:[null]};if("string"==typeof t)return{dataDeepLevel:0,nestedData:[t]};return e({data:t,objectCallback:function({key:e,value:t,breadcrumbs:o}){let a=!1;return n=o.split("/").length-1,isNaN(e)||(a=!0),r[n]||(r[n]=a?[]:{}),"root"===e?r[n]=t:a?r[n].push(t):r[n][o]=t,t}}),{dataDeepLevel:n,nestedData:r}}function*o(e,t){let r=function(e={}){let t=[],{type:r,limit:n,onLimit:o}=Object.assign({},{type:"FIFO",limit:!1,onLimit:"update"},e),a="LIFO"===r.toUpperCase(),i=!1;function s(e=1,r=0){let n=[];return r>0&&Array.from({length:r}).map((()=>t.pop())),1==e?t.pop():(Array.from({length:e}).map((()=>{let e=t.pop();null!=e&&n.push(e)})),n)}function l(e=1,r=0){let n=[],o=t.length-r;return e>1&&Array.from({length:e}).map((()=>{null!=t[o-1]&&n.push(t[o-1]),o--})),1==e?t[t.length-1]:n}function c(){}return c.prototype={pull:s,pullReverse:function(e=1,t=0){let r=s(e,t);return r instanceof Array?r.reverse():r},peek:l,peekReverse:function(e=1,t=0){const r=l(e,t);return r instanceof Array?r.reverse():r},getSize:()=>t.length,isEmpty:()=>0==t.length,reset:()=>(t=[],!0),debug:()=>[...t]},c.prototype.push=a?function(e){const r=e instanceof Array,a=r?e.length:1;let l=!1;if("full"!==o||!i){if(n&&r&&a>n&&(e=e.slice(0,-a+n)),n){const a=(r?e.length:1)+t.length;a>=n&&"full"===o&&(e=e.slice(0,-(a-n))),a>=n&&"update"===o&&(l=s(a-n))}return t=e instanceof Array?t.concat(e):t.concat([e]),i=!!n&&t.length===n,l||void 0}}:function(e){const r=e instanceof Array,a=r?e.length:1;let l=!1;if("full"!==o||!i){if(n&&r&&a>n&&(e=e.slice(a-n)),n){const a=(r?e.length:1)+t.length;a>=n&&"full"===o&&(e=e.slice(0,-(a-n))),a>=n&&"update"===o&&(l=s(a-n))}return t=r?e.reduce(((e,t)=>[t,...e]),t):[e].reduce(((e,t)=>[t,...e]),t),i=!!n&&t.length===n,l||void 0}},new c}({type:"LIFO"});for(let n=0;n<=t;n++)r.push(e[n]);for(;r&&!r.isEmpty();){let e=yield r.pull();e&&r.push(e)}}var a={TG_PRX:"{{",TG_SFX:"}}",TG_SIZE_P:2,TG_SIZE_S:2};function i(e){return null==e?"null":"string"==typeof e||"number"==typeof e||"boolean"==typeof e?"primitive":"function"==typeof e?"function":e instanceof Array?"array":e instanceof Object?"object":void 0}function s(e,r,n){e instanceof Object&&Object.entries(e).forEach((([t,r])=>{r instanceof Object&&(e[t]=r.text)}));const o="function"==typeof n[r];return e=function(e={}){return"string"==typeof e?{text:e}:e}(e),o?n[r](e):function(e,r){if(null==r)return null;const n=t(a)(e),o=a;return n.forEach(((e,t)=>{if(e.includes(o.TG_PRX)){const a=e.replace(o.TG_PRX,"").replace(o.TG_SFX,"").trim();r[a]&&(n[t]=r[a])}})),n.join("")}(n[r],e)}function l(r){const{hasError:l,placeholders:c,chop:u,helpers:f,handshake:p}=function(e){const{template:r,helpers:n,handshake:o}=e,{TG_PRX:i,TG_SFX:s,TG_SIZE_P:l,TG_SIZE_S:c}=a,u=[];let f=null;const p=t(a)(r);return"string"==typeof p?f=p:p.forEach(((e,t)=>{const r=RegExp(i+"\\s*(.*?)\\s*(?::\\s*(.*?)\\s*)?"+s,"g");if(e.includes(i)){const o=r.exec(e);u.push({index:t,data:(n=o[1],n||null),action:o[2]?o[2].split(",").map((e=>e.trim())):null})}var n})),u.forEach((e=>{e.action&&e.action.every((e=>"#"===e||(e.startsWith("?")&&(e=e.replace("?","")),e.startsWith("+")&&(e=e.replace("+","")),e.startsWith("[]")&&(e=e.replace("[]","")),e.startsWith(">")&&(e=e.replace(">","")),""===e||!!n[e]||(f=`Error: Missing helper: ${e}`,!1))))})),{hasError:f,placeholders:u,chop:p,helpers:n,handshake:o}}(r);if(l)return function(){return l};{let t=structuredClone(u);return function(r={},...a){const l=i(r),u=[];if("null"===l)return t.join("");if("string"==typeof r)switch(r){case"raw":return t.join("");case"demo":if(!p)return"Error: No handshake data.";r=p;break;case"handshake":return p?structuredClone(p):"Error: No handshake data.";case"placeholders":return c.map((e=>t[e.index])).join(", ");default:return`Error: Wrong command "${r}". Available commands: raw, demo, handshake, placeholders.`}return"array"!==l&&(r=[r]),r.forEach((r=>{c.forEach((a=>{const{index:l,data:c,action:u}=a;if(!u&&c){const p=r[c];switch(i(p)){case"function":return void(t[l]=p());case"primitive":return void(t[l]=p);case"array":return void("primitive"===i(p[0])&&(t[l]=p[0]));case"object":return void(p.text&&(t[l]=p.text))}}else{const{dataDeepLevel:d,nestedData:h}=n("@all"===c||null===c||"@root"===c?r:r[c]),m=o(function(e,t=10){let r={},n=0,o=[...e],a=0;do{r[a]=[],a++}while(a<=t);return o.every((e=>"#"===e?(n++,!(n>t)):e.startsWith("?")?(r[n].push({type:"route",name:e.replace("?",""),level:n}),!0):e.startsWith("+")?(r[n].push({type:"extendedRender",name:e.replace("+",""),level:n}),!0):e.startsWith("[]")?(r[n].push({type:"mix",name:e.replace("[]",""),level:n}),!0):e.startsWith(">")?(r[n].push({type:"data",name:e.replace(">",""),level:n}),!0):(""===e||r[n].push({type:"render",name:e,level:n}),!0))),r}(u,d),d);for(let g of m){let{type:v,name:E,level:k}=g,j=h[k],x=i(j);switch(v){case"route":switch(x){case"array":j.forEach(((e,t)=>{if(null==e)return;const r=i(e),n=f[E](e);null!=n&&("object"===r?j[t].text=s(e,n,f):j[t]=s(e,n,f))}));break;case"object":j.text=s(j,routeName,f);break;case"primitive":h[k]=s(j,routeName,f)}break;case"data":switch(x){case"array":j.forEach(((e,t)=>j[t]=e instanceof Function?f[E](e()):f[E](e)));break;case"object":case"primitive":h[k]=f[E](j);break;case"function":h[k]=f[E](j())}break;case"render":const w="function"==typeof f[E];switch(x){case"array":w?j.forEach(((e,t)=>{if(null==e)return;const r=i(e),n=f[E](e);null==n&&(j[t]=null),"object"===r?e.text=n:j[t]=n})):j.forEach(((e,t)=>{if(null==e)return;const r=i(e),n=s(e,E,f);null==n&&(j[t]=null),"object"===r?e.text=n:j[t]=n}));break;case"primitive":h[k]=s(j,E,f);break;case"object":Object.keys(j).find((e=>e.includes("/")))?Object.entries(j).forEach((([e,t])=>t.text=s(t,E,f))):j.text=s(j,E,f)}break;case"extendedRender":"function"==typeof f[E]&&(h[k]=f[E](h[0]));break;case"mix":if(""===E)switch(x){case"object":Object.keys(j).find((e=>e.includes("/")))?Object.entries(j).forEach((([e,t])=>h[k][e]=t.text)):h[k]=j.text;for(let _=k-1;_>=0;_--)h[_]=e({data:h[_],objectCallback:T});function T({value:e,breadcrumbs:t}){return h[k][t]?h[k][t]:e}break;case"array":h[k]=j.map((e=>"object"===i(e)?e.text:e)).filter((e=>null!=e)).join("")}else h[k]=f[E](j)}}let y=i(h[0]),b=h[0];switch(y){case"primitive":if(null==b)return;t[l]=b;break;case"object":if(null==b.text)return;t[l]=b.text;break;case"array":t[l]=b.join("")}}})),u.push(t.join(""))})),"array"===l?u:a?a.reduce(((e,t)=>t(e)),u.join("")):u.join("")}}}const c={default:{}};return{build:l,get:function(e,t="default"){return c[t]?c[t][e]?c[t][e]:function(){return`Error: Template "${e}" does not exist in storage "${t}".`}:function(){return`Error: Storage "${t}" does not exist.`}},add:function(e,t,r="default"){let n=t;c[r]||(c[r]={}),"function"!=typeof t&&(n=l(t)),"success"===n.name?c[r][e]=n:console.error(`Error: Template "${e}" looks broken and is not added to storage.`)},list:function(e="default"){return c[e]?Object.keys(c[e]):[]},clear:function(){Object.keys(c).forEach((e=>{"default"!=e?delete c[e]:c.default={}}))},remove:function(e,t="default"){return c[t]?c[t][e]?void delete c[t][e]:`Error: Template "${e}" does not exist in storage "${t}".`:`Error: Storage "${t}" does not exist.`}}}));

package/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "@peter.naydenov/morph",
+    "description": "Template engine",
+    "version": "0.0.1",
+    "license": "MIT",
+    "author": "Peter Naydenov",
+    "main": "./dist/morph.umd.js",
+    "type": "module",
+    "exports": {
+        ".": {
+            "import": "./dist/morph.esm.mjs",
+            "require": "./dist/morph.cjs",
+            "default": "./dist/morph.umd.js"
+        },
+        "./package.json": "./package.json",
+        "./dist/*": "./dist/*",
+        "./src/*": "./src/*"
+    },
+    "scripts": {
+        "test": "mocha test",
+        "cover": "c8 mocha",
+        "build": "rollup -c"
+    },
+    "dependencies": {
+            "@peter.naydenov/stack": "^3.0.0",
+            "@peter.naydenov/walk": "^5.0.0"
+        },
+    "devDependencies": {
+        "@rollup/plugin-commonjs": "^28.0.0",
+        "@rollup/plugin-node-resolve": "^15.3.0",
+        "@rollup/plugin-terser": "^0.4.4",
+        "c8": "^10.1.2",
+        "chai": "5.1.2",
+        "mocha": "10.8.2",
+        "rollup": "^4.27.4"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/PeterNaydenov/morph.git"
+    },
+    "c8": {
+        "include": [
+            "src/**/*.js"
+        ],
+        "exclude": [
+            "node_modules",
+            "test"
+        ],
+        "reporter": [
+            "lcov",
+            "text-summary"
+        ]
+    },
+    "keywords": [
+        "template",
+        "engine",
+        "string",
+        "function"
+    ]
+    
+}

package/rollup.config.js

@@ -0,0 +1,42 @@
+import resolve    from '@rollup/plugin-node-resolve'
+import commonjs   from '@rollup/plugin-commonjs'
+import terser     from '@rollup/plugin-terser';
+
+
+export default [
+	// browser-friendly UMD build
+	{
+		input: 'src/main.js',
+		output: {
+			name: 'morph',
+			file: 'dist/morph.umd.js',
+			format: 'umd',
+			globals: {
+						  '@peter.naydenov/walk': 'walk'
+                        , '@peter.naydenov/stack': 'stack'
+					}
+		},
+		external: ['@peter.naydenov/walk'],
+		plugins: [
+			resolve(), // so Rollup can find `ms`
+			commonjs() // so Rollup can convert `ms` to an ES module
+			, terser()
+		]
+	},
+
+	// CommonJS (for Node) and ES module (for bundlers) build.
+	// (We could have three entries in the configuration array
+	// instead of two, but it's quicker to generate multiple
+	// builds from a single configuration where possible, using
+	// an array for the `output` option, where we can specify
+	// `file` and `format` for each target)
+	{
+		input: 'src/main.js',
+		external: ['@peter.naydenov/walk', '@peter.naydenov/stack'],
+		output: [
+			{ file: 'dist/morph.cjs'    , format: 'cjs' },
+			{ file: 'dist/morph.esm.mjs', format: 'es' }
+		],
+		plugins: [ terser() ]
+	}
+];

package/src/main.js

@@ -0,0 +1,100 @@
+/***
+ *   Morph (@peter.naydenov/morph)
+ * 
+ *   Text based template engine
+ * 
+ * 
+ *   History notes:
+ *   - Idea was born on October 28th, 2024.  
+ *   - Published on GitHub for first time: November 30th, 2024
+ * 
+ */
+
+
+import build from "./methods/build.js"
+
+
+
+const storage = { default: {}};
+
+
+
+function get ( prop, strName='default' ) {
+    if ( !storage[strName] ) {
+            return function () {
+                  return `Error: Storage "${strName}" does not exist.`
+               }
+        }
+    if ( !storage[strName][prop] ) {
+            return function () {
+                  return `Error: Template "${prop}" does not exist in storage "${strName}".`
+               }
+        }
+    return storage[strName][prop]
+} // get func.
+
+
+
+function add ( name, tplfn, strName='default' ) {
+    let fn = tplfn;
+    if( !storage[strName] )   storage[strName] = {}
+    if ( typeof tplfn !== 'function' ) fn = build ( tplfn );
+    if ( fn.name === 'success' )       storage[strName][name] = fn
+    else                               console.error ( `Error: Template "${name}" looks broken and is not added to storage.` )
+} // add func.
+
+
+
+function list ( strName='default' ) {
+    if ( !storage[strName] )   return []
+    return Object.keys ( storage[strName] )  
+} // list func. 
+
+
+
+function clear ( ) {
+    const keys = Object.keys ( storage )
+    keys.forEach ( key => {
+              if ( key != 'default' )   delete storage[key]
+              else                      storage['default'] = {}
+          })
+} // clear func.
+
+
+
+function remove ( name, strName='default' ) {
+    if ( !storage[strName]       )   return `Error: Storage "${strName}" does not exist.`
+    if ( !storage[strName][name] )   return `Error: Template "${name}" does not exist in storage "${strName}".`
+    delete storage[strName][name]
+} // remove func.
+
+
+
+const morphAPI = {
+                //  Engine API
+                /**
+                 *  
+                 *  build - 
+                 *  add - register a component to component storage
+                 *  get - get a component from component storage
+                 *  list - list all components in component storage
+                 *  clear - clear all templates in component storage
+                 *  remove - remove a template from component storage
+                 *  
+                 *  shine - extra step to remove all non used placeholders and <rs> tags
+                 * 
+                 */
+                  build   // build a component from template description
+                , get     // get a component from component storage
+                , add     // add a component to component storage
+                , list    // list all components in component storage
+                , clear   // clear all templates in component storage
+                , remove  // remove a template from component storage
+} // morphAPI
+
+// TODO: How to change render templates on condition?
+// - Use compiled versions of simile templates
+
+export default morphAPI
+
+

package/src/methods/_actionSupply.js

@@ -0,0 +1,19 @@
+import stack from "@peter.naydenov/stack"
+
+
+
+function* _actionSupply ( act, level ) {
+    let action = stack ({ type:'LIFO' });
+    for ( let i=0; i<=level; i++ ) {
+                    action.push ( act[i] )          
+            }
+    while ( action && !action.isEmpty () ) {
+                    let newAct = yield action.pull ()
+                    if ( newAct )  action.push ( newAct )
+            }                        
+} // _actionSupply func.
+
+
+export default _actionSupply
+
+

package/src/methods/_chopTemplates.js

@@ -0,0 +1,60 @@
+function _chopTemplate ( settings ) {
+    return function _chopTemplate ( text ) {
+        const { TG_PRX, TG_SFX, TG_SIZE_P, TG_SIZE_S } = settings;
+        let 
+            start      // placeholder start
+          , end        // placeholder end
+          , checkPoint // check 
+          , res = []   // template result array
+          ;
+    
+        if ( typeof(text) != 'string' ) return showError( 'notAString' ) // Template is not a string
+        if ( text.length == 0 ) return []
+    
+        start = text.indexOf ( TG_PRX )
+        if ( 0 < start )  res.push ( text.slice(0, start) )
+        if ( -1 == start ) {
+                    res.push( text  )
+                    return res;
+             }
+        else {
+                    checkPoint = text.indexOf ( TG_PRX, start+TG_SIZE_P )
+                    end = text.indexOf( TG_SFX )
+    
+                    if ( end == -1   ) return showError('missingClosing') // Placeholder with missing closing tags
+                    if ( end < start ) return showError('closedBeforeOpened') // Placeholder closing tags without starting ones
+                    else               end += TG_SIZE_S 
+    
+                    if ( checkPoint != -1 && checkPoint < end ) {
+                         return showError('newBeforeClosed') // New placeholder before first ends
+                       }
+    
+                    res.push( text.slice(start,end) )
+                    let nextText = text.slice (end)
+                    let additional = _chopTemplate ( nextText )
+                    return res.concat ( additional )
+             }
+    }} // chopTemplate func.
+    
+    
+    
+    function showError (type) {
+            switch (type) {
+                  case 'notAString': 
+                            return `Error: Template is not a string.`
+                  case 'missingClosing':
+                            return `Error: Placeholder with missing closing tag.`
+                  case 'closedBeforeOpened':
+                            return `Error: Placeholder closing tag without starting one.`
+                  case 'newBeforeClosed':
+                            return `Error: Nested placeholders. Close placeholder before open new one.`
+                  default: 
+                            return `Error: Unknown template error.`
+                }
+    } // showError func.
+    
+    
+    
+    export default _chopTemplate
+    
+    

package/src/methods/_defineData.js

@@ -0,0 +1,32 @@
+import walk from '@peter.naydenov/walk'
+
+
+
+function _defineData ( d ) {
+    const nestedData = {};
+    let dataDeepLevel = 0;
+
+    if ( d instanceof Function )   return {  dataDeepLevel:0, nestedData:[d()] }
+    if ( d == null             )   return {  dataDeepLevel:0, nestedData:[ null ] }
+    if ( typeof d === 'string' )   return {  dataDeepLevel:0, nestedData:[d] }
+    
+           function findObjects ({key, value, breadcrumbs}) {
+                    let isArray = false;
+                    dataDeepLevel = breadcrumbs.split('/').length -1;
+                    if ( !isNaN(key) )  isArray = true 
+                    if ( !nestedData[dataDeepLevel] )   nestedData[dataDeepLevel] = isArray? [] : {}
+                    if ( key === 'root' ) nestedData[dataDeepLevel] = value
+                    else if ( isArray )   nestedData[dataDeepLevel].push ( value )
+                    else                  nestedData[dataDeepLevel][breadcrumbs] = value
+                    return value
+            } // step func.
+
+    walk ({ data:d, objectCallback:findObjects })
+    return { dataDeepLevel, nestedData }
+} // _defineData func.
+
+
+
+export default _defineData
+
+

package/src/methods/_defineType.js

@@ -0,0 +1,16 @@
+function _defineDataType ( data ) {
+    
+    if ( data == null )              return  'null'
+    if ( typeof data === 'string'  ) return 'primitive'
+    if ( typeof data === 'number'  ) return 'primitive'
+    if ( typeof data === 'boolean' ) return 'primitive'
+    if ( typeof data === 'function') return 'function'
+    if ( data instanceof Array     ) return 'array'
+    if ( data instanceof Object    ) return 'object'
+    return undefined
+} // _defineDataType func.
+
+
+export default _defineDataType
+
+