3.0.23

.gitlab-ci.yml

@@ -12,30 +12,38 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
-  stage: security
+# security stage
-  script:
+# ====================
-    - npmci git mirror
+auditProductionDependencies:
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-audit:
   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 --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
   tags:
     - lossless
     - docker
-    - notpriv
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command pnpm audit --audit-level=high --dev
+  tags:
+    - lossless
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
@@ -44,28 +52,22 @@ audit:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 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:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +87,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  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
@@ -109,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

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
     }
   ]
 }

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "webrequest",
-      "shortDescription": "securely request from browsers",
+      "description": "securely request from browsers",
       "npmPackagename": "@pushrocks/webrequest",
       "license": "MIT"
     }

package.json

@@ -1,29 +1,34 @@
 {
   "name": "@pushrocks/webrequest",
-  "version": "2.0.7",
+  "version": "3.0.23",
   "private": false,
   "description": "securely request from browsers",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
-    "format": "(gitzone format)"
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.65",
-    "@gitzone/tstest": "^1.0.33",
+    "@gitzone/tsbundle": "^2.0.7",
-    "@pushrocks/smartexpress": "^3.0.72",
+    "@gitzone/tsrun": "^1.2.39",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@gitzone/tstest": "^1.0.73",
-    "@types/node": "^14.0.14",
+    "@pushrocks/smartexpress": "^4.0.35",
-    "node-fetch": "^2.6.0",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "tslint": "^6.1.2",
+    "@types/node": "^18.16.3"
-    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.9"
+    "@adobe/fetch": "^4.0.10",
+    "@pushrocks/smartdelay": "^3.0.1",
+    "@pushrocks/smartenv": "^5.0.2",
+    "@pushrocks/smartjson": "^5.0.1",
+    "@pushrocks/smartpromise": "^4.0.2",
+    "@pushrocks/webstore": "^2.0.7"
   },
   "files": [
     "ts/**/*",
@@ -36,5 +41,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -21,20 +21,17 @@ 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
 
 Use TypeScript for best in class intellisense.
 
-
 ## Contribution
 
 We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
 
 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

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

test/test.ts

@@ -1,5 +1,5 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as webrequest from '../ts/index';
+import * as webrequest from '../ts/index.js';
 
 // test dependencies
 import * as smartexpress from '@pushrocks/smartexpress';
@@ -10,7 +10,7 @@ tap.test('setup test server', async () => {
   testServer = new smartexpress.Server({
     cors: false,
     forceSsl: false,
-    port: 2345
+    port: 2345,
   });
 
   testServer.addRoute(
@@ -34,7 +34,7 @@ tap.test('setup test server', async () => {
     new smartexpress.Handler('GET', (req, res) => {
       res.status(200);
       res.send({
-        hithere: 'hi'
+        hithere: 'hi',
       });
     })
   );
@@ -42,29 +42,37 @@ tap.test('setup test server', async () => {
   await testServer.start();
 });
 
-tap.test('first test', async tools => {
+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');
 
-  console.log(response);
+  console.log('response 1: ' + JSON.stringify(response));
-  console.log(response2);
+  console.log('response 2: ' + JSON.stringify(response2));
 
-  expect(response)
+  expect(response).toHaveProperty('hithere'); //.to.equal('hi');
-    .property('hithere')
+  expect(response2).toHaveProperty('hithere'); //.to.equal('hi');
-    .to.equal('hi');
-  expect(response2)
-    .property('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

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/webrequest',
+  version: '3.0.23',
+  description: 'securely request from browsers'
+}

ts/index.ts

@@ -1,72 +1,209 @@
-import * as plugins from './webrequest.plugins';
+import * as plugins from './webrequest.plugins.js';
+
+export interface IWebrequestContructorOptions {
+  logging?: boolean;
+}
 
 /**
  * web request
  */
 export class WebRequest {
-  private static polyfillsLoaded = false;
+  private static polyfillStatusEvaluated = false;
-  public static loadNeededPolyfills() {
+  private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer<{
-    if (!this.polyfillsLoaded) {
+    fetch: typeof fetch;
-      this.polyfillsLoaded = true;
+    Response: typeof Response;
-      // tslint:disable-next-line: no-eval
+    AbortController?: typeof AbortController;
-      const loadFetchPolyfill = eval(`globalThis.fetch = require('node-fetch')`);
+    helixTimeout?: any;
-      loadFetchPolyfill();
+  }>();
+
+  /**
+   * loads the needed polyfill
+   * @returns
+   */
+  public static async loadNeededPolyfills() {
+    if (this.polyfillStatusEvaluated) {
+      return this.neededPolyfillsLoadedDeferred.promise;
+    }
+    this.polyfillStatusEvaluated = true;
+    const smartenv = new plugins.smartenv.Smartenv();
+    if (!smartenv.isBrowser) {
+      console.log('webrequest using node context.');
+      this.polyfillStatusEvaluated = true;
+      const fetchMod = await smartenv.getSafeNodeModule('@adobe/fetch');
+      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,
+      });
     }
   }
 
-  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'
+      method: 'GET',
+      useCache: useCacheArg,
     });
-    return response.json();
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
   }
 
   /**
    * 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: JSON.stringify(requestBody),
+      method: 'POST',
-      method: 'POST'
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: plugins.smartjson.stringify(requestBody),
+      useCache: useCacheArg,
     });
-    return response.json();
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
   }
 
   /**
    * put js
    */
-  public async putJson(urlArg: string, requestBody?: any) {
+  public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
-      body: JSON.stringify(requestBody),
+      method: 'PUT',
-      method: 'PUT'
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: plugins.smartjson.stringify(requestBody),
     });
-    return response.json();
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
   }
 
   /**
    * put js
    */
-  public async deleteJson(urlArg: string) {
+  public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     const response: Response = await this.request(urlArg, {
-      method: 'GET'
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      method: 'GET',
     });
-    return response.json();
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    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';
       body?: any;
+      headers?: HeadersInit;
     }
   ): Promise<Response> {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
     let allUrls: string[];
     let usedUrlIndex = 0;
 
@@ -99,31 +236,39 @@ export class WebRequest {
     };
 
     // lets go recursive
-    const doRequest = async (urlToUse: string) => {
+    const doRequest = async (urlToUse: string): Promise<any> => {
       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: {
-          'Content-Type': 'application/json'
+          'Content-Type': 'application/json',
+          ...(optionsArg.headers || {}),
         },
-        body: optionsArg.body
+        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;
       } else {
+        // lets perform a history check to determine failed urls
         await doHistoryCheck(response.status.toString());
-        // tslint:disable-next-line: no-return-await
+        // lets fire the request
-        return await doRequest(allUrls[usedUrlIndex]);
+        const result = await doRequest(allUrls[usedUrlIndex]);
+        return result;
       }
     };
 
     const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
-    console.log(finalResponse);
     return finalResponse;
   }
+
+  public log(logArg: string) {
+    if (this.options.logging) {
+      console.log(logArg);
+    }
+  }
 }

ts/webrequest.plugins.ts

@@ -1,3 +1,7 @@
 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 };
+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"
-}