tulisix 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 rezzvy
+
+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/README.md

@@ -0,0 +1,244 @@
+# Tulisix
+
+Transform text nodes into any format imaginable.
+
+## Overview
+
+Tulisix lets you transform text nodes into specific formats based on rules you define.
+
+- Rule-based transformation
+- Supports dynamic variables
+- Function-based output for advanced logic
+- Automatic HTML escaping (XSS-safe by default)
+
+## Installation & Usage
+
+### Installation
+
+#### Browser
+
+Include via CDN:
+
+```html
+<script src="https://cdn.jsdelivr.net/gh/rezzvy/tulisix@465b13b/dist/tulisix.min.js"></script>
+```
+
+```javascript
+const tulisix = new Tulisix();
+```
+
+#### Node
+
+Install via npm:
+
+```bash
+npm install tulisix
+```
+
+```javascript
+import Tulisix from "tulisix";
+const tulisix = new Tulisix();
+```
+
+## Usage
+
+```html
+<div id="app">Hello Reza</div>
+```
+
+```javascript
+tulisix.addRule({
+  from: "Hello {name}",
+  to: "<strong>Hello {name}</strong>",
+});
+
+tulisix.replace("#app");
+```
+
+## Examples
+
+### Multiple Patterns
+
+```html
+<p class="text">Hi Reza</p>
+```
+
+```javascript
+const tulisix = new Tulisix();
+
+tulisix.addRule({
+  from: ["Hi {name}", "Hello {name}"],
+  to: "<b>{name}</b>",
+});
+
+tulisix.replace(".text");
+```
+
+### Dynamic Output (Function)
+
+```html
+<p class="price">Price: 100</p>
+```
+
+```javascript
+const tulisix = new Tulisix();
+
+tulisix.addRule({
+  from: "Price: {value}",
+  to: (safe, match, raw) => {
+    return `<span>$${Number(raw.value).toFixed(2)}</span>`;
+  },
+});
+
+tulisix.replace(".price");
+```
+
+### Case Insensitive
+
+```html
+<p class="text">hello Reza</p>
+```
+
+```javascript
+const tulisix = new Tulisix();
+
+tulisix.addRule({
+  from: "hello {name}",
+  to: "<i>{name}</i>",
+  caseSensitive: false,
+});
+
+tulisix.replace(".text");
+```
+
+### Escaping Curly Braces
+
+```html
+<p class="text">{not a variable}</p>
+```
+
+```javascript
+const tulisix = new Tulisix();
+
+tulisix.addRule({
+  from: "\\{not a variable\\}",
+  to: "<span>literal</span>",
+});
+
+tulisix.replace(".text");
+```
+
+### Multiple Rules
+
+```html
+<p class="text">**bold** and *italic*</p>
+```
+
+```javascript
+const tulisix = new Tulisix();
+
+tulisix.addRule([
+  {
+    from: "**{text}**",
+    to: "<strong>{text}</strong>",
+  },
+  {
+    from: "*{text}*",
+    to: "<em>{text}</em>",
+  },
+]);
+
+tulisix.replace(".text");
+```
+
+## Documentation
+
+### API Reference
+
+#### `addRule(param)`
+
+Register one or more transformation rules.
+
+| Parameter | Type                        | Description                           |
+| :-------- | :-------------------------- | :------------------------------------ |
+| `param`   | `Object` \| `Array<Object>` | Rule object or array of rule objects. |
+
+##### Rule Object Structure
+
+| Property        | Type                        | Required | Default | Description                             |
+| :-------------- | :-------------------------- | :------- | :------ | :-------------------------------------- |
+| `from`          | `String` \| `Array<String>` | Yes      | -       | Pattern(s) with optional `{variables}`. |
+| `to`            | `String` \| `Function`      | Yes      | -       | Replacement string or function.         |
+| `caseSensitive` | `Boolean`                   | No       | `true`  | Enable/disable case-sensitive matching. |
+
+##### `to` Function Arguments
+
+Used when `to` is a function:
+
+| Argument   | Type     | Description                               |
+| :--------- | :------- | :---------------------------------------- |
+| `safeVars` | `Object` | Escaped variables (safe for HTML output). |
+| `match`    | `Array`  | Result from `RegExp.exec()`.              |
+| `rawVars`  | `Object` | Original (unescaped) variable values.     |
+
+#### `replace(target)`
+
+Apply all registered rules to the target.
+
+| Parameter | Type                                                    | Description                                        |
+| :-------- | :------------------------------------------------------ | :------------------------------------------------- |
+| `target`  | `String` \| `Element` \| `NodeList` \| `Array<Element>` | Selector or collection of DOM elements to process. |
+
+### Limitations
+
+#### Text nodes only
+
+Tulisix only processes text nodes. It does not parse or transform HTML attributes or element structures.
+Example: `<div title="Hello Reza">` will NOT be transformed.
+
+#### No cross-node matching
+
+Patterns must exist within a single text node.
+Text split across multiple elements will not match.
+
+Example:
+
+```html
+<span>Hello</span> <span>Reza</span>
+```
+
+Will NOT match `Hello {name}`.
+
+#### HTML output is not sanitized
+
+Only variables are automatically escaped.
+If you return raw HTML in `to`, you are responsible for ensuring it is safe.
+
+#### Greedy / ambiguous patterns
+
+Patterns using `{variables}` may behave unexpectedly if the structure is ambiguous.
+
+Example:
+
+```
+"{a} {b}"
+```
+
+may produce unintended matches depending on content.
+
+#### Order matters
+
+Rules are applied sequentially.
+Earlier rules can affect later matches.
+
+#### Not a full template engine
+
+Tulisix is designed for lightweight text transformation, not full HTML templating or parsing.
+
+## Contributing
+
+There's always room for improvement. Feel free to contribute!
+
+## Licensing
+
+The project is licensed under the MIT License. Check the license file for more details.

