tshtml-loader 1.3.0 → 1.4.3

package/dist/export-template.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=export-template.d.ts.map

package/dist/export-template.js

@@ -0,0 +1,78 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * CLI helper to compile a single .tshtml file to .html on disk.
+ */
+const fs_1 = require("fs");
+const path = __importStar(require("node:path"));
+const index_1 = require("./index");
+// ----------------------------------------------------------------------------------
+if (process.argv.length !== 3) {
+    console.error("Please specify one .tshtml file");
+    process.exit();
+}
+const fileName = process.argv[2];
+const extension = path.extname(fileName).toLowerCase();
+if (extension !== ".tshtml") {
+    console.error("Input file must have .tshtml extension");
+    process.exit();
+}
+const fileNameNoExtension = fileName.substr(0, fileName.length - extension.length);
+const outputFileName = fileNameNoExtension + ".html";
+(0, fs_1.readFile)(fileName, { encoding: 'utf-8' }, function (err, data) {
+    if (!err) {
+        // Transform the source
+        const result = (0, index_1.executeTemplate)(data, path.join(process.cwd(), "/test.html"));
+        const htmlResult = (0, index_1.templateToString)(result.exports.default);
+        // Write to destination
+        // process.stdout.write( htmlResult );
+        (0, fs_1.writeFile)(outputFileName, htmlResult, {
+            encoding: "utf8",
+            flag: "w",
+        }, writeErr => {
+            if (!writeErr) {
+                console.log(`File is written: ${outputFileName}`);
+            }
+            else {
+                console.log(`Error writing to the output file ${outputFileName}`, writeErr);
+            }
+        });
+    }
+    else {
+        console.log(`Error reading the input file ${fileName}`, err);
+    }
+});

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import * as webpack from "webpack";
+/**
+ * Webpack loader entry point for .tshtml files. Executes the template code and
+ * returns compiled HTML while registering file dependencies with webpack.
+ * @param this Loader context provided by webpack
+ * @param source Raw .tshtml source code
+ */
+export default function (this: webpack.LoaderContext<any>, source: string): string;
+/**
+ * Compile and execute a .tshtml template in an isolated VM context while
+ * tracking all file dependencies loaded via require().
+ * @param code Template source
+ * @param fileName Absolute path of the template file (used for resolution)
+ */
+export declare function executeTemplate(code: string, fileName: string): {
+    exports: any;
+    dependencies: string[];
+};
+/**
+ * Convert different template builder outputs into a final HTML string.
+ * Accepts strings, class constructors (invoked), tshtml tags/arrays, or objects with toString().
+ */
+export declare function templateToString(builder: any): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,250 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+exports.executeTemplate = executeTemplate;
+exports.templateToString = templateToString;
+const lodash_1 = require("lodash");
+const ts_node_1 = require("ts-node");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const vm_1 = require("vm");
+const webpack = __importStar(require("webpack"));
+const tshtml_1 = require("tshtml");
+const Module = require("module");
+// ----------------------------------------------------------------------------------
+// tshtml-loader implementation
+/**
+ * Webpack loader entry point for .tshtml files. Executes the template code and
+ * returns compiled HTML while registering file dependencies with webpack.
+ * @param this Loader context provided by webpack
+ * @param source Raw .tshtml source code
+ */
+function default_1(source) {
+    let result;
+    let htmlResult;
+    let builder;
+    try {
+        result = executeTemplate(source, this.resourcePath);
+        builder = result.exports.default;
+    }
+    catch (error) {
+        throw new Error(`Error executing template: ${error.message}\n ${error.stack}`);
+    }
+    if (builder == null) {
+        throw new Error(`Template must be exported as "default".`);
+    }
+    htmlResult = templateToString(builder);
+    // Dependencies
+    const reTestNodeFolder = /[\/\\]node_modules[\/\\]/;
+    const filteredDependencies = (0, lodash_1.filter)(result.dependencies, x => x.startsWith(this.rootContext) && !reTestNodeFolder.test(x));
+    for (let file of filteredDependencies) {
+        this.addDependency(file);
+    }
+    // In case of AOT build add the resulting HTML to the assets
+    if (this._compilation.name === "angular-compiler:resource") {
+        const compilation = this._compilation;
+        const rawRequest = this._module.rawRequest;
+        const request = rawRequest.substring(0, rawRequest.lastIndexOf("?"));
+        // postpone to a later event, because when loader is invoked, the chunks don't yet exist, and we need to register the file
+        compilation.hooks.processAssets.tap({
+            name: "tshtml-loader",
+            stage: webpack.Compilation.PROCESS_ASSETS_STAGE_PRE_PROCESS
+        }, (assets) => {
+            compilation.emitAsset(request, new webpack.sources.RawSource(htmlResult));
+            compilation.addChunk("resource").files.add(request);
+        });
+    }
+    return htmlResult;
+}
+// ----------------------------------------------------------------------------------
+//
+/**
+ * Compile and execute a .tshtml template in an isolated VM context while
+ * tracking all file dependencies loaded via require().
+ * @param code Template source
+ * @param fileName Absolute path of the template file (used for resolution)
+ */
+function executeTemplate(code, fileName) {
+    const dirName = (0, path_1.dirname)(fileName);
+    const output = compileCode(code, fileName);
+    const script = new vm_1.Script(output, { filename: fileName });
+    const module = new Module(fileName);
+    module.filename = fileName;
+    module.loaded = true;
+    module.paths = Module._nodeModulePaths(dirName);
+    const req = createRequireService(fileName);
+    const sandbox = {
+        __filename: fileName,
+        __dirname: dirName,
+        module: module,
+        exports: module.exports,
+        require: req,
+    };
+    script.runInNewContext(sandbox, {
+        filename: fileName,
+    });
+    return {
+        exports: sandbox.exports,
+        dependencies: req.dependencies,
+    };
+}
+/**
+ * Convert different template builder outputs into a final HTML string.
+ * Accepts strings, class constructors (invoked), tshtml tags/arrays, or objects with toString().
+ */
+function templateToString(builder) {
+    if (builder == null) {
+        return "";
+    }
+    else if ((0, lodash_1.isString)(builder)) {
+        return builder;
+    }
+    else if (typeof (builder) == "function") {
+        return (new builder()).toString();
+    }
+    else if ((0, lodash_1.isArray)(builder) || (0, tshtml_1.isTag)(builder)) {
+        return (0, tshtml_1.tagToString)(builder);
+    }
+    else {
+        return builder.toString();
+    }
+}
+let compilerService;
+/***
+ * Compiles given TypeScript code
+ * @param code
+ * @param fileName
+ */
+/**
+ * Compile TypeScript source using ts-node with Node16 settings.
+ * @param code Source code
+ * @param fileName File name used for source maps and module resolution
+ */
+function compileCode(code, fileName) {
+    const tsFileName = `${fileName}.ts`;
+    if (compilerService == null) {
+        compilerService = (0, ts_node_1.register)({
+            compilerOptions: {
+                module: "Node16",
+                target: "es2022",
+                moduleResolution: "node16",
+            },
+        });
+    }
+    return compilerService.compile(code, tsFileName);
+}
+/***
+ * Create a logging wrapper for "require" function.
+ * @param fileName
+ */
+/**
+ * Wrap Node's require to track dependency files and evict stale modules when underlying files change.
+ * @param fileName The template file being executed
+ */
+function createRequireService(fileName) {
+    const req = Module.createRequire(fileName);
+    const cache = req.cache;
+    const dependencies = [];
+    const resolveFn = (id, options) => {
+        return req.resolve(id, options);
+    };
+    resolveFn.paths = req.resolve.paths;
+    const requireFn = (request) => {
+        let filePath;
+        try {
+            filePath = resolveFn(request);
+        }
+        catch (error) {
+            // Likely file doesn't exist, so short circuit to the default implementation
+            return req(request);
+        }
+        // Try to get the module from cache and check it's modification time
+        let module = cache[filePath];
+        if (module != null) {
+            cleanOutdatedModules(module, {});
+        }
+        const result = req(request);
+        // Store last modification date
+        const allFiles = {};
+        storeModuleTimes(cache[filePath], allFiles);
+        // Store request to the dependency resolution log
+        dependencies.push(...(0, lodash_1.keys)(allFiles));
+        return result;
+    };
+    requireFn.resolve = resolveFn;
+    requireFn.cache = cache;
+    requireFn.extensions = req.extensions;
+    requireFn.main = req.main;
+    requireFn.dependencies = dependencies;
+    return requireFn;
+    // ---
+    function cleanOutdatedModules(module, allFiles) {
+        allFiles[module.filename] = true;
+        let doClean = false;
+        // If the module file was modified since last access -> remove it from the cache
+        if (module.fileLastModified != null) {
+            const moduleTime = (0, fs_1.statSync)(module.filename).mtimeMs;
+            if (module.fileLastModified != moduleTime) {
+                doClean = true;
+            }
+        }
+        // Check if any child module is outdated
+        for (let childModule of module.children) {
+            if (allFiles[childModule.filename] || !checkFilename(childModule.filename))
+                continue;
+            doClean = cleanOutdatedModules(childModule, allFiles) || doClean;
+        }
+        if (doClean) {
+            delete cache[module.filename];
+        }
+        return doClean;
+    }
+    function storeModuleTimes(module, allFiles) {
+        allFiles[module.filename] = true;
+        if (module.fileLastModified == null) {
+            module.fileLastModified = (0, fs_1.statSync)(module.filename).mtimeMs;
+        }
+        let childModule;
+        for (childModule of module.children) {
+            if (allFiles[childModule.filename] || !checkFilename(childModule.filename))
+                continue;
+            storeModuleTimes(childModule, allFiles);
+        }
+    }
+    function checkFilename(filename) {
+        return filename.indexOf("\\node_modules\\") === -1;
+    }
+}

