npm - shokupan - Versions diffs - 0.6.1 → 0.9.0 - Mend

shokupan 0.6.1 → 0.9.0

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 (81) hide show

package/README.md +55 -2
package/dist/{openapi-analyzer-Bei1sVWp.cjs → analyzer-Bei1sVWp.cjs} +1 -1
package/dist/analyzer-Bei1sVWp.cjs.map +1 -0
package/dist/{openapi-analyzer-Ce_7JxZh.js → analyzer-Ce_7JxZh.js} +1 -1
package/dist/analyzer-Ce_7JxZh.js.map +1 -0
package/dist/cli.cjs +2 -2
package/dist/cli.cjs.map +1 -1
package/dist/cli.js +1 -1
package/dist/cli.js.map +1 -1
package/dist/context.d.ts +58 -23
package/dist/{server-adapter-DFhwlK8e.cjs → http-server-BEMPIs33.cjs} +4 -2
package/dist/http-server-BEMPIs33.cjs.map +1 -0
package/dist/{server-adapter-0xH174zz.js → http-server-CCeagTyU.js} +4 -2
package/dist/http-server-CCeagTyU.js.map +1 -0
package/dist/index.cjs +1940 -917
package/dist/index.cjs.map +1 -1
package/dist/index.d.ts +18 -17
package/dist/index.js +1948 -925
package/dist/index.js.map +1 -1
package/dist/middleware.d.ts +1 -1
package/dist/plugins/{auth.d.ts → application/auth.d.ts} +72 -3
package/dist/plugins/application/cluster.d.ts +33 -0
package/dist/plugins/{failed-request-recorder.d.ts → application/dashboard/failed-request-recorder.d.ts} +1 -1
package/dist/plugins/application/dashboard/metrics-collector.d.ts +12 -0
package/dist/plugins/application/dashboard/plugin.d.ts +42 -0
package/dist/plugins/application/dashboard/static/charts.js +328 -0
package/dist/plugins/application/dashboard/static/failures.js +85 -0
package/dist/plugins/application/dashboard/static/graph.mjs +523 -0
package/dist/plugins/application/dashboard/static/poll.js +146 -0
package/dist/plugins/application/dashboard/static/reactflow.css +18 -0
package/dist/plugins/application/dashboard/static/registry.css +131 -0
package/dist/plugins/application/dashboard/static/registry.js +269 -0
package/dist/plugins/application/dashboard/static/requests.js +118 -0
package/dist/plugins/application/dashboard/static/scrollbar.css +24 -0
package/dist/plugins/application/dashboard/static/styles.css +175 -0
package/dist/plugins/application/dashboard/static/tables.js +92 -0
package/dist/plugins/application/dashboard/static/tabs.js +113 -0
package/dist/plugins/application/dashboard/static/tabulator.css +66 -0
package/dist/plugins/application/dashboard/template.eta +246 -0
package/dist/plugins/{server-adapter.d.ts → application/http-server.d.ts} +1 -1
package/dist/plugins/{idempotency → application/idempotency}/plugin.d.ts +7 -1
package/dist/plugins/{openapi.d.ts → application/openapi/openapi.d.ts} +2 -2
package/dist/plugins/application/scalar.d.ts +36 -0
package/dist/plugins/application/socket-io.d.ts +14 -0
package/dist/plugins/middleware/compression.d.ts +17 -0
package/dist/plugins/middleware/cors.d.ts +34 -0
package/dist/plugins/{express.d.ts → middleware/express.d.ts} +1 -1
package/dist/plugins/{openapi-validator.d.ts → middleware/openapi-validator.d.ts} +2 -2
package/dist/plugins/middleware/proxy.d.ts +37 -0
package/dist/plugins/middleware/rate-limit.d.ts +58 -0
package/dist/plugins/{security-headers.d.ts → middleware/security-headers.d.ts} +51 -1
package/dist/plugins/{serve-static.d.ts → middleware/serve-static.d.ts} +1 -1
package/dist/plugins/{session.d.ts → middleware/session.d.ts} +89 -3
package/dist/plugins/{validation.d.ts → middleware/validation.d.ts} +6 -1
package/dist/router.d.ts +17 -5
package/dist/shokupan.d.ts +31 -5
package/dist/util/async-hooks.d.ts +8 -2
package/dist/util/datastore.d.ts +4 -3
package/dist/{decorators.d.ts → util/decorators.d.ts} +6 -1
package/dist/util/http-error.d.ts +38 -0
package/dist/util/http-status.d.ts +32 -0
package/dist/util/instrumentation.d.ts +1 -1
package/dist/{request.d.ts → util/request.d.ts} +1 -1
package/dist/util/symbol.d.ts +34 -0
package/dist/{router → util}/trie.d.ts +1 -1
package/dist/{types.d.ts → util/types.d.ts} +38 -2
package/package.json +9 -6
package/dist/openapi-analyzer-Bei1sVWp.cjs.map +0 -1
package/dist/openapi-analyzer-Ce_7JxZh.js.map +0 -1
package/dist/plugins/compression.d.ts +0 -5
package/dist/plugins/cors.d.ts +0 -11
package/dist/plugins/debugview/plugin.d.ts +0 -29
package/dist/plugins/proxy.d.ts +0 -11
package/dist/plugins/rate-limit.d.ts +0 -15
package/dist/plugins/scalar.d.ts +0 -15
package/dist/server-adapter-0xH174zz.js.map +0 -1
package/dist/server-adapter-DFhwlK8e.cjs.map +0 -1
package/dist/symbol.d.ts +0 -15
/package/dist/{analysis/openapi-analyzer.d.ts → plugins/application/openapi/analyzer.d.ts} +0 -0
/package/dist/{di.d.ts → util/di.d.ts} +0 -0
/package/dist/{response.d.ts → util/response.d.ts} +0 -0

