@webda/core 4.0.0-beta.1 → 4.0.0-beta.3

package/lib/{utils → contexts}/httpcontext.js

@@ -14,11 +14,46 @@ export const HttpMethodTypeAny = ["GET", "OPTIONS", "POST", "PUT", "PATCH", "DEL
  * @category CoreFeatures
  */
 export class HttpContext {
+    /**
+     * Hostname
+     *
+     * @example test.webda.io
+     */
+    hostname;
+    /**
+     * HTTP Method
+     */
+    method;
+    /**
+     * Pathname
+     */
+    uri;
+    /**
+     * Get the client ip if available
+     */
+    clientIp;
+    path;
+    search;
+    protocol;
+    port;
+    headers;
+    origin;
+    host;
+    body;
+    cookies;
+    /**
+     * URI prefix in case it is exposed through something that prefix the uri
+     */
+    prefix = "";
+    /** Create a new HttpContext
+     * @param hostname - the request hostname
+     * @param method - the HTTP method
+     * @param uri - the request URI
+     * @param protocol - the protocol
+     * @param port - the port number
+     * @param headers - the request headers
+     */
     constructor(hostname, method, uri, protocol = "http", port = "80", headers = {}) {
-        /**
-         * URI prefix in case it is exposed through something that prefix the uri
-         */
-        this.prefix = "";
         this.hostname = hostname;
         this.method = method;
         this.uri = uri;
@@ -33,7 +68,7 @@ export class HttpContext {
         this.protocol = protocol + ":";
         this.port = port.toString();
         this.headers = {};
-        for (let i in headers) {
+        for (const i in headers) {
             if (i.toLowerCase() === "cookie") {
                 this.cookies = Array.isArray(headers[i])
                     ? headers[i].map(c => cookieParse(c))
@@ -54,6 +89,8 @@ export class HttpContext {
     }
     /**
      * Set the client ip
+     * @param ip - the IP address
+     * @returns this for chaining
      */
     setClientIp(ip) {
         this.clientIp = ip;
@@ -61,6 +98,7 @@ export class HttpContext {
     }
     /**
      * Get the client ip
+     * @returns the result string
      */
     getClientIp() {
         return this.clientIp;
@@ -68,7 +106,7 @@ export class HttpContext {
     /**
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/href
-     * @returns
+     * @returns the result string
      */
     getHref() {
         return this.getAbsoluteUrl();
@@ -85,20 +123,33 @@ export class HttpContext {
     }
     /**
      * Return Uri without prefix
+     *
+     * The prefix is only removed on a path boundary, so prefix `/prod` does not strip `/production`
+     * @returns the result string
      */
     getRelativeUri() {
-        return this.uri.substring(this.prefix.length);
+        if (!this.prefix || !this.uri.startsWith(this.prefix)) {
+            return this.uri;
+        }
+        const relative = this.uri.substring(this.prefix.length);
+        if (relative === "" || relative.startsWith("?")) {
+            return "/" + relative;
+        }
+        if (!relative.startsWith("/")) {
+            return this.uri;
+        }
+        return relative;
     }
     /**
      * Get full URI
-     * @returns
+     * @returns the result string
      */
     getUrl() {
         return this.uri;
     }
     /**
      * Get cookies
-     * @returns
+     * @returns the result
      */
     getCookies() {
         return this.cookies;
@@ -107,12 +158,14 @@ export class HttpContext {
      * Get port number as string
      *
      * If http on port 80, or https on port 443 will return ""
+     * @returns the result string
      */
     getPort() {
         return this.port;
     }
     /**
      * Get the port number
+     * @returns the result number
      */
     getPortNumber() {
         if (this.port) {
@@ -127,35 +180,35 @@ export class HttpContext {
     }
     /**
      * Return hostname and port
-     * @returns
+     * @returns the result string
      */
     getHost() {
         return this.host;
     }
     /**
      * Return protocol, hostname and port
-     * @returns
+     * @returns the result string
      */
     getOrigin() {
         return this.origin;
     }
     /**
      * Get the hostname
-     * @returns
+     * @returns the result string
      */
     getHostName() {
         return this.hostname;
     }
     /**
      * Get HTTP Method used
-     * @returns
+     * @returns the result
      */
     getMethod() {
         return this.method;
     }
     /**
      * Get protocol used
-     * @returns
+     * @returns the result
      */
     getProtocol() {
         return this.protocol;
@@ -166,12 +219,12 @@ export class HttpContext {
      * @param limit the size of readable request
      * @param timeout the time to read the request
      * @param encoding to analyze
-     * @returns
+     * @returns the result
      */
     async getRawBodyAsString(limit = 1024 * 1024 * 10, timeout = 60000, encoding) {
         // Get charset from header
         if (!encoding) {
-            let match = this.getUniqueHeader("content-type", "charset=utf-8").match(/charset=([^;\s]+)/);
+            const match = this.getUniqueHeader("content-type", "charset=utf-8").match(/charset=([^;\s]+)/);
             if (match) {
                 encoding = match[1].trim();
             }
@@ -189,18 +242,18 @@ export class HttpContext {
      *
      * @param limit the size of readable request
      * @param timeout the time to read the request
-     * @returns
+     * @returns the result
      */
     async getRawBody(limit = 1024 * 1024 * 10, timeout = 60000) {
         if (this.body instanceof Readable) {
             return new Promise((resolve, reject) => {
-                let req = this.body;
-                let body = [];
-                let timeoutId = setTimeout(() => {
+                const req = this.body;
+                const body = [];
+                const timeoutId = setTimeout(() => {
                     reject("Request timeout");
                 }, timeout);
                 req.on("readable", () => {
-                    let chunk = req.read();
+                    const chunk = req.read();
                     if (chunk !== null) {
                         if (chunk.length + body.length > limit) {
                             clearTimeout(timeoutId);
@@ -223,6 +276,7 @@ export class HttpContext {
     }
     /**
      * Get the body as stream
+     * @returns the result
      */
     getRawStream() {
         if (this.body instanceof Readable) {
@@ -232,25 +286,28 @@ export class HttpContext {
     }
     /**
      * Get HTTP Headers
-     * @returns
+     * @returns the result
      */
     getHeaders() {
         return this.headers;
     }
     /**
      * Get header value
-     * @param name
-     * @param def
-     * @returns
+     * @param name - the name to use
+     * @param def - the default value
+     * @returns the list of results
      */
     getHeader(name, def) {
         return this.headers[name.toLowerCase()] || def;
     }
     /**
      * Return the last header found with that name
+     * @param name - the name to use
+     * @param def - the default value
+     * @returns the result string
      */
     getUniqueHeader(name, def) {
-        let header = this.getHeader(name, def);
+        const header = this.getHeader(name, def);
         if (Array.isArray(header)) {
             return header.pop() || def;
         }
@@ -258,7 +315,8 @@ export class HttpContext {
     }
     /**
      * Used for test
-     * @param body
+     * @param body - the request body
+     * @returns this for chaining
      */
     setBody(body) {
         if (body instanceof Readable || body instanceof Buffer) {
@@ -279,7 +337,7 @@ export class HttpContext {
      * Get request path name
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname
-     * @returns
+     * @returns the result
      */
     getPathName() {
         return this.path;
@@ -288,21 +346,31 @@ export class HttpContext {
      * Get search section
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/search
-     * @returns
+     * @returns the result
      */
     getSearch() {
         return this.search;
     }
     /**
+     * Return the absolute url of the request, or of an application uri
+     *
+     * An application uri is relative to the prefix, so the prefix is added to it
      *
-     * @param uri to return absolute url from
+     * @param uri to return absolute url from, the request uri by default
+     * @returns the result string
      */
-    getAbsoluteUrl(uri = this.uri) {
-        if (uri.match(/^\w{1,10}:\/\//)) {
+    getAbsoluteUrl(uri) {
+        if (uri === undefined) {
+            uri = this.uri;
+        }
+        else if (uri.match(/^\w{1,10}:\/\//)) {
             return uri;
         }
-        if (!uri.startsWith("/")) {
-            uri = "/" + uri;
+        else {
+            if (!uri.startsWith("/")) {
+                uri = "/" + uri;
+            }
+            uri = this.prefix + uri;
         }
         if (this.port) {
             return `${this.protocol}//${this.hostname}:${this.port}${uri}`;

package/lib/contexts/httpcontext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpcontext.js","sourceRoot":"","sources":["../../src/contexts/httpcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGlC;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AAOxG;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAW;IACtB;;;;OAIG;IACH,QAAQ,CAAS;IACjB;;OAEG;IACH,MAAM,CAAiB;IACvB;;OAEG;IACH,GAAG,CAAS;IACZ;;OAEG;IACH,QAAQ,CAAS;IACjB,IAAI,CAAS;IACb,MAAM,CAAS;IACf,QAAQ,CAAqB;IAC7B,IAAI,CAAS;IACb,OAAO,CAAiB;IACxB,MAAM,CAAS;IACf,IAAI,CAAS;IACb,IAAI,CAAgC;IACpC,OAAO,CAAM;IAEb;;OAEG;IACH,MAAM,GAAW,EAAE,CAAC;IAEpB;;;;;;;OAOG;IACH,YACE,QAAgB,EAChB,MAAsB,EACtB,GAAW,EACX,QAAQ,GAAqB,MAAM,EACnC,IAAI,GAAoB,IAAI,EAC5B,OAAO,GAAyC,EAAE;QAElD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACnB,CAAC;QACD,aAAa;QACb,IAAI,CAAC,QAAQ,GAAY,QAAQ,GAAG,GAAG,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,QAAQ,EAAE,CAAC;gBACjC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBACtC,CAAC,CAAY,OAAO,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;oBACjD,CAAC,CAAC,WAAW,CAAS,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,IACE,IAAI,KAAK,SAAS;YAClB,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,QAAQ,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,QAAQ,KAAK,OAAO,CAAC,CAAC,EAC9F,CAAC;YACD,OAAO,GAAG,GAAG,GAAG,IAAI,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACjB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC7D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,EAAU;QACpB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAc;QACtB,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAClD,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,cAAc;QACZ,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtD,OAAO,IAAI,CAAC,GAAG,CAAC;QAClB,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,QAAQ,KAAK,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,OAAO,GAAG,GAAG,QAAQ,CAAC;QACxB,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,GAAG,CAAC;QAClB,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC/B,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAK,GAAW,IAAI,GAAG,IAAI,GAAG,EAAE,EAAE,OAAO,GAAW,KAAK,EAAE,QAAiB;QACnG,0BAA0B;QAC1B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;YAC/F,IAAI,KAAK,EAAE,CAAC;gBACV,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,QAAQ,GAAG,OAAO,CAAC;YACrB,CAAC;QACH,CAAC;QACD,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QACD,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAiB,QAAQ,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,KAAK,GAAW,IAAI,GAAG,IAAI,GAAG,EAAE,EAAE,OAAO,GAAW,KAAK;QACxE,IAAI,IAAI,CAAC,IAAI,YAAY,QAAQ,EAAE,CAAC;YAClC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACrC,MAAM,GAAG,GAAa,IAAI,CAAC,IAAI,CAAC;gBAChC,MAAM,IAAI,GAAG,EAAE,CAAC;gBAChB,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;oBAChC,MAAM,CAAC,iBAAiB,CAAC,CAAC;gBAC5B,CAAC,EAAE,OAAO,CAAC,CAAC;gBACZ,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE;oBACtB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;oBACzB,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;wBACnB,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;4BACvC,YAAY,CAAC,SAAS,CAAC,CAAC;4BACxB,MAAM,CAAC,mBAAmB,CAAC,CAAC;wBAC9B,CAAC;wBACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC,CAAC,CAAC;gBACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACjB,YAAY,CAAC,SAAS,CAAC,CAAC;oBACxB,sDAAsD;oBACtD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;oBAChC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,IAAI,IAAI,CAAC,IAAI,YAAY,QAAQ,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,IAAY,EAAE,GAAY;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,GAAG,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,IAAY,EAAE,GAAY;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACzC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,CAAC;QAC7B,CAAC;QACD,OAAO,MAAM,IAAI,GAAG,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAsC;QAC5C,IAAI,IAAI,YAAY,QAAQ,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;YACvD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACnB,CAAC;aAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACH,WAAW;QACT,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,GAAY;QACzB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACtB,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACjB,CAAC;aAAM,IAAI,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACvC,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACzB,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;YAClB,CAAC;YACD,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;QAC1B,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,OAAO,GAAG,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC;QACjE,CAAC;QACD,OAAO,GAAG,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC;IACpD,CAAC;CACF"}

package/lib/contexts/icontext.d.ts

@@ -0,0 +1,236 @@
+import { Writable } from "node:stream";
+import { HttpContext } from "./httpcontext.js";
+import { PipelineOptions } from "node:stream/promises";
+/**
+ * Context is the object that will be passed to the services
+ */
+export declare abstract class Context {
+    /**
+     * Get the session linked to the context if exists
+     */
+    abstract getSession(): any;
+    /**
+     * Get the caches linked to the context
+     */
+    caches: any;
+    /**
+     * Allow extensions
+     */
+    protected extensions: {
+        [key: string]: any;
+    };
+    /**
+     * Store response headers
+     */
+    private responseHeaders;
+    /**
+     * Contain all registered promises to this context
+     */
+    _promises: Promise<any>[];
+    /**
+     * If the headers were flushed
+     */
+    protected flushed: boolean;
+    /**
+     * Whether this is the global (non-request-scoped) context
+     * @returns true if the condition is met
+     */
+    isGlobalContext(): boolean;
+    /**
+     * Get current user id
+     */
+    abstract getCurrentUserId(): string | "system" | undefined;
+    /**
+     * Register a promise with the context
+     * @param promise - the promise to add
+     */
+    registerPromise(promise: any): void;
+    /**
+     * Get an extension of the context
+     * @param name of the extension
+     * @returns extension object
+     */
+    getExtension<K = any>(name: string): K;
+    /**
+     *
+     * @param name to add
+     * @param extension object to store
+     * @returns this for chaining
+     */
+    setExtension(name: string, extension: any): this;
+    /**
+     * Ensure the whole execution is finished
+     */
+    end(): Promise<void>;
+    /**
+     * Return the user
+     *
+     * This method is not typed to avoid circular dependencies
+     * @returns
+     */
+    abstract getCurrentUser(): Promise<any | undefined>;
+    /**
+     * Can be used to init the context if needed
+     * Reading from the input or reaching to a db
+     * @returns this for chaining
+     */
+    init(): Promise<this>;
+    /**
+     * Set a header in the response
+     * @param name - the name to use
+     * @param value - the value to set
+     */
+    setHeader(name: string, value: string | number | string[]): void;
+    /**
+     * For easier compatibility with WebContext
+     * On OperationContext this call is simply ignored
+     * @param _code - the status code
+     */
+    writeHead(_code: number, headers: {
+        [key: string]: string | number | string[];
+    }): void;
+    /**
+     * Get current response headers
+     * @returns the result
+     */
+    getResponseHeaders(): any;
+    /**
+     * Send the headers to the client
+     */
+    flushHeaders(): Promise<void>;
+    /**
+     * Pipeline streams into the output stream
+     *
+     * @see https://nodejs.org/api/stream.html#streampipelinestreams-options
+     * @param stream1 - the first stream
+     * @param streams - additional streams
+     */
+    pipeline(stream1: NodeJS.ReadableStream, ...streams: Array<NodeJS.ReadWriteStream | PipelineOptions>): Promise<void>;
+    abstract getOutputStream(): Promise<Writable>;
+}
+/** Abstract context for an operation, providing access to input, parameters, output, and session */
+export declare abstract class IOperationContext<Input = any, Parameters = any, Output = any> extends Context {
+    /**
+     * Get the input of the context
+     */
+    abstract getInput(): Promise<Input>;
+    /**
+     * Get the raw input of the context
+     */
+    abstract getRawInput(limit?: number): Promise<any>;
+    /**
+     * Read one specific parameter
+     * @param name - the name to use
+     * @returns the result
+     * @param defaultValue - the default value
+     * @deprecated Use getParameters
+     */
+    parameter(name: string, defaultValue?: any): any;
+    abstract clearInput(): void;
+    /**
+     * Get the parameters of the context
+     */
+    abstract getParameters(): Parameters;
+    /**
+     * Write the output of the context
+     * @param _data
+     * @returns
+     */
+    abstract write(_data: Output): boolean;
+    abstract setSession(session: any): void;
+    /**
+     * Create a new session
+     *
+     * Logout the current user
+     */
+    abstract newSession(): any;
+}
+/**
+ * Data provided by the context
+ */
+export interface ContextProviderInfo {
+    /**
+     * Stream to write to
+     */
+    stream?: Writable;
+    /**
+     * If this is http context
+     */
+    http?: HttpContext;
+    /**
+     * true if this is a global context
+     */
+    global?: boolean;
+    /**
+     * Can contain any type of information
+     */
+    [key: string]: any;
+}
+/**
+ * @category CoreFeatures
+ */
+export interface ContextProvider {
+    /**
+     * Info can contain any type of information
+     * @param info
+     */
+    getContext(info: ContextProviderInfo): Context;
+}
+/**
+ * Context aware interface
+ *
+ * An object that is aware of the context
+ * It should allow to set the context only if `canUpdateContext` is true
+ */
+export interface IContextAware {
+    context: Context;
+}
+/**
+ * Set the context update
+ * @param value - the value to set
+ */
+export declare function setContextUpdate(value: boolean): void;
+/**
+ * Who can update the context
+ * @returns true if the condition is met
+ */
+export declare function canUpdateContext(): boolean;
+/**
+ * Represent a context from the web
+ * It also fit the express response object
+ */
+export type IWebContext = IOperationContext & {
+    setParameters: (params: object) => void;
+    /**
+     * Get the http context
+     * @returns
+     */
+    getHttpContext: () => HttpContext;
+    /**
+     * Set a cookie in the browser
+     * @param name
+     * @param value
+     * @param params
+     * @returns
+     */
+    cookie: (name: string, value: string, params: any) => void;
+    /**
+     * Get the status code for the response
+     */
+    statusCode: number;
+    /**
+     * Redirect the user to another page
+     */
+    redirect: (url: string) => void;
+    /**
+     * Send the header response to the user
+     */
+    writeHead: (statusCode: number, headers: any) => void;
+};
+/**
+ * Return the gather information from the repository
+ * @param obj - the target object
+ * @returns the result
+ */
+export declare function isWebContext(obj: any): obj is IWebContext;
+//# sourceMappingURL=icontext.d.ts.map

package/lib/contexts/icontext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icontext.d.ts","sourceRoot":"","sources":["../../src/contexts/icontext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EAAY,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEjE;;GAEG;AACH,8BAAsB,OAAO;IAC3B;;OAEG;IACH,QAAQ,CAAC,UAAU,IAAI,GAAG,CAAC;IAC3B;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC;IACZ;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE7C;;OAEG;IACH,OAAO,CAAC,eAAe,CAAM;IAC7B;;OAEG;IAEH,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO,CAAS;IAEnC;;;OAGG;IACH,eAAe,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,QAAQ,CAAC,gBAAgB,IAAI,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE3D;;;OAGG;IACH,eAAe,CAAC,OAAO,KAAA,QAEtB;IACD;;;;OAIG;IACI,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAE5C;IACD;;;;;OAKG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,GAAG,IAAI,CAGtD;IACD;;OAEG;IACG,GAAG,kBAGR;IACD;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IACpD;;;;OAIG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IACD;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,QAKxD;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,QAK9E;IAED;;;OAGG;IACH,kBAAkB,IAAI,GAAG,CAExB;IAED;;OAEG;IACG,YAAY,kBAMjB;IAED;;;;;;OAMG;IACG,QAAQ,CACZ,OAAO,EAAE,MAAM,CAAC,cAAc,EAC9B,GAAG,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,eAAe,GAAG,eAAe,CAAC,GAC1D,OAAO,CAAC,IAAI,CAAC,CAuBf;IAED,QAAQ,CAAC,eAAe,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC/C;AAED,oGAAoG;AACpG,8BAAsB,iBAAiB,CAAC,KAAK,GAAG,GAAG,EAAE,UAAU,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,CAAE,SAAQ,OAAO;IAClG;;OAEG;IACH,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,GAAG,GAAG,CAE/C;IAED,QAAQ,CAAC,UAAU,IAAI,IAAI,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,aAAa,IAAI,UAAU,CAAC;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IAEvC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,IAAI,GAAG,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;CAClB;AAOD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,QAE9C;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAE1C;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,iBAAiB,GAAG;IAC5C,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC;;;OAGG;IACH,cAAc,EAAE,MAAM,WAAW,CAAC;IAClC;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,IAAI,CAAC;IAC3D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC;;OAEG;IACH,SAAS,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,IAAI,CAAC;CACvD,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,WAAW,CAEzD"}