@villedemontreal/http-request 7.4.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Ville de Montréal and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,216 @@
+# @villedemontreal/http-request
+
+Utilitaires pour requêtes HTTP. Fourni principalement une fonction permettant de faire
+des requêtes HTTP de manière à ce que les bons Correlation Ids soient envoyés.
+
+## Configuration
+
+Avant d'utiliser la fonction `httpUtils.send()`, il faut avoir correctement configuré la librairie.
+
+La librarie a présentement besoin de deux configurations :
+
+- Un "`Logger Creator`", qui est une fonction passée par le code appelant et servant à créer des Loggers
+  configurés correctement.
+- Un "`Correlation Id provider`". Ceci est requis car la librairie doit avoir accès
+  aux bons Correlation Ids à ajouter aux requêtes effectuées.
+
+Voici un exemple de code configurant la librairie, ici dans un projet démarré à l'aide du gabarit
+[generator-mtl-node-api].
+
+Dans le fichier "`src/init.ts`" du projet de l'API :
+
+```typescript
+import { init as initHttpUtils } from '@villedemontreal/http-request';
+import { createLogger } from './utils/logger';
+import { correlationIdService } from '@villedemontreal/correlation-id';
+import { configs } from '../config/configs';
+
+//...
+
+export async function initComponents() {
+  initHttpUtils(
+    createLogger,
+    () => {
+      return correlationIdService.getId();
+    },
+    config.routing.caseSensitive // required since 7.0.0
+  );
+
+  //...
+}
+```
+
+Notez que si vous configurez la librairie depuis _une autre librairie_, vous aurez probablement à passer
+le "`Logger Creator`", le "`Correlation Id provider`" et le "`caseSensitive`" que vous aurez _vous-même_ reçus
+comme configurations! Le but étant que toutes les librairies utilisées dans un projet d'API, ainsi que leurs
+propres librairies transitives, puissent logger de la même manière, aient accès aux bons Correlation Ids et
+parsent les URLs de la même manière.
+
+Finalement, notez qu'une fonction "`isInited()`" est exportée et permet au code appelant de valider que la librairie a été
+configurée correctement.
+
+## Utilisation
+
+### Effectuer une requête HTTP
+
+Il s'agit de créer un objet "SuperAgentRequest" en utilisant [SuperAgent](http://visionmedia.github.io/superagent/), et de passer
+cet objet à la fonction "`send(...)`" fournie ici. Il ne faut _pas_ awaiter l'objet "SuperAgentRequest" lui-même, mais plutôt
+l'appel à la fonction "`send(...)`"! Par exemple :
+
+```typescript
+import * as superagent from 'superagent';
+
+//...
+
+// Création de l'object requête
+// (pas de "await" ici!)
+let request = superagent
+  .get('https://some.url')
+  .set('someCustomHeader', '123')
+  .accept('application/json');
+
+// Utilisation de httpUtils pour lancer la requête.
+// Le bon Correlation Id sera automatiquement ajouté.
+// Ne pas oublier le "await"!
+try {
+  let response = await httpUtils.send(request);
+
+  // Gestion des erreurs 4XX-5XX...
+  if (!response.ok) {
+    let status = response.status;
+    //...
+  }
+  //...
+} catch (err) {
+  // Ici une erreur réseau s'est produite ou le serveur
+  // demandé n'a pas été trouvé...
+}
+```
+
+#### Gestion des erreurs
+
+**Note importante** : la méthode `httpUtils.send(...)` gère les erreurs différement de la manière dont elles le sont
+par défaut par SuperAgent! En effet, SuperAgent va _thrower_ une erreur lorsqu'une réponse avec status 4XX-5XX est retournée.
+La méthode `httpUtils.send(...)`, au contraire, va _retourner ces réponses de manière régulière_ et c'est au code appelant
+de valider le status HTTP (ou d'utiliser _`if (response.ok)`_). Le but est d'être en mesure de différencier entre une "erreur"
+4XX-5XX et une _vraie_ erreur, par exemple lorsque la requête ne peut être effectuée car il y a un problème de réseau, ou lorsque
+le host visé n'est pas trouvé.
+
+Bref, il faut savoir qu'en utilisant `httpUtils.send(...)`, une erreur comme un "`Not Found`" (`404`) ne throwera **pas** d'erreur,
+et c'est à vous à valider le status retourné...
+
+### Autres utilitaires
+
+#### getQueryParamAll
+
+Retourne tous les paramètres de la _querystring_ d'un object `express.Request` spécifié.
+
+Cette fonction tient compte de la configuration `urlCaseSensitive` ayant été utilisée lors
+de l'initialisation de la librairie.
+
+#### getQueryParamOne
+
+Retourne un paramètre de la _querystring_ d'un object `express.Request` spécifié. Si
+plusieures valeurs pour ce paramètre sont trouvées, la function retourne _la dernière trouvée_.
+
+Cette fonction tient compte de la configuration `urlCaseSensitive` ayant été utilisée lors
+de l'initialisation de la librairie.
+
+#### getQueryParamOneAsDate
+
+Retourne un paramètre de la _querystring_ d'un object `express.Request` spécifié, en tant
+que `Date`. Si plusieures valeurs pour ce paramètre sont trouvées, la function retourne _la dernière trouvée_.
+
+Si le paramètre est trouvé mais sa valeur ne peut être convertie en `Date` valide (en utilisant `new Date(xxx)`),
+par défaut une `Error` est lancée. Mais si un `errorHandler` est passé en option, ce handler
+sera appellé à la place. Dans une API basée sur `@villemontreal/generator-mtl-node-api`, ceci
+vous permet de lancer une erreur custom, en utilisant par exemple `throw createInvalidParameterError(xxx)`.
+
+Il est recommandé de toujours utiliser le format `ISO 8601` pour les dates.
+
+Cette fonction tient compte de la configuration `urlCaseSensitive` ayant été utilisée lors
+de l'initialisation de la librairie.
+
+#### getQueryParamOneAsNumber
+
+Retourne un paramètre de la _querystring_ d'un object `express.Request` spécifié, en tant
+que `Number`. Si plusieures valeurs pour ce paramètre sont trouvées, la function retourne _la dernière trouvée_.
+
+Si le paramètre est trouvé mais sa valeur ne peut être convertie en `Number` valide (en utilisant `Number(xxx)`),
+par défaut une `Error` est lancée. Mais si un `errorHandler` est passé en option, ce handler
+sera appellé à la place. Dans une API basée sur `@villemontreal/generator-mtl-node-api`, ceci
+vous permet de lancer une erreur custom, en utilisant par exemple `throw createInvalidParameterError(xxx)`.
+
+Cette fonction tient compte de la configuration `urlCaseSensitive` ayant été utilisée lors
+de l'initialisation de la librairie.
+
+#### getOrderBys
+
+Retourne les `IOrderBy` spécifiés dans la querystring d'une requête de recherche.
+
+
+#### urlJoin
+
+Util to join part of url:
+
+```typescript
+import { httpUtils } from '@villedemontreal/http-request';
+
+// To join multiple part of uri:
+let url: string = httpUtils.urlJoin('http://api.montreal.ca/accounts/', '/inum', '@5441521452', 'tickets');
+console.log(url); // http://api.montreal.ca/accounts/inum/@5441521452/tickets
+```
+
+#### buildUriObject
+
+Util to parse an url and get the different parts:
+
+```typescript
+import { httpUtils } from '@villedemontreal/http-request';
+
+let url: string = httpUtils.buildUriObject('http://api.montreal.ca/accounts/inum/@5441521452/tickets');
+console.log(url); // {"uri": "http://api.montreal.ca/accounts/inum/@5441521452/tickets", "baseUri":"http://api.montreal.ca", "path":"/accounts/inum/@5441521452/tickets"}
+```
+
+# Builder le projet
+
+**Note**: Sur Linux/Mac assurz-vous que le fichier `run` est exécutable. Autrement, lancez `chmod +x ./run`.
+
+Pour lancer le build :
+
+- > `run compile` ou `./run compile` (sur Linux/Mac)
+
+Pour lancer les tests :
+
+- > `run test` ou `./run test` (sur Linux/Mac)
+
+# Mode Watch
+
+Lors du développement, il est possible de lancer `run watch` (ou `./run watch` sur Linux/mac) dans un terminal
+externe pour démarrer la compilation incrémentale. Il est alors possible de lancer certaines _launch configuration_
+comme `Debug current tests file - fast` dans VsCode et ainsi déboguer le fichier de tests présentement ouvert sans
+avoir à (re)compiler au préalable (la compilation incrémentale s'en sera chargé).
+
+Notez que, par défaut, des _notifications desktop_ sont activées pour indiquer visuellement si la compilation
+incrémentale est un succès ou si une erreur a été trouvée. Vous pouvez désactiver ces notifications en utilisant
+`run watch --dn` (`d`isable `n`otifications).
+
+# Déboguer le projet
+
+Trois "_launch configurations_" sont founies pour déboguer le projet dans VSCode :
+
+- "`Debug all tests`", la launch configuration par défaut. Lance les tests en mode debug. Vous pouvez mettre
+  des breakpoints et ils seront respectés.
+
+- "`Debug a test file`". Lance _un_ fichier de tests en mode debug. Vous pouvez mettre
+  des breakpoints et ils seront respectés. Pour changer le fichier de tests à être exécuté, vous devez modifier la ligne appropriée dans le fichier "`.vscode/launch.json`".
+
+- "`Debug current tests file`". Lance le fichier de tests _présentement ouvert_ dans VSCode en mode debug. Effectue la compîlation au préalable.
+
+- "`Debug current tests file - fast`". Lance le fichier de tests _présentement ouvert_ dans VSCode en mode debug. Aucune compilation
+  n'est effectuée au préalable. Cette launch configuration doit être utilisée lorsque la compilation incrémentale roule (voir la section "`Mode Watch`" plus haut)
+
+
+# Aide / Contributions
+
+Notez que les contributions sous forme de pull requests sont bienvenues.

package/dist/src/config/configs.d.ts

@@ -0,0 +1,38 @@
+import { ILogger } from '@villedemontreal/logger';
+/**
+ * Http Client Config
+ */
+export declare class Configs {
+    private _correlationIdProvider;
+    private _loggerCreator;
+    private _urlCaseSensitive;
+    /**
+     * Sets the Logger creator.
+     */
+    setLoggerCreator(loggerCreator: (name: string) => ILogger): void;
+    /**
+     * The Logger creator
+     */
+    get loggerCreator(): (name: string) => ILogger;
+    /**
+     * Sets the Correlation Id provider.
+     */
+    setCorrelationIdProvider(correlationIdProvider: () => string): void;
+    /**
+     * The Correlation Id provider
+     */
+    get correlationIdProvider(): () => string;
+    /**
+     * The current Correlation Id.
+     */
+    get correlationId(): string;
+    /**
+     * Sets the case sensitivity to use for the URLs.
+     */
+    setUrlCaseSensitive(urlCaseSensitive: boolean): void;
+    /**
+     * Routing info
+     */
+    get isUrlCaseSensitive(): boolean;
+}
+export declare let configs: Configs;

package/dist/src/config/configs.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configs = exports.Configs = void 0;
+const _ = require("lodash");
+/**
+ * Http Client Config
+ */
+class Configs {
+    /**
+     * Sets the Logger creator.
+     */
+    setLoggerCreator(loggerCreator) {
+        this._loggerCreator = loggerCreator;
+    }
+    /**
+     * The Logger creator
+     */
+    get loggerCreator() {
+        if (!this._loggerCreator) {
+            throw new Error(`The Logger Creator HAS to be set as a configuration! Please call the init(...) function first.`);
+        }
+        return this._loggerCreator;
+    }
+    /**
+     * Sets the Correlation Id provider.
+     */
+    setCorrelationIdProvider(correlationIdProvider) {
+        this._correlationIdProvider = correlationIdProvider;
+    }
+    /**
+     * The Correlation Id provider
+     */
+    get correlationIdProvider() {
+        if (!this._correlationIdProvider) {
+            throw new Error(`The Correlation Id provider HAS to be set as a configuration! Please call the init(...) function first.`);
+        }
+        return this._correlationIdProvider;
+    }
+    /**
+     * The current Correlation Id.
+     */
+    get correlationId() {
+        return this.correlationIdProvider();
+    }
+    /**
+     * Sets the case sensitivity to use for the URLs.
+     */
+    setUrlCaseSensitive(urlCaseSensitive) {
+        this._urlCaseSensitive = urlCaseSensitive;
+    }
+    /**
+     * Routing info
+     */
+    get isUrlCaseSensitive() {
+        if (_.isNil(this._urlCaseSensitive)) {
+            throw new Error(`The Case Sensitivity to use for the URLs HAS to be set as a configuration! Please call the init(...) function first.`);
+        }
+        return this._urlCaseSensitive;
+    }
+}
+exports.Configs = Configs;
+exports.configs = new Configs();
+//# sourceMappingURL=configs.js.map

package/dist/src/config/configs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configs.js","sourceRoot":"","sources":["../../../src/config/configs.ts"],"names":[],"mappings":";;;AACA,4BAA4B;AAE5B;;GAEG;AACH,MAAa,OAAO;IAKlB;;OAEG;IACI,gBAAgB,CAAC,aAAwC;QAC9D,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACxB,MAAM,IAAI,KAAK,CAAC,gGAAgG,CAAC,CAAC;SACnH;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,qBAAmC;QACjE,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,IAAI,qBAAqB;QACvB,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAChC,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;SACH;QACD,OAAO,IAAI,CAAC,sBAAsB,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,gBAAyB;QAClD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QACpB,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE;YACnC,MAAM,IAAI,KAAK,CACb,sHAAsH,CACvH,CAAC;SACH;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;CACF;AAlED,0BAkEC;AACU,QAAA,OAAO,GAAY,IAAI,OAAO,EAAE,CAAC"}

package/dist/src/config/constants.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Library constants
+ */
+export declare class Constants {
+    /**
+     * The library root. When this library is used
+     * as a dependency in a project, the "libRoot"
+     * will be the path to the dependency folder,
+     * inside the "node_modules".
+     */
+    libRoot: string;
+    /**
+     * The app root. When this library is used
+     * as a dependency in a project, the "appRoot"
+     * will be the path to the root project!
+     */
+    appRoot: string;
+    constructor();
+    /**
+     * Requests constants
+     */
+    get request(): {
+        /**
+         * Default timeout constants
+         */
+        timeoutsDefault: {
+            /**
+             * The default number of milliseconds to wait
+             * for the server to start sending data.
+             */
+            response: number;
+            /**
+             * The default number of milliseconds to wait
+             * for the data to finish loading.
+             */
+            deadline: number;
+        };
+    };
+}
+export declare let constants: Constants;

package/dist/src/config/constants.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constants = exports.Constants = void 0;
+const app_root_path_1 = require("app-root-path");
+const path = require("path");
+/**
+ * Library constants
+ */
+class Constants {
+    constructor() {
+        // From the "dist/src/config" folder
+        this.libRoot = path.normalize(__dirname + '/../../..');
+        this.appRoot = app_root_path_1.path;
+    }
+    /**
+     * Requests constants
+     */
+    get request() {
+        return {
+            /**
+             * Default timeout constants
+             */
+            timeoutsDefault: {
+                /**
+                 * The default number of milliseconds to wait
+                 * for the server to start sending data.
+                 */
+                response: 30000,
+                /**
+                 * The default number of milliseconds to wait
+                 * for the data to finish loading.
+                 */
+                deadline: 60000
+            }
+        };
+    }
+}
+exports.Constants = Constants;
+exports.constants = new Constants();
+//# sourceMappingURL=constants.js.map

package/dist/src/config/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/config/constants.ts"],"names":[],"mappings":";;;AAAA,iDAAgD;AAChD,6BAA6B;AAE7B;;GAEG;AACH,MAAa,SAAS;IAgBpB;QACE,oCAAoC;QACpC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,WAAW,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,oBAAO,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO;YACL;;eAEG;YACH,eAAe,EAAE;gBACf;;;mBAGG;gBACH,QAAQ,EAAE,KAAK;gBAEf;;;mBAGG;gBACH,QAAQ,EAAE,KAAK;aAChB;SACF,CAAC;IACJ,CAAC;CACF;AA7CD,8BA6CC;AAEU,QAAA,SAAS,GAAc,IAAI,SAAS,EAAE,CAAC"}

package/dist/src/config/init.d.ts

@@ -0,0 +1,22 @@
+import { ILogger } from '@villedemontreal/logger';
+/**
+ * Inits the library.
+ */
+export declare function init(loggerCreator: (name: string) => ILogger, correlationIdProvider: () => string, 
+/**
+ * The case sensitivity to use for the URLs.
+ *
+ * In an API based on "@villemontreal/generator-mtl-node-api",
+ * you need to pass `configs.routing.caseSensitive` here!
+ */
+urlCaseSensitive: boolean): void;
+/**
+ * Is the library properly initialized?
+ *
+ * This function MUST be named "isInited()"!
+ * Code using this library may loop over all its "@villemontreal"
+ * dependencies and, if one of those exports a "isInited" fonction,
+ * it will enforce that the lib has been properly initialized before
+ * starting...
+ */
+export declare function isInited(): boolean;

package/dist/src/config/init.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isInited = exports.init = void 0;
+const _ = require("lodash");
+const configs_1 = require("./configs");
+let libIsInited = false;
+/**
+ * Inits the library.
+ */
+function init(loggerCreator, correlationIdProvider, 
+/**
+ * The case sensitivity to use for the URLs.
+ *
+ * In an API based on "@villemontreal/generator-mtl-node-api",
+ * you need to pass `configs.routing.caseSensitive` here!
+ */
+urlCaseSensitive) {
+    if (!loggerCreator) {
+        throw new Error(`The Logger Creator is required.`);
+    }
+    if (!correlationIdProvider) {
+        throw new Error(`The Correlation Id provider is required.`);
+    }
+    if (_.isNil(urlCaseSensitive)) {
+        throw new Error(`The Case Sensitivity to use for the URLs is required.`);
+    }
+    configs_1.configs.setLoggerCreator(loggerCreator);
+    configs_1.configs.setCorrelationIdProvider(correlationIdProvider);
+    configs_1.configs.setUrlCaseSensitive(urlCaseSensitive);
+    // ==========================================
+    // Set as being "properly initialized".
+    // At the very end of the "init()" function!
+    // ==========================================
+    libIsInited = true;
+}
+exports.init = init;
+/**
+ * Is the library properly initialized?
+ *
+ * This function MUST be named "isInited()"!
+ * Code using this library may loop over all its "@villemontreal"
+ * dependencies and, if one of those exports a "isInited" fonction,
+ * it will enforce that the lib has been properly initialized before
+ * starting...
+ */
+function isInited() {
+    return libIsInited;
+}
+exports.isInited = isInited;
+//# sourceMappingURL=init.js.map

package/dist/src/config/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/config/init.ts"],"names":[],"mappings":";;;AACA,4BAA4B;AAC5B,uCAAoC;AAEpC,IAAI,WAAW,GAAY,KAAK,CAAC;AAEjC;;GAEG;AACH,SAAgB,IAAI,CAClB,aAAwC,EACxC,qBAAmC;AACnC;;;;;GAKG;AACH,gBAAyB;IAEzB,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;IAED,IAAI,CAAC,qBAAqB,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;KAC7D;IAED,IAAI,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;KAC1E;IAED,iBAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IACxC,iBAAO,CAAC,wBAAwB,CAAC,qBAAqB,CAAC,CAAC;IACxD,iBAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAE9C,6CAA6C;IAC7C,uCAAuC;IACvC,4CAA4C;IAC5C,6CAA6C;IAC7C,WAAW,GAAG,IAAI,CAAC;AACrB,CAAC;AAhCD,oBAgCC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ;IACtB,OAAO,WAAW,CAAC;AACrB,CAAC;AAFD,4BAEC"}

package/dist/src/httpUtils.d.ts

@@ -0,0 +1,131 @@
+import { IOrderBy } from '@villedemontreal/general-utils';
+import { Request } from 'express';
+import * as superagent from 'superagent';
+/**
+ * HTTP utilities
+ */
+export declare class HttpUtils {
+    private readonly REQ_PARAMS_LOWERCASED;
+    /**
+     * Remove first and last slash of the string unless the string is the part after protocol (http://)
+     */
+    removeSlashes(text: string): string;
+    /**
+     * Join few parts of an url to a final string
+     */
+    urlJoin(...args: string[]): string;
+    /**
+     * Sends a HTTP request built with Superagent.
+     *
+     * Will add the proper Correlation Id and will write
+     * useful logs.
+     *
+     * IMPORTANT : this method does NOT throw an Error on a
+     * 4XX-5XX status response! It will return it the same way
+     * it returns a 200 response and it is up to the calling code
+     * to validate the actual response's status. For example
+     * by using :
+     *
+     * if(response.ok) {...}
+     *
+     * and/or by checking the status :
+     *
+     * if(response.status === 404) {...}
+     *
+     * An error will be thrown only when a network problem occures or
+     * if the target server can't be reached.
+     *
+     * This is different from SuperAgent's default behavior that DOES
+     * throw an error on 4XX-5XX status responses.
+     *
+     */
+    send(request: superagent.SuperAgentRequest): Promise<superagent.Response>;
+    /**
+     * Gets all the values of a querystring parameter.
+     * Manages the fact that we may use insensitive routing.
+     *
+     * A querystring parameter may indeed contains multiple values. For
+     * example : "path?name=aaa&name=bbb" will result in an
+     * *array* when getting the "name" parameter : ['aaa', 'bbb'].
+     *
+     * @returns all the values of the parameters as an array (even if
+     * only one value is found) or an empty array if none are found.
+     */
+    getQueryParamAll(req: Request, key: string): string[];
+    /**
+     * Get the last value of a querystring parameter.
+     * Manages the fact that we may use insensitive routing.
+     *
+     * A querystring parameter may indeed contains multiple values. For
+     * example : "path?name=aaa&name=bbb" will result in an
+     * *array* when getting the "name" parameter : ['aaa', 'bbb'].
+     *
+     * In many situation, we only want to deal withy a single value.
+     * This function return the last value of a query param.
+     *
+     * @returns the last parameter with that key or `undefined` if
+     *  not found.
+     */
+    getQueryParamOne(req: Request, key: string): string;
+    /**
+     * Get the last value of a querystring parameter *as a Date*.
+     * The parameter must be parsable using `new Date(xxx)`.
+     * It is recommended to always use ISO-8601 to represent dates
+     * (ex: "2020-04-21T17:13:33.107Z").
+     *
+     * If the parameter is found but can't be parsed to a Date,
+     * by default an `Error` is thrown. But if `errorHandler`
+     * is specified, it is called instead. This allows you
+     * to catch the error and throw a custom error, for
+     * example by using `throw createInvalidParameterError(xxx)`
+     * in an API.
+     *
+     * Manages the fact that we may use insensitive routing.
+     *
+     * @returns the last parameter with that key as a Date
+     *  or `undefined` if not found.
+     * @throws An Error if the parameter is found but can't be parsed
+     *  to a Date and no `errorHandler` is specified.
+     */
+    getQueryParamOneAsDate: (req: Request, key: string, errorHandler?: (errMsg: string, value?: string) => any) => Date;
+    /**
+     * Get the last value of a querystring parameter *as a Number*.
+     * The parameter must be parsable using `Number(xxx)`.
+     *
+     * If the parameter is found but can't be parsed to a Number,
+     * by default an `Error` is thrown. But if `errorHandler`
+     * is specified, it is called instead. This allows you
+     * to catch the error and throw a custom error, for
+     * example by using `throw createInvalidParameterError(xxx)`
+     * in an API.
+     *
+     * Manages the fact that we may use insensitive routing.
+     *
+     * @returns the last parameter with that key as a Number
+     *  or `undefined` if not found.
+     * @throws An Error if the parameter is found but can't be parsed
+     *  to a Number and no `errorHandler` is specified.
+     */
+    getQueryParamOneAsNumber: (req: Request, key: string, errorHandler?: (errMsg: string, value?: string) => any) => number;
+    /**
+     * Get the last value of a querystring parameter *as a boolean*.
+     * The value must be "true" or "false" (case insensitive) to
+     * be considered as a valid boolean. For example, the value '1'
+     * is invalid.
+     *
+     * @returns the last parameter with that key as a boolean
+     *  or `undefined` if not found.
+     * @throws An Error if the parameter is found but can't be parsed
+     *  to a valid boolean and no `errorHandler` is specified.
+     */
+    getQueryParamOneAsBoolean: (req: Request, key: string, errorHandler?: (errMsg: string, value?: string) => any) => boolean;
+    private getOriginalQueryParamAsArray;
+    /**
+     * Gets the "IOrderBy[]" from the querystring parameters
+     * of a search request.
+     *
+     * @see https://confluence.montreal.ca/pages/viewpage.action?spaceKey=AES&title=REST+API#RESTAPI-Tridelarequ%C3%AAte
+     */
+    getOrderBys: (req: Request) => IOrderBy[];
+}
+export declare let httpUtils: HttpUtils;