package/dist/plugins/application/dashboard/template.eta ADDED Viewed

@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Shokupan Debug Dashboard</title>
+    <link href="https://unpkg.com/tabulator-tables@5.5.0/dist/css/tabulator_bootstrap5.min.css" rel="stylesheet">
+    <link rel="stylesheet" href="https://esm.sh/@xyflow/react@12.3.6/dist/style.css" />
+    <style id="styles"><%~ include("styles.css") %></style>
+    <style id="reactflow"><%~ include("reactflow.css") %></style>
+    <style id="registry"><%~ include("registry.css") %></style>
+    <style id="scrollbar"><%~ include("scrollbar.css") %></style>
+    <style id="tabulator"><%~ include("tabulator.css") %></style>
+    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+    <script type="text/javascript" src="https://unpkg.com/tabulator-tables@5.5.0/dist/js/tabulator.min.js"></script>
+</head>
+<body>
+    <div class="container">
+        <header>
+            <div>
+                <h1>Debug Dashboard</h1>
+                <div style="color: var(--text-secondary)">Uptime: <span id="uptime"><%= it.uptime %></span></div>
+            </div>
+            <div class="tabs">
+                <button class="tab-btn active" onclick="switchTab('overview')">Overview</button>
+                <button class="tab-btn" onclick="switchTab('registry')">Registry</button>
+                <button class="tab-btn" onclick="switchTab('graph')">Graph</button>
+                <button class="tab-btn" onclick="switchTab('requests')">Requests</button>
+                <button class="tab-btn" onclick="switchTab('failures')">Failures</button>
+            </div>
+        </header>
+        <!-- Overview Tab -->
+        <div id="tab-overview" class="tab-content active">
+        <div class="metrics-grid">
+            <div class="card">
+                <div class="card-title">Total Requests</div>
+                <div class="card-value" id="total-requests">
+                    <%= it.metrics.totalRequests %>
+                </div>
+            </div>
+            <div class="card">
+                <div class="card-title">Active Requests</div>
+                <div class="card-value" style="color: var(--accent)" id="active-requests">
+                    <%= it.metrics.activeRequests %>
+                </div>
+            </div>
+            <div class="card">
+                <div class="card-title">Success Rate</div>
+                <div class="card-value text-success">
+                    <span id="success-rate">
+                        <%= (it.metrics.totalRequests - it.metrics.activeRequests) ?
+                            Math.round((it.metrics.successfulRequests / (it.metrics.totalRequests -
+                            it.metrics.activeRequests)) * 100) : 100 %>%
+                    </span>
+                </div>
+                <div style="color: var(--text-secondary); margin-top: 0.5rem">
+                    <span id="successful-requests">
+                        <%= it.metrics.successfulRequests %>
+                    </span> successful
+                </div>
+            </div>
+            <div class="card">
+                <div class="card-title">Fail Rate</div>
+                <div class="card-value text-error">
+                    <span id="fail-rate">
+                        <%= (it.metrics.totalRequests - it.metrics.activeRequests) ?
+                            Math.round((it.metrics.failedRequests / (it.metrics.totalRequests -
+                            it.metrics.activeRequests)) * 100) : 0 %>%
+                    </span>
+                </div>
+                <div style="color: var(--text-secondary); margin-top: 0.5rem">
+                    <span id="failed-requests">
+                        <%= it.metrics.failedRequests %>
+                    </span> failed
+                </div>
+            </div>
+            <div class="card">
+                <div class="card-title">Avg Latency</div>
+                <div class="card-value">
+                    <span id="avg-latency">
+                        <%= it.metrics.averageTotalTime_ms.toFixed(2) %>
+                    </span> <span style="font-size: 1rem; color: var(--text-secondary)">ms</span>
+                </div>
+            </div>
+        </div>
+        <div id="chart-container" style="display: flex; flex-direction: column; gap: 1rem;">
+            <div style="display: flex; justify-content: flex-end;">
+                <select id="time-range-selector" onchange="updateCharts(); updateDashboard(); fetchTopStats();" style="background: var(--bg-primary); color: var(--text-primary); border: 1px solid var(--card-border); padding: 5px; border-radius: 4px;">
+                    <option value="1m">1 Minute</option>
+                    <option value="5m">5 Minutes</option>
+                    <option value="30m">30 Minutes</option>
+                    <option value="1h">1 Hour</option>
+                    <option value="2h">2 Hours</option>
+                    <option value="6h">6 Hours</option>
+                    <option value="12h">12 Hours</option>
+                    <option value="1d">1 Day</option>
+                    <option value="3d">3 Days</option>
+                    <option value="7d">7 Days</option>
+                    <option value="30d">30 Days</option>
+                </select>
+            </div>
+            <div class="card-container" >
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">Response Time</div>
+                    <div class="card-chart">
+                        <canvas id="latencyChart"></canvas>
+                    </div>
+                </div>
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">Requests / Second</div>
+                    <div class="card-chart">
+                        <canvas id="rpsChart"></canvas>
+                    </div>
+                </div>
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">CPU & Load</div>
+                    <div class="card-chart">
+                        <canvas id="cpuChart"></canvas>
+                    </div>
+                </div>
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">Memory</div>
+                    <div class="card-chart">
+                        <canvas id="memoryChart"></canvas>
+                    </div>
+                </div>
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">Heap Usage</div>
+                    <div class="card-chart">
+                        <canvas id="heapChart"></canvas>
+                    </div>
+                </div>
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">Event Loop Latency</div>
+                    <div class="card-chart">
+                        <canvas id="eventLoopChart"></canvas>
+                    </div>
+                </div>
+                <div class="card" style="height: 300px;">
+                    <div class="card-title">Error Rate</div>
+                    <div class="card-chart">
+                        <canvas id="errorRateChart"></canvas>
+                    </div>
+                </div>
+            </div>
+            <div class="card-title" style="margin-top: 1rem;">Top Statistics</div>
+            <div class="card-container">
+                 <div class="card">
+                    <div class="card-title">Top Requests</div>
+                    <div id="top-requests-table"></div>
+                 </div>
+                 <div class="card">
+                    <div class="card-title">Top Errors</div>
+                    <div id="top-errors-table"></div>
+                 </div>
+                 <div class="card">
+                    <div class="card-title">Most Frequent Failures</div>
+                    <div id="failing-requests-table"></div>
+                 </div>
+                 <div class="card">
+                    <div class="card-title">Slowest Requests</div>
+                    <div id="slowest-requests-table"></div>
+                 </div>
+            </div>
+            <div id="table-container" style="padding: 0; margin-top: 1rem;">
+                <div id="requests-table" class="table-dark"></div>
+            </div>
+        </div>
+    </div>
+    <!-- Registry Tab -->
+        <div id="tab-registry" class="tab-content">
+            <div id="registry-container" class="card" style="margin-top: 2rem;">
+                <div class="card-title">Component Registry</div>
+                <div id="registry-tree" style="padding: 0 1rem 1rem 1rem; font-family: monospace; font-size: 0.9rem;"></div>
+            </div>
+        </div>
+        <!-- Graph Tab -->
+        <div id="tab-graph" class="tab-content">
+             <div class="card" style="margin-bottom: 1rem;">
+                <div style="display: flex; gap: 1rem;">
+                    <input type="text" id="graph-search" placeholder="Search routes or middleware..." style="flex:1; padding: 0.5rem; border-radius: 0.5rem; background: var(--bg-primary); border: 1px solid var(--card-border); color: var(--text-primary);">
+                </div>
+            </div>
+            <div id="cy"></div>
+        </div>
+        <!-- Requests Tab -->
+        <div id="tab-requests" class="tab-content">
+             <div class="card" style="margin-bottom: 1rem; display: flex; justify-content: space-between; align-items: center;">
+                <div class="card-title">Recent Requests (Last 100)</div>
+                <div>
+                    <button onclick="fetchRequests()" style="background: var(--bg-primary); color: var(--text-primary); border: 1px solid var(--card-border); padding: 5px 10px; border-radius: 4px; cursor: pointer;">Refresh</button>
+                </div>
+             </div>
+             <div id="requests-list-container" style="height: calc(100vh - 300px); margin-bottom: 2rem;"></div>
+             <div id="request-details-container" class="card" style="display: none;">
+                <div class="card-title">Request Details</div>
+                <div id="request-details-content"></div>
+                <div class="card-title" style="margin-top: 1rem;">Middleware Trace</div>
+                <div id="middleware-trace-container"></div>
+             </div>
+        </div>
+        <!-- Failures Tab -->
+        <div id="tab-failures" class="tab-content">
+             <div class="card" style="margin-bottom: 1rem; display: flex; justify-content: space-between; align-items: center;">
+                <div class="card-title">Failed Requests (Last 50)</div>
+                <div>
+                    <button onclick="importFailure()" style="background: var(--bg-primary); color: var(--text-primary); border: 1px solid var(--card-border); padding: 5px 10px; border-radius: 4px; cursor: pointer; margin-right: 8px;">Import</button>
+                    <button onclick="fetchFailures()" style="background: var(--bg-primary); color: var(--text-primary); border: 1px solid var(--card-border); padding: 5px 10px; border-radius: 4px; cursor: pointer;">Refresh</button>
+                </div>
+             </div>
+             <div id="failures-table-container"></div>
+        </div>
+    </div>
+    <script>
+    // Injected function from server config
+    const getRequestHeaders = <%~ it.getRequestHeaders || "undefined" %>;
+    </script>
+    <script id="poll.js"><%~ include("poll.js") %></script>
+    <script id="graph.mjs" type="module"><%~ include("graph.mjs") %></script>
+    <script id="charts.js"><%~ include("charts.js") %></script>
+    <script id="tables.js"><%~ include("tables.js") %></script>
+    <script id="registry.js"><%~ include("registry.js") %></script>
+    <script id="failures.js"><%~ include("failures.js") %></script>
+    <script id="requests.js"><%~ include("requests.js") %></script>
+    <script id="tabs.js"><%~ include("tabs.js") %></script>
+</body>
+</html>

