@spinajs/templates 2.0.481 → 2.0.484

package/lib/cjs/CompiledTemplateRenderer.d.ts

@@ -0,0 +1,41 @@
+import { TemplateRenderer } from './interfaces.js';
+/**
+ * A compiled template delegate: takes a locals/context object and returns the
+ * rendered string. Both pug's `compileTemplate` and handlebars' template
+ * delegate satisfy this shape.
+ */
+export type CompiledTemplate = (locals: any) => string;
+/**
+ * Base class for template engines that compile a template file into a reusable
+ * delegate (pug, handlebars). It captures the render skeleton - validation,
+ * lazy compile + caching, language resolution, timing/logging and writing to
+ * file - leaving engines to supply only what actually differs:
+ *
+ *  - {@link buildContext} - the locals object passed to the compiled delegate
+ *    (model merged with engine-specific helpers).
+ *  - {@link compile} - how a template source is compiled into a delegate.
+ *
+ * Caching (including dev-mode recompilation) is owned by the base
+ * {@link TemplateRenderer.withCache} machinery, not this class.
+ */
+export declare abstract class CompiledTemplateRenderer<TDelegate extends CompiledTemplate = CompiledTemplate> extends TemplateRenderer {
+    renderToFile(template: string, model: unknown, filePath: string, language?: string): Promise<void>;
+    render(templateName: string, model: unknown, language?: string): Promise<string>;
+    /**
+     * Effective language for a render: explicit argument, else the ambient
+     * (async-context) language, else the framework default.
+     */
+    protected resolveLanguage(language?: string): string;
+    /**
+     * Build the locals object passed to the compiled template - the model merged
+     * with any engine-specific helpers (translation functions, `lang`, ...).
+     */
+    protected abstract buildContext(model: unknown, language: string): Record<string, unknown>;
+    /**
+     * Compile the template identified by `template` (a bare path or `fs://` URI)
+     * into a reusable delegate. Called only on a cache miss; the returned delegate
+     * is cached by {@link TemplateRenderer.withCache}.
+     */
+    protected abstract compile(template: string): Promise<TDelegate>;
+}
+//# sourceMappingURL=CompiledTemplateRenderer.d.ts.map

package/lib/cjs/CompiledTemplateRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompiledTemplateRenderer.d.ts","sourceRoot":"","sources":["../../src/CompiledTemplateRenderer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,GAAG,KAAK,MAAM,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,8BAAsB,wBAAwB,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,CAAE,SAAQ,gBAAgB;IAC/G,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMlG,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7F;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAIpD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1F;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CACjE"}

package/lib/cjs/CompiledTemplateRenderer.js

@@ -0,0 +1,83 @@
+"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.CompiledTemplateRenderer = void 0;
+const exceptions_1 = require("@spinajs/exceptions");
+const intl_1 = require("@spinajs/intl");
+const fs = __importStar(require("fs"));
+const interfaces_js_1 = require("./interfaces.js");
+const io_js_1 = require("./io.js");
+/**
+ * Base class for template engines that compile a template file into a reusable
+ * delegate (pug, handlebars). It captures the render skeleton - validation,
+ * lazy compile + caching, language resolution, timing/logging and writing to
+ * file - leaving engines to supply only what actually differs:
+ *
+ *  - {@link buildContext} - the locals object passed to the compiled delegate
+ *    (model merged with engine-specific helpers).
+ *  - {@link compile} - how a template source is compiled into a delegate.
+ *
+ * Caching (including dev-mode recompilation) is owned by the base
+ * {@link TemplateRenderer.withCache} machinery, not this class.
+ */
+class CompiledTemplateRenderer extends interfaces_js_1.TemplateRenderer {
+    async renderToFile(template, model, filePath, language) {
+        const content = await this.render(template, model, language);
+        (0, io_js_1.ensureParentDir)(filePath);
+        fs.writeFileSync(filePath, content);
+    }
+    async render(templateName, model, language) {
+        if (!templateName) {
+            throw new exceptions_1.InvalidArgument('template parameter cannot be null or empty');
+        }
+        const label = `${this.constructor.name}.render.${templateName}`;
+        this.Log.trace(`Rendering template ${templateName}`);
+        this.Log.timeStart(label);
+        const delegate = await this.withCache(templateName, () => this.compile(templateName));
+        const content = delegate(this.buildContext(model, this.resolveLanguage(language)));
+        const time = this.Log.timeEnd(label);
+        this.Log.trace(`Rendering template ${templateName} ended, (${time} ms)`);
+        return content;
+    }
+    /**
+     * Effective language for a render: explicit argument, else the ambient
+     * (async-context) language, else the framework default.
+     */
+    resolveLanguage(language) {
+        return (language ? language : (0, intl_1.guessLanguage)()) ?? (0, intl_1.defaultLanguage)();
+    }
+}
+exports.CompiledTemplateRenderer = CompiledTemplateRenderer;
+//# sourceMappingURL=CompiledTemplateRenderer.js.map