package/package.json

@@ -1,28 +1,56 @@
-{
-  "name": "tshtml-loader",
-  "version": "1.3.0",
-  "description": "",
-  "main": "lib/index.js",
-  "files": [
-    "lib/*.*"
-  ],
-  "bin": "./lib/export-template.js",
-  "scripts": {
-    "build": "tsc ./src/index.ts ./src/export-template.ts --outdir ./lib -d",
-    "build-watch": "tsc ./src/index.ts --outdir ./lib -d -w"
-  },
-  "author": "LOGEX Group",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/lodash": "4.17.15",
-    "@types/node": "22.13.5",
-    "@types/webpack": "5.28.5"
-  },
-  "dependencies": {
-    "lodash": "^4.17.21",
-    "ts-node": "^10.9.2",
-    "tsconfig-paths": "^4.2.0",
-    "tshtml": "^1.3.0",
-    "typescript": "5.7.3"
-  }
-}
+{
+  "name": "tshtml-loader",
+  "version": "1.4.3",
+  "description": "Webpack loader for tshtml template files",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xorets/tshtml"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "bin": "./dist/export-template.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --project . --outDir ./dist --module commonjs --declaration --declarationMap --skipLibCheck true",
+    "build-watch": "tsc --project . --outDir ./dist -d -w",
+    "pretest": "cd ../tshtml && npm run build --if-present",
+    "test": "tsx ./test/jasmine.js",
+    "coverage": "nyc tsx ./test/jasmine.js",
+    "prepublishOnly": "npm run test && npm run build"
+  },
+  "author": "LOGEX Group",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jasmine": "^5.1.15",
+    "@types/lodash": "4.17.23",
+    "@types/node": "25.0.9",
+    "@types/webpack": "5.28.5",
+    "jasmine": "6.0.0",
+    "nyc": "^17.1.0",
+    "tsx": "^4.21.0"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21",
+    "ts-node": "^10.9.2",
+    "tshtml": "^1.4.3",
+    "typescript": "^5.9.3"
+  },
+  "overrides": {
+    "diff": "^8.0.3"
+  }
+}