package/dist/plugins/{server-adapter.d.ts → application/http-server.d.ts} RENAMED Viewed

@@ -1,4 +1,4 @@
-import { ServerFactory } from '../types';
+import { ServerFactory } from '../../util/types';
 import * as https from "node:https";
 /**
  * Creates a server factory that uses the standard Node.js `http` module.

package/dist/plugins/{idempotency → application/idempotency}/plugin.d.ts RENAMED Viewed

@@ -1,4 +1,4 @@
-import { Middleware } from '../../types';
+import { Middleware } from '../../../util/types';
 export interface IdempotencyOptions {
     /**
      * Header name to use for the idempotency key.
@@ -11,4 +11,10 @@ export interface IdempotencyOptions {
      */
     ttl?: number;
 }
+/**
+ * Idempotency middleware. This middleware will cache responses based on the idempotency key
+ * to prevent duplicate server processing of requests.
+ * @param options Idempotency options
+ * @returns Middleware
+ */
 export declare function Idempotency(options?: IdempotencyOptions): Middleware;

package/dist/plugins/{openapi.d.ts → application/openapi/openapi.d.ts} RENAMED Viewed

@@ -1,5 +1,5 @@
-import { ShokupanRouter } from '../router';
-import { OpenAPIOptions } from '../types';
+import { ShokupanRouter } from '../../../router';
+import { OpenAPIOptions } from '../../../util/types';
 /**
  * Statically generate an OpenAPI spec from a ShokupanRouter instance.
  *

package/dist/plugins/application/scalar.d.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import { ApiReferenceConfiguration } from '@scalar/api-reference';
+import { OpenAPI } from '@scalar/openapi-types';
+import { ShokupanRouter } from '../../router';
+import { Shokupan } from '../../shokupan';
+import { DeepPartial, ShokupanPlugin, ShokupanPluginOptions } from '../../util/types';
+export type ScalarPluginOptions = {
+    /**
+     * Base document to use for API reference.
+     */
+    baseDocument?: DeepPartial<OpenAPI.Document>;
+    /**
+     * Configuration for API reference.
+     */
+    config?: Partial<ApiReferenceConfiguration>;
+    /**
+     * Whether to enable static analysis.
+     * When this is enabled, the plugin will run static analysis on the entrypoint
+     * and generate an OpenAPI document. This is useful for when you want to generate
+     * an OpenAPI document without having to manually define it.
+     *
+     * Only works with TypeScript entrypoints.
+     */
+    enableStaticAnalysis?: boolean;
+};
+/**
+ * Scalar plugin. This plugin provides an API reference interface for your API.
+ * @param options Scalar plugin options
+ * @returns Scalar plugin instance
+ */
+export declare class ScalarPlugin extends ShokupanRouter<any> implements ShokupanPlugin {
+    private readonly pluginOptions;
+    constructor(pluginOptions?: ScalarPluginOptions);
+    onInit(app: Shokupan, options?: ShokupanPluginOptions): void;
+    private init;
+    onMount(parent: ShokupanRouter<any>): void;
+}