package/lib/cjs/CompiledTemplateRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompiledTemplateRenderer.js","sourceRoot":"","sources":["../../src/CompiledTemplateRenderer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAsD;AACtD,wCAA+D;AAC/D,uCAAyB;AACzB,mDAAmD;AACnD,mCAA0C;AAS1C;;;;;;;;;;;;GAYG;AACH,MAAsB,wBAAgF,SAAQ,gCAAgB;IACrH,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,KAAc,EAAE,QAAgB,EAAE,QAAiB;QAC7F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC7D,IAAA,uBAAe,EAAC,QAAQ,CAAC,CAAC;QAC1B,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,KAAc,EAAE,QAAiB;QACzE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,4BAAe,CAAC,4CAA4C,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,WAAW,YAAY,EAAE,CAAC;QAChE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,YAAY,EAAE,CAAC,CAAC;QACrD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;QACtF,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEnF,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,sBAAsB,YAAY,YAAY,IAAI,MAAM,CAAC,CAAC;QAEzE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACO,eAAe,CAAC,QAAiB;QACzC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,oBAAa,GAAE,CAAC,IAAI,IAAA,sBAAe,GAAE,CAAC;IACtE,CAAC;CAcF;AA7CD,4DA6CC"}

package/lib/cjs/cli/renderHelpers.d.ts

@@ -0,0 +1,26 @@
+import { IRenderProgress, RenderProgressCallback } from '../progress.js';
+/** Load an optional JSON model file, returning an empty object when no readable file is given. */
+export declare function loadJsonModel(modelPath?: string): Record<string, unknown>;
+export interface IResolveHtmlOptions {
+    template?: boolean;
+    model?: string;
+    lang?: string;
+}
+/**
+ * Resolve the HTML for a CLI render. In template mode the input is rendered
+ * through the text engine selected by its file extension (pug/handlebars/...);
+ * in raw mode the input file is read as-is.
+ */
+export declare function resolveInputHtml(input: string, options: IResolveHtmlOptions): Promise<string>;
+/** Format one progress snapshot as a compact single line. */
+export declare function formatProgressLine(p: IRenderProgress): string;
+/**
+ * A progress callback for one-shot CLI commands. On a TTY it rewrites a single
+ * live line; otherwise (piped / CI) it prints one line per phase change. The
+ * live line is terminated with a newline on Done/Failed.
+ *
+ * @param write - sink for output (defaults to stdout); injectable for testing.
+ * @param isTty - whether to use the live single-line mode (defaults to stdout's TTY state).
+ */
+export declare function cliProgressReporter(write?: (s: string) => void, isTty?: boolean): RenderProgressCallback;
+//# sourceMappingURL=renderHelpers.d.ts.map

package/lib/cjs/cli/renderHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderHelpers.d.ts","sourceRoot":"","sources":["../../../src/cli/renderHelpers.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAe,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAEtF,kGAAkG;AAClG,wBAAgB,aAAa,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMzE;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAWnG;AASD,6DAA6D;AAC7D,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,eAAe,GAAG,MAAM,CAG7D;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,GAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAA0C,EAChE,KAAK,GAAE,OAAgC,GACtC,sBAAsB,CAiBxB"}