package/lib/export-template.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/lib/export-template.js

@@ -1,42 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var fs_1 = require("fs");
-var path = require("node:path");
-var index_1 = require("./index");
-// ----------------------------------------------------------------------------------
-if (process.argv.length !== 3) {
-    console.error("Please specify one .tshtml file");
-    process.exit();
-}
-var fileName = process.argv[2];
-var extension = path.extname(fileName).toLowerCase();
-if (extension !== ".tshtml") {
-    console.error("Input file must have .tshtml extension");
-    process.exit();
-}
-var fileNameNoExtension = fileName.substr(0, fileName.length - extension.length);
-var outputFileName = fileNameNoExtension + ".html";
-(0, fs_1.readFile)(fileName, { encoding: 'utf-8' }, function (err, data) {
-    if (!err) {
-        // Transform the source
-        var result = (0, index_1.executeTemplate)(data, path.join(process.cwd(), "/test.html"));
-        var htmlResult = (0, index_1.templateToString)(result.exports.default);
-        // Write to destination
-        // process.stdout.write( htmlResult );
-        (0, fs_1.writeFile)(outputFileName, htmlResult, {
-            encoding: "utf8",
-            flag: "w",
-        }, function (writeErr) {
-            if (!writeErr) {
-                console.log("File is written: ".concat(outputFileName));
-            }
-            else {
-                console.log("Error writing to the output file ".concat(outputFileName), writeErr);
-            }
-        });
-    }
-    else {
-        console.log("Error reading the input file ".concat(fileName), err);
-    }
-});