package/dist/plugins/application/socket-io.d.ts ADDED Viewed

@@ -0,0 +1,14 @@
+import { Server } from 'socket.io';
+import { Shokupan } from '../../shokupan';
+/**
+ * Attaches the Shokupan HTTP Bridge and Event System to a Socket.IO server.
+ * This makes the Shokupan HTTP APIs accessible via Socket.IO events.
+ *
+ * Send events as `shokupan:request` events with the payload { type: "http", id: "123", body: {} }.
+ *
+ * Responses are emitted as `shokupan:response` events with the payload { id, status, body }
+ *
+ * @param io The Socket.IO server instance
+ * @param app The Shokupan application instance
+ */
+export declare function attachSocketIOBridge(io: Server, app: Shokupan): void;

package/dist/plugins/middleware/compression.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+import { Middleware } from '../../util/types';
+export interface CompressionOptions {
+    /**
+     * Minimum byte size to compress
+     */
+    threshold?: number;
+    /**
+     * Allowed algorithms
+     */
+    allowedAlgorithms?: string[];
+}
+/**
+ * Compression middleware.
+ * @param options Compression options
+ * @returns Middleware function
+ */
+export declare function Compression(options?: CompressionOptions): Middleware;

package/dist/plugins/middleware/cors.d.ts ADDED Viewed

