Make HttpRequestOptions accept 'headers' parameter when Axios request.

vmware · Nov 15, 2024 · 2eb32c1 · 2eb32c1
1 parent a55c551
commit 2eb32c1
Show file tree

Hide file tree

Showing 12 changed files with 5,851 additions and 5,976 deletions.
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -13,7 +13,7 @@ jobs:
   pre-process:
     name: Pre process
     runs-on: ubuntu-latest
-    outputs: 
+    outputs:
       were-only-docs-updated: ${{ steps.were-only-docs-updated-action.outputs.were-only-docs-updated }}
     steps:
       - name: Checkout code
@@ -38,7 +38,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
         with:
-          fetch-depth: 2.  
+          fetch-depth: 2.
       - name: Get commit range
         id: get-commit-range-action
         uses: ./.github/actions/get-commit-range-action
@@ -86,50 +86,50 @@ jobs:
       security-events: write
     strategy:
       matrix:
-        node-version: [10.x]    
+        node-version: [14.x]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
       - name: Create cache folder
         run: |
           mkdir -p /home/runner/.npm
-        continue-on-error: true  
+        continue-on-error: true
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-          cache: 'npm'      
+          cache: 'npm'
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           languages: javascript
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v2
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
-        
+        uses: github/codeql-action/analyze@v2
+
   codacy-analysis-cli:
     name: Codacy Analysis CLI
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@main
       - name: Run Codacy Analysis CLI
-        uses: codacy/codacy-analysis-cli-action@master  
+        uses: codacy/codacy-analysis-cli-action@master
         with:
           output: results.sarif
           format: sarif
           # Adjust severity of non-security issues
           gh-code-scanning-compat: true
           # Force 0 exit code to allow SARIF file generation
           # This will handover control about PR rejection to the GitHub side
-          max-allowed-issues: 2147483647  
-      # Upload the SARIF file generated in the previous step  
+          max-allowed-issues: 2147483647
+      # Upload the SARIF file generated in the previous step
       - name: Upload SARIF results file
         uses: github/codeql-action/upload-sarif@main
         with:
           sarif_file: results.sarif
-        
+
   smoke-test:
     name: Smoke Test
     runs-on: ubuntu-latest
@@ -141,19 +141,19 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-      - name: Set up JDK 8
+      - name: Set up JDK 17
         uses: actions/setup-java@v2
         with:
           distribution: 'adopt'
-          java-version: '8'
+          java-version: '17'
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - name: Smoke Test
         run: |
-          TZ='Asia/Shanghai'; export TZ 
+          TZ='Asia/Shanghai'; export TZ
           mkdir -p g11n-js-client
           shopt -s extglob
           mv !(g11n-js-client) g11n-js-client/

diff --git a/jest.config.json b/jest.config.json
@@ -7,6 +7,7 @@
 		"json"
 	],
 	"testRegex": "/test/*.*\\.spec\\.ts$",
