@spinajs/templates 2.0.481 → 2.0.482

package/lib/cjs/interfaces.js

@@ -10,18 +10,110 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateRenderer = void 0;
-const configuration_1 = require("@spinajs/configuration");
 const di_1 = require("@spinajs/di");
+const configuration_1 = require("@spinajs/configuration");
 const log_1 = require("@spinajs/log");
+const fs_1 = require("@spinajs/fs");
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
 class TemplateRenderer extends di_1.AsyncService {
     constructor() {
         super(...arguments);
-        this.TemplateFiles = new Map();
+        this.Cache = new Map();
     }
     get ServiceName() {
         // we map this service by extension
         return this.Extension;
     }
+    /**
+     * Explicit config wins; otherwise dev mode implies always-recompile.
+     */
+    get CacheMode() {
+        if (this.ConfiguredCacheMode) {
+            return this.ConfiguredCacheMode;
+        }
+        return this.DevMode ? 'always' : 'cache';
+    }
+    isUri(template) {
+        return /^fs:\/\//.test(template);
+    }
+    /**
+     * 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.
+     */
+    normalizeTemplate(template) {
+        return this.isUri(template) ? template : (0, path_1.normalize)(template);
+    }
+    /**
+     * 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.
+     */
+    async resolveContent(template) {
+        if (!this.isUri(template)) {
+            return await (0, promises_1.readFile)(template, 'utf-8');
+        }
+        const content = await fs_1.fs.read(new fs_1.URI(template), 'utf-8');
+        return Buffer.isBuffer(content) ? content.toString('utf-8') : content;
+    }
+    /**
+     * A real local path. For renderers that cannot compile from a string (pug),
+     * remote sources are materialised to temp storage.
+     */
+    async resolveLocalPath(template) {
+        if (!this.isUri(template)) {
+            return template;
+        }
+        return await fs_1.fs.download(new fs_1.URI(template));
+    }
+    /**
+     * Opaque token that changes when the source changes. Null means "cannot tell" -
+     * callers must then trust whatever they already have cached.
+     */
+    async changeToken(template) {
+        try {
+            if (this.isUri(template)) {
+                return this.tokenFromStat(await fs_1.fs.stat(new fs_1.URI(template)));
+            }
+            const s = await (0, promises_1.stat)(template);
+            return `${s.mtimeMs}|${s.size}`;
+        }
+        catch (err) {
+            this.Log.warn(`Cannot stat template ${template}, serving cached version. ${err}`);
+            return null;
+        }
+    }
+    tokenFromStat(s) {
+        if (s.Version) {
+            return s.Version;
+        }
+        return `${s.ModifiedTime?.toMillis() ?? 0}|${s.Size ?? 0}`;
+    }
+    /**
+     * Compiled-template cache honouring CacheMode. `compile` runs only on a miss.
+     */
+    async withCache(template, compile) {
+        const mode = this.CacheMode;
+        if (mode === 'always') {
+            return await compile();
+        }
+        const key = this.normalizeTemplate(template);
+        const entry = this.Cache.get(key);
+        let token = null;
+        if (mode === 'revalidate') {
+            token = await this.changeToken(template);
+            // null token => stat failed; prefer a stale entry over failing the render
+            if (entry && (token === null || token === entry.token)) {
+                return entry.compiled;
+            }
+        }
+        else if (entry) {
+            return entry.compiled;
+        }
+        const compiled = await compile();
+        this.Cache.set(key, { compiled, token });
+        return compiled;
+    }
 }
 exports.TemplateRenderer = TemplateRenderer;
 __decorate([
@@ -29,7 +121,11 @@ __decorate([
     __metadata("design:type", log_1.Log)
 ], TemplateRenderer.prototype, "Log", void 0);
 __decorate([
-    (0, configuration_1.Config)('system.dirs.templates', { defaultValue: [] }),
-    __metadata("design:type", Array)
-], TemplateRenderer.prototype, "TemplatePaths", void 0);
+    (0, configuration_1.Config)('templates.cache.mode'),
+    __metadata("design:type", String)
+], TemplateRenderer.prototype, "ConfiguredCacheMode", void 0);
+__decorate([
+    (0, configuration_1.Config)('configuration.isDevelopment', { defaultValue: false }),
+    __metadata("design:type", Boolean)
+], TemplateRenderer.prototype, "DevMode", void 0);
 //# sourceMappingURL=interfaces.js.map