@@ -0,0 +1,34 @@
+import { ShokupanContext } from '../../context';
+import { Middleware } from '../../util/types';
+export interface CorsOptions {
+    /**
+     * Origin to allow. Can be a string, array of strings, or function that returns a string.
+     */
+    origin?: string | string[] | ((ctx: ShokupanContext) => string | undefined | null | boolean);
+    /**
+     * HTTP methods to allow.
+     */
+    methods?: string | string[];
+    /**
+     * HTTP headers to allow.
+     */
+    allowedHeaders?: string | string[];
+    /**
+     * HTTP headers to expose.
+     */
+    exposedHeaders?: string | string[];
+    /**
+     * Whether to allow credentials.
+     */
+    credentials?: boolean;
+    /**
+     * Maximum age of preflight request.
+     */
+    maxAge?: number;
+}
+/**
+ * CORS middleware.
+ * @param options CORS options
+ * @returns Middleware function
+ */
+export declare function Cors(options?: CorsOptions): Middleware;

package/dist/plugins/{express.d.ts → middleware/express.d.ts} RENAMED Viewed

@@ -1,4 +1,4 @@
-import { Middleware } from '../types';
+import { Middleware } from '../../util/types';
 /**
  * Adapter to use legacy Express middleware.
  * NOTE: This provides a PARTIAL mock of req/res.

package/dist/plugins/{openapi-validator.d.ts → middleware/openapi-validator.d.ts} RENAMED Viewed

@@ -1,4 +1,4 @@
-import { Middleware } from '../types';
+import { Middleware } from '../../util/types';
 type ValidatorCache = Map<string, {
     [method: string]: {
         body?: import('ajv').ValidateFunction;
@@ -26,5 +26,5 @@ export declare function precompileValidators(app: any, spec: any): void;
  *
  * @param app The Shokupan application instance
  */
