@itrocks/template 0.0.6 → 0.0.8

package/README.md

@@ -18,7 +18,7 @@ npm i @itrocks/template
 
 ```ts
 console.log(
-	new Template({
+	await new Template({
 		users: [
 			{ age: 10, name: 'kid' },
 			{ age: 20, name: 'old-timer' }
@@ -68,6 +68,9 @@ Since the engine supports asynchronous operations (e.g., reading files, calling
 parsing returns a [Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)
 that you should handle with [await](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/await).
 
+This library is fully compatible with both ECMAScript modules (import) and CommonJS (require),
+adapting seamlessly to your project's module system.
+
 ## Key features
 
 ### W3C Validation-Friendly Templates
@@ -193,7 +196,7 @@ if not properly spaced.
 Wrap a property in `{}` to display its value:
 ```ts
 console.log(
-	new Template({ var: 15 }).parseBuffer('<span>{var}</span>')
+	await new Template({ var: 15 }).parseBuffer('<span>{var}</span>')
 )
 ```
 Result:
@@ -206,7 +209,7 @@ Result:
 If a context property is a function, it will be called and its return value displayed:
 ```ts
 console.log(
-	new Template({ var: () => 15 }).parseBuffer('<span>{var}</span>')
+	await new Template({ var: () => 15 }).parseBuffer('<span>{var}</span>')
 )
 ```
 Result:
@@ -218,7 +221,7 @@ Result:
 
 Use `{.}` to reference the current data context:
 ```ts
-console.log(new Template(15).parseBuffer('<span>{.}</span>'))
+console.log(await new Template(15).parseBuffer('<span>{.}</span>'))
 ```
 Result:
 ```html
@@ -262,14 +265,14 @@ Result on data `{ user: { age: 10, name: 'kid' } }`:
 You can use dot notation within `{your.expression}`:
 ```ts
 console.log(
-	new Template({ user: { age: 10, name: 'kid' } })
+	await new Template({ user: { age: 10, name: 'kid' } })
 		.parseBuffer('<span>{user.name} is {user.age} years old</span>')
 )
 ```
 Or use a block to avoid repeating:
 ```ts
 console.log(
-	new Template({ user: { age: 10, name: 'kid' } })
+	await new Template({ user: { age: 10, name: 'kid' } })
 		.parseBuffer('<span><!--user-->{name} is {age} years old<!--end--></span>')
 )
 ```
@@ -283,7 +286,7 @@ Both produce:
 Use `*` to iterate over all values of an object:
 ```ts
 console.log(
-	new Template({ object: { first: 'kid', next: 'old-timer' } })
+	await new Template({ object: { first: 'kid', next: 'old-timer' } })
 		.parseBuffer('<ul><!--object.*--><li>{.}<!--end--></ul>')
 )
 ```
@@ -296,7 +299,7 @@ Result:
 
 ```ts
 console.log(
-	new Template({ users: ['kid', 'old-timer'] })
+	await new Template({ users: ['kid', 'old-timer'] })
 		.parseBuffer('<ul><!--users--><li>{.}</li><!--end--></ul>')
 )
 ```