package/lib/cjs/cli/renderHelpers.js

@@ -0,0 +1,101 @@
+"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.loadJsonModel = loadJsonModel;
+exports.resolveInputHtml = resolveInputHtml;
+exports.formatProgressLine = formatProgressLine;
+exports.cliProgressReporter = cliProgressReporter;
+const di_1 = require("@spinajs/di");
+const fs = __importStar(require("fs"));
+const index_js_1 = require("../index.js");
+const progress_js_1 = require("../progress.js");
+/** Load an optional JSON model file, returning an empty object when no readable file is given. */
+function loadJsonModel(modelPath) {
+    if (modelPath && fs.existsSync(modelPath)) {
+        return JSON.parse(fs.readFileSync(modelPath, { encoding: 'utf-8' }));
+    }
+    return {};
+}
+/**
+ * Resolve the HTML for a CLI render. In template mode the input is rendered
+ * through the text engine selected by its file extension (pug/handlebars/...);
+ * in raw mode the input file is read as-is.
+ */
+async function resolveInputHtml(input, options) {
+    if (options.template) {
+        const templates = await di_1.DI.resolve(index_js_1.Templates);
+        return templates.render(input, loadJsonModel(options.model), options.lang);
+    }
+    if (!fs.existsSync(input)) {
+        throw new Error(`Input HTML file ${input} does not exist`);
+    }
+    return fs.readFileSync(input, { encoding: 'utf-8' });
+}
+const PROGRESS_BAR_WIDTH = 20;
+function progressBar(percent) {
+    const filled = Math.max(0, Math.min(PROGRESS_BAR_WIDTH, Math.round((percent / 100) * PROGRESS_BAR_WIDTH)));
+    return '█'.repeat(filled) + '·'.repeat(PROGRESS_BAR_WIDTH - filled);
+}
+/** Format one progress snapshot as a compact single line. */
+function formatProgressLine(p) {
+    const secs = (p.elapsedMs / 1000).toFixed(1);
+    return `[${progressBar(p.percent)}] ${String(p.percent).padStart(3)}% ${p.phase.padEnd(9)} ${p.message ?? ''} ${secs}s`;
+}
+/**
+ * A progress callback for one-shot CLI commands. On a TTY it rewrites a single
+ * live line; otherwise (piped / CI) it prints one line per phase change. The
+ * live line is terminated with a newline on Done/Failed.
+ *
+ * @param write - sink for output (defaults to stdout); injectable for testing.
+ * @param isTty - whether to use the live single-line mode (defaults to stdout's TTY state).
+ */
+function cliProgressReporter(write = (s) => void process.stdout.write(s), isTty = !!process.stdout.isTTY) {
+    let lastPhase;
+    return (p) => {
+        const line = formatProgressLine(p);
+        const finished = p.phase === progress_js_1.RenderPhase.Done || p.phase === progress_js_1.RenderPhase.Failed;
+        if (isTty) {
+            write(`\r${line.padEnd(80)}`);
+            if (finished) {
+                write('\n');
+            }
+        }
+        else if (p.phase !== lastPhase) {
+            lastPhase = p.phase;
+            write(`${line}\n`);
+        }
+    };
+}
+//# sourceMappingURL=renderHelpers.js.map

package/lib/cjs/cli/renderHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderHelpers.js","sourceRoot":"","sources":["../../../src/cli/renderHelpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,sCAMC;AAaD,4CAWC;AAUD,gDAGC;AAUD,kDAoBC;AA/ED,oCAAiC;AACjC,uCAAyB;AACzB,0CAAwC;AACxC,gDAAsF;AAEtF,kGAAkG;AAClG,SAAgB,aAAa,CAAC,SAAkB;IAC9C,IAAI,SAAS,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAQD;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAAC,KAAa,EAAE,OAA4B;IAChF,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,SAAS,GAAG,MAAM,OAAE,CAAC,OAAO,CAAC,oBAAS,CAAC,CAAC;QAC9C,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,iBAAiB,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,SAAS,WAAW,CAAC,OAAe;IAClC,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAC3G,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,CAAC;AACtE,CAAC;AAED,6DAA6D;AAC7D,SAAgB,kBAAkB,CAAC,CAAkB;IACnD,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7C,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,IAAI,IAAI,GAAG,CAAC;AAC1H,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CACjC,QAA6B,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAChE,QAAiB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK;IAEvC,IAAI,SAAkC,CAAC;IAEvC,OAAO,CAAC,CAAkB,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,KAAK,yBAAW,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,yBAAW,CAAC,MAAM,CAAC;QAEhF,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAC9B,IAAI,QAAQ,EAAE,CAAC;gBACb,KAAK,CAAC,IAAI,CAAC,CAAC;YACd,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACjC,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC;YACpB,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/lib/cjs/config/templates.d.ts

