map-http-status-to-name.mjs

// We considered using something like 'http-status' (https://www.npmjs.com/package/http-status), but it would add a
// bunch of unnecessary codes. I.e., errors don't need 1xx, 2xx, or 3xx codes since those represent non-error statuses.

const defaultMappings = {
  400 : 'Bad Request',
  401 : 'Unauthorized',
  402 : 'Payment Required',
  403 : 'Forbidden',
  404 : 'Not Found',
  405 : 'Method Not Allowed',
  406 : 'Not Acceptable',
  407 : 'Proxy Authentication Required',
  408 : 'Request Timeout',
  409 : 'Conflict',
  410 : 'Gone',
  411 : 'Length Required',
  412 : 'Precondition Failed',
  413 : 'Content Too Large',
  414 : 'URI Too Long',
  415 : 'Unsupported Media Type',
  416 : 'Range Not Satisfiable',
  417 : 'Expectation Failed',
  418 : '(Unused)',
  421 : 'Misdirected Request',
  422 : 'Unprocessable Content',
  423 : 'Locked',
  424 : 'Failed Dependency',
  425 : 'Too Early',
  426 : 'Upgrade Required',
  428 : 'Precondition Required',
  429 : 'Too Many Requests',
  431 : 'Request Header Fields Too Large',
  440 : 'Login Time Out', // extended code from IIS
  444 : 'No Response', // extended code from Nginx
  451 : 'Unavailable For Legal Reasons',
  500 : 'Internal Server Error',
  501 : 'Not Implemented',
  502 : 'Bad Gateway',
  503 : 'Service Unavailable',
  504 : 'Gateway Timeout',
  505 : 'HTTP Version Not Supported',
  506 : 'Variant Also Negotiates',
  507 : 'Insufficient Storage',
  508 : 'Loop Detected',
  510 : 'Not Extended', // OBSOLETE
  511 : 'Network Authentication Required',
  540 : 'Unknown Error', // extended code from Cloudflair
}

const customMappings = {}

/* eslint-disable jsdoc/check-types */
/**
 * Used to translate and manage mappings from HTTP status codes to names. Supports all current status defined by the [
 * IANA](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml), as well as common extensions
 * returned by IIS, NginX, and Cloudflare.
 * - To retrieve a status name, call `mapHttpStatusToName(status)` (where `status` is a `string`).
 * - To add/override a single custom mapping, call `mapHttpStatusToName(status, name)`.
 * - To bulk add/override custom mappings, call `mapHttpStatusToName(/mappings)` (where `mappings is an `Object`).
 * - To reset the custom mappings to default, call `mapHttpStatusToName()`.
 * @param {number|Object<number,string>} status - Either the status to retrieve or set mapping for, or an
 *   `Object<number,string>` to bulk update mappings.
 * @param {string} name - The name to map a status onto.
 * @returns {string|undefined} The status name, if known.
 * @category Settings management
 */
const mapHttpStatusToName = (status, name) => {
  /* eslint-enable jsdoc/check-types */
  if (status === undefined) {
    for (const prop in customMappings) {
      delete customMappings[prop]
    }
  }
  else if (typeof status === 'object') {
    Object.assign(customMappings, status)
  }
  else if (name === undefined) {
    return customMappings[status] || defaultMappings[status] || 'Unassigned'
  }
  else {
    customMappings[status] = name
  }
}

export { mapHttpStatusToName }