-export declare function enableOpenApiValidation(app: import('../shokupan').Shokupan): void;
+export declare function enableOpenApiValidation(app: import('../../shokupan').Shokupan): void;
 export {};

package/dist/plugins/middleware/proxy.d.ts ADDED Viewed

@@ -0,0 +1,37 @@
+import { Middleware } from '../../util/types';
+export interface ProxyOptions {
+    /**
+     * Target URL to proxy requests to.
+     */
+    target: string;
+    /**
+     * Function to rewrite the path of the request.
+     */
+    pathRewrite?: (path: string) => string;
+    /**
+     * Whether to change the origin of the request.
+     */
+    changeOrigin?: boolean;
+    /**
+     * Whether to proxy WebSocket connections.
+     */
+    ws?: boolean;
+    /**
+     * Additional headers to send with the request.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Whitelist of allowed target hosts.
+     */
+    allowedHosts?: string[];
+    /**
+     * Whether to allow private IPs (disabled by default).
+     */
+    allowPrivateIPs?: boolean;
+}
+/**
+ * Proxy middleware. This will proxy requests that match the path to the target URL.
+ * @param options Proxy options
+ * @returns Middleware function
+ */
+export declare function Proxy(options: ProxyOptions): Middleware;

package/dist/plugins/middleware/rate-limit.d.ts ADDED Viewed

