npm - @expressots/core - Versions diffs - 3.0.0 → 4.0.0-preview.1 - Mend

@expressots/core 3.0.0 → 4.0.0-preview.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1090) hide show

package/lib/esm/render/features/view-debugger.js ADDED Viewed

@@ -0,0 +1,172 @@
+import { Logger } from "../../provider/logger/logger.provider.js";
+/**
+ * View Debugger
+ *
+ * @description Provides debug endpoints for inspecting the render system.
+ * Only available in development mode.
+ *
+ * @public API
+ */
+export class ViewDebugger {
+    renderService;
+    logger;
+    isRegistered = false;
+    constructor(renderService) {
+        this.renderService = renderService;
+        this.logger = new Logger();
+    }
+    /**
+     * Register debug routes on the Express app.
+     *
+     * @param app - Express application
+     */
+    registerRoutes(app) {
+        if (this.isRegistered) {
+            return;
+        }
+        // Main debug endpoint
+        app.get("/__views", (req, res) => {
+            this.handleViewsEndpoint(req, res);
+        });
+        // Preview a view
+        app.get("/__views/preview/:view(*)", (req, res) => {
+            this.handlePreviewEndpoint(req, res);
+        });
+        // Get view info
+        app.get("/__views/info/:view(*)", (req, res) => {
+            this.handleInfoEndpoint(req, res);
+        });
+        // Get metrics
+        app.get("/__views/metrics", (req, res) => {
+            this.handleMetricsEndpoint(req, res);
+        });
+        this.isRegistered = true;
+        this.logger.info("View debugger enabled at /__views", "view-debugger");
+    }
+    /**
+     * Handle the main views endpoint.
+     */
+    handleViewsEndpoint(req, res) {
+        try {
+            const data = {
+                engines: this.renderService.getRegisteredEngines(),
+                activeEngine: this.renderService.getActiveEngine().name,
+                views: this.renderService.getViewFiles(),
+                config: this.renderService.getConfig(),
+                metrics: this.renderService.getMetrics(),
+                endpoints: {
+                    list: "GET /__views",
+                    preview: "GET /__views/preview/:view",
+                    info: "GET /__views/info/:view",
+                    metrics: "GET /__views/metrics",
+                },
+            };
+            res.json(data);
+        }
+        catch (error) {
+            res.status(500).json({ error: error.message });
+        }
+    }
+    /**
+     * Handle the view preview endpoint.
+     */
+    async handlePreviewEndpoint(req, res) {
+        try {
+            const view = req.params.view;
+            const data = req.query.data ? JSON.parse(req.query.data) : {};
+            const html = await this.renderService.render(view, data);
+            res.setHeader("Content-Type", "text/html");
+            res.send(this.wrapPreview(view, html));
+        }
+        catch (error) {
+            res.status(500).json({
+                error: error.message,
+                view: req.params.view,
+            });
+        }
+    }
+    /**
+     * Handle the view info endpoint.
+     */
+    handleInfoEndpoint(req, res) {
+        try {
+            const view = req.params.view;
+            const viewFiles = this.renderService.getViewFiles();
+            // Find matching view
+            const matchingFiles = viewFiles.filter((file) => file.includes(view));
+            res.json({
+                view,
+                files: matchingFiles,
+                engine: this.renderService.getActiveEngine().name,
+            });
+        }
+        catch (error) {
+            res.status(500).json({ error: error.message });
+        }
+    }
+    /**
+     * Handle the metrics endpoint.
+     */
+    handleMetricsEndpoint(req, res) {
+        try {
+            res.json(this.renderService.getMetrics());
+        }
+        catch (error) {
+            res.status(500).json({ error: error.message });
+        }
+    }
+    /**
+     * Wrap preview HTML with debug info.
+     */
+    wrapPreview(view, html) {
+        return `<!DOCTYPE html>
+<html>
+<head>
+  <title>View Preview: ${view}</title>
+  <style>
+    .debug-bar {
+      position: fixed;
+      top: 0;
+      left: 0;
+      right: 0;
+      background: #1a1a2e;
+      color: #eee;
+      padding: 8px 16px;
+      font-family: system-ui, -apple-system, sans-serif;
+      font-size: 13px;
+      z-index: 99999;
+      display: flex;
+      align-items: center;
+      gap: 16px;
+      box-shadow: 0 2px 8px rgba(0,0,0,0.2);
+    }
+    .debug-bar strong {
+      color: #00d9ff;
+    }
+    .debug-bar a {
+      color: #ff6b6b;
+      text-decoration: none;
+    }
+    .debug-bar a:hover {
+      text-decoration: underline;
+    }
+    .content-wrapper {
+      padding-top: 50px;
+    }
+  </style>
+</head>
+<body>
+  <div class="debug-bar">
+    <span>📁 <strong>${view}</strong></span>
+    <span>|</span>
+    <span>Engine: <strong>${this.renderService.getActiveEngine().name}</strong></span>
+    <span>|</span>
+    <a href="/__views">← Back to Views</a>
+  </div>
+  <div class="content-wrapper">
+    ${html}
+  </div>
+</body>
+</html>`;
+    }
+}

