import * as getType from 'cache-content-type'; import * as assert from 'assert'; import * as statuses from 'statuses'; import { is as typeis } from 'type-is'; import * as encodeUrl from 'encodeurl'; import * as escape from 'escape-html'; import * as only from 'only'; import * as vary from 'vary'; export const response = { _explicitStatus: false, _body: undefined, res: null, ctx: null, /** * Return response header. * * @return {Object} * @api public */ get header() { return this.res.headers; }, /** * Return response header, alias as response.header * * @return {Object} * @api public */ get headers() { return this.header; }, /** * Get response body. * * @return {Mixed} * @api public */ get body() { return this._body; }, /** * Set response body. * * @param {String|Buffer|Object|Stream} val * @api public */ set body(val) { this._body = val; // no content if (null == val) { if (!statuses.empty[this.status]) this.status = 204; this.remove('Content-Type'); this.remove('Content-Length'); this.remove('Transfer-Encoding'); return; } // set the status if (!this._explicitStatus) this.status = 200; // set the content-type only if not yet set const setType = !this.has('Content-Type'); // string if ('string' === typeof val) { if (setType) this.type = /^\s* true * * this.get('content-type'); * // => true * * @param {String} field * @return {boolean} * @api public */ has(field) { return this.res.hasHeader(field); }, /** * Set header `field` to `val`, or pass * an object of header fields. * * Examples: * * this.set('Foo', ['bar', 'baz']); * this.set('Accept', 'application/json'); * this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' }); * * @param {String|Object|Array} field * @param {String} val * @api public */ set(field, val?) { if (val !== undefined) { if (Array.isArray(val)) val = val.map(v => (typeof v === 'string' ? v : String(v))); else if (typeof val !== 'string') val = String(val); this.res.setHeader(field, val); } else if (typeof field !== 'string') { for (const key in field) { this.set(key, field[key]); } } }, /** * Append additional header `field` with value `val`. * * Examples: * * ``` * this.append('Link', ['', '']); * this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly'); * this.append('Warning', '199 Miscellaneous warning'); * ``` * * @param {String} field * @param {String|Array} val * @api public */ append(field, val) { const prev = this.get(field); if (prev) { val = Array.isArray(prev) ? prev.concat(val) : [prev].concat(val); } return this.set(field, val); }, /** * Return response header. * * Examples: * * this.get('Content-Type'); * // => "text/plain" * * this.get('content-type'); * // => "text/plain" * * @param {String} field * @return {String} * @api public */ get(field) { return this.res.getHeader(field); }, set type(type) { type = getType(type); if (type) { this.set('Content-Type', type); } else { this.remove('Content-Type'); } }, get type() { const type = this.get('Content-Type'); if (!type) { return ''; } return type.split(';', 1)[0]; }, remove(field) { this.res.removeHeader(field); }, get status() { return this.res.statusCode; }, /** * Set response status code. * * @param {Number} code * @api public */ set status(code) { assert.ok(Number.isInteger(code), 'status code must be a number'); assert.ok(code >= 100 && code <= 999, `invalid status code: ${code}`); this._explicitStatus = true; this.res.statusCode = code; if (this.body && statuses.empty[code]) this.body = null; }, /** * Set Content-Length field to `n`. * * @param {Number} n * @api public */ set length(n: number) { this.set('Content-Length', String(n)); }, /** * Return parsed response Content-Length when present. * * @return {Number} * @api public */ get length() { if (this.has('Content-Length')) { return parseInt(this.get('Content-Length'), 10) || 0; } const { body } = this; if (!body) return undefined; if ('string' === typeof body) return Buffer.byteLength(body); if (Buffer.isBuffer(body)) return body.length; return Buffer.byteLength(JSON.stringify(body)); }, /** * Set the Last-Modified date using a string or a Date. * * this.response.lastModified = new Date(); * this.response.lastModified = '2013-09-13'; * * @param {String|Date} type * @api public */ set lastModified(val: Date) { if ('string' === typeof val) val = new Date(val); this.set('Last-Modified', val.toUTCString()); }, /** * Get the Last-Modified date in Date form, if it exists. * * @return {Date} * @api public */ get lastModified(): Date | undefined { const date = this.get('last-modified'); if (date && typeof date === 'string') { return new Date(date); } return undefined; }, /** * Check whether the response is one of the listed types. * Pretty much the same as `this.request.is()`. * * @param {String|String[]} [type] * @param {String[]} [types] * @return {String|false} * @api public */ is(type, ...types) { return typeis(this.type, type, ...types); }, /** * Check if a header has been written to the socket. * * @return {Boolean} * @api public */ get headerSent() { return this.res.headersSent; }, /** * Vary on `field`. * * @param {String} field * @api public */ vary(field) { if (this.headerSent) return; vary(this.res, field); }, /** * Perform a 302 redirect to `url`. * * The string "back" is special-cased * to provide Referrer support, when Referrer * is not present `alt` or "/" is used. * * Examples: * * this.redirect('back'); * this.redirect('back', '/index.html'); * this.redirect('/login'); * this.redirect('http://google.com'); * * @param {String} url * @param {String} [alt] * @api public */ redirect(url: string, alt?: string) { // location if ('back' === url) url = this.ctx.get('Referrer') || alt || '/'; this.set('Location', encodeUrl(url)); // status if (!statuses.redirect[this.status]) this.status = 302; // html if (this.ctx.accepts('html')) { url = escape(url); this.type = 'text/html; charset=utf-8'; this.body = `Redirecting to ${url}.`; return; } // text this.type = 'text/plain; charset=utf-8'; this.body = `Redirecting to ${url}.`; }, /** * Inspect implementation. * * @return {Object} * @api public */ inspect() { if (!this.res) return; const o = this.toJSON(); o.body = this.body; return o; }, /** * Return JSON representation. * * @return {Object} * @api public */ toJSON() { return only(this, ['status', 'message', 'header']); }, end() { if (this.res.end) { this.res.end(); } }, };