@mojojs/core 0.17.3 → 0.19.2

package/README.md

@@ -32,7 +32,7 @@ If you want to stay up to date on the latest developments join us on [IRC](https
   dependency hell and allow for "Perl-grade" long term support.
 
 * Fresh code based upon decades of experience developing [Mojolicious](https://mojolicious.org) and
-  [Catalyst](https://en.wikipedia.org/wiki/Catalyst_(software)), free and open source.
+  [Catalyst](http://catalyst.perl.org), free and open source.
 
 ## Installation
 

package/lib/app.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
 import type { Route } from './router/route.js';
-import type { Server } from './server.js';
 import type { AnyArguments, AppOptions, UserAgentOptions, MockRequestOptions, MojoAction, MojoContext, RouteArguments, ServerRequestOptions, TestUserAgentOptions } from './types.js';
 import type { IncomingMessage, ServerResponse } from 'http';
 import { CLI } from './cli.js';
@@ -23,50 +22,161 @@ export declare type Decoration = ((...args: any[]) => any) | {
     set?: (value: any) => any;
 };
 export declare type Plugin = (app: App, options: Record<string, any>) => any;
+/**
+ * Application class.
+ */
 export declare class App {
+    /**
+     * Command line interface.
+     */
     cli: CLI;
+    /**
+     * Application config.
+     */
     config: Record<string, any>;
+    /**
+     * Detect if the application has been imported and disable the command line interface if it has.
+     */
     detectImport: boolean;
+    /**
+     * Format for HTTP exceptions.
+     */
     exceptionFormat: string;
+    /**
+     * Application hooks.
+     */
     hooks: Hooks;
+    /**
+     * Application home directory.
+     */
     home: Path;
+    /**
+     * Application logger.
+     */
     log: Logger;
+    /**
+     * MIME types.
+     */
     mime: Mime;
+    /**
+     * Storage for user defined models.
+     */
     models: Record<string, any>;
+    /**
+     * Application renderer.
+     */
     renderer: Renderer;
+    /**
+     * Application router.
+     */
     router: Router;
+    /**
+     * Secret passphrases used for signed cookies and the like.
+     */
     secrets: string[];
+    /**
+     * Encrypted cookie based session manager.
+     */
     session: Session;
+    /**
+     * Static file server.
+     */
     static: Static;
+    /**
+     * HTTP/WebSocket user agent.
+     */
     ua: UserAgent;
+    /**
+     * JSON schema validator.
+     */
     validator: Validator;
     _contextClass: any;
     _mode: string;
-    _server: WeakRef<Server> | null;
     constructor(options?: AppOptions);
+    /**
+     * Add an application hook.
+     */
     addAppHook(name: string, fn: AppHook): this;
+    /**
+     * Add a context hook.
+     */
     addContextHook(name: string, fn: ContextHook): this;
+    /**
+     * Add a helper.
+     */
     addHelper(name: string, fn: MojoAction): this;
+    /**
+     * Generate route matching any of the listed HTTP request methods or all.
+     */
     any(...args: AnyArguments): Route;
+    /**
+     * Decorate context class with a method or getter/setter.
+     */
     decorateContext(name: string, fn: Decoration): this;
+    /**
+     * Generate route matching only `DELETE` requests.
+     */
     delete(...args: RouteArguments): Route;
+    /**
+     * Generate route matching only `GET` requests.
+     */
     get(...args: RouteArguments): Route;
+    /**
+     * Handle a new incoming request, used by servers.
+     */
     handleRequest(ctx: MojoContext): Promise<void>;
+    /**
+     * Operating mode for application. Defaults to the value of the `NODE_ENV` environment variable.
+     */
     get mode(): string;
+    /**
+     * Create a context for application.
+     */
     newContext(req: IncomingMessage, res: ServerResponse, options: ServerRequestOptions): MojoContext;
+    /**
+     * Create a mock context for application. Very useful for testing helpers.
+     */
     newMockContext(options?: MockRequestOptions): MojoContext;
+    /**
+     * Create a new mock user agent for application.
+     */
     newMockUserAgent(options?: UserAgentOptions): Promise<MockUserAgent>;
+    /**
+     * Create a new test user agent for application.
+     */
     newTestUserAgent(options?: TestUserAgentOptions): Promise<TestUserAgent>;
+    /**
+     * Generate route matching only `OPTIONS` requests.
+     */
     options(...args: RouteArguments): Route;
+    /**
+     * Generate route matching only `PATCH` requests.
+     */
     patch(...args: RouteArguments): Route;
     plugin(plugin: Plugin, options?: Record<string, any>): any;
+    /**
+     * Generate route matching only `POST` requests.
+     */
     post(...args: RouteArguments): Route;
+    /**
+     * Generate route matching only `PUT` requests.
+     */
     put(...args: RouteArguments): Route;
-    get server(): Server | null;
-    set server(server: Server | null);
+    /**
+     * Start the command line interface.
+     */
     start(command?: string, ...args: string[]): void;
+    /**
+     * Generate route for a nested route with its own intermediate destination.
+     */
     under(...args: AnyArguments): Route;
+    /**
+     * Warmup the cache, usually called automatically.
+     */
     warmup(): Promise<void>;
+    /**
+     * Generate route matching only WebSocket handshake requests.
+     */
     websocket(...args: RouteArguments): Route;
 }
 export {};

package/lib/app.js

@@ -5,6 +5,7 @@ import { Logger } from './logger.js';
 import { Mime } from './mime.js';
 import { MockRequest } from './mock/request.js';
 import { MockResponse } from './mock/response.js';
+import defaultHelpersPlugin from './plugins/default-helpers.js';
 import exceptionHelpersPlugin from './plugins/exception-helpers.js';
 import headerConditionsPlugin from './plugins/header-conditions.js';
 import mtEnginePlugin from './plugins/mt-engine.js';
@@ -20,22 +21,57 @@ import { Validator } from './validator.js';
 import Path from '@mojojs/path';
 const ContextWrapper = class extends Context {
 };
+/**
+ * Application class.
+ */
 export class App {
     constructor(options = {}) {
+        /**
+         * Command line interface.
+         */
         this.cli = new CLI(this);
+        /**
+         * Application hooks.
+         */
         this.hooks = new Hooks();
+        /**
+         * Application home directory.
+         */
         this.home = new Path();
+        /**
+         * MIME types.
+         */
         this.mime = new Mime();
+        /**
+         * Storage for user defined models.
+         */
         this.models = {};
+        /**
+         * Application renderer.
+         */
         this.renderer = new Renderer();
+        /**
+         * Application router.
+         */
         this.router = new Router();
+        /**
+         * Encrypted cookie based session manager.
+         */
         this.session = new Session(this);
+        /**
+         * Static file server.
+         */
         this.static = new Static();
+        /**
+         * HTTP/WebSocket user agent.
+         */
         this.ua = new UserAgent();
+        /**
+         * JSON schema validator.
+         */
         this.validator = new Validator();
         this._contextClass = class extends ContextWrapper {
         };
-        this._server = null;
         this.config = options.config ?? {};
         this.detectImport = options.detectImport ?? true;
         this.exceptionFormat = options.exceptionFormat ?? 'html';
@@ -43,27 +79,43 @@ export class App {
         this._mode = options.mode ?? process.env.NODE_ENV ?? 'development';
         const isDev = this._mode === 'development';
         this.log = new Logger({ historySize: isDev ? 10 : 0, level: isDev ? 'trace' : 'info' });
-        this.plugin(mtEnginePlugin);
+        this.plugin(defaultHelpersPlugin);
         this.plugin(exceptionHelpersPlugin);
         this.plugin(headerConditionsPlugin);
+        this.plugin(mtEnginePlugin);
         this.plugin(viewHelpersPlugin);
     }
+    /**
+     * Add an application hook.
+     */
     addAppHook(name, fn) {
         this.hooks.addHook(name, fn);
         return this;
     }
+    /**
+     * Add a context hook.
+     */
     addContextHook(name, fn) {
         this.hooks.addHook(name, fn);
         return this;
     }
+    /**
+     * Add a helper.
+     */
     addHelper(name, fn) {
         return this.decorateContext(name, function (...args) {
             return fn(this, ...args);
         });
     }
+    /**
+     * Generate route matching any of the listed HTTP request methods or all.
+     */
     any(...args) {
         return this.router.any(...args);
     }
+    /**
+     * Decorate context class with a method or getter/setter.
+     */
     decorateContext(name, fn) {
         const proto = Context.prototype;
         if (Object.getOwnPropertyDescriptor(proto, name) != null) {
@@ -77,76 +129,115 @@ export class App {
         }
         return this;
     }
+    /**
+     * Generate route matching only `DELETE` requests.
+     */
     delete(...args) {
         return this.router.delete(...args);
     }
+    /**
+     * Generate route matching only `GET` requests.
+     */
     get(...args) {
         return this.router.get(...args);
     }
+    /**
+     * Handle a new incoming request, used by servers.
+     */
     async handleRequest(ctx) {
-        if (ctx.isWebSocket === true) {
-            if ((await this.hooks.runHook('websocket', ctx)) === true)
-                return;
-            await this.router.dispatch(ctx);
+        if ((await this.hooks.runHook('dispatch:before', ctx)) === true)
             return;
-        }
-        if ((await this.hooks.runHook('request', ctx)) === true)
+        if (ctx.isWebSocket !== true && (await this.static.dispatch(ctx)) === true)
             return;
-        if ((await this.static.dispatch(ctx)) === true)
+        if ((await this.hooks.runHook('router:before', ctx)) === true)
             return;
         if ((await this.router.dispatch(ctx)) === true)
             return;
-        await ctx.notFound();
+        if (ctx.isWebSocket !== true)
+            await ctx.notFound();
     }
+    /**
+     * Operating mode for application. Defaults to the value of the `NODE_ENV` environment variable.
+     */
     get mode() {
         return this._mode;
     }
+    /**
+     * Create a context for application.
+     */
     newContext(req, res, options) {
         return new this._contextClass(this, req, res, options);
     }
+    /**
+     * Create a mock context for application. Very useful for testing helpers.
+     */
     newMockContext(options) {
         const req = new MockRequest(options);
         return new this._contextClass(this, req, new MockResponse(req), { isReverseProxy: false, isWebSocket: false });
     }
+    /**
+     * Create a new mock user agent for application.
+     */
     async newMockUserAgent(options) {
         return await MockUserAgent.newMockUserAgent(this, options);
     }
+    /**
+     * Create a new test user agent for application.
+     */
     async newTestUserAgent(options) {
         return await TestUserAgent.newTestUserAgent(this, options);
     }
+    /**
+     * Generate route matching only `OPTIONS` requests.
+     */
     options(...args) {
         return this.router.options(...args);
     }
+    /**
+     * Generate route matching only `PATCH` requests.
+     */
     patch(...args) {
         return this.router.patch(...args);
     }
     plugin(plugin, options = {}) {
         return plugin(this, options);
     }
+    /**
+     * Generate route matching only `POST` requests.
+     */
     post(...args) {
         return this.router.post(...args);
     }
+    /**
+     * Generate route matching only `PUT` requests.
+     */
     put(...args) {
         return this.router.put(...args);
     }
-    get server() {
-        return this._server?.deref() ?? null;
-    }
-    set server(server) {
-        this._server = server === null ? null : new WeakRef(server);
-    }
+    /**
+     * Start the command line interface.
+     */
     start(command, ...args) {
         if (this.detectImport && process.argv[1] !== Path.callerFile().toString())
             return;
         this.cli.start(command, ...args).catch(error => this.log.error(error.message));
     }
+    /**
+     * Generate route for a nested route with its own intermediate destination.
+     */
     under(...args) {
         return this.router.under(...args);
     }
+    /**
+     * Warmup the cache, usually called automatically.
+     */
     async warmup() {
         await this.renderer.warmup();
         await this.router.warmup();
     }
+    /**
+     * Generate route matching only WebSocket handshake requests.
+     */
     websocket(...args) {
         return this.router.websocket(...args);
     }

package/lib/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAcA,OAAO,EAAC,GAAG,EAAC,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AACrC,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AACjC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,sBAAsB,MAAM,gCAAgC,CAAC;AACpE,OAAO,sBAAsB,MAAM,gCAAgC,CAAC;AACpE,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AACrC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,IAAI,MAAM,cAAc,CAAC;AAEhC,MAAM,cAAc,GAAG,KAAM,SAAQ,OAAO;CAAG,CAAC;AAShD,MAAM,OAAO,GAAG;IAqBd,YAAY,UAAsB,EAAE;QApBpC,QAAG,GAAQ,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAIzB,UAAK,GAAU,IAAI,KAAK,EAAE,CAAC;QAC3B,SAAI,GAAS,IAAI,IAAI,EAAE,CAAC;QAExB,SAAI,GAAS,IAAI,IAAI,EAAE,CAAC;QACxB,WAAM,GAAwB,EAAE,CAAC;QACjC,aAAQ,GAAa,IAAI,QAAQ,EAAE,CAAC;QACpC,WAAM,GAAW,IAAI,MAAM,EAAE,CAAC;QAE9B,YAAO,GAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,WAAM,GAAW,IAAI,MAAM,EAAE,CAAC;QAC9B,OAAE,GAAc,IAAI,SAAS,EAAE,CAAC;QAChC,cAAS,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,kBAAa,GAAQ,KAAM,SAAQ,cAAc;SAAG,CAAC;QAErD,YAAO,GAA2B,IAAI,CAAC;QAGrC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,MAAM,CAAC;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;QAEnE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC;QAC3C,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,EAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAC,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACjC,CAAC;IAED,UAAU,CAAC,IAAY,EAAE,EAAW;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,IAAY,EAAE,EAAe;QAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,EAAc;QACpC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,UAA6B,GAAG,IAAW;YAC3E,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAG,IAAkB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,eAAe,CAAC,IAAY,EAAE,EAAc;QAC1C,MAAM,KAAK,GAAgB,OAAO,CAAC,SAAS,CAAC;QAC7C,IAAI,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACxD,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0CAA0C,CAAC,CAAC;SAC9E;QAED,IAAI,OAAO,EAAE,KAAK,UAAU,EAAE;YAC5B,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;SAC/D;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SACzC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,GAAG,IAAoB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,GAAG,CAAC,GAAG,IAAoB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAgB;QAClC,IAAI,GAAG,CAAC,WAAW,KAAK,IAAI,EAAE;YAC5B,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,IAAI;gBAAE,OAAO;YAClE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAChC,OAAO;SACR;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QAChE,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QACvD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QACvD,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,UAAU,CAAC,GAAoB,EAAE,GAAmB,EAAE,OAA6B;QACjF,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED,cAAc,CAAC,OAA4B;QACzC,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QACrC,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,EAAC,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAC,CAAC,CAAC;IAC/G,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAA0B;QAC/C,OAAO,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAA8B;QACnD,OAAO,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,CAAC,GAAG,IAAoB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,GAAG,IAAoB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,UAA+B,EAAE;QACtD,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,CAAC,GAAG,IAAoB;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,GAAG,CAAC,GAAG,IAAoB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC;IACvC,CAAC;IAED,IAAI,MAAM,CAAC,MAAqB;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,OAAgB,EAAE,GAAG,IAAc;QACvC,IAAI,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE;YAAE,OAAO;QAClF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,KAAK,CAAC,GAAG,IAAkB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED,SAAS,CAAC,GAAG,IAAoB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IACxC,CAAC;CACF"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAaA,OAAO,EAAC,GAAG,EAAC,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AACrC,OAAO,EAAC,KAAK,EAAC,MAAM,YAAY,CAAC;AACjC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAC/B,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAChE,OAAO,sBAAsB,MAAM,gCAAgC,CAAC;AACpE,OAAO,sBAAsB,MAAM,gCAAgC,CAAC;AACpE,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAC,QAAQ,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC;AACrC,OAAO,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AACnC,OAAO,EAAC,SAAS,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAC;AACzC,OAAO,IAAI,MAAM,cAAc,CAAC;AAEhC,MAAM,cAAc,GAAG,KAAM,SAAQ,OAAO;CAAG,CAAC;AAShD;;GAEG;AACH,MAAM,OAAO,GAAG;IAqEd,YAAY,UAAsB,EAAE;QApEpC;;WAEG;QACH,QAAG,GAAQ,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAazB;;WAEG;QACH,UAAK,GAAU,IAAI,KAAK,EAAE,CAAC;QAC3B;;WAEG;QACH,SAAI,GAAS,IAAI,IAAI,EAAE,CAAC;QAKxB;;WAEG;QACH,SAAI,GAAS,IAAI,IAAI,EAAE,CAAC;QACxB;;WAEG;QACH,WAAM,GAAwB,EAAE,CAAC;QACjC;;WAEG;QACH,aAAQ,GAAa,IAAI,QAAQ,EAAE,CAAC;QACpC;;WAEG;QACH,WAAM,GAAW,IAAI,MAAM,EAAE,CAAC;QAK9B;;WAEG;QACH,YAAO,GAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC;;WAEG;QACH,WAAM,GAAW,IAAI,MAAM,EAAE,CAAC;QAC9B;;WAEG;QACH,OAAE,GAAc,IAAI,SAAS,EAAE,CAAC;QAChC;;WAEG;QACH,cAAS,GAAG,IAAI,SAAS,EAAE,CAAC;QAE5B,kBAAa,GAAQ,KAAM,SAAQ,cAAc;SAAG,CAAC;QAInD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;QACjD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,IAAI,MAAM,CAAC;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,aAAa,CAAC;QAEnE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,KAAK,aAAa,CAAC;QAC3C,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,EAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAC,CAAC,CAAC;QAEtF,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY,EAAE,EAAW;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,IAAY,EAAE,EAAe;QAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAY,EAAE,EAAc;QACpC,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,UAA6B,GAAG,IAAW;YAC3E,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,GAAG,IAAkB;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,IAAY,EAAE,EAAc;QAC1C,MAAM,KAAK,GAAgB,OAAO,CAAC,SAAS,CAAC;QAC7C,IAAI,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;YACxD,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,0CAA0C,CAAC,CAAC;SAC9E;QAED,IAAI,OAAO,EAAE,KAAK,UAAU,EAAE;YAC5B,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;SAC/D;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SACzC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,IAAoB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,GAAG,IAAoB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,GAAgB;QAClC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QACxE,IAAI,GAAG,CAAC,WAAW,KAAK,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QAEnF,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QACtE,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI;YAAE,OAAO;QAEvD,IAAI,GAAG,CAAC,WAAW,KAAK,IAAI;YAAE,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,GAAoB,EAAE,GAAmB,EAAE,OAA6B;QACjF,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,OAA4B;QACzC,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QACrC,OAAO,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,EAAC,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAC,CAAC,CAAC;IAC/G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAA0B;QAC/C,OAAO,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAA8B;QACnD,OAAO,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,GAAG,IAAoB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,IAAoB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,UAA+B,EAAE;QACtD,OAAO,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,GAAG,IAAoB;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,GAAG,IAAoB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAgB,EAAE,GAAG,IAAc;QACvC,IAAI,IAAI,CAAC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE;YAAE,OAAO;QAClF,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,IAAkB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,GAAG,IAAoB;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IACxC,CAAC;CACF"}

package/lib/body/params.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="node" />
 import { URLSearchParams } from 'url';
+/**
+ * GET/POST parameter class.
+ */
 export declare class Params extends URLSearchParams {
+    /**
+     * Convert parameters into a plain object, useful for validation.
+     */
     toObject(): Record<string, string>;
 }

package/lib/body/params.js

@@ -1,5 +1,11 @@
 import { URLSearchParams } from 'url';
+/**
+ * GET/POST parameter class.
+ */
 export class Params extends URLSearchParams {
+    /**
+     * Convert parameters into a plain object, useful for validation.
+     */
     toObject() {
         return Object.fromEntries(this);
     }

package/lib/body/params.js.map

@@ -1 +1 @@
-{"version":3,"file":"params.js","sourceRoot":"","sources":["../../src/body/params.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,KAAK,CAAC;AAEpC,MAAM,OAAO,MAAO,SAAQ,eAAe;IACzC,QAAQ;QACN,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF"}
+{"version":3,"file":"params.js","sourceRoot":"","sources":["../../src/body/params.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,KAAK,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,eAAe;IACzC;;OAEG;IACH,QAAQ;QACN,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;CACF"}

package/lib/body.d.ts

@@ -22,24 +22,72 @@ interface FileUpload {
     encoding: string;
     mimetype: string;
 }
+/**
+ * HTTP message body base class.
+ */
 export declare class Body {
+    /**
+     * Automatically decompress message body if necessary.
+     */
     autoDecompress: boolean;
+    /**
+     * Low-level HTTP message.
+     */
     raw: IncomingMessage;
     _form: Params | undefined;
     constructor(stream: IncomingMessage);
     [Symbol.asyncIterator](): AsyncIterable<Buffer>;
+    /**
+     * Get message body as `Buffer` object.
+     */
     buffer(): Promise<Buffer>;
+    /**
+     * Get message body as a readable stream.
+     */
     createReadStream(): Readable;
+    /**
+     * Get async iterator for uploaded files from message body.
+     */
     files(options?: UploadOptions): AsyncIterableIterator<FileUpload>;
+    /**
+     * Get form parameters from message body.
+     */
     form(options?: UploadOptions): Promise<Params>;
+    /**
+     * Get HTTP header from message.
+     */
     get(name: string): string | undefined;
+    /**
+     * Get HTTP headers from message.
+     */
     get headers(): IncomingHttpHeaders;
+    /**
+     * Get HTML message body as `@mojojs/dom` object.
+     */
     html(): Promise<DOM>;
+    /**
+     * Check if underlying socket was encrypted with TLS.
+     */
     get isSecure(): boolean;
+    /**
+     * Get JSON message body as parsed data structure.
+     */
     json(): Promise<JSONValue>;
+    /**
+     * Pipe message body to writable stream.
+     */
     pipe(writer: Writable): Promise<void>;
+    /**
+     * Get message body as string.
+     */
     text(charset?: BufferEncoding): Promise<string>;
+    /**
+     * Get XML message body as `@mojojs/dom` object.
+     */
     xml(): Promise<DOM>;
+    /**
+     * Get YAML message body as parsed data structure.
+     */
     yaml(): Promise<unknown>;
     _consumeBody(): Promise<Uint8Array[]>;
     _formIterator(options?: UploadOptions): AsyncIterableIterator<[string, Readable, string, string, string]>;

package/lib/body.js

@@ -4,8 +4,14 @@ import { Params } from './body/params.js';
 import DOM from '@mojojs/dom';
 import busboy from 'busboy';
 import yaml from 'js-yaml';
+/**
+ * HTTP message body base class.
+ */
 export class Body {
     constructor(stream) {
+        /**
+         * Automatically decompress message body if necessary.
+         */
         this.autoDecompress = true;
         this._form = undefined;
         this.raw = stream;
@@ -13,9 +19,15 @@ export class Body {
     async *[Symbol.asyncIterator]() {
         yield* this.createReadStream();
     }
+    /**
+     * Get message body as `Buffer` object.
+     */
     async buffer() {
         return Buffer.concat(await this._consumeBody());
     }
+    /**
+     * Get message body as a readable stream.
+     */
     createReadStream() {
         if (this.autoDecompress !== true || this.get('content-encoding') !== 'gzip')
             return this.raw;
@@ -23,6 +35,9 @@ export class Body {
         this.raw.pipe(gunzip);
         return gunzip;
     }
+    /**
+     * Get async iterator for uploaded files from message body.
+     */
     async *files(options) {
         if (this._isForm() === false)
             return;
@@ -37,6 +52,9 @@ export class Body {
                 throw error;
         }
     }
+    /**
+     * Get form parameters from message body.
+     */
     async form(options) {
         if (this._form === undefined) {
             // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -46,34 +64,61 @@ export class Body {
         }
         return this._params;
     }
+    /**
+     * Get HTTP header from message.
+     */
     get(name) {
         const header = this.raw.headers[name.toLowerCase()];
         return Array.isArray(header) ? header.join(',') : header;
     }
+    /**
+     * Get HTTP headers from message.
+     */
     get headers() {
         return this.raw.headers;
     }
+    /**
+     * Get HTML message body as `@mojojs/dom` object.
+     */
     async html() {
         return new DOM(await this.text());
     }
+    /**
+     * Check if underlying socket was encrypted with TLS.
+     */
     get isSecure() {
         const socket = this.raw.socket;
         return socket.encrypted ?? false;
     }
+    /**
+     * Get JSON message body as parsed data structure.
+     */
     async json() {
         return JSON.parse((await this.buffer()).toString());
     }
+    /**
+     * Pipe message body to writable stream.
+     */
     async pipe(writer) {
         return await new Promise((resolve, reject) => {
             this.createReadStream().on('error', reject).pipe(writer).on('unpipe', resolve);
         });
     }
+    /**
+     * Get message body as string.
+     */
     async text(charset = 'utf8') {
         return (await this.buffer()).toString(charset);
     }
+    /**
+     * Get XML message body as `@mojojs/dom` object.
+     */
     async xml() {
         return new DOM(await this.text(), { xml: true });
     }
+    /**
+     * Get YAML message body as parsed data structure.
+     */
     async yaml() {
         return yaml.load((await this.buffer()).toString());
     }