package/lib/esm/render/index.js ADDED Viewed

@@ -0,0 +1,54 @@
+/**
+ * ExpressoTS Render Engine
+ *
+ * @module render
+ * @description Unified render engine system supporting traditional template engines
+ * (EJS, Pug, Handlebars) and modern frameworks (React, Vue, Svelte).
+ *
+ * @example Simple usage
+ * ```typescript
+ * // In app.ts
+ * this.Middleware.render(); // Auto-detects installed engine
+ * ```
+ *
+ * @example With preset
+ * ```typescript
+ * this.Middleware.render('production');
+ * ```
+ *
+ * @example Full configuration
+ * ```typescript
+ * this.Middleware.render({
+ *   engine: 'react',
+ *   viewsDir: 'src/views',
+ *   cache: 'auto',
+ *   ssr: { hydrate: true, streaming: true },
+ *   watch: 'auto'
+ * });
+ * ```
+ *
+ * @public API
+ */
+// Registry
+export { EngineRegistry } from "./render-registry.js";
+// Base adapter
+export { BaseEngineAdapter } from "./adapters/base-adapter.js";
+// Engine adapters
+export { EjsAdapter } from "./adapters/ejs-adapter.js";
+export { PugAdapter } from "./adapters/pug-adapter.js";
+export { HandlebarsAdapter } from "./adapters/handlebars-adapter.js";
+export { ReactAdapter } from "./adapters/react-adapter.js";
+// Utilities
+export { PackageResolver, PackageNotInstalledError, getPackageResolver, } from "./utils/package-resolver.js";
+export { ViewScanner, getViewScanner } from "./utils/view-scanner.js";
+export { CacheManager, getCacheManager } from "./utils/cache-manager.js";
+// Service
+export { RenderService } from "./render-service.js";
+// Features
+export { AutoDetection } from "./features/auto-detection.js";
+export { HotReload } from "./features/hot-reload.js";
+export { ViewDebugger } from "./features/view-debugger.js";
+export { StreamingRenderer } from "./features/streaming.js";
+export { TypeGenerator } from "./features/type-generator.js";
+// Presets
+export { developmentPreset as renderDevelopmentPreset, productionPreset as renderProductionPreset, ssrPreset as renderSsrPreset, getPreset as getRenderPreset, } from "./presets/index.js";

package/lib/esm/render/presets/index.js ADDED Viewed