@@ -0,0 +1,58 @@
+import { ShokupanContext } from '../../context';
+import { Middleware } from '../../util/types';
+export interface RateLimitOptions {
+    /**
+     * Window in milliseconds
+     */
+    windowMs?: number;
+    /**
+     * Maximum number of requests allowed in the window
+     */
+    max?: number;
+    /**
+     * Alias for max
+     */
+    limit?: number;
+    /**
+     * Message to send when rate limited
+     */
+    message?: string | object | ((ctx: ShokupanContext, key: string) => string | object);
+    /**
+     * Status code to send when rate limited
+     */
+    statusCode?: number;
+    /**
+     * Whether to include X-RateLimit headers in the response
+     */
+    headers?: boolean;
+    /**
+     * Function to generate a unique key for each request
+     * This is used to identify the user or source of the request
+     * Defaults to the request's ip address.
+     */
+    keyGenerator?: (ctx: ShokupanContext) => string;
+    /**
+     * Function to execute when a request is rate limited
+     */
+    onRateLimited?: (ctx: ShokupanContext, key: string) => void | Response | Promise<void | Response>;
+    /**
+     * Function to determine whether to skip rate limiting
+     */
+    skip?: (ctx: ShokupanContext) => boolean;
+    /**
+     * Mode to use for rate limiting
+     * - user: Rate limit per user (generated key, defaults to ip address)
+     * - absolute: Rate limit for all users
+     */
+    mode?: 'user' | 'absolute';
+    /**
+     * List of trusted proxy IPs
+     */
+    trustedProxies?: string[];
+}
+/**
+ * Rate limit middleware.
+ * @param options Rate limit options
+ * @returns Middleware function
+ */
+export declare function RateLimitMiddleware(options?: RateLimitOptions): Middleware;

package/dist/plugins/{security-headers.d.ts → middleware/security-headers.d.ts} RENAMED Viewed

@@ -1,36 +1,86 @@
-import { Middleware } from '../types';
+import { Middleware } from '../../util/types';
 export interface SecurityHeadersOptions {
+    /**
+     * Content Security Policy
+     */
     contentSecurityPolicy?: boolean | Record<string, any>;
+    /**
+     * Cross-Origin Embedder Policy
+     */
     crossOriginEmbedderPolicy?: boolean;
+    /**
+     * Cross-Origin Opener Policy
+     */
     crossOriginOpenerPolicy?: boolean;
+    /**
+     * Cross-Origin Resource Policy
+     */
     crossOriginResourcePolicy?: boolean;
+    /**
+     * DNS Prefetch Control
+     */
     dnsPrefetchControl?: boolean | {
         allow: boolean;
     };
+    /**
+     * Expect CT
+     */
     expectCt?: boolean | {
         maxAge?: number;
         enforce?: boolean;
         reportUri?: string;
     };
+    /**
+     * Frameguard
+     */
     frameguard?: boolean | {
         action: 'deny' | 'sameorigin' | 'allow-from';
         domain?: string;
     };
+    /**
+     * Hide Powered By
+     */
     hidePoweredBy?: boolean;
+    /**
+     * HTTP Strict Transport Security
+     */
     hsts?: boolean | {
         maxAge?: number;
         includeSubDomains?: boolean;
         preload?: boolean;
     };
+    /**
+     * IE No Open
+     */
     ieNoOpen?: boolean;
+    /**
+     * No Sniff
+     */
     noSniff?: boolean;
+    /**
+     * Origin Agent Cluster
+     */
     originAgentCluster?: boolean;
+    /**
+     * Permitted Cross Domain Policies
+     */
     permittedCrossDomainPolicies?: boolean | {
         permittedPolicies: 'none' | 'master-only' | 'by-content-type' | 'all';
     };
+    /**
+     * Referrer Policy
+     */
     referrerPolicy?: boolean | {
         policy: string | string[];
     };
+    /**
+     * X-XSS-Protection
+     */
     xssFilter?: boolean;
 }
+/**
+ * Security headers middleware.
+ * @param options Security headers options
+ * @returns Middleware function
+ */
 export declare function SecurityHeaders(options?: SecurityHeadersOptions): Middleware;

package/dist/plugins/{serve-static.d.ts → middleware/serve-static.d.ts} RENAMED Viewed

@@ -1,2 +1,2 @@
-import { Middleware, StaticServeOptions } from '../types';
+import { Middleware, StaticServeOptions } from '../../util/types';
 export declare function serveStatic<T extends Record<string, any>>(config: StaticServeOptions<T>, prefix: string): Middleware;