package/dist/tulisix.esm.js

@@ -0,0 +1 @@
+var g=class{#e=[];#t;constructor(){this.#t=document.createElement("template")}addRule(e){if(!e)return;let r=Array.isArray(e)?e:[e];for(let t of r){if(typeof t!="object"||t===null)throw new TypeError("Each rule must be a valid object.");if(!t.from)throw new Error("Rule is missing the required 'from' property.");if(typeof t.from!="string"&&!Array.isArray(t.from))throw new TypeError("Rule 'from' property must be a string or an array of strings.");if(typeof t.to!="string"&&typeof t.to!="function")throw new TypeError("Rule 'to' property must be a string or a function.");let o=Array.isArray(t.from)?t.from:[t.from],i=t.caseSensitive!==!1;for(let s of o){if(typeof s!="string")throw new TypeError(`Invalid pattern in 'from': ${s}. Must be a string.`);let n=this.#n(s,i);this.#e.push({regex:n.regex,varNames:n.varNames,to:t.to})}}}#n(e,r){let t=[];e=e.replace(/\\\{/g,"__ESCAPED_OPEN__").replace(/\\\}/g,"__ESCAPED_CLOSE__");let o=[],i=0,s=/\{([a-zA-Z0-9_]+)\}/g,n;for(;n=s.exec(e);){let[c,m]=n,f=n.index,p=e.slice(i,f);o.push(p.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&")),t.push(m);let h=f+c.length===e.length;o.push(h?"([^\\s<]+)":"(.*?)"),i=f+c.length}let a=e.slice(i);o.push(a.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&"));let l=o.join("");return l=l.replace(/__ESCAPED_OPEN__/g,"\\{").replace(/__ESCAPED_CLOSE__/g,"\\}"),{regex:new RegExp(l,r?"g":"gi"),varNames:t}}replace(e){if(!this.#e.length)return;let r;if(typeof e=="string")r=document.querySelectorAll(e);else if(e instanceof Element)r=[e];else if(e instanceof NodeList||Array.isArray(e))r=e;else throw new TypeError("replace() requires a valid CSS selector string, a DOM Element, or a NodeList.");if(!(!r||r.length===0))for(let t of r){let o=this.#s(t);for(let i of o){let s=[i];for(let n of this.#e){let a=[];for(let l of s)l.parentNode&&this.#r(l,n,a);s=a}}}}#s(e){let r=document.createTreeWalker(e,NodeFilter.SHOW_TEXT,null,!1),t=[],o;for(;o=r.nextNode();)o.nodeValue.trim()&&t.push(o);return t}#r(e,r,t){let{regex:o,varNames:i,to:s}=r;o.lastIndex=0;let n=o.exec(e.nodeValue);if(!n||n[0].length===0){e.nodeValue.length>0&&t.push(e);return}let a=n.index,l=n[0].length,c=e.splitText(a),m=c.splitText(l);e.nodeValue.length>0&&t.push(e);let f={},p={};for(let u=0;u<i.length;u++){let d=n[u+1]??"";p[i[u]]=d,f[i[u]]=this.#o(d)}let h;typeof s=="function"?h=s(f,n,p):h=this.#i(s,p),this.#t.innerHTML=h;let y=this.#t.content.cloneNode(!0);c.parentNode.replaceChild(y,c),this.#r(m,r,t)}#i(e,r){return e.replace(/\{([a-zA-Z0-9_]+)\}/g,(t,o)=>this.#o(r[o]??""))}#o(e){return String(e).replace(/[&<>"']/g,r=>({"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;"})[r])}};export{g as default};

package/dist/tulisix.min.js

@@ -0,0 +1 @@
+(()=>{var m=class{#e=[];#t;constructor(){this.#t=document.createElement("template")}addRule(e){if(!e)return;let r=Array.isArray(e)?e:[e];for(let t of r){if(typeof t!="object"||t===null)throw new TypeError("Each rule must be a valid object.");if(!t.from)throw new Error("Rule is missing the required 'from' property.");if(typeof t.from!="string"&&!Array.isArray(t.from))throw new TypeError("Rule 'from' property must be a string or an array of strings.");if(typeof t.to!="string"&&typeof t.to!="function")throw new TypeError("Rule 'to' property must be a string or a function.");let o=Array.isArray(t.from)?t.from:[t.from],i=t.caseSensitive!==!1;for(let s of o){if(typeof s!="string")throw new TypeError(`Invalid pattern in 'from': ${s}. Must be a string.`);let n=this.#n(s,i);this.#e.push({regex:n.regex,varNames:n.varNames,to:t.to})}}}#n(e,r){let t=[];e=e.replace(/\\\{/g,"__ESCAPED_OPEN__").replace(/\\\}/g,"__ESCAPED_CLOSE__");let o=[],i=0,s=/\{([a-zA-Z0-9_]+)\}/g,n;for(;n=s.exec(e);){let[c,d]=n,f=n.index,p=e.slice(i,f);o.push(p.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&")),t.push(d);let u=f+c.length===e.length;o.push(u?"([^\\s<]+)":"(.*?)"),i=f+c.length}let a=e.slice(i);o.push(a.replace(/[-/\\^$*+?.()|[\]{}]/g,"\\$&"));let l=o.join("");return l=l.replace(/__ESCAPED_OPEN__/g,"\\{").replace(/__ESCAPED_CLOSE__/g,"\\}"),{regex:new RegExp(l,r?"g":"gi"),varNames:t}}replace(e){if(!this.#e.length)return;let r;if(typeof e=="string")r=document.querySelectorAll(e);else if(e instanceof Element)r=[e];else if(e instanceof NodeList||Array.isArray(e))r=e;else throw new TypeError("replace() requires a valid CSS selector string, a DOM Element, or a NodeList.");if(!(!r||r.length===0))for(let t of r){let o=this.#s(t);for(let i of o){let s=[i];for(let n of this.#e){let a=[];for(let l of s)l.parentNode&&this.#r(l,n,a);s=a}}}}#s(e){let r=document.createTreeWalker(e,NodeFilter.SHOW_TEXT,null,!1),t=[],o;for(;o=r.nextNode();)o.nodeValue.trim()&&t.push(o);return t}#r(e,r,t){let{regex:o,varNames:i,to:s}=r;o.lastIndex=0;let n=o.exec(e.nodeValue);if(!n||n[0].length===0){e.nodeValue.length>0&&t.push(e);return}let a=n.index,l=n[0].length,c=e.splitText(a),d=c.splitText(l);e.nodeValue.length>0&&t.push(e);let f={},p={};for(let h=0;h<i.length;h++){let g=n[h+1]??"";p[i[h]]=g,f[i[h]]=this.#o(g)}let u;typeof s=="function"?u=s(f,n,p):u=this.#i(s,p),this.#t.innerHTML=u;let y=this.#t.content.cloneNode(!0);c.parentNode.replaceChild(y,c),this.#r(d,r,t)}#i(e,r){return e.replace(/\{([a-zA-Z0-9_]+)\}/g,(t,o)=>this.#o(r[o]??""))}#o(e){return String(e).replace(/[&<>"']/g,r=>({"&":"&amp;","<":"&lt;",">":"&gt;",'"':"&quot;","'":"&#39;"})[r])}};typeof window<"u"&&(window.Tulisix=m);})();

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "tulisix",
+  "version": "1.0.0",
+  "description": "Transform text node into any format imaginable.",
+  "type": "module",
+  "main": "dist/tulisix.esm.js",
+  "exports": {
+    ".": "./dist/tulisix.esm.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rezzvy/tulisix.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rezzvy/tulisix/issues"
+  },
+  "homepage": "https://github.com/rezzvy/tulisix#readme",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:browser": "esbuild ./src/index.browser.js --bundle --minify --platform=browser --format=iife --outfile=dist/tulisix.min.js",
+    "build:esm": "esbuild ./src/tulisix.js --bundle --minify --format=esm --outfile=dist/tulisix.esm.js",
+    "build": "npm run build:browser && npm run build:esm"
+  },
+  "keywords": [
+    "text-transformation",
+    "pattern-matcher",
+    "safe-html-converter",
+    "regex-transformer",
+    "content-formatter"
+  ],
+  "author": "rezzvy",
+  "license": "MIT",
+  "devDependencies": {
+    "esbuild": "^0.27.4"
+  }
+}