miki-template 2.3.1 → 2.3.3

package/docs/integrations/elysia.md

@@ -1,80 +0,0 @@
-# Elysia
-
-Use miki-template with Elysia (Bun-native framework) by calling `asyncRender()` in your handlers.
-
-## Setup
-
-=== "ES Modules"
-
-    ```javascript
-    import { Elysia } from 'elysia';
-    import miki from 'miki-template';
-
-    const app = new Elysia();
-
-    app.get('/', async () => {
-      const html = await miki.asyncRender('index', {}, { views: './views' });
-      return new Response(html, {
-        headers: { 'Content-Type': 'text/html' }
-      });
-    });
-
-    export default app;
-    ```
-
-=== "CommonJS"
-
-    ```javascript
-    const { Elysia } = require('elysia');
-    const miki = require('miki-template');
-
-    const app = new Elysia();
-
-    app.get('/', async () => {
-      const html = await miki.asyncRender('index', {}, { views: './views' });
-      return new Response(html, {
-        headers: { 'Content-Type': 'text/html' }
-      });
-    });
-
-    module.exports = app;
-    ```
-
-## Partial Rendering
-
-=== "ES Modules"
-
-    ```javascript
-    app.get('/partials/:name', async ({ params }) => {
-      const html = await miki.asyncRender(
-        `home#${params.name}`,
-        {},
-        { views: './views' }
-      );
-      return new Response(html, {
-        headers: { 'Content-Type': 'text/html' }
-      });
-    });
-    ```
-
-=== "CommonJS"
-
-    ```javascript
-    app.get('/partials/:name', async ({ params }) => {
-      const html = await miki.asyncRender(
-        `home#${params.name}`,
-        {},
-        { views: './views' }
-      );
-      return new Response(html, {
-        headers: { 'Content-Type': 'text/html' }
-      });
-    });
-    ```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
-, '../.md' -replace '([a-z][a-z0-9-]+)
-, '../.md' 

package/docs/integrations/express.md

@@ -1,219 +0,0 @@
-# Express
-
-Express is the most common integration. Use `setupExpress()` for one-line setup.
-
-## Setup
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-## Options
-
-| Option | Default | Description |
-|--------|---------|-------------|
-| `extension` | `'html'` | File extension for views. Use `'miki'` if you prefer `.miki` files. |
-| `views` | `app.get('views')` | Views directory (passed to `app.set('views', ...)`). |
-| `async` | `false` | Use the async engine (`__expressAsync`). For Express 5+ with async helpers. |
-
-> The `res.render` shim intercepts **only** view names containing a `#`. Everything else (full pages, `res.render(view, cb)`, callback forms) goes through Express's normal view lookup, so the integration is fully compatible with existing Express middleware.
-
-## Manual Setup
-
-If you prefer full control:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const { __express } = require('miki-template');
-
-    const app = express();
-    app.engine('html', __express);
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import { __express } from 'miki-template';
-
-    const app = express();
-    app.engine('html', __express);
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-## Async Express 5+
-
-Express 5+ supports async route handlers natively. Pass `async: true` to `setupExpress`, or use `__expressAsync` directly:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views', async: true });
-
-    app.get('/user/:id', async (req, res) => {
-      const user = await User.findById(req.params.id);
-      if (!user) return res.status(404).send('Not found');
-      res.render('user-profile', { user });
-    });
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views', async: true });
-
-    app.get('/user/:id', async (req, res) => {
-      const user = await User.findById(req.params.id);
-      if (!user) return res.status(404).send('Not found');
-      res.render('user-profile', { user });
-    });
-    ```
-
-## Partial Renderer Middleware
-
-Add partial rendering without changing engine registration:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-    app.use(miki.expressPartialRenderer());
-
-    app.get('/card', (req, res) => res.renderPartial('home#card', { user: req.user }));
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-    // Note: must call expressPartialRenderer() before routes
-    app.use(miki.expressPartialRenderer());
-
-    app.get('/card', (req, res) => res.renderPartial('home#card', { user: req.user }));
-    ```
-
-## Express Adapter (app.engine)
-
-If you prefer not to use `setupExpress()`, you can use `express()` directly as a view engine:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const { express: mikiExpress } = require('miki-template');
-
-    const app = express();
-    app.engine('html', mikiExpress({ async: true }));
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import { express as mikiExpress } from 'miki-template';
-
-    const app = express();
-    app.engine('html', mikiExpress({ async: true }));
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-## HTMX Example
-
-miki-template's partial rendering (`#partialName`) is purpose-built for HTMX and similar frameworks:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    // Full page — initial load
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    // HTMX partial — only re-renders the "card" component
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: setupExpress](../api/setup-express.md)