@@ -0,0 +1,207 @@
+/**
+ * Render Engine Presets
+ *
+ * @module render/presets
+ * @description Pre-configured render configurations for common scenarios.
+ * @public API
+ */
+/**
+ * Development Preset
+ *
+ * Optimized for development with:
+ * - No caching (see changes immediately)
+ * - Hot reload enabled
+ * - Debug mode with /__views endpoint
+ * - Streaming disabled for easier debugging
+ *
+ * @public API
+ */
+export const developmentPreset = {
+    cache: false,
+    watch: true,
+    debug: true,
+    streaming: false,
+    ssr: {
+        hydrate: true,
+        streaming: false,
+        preload: false,
+    },
+};
+/**
+ * Production Preset
+ *
+ * Optimized for production with:
+ * - View caching enabled
+ * - No hot reload
+ * - Debug mode disabled
+ * - Streaming enabled for performance
+ *
+ * @public API
+ */
+export const productionPreset = {
+    cache: true,
+    watch: false,
+    debug: false,
+    streaming: true,
+    ssr: {
+        hydrate: true,
+        streaming: true,
+        preload: true,
+    },
+};
+/**
+ * SSR Preset
+ *
+ * Optimized for server-side rendering with:
+ * - Caching enabled
+ * - Streaming enabled
+ * - Full hydration support
+ * - Progressive rendering
+ *
+ * @public API
+ */
+export const ssrPreset = {
+    cache: true,
+    streaming: true,
+    watch: false,
+    debug: false,
+    ssr: {
+        hydrate: true,
+        streaming: true,
+        preload: true,
+        progressive: true,
+    },
+};
+/**
+ * Edge Preset
+ *
+ * Optimized for edge computing environments with:
+ * - Memory-only caching
+ * - Streaming enabled
+ * - Minimal runtime overhead
+ *
+ * @public API
+ */
+export const edgePreset = {
+    cache: true,
+    streaming: true,
+    watch: false,
+    debug: false,
+    ssr: {
+        hydrate: true,
+        streaming: true,
+        preload: false,
+    },
+};
+/**
+ * API Preset
+ *
+ * Optimized for API-first applications with:
+ * - Minimal view configuration
+ * - Caching based on environment
+ *
+ * @public API
+ */
+export const apiPreset = {
+    cache: "auto",
+    watch: "auto",
+    debug: false,
+    streaming: false,
+};
+/**
+ * All available presets
+ */
+const presets = {
+    development: developmentPreset,
+    production: productionPreset,
+    ssr: ssrPreset,
+    edge: edgePreset,
+    api: apiPreset,
+};
+/**
+ * Get a preset by name.
+ *
+ * @param name - Preset name
+ * @returns Preset configuration
+ * @throws Error if preset not found
+ *
+ * @public API
+ */
+export function getPreset(name) {
+    const preset = presets[name];
+    if (!preset) {
+        throw new Error(`Unknown render preset: '${name}'. Available presets: ${Object.keys(presets).join(", ")}`);
+    }
+    // Return a copy to prevent mutations
+    return { ...preset, ssr: preset.ssr ? { ...preset.ssr } : undefined };
+}
+/**
+ * Get all available preset names.
+ *
+ * @returns Array of preset names
+ *
+ * @public API
+ */
+export function getPresetNames() {
+    return Object.keys(presets);
+}
+/**
+ * Check if a preset exists.
+ *
+ * @param name - Preset name
+ * @returns Whether the preset exists
+ *
+ * @public API
+ */
+export function hasPreset(name) {
+    return name in presets;
+}
+/**
+ * Register a custom preset.
+ *
+ * @param name - Preset name
+ * @param config - Preset configuration
+ *
+ * @public API
+ */
+export function registerPreset(name, config) {
+    presets[name] = config;
+}
+/**
+ * Merge multiple presets.
+ *
+ * @param basePreset - Base preset name
+ * @param overrides - Configuration overrides
+ * @returns Merged configuration
+ *
+ * @public API
+ */
+export function mergePreset(basePreset, overrides) {
+    const base = getPreset(basePreset);
+    return {
+        ...base,
+        ...overrides,
+        ssr: {
+            ...base.ssr,
+            ...overrides.ssr,
+        },
+    };
+}
+/**
+ * Auto-select preset based on environment.
+ *
+ * @returns Appropriate preset for current environment
+ *
+ * @public API
+ */
+export function autoSelectPreset() {
+    const env = process.env.NODE_ENV || "development";
+    switch (env) {
+        case "production":
+            return getPreset("production");
+        case "test":
+            return getPreset("development");
+        default:
+            return getPreset("development");
+    }
+}