@@ -1,10 +1,12 @@
 declare const templates: {
     system: {
         dirs: {
-            templates: string[];
             cli: string[];
         };
     };
+    templates: {
+        cache: {};
+    };
 };
 export default templates;
 //# sourceMappingURL=templates.d.ts.map

package/lib/cjs/config/templates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/config/templates.ts"],"names":[],"mappings":"AAYA,QAAA,MAAM,SAAS;;;;;;;CAOd,CAAC;AAEF,eAAe,SAAS,CAAC"}
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/config/templates.ts"],"names":[],"mappings":"AAYA,QAAA,MAAM,SAAS;;;;;;;;;CAmBd,CAAC;AAEF,eAAe,SAAS,CAAC"}

package/lib/cjs/config/templates.js

@@ -4,18 +4,30 @@ const path_1 = require("path");
 function dir(path) {
     const inCommonJs = typeof module !== 'undefined';
     return [
-        (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), 'node_modules', '@spinajs', 'rbac', 'lib', inCommonJs ? 'cjs' : 'mjs', path))),
+        (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), 'node_modules', '@spinajs', 'templates', 'lib', inCommonJs ? 'cjs' : 'mjs', path))),
         // one up if we run from app or build folder
-        (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), '../', 'node_modules', '@spinajs', 'rbac', 'lib', inCommonJs ? 'cjs' : 'mjs', path))),
+        (0, path_1.resolve)((0, path_1.normalize)((0, path_1.join)(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), '../', 'node_modules', '@spinajs', 'templates', 'lib', inCommonJs ? 'cjs' : 'mjs', path))),
     ];
 }
 const templates = {
     system: {
         dirs: {
-            templates: [...dir('templates')],
             cli: [...dir('cli')],
         },
     },
+    templates: {
+        cache: {
+        // How aggressively compiled templates are reused. Accepts:
+        //   'cache'      - compile once, reuse forever.
+        //   'revalidate' - stat() the source and recompile only when it changes.
+        //   'always'     - recompile on every render.
+        // Intentionally left unset: when no mode is configured the renderer falls
+        // back to 'always' in development and 'cache' in production (see
+        // TemplateRenderer.CacheMode). Shipping a concrete value here would defeat
+        // that dev/prod fallback.
+        // mode: 'cache',
+        },
+    },
 };
 exports.default = templates;
 //# sourceMappingURL=templates.js.map

package/lib/cjs/config/templates.js.map

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/config/templates.ts"],"names":[],"mappings":";;AAAA,+BAAgD;AAEhD,SAAS,GAAG,CAAC,IAAY;IACvB,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;IACjD,OAAO;QACL,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QAEvJ,4CAA4C;QAC5C,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAC,KAAK,EAAC,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;KAC7J,CAAC;AACJ,CAAC;AAED,MAAM,SAAS,GAAG;IAChB,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,SAAS,EAAE,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;YAChC,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;SACrB;KACF;CACF,CAAC;AAEF,kBAAe,SAAS,CAAC"}
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/config/templates.ts"],"names":[],"mappings":";;AAAA,+BAAgD;AAEhD,SAAS,GAAG,CAAC,IAAY;IACvB,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;IACjD,OAAO;QACL,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QAE5J,4CAA4C;QAC5C,IAAA,cAAO,EAAC,IAAA,gBAAS,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;KACpK,CAAC;AACJ,CAAC;AAED,MAAM,SAAS,GAAG;IAChB,MAAM,EAAE;QACN,IAAI,EAAE;YACJ,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;SACrB;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE;QACL,2DAA2D;QAC3D,gDAAgD;QAChD,yEAAyE;QACzE,8CAA8C;QAC9C,0EAA0E;QAC1E,iEAAiE;QACjE,2EAA2E;QAC3E,0BAA0B;QAC1B,iBAAiB;SAClB;KACF;CACF,CAAC;AAEF,kBAAe,SAAS,CAAC"}