package/docs/integrations/fastify.md

@@ -1,79 +0,0 @@
-# Fastify
-
-Use miki-template with Fastify by calling `asyncRender()` inline in your route handlers.
-
-## Setup
-
-=== "CommonJS"
-
-    ```javascript
-    const fastify = require('fastify')();
-    const path = require('path');
-    const miki = require('miki-template');
-
-    fastify.get('/', async (request, reply) => {
-      const html = await miki.asyncRender(
-        'index',
-        { user: request.user },
-        { views: path.resolve('./views') }
-      );
-      reply.type('text/html').send(html);
-    });
-
-    fastify.listen({ port: 3000 });
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import Fastify from 'fastify';
-    import miki from 'miki-template';
-
-    const fastify = Fastify();
-
-    fastify.get('/', async (request, reply) => {
-      const html = await miki.asyncRender(
-        'index',
-        { user: request.user },
-        { views: './views' }
-      );
-      reply.type('text/html').send(html);
-    });
-
-    fastify.listen({ port: 3000 });
-    ```
-
-## Partial Rendering
-
-=== "CommonJS"
-
-    ```javascript
-    fastify.get('/partial/:name', async (request, reply) => {
-      const html = await miki.asyncRender(
-        `home#${request.params.name}`,
-        { user: request.user },
-        { views: path.resolve('./views') }
-      );
-      reply.type('text/html').send(html);
-    });
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    fastify.get('/partial/:name', async (request, reply) => {
-      const html = await miki.asyncRender(
-        `home#${request.params.name}`,
-        { user: request.user },
-        { views: './views' }
-      );
-      reply.type('text/html').send(html);
-    });
-    ```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
-, '../.md' -replace '([a-z][a-z0-9-]+)
-, '../.md' 

package/docs/integrations/hono.md

@@ -1,80 +0,0 @@
-# Hono
-
-Use miki-template with Hono (ESM-first framework) by calling `asyncRender()` in your handlers.
-
-## Setup
-
-=== "ES Modules"
-
-    ```javascript
-    import { Hono } from 'hono';
-    import miki from 'miki-template';
-
-    const app = new Hono();
-
-    app.get('/', async (c) => {
-      const html = await miki.asyncRender(
-        'index',
-        { user: c.get('user') },
-        { views: './views' }
-      );
-      return c.html(html);
-    });
-
-    export default app;
-    ```
-
-=== "CommonJS"
-
-    ```javascript
-    const { Hono } = require('hono');
-    const miki = require('miki-template');
-
-    const app = new Hono();
-
-    app.get('/', async (c) => {
-      const html = await miki.asyncRender(
-        'index',
-        { user: c.get('user') },
-        { views: './views' }
-      );
-      return c.html(html);
-    });
-
-    module.exports = app;
-    ```
-
-## Partial Rendering
-
-=== "ES Modules"
-
-    ```javascript
-    app.get('/partials/:name', async (c) => {
-      const html = await miki.asyncRender(
-        `home#${c.req.param('name')}`,
-        { user: c.get('user') },
-        { views: './views' }
-      );
-      return c.html(html);
-    });
-    ```
-
-=== "CommonJS"
-
-    ```javascript
-    app.get('/partials/:name', async (c) => {
-      const html = await miki.asyncRender(
-        `home#${c.req.param('name')}`,
-        { user: c.get('user') },
-        { views: './views' }
-      );
-      return c.html(html);
-    });
-    ```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
-, '../.md' -replace '([a-z][a-z0-9-]+)
-, '../.md' 

package/docs/integrations/index.md

@@ -1,68 +0,0 @@
-# Integrations Overview
-
-miki-template works with all major Node.js web frameworks. Use `render()` for synchronous output or `asyncRender()` for templates with async filters/tags.
-
-## Supported Frameworks
-
-- [Express](./express.md) — One-line setup with `setupExpress()`
-- [Koa](./koa.md) — Context helper using `asyncRender()`
-- [Fastify](./fastify.md) — Inline `asyncRender()` calls
-- [Hono](./hono.md) — ESM-first, using `asyncRender()`
-- [Elysia](./elysia.md) — ESM-first, using `asyncRender()`
-- [NestJS](./nestjs.md) — Module/Provider pattern
-- [TSDX / TS-Economy (TSed)](./tsed.md) — TypeScript integration
-
-## Quick Example
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    app.listen(3000);
-    ```
-
-## Notes
-
-- For CommonJS: `const miki = require('miki-template');`
-- For ESM / Bun: `import miki from 'miki-template';` or `import * as miki from 'miki-template';`
-- When rendering files, pass `options.views` or set framework view roots so the engine can locate templates.
-- Use `asyncRender()` if your templates use async filters, async tags, or `{% load %}` libraries with async components.
-
-## Installation
-
-```bash
-# npm
-npm install miki-template
-
-# bun
-bun add miki-template
-
-# yarn
-yarn add miki-template
-```
-
-## Next Steps
-
-- [Express Integration](./express.md)
-- [API Reference: render](../api/render.md)