package/lib/cjs/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,0DAAgD;AAChD,oCAA2C;AAC3C,sCAA2C;AAG3C,MAAsB,gBAAiB,SAAQ,iBAAY;IAA3D;;QAOY,kBAAa,GAA0B,IAAI,GAAG,EAAoB,CAAC;IAqB/E,CAAC;IAfC,IAAW,WAAW;QACpB,mCAAmC;QACnC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;CAYF;AA5BD,4CA4BC;AA1BW;IADT,IAAA,YAAM,EAAC,UAAU,CAAC;8BACJ,SAAG;6CAAC;AAGT;IADT,IAAA,sBAAM,EAAC,uBAAuB,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;;uDACpB"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,oCAA2C;AAC3C,0DAAgD;AAChD,sCAA2C;AAC3C,oCAA6C;AAC7C,0CAA0D;AAC1D,+BAAiC;AAsBjC,MAAsB,gBAAiB,SAAQ,iBAAY;IAA3D;;QAUY,UAAK,GAAqC,IAAI,GAAG,EAA+B,CAAC;IAuH7F,CAAC;IAjHC,IAAW,WAAW;QACpB,mCAAmC;QACnC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAKD;;OAEG;IACH,IAAc,SAAS;QACrB,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QAClC,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;IAC3C,CAAC;IAES,KAAK,CAAC,QAAgB;QAC9B,OAAO,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,QAAgB;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,gBAAS,EAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC7C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,OAAE,CAAC,IAAI,CAAC,IAAI,QAAG,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IACxE,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QAC/C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,OAAO,MAAM,OAAE,CAAC,QAAQ,CAAC,IAAI,QAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,WAAW,CAAC,QAAgB;QAC1C,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzB,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,OAAE,CAAC,IAAI,CAAC,IAAI,QAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC9D,CAAC;YAED,MAAM,CAAC,GAAG,MAAM,IAAA,eAAS,EAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QAClC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,QAAQ,6BAA6B,GAAG,EAAE,CAAC,CAAC;YAClF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAES,aAAa,CAAC,CAAQ;QAC9B,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;YACd,OAAO,CAAC,CAAC,OAAO,CAAC;QACnB,CAAC;QAED,OAAO,GAAG,CAAC,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;IAC7D,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,SAAS,CAAI,QAAgB,EAAE,OAAyB;QACtE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QAE5B,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtB,OAAO,MAAM,OAAO,EAAE,CAAC;QACzB,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,KAAK,GAAkB,IAAI,CAAC;QAEhC,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YAC1B,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAEzC,0EAA0E;YAC1E,IAAI,KAAK,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvD,OAAO,KAAK,CAAC,QAAa,CAAC;YAC7B,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,EAAE,CAAC;YACjB,OAAO,KAAK,CAAC,QAAa,CAAC;QAC7B,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,OAAO,EAAE,CAAC;QACjC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAEzC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAjID,4CAiIC;AA/HW;IADT,IAAA,YAAM,EAAC,UAAU,CAAC;8BACJ,SAAG;6CAAC;AAGT;IADT,IAAA,sBAAM,EAAC,sBAAsB,CAAC;;6DACkB;AAGvC;IADT,IAAA,sBAAM,EAAC,6BAA6B,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;;iDACpC"}

package/lib/cjs/io.d.ts

@@ -0,0 +1,3 @@
+/** Ensure the parent directory of `filePath` exists, creating it recursively if needed. */
+export declare function ensureParentDir(filePath: string): void;
+//# sourceMappingURL=io.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"io.d.ts","sourceRoot":"","sources":["../../src/io.ts"],"names":[],"mappings":"AAGA,2FAA2F;AAC3F,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAKtD"}

package/lib/cjs/io.js

@@ -0,0 +1,46 @@
+"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.ensureParentDir = ensureParentDir;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/** Ensure the parent directory of `filePath` exists, creating it recursively if needed. */
+function ensureParentDir(filePath) {
+    const dir = path.dirname(filePath);
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+}
+//# sourceMappingURL=io.js.map