package/lib/cjs/index.d.ts

@@ -1,7 +1,12 @@
 import { AsyncService } from '@spinajs/di';
 import { Log } from '@spinajs/log';
 import { TemplateRenderer } from './interfaces.js';
+import { IRenderOptions } from './progress.js';
 export * from './interfaces.js';
+export * from './progress.js';
+export * from './io.js';
+export * from './CompiledTemplateRenderer.js';
+export * from './cli/renderHelpers.js';
 /**
  * Inject INTL module for language support. We does nothing but to initialize module for use in templates.
  */
@@ -9,7 +14,7 @@ export declare class Templates extends AsyncService {
     protected Log: Log;
     protected Renderers: TemplateRenderer[];
     getRendererFor(extname: string): TemplateRenderer;
-    compileToFile(template: string, renderer: string, model: unknown, filePath: string, language?: string): Promise<void>;
+    compileToFile(template: string, renderer: string, model: unknown, filePath: string, language?: string, options?: IRenderOptions): Promise<void>;
     /**
      *
      * Renders template with given model and language. Returns compiled content
@@ -18,9 +23,10 @@ export declare class Templates extends AsyncService {
      * @param renderer
      * @param model
      * @param language
+     * @param options - optional render options (e.g. progress reporting)
      * @returns
      */
-    compile(template: string, renderer: string, model: unknown, language?: string): Promise<string>;
+    compile(template: string, renderer: string, model: unknown, language?: string, options?: IRenderOptions): Promise<string>;
     /**
      *
      * Renders template with given model and language. Returns compiled content
@@ -29,9 +35,20 @@ export declare class Templates extends AsyncService {
      * @param template
      * @param model
      * @param language
+     * @param options - optional render options (e.g. progress reporting)
      * @returns
      */
-    render(template: string, model: unknown, language?: string): Promise<string>;
-    renderToFile(template: string, model: unknown, filePath: string, language?: string): Promise<void>;
+    render(template: string, model: unknown, language?: string, options?: IRenderOptions): Promise<string>;
+    renderToFile(template: string, model: unknown, filePath: string, language?: string, options?: IRenderOptions): Promise<void>;
+    /**
+     * Finds the renderer registered under the given renderer type (e.g. `handlebars`,
+     * `pdf`), throwing if none is registered.
+     */
+    private engineByType;
+    /**
+     * Finds the renderer matching the template file's extension, throwing if none
+     * is registered for that extension.
+     */
+    private engineByExtension;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAsB,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,GAAG,EAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAGnD,cAAc,iBAAiB,CAAC;AAEhC;;GAEG;AACH,qBACa,SAAU,SAAQ,YAAY;IAEzC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAGnB,SAAS,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAEjC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB;IAI3C,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASlI;;;;;;;;;OASG;IACU,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAS5G;;;;;;;;;OASG;IACU,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAW5E,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAUhH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAsB,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,GAAG,EAAgB,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAG/C,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AAEvC;;GAEG;AACH,qBACa,SAAU,SAAQ,YAAY;IAEzC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAGnB,SAAS,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAEjC,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,gBAAgB;IAI3C,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAK5J;;;;;;;;;;OAUG;IACU,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAKtI;;;;;;;;;;OAUG;IACU,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAKtG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzI;;;OAGG;IACH,OAAO,CAAC,YAAY;IASpB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;CAS1B"}

package/lib/cjs/index.js

@@ -31,6 +31,10 @@ const interfaces_js_1 = require("./interfaces.js");
 const path_1 = require("path");
 const intl_1 = require("@spinajs/intl");
 __exportStar(require("./interfaces.js"), exports);
+__exportStar(require("./progress.js"), exports);
+__exportStar(require("./io.js"), exports);
+__exportStar(require("./CompiledTemplateRenderer.js"), exports);
+__exportStar(require("./cli/renderHelpers.js"), exports);
 /**
  * Inject INTL module for language support. We does nothing but to initialize module for use in templates.
  */
@@ -38,12 +42,9 @@ let Templates = class Templates extends di_1.AsyncService {
     getRendererFor(extname) {
         return this.Renderers.find((x) => x.Extension === extname);
     }
-    async compileToFile(template, renderer, model, filePath, language) {
-        const engine = this.Renderers.find((x) => x.Type === renderer);
-        if (!engine) {
-            throw new exceptions_1.InvalidOperation(`No renderer for ${renderer}`);
-        }
-        return await engine.renderToFile(template, model, filePath, language);
+    async compileToFile(template, renderer, model, filePath, language, options) {
+        const engine = this.engineByType(renderer);
+        return await log_1.Perf.measure('template.compile', () => engine.renderToFile(template, model, filePath, language, options), { labels: { engine: engine.Type }, fields: { template } });
     }
     /**
      *
@@ -53,14 +54,12 @@ let Templates = class Templates extends di_1.AsyncService {
      * @param renderer
      * @param model
      * @param language
+     * @param options - optional render options (e.g. progress reporting)
      * @returns
      */
-    async compile(template, renderer, model, language) {
-        const engine = this.Renderers.find((x) => x.Type === renderer);
-        if (!engine) {
-            throw new exceptions_1.InvalidOperation(`No renderer for ${renderer}`);
-        }
-        return await engine.render(template, model, language);
+    async compile(template, renderer, model, language, options) {
+        const engine = this.engineByType(renderer);
+        return await log_1.Perf.measure('template.compile', () => engine.render(template, model, language, options), { labels: { engine: engine.Type }, fields: { template } });
     }
     /**
      *
@@ -70,23 +69,39 @@ let Templates = class Templates extends di_1.AsyncService {
      * @param template
      * @param model
      * @param language
+     * @param options - optional render options (e.g. progress reporting)
      * @returns
      */
-    async render(template, model, language) {
-        const extension = (0, path_1.extname)(template);
-        const renderer = this.Renderers.find((x) => x.Extension === extension);
-        if (!renderer) {
-            throw new exceptions_1.InvalidOperation(`No renderer for file ${template} with extension ${extension}`);
+    async render(template, model, language, options) {
+        const renderer = this.engineByExtension(template);
+        return await log_1.Perf.measure('template.render', () => renderer.render(template, model, language, options), { labels: { engine: renderer.Type }, fields: { template } });
+    }
+    async renderToFile(template, model, filePath, language, options) {
+        const renderer = this.engineByExtension(template);
+        return await log_1.Perf.measure('template.render', () => renderer.renderToFile(template, model, filePath, language, options), { labels: { engine: renderer.Type }, fields: { template } });
+    }
+    /**
+     * Finds the renderer registered under the given renderer type (e.g. `handlebars`,
+     * `pdf`), throwing if none is registered.
+     */
+    engineByType(renderer) {
+        const engine = this.Renderers.find((x) => x.Type === renderer);
+        if (!engine) {
+            throw new exceptions_1.InvalidOperation(`No renderer for ${renderer}`);
         }
-        return await renderer.render(template, model, language);
+        return engine;
     }
-    async renderToFile(template, model, filePath, language) {
+    /**
+     * Finds the renderer matching the template file's extension, throwing if none
+     * is registered for that extension.
+     */
+    engineByExtension(template) {
         const extension = (0, path_1.extname)(template);
         const renderer = this.Renderers.find((x) => x.Extension === extension);
         if (!renderer) {
             throw new exceptions_1.InvalidOperation(`No renderer for file ${template} with extension ${extension}`);
         }
-        return await renderer.renderToFile(template, model, filePath, language);
+        return renderer;
     }
 };
 exports.Templates = Templates;

package/lib/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuD;AACvD,oCAA+D;AAC/D,sCAA2C;AAC3C,mDAAmD;AACnD,+BAA+B;AAC/B,wCAAqC;AACrC,kDAAgC;AAEhC;;GAEG;AAEI,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,iBAAY;IAOlC,cAAc,CAAC,OAAe;QACnC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,QAAgB,EAAE,QAAgB,EAAE,KAAc,EAAE,QAAgB,EAAE,QAAiB;QAChH,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,6BAAgB,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,OAAO,MAAM,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,QAAgB,EAAE,KAAc,EAAE,QAAiB;QACxF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,6BAAgB,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,KAAc,EAAE,QAAiB;QACrE,MAAM,SAAS,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAEvE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,6BAAgB,CAAC,wBAAwB,QAAQ,mBAAmB,SAAS,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,MAAM,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,KAAc,EAAE,QAAgB,EAAE,QAAiB;QAC7F,MAAM,SAAS,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAEvE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,6BAAgB,CAAC,wBAAwB,QAAQ,mBAAmB,SAAS,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,MAAM,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1E,CAAC;CACF,CAAA;AAtEY,8BAAS;AAEV;IADT,IAAA,YAAM,EAAC,WAAW,CAAC;8BACL,SAAG;sCAAC;AAGT;IADT,IAAA,eAAU,EAAC,gCAAgB,CAAC;;4CACW;oBAL7B,SAAS;IADrB,IAAA,WAAM,EAAC,WAAI,CAAC;GACA,SAAS,CAsErB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuD;AACvD,oCAA+D;AAC/D,sCAAiD;AACjD,mDAAmD;AAEnD,+BAA+B;AAC/B,wCAAqC;AACrC,kDAAgC;AAChC,gDAA8B;AAC9B,0CAAwB;AACxB,gEAA8C;AAC9C,yDAAuC;AAEvC;;GAEG;AAEI,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,iBAAY;IAOlC,cAAc,CAAC,OAAe;QACnC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,OAAO,CAAE,CAAC;IAC9D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,QAAgB,EAAE,QAAgB,EAAE,KAAc,EAAE,QAAgB,EAAE,QAAiB,EAAE,OAAwB;QAC1I,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,MAAM,UAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACpL,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,QAAgB,EAAE,KAAc,EAAE,QAAiB,EAAE,OAAwB;QAClH,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,MAAM,UAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACpK,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,KAAc,EAAE,QAAiB,EAAE,OAAwB;QAC/F,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAClD,OAAO,MAAM,UAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACvK,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,KAAc,EAAE,QAAgB,EAAE,QAAiB,EAAE,OAAwB;QACvH,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAClD,OAAO,MAAM,UAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IACvL,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,QAAgB;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,6BAAgB,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,iBAAiB,CAAC,QAAgB;QACxC,MAAM,SAAS,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,6BAAgB,CAAC,wBAAwB,QAAQ,mBAAmB,SAAS,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAA;AA/EY,8BAAS;AAEV;IADT,IAAA,YAAM,EAAC,WAAW,CAAC;8BACL,SAAG;sCAAC;AAGT;IADT,IAAA,eAAU,EAAC,gCAAgB,CAAC;;4CACW;oBAL7B,SAAS;IADrB,IAAA,WAAM,EAAC,WAAI,CAAC;GACA,SAAS,CA+ErB"}

package/lib/cjs/interfaces.d.ts

@@ -1,21 +1,64 @@
 import { IMappableService } from '@spinajs/di';
 import { AsyncService } from '@spinajs/di';
 import { Log } from '@spinajs/log';
+import { IStat } from '@spinajs/fs';
+import { IRenderOptions } from './progress.js';
+/**
+ * How aggressively compiled templates are reused.
+ *
+ * cache      - compile once, reuse forever. Default.
+ * revalidate - stat() the source and recompile only when its change token differs.
+ * always     - recompile on every render.
+ */
+export type TemplateCacheMode = 'cache' | 'revalidate' | 'always';
+export interface ITemplateCacheEntry {
+    compiled: unknown;
+    /**
+     * Change token captured when this entry was compiled. Null when the mode does
+     * not track one, or when the source could not be stat-ed.
+     */
+    token: string | null;
+}
 export declare abstract class TemplateRenderer extends AsyncService implements IMappableService {
     protected Log: Log;
-    protected TemplatePaths: string[];
-    protected TemplateFiles: Map<string, string[]>;
+    protected ConfiguredCacheMode: TemplateCacheMode;
+    protected DevMode: boolean;
+    protected Cache: Map<string, ITemplateCacheEntry>;
     abstract get Type(): string;
     abstract get Extension(): string;
     get ServiceName(): string;
-    abstract render(templatePath: string, model: unknown, language?: string): Promise<string>;
-    abstract renderToFile(templatePath: string, model: unknown, filePath: string, language?: string): Promise<void>;
+    abstract render(templatePath: string, model: unknown, language?: string, options?: IRenderOptions): Promise<string>;
+    abstract renderToFile(templatePath: string, model: unknown, filePath: string, language?: string, options?: IRenderOptions): Promise<void>;
+    /**
+     * Explicit config wins; otherwise dev mode implies always-recompile.
+     */
+    protected get CacheMode(): TemplateCacheMode;
+    protected isUri(template: string): boolean;
+    /**
+     * Bare paths are normalized as before. URIs must be left alone - path.normalize
+     * would turn fs://name/x into fs:\name\x on windows and break URI parsing.
+     */
+    protected normalizeTemplate(template: string): string;
+    /**
+     * Template source as text. Bare paths read from local disk exactly as before -
+     * routing them through the default provider would re-resolve relative paths
+     * against its basePath and break existing callers.
+     */
+    protected resolveContent(template: string): Promise<string>;
+    /**
+     * A real local path. For renderers that cannot compile from a string (pug),
+     * remote sources are materialised to temp storage.
+     */
+    protected resolveLocalPath(template: string): Promise<string>;
+    /**
+     * Opaque token that changes when the source changes. Null means "cannot tell" -
+     * callers must then trust whatever they already have cached.
+     */
+    protected changeToken(template: string): Promise<string | null>;
+    protected tokenFromStat(s: IStat): string;
     /**
-     * Function used for precompiling templates at load time. Not all template engines can support it, leave it empty if so.
-     *
-     * @param templateName - template name
-     * @param path - template full path
+     * Compiled-template cache honouring CacheMode. `compile` runs only on a miss.
      */
-    protected abstract compile(templateName: string, path: string): Promise<void>;
+    protected withCache<T>(template: string, compile: () => Promise<T>): Promise<T>;
 }
 //# sourceMappingURL=interfaces.d.ts.map

package/lib/cjs/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAU,GAAG,EAAE,MAAM,cAAc,CAAC;AAG3C,8BAAsB,gBAAiB,SAAQ,YAAa,YAAW,gBAAgB;IAErF,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAGnB,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC;IAElC,SAAS,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAA+B;IAE7E,aAAoB,IAAI,IAAI,MAAM,CAAC;IAEnC,aAAoB,SAAS,IAAI,MAAM,CAAC;IAExC,IAAW,WAAW,WAGrB;aAEe,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;aAChF,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtH;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAC9E"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,OAAO,EAAU,GAAG,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAM,KAAK,EAAO,MAAM,aAAa,CAAC;AAG7C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAElE,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,8BAAsB,gBAAiB,SAAQ,YAAa,YAAW,gBAAgB;IAErF,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC;IAGnB,SAAS,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;IAGjD,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAE3B,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAA0C;IAE3F,aAAoB,IAAI,IAAI,MAAM,CAAC;IAEnC,aAAoB,SAAS,IAAI,MAAM,CAAC;IAExC,IAAW,WAAW,WAGrB;aAEe,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;aAC1G,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhJ;;OAEG;IACH,SAAS,KAAK,SAAS,IAAI,iBAAiB,CAM3C;IAED,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAI1C;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIrD;;;;OAIG;cACa,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IASjE;;;OAGG;cACa,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQnE;;;OAGG;cACa,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAcrE,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM;IAQzC;;OAEG;cACa,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CA2BtF"}