package/docs/integrations/koa.md

@@ -1,90 +0,0 @@
-# Koa
-
-Use miki-template with Koa by attaching an async render helper to the context.
-
-## Setup
-
-=== "CommonJS"
-
-    ```javascript
-    const Koa = require('koa');
-    const path = require('path');
-    const miki = require('miki-template');
-
-    const app = new Koa();
-
-    app.context.render = async function (view, locals = {}) {
-      const html = await miki.asyncRender(view, locals, {
-        views: path.resolve('./views')
-      });
-      this.type = 'text/html';
-      this.body = html;
-    };
-
-    app.use(async (ctx) => {
-      await ctx.render('index', { user: ctx.state.user });
-    });
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import { Koa } from 'koa';
-    import miki from 'miki-template';
-    import path from 'node:path';
-
-    const app = new Koa();
-
-    app.context.render = async function (view, locals = {}) {
-      const html = await miki.asyncRender(view, locals, {
-        views: path.resolve('./views')
-      });
-      this.type = 'text/html';
-      this.body = html;
-    };
-
-    app.use(async (ctx) => {
-      await ctx.render('index', { user: ctx.state.user });
-    });
-
-    export default app;
-    ```
-
-## Partial Rendering
-
-=== "CommonJS"
-
-    ```javascript
-    app.use(async (ctx) => {
-      const html = await miki.asyncRender(
-        `home#${ctx.params.name}`,
-        { user: ctx.state.user },
-        { views: path.resolve('./views') }
-      );
-      ctx.type = 'text/html';
-      ctx.body = html;
-    });
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    app.use(async (ctx) => {
-      const html = await miki.asyncRender(
-        `home#${ctx.params.name}`,
-        { user: ctx.state.user },
-        { views: './views' }
-      );
-      ctx.type = 'text/html';
-      ctx.body = html;
-    });
-    ```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
-, '../.md' -replace '([a-z][a-z0-9-]+)
-, '../.md' 

package/docs/integrations/nestjs.md

@@ -1,80 +0,0 @@
-# NestJS
-
-Use miki-template with NestJS by wiring it into the underlying Express adapter instance.
-
-## Setup
-
-NestJS abstracts the HTTP adapter. To use miki-template, access the underlying Express app and call `setupExpress()`.
-
-=== "TypeScript"
-
-    ```typescript
-    // main.ts
-    import { NestFactory } from '@nestjs/core';
-    import { AppModule } from './app.module';
-    import * as miki from 'miki-template';
-
-    async function bootstrap() {
-      const app = await NestFactory.create(AppModule);
-      const expressApp = app.getHttpAdapter().getInstance();
-      miki.setupExpress(expressApp, { extension: 'html', views: './views' });
-      await app.listen(3006);
-    }
-
-    bootstrap();
-    ```
-
-=== "CommonJS"
-
-    ```javascript
-    const { NestFactory } = require('@nestjs/core');
-    const { AppModule } = require('./app.module');
-    const miki = require('miki-template');
-
-    async function bootstrap() {
-      const app = await NestFactory.create(AppModule);
-      const expressApp = app.getHttpAdapter().getInstance();
-      miki.setupExpress(expressApp, { extension: 'html', views: './views' });
-      await app.listen(3006);
-    }
-
-    bootstrap();
-    ```
-
-## Using in Controllers
-
-Once `setupExpress()` is wired, use `res.render()` normally in Express-style controllers or middleware:
-
-```typescript
-import { Controller, Get, Req, Res } from '@nestjs/common';
-import { Request, Response } from 'express';
-
-@Controller()
-export class AppController {
-  @Get()
-  renderHome(@Req() req: Request, @Res() res: Response) {
-    res.render('home', { user: req.user });
-  }
-
-  @Get('partials/:name')
-  renderPartial(@Req() req: Request, @Res() res: Response) {
-    res.render(`home#${req.params.name}`, { user: req.user });
-  }
-}
-```
-
-## Partial Rendering
-
-```typescript
-@Get('cards/:id')
-renderCard(@Req() req: Request, @Res() res: Response) {
-  res.render(`home#card`, { user: req.user });
-}
-```
-
-## Next Steps
-
-- [Integrations Overview](../index.md)
-- [API Reference: setupExpress param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
-, '../.md' -replace '([a-z][a-z0-9-]+)
-, '../.md'