@opra/common 0.14.0 → 0.16.0

package/esm/http/http-response-message.js

@@ -0,0 +1,238 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpResponseMessageHost = exports.HttpResponseMessage = void 0;
+const tslib_1 = require("tslib");
+const content_disposition_1 = tslib_1.__importDefault(require("content-disposition"));
+const cookie_1 = tslib_1.__importDefault(require("cookie"));
+const cookie_signature_1 = tslib_1.__importDefault(require("cookie-signature"));
+const encodeurl_1 = tslib_1.__importDefault(require("encodeurl"));
+const http_parser_js_1 = require("http-parser-js");
+const mime_types_1 = tslib_1.__importDefault(require("mime-types"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const http_status_messages_js_1 = require("./enums/http-status-messages.js");
+const http_message_host_js_1 = require("./http-message.host.js");
+/**
+ * @namespace HttpResponseMessage
+ */
+var HttpResponseMessage;
+(function (HttpResponseMessage) {
+    function create(init) {
+        return HttpResponseMessageHost.create(init);
+    }
+    HttpResponseMessage.create = create;
+    function fromBuffer(buffer) {
+        return HttpResponseMessageHost.fromBuffer(buffer);
+    }
+    HttpResponseMessage.fromBuffer = fromBuffer;
+    async function fromStream(readable) {
+        return HttpResponseMessageHost.fromStream(readable);
+    }
+    HttpResponseMessage.fromStream = fromStream;
+})(HttpResponseMessage = exports.HttpResponseMessage || (exports.HttpResponseMessage = {}));
+/**
+ * @class HttpResponseMessageHost
+ */
+class HttpResponseMessageHost extends http_message_host_js_1.HttpMessageHost {
+    constructor() {
+        super();
+    }
+    header(arg0, arg1) {
+        return this.set(arg0, arg1);
+    }
+    append(name, value) {
+        this[http_message_host_js_1.HttpMessageHost.kHeaders].append(name, value);
+        return this;
+    }
+    /**
+     * Set "Content-Disposition" header to "attachment" with optional `filename`.
+     */
+    attachment(filename) {
+        if (filename)
+            this.type(path_1.default.extname(filename));
+        this.set('Content-Disposition', (0, content_disposition_1.default)(filename));
+        return this;
+    }
+    /**
+     * Alias for msg.type()
+     */
+    contentType(type) {
+        return this.type(type);
+    }
+    /**
+     * Set _Content-Type_ response header with `type` through `mime.lookup()`
+     * when it does not contain "/", or set the Content-Type to `type` otherwise.
+     *
+     * Examples:
+     *
+     *     res.type('.html');
+     *     res.type('html');
+     *     res.type('json');
+     *     res.type('application/json');
+     *     res.type('png');
+     */
+    type(type) {
+        const ct = type.indexOf('/') === -1
+            ? mime_types_1.default.lookup(type)
+            : type;
+        if (ct)
+            this.set('Content-Type', ct);
+        return this;
+    }
+    /**
+     * Set cookie `name` to `value`, with the given `options`.
+     *
+     * Options:
+     *
+     *    - `maxAge`   max-age in milliseconds, converted to `expires`
+     *    - `signed`   sign the cookie
+     *    - `path`     defaults to "/"
+     *
+     * Examples:
+     *
+     *    // "Remember Me" for 15 minutes
+     *    res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
+     *
+     *    // same as above
+     *    res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
+     *
+     */
+    cookie(name, value, options) {
+        const opts = { ...options };
+        const secret = this.req?.secret;
+        const signed = opts.signed;
+        if (signed && !secret) {
+            throw new Error('cookieParser("secret") required for signed cookies');
+        }
+        let val = typeof value === 'object'
+            ? 'j:' + JSON.stringify(value)
+            : String(value);
+        if (signed)
+            val = 's:' + cookie_signature_1.default.sign(val, secret);
+        if (opts.maxAge != null) {
+            const maxAge = opts.maxAge - 0;
+            if (!isNaN(maxAge)) {
+                opts.expires = new Date(Date.now() + maxAge);
+                opts.maxAge = Math.floor(maxAge / 1000);
+            }
+        }
+        if (opts.path == null)
+            opts.path = '/';
+        // Remove old cookie
+        let a = this.get('Set-Cookie');
+        if (a && Array.isArray(a)) {
+            a = a.filter(x => !x.startsWith(name + '='));
+            this.set('Set-Cookie', a);
+        }
+        this.append('Set-Cookie', cookie_1.default.serialize(name, String(val), opts));
+        return this;
+    }
+    /**
+     * Clear cookie `name`.
+     */
+    clearCookie(name, options) {
+        return this.cookie(name, '', { expires: new Date(1), path: '/', ...options });
+    }
+    /**
+     * Set Link header field with the given `links`.
+     *
+     * Examples:
+     *
+     *    res.links({
+     *      next: 'http://api.example.com/users?page=2',
+     *      last: 'http://api.example.com/users?page=5'
+     *    });
+     *
+     */
+    links(links) {
+        let link = this.get('Link') || '';
+        if (link)
+            link += ', ';
+        return this.set('Link', link + Object.keys(links).map(rel => '<' + links[rel] + '>; rel="' + rel + '"').join(', '));
+    }
+    redirect(arg0, url) {
+        let status = 302;
+        // allow status / url
+        if (typeof arg0 === 'number') {
+            status = arg0;
+        }
+        else
+            url = arg0 || '';
+        // Set location header
+        this.location(url || '/');
+        // Respond
+        this.statusCode = status;
+    }
+    /**
+     * Send JSON response.
+     *
+     * Examples:
+     *
+     *     res.json(null);
+     *     res.json({ user: 'tj' });
+     */
+    json(obj) {
+        if (!this.get('Content-Type'))
+            this.set('Content-Type', 'application/json');
+        const body = JSON.stringify(obj);
+        return this.send(body);
+    }
+    location(url) {
+        let loc = url;
+        // "back" is an alias for the referrer
+        if (url === 'back')
+            loc = this.req?.get('Referrer') || '/';
+        // set location
+        return this.set('Location', (0, encodeurl_1.default)(loc));
+    }
+    /**
+     * Set status `code`.
+     */
+    status(code) {
+        this.statusCode = code;
+        return this;
+    }
+    /**
+     * Set the response HTTP status code to `statusCode` and send its string representation as the response body.
+     * @link http://expressjs.com/4x/api.html#res.sendStatus
+     *
+     * Examples:
+     *
+     *    res.sendStatus(200); // equivalent to res.status(200).send('OK')
+     *    res.sendStatus(403); // equivalent to res.status(403).send('Forbidden')
+     *    res.sendStatus(404); // equivalent to res.status(404).send('Not Found')
+     *    res.sendStatus(500); // equivalent to res.status(500).send('Internal Server Error')
+     */
+    sendStatus(statusCode) {
+        const body = http_status_messages_js_1.HttpStatusMessages[statusCode] || String(statusCode);
+        this.statusCode = statusCode;
+        this.type('txt');
+        return this.send(body);
+    }
+    _init(init) {
+        super._init(init);
+        this.statusCode = init?.statusCode;
+        this.statusMessage = init?.statusMessage;
+        this.req = init?.req;
+        this.chunkedEncoding = init?.chunkedEncoding;
+    }
+    [http_message_host_js_1.HttpMessageHost.kOnHeaderReceived](info) {
+        super[http_message_host_js_1.HttpMessageHost.kOnHeaderReceived](info);
+        this.statusCode = info.statusCode;
+        this.statusMessage = info.statusMessage;
+    }
+    static create(init) {
+        const msg = new HttpResponseMessageHost();
+        msg._init(init);
+        return msg;
+    }
+    static fromBuffer(buffer) {
+        const msg = new HttpResponseMessageHost();
+        msg._parseBuffer(buffer, http_parser_js_1.HTTPParser.RESPONSE);
+        return msg;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async fromStream(readable) {
+        throw new Error('fromStream is not implemented yet');
+    }
+}
+exports.HttpResponseMessageHost = HttpResponseMessageHost;

package/esm/http/index.js

@@ -1,17 +1,17 @@
-export * from './http-request-node.js';
-export * from './http-headers.js';
-export * from './http-request.js';
-export * from './http-response.js';
-export * from './http-params.js';
-export * from './http-param-codec.js';
-export * from './enums/http-headers-codes.enum.js';
-export * from './enums/http-status-codes.enum.js';
-export * from './interfaces/client-http-headers.interface.js';
-export * from './interfaces/server-http-headers.interface.js';
-export * from './param-codec/date-codec.js';
-export * from './param-codec/boolean-codec.js';
-export * from './param-codec/filter-codec.js';
-export * from './param-codec/integer-codec.js';
-export * from './param-codec/number-codec.js';
-export * from './param-codec/string-codec.js';
-export * from './utils/normalize-headers.js';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./http-headers.js"), exports);
+tslib_1.__exportStar(require("./http-params.js"), exports);
+tslib_1.__exportStar(require("./http-response-message.js"), exports);
+tslib_1.__exportStar(require("./http-request-message.js"), exports);
+tslib_1.__exportStar(require("./enums/http-headers-codes.enum.js"), exports);
+tslib_1.__exportStar(require("./enums/http-status-codes.enum.js"), exports);
+tslib_1.__exportStar(require("./interfaces/client-http-headers.interface.js"), exports);
+tslib_1.__exportStar(require("./interfaces/server-http-headers.interface.js"), exports);
+tslib_1.__exportStar(require("./codecs/date-codec.js"), exports);
+tslib_1.__exportStar(require("./codecs/boolean-codec.js"), exports);
+tslib_1.__exportStar(require("./codecs/filter-codec.js"), exports);
+tslib_1.__exportStar(require("./codecs/integer-codec.js"), exports);
+tslib_1.__exportStar(require("./codecs/number-codec.js"), exports);
+tslib_1.__exportStar(require("./codecs/string-codec.js"), exports);

package/esm/http/interfaces/client-http-headers.interface.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/http/interfaces/cookie-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/http/interfaces/server-http-headers.interface.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/http/multipart/batch-multipart.js

@@ -1,149 +1,170 @@
-import Highland from 'highland';
-import { uid } from 'uid';
-import { isReadable } from '../../utils/type-guards.js';
-import { HttpHeaderCodes } from '../enums/http-headers-codes.enum.js';
-import { HttpStatusCodes } from '../enums/http-status-codes.enum.js';
-import { normalizeHeaders } from '../utils/normalize-headers.js';
-import { HttpRequestContent } from './http-request-content.js';
-import { HttpResponseContent } from './http-response-content.js';
-const CRLF = '\r\n';
-const CHARSET_PATTERN = / *charset=./i;
-export class BatchMultipart {
-    constructor() {
-        this._parts = [];
-        this.boundary = 'batch_' + uid(12);
-    }
-    addRequestPart(content, part) {
-        const headers = {
-            ...normalizeHeaders(part?.headers || {}, true),
-            [HttpHeaderCodes.Content_Type]: 'application/http',
-            [HttpHeaderCodes.Content_Transfer_Encoding]: 'binary'
-        };
-        if (part?.contentId)
-            headers[HttpHeaderCodes.Content_ID] = part.contentId;
-        this._parts.push({
-            headers,
-            contentId: part?.contentId,
-            content: new HttpRequestContent(content)
-        });
-        return this;
-    }
-    addHttpResponse(content, part) {
-        const headers = {
-            ...normalizeHeaders(part?.headers || {}, true),
-            [HttpHeaderCodes.Content_Type]: 'application/http',
-            [HttpHeaderCodes.Content_Transfer_Encoding]: 'binary'
-        };
-        if (part?.contentId)
-            headers[HttpHeaderCodes.Content_ID] = part.contentId;
-        this._parts.push({
-            headers,
-            contentId: part?.contentId,
-            content: new HttpResponseContent(content)
-        });
-        return this;
-    }
-    addBatch(batch, part) {
-        const headers = {
-            ...normalizeHeaders(part?.headers || {}, true),
-            [HttpHeaderCodes.Content_Type]: 'application/http',
-            [HttpHeaderCodes.Content_Transfer_Encoding]: 'binary'
-        };
-        if (part?.contentId)
-            headers[HttpHeaderCodes.Content_ID] = part.contentId;
-        this._parts.push({
-            headers,
-            contentId: part?.contentId,
-            content: batch
-        });
-        return this;
-    }
-    stream() {
-        const chunks = [];
-        this._build(chunks);
-        return Highland(chunks).flatten().toNodeStream();
-    }
-    _build(target) {
-        for (const part of this._parts) {
-            if (part.content instanceof HttpRequestContent || part.content instanceof HttpResponseContent) {
-                let contentBody = part.content.data;
-                let contentLength = 0;
-                const contentHeaders = normalizeHeaders(part.content.headers);
-                if (contentBody) {
-                    const contentType = String(contentHeaders['content-type'] || '').split(/\s*;\s*/);
-                    let charset = '';
-                    if (isReadable(contentBody)) {
-                        contentLength = parseInt(String(contentHeaders['content-length']), 10) || 0;
-                        // const l = parseInt(String(contentHeaders['content-length']), 10);
-                        // if (isNaN(l))
-                        //   throw new TypeError('"content-length" header required for streamed responses');
-                    }
-                    else if (typeof contentBody === 'object') {
-                        if (typeof contentBody.stream === 'function') { // File and Blob
-                            contentType[0] = contentBody.type || 'binary';
-                            contentLength = contentBody.size;
-                            contentBody = contentBody.stream();
-                        }
-                        else if (Buffer.isBuffer(contentBody)) {
-                            contentHeaders['content-length'] = String(contentBody.length);
-                        }
-                        else {
-                            contentType[0] = contentType[0] || 'application/json';
-                            charset = 'utf-8';
-                            contentBody = Buffer.from(JSON.stringify(contentBody), 'utf-8');
-                            contentLength = contentBody.length;
-                        }
-                    }
-                    else {
-                        contentType[0] = contentType[0] || 'text/plain';
-                        charset = 'utf-8';
-                        contentBody = Buffer.from(String(contentBody), 'utf-8');
-                        contentLength = contentBody.length;
-                    }
-                    if (contentType[0]) {
-                        if (charset) {
-                            const i = contentType.findIndex(x => CHARSET_PATTERN.test(String(x)));
-                            if (i > 0)
-                                contentType[i] = 'charset=' + charset;
-                            else
-                                contentType.join('charset=' + charset);
-                        }
-                        contentHeaders['content-type'] = contentType.join(';');
-                    }
-                    if (contentLength)
-                        contentHeaders['content-length'] = String(contentLength);
-                }
-                let s = '--' + this.boundary + CRLF;
-                for (const [k, v] of Object.entries(part.headers)) {
-                    if (!(v === '' || v == null))
-                        s += k + ': ' + (Array.isArray(v) ? v.join(';') : v) + CRLF;
-                }
-                s += CRLF;
-                if (part.content instanceof HttpRequestContent)
-                    s += (part.content.method || 'GET').toUpperCase() + ' ' + part.content.url + ' HTTP/1.1' + CRLF;
-                else
-                    s += 'HTTP/1.1 ' + part.content.status + (HttpStatusCodes[part.content.status] || 'Unknown') + CRLF;
-                if (part.content.headers) {
-                    for (const [k, v] of Object.entries(part.content.headers)) {
-                        if (v === '' || v == null)
-                            continue;
-                        if (k === 'set-cookie' && Array.isArray(v)) {
-                            v.forEach(x => s += k + ': ' + x);
-                        }
-                        else
-                            s += k + ': ' + (Array.isArray(v) ? v.join(';') : v) + CRLF;
-                    }
-                }
-                s += CRLF;
-                target.push(Buffer.from(s, 'utf-8'));
-                if (contentBody) {
-                    target.push(contentBody);
-                    target.push(Buffer.from(CRLF + CRLF));
-                }
-            }
-            else
-                throw new Error('Not implemented yet');
-        }
-        target.push(Buffer.from('--' + this.boundary + '--' + CRLF, 'utf-8'));
-    }
-}
+"use strict";
+// import Highland from 'highland';
+// import { Readable } from 'stream';
+// import { uid } from 'uid';
+// import { isReadable } from '../../helpers/index.js';
+// import { HttpHeaderCodes } from '../enums/http-headers-codes.enum.js';
+// import { HttpStatusCodes } from '../enums/http-status-codes.enum.js';
+// import { normalizeHeaders } from '../utils/normalize-headers.js';
+// import { HttpRequestContent, IHttpRequestContent } from './http-request-content.js';
+// import { HttpResponseContent, IHttpResponseContent } from './http-response-content.js';
+//
+// const CRLF = '\r\n';
+// const CHARSET_PATTERN = / *charset=./i;
+//
+// type Part = {
+//   headers: Record<string, string | string[]>;
+//   contentId?: string;
+//   content: HttpRequestContent | HttpResponseContent | BatchMultipart;
+// }
+//
+// export class BatchMultipart {
+//   protected _parts: Part[] = [];
+//   readonly boundary: string;
+//
+//   constructor() {
+//     this.boundary = 'batch_' + uid(12);
+//   }
+//
+//   addRequestPart(content: IHttpRequestContent, part?: {
+//     contentId?: string;
+//     headers?: Record<string, string | string[]>;
+//   }): this {
+//     const headers: any = {
+//       ...normalizeHeaders(part?.headers || {}, true),
+//       [HttpHeaderCodes.Content_Type]: 'application/http',
+//       [HttpHeaderCodes.Content_Transfer_Encoding]: 'binary'
+//     };
+//     if (part?.contentId)
+//       headers[HttpHeaderCodes.Content_ID] = part.contentId;
+//     this._parts.push({
+//       headers,
+//       contentId: part?.contentId,
+//       content: new HttpRequestContent(content)
+//     });
+//     return this;
+//   }
+//
+//   addHttpResponse(content: IHttpResponseContent, part?: {
+//     contentId?: string;
+//     headers?: Record<string, string | string[]>;
+//   }): this {
+//     const headers: any = {
+//       ...normalizeHeaders(part?.headers || {}, true),
+//       [HttpHeaderCodes.Content_Type]: 'application/http',
+//       [HttpHeaderCodes.Content_Transfer_Encoding]: 'binary'
+//     };
+//     if (part?.contentId)
+//       headers[HttpHeaderCodes.Content_ID] = part.contentId;
+//     this._parts.push({
+//       headers,
+//       contentId: part?.contentId,
+//       content: new HttpResponseContent(content)
+//     });
+//     return this;
+//   }
+//
+//   addBatch(batch: BatchMultipart, part?: {
+//     contentId?: string;
+//     headers?: Record<string, string | string[]>;
+//   }): this {
+//     const headers: any = {
+//       ...normalizeHeaders(part?.headers || {}, true),
+//       [HttpHeaderCodes.Content_Type]: 'application/http',
+//       [HttpHeaderCodes.Content_Transfer_Encoding]: 'binary'
+//     };
+//     if (part?.contentId)
+//       headers[HttpHeaderCodes.Content_ID] = part.contentId;
+//     this._parts.push({
+//       headers,
+//       contentId: part?.contentId,
+//       content: batch
+//     });
+//     return this;
+//   }
+//
+//   stream(): NodeJS.ReadableStream {
+//     const chunks: (Buffer | Readable)[] = [];
+//     this._build(chunks);
+//     return Highland(chunks).flatten().toNodeStream();
+//   }
+//
+//   protected _build(target: (Buffer | Readable)[]) {
+//     for (const part of this._parts) {
+//       if (part.content instanceof HttpRequestContent || part.content instanceof HttpResponseContent) {
+//         let contentBody = part.content.data;
+//         let contentLength = 0;
+//         const contentHeaders = normalizeHeaders(part.content.headers);
+//         if (contentBody) {
+//           const contentType = String(contentHeaders['content-type'] || '').split(/\s*;\s*/);
+//           let charset = '';
+//           if (isReadable(contentBody)) {
+//             contentLength = parseInt(String(contentHeaders['content-length']), 10) || 0;
+//             // const l = parseInt(String(contentHeaders['content-length']), 10);
+//             // if (isNaN(l))
+//             //   throw new TypeError('"content-length" header required for streamed responses');
+//           } else if (typeof contentBody === 'object') {
+//             if (typeof contentBody.stream === 'function') { // File and Blob
+//               contentType[0] = contentBody.type || 'binary';
+//               contentLength = contentBody.size;
+//               contentBody = contentBody.stream();
+//             } else if (Buffer.isBuffer(contentBody)) {
+//               contentHeaders['content-length'] = String(contentBody.length);
+//             } else {
+//               contentType[0] = contentType[0] || 'application/json';
+//               charset = 'utf-8';
+//               contentBody = Buffer.from(JSON.stringify(contentBody), 'utf-8');
+//               contentLength = contentBody.length;
+//             }
+//           } else {
+//             contentType[0] = contentType[0] || 'text/plain';
+//             charset = 'utf-8';
+//             contentBody = Buffer.from(String(contentBody), 'utf-8');
+//             contentLength = contentBody.length;
+//           }
+//           if (contentType[0]) {
+//             if (charset) {
+//               const i = contentType.findIndex(x => CHARSET_PATTERN.test(String(x)));
+//               if (i > 0) contentType[i] = 'charset=' + charset;
+//               else contentType.join('charset=' + charset);
+//             }
+//             contentHeaders['content-type'] = contentType.join(';');
+//           }
+//           if (contentLength)
+//             contentHeaders['content-length'] = String(contentLength);
+//         }
+//
+//         let s = '--' + this.boundary + CRLF;
+//         for (const [k, v] of Object.entries(part.headers)) {
+//           if (!(v === '' || v == null))
+//             s += k + ': ' + (Array.isArray(v) ? v.join(';') : v) + CRLF;
+//         }
+//         s += CRLF;
+//
+//         if (part.content instanceof HttpRequestContent)
+//           s += (part.content.method || 'GET').toUpperCase() + ' ' + part.content.url + ' HTTP/1.1' + CRLF;
+//         else
+//           s += 'HTTP/1.1 ' + part.content.status + (HttpStatusCodes[part.content.status] || 'Unknown') + CRLF;
+//         if (part.content.headers) {
+//           for (const [k, v] of Object.entries(part.content.headers)) {
+//             if (v === '' || v == null)
+//               continue;
+//             if (k === 'set-cookie' && Array.isArray(v)) {
+//               v.forEach(x => s += k + ': ' + x);
+//             } else
+//               s += k + ': ' + (Array.isArray(v) ? v.join(';') : v) + CRLF;
+//           }
+//         }
+//         s += CRLF;
+//         target.push(Buffer.from(s, 'utf-8'));
+//
+//         if (contentBody) {
+//           target.push(contentBody);
+//           target.push(Buffer.from(CRLF + CRLF));
+//         }
+//       } else throw new Error('Not implemented yet');
+//     }
+//     target.push(Buffer.from('--' + this.boundary + '--' + CRLF, 'utf-8'));
+//   }
+//
+// }

package/esm/http/multipart/http-request-content.js

@@ -1,8 +1,17 @@
-export class HttpRequestContent {
-    constructor(init) {
-        this.method = init.method;
-        this.url = encodeURI(decodeURI(init.url));
-        this.headers = init.headers;
-        this.data = init.data;
-    }
-}
+"use strict";
+//
+// export type IHttpRequestContent = Pick<HttpRequestContent, 'method' | 'url' | 'headers' | 'data'>;
+//
+// export class HttpRequestContent {
+//   method: string;
+//   url: string;
+//   headers?: Record<string, string | string[]>;
+//   data?: any;
+//
+//   constructor(init: IHttpRequestContent) {
+//     this.method = init.method;
+//     this.url = encodeURI(decodeURI(init.url));
+//     this.headers = init.headers;
+//     this.data = init.data;
+//   }
+// }