package/lib/index.d.ts

@@ -1,7 +0,0 @@
-import * as webpack from "webpack";
-export default function (this: webpack.LoaderContext<any>, source: string): string;
-export declare function executeTemplate(code: string, fileName: string): {
-    exports: any;
-    dependencies: string[];
-};
-export declare function templateToString(builder: any): string;

package/lib/index.js

@@ -1,195 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = default_1;
-exports.executeTemplate = executeTemplate;
-exports.templateToString = templateToString;
-var lodash_1 = require("lodash");
-var ts_node_1 = require("ts-node");
-var fs_1 = require("fs");
-var path_1 = require("path");
-var vm_1 = require("vm");
-var webpack = require("webpack");
-var tshtml_1 = require("tshtml");
-require("tsconfig-paths/register"); // Necessary to support @folders resolution by Nodejs
-var Module = require("module");
-// ----------------------------------------------------------------------------------
-// tshtml-loader implementation
-function default_1(source) {
-    var _this = this;
-    var result;
-    var htmlResult;
-    var builder;
-    try {
-        result = executeTemplate(source, this.resourcePath);
-        builder = result.exports.default;
-    }
-    catch (error) {
-        throw new Error("Error executing template: ".concat(error.message, "\n ").concat(error.stack));
-    }
-    if (builder == null) {
-        throw new Error("Template must be exported as \"default\".");
-    }
-    htmlResult = templateToString(builder);
-    // Dependencies
-    var reTestNodeFolder = /[\/\\]node_modules[\/\\]/;
-    var filteredDependencies = (0, lodash_1.filter)(result.dependencies, function (x) {
-        return x.startsWith(_this.rootContext) && !reTestNodeFolder.test(x);
-    });
-    for (var _i = 0, filteredDependencies_1 = filteredDependencies; _i < filteredDependencies_1.length; _i++) {
-        var file = filteredDependencies_1[_i];
-        this.addDependency(file);
-    }
-    // In case of AOT build add the resulting HTML to the assets
-    if (this._compilation.name === "angular-compiler:resource") {
-        var compilation_1 = this._compilation;
-        var rawRequest = this._module.rawRequest;
-        var request_1 = rawRequest.substring(0, rawRequest.lastIndexOf("?"));
-        // postpone to a later event, because when loader is invoked, the chunks don’t yet exist, and we need to register the file
-        compilation_1.hooks.processAssets.tap({
-            name: "tshtml-loader",
-            stage: webpack.Compilation.PROCESS_ASSETS_STAGE_PRE_PROCESS
-        }, function (assets) {
-            compilation_1.emitAsset(request_1, new webpack.sources.RawSource(htmlResult));
-            compilation_1.addChunk("resource").files.add(request_1);
-        });
-    }
-    return htmlResult;
-}
-// ----------------------------------------------------------------------------------
-//
-function executeTemplate(code, fileName) {
-    var dirName = (0, path_1.dirname)(fileName);
-    var output = compileCode(code, fileName);
-    var script = new vm_1.Script(output, { filename: fileName });
-    var module = new Module(fileName);
-    module.filename = fileName;
-    module.loaded = true;
-    module.paths = Module._nodeModulePaths(dirName);
-    var req = createRequireService(fileName);
-    var sandbox = {
-        __filename: fileName,
-        __dirname: dirName,
-        module: module,
-        exports: module.exports,
-        require: req,
-    };
-    script.runInNewContext(sandbox, {
-        filename: fileName,
-    });
-    return {
-        exports: sandbox.exports,
-        dependencies: req.dependencies,
-    };
-}
-function templateToString(builder) {
-    if ((0, lodash_1.isString)(builder)) {
-        return builder;
-    }
-    else if (typeof (builder) == "function") {
-        return (new builder()).toString();
-    }
-    else if ((0, lodash_1.isArray)(builder) || (0, tshtml_1.isTag)(builder)) {
-        return (0, tshtml_1.tagToString)(builder);
-    }
-    else {
-        return builder.toString();
-    }
-}
-var compilerService;
-/***
- * Compiles given TypeScript code
- * @param code
- * @param fileName
- */
-function compileCode(code, fileName) {
-    var tsFileName = "".concat(fileName, ".ts");
-    if (compilerService == null) {
-        compilerService = (0, ts_node_1.register)({
-            compilerOptions: {
-                module: "CommonJS",
-                target: "es2015",
-            },
-        });
-    }
-    return compilerService.compile(code, tsFileName);
-}
-/***
- * Create a logging wrapper for "require" function.
- * @param fileName
- */
-function createRequireService(fileName) {
-    var req = Module.createRequire(fileName);
-    var cache = req.cache;
-    var dependencies = [];
-    var resolveFn = function (id, options) {
-        return req.resolve(id, options);
-    };
-    resolveFn.paths = req.resolve.paths;
-    var requireFn = function (request) {
-        var filePath;
-        try {
-            filePath = resolveFn(request);
-        }
-        catch (error) {
-            // Likely file doesn't exist, so short circuit to the default implementation
-            return req(request);
-        }
-        // Try to get the module from cache and check it's modification time
-        var module = cache[filePath];
-        if (module != null) {
-            cleanOutdatedModules(module, {});
-        }
-        var result = req(request);
-        // Store last modification date
-        var allFiles = {};
-        storeModuleTimes(cache[filePath], allFiles);
-        // Store request to the dependency resolution log
-        dependencies.push.apply(dependencies, (0, lodash_1.keys)(allFiles));
-        return result;
-    };
-    requireFn.resolve = resolveFn;
-    requireFn.cache = cache;
-    requireFn.extensions = req.extensions;
-    requireFn.main = req.main;
-    requireFn.dependencies = dependencies;
-    return requireFn;
-    // ---
-    function cleanOutdatedModules(module, allFiles) {
-        allFiles[module.filename] = true;
-        var doClean = false;
-        // If the module file was modified since last access -> remove it from the cache
-        if (module.fileLastModified != null) {
-            var moduleTime = (0, fs_1.statSync)(module.filename).mtimeMs;
-            if (module.fileLastModified != moduleTime) {
-                doClean = true;
-            }
-        }
-        // Check if any child module is outdated
-        for (var _i = 0, _a = module.children; _i < _a.length; _i++) {
-            var childModule = _a[_i];
-            if (allFiles[childModule.filename] || !checkFilename(childModule.filename))
-                continue;
-            doClean = cleanOutdatedModules(childModule, allFiles) || doClean;
-        }
-        if (doClean) {
-            delete cache[module.filename];
-        }
-        return doClean;
-    }
-    function storeModuleTimes(module, allFiles) {
-        allFiles[module.filename] = true;
-        if (module.fileLastModified == null) {
-            module.fileLastModified = (0, fs_1.statSync)(module.filename).mtimeMs;
-        }
-        var childModule;
-        for (var _i = 0, _a = module.children; _i < _a.length; _i++) {
-            childModule = _a[_i];
-            if (allFiles[childModule.filename] || !checkFilename(childModule.filename))
-                continue;
-            storeModuleTimes(childModule, allFiles);
-        }
-    }
-    function checkFilename(filename) {
-        return filename.indexOf("\\node_modules\\") === -1;
-    }
-}