3.0.20

.gitlab-ci.yml

@@ -13,31 +13,24 @@ stages:
   - metadata
 
 before_script:
-  - npm install -g @shipzone/npmci
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
-  stage: security
+# security stage
-  script:
+# ====================
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install --production --ignore-scripts
+     - npmci command pnpm audit --audit-level=high --prod
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -45,11 +38,10 @@ auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -60,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -71,10 +62,9 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
-    - npmci command npm run build
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -100,10 +90,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -123,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/webrequest",
-  "version": "3.0.4",
+  "version": "3.0.20",
   "private": false,
   "description": "securely request from browsers",
   "main": "dist_ts/index.js",
@@ -10,24 +10,25 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)"
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tsbuild": "^2.1.65",
-    "@gitzone/tsbundle": "^2.0.4",
+    "@gitzone/tsbundle": "^2.0.7",
-    "@gitzone/tstest": "^1.0.71",
+    "@gitzone/tsrun": "^1.2.39",
-    "@pushrocks/smartexpress": "^4.0.4",
+    "@gitzone/tstest": "^1.0.73",
-    "@pushrocks/tapbundle": "^5.0.3",
+    "@pushrocks/smartexpress": "^4.0.21",
-    "@types/node": "^17.0.35",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "tslint": "^6.1.3",
+    "@types/node": "^18.14.6"
-    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
+    "@adobe/fetch": "^4.0.4",
     "@pushrocks/smartdelay": "^2.0.13",
-    "@pushrocks/smartenv": "^5.0.1",
+    "@pushrocks/smartenv": "^5.0.2",
-    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartjson": "^5.0.1",
     "@pushrocks/smartpromise": "^3.1.7",