package/lib/esm/render/render-config.js ADDED Viewed

@@ -0,0 +1,9 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * Render Engine Configuration Types
+ *
+ * @module render/config
+ * @description Configuration types for the unified render engine system.
+ * @public API
+ */
+export {};

package/lib/esm/render/render-interface.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/esm/render/render-registry.js ADDED Viewed

@@ -0,0 +1,124 @@
+/**
+ * Engine Registry
+ *
+ * @description Manages registration and lookup of template engine adapters.
+ * Provides O(1) lookup by engine name and by file extension.
+ *
+ * @public API
+ */
+export class EngineRegistry {
+    /** Map of engine name to adapter */
+    engines = new Map();
+    /** Map of file extension to adapter for quick lookup */
+    extensionMap = new Map();
+    /**
+     * Register an engine adapter.
+     *
+     * @param adapter - Engine adapter to register
+     */
+    register(adapter) {
+        this.engines.set(adapter.name, adapter);
+        // Map all extensions to this adapter
+        for (const ext of adapter.extensions) {
+            this.extensionMap.set(ext.toLowerCase(), adapter);
+        }
+    }
+    /**
+     * Get an engine adapter by name.
+     *
+     * @param name - Engine name
+     * @returns Engine adapter or undefined
+     */
+    get(name) {
+        return this.engines.get(name.toLowerCase());
+    }
+    /**
+     * Get an engine adapter by file extension.
+     *
+     * @param extension - File extension (with or without dot)
+     * @returns Engine adapter or undefined
+     */
+    getByExtension(extension) {
+        const ext = extension.startsWith(".") ? extension : `.${extension}`;
+        return this.extensionMap.get(ext.toLowerCase());
+    }
+    /**
+     * Get all registered engine adapters.
+     *
+     * @returns Array of all engine adapters
+     */
+    getAll() {
+        return Array.from(this.engines.values());
+    }
+    /**
+     * Get all registered engine names.
+     *
+     * @returns Array of engine names
+     */
+    getNames() {
+        return Array.from(this.engines.keys());
+    }
+    /**
+     * Check if an engine is registered.
+     *
+     * @param name - Engine name
+     * @returns Whether the engine is registered
+     */
+    has(name) {
+        return this.engines.has(name.toLowerCase());
+    }
+    /**
+     * Check if an extension is supported.
+     *
+     * @param extension - File extension
+     * @returns Whether the extension is supported
+     */
+    hasExtension(extension) {
+        const ext = extension.startsWith(".") ? extension : `.${extension}`;
+        return this.extensionMap.get(ext.toLowerCase()) !== undefined;
+    }
+    /**
+     * Unregister an engine adapter.
+     *
+     * @param name - Engine name to unregister
+     * @returns Whether the engine was unregistered
+     */
+    unregister(name) {
+        const adapter = this.engines.get(name.toLowerCase());
+        if (adapter) {
+            // Remove from engines map
+            this.engines.delete(name.toLowerCase());
+            // Remove extensions
+            for (const ext of adapter.extensions) {
+                this.extensionMap.delete(ext.toLowerCase());
+            }
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Clear all registered engines.
+     */
+    clear() {
+        this.engines.clear();
+        this.extensionMap.clear();
+    }
+    /**
+     * Get the number of registered engines.
+     *
+     * @returns Number of engines
+     */
+    get size() {
+        return this.engines.size;
+    }
+    /**
+     * Map extension to engine type.
+     *
+     * @param extension - File extension
+     * @returns Engine type or undefined
+     */
+    mapExtensionToEngineType(extension) {
+        const adapter = this.getByExtension(extension);
+        return adapter?.name;
+    }
+}