body-parser.ts

import parser from 'co-body';
import type * as Koa from 'koa';
import type {BodyParserOptions, BodyType} from './body-parser.types';
import {getIsEnabledBodyAs, getMimeTypes, isTypes} from './body-parser.utils';

/**
 * Global declaration for the added properties to the 'ctx.request'
 */
declare module 'koa' {
  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
  interface Request {
    body?: any;
    rawBody: string;
  }
}

declare module 'http' {
  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
  interface IncomingMessage {
    body?: any;
    rawBody: string;
  }
}
/**
 * Middleware wrapper which delegate options to the core code
 */
export function bodyParserWrapper(opts: BodyParserOptions = {}) {
  const {
    patchNode = false,
    parsedMethods = ['POST', 'PUT', 'PATCH'],
    detectJSON,
    onError,
    enableTypes = ['json', 'form'],
    extendTypes = {} as NonNullable<BodyParserOptions['extendTypes']>,
    enableRawChecking = false,
    ...restOpts
  } = opts;
  const isEnabledBodyAs = getIsEnabledBodyAs(enableTypes);
  const mimeTypes = getMimeTypes(extendTypes);

  /**
   * Handler to parse the request coming data
   */
  async function parseBody(ctx: Koa.Context) {
    const shouldParseBodyAs = (type: BodyType) => {
      return Boolean(
        isEnabledBodyAs[type] &&
          isTypes(ctx.request.get('content-type'), mimeTypes[type]),
      );
    };

    const bodyType =
      detectJSON?.(ctx) || shouldParseBodyAs('json')
        ? 'json'
        : shouldParseBodyAs('form')
        ? 'form'
        : shouldParseBodyAs('text') || shouldParseBodyAs('xml')
        ? 'text'
        : null;

    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
    if (!bodyType) return {} as Record<string, string>;
    const parserOptions = {
      // force co-body return raw body
      returnRawBody: true,
      strict: bodyType === 'json' ? restOpts.jsonStrict : undefined,
      [`${bodyType}Types`]: mimeTypes[bodyType],
      limit: restOpts[`${shouldParseBodyAs('xml') ? 'xml' : bodyType}Limit`],
    };

    return parser[bodyType](ctx, parserOptions) as Promise<
      Record<string, string>
    >;
  }

  // eslint-disable-next-line func-names
  return async function bodyParser(ctx: Koa.Context, next: Koa.Next) {
    if (
      // method souldn't be parsed
      !parsedMethods.includes(ctx.method.toUpperCase()) ||
      // patchNode enabled and raw request already parsed
      (patchNode && ctx.req.body !== undefined) ||
      // koa request body already parsed
      ctx.request.body !== undefined ||
      // bodyparser disabled
      ctx.disableBodyParser
    )
      return next();
    // raw request parsed and contain 'body' values and it's enabled to override the koa request
    if (enableRawChecking && ctx.req.body !== undefined) {
      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
      ctx.request.body = ctx.req.body;
      return next();
    }

    try {
      const response = await parseBody(ctx);
      // patch node
      if (patchNode) {
        ctx.req.body = 'parsed' in response ? response.parsed : {};
        if (ctx.req.rawBody === undefined) ctx.req.rawBody = response.raw;
      }

      // patch koa
      ctx.request.body = 'parsed' in response ? response.parsed : {};
      if (ctx.request.rawBody === undefined) ctx.request.rawBody = response.raw;
    } catch (err: unknown) {
      if (!onError) throw err;
      onError(err as Error, ctx);
    }

    return next();
  };
}