@metarisc/metarisc-js 0.0.1-alpha.19 → 0.0.1-alpha.20

package/lib/client.d.ts

@@ -25,5 +25,9 @@ export declare class Client {
     getClientCredentials(options: OAuth2Options): Promise<GrantResponse>;
     setAccessToken(access_token: string): void;
     getAccessToken(): string;
+    /**
+     * Retourne les headers HTTP par défauts devant être présents dans toutes les requêtes Metarisc.
+     */
+    private getDefaultHeaders;
 }
 export {};

package/lib/client.js

@@ -8,6 +8,7 @@ const axios_1 = __importDefault(require("axios"));
 const axios_retry_1 = __importDefault(require("axios-retry"));
 const axios_oauth_client_1 = __importDefault(require("axios-oauth-client"));
 const oauth2_1 = require("./auth/oauth2");
+const axios_cache_interceptor_1 = require("axios-cache-interceptor");
 var AuthMethod;
 (function (AuthMethod) {
     AuthMethod[AuthMethod["CLIENT_CREDENTIALS"] = 0] = "CLIENT_CREDENTIALS";
@@ -17,7 +18,17 @@ class Client {
     constructor(config) {
         this.axios = axios_1.default.create({
             baseURL: config.metarisc_url ?? 'https://api.metarisc.fr/',
+            'headers': {
+                'common': this.getDefaultHeaders()
+            }
         });
+        // Axios Interceptors
+        // Request interceptors are FILO (First In Last Out)
+        // Response interceptors are FIFO (First In First Out)
+        // Axios interceptor : Enable HTTP Caching
+        // When combining axios-cache-interceptors with other interceptors, you may encounter some inconsistences.
+        // See : https://github.com/arthurfiorette/axios-cache-interceptor/issues/449#issuecomment-1370327566
+        this.axios = (0, axios_cache_interceptor_1.setupCache)(this.axios);
         // Axios interceptor : Retry strategy
         (0, axios_retry_1.default)(this.axios, {
             retries: 3,
@@ -70,5 +81,17 @@ class Client {
     getAccessToken() {
         return this.access_token;
     }
+    /**
+     * Retourne les headers HTTP par défauts devant être présents dans toutes les requêtes Metarisc.
+     */
+    getDefaultHeaders() {
+        const headers = {};
+        // UA Headers
+        headers['User-Agent'] = 'MetariscJs/dev'; // Format User-Agent (https://www.rfc-editor.org/rfc/rfc9110#name-user-agent)
+        headers['Metarisc-User-Agent'] = JSON.stringify({
+            'lang': 'js'
+        });
+        return headers;
+    }
 }
 exports.Client = Client;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@metarisc/metarisc-js",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "version": "0.0.1-alpha.19",
+  "version": "0.0.1-alpha.20",
   "scripts": {
     "lint": "eslint . --ext .ts --fix",
     "compile": "tsc",
@@ -19,8 +19,9 @@
   },
   "dependencies": {
     "axios": "^1.4.0",
-    "axios-retry": "^3.5.0",
+    "axios-cache-interceptor": "^1.3.2",
     "axios-oauth-client": "^2.0.4",
+    "axios-retry": "^3.5.0",
     "tus-js-client": "^3.1.1"
   }
 }

package/src/client.ts

@@ -1,8 +1,9 @@
-import axios, { AxiosInstance, AxiosResponse } from "axios";
+import axios, { AxiosInstance, AxiosResponse, RawAxiosRequestHeaders } from "axios";
 import axiosRetry from "axios-retry";
 import oauth from "axios-oauth-client";
 import { GrantResponse, MetariscConfig, OAuth2Options } from './core';
 import { OAuth2 } from "./auth/oauth2";
+import { setupCache } from 'axios-cache-interceptor';
 
 interface RequestConfig {
   body?: any;
@@ -26,8 +27,20 @@ export class Client {
   constructor(config : MetariscConfig) {
     this.axios = axios.create({
       baseURL: config.metarisc_url ?? 'https://api.metarisc.fr/',
+      'headers': {
+        'common': this.getDefaultHeaders()
+      }
     });
 
+    // Axios Interceptors
+    // Request interceptors are FILO (First In Last Out)
+    // Response interceptors are FIFO (First In First Out)
+
+    // Axios interceptor : Enable HTTP Caching
+    // When combining axios-cache-interceptors with other interceptors, you may encounter some inconsistences.
+    // See : https://github.com/arthurfiorette/axios-cache-interceptor/issues/449#issuecomment-1370327566
+    this.axios = setupCache(this.axios);
+
     // Axios interceptor : Retry strategy
     axiosRetry(this.axios, {
         retries: 3,
@@ -101,4 +114,20 @@ export class Client {
   getAccessToken(): string {
     return this.access_token;
   }
+
+  /**
+   * Retourne les headers HTTP par défauts devant être présents dans toutes les requêtes Metarisc.
+   */
+  private getDefaultHeaders() : RawAxiosRequestHeaders
+  {
+    const headers : RawAxiosRequestHeaders = {};
+
+    // UA Headers
+    headers['User-Agent'] = 'MetariscJs/dev'; // Format User-Agent (https://www.rfc-editor.org/rfc/rfc9110#name-user-agent)
+    headers['Metarisc-User-Agent'] = JSON.stringify({
+      'lang': 'js'
+    });
+
+    return headers;
+  }
 }