-    "node-fetch": "^3.2.4"
+    "@pushrocks/webstore": "^2.0.5"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
 PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/webrequest)](https://lossless.cloud)
 PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/webrequest)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/webrequest)](https://lossless.cloud)
-Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
@@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.browser.ts

@@ -1,16 +1,11 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as webrequest from '../ts/index.js';
 
-tap.test('first test', async (tools) => {
+tap.test('should run multiendpoint request', async (tools) => {
-  const done = tools.defer();
+  const response = await new webrequest.WebRequest().request('https://api.signup.software', {
-  const response = await new webrequest.WebRequest()
+    method: 'GET',
-    .request(['https://lossless.com'], {
+  });
-      method: 'GET',
+  console.log(JSON.stringify(await response.text()));
-    })
-    .catch((e) => {
-      done.resolve();
-    });
-  await done.promise;
 });
 
 tap.start();

test/test.ts

@@ -43,12 +43,19 @@ tap.test('setup test server', async () => {
 });
 
 tap.test('first test', async (tools) => {
-  const response = await new webrequest.WebRequest().getJson([
+  const response = await (
-    'http://localhost:2345/apiroute1',
+    await new webrequest.WebRequest().requestMultiEndpoint(
-    'http://localhost:2345/apiroute2',
+      [
-    'http://localhost:2345/apiroute4',
+        'http://localhost:2345/apiroute1',
-    'http://localhost:2345/apiroute3',
+        'http://localhost:2345/apiroute2',
-  ]);
+        'http://localhost:2345/apiroute4',
+        'http://localhost:2345/apiroute3',
+      ],
+      {
+        method: 'GET',
+      }
+    )
+  ).json();
 
   const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
 
@@ -59,8 +66,13 @@ tap.test('first test', async (tools) => {
   expect(response2).toHaveProperty('hithere'); //.to.equal('hi');
 });
 
-tap.test('tear down server', async () => {
+tap.test('should cache response', async () => {
-  testServer.stop();
+  const webrequestInstance = new webrequest.WebRequest();
+  const response = await webrequestInstance.getJson('http://localhost:2345/apiroute3', true);
+  expect(response).toHaveProperty('hithere');
+  await testServer.stop();
+  const response2 = await webrequestInstance.getJson('http://localhost:2345/apiroute3', true);
+  expect(response2).toHaveProperty('hithere');
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@pushrocks/webrequest',
-  version: '3.0.4',
+  version: '3.0.20',
   description: 'securely request from browsers'
 }

ts/index.ts

@@ -1,11 +1,25 @@
 import * as plugins from './webrequest.plugins.js';
 
+export interface IWebrequestContructorOptions {
+  logging?: boolean;
+}
+
 /**
  * web request
  */
 export class WebRequest {
   private static polyfillStatusEvaluated = false;
-  private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer();
+  private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer<{
+    fetch: typeof fetch;
+    Response: typeof Response;
+    AbortController?: typeof AbortController;
+    helixTimeout?: any;
+  }>();
+
+  /**
+   * loads the needed polyfill
+   * @returns
+   */
   public static async loadNeededPolyfills() {
     if (this.polyfillStatusEvaluated) {
       return this.neededPolyfillsLoadedDeferred.promise;
@@ -13,21 +27,46 @@ export class WebRequest {
     this.polyfillStatusEvaluated = true;
     const smartenv = new plugins.smartenv.Smartenv();
     if (!smartenv.isBrowser) {
+      console.log('webrequest using node context.');
       this.polyfillStatusEvaluated = true;
-      const fetch = await smartenv.getSafeNodeModule('node-fetch');
+      const fetchMod = await smartenv.getSafeNodeModule('@adobe/fetch');
-      globalThis.fetch = fetch.default;
+      this.neededPolyfillsLoadedDeferred.resolve({
+        fetch: fetchMod.fetch,
+        Response: fetchMod.Response,
+        helixTimeout: fetchMod.timeoutSignal,
+      });
+    } else {
+      console.log('webrequest using browser context.');
+      this.neededPolyfillsLoadedDeferred.resolve({
+        fetch: (...args) => {
+          return fetch(...args);
+        },
+        Response: globalThis.Response,
+        AbortController: globalThis.AbortController,
+      });
     }
-    this.neededPolyfillsLoadedDeferred.resolve();
   }
 
-  constructor() {
+  public cacheStore = new plugins.webstore.WebStore({
+    dbName: 'webrequest',
+    storeName: 'webrequest',
+  });
+
+  public options: IWebrequestContructorOptions;
+
+  constructor(public optionsArg: IWebrequestContructorOptions = {}) {
+    this.options = {
+      logging: true,
+      ...optionsArg,
+    };
     WebRequest.loadNeededPolyfills();
   }
 
-  public async getJson(urlArg: string | string[]) {
+  public async getJson(urlArg: string, useCacheArg: boolean = false) {
     await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
       method: 'GET',
+      useCache: useCacheArg,
     });
     const responseText = await response.text();
     const responseResult = plugins.smartjson.parse(responseText);
@@ -37,25 +76,15 @@ export class WebRequest {
   /**
    * postJson
    */
-  public async postJson(urlArg: string, requestBody?: any) {
+  public async postJson(urlArg: string, requestBody?: any, useCacheArg: boolean = false) {
     await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
-      body: plugins.smartjson.stringify(requestBody),
       method: 'POST',
-    });
+      headers: {
-    const responseText = await response.text();
+        'Content-Type': 'application/json',
-    const responseResult = plugins.smartjson.parse(responseText);
+      },
-    return responseResult;
-  }
-
-  /**
-   * put js
-   */
-  public async putJson(urlArg: string, requestBody?: any) {
-    await WebRequest.neededPolyfillsLoadedDeferred.promise;
-    const response: Response = await this.request(urlArg, {
       body: plugins.smartjson.stringify(requestBody),
-      method: 'PUT',
+      useCache: useCacheArg,
     });
     const responseText = await response.text();
     const responseResult = plugins.smartjson.parse(responseText);
@@ -65,9 +94,29 @@ export class WebRequest {
   /**
    * put js
    */
-  public async deleteJson(urlArg: string) {
+  public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
     await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
+      method: 'PUT',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: plugins.smartjson.stringify(requestBody),
+    });
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
+  }
+
+  /**
+   * put js
+   */
+  public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    const response: Response = await this.request(urlArg, {
+      headers: {
+        'Content-Type': 'application/json',
+      },
       method: 'GET',
     });
     const responseText = await response.text();
@@ -75,10 +124,78 @@ export class WebRequest {
     return responseResult;
   }
 
-  /**
-   * a fault tolerant request
-   */
   public async request(
+    urlArg: string,
+    optionsArg: {
+      method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+      body?: any;
+      headers?: HeadersInit;
+      useCache?: boolean;
+      timeoutMs?: number;
+    }
+  ) {
+    optionsArg = {
+      timeoutMs: 60000,
+      useCache: false,
+      ...optionsArg,
+    };
+
+    const fetchObject = await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    let controller: AbortController;
+    if (optionsArg.timeoutMs) {
+      if (fetchObject.AbortController) {
+        controller = new fetchObject.AbortController();
+        plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => {
+          controller.abort();
+        });
+      } else {
+        controller = {
+          signal: fetchObject.helixTimeout(optionsArg.timeoutMs),
+        } as any;
+      }
+    }
+    let cachedResponseDeferred = plugins.smartpromise.defer<Response>();
+    let cacheUsed = false;
+    if (optionsArg.useCache && (await this.cacheStore.check(urlArg))) {
+      const responseBuffer: ArrayBuffer = await this.cacheStore.get(urlArg);
+      cachedResponseDeferred.resolve(new Response(responseBuffer, {}));
+    } else {
+      cachedResponseDeferred.resolve(null);
+    }
+    let response: Response = await fetchObject
+      .fetch(urlArg, {
+        signal: controller ? controller.signal : null,
+        method: optionsArg.method,
+        headers: {
+          ...(optionsArg.headers || {}),
+        },
+        body: optionsArg.body,
+      })
+      .catch(async (err) => {
+        if (optionsArg.useCache && (await cachedResponseDeferred.promise)) {
+          cacheUsed = true;
+          const cachedResponse = cachedResponseDeferred.promise;
+          return cachedResponse;
+        } else {
+          return err;
+        }
+      });
+    if (optionsArg.useCache && (await cachedResponseDeferred.promise) && response.status === 500) {
+      cacheUsed = true;
+      response = await cachedResponseDeferred.promise;
+    }
+    if (!cacheUsed && optionsArg.useCache && response.status < 300) {
+      const buffer = await response.clone().arrayBuffer();
+      await this.cacheStore.set(urlArg, buffer);
+    }
+    this.log(`${urlArg} answers with status: ${response.status}`);
+    return response;
+  }
+
+  /**
+   * a multi endpoint, fault tolerant request function
+   */
+  public async requestMultiEndpoint(
     urlArg: string | string[],
     optionsArg: {
       method: 'GET' | 'POST' | 'PUT' | 'DELETE';
@@ -123,7 +240,7 @@ export class WebRequest {
       if (!urlToUse) {
         throw new Error('request failed permanently');
       }
-      console.log(`Getting ${urlToUse} with method ${optionsArg.method}`);
+      this.log(`Getting ${urlToUse} with method ${optionsArg.method}`);
       const response = await fetch(urlToUse, {
         method: optionsArg.method,
         headers: {
@@ -132,7 +249,7 @@ export class WebRequest {
         },
         body: optionsArg.body,
       });
-      console.log(`${urlToUse} answers with status: ${response.status}`);
+      this.log(`${urlToUse} answers with status: ${response.status}`);
 
       if (response.status >= 200 && response.status < 300) {
         return response;
@@ -148,4 +265,10 @@ export class WebRequest {
     const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
     return finalResponse;
   }
+
+  public log(logArg: string) {
+    if (this.options.logging) {
+      console.log(logArg);
+    }
+  }
 }

ts/webrequest.plugins.ts

@@ -2,5 +2,6 @@ import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartenv from '@pushrocks/smartenv';
 import * as smartjson from '@pushrocks/smartjson';
 import * as smartpromise from '@pushrocks/smartpromise';
+import * as webstore from '@pushrocks/webstore';
 
-export { smartdelay, smartenv, smartjson, smartpromise };
+export { smartdelay, smartenv, smartjson, smartpromise, webstore };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}