js-trie-router/src/request-context.js

import {Errorf} from '@e22m4u/js-format';
import {isReadableStream} from './utils/index.js';
import {isWritableStream} from './utils/index.js';
import {ServiceContainer} from '@e22m4u/js-service';
import {getRequestPathname} from './utils/index.js';
import {isServiceContainer} from '@e22m4u/js-service';

/**
 * Request context.
 */
export class RequestContext {
  /**
   * Service container.
   *
   * @type {import('@e22m4u/js-service').ServiceContainer}
   */
  container;

  /**
   * Request.
   *
   * @type {import('http').IncomingMessage}
   */
  req;

  /**
   * Response.
   *
   * @type {import('http').ServerResponse}
   */
  res;

  /**
   * Query.
   *
   * @type {object}
   */
  query = {};

  /**
   * Path parameters.
   *
   * @type {object}
   */
  params = {};

  /**
   * Headers.
   *
   * @type {object}
   */
  headers = {};

  /**
   * Parsed cookies.
   *
   * @type {object}
   */
  cookies = {};

  /**
   * Parsed body.
   *
   * @type {*}
   */
  body;

  /**
   * Method.
   *
   * @returns {string}
   */
  get method() {
    return this.req.method.toUpperCase();
  }

  /**
   * Path.
   *
   * @returns {string}
   */
  get path() {
    return this.req.url;
  }

  /**
   * Pathname.
   *
   * @type {string|undefined}
   * @private
   */
  _pathname = undefined;

  /**
   * Pathname.
   *
   * @returns {string}
   */
  get pathname() {
    if (this._pathname != null) return this._pathname;
    this._pathname = getRequestPathname(this.req);
    return this._pathname;
  }

  /**
   * Constructor.
   *
   * @param {ServiceContainer} container
   * @param {import('http').IncomingMessage} request
   * @param {import('http').ServerResponse} response
   */
  constructor(container, request, response) {
    if (!isServiceContainer(container))
      throw new Errorf(
        'The parameter "container" of RequestContext.constructor ' +
          'should be an instance of ServiceContainer, but %v was given.',
        container,
      );
    this.container = container;
    if (
      !request ||
      typeof request !== 'object' ||
      Array.isArray(request) ||
      !isReadableStream(request)
    ) {
      throw new Errorf(
        'The parameter "request" of RequestContext.constructor ' +
          'should be an instance of IncomingMessage, but %v was given.',
        request,
      );
    }
    this.req = request;
    if (
      !response ||
      typeof response !== 'object' ||
      Array.isArray(response) ||
      !isWritableStream(response)
    ) {
      throw new Errorf(
        'The parameter "response" of RequestContext.constructor ' +
          'should be an instance of ServerResponse, but %v was given.',
        response,
      );
    }
    this.res = response;
  }
}