@@ -309,7 +312,7 @@ Result:
 
 ```ts
 console.log(
-	new Template({
+	await new Template({
 		users: [
 			{ age: 10, name: 'kid' },
 			{ age: 20, name: 'old-timer' }
@@ -337,7 +340,7 @@ Result:
 Use `-` to go back up one level in the data context:
 ```ts
 console.log(
-	new Template({ name: 'Eddie', data: { age: 30, status: 'well' } })
+	await new Template({ name: 'Eddie', data: { age: 30, status: 'well' } })
 	.parseBuffer(`
 		<!--data-->
 		<ol>
@@ -372,7 +375,7 @@ the engine attempts to use the [Str](https://www.npmjs.com/package/@itrocks/rena
 which provides string formatting functions. If no matching function is found, an error is thrown.
 ```ts
 console.log(
-	new Template({ name: 'EDITH' })
+	await new Template({ name: 'EDITH' })
 		.parseBuffer('<span>{name.lcFirst}</span>')
 )
 ```
@@ -449,11 +452,11 @@ class MyTemplate extends Template
 Using this class:
 ```ts
 console.log(
-	new MyTemplate({ name: 'Nick' })
-	.parseBuffer(`
-		<h2>What is my name</h2>
-		<p>My name is {name}</p>
-	`)
+	await new MyTemplate({ name: 'Nick' })
+		.parseBuffer(`
+			<h2>What is my name</h2>
+			<p>My name is {name}</p>
+		`)
 )
 ```
 Results in:
@@ -466,11 +469,11 @@ Results in:
 are considered part of the phrase, so their text is also translated:
 ```ts
 console.log(
-new MyTemplate({ name: 'Nick' })
-	.parseBuffer(`
-		<h2>What is my name</h2>
-		<p>My <span>name</span> is {name}</p>
-	`)
+	await new MyTemplate({ name: 'Nick' })
+		.parseBuffer(`
+			<h2>What is my name</h2>
+			<p>My <span>name</span> is {name}</p>
+		`)
 )
 ```
 Results in:

package/cjs/template.d.ts

@@ -0,0 +1,76 @@
+import { SortedArray } from '@itrocks/sorted-array';
+export declare const frontScripts: SortedArray<string>;
+export type VariableParser = [parser: string, (variable: string, data: any) => any];
+export { Template };
+export default class Template {
+    data?: any;
+    containerData?: any;
+    doExpression: boolean;
+    doLiteral: boolean;
+    fileName?: string;
+    filePath?: string;
+    included: boolean;
+    inlineElements: SortedArray<string>;
+    literalAttributes: SortedArray<string>;
+    literalElements: SortedArray<string>;
+    onAttribute?: ((name: string, value: string) => void);
+    onTagOpen?: ((name: string) => void);
+    onTagOpened?: ((name: string) => void);
+    onTagClose?: ((name: string) => void);
+    parsers: VariableParser[];
+    prefixes: string;
+    unclosingTags: SortedArray<string>;
+    constructor(data?: any, containerData?: any);
+    applyLiterals(text: string, parts?: string[]): string;
+    closeTag(shouldInLiteral: boolean, targetIndex: number): boolean;
+    combineLiterals(text: string, parts?: string[]): string;
+    debugEvents(): void;
+    getCleanContext(): {
+        doHeadLinks: boolean;
+        doneLinks: SortedArray<string>;
+        headLinks: SortedArray<string>;
+        index: number;
+        length: number;
+        source: string;
+        start: number;
+        target: string;
+        targetStack: never[];
+        literalPartStack: never[];
+        literalParts: never[];
+        inLiteral: boolean;
+    };
+    getPosition(): {
+        index: number;
+        start: number;
+        target: string;
+    };
+    getContext(): {
+        doHeadLinks: boolean;
+        doneLinks: SortedArray<string>;
+        headLinks: SortedArray<string>;
+        index: number;
+        length: number;
+        source: string;
+        start: number;
+        target: string;
+        targetStack: string[];
+        literalPartStack: string[][];
+        literalParts: string[];
+        inLiteral: boolean;
+    };
+    include(path: string, data: any): Promise<any>;
+    isContextClean(): boolean;
+    literalTarget(index: number, isTitle?: boolean): void;
+    parseBuffer(buffer: string): Promise<string>;
+    parseExpression(data: any, close: string, finalClose?: string): Promise<boolean | undefined>;
+    parseFile(fileName: string, containerFileName?: string): Promise<string>;
+    parsePath(expression: string, data: any): Promise<any>;
+    parseVariable(variable: string, data: any): Promise<any>;
+    parseVars(): Promise<string>;
+    setSource(setSource: string, setIndex?: number, setStart?: number, setTarget?: string): void;
+    skipBlock(): void;
+    sourceToTarget(): void;
+    startsExpression(char: string, open?: string, close?: string): boolean;
+    trimEndLine(string: string): string;
+}
+//# sourceMappingURL=template.d.ts.map

package/cjs/template.js

@@ -1,8 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Template = exports.frontScripts = void 0;
-const rename_1 = require("@itrocks/rename");
-const app_dir_1 = require("@itrocks/app-dir");
+const rename_1 = __importDefault(require("@itrocks/rename"));
+const app_dir_1 = __importDefault(require("@itrocks/app-dir"));
 const sorted_array_1 = require("@itrocks/sorted-array");
 const promises_1 = require("node:fs/promises");
 const node_path_1 = require("node:path");
@@ -775,3 +778,4 @@ class Template {
 }
 exports.default = Template;
 exports.Template = Template;
+//# sourceMappingURL=template.js.map

package/package.json

@@ -10,9 +10,9 @@
 	},
 	"description": "The W3C-valid, browser-previewable, concise, and fast HTML template engine that enables delimiter-less translations",
 	"devDependencies": {
-		"@types/jest": "^29.5.14",
+		"@types/jest": "^29.5",
 		"@types/node": "^22.9",
-		"jest": "^29.7.0",
+		"jest": "^29.7",
 		"ts-jest": "^29.2",
 		"typescript": "~5.6"
 	},
@@ -20,15 +20,14 @@
 		"node": ">=18"
 	},
 	"exports": {
-		"import": "./template.js",
+		"import": "./esm/template.js",
 		"require": "./cjs/template.js"
 	},
 	"files": [
 		"LICENSE",
 		"README.md",
-		"cjs",
-		"template.d.ts",
-		"template.js"
+		"*/*.js",
+		"*/*.d.ts"
 	],
 	"keywords": [
 		"browser",
@@ -50,13 +49,13 @@
 	],
 	"license": "LGPL-3.0-or-later",
 	"name": "@itrocks/template",
-	"repository": "https://github.com/itrocks-ts/template",
+	"repository": { "git": "https://github.com/itrocks-ts/template" },
 	"scripts": {
 		"build": "npm run build:cjs && npm run build:esm",
 		"build:cjs": "tsc -p tsconfig.cjs.json",
 		"build:esm": "tsc -p tsconfig.esm.json",
 		"test": "jest"
 	},
-	"types": "./template.d.ts",
-	"version": "0.0.6"
+	"types": "./esm/template.d.ts",
+	"version": "0.0.8"
 }