package/lib/cjs/io.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.js","sourceRoot":"","sources":["../../src/io.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,0CAKC;AATD,uCAAyB;AACzB,2CAA6B;AAE7B,2FAA2F;AAC3F,SAAgB,eAAe,CAAC,QAAgB;IAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;AACH,CAAC"}

package/lib/cjs/progress.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Milestones a (puppeteer) render passes through. Text engines complete
+ * synchronously and do not report phases.
+ */
+export declare enum RenderPhase {
+    /** Local static server + pooled browser + page are being set up. */
+    Starting = "starting",
+    /** HTML is being built (template compiled / raw HTML injected) - before load. */
+    Preparing = "preparing",
+    /** Page content is loading - external resources (images, css, fonts) downloading. */
+    Loading = "loading",
+    /** The output is being produced (page.pdf() / screenshot). */
+    Rendering = "rendering",
+    /** Render finished successfully. */
+    Done = "done",
+    /** Render failed - `message` carries the reason. */
+    Failed = "failed"
+}
+/**
+ * A single progress snapshot delivered to a {@link RenderProgressCallback}.
+ * Resource counters are meaningful only for network-backed engines (puppeteer);
+ * they stay at 0 otherwise.
+ */
+export interface IRenderProgress {
+    /** Current render phase. */
+    phase: RenderPhase;
+    /** Best-effort completion, 0..100, weighted per phase. */
+    percent: number;
+    /** Resources whose response completed since loading started. */
+    resourcesLoaded: number;
+    /** Resources requested but not yet finished or failed. */
+    resourcesPending: number;
+    /** Resources that failed to load (e.g. broken images). */
+    resourcesFailed: number;
+    /** Milliseconds elapsed since the render started. */
+    elapsedMs: number;
+    /** Output file being produced. */
+    filePath: string;
+    /** Short human-readable status line. */
+    message?: string;
+}
+/**
+ * Progress listener. Invoked fire-and-forget by the renderer - it is never
+ * awaited and any thrown error / rejected promise is swallowed, so a slow or
+ * faulty listener can neither stall nor break a render. Emissions are throttled.
+ */
+export type RenderProgressCallback = (progress: IRenderProgress) => void | Promise<void>;
+/**
+ * Optional per-render options threaded through the {@link TemplateRenderer}
+ * contract and the {@link Templates} facade. All fields are optional; engines
+ * that do not support a given field ignore it.
+ */
+export interface IRenderOptions {
+    /** Receives throttled progress updates during the render. */
+    onProgress?: RenderProgressCallback;
+}
+//# sourceMappingURL=progress.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"progress.d.ts","sourceRoot":"","sources":["../../src/progress.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,WAAW;IACrB,oEAAoE;IACpE,QAAQ,aAAa;IACrB,iFAAiF;IACjF,SAAS,cAAc;IACvB,qFAAqF;IACrF,OAAO,YAAY;IACnB,8DAA8D;IAC9D,SAAS,cAAc;IACvB,oCAAoC;IACpC,IAAI,SAAS;IACb,oDAAoD;IACpD,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,KAAK,EAAE,WAAW,CAAC;IACnB,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,eAAe,EAAE,MAAM,CAAC;IACxB,0DAA0D;IAC1D,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,eAAe,EAAE,MAAM,CAAC;IACxB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzF;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,6DAA6D;IAC7D,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACrC"}

package/lib/cjs/progress.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderPhase = void 0;
+/**
+ * Milestones a (puppeteer) render passes through. Text engines complete
+ * synchronously and do not report phases.
+ */
+var RenderPhase;
+(function (RenderPhase) {
+    /** Local static server + pooled browser + page are being set up. */
+    RenderPhase["Starting"] = "starting";
+    /** HTML is being built (template compiled / raw HTML injected) - before load. */
+    RenderPhase["Preparing"] = "preparing";
+    /** Page content is loading - external resources (images, css, fonts) downloading. */
+    RenderPhase["Loading"] = "loading";
+    /** The output is being produced (page.pdf() / screenshot). */
+    RenderPhase["Rendering"] = "rendering";
+    /** Render finished successfully. */
+    RenderPhase["Done"] = "done";
+    /** Render failed - `message` carries the reason. */
+    RenderPhase["Failed"] = "failed";
+})(RenderPhase || (exports.RenderPhase = RenderPhase = {}));
+//# sourceMappingURL=progress.js.map