+	"testEnvironment": "jsdom",
 	"transform": {
 		"^.+\\.tsx?$": "ts-jest"
 	},

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.client.json b/package.client.json
@@ -1,6 +1,6 @@
 {
     "name": "@singleton-i18n/js-core-sdk",
-    "version": "0.5.7",
+    "version": "0.5.8",
     "publishConfig": {
         "registry": ""
     },
@@ -42,18 +42,26 @@
         "@types/node": "^10.11.7",
         "awesome-typescript-loader": "^5.2.1",
         "axios": "^0.21.1",
-        "jest": "^24.5.0",
-        "ts-jest": "^24.0.0",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^28.1.3",
+        "ts-jest": "^29.2.5",
         "ts-node": "^7.0.1",
         "tslint": "^5.11.0",
         "tslint-loader": "^3.5.4",
         "typescript": "^4.4.4",
-        "typescript-loader": "^1.1.3",
-        "typings": "^2.1.1",
-        "webpack": "^4.20.2",
-        "webpack-cli": "^3.3.0"
+        "webpack": "^5.96.1",
+        "webpack-cli": "^5.1.4"
     },
     "changelogHistory": [
+        {
+            "date": "11/15/24",
+            "version": "0.5.8",
+            "notes": [
+                {
+                    "description": "Make HttpRequestOptions accept 'headers' parameter when Axios request."
+                }
+            ]
+        },
         {
             "date": "06/05/23",
             "version": "0.5.7",

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@singleton-i18n/js-core-sdk-server",
-    "version": "0.5.7",
+    "version": "0.5.8",
     "publishConfig": {
         "registry": ""
     },
@@ -42,18 +42,26 @@
         "@types/node": "^10.11.7",
         "awesome-typescript-loader": "^5.2.1",
         "axios": "^0.21.1",
-        "jest": "^24.5.0",
-        "ts-jest": "^24.0.0",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^28.1.3",
+        "ts-jest": "^29.2.5",
         "ts-node": "^7.0.1",
         "tslint": "^5.11.0",
         "tslint-loader": "^3.5.4",
         "typescript": "^4.4.4",
-        "typescript-loader": "^1.1.3",
-        "typings": "^2.1.1",
-        "webpack": "^4.20.2",
-        "webpack-cli": "^3.3.0"
+        "webpack": "^5.96.1",
+        "webpack-cli": "^5.1.4"
     },
     "changelogHistory": [
+        {
+            "date": "11/15/24",
+            "version": "0.5.8",
+            "notes": [
+                {
+                    "description": "Make HttpRequestOptions accept 'headers' parameter when Axios request."
+                }
+            ]
+        },
         {
             "date": "06/05/23",
             "version": "0.5.7",

diff --git a/samples/client/js/package.json b/samples/client/js/package.json
@@ -10,7 +10,7 @@
     "load-translation": "load-translation --directory `pwd`/src/sources --product CoreSDKClient --component ui --host http://localhost:8091 --version 1.0 --languages zh,en"
   },
   "dependencies": {
-    "@singleton-i18n/js-core-sdk": "file:../../../singleton-i18n-js-core-sdk-0.5.7.tgz",
+    "@singleton-i18n/js-core-sdk": "file:../../../singleton-i18n-js-core-sdk-0.5.8.tgz",
     "argparse": "^1.0.10",
     "axios": "^0.21.1",
     "typescript": "^4.4.4"
@@ -21,8 +21,11 @@
     "copy-webpack-plugin": "^5.0.4",
     "express": "^4.17.1",
     "express-rate-limit": "^6.7.0",
-    "jest": "^24.9.0",
-    "webpack": "^4.39.1",
-    "webpack-cli": "^3.3.6"
+    "jest": "^29.7.0",
+    "webpack": "^5.96.1",
+    "webpack-cli": "^5.1.4"
+  },
+  "jest": {
+    "testEnvironment": "jsdom"
   }
 }
diff --git a/samples/client/js/src/i18n.utils.js b/samples/client/js/src/i18n.utils.js
@@ -1,23 +1,23 @@
 /*
- * Copyright 2019-2023 VMware, Inc.
+ * Copyright 2019-2024 VMware, Inc.
  * SPDX-License-Identifier: EPL-2.0
  */
 import * as singletonCore from '@singleton-i18n/js-core-sdk';
 import { ENGLISH } from './source.l10n';
 import { config as defaultConfig } from './config';
 
 /**
- * Should be executed in the html file that needs to be localized. 
- * 
+ * Should be executed in the html file that needs to be localized.
+ *
  * @param {*} config object that provides the configuration with the following format
  *      {
- *          productID, version, component, host, localizeAttribute, langCookieName, localStoragePseudoKey 
- *      } 
+ *          productID, version, component, host, localizeAttribute, langCookieName, localStoragePseudoKey
+ *      }
  */
 export function localize(config) {
 
     config = config ? config : {};
-    // If some properties aren't provided by the given config 
+    // If some properties aren't provided by the given config
     // we are getting them from the defaultConfig
     config = Object.assign(defaultConfig, config);
     const lang = detectLanguage(config);
@@ -39,16 +39,20 @@ export function localize(config) {
             language: lang,
             sourceBundle: ENGLISH,
             // Uncommend if you don't want to load your translation from singleton but from your sources
-            //i18nAssets: 'src/translations/', 
+            //i18nAssets: 'src/translations/',
             isPseudo: shouldUsePseudoTranslations(),
+            // It offers the feature to self-custom header for target product
+            httpOptions: {
+                headers: {'vrni-header': 'vrni_custom'}
+            }
         }
     );
     loadAndShowTranslations(i18nClient, config);
 }
 
 /**
- *  Collects all elements from the page that have the l10n attribute. 
- *  Gets the attribute's value which is the key for the message, localizes the message 
+ *  Collects all elements from the page that have the l10n attribute.
+ *  Gets the attribute's value which is the key for the message, localizes the message
  *  and inserts it in the element.
  */
 function loadAndShowTranslations(i18nClient, config) {
@@ -65,12 +69,12 @@ function loadAndShowTranslations(i18nClient, config) {
 }
 
 /**
- *  Function that gets the current language. 
- *  If not set in the cookies it tries to detect the browser's. 
- *  If the browser's language isn't supported by singleton, falls back to english. 
+ *  Function that gets the current language.
+ *  If not set in the cookies it tries to detect the browser's.
+ *  If the browser's language isn't supported by singleton, falls back to english.
  */
 function detectLanguage(config) {
-    // First checks for lang in the cookie 
+    // First checks for lang in the cookie
     let language = getCookie(config.langCookieName);
     if (language) {
         return language;
@@ -81,8 +85,8 @@ function detectLanguage(config) {
     return language || undefined;
 }
 
-/** 
- * Gets a cookie by its name.  
+/**
+ * Gets a cookie by its name.
  */
 function getCookie(name) {
     function escape(s) { return s.replace(/([.*+?\^${}()|\[\]\/\\])/g, '\\$1'); };

diff --git a/samples/server/express/package.json b/samples/server/express/package.json
@@ -8,7 +8,7 @@
     "collect-source-bundle": "collect-source-bundle --source-dir `pwd`/i18n --product NodeSample --component NodeJS --host http://localhost:8091 --version 1.0"
   },
   "dependencies": {
-    "@singleton-i18n/js-core-sdk-server": "file:../../../singleton-i18n-js-core-sdk-server-0.5.7.tgz",
+    "@singleton-i18n/js-core-sdk-server": "file:../../../singleton-i18n-js-core-sdk-server-0.5.8.tgz",
     "argparse": "^1.0.10",
     "axios": "^0.21.1",
     "express": "4.15.3",

diff --git a/src/formatters/plural/plural.formatter.ts b/src/formatters/plural/plural.formatter.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 VMware, Inc.
+ * Copyright 2019-2024 VMware, Inc.
  * SPDX-License-Identifier: EPL-2.0
  */
 import { PLURALFUNCS } from './plurals.func';
@@ -8,7 +8,7 @@ export class Plural {
     constructor() { }
     private resolveLocale(locale: string): string {
         let lang: string = locale;
-        do {      
+        do {
             if (PLURALFUNCS[lang]) {
                 return lang;
             } else if (PLURALFUNCS[lang.toLocaleLowerCase()]) {

diff --git a/src/loader.ts b/src/loader.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2021 VMware, Inc.
+ * Copyright 2019-2024 VMware, Inc.
  * SPDX-License-Identifier: EPL-2.0
  */
 import axios from 'axios';
@@ -8,6 +8,11 @@ import { basedLogger, Logger } from './logger';
 export interface HttpRequestOptions {
     timeout?: number;
     withCredentials?: boolean;
+    headers?: HttpHeaders;
+}
+
+export interface HttpHeaders {
+    [key: string]: string;
 }
 
 export abstract class Loader {

diff --git a/src/services/core.service.ts b/src/services/core.service.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2021 VMware, Inc.
+ * Copyright 2019-2024 VMware, Inc.
  * SPDX-License-Identifier: EPL-2.0
  */
 import { Loader, HttpRequestOptions } from '../loader';
@@ -62,7 +62,7 @@ export class CoreService {
          * on which some products might rely to handle .then() method
         1. language = 'en-US'
         2. language = 'en', region = 'US'
-        3. language = 'en' 
+        3. language = 'en'
         */
         return Promise.resolve({});
     }

diff --git a/webpack.config.js b/webpack.config.js
@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2023 VMware, Inc.
+ * Copyright 2019-2024 VMware, Inc.
  * SPDX-License-Identifier: EPL-2.0
  */
 const helpers = require('./config/helpers');
@@ -44,21 +44,21 @@ module: {
 const nodeConfig = {
     mode: 'production',
     target: 'node',
-    
+
     resolve: {
         extensions: ['.ts', '.js']
     },
-    
+
     entry: helpers.root('index.ts'),
-    
+
     output: {
         path: helpers.root('bundles'),
         publicPath: '/',
         filename: 'singleton.core.umd.server.js',
         library: 'singletoncore',
         libraryTarget: 'umd'
     },
-    
+
     module: {
         rules: [{
             enforce: 'pre',
@@ -77,4 +77,3 @@ const nodeConfig = {
     };
 
     module.exports = [ webConfig, nodeConfig ];
-