package/lib/cjs/progress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress.js","sourceRoot":"","sources":["../../src/progress.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,oEAAoE;IACpE,oCAAqB,CAAA;IACrB,iFAAiF;IACjF,sCAAuB,CAAA;IACvB,qFAAqF;IACrF,kCAAmB,CAAA;IACnB,8DAA8D;IAC9D,sCAAuB,CAAA;IACvB,oCAAoC;IACpC,4BAAa,CAAA;IACb,oDAAoD;IACpD,gCAAiB,CAAA;AACnB,CAAC,EAbW,WAAW,2BAAX,WAAW,QAatB"}

package/lib/mjs/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/mjs/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/mjs/CompiledTemplateRenderer.js

@@ -0,0 +1,46 @@
+import { InvalidArgument } from '@spinajs/exceptions';
+import { guessLanguage, defaultLanguage } from '@spinajs/intl';
+import * as fs from 'fs';
+import { TemplateRenderer } from './interfaces.js';
+import { ensureParentDir } from './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.
+ */
+export class CompiledTemplateRenderer extends TemplateRenderer {
+    async renderToFile(template, model, filePath, language) {
+        const content = await this.render(template, model, language);
+        ensureParentDir(filePath);
+        fs.writeFileSync(filePath, content);
+    }
+    async render(templateName, model, language) {
+        if (!templateName) {
+            throw new 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 : guessLanguage()) ?? defaultLanguage();
+    }
+}
+//# sourceMappingURL=CompiledTemplateRenderer.js.map

package/lib/mjs/CompiledTemplateRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompiledTemplateRenderer.js","sourceRoot":"","sources":["../../src/CompiledTemplateRenderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAS1C;;;;;;;;;;;;GAYG;AACH,MAAM,OAAgB,wBAAgF,SAAQ,gBAAgB;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,eAAe,CAAC,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,eAAe,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,aAAa,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC;IACtE,CAAC;CAcF"}

package/lib/mjs/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/mjs/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/mjs/cli/renderHelpers.js

@@ -0,0 +1,62 @@
+import { DI } from '@spinajs/di';
+import * as fs from 'fs';
+import { Templates } from '../index.js';
+import { RenderPhase } from '../progress.js';
+/** Load an optional JSON model file, returning an empty object when no readable file is given. */
+export 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.
+ */
+export async function resolveInputHtml(input, options) {
+    if (options.template) {
+        const templates = await DI.resolve(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. */
+export 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).
+ */
+export 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 === RenderPhase.Done || p.phase === 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/mjs/cli/renderHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderHelpers.js","sourceRoot":"","sources":["../../../src/cli/renderHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAmB,WAAW,EAA0B,MAAM,gBAAgB,CAAC;AAEtF,kGAAkG;AAClG,MAAM,UAAU,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;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,KAAa,EAAE,OAA4B;IAChF,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,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,MAAM,UAAU,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,MAAM,UAAU,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,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,WAAW,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/mjs/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/mjs/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/mjs/config/templates.js

@@ -2,18 +2,30 @@ import { join, normalize, resolve } from 'path';
 function dir(path) {
     const inCommonJs = typeof module !== 'undefined';
     return [
-        resolve(normalize(join(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), 'node_modules', '@spinajs', 'rbac', 'lib', inCommonJs ? 'cjs' : 'mjs', path))),
+        resolve(normalize(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
-        resolve(normalize(join(process.env.WORKSPACE_ROOT_PATH ?? process.cwd(), '../', 'node_modules', '@spinajs', 'rbac', 'lib', inCommonJs ? 'cjs' : 'mjs', path))),
+        resolve(normalize(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',
+        },
+    },
 };
 export default templates;
 //# sourceMappingURL=templates.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/config/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEhD,SAAS,GAAG,CAAC,IAAY;IACvB,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;IACjD,OAAO;QACL,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,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,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,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,eAAe,SAAS,CAAC"}
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/config/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEhD,SAAS,GAAG,CAAC,IAAY;IACvB,MAAM,UAAU,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC;IACjD,OAAO;QACL,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,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,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,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,eAAe,SAAS,CAAC"}

package/lib/mjs/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/mjs/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"}