3.0.5

.gitignore

@@ -1,6 +1,20 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,19 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,102 +21,115 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+  allow_failure: true
+
+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
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
-    
+testBuild:
-testSTABLE:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +137,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "webrequest",
+      "description": "securely request from browsers",
+      "npmPackagename": "@pushrocks/webrequest",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,28 +1,48 @@
 {
   "name": "@pushrocks/webrequest",
-  "version": "1.0.7",
+  "version": "3.0.5",
   "private": false,
   "description": "securely request from browsers",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "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)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.3",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tstest": "^1.0.17",
+    "@gitzone/tsbundle": "^2.0.4",
-    "@pushrocks/smartexpress": "^2.0.4",
+    "@gitzone/tstest": "^1.0.71",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/smartexpress": "^4.0.5",
-    "@types/node": "^10.12.12",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "node-fetch": "^2.3.0",
+    "@types/node": "^17.0.36",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.15.0"
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2"
+    "@pushrocks/smartdelay": "^2.0.13",
-  }
+    "@pushrocks/smartenv": "^5.0.2",
+    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartpromise": "^3.1.7",
+    "@pushrocks/webstore": "^2.0.3",
+    "node-fetch": "^3.2.4"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,39 @@
+# @pushrocks/webrequest
+securely request from browsers
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/webrequest)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/webrequest)
+* [github.com (source mirror)](https://github.com/pushrocks/webrequest)
+* [docs (typedoc)](https://pushrocks.gitlab.io/webrequest/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/webrequest/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/webrequest/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/webrequest)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/webrequest)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+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)
+| 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,16 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as webrequest from '../ts/index.js';
+
+tap.test('should run multiendpoint request', async (tools) => {
+  const done = tools.defer();
+  const response = await new webrequest.WebRequest()
+    .requestMultiEndpoint(['https://lossless.com'], {
+      method: 'GET',
+    })
+    .catch((e) => {
+      done.resolve();
+    });
+  await done.promise;
+});
+
+tap.start();

test/test.ts

@@ -1,16 +1,5 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as webrequest from '../ts/index';
+import * as webrequest from '../ts/index.js';
-import * as fetch from 'node-fetch';
-
-declare global {
-  namespace NodeJS {
-    interface Global {
-        fetch: any;
-    }
-  }
-}
-global.fetch = fetch;
-
 
 // test dependencies
 import * as smartexpress from '@pushrocks/smartexpress';
@@ -21,46 +10,64 @@ tap.test('setup test server', async () => {
   testServer = new smartexpress.Server({
     cors: false,
     forceSsl: false,
-    port: 2345
+    port: 2345,
   });
 
-  testServer.addRoute('/apiroute1', new smartexpress.Handler("GET", (req, res) => {
+  testServer.addRoute(
-    res.status(429);
+    '/apiroute1',
-    res.end();
+    new smartexpress.Handler('GET', (req, res) => {
-  }));
+      res.status(429);
+      res.end();
+    })
+  );
 
-  testServer.addRoute('/apiroute2', new smartexpress.Handler("GET", (req, res) => {
+  testServer.addRoute(
-    res.status(500);
+    '/apiroute2',
-    res.end();
+    new smartexpress.Handler('GET', (req, res) => {
-  }));
+      res.status(500);
+      res.end();
+    })
+  );
 
-  testServer.addRoute('/apiroute3', new smartexpress.Handler("GET", (req, res) => {
+  testServer.addRoute(
-    res.status(200);
+    '/apiroute3',
-    res.send({
+    new smartexpress.Handler('GET', (req, res) => {
-      hithere: 'hi'
+      res.status(200);
-    });
+      res.send({
-  }));
+        hithere: 'hi',
+      });
+    })
+  );
 
-  await testServer.start()
+  await testServer.start();
-})
+});
 
 tap.test('first test', async (tools) => {
-  const response = await (new webrequest.WebRequest()).request([
+  const response = await (await new webrequest.WebRequest().requestMultiEndpoint([
     'http://localhost:2345/apiroute1',
     'http://localhost:2345/apiroute2',
     'http://localhost:2345/apiroute4',
-    'http://localhost:2345/apiroute3'
+    'http://localhost:2345/apiroute3',
   ], {
     method: 'GET'
-  })
+  })).json();
 
-  console.log(response);
+  const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
 
-  expect(response).property('hithere').to.equal('hi');
+  console.log('response 1: ' + JSON.stringify(response));
+  console.log('response 2: ' + JSON.stringify(response2));
+
+  expect(response).toHaveProperty('hithere'); //.to.equal('hi');
+  expect(response2).toHaveProperty('hithere'); //.to.equal('hi');
+});
+
+tap.test('should cache response', async () => {
+  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.test('tear down server', async () => {
+tap.start();
-  testServer.stop();
-})
-
-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.5',
+  description: 'securely request from browsers'
+}

ts/index.ts

@@ -1,34 +1,149 @@
-import * as plugins from './webrequest.plugins';
+import * as plugins from './webrequest.plugins.js';
 
 /**
  * web request
  */
 export class WebRequest {
-  /**
+  private static polyfillStatusEvaluated = false;
-   * gets json
+  private static neededPolyfillsLoadedDeferred = plugins.smartpromise.defer();
-   */
+  public static async loadNeededPolyfills() {
-  async getJson(url: string | string[]) {}
+    if (this.polyfillStatusEvaluated) {
+      return this.neededPolyfillsLoadedDeferred.promise;
+    }
+    this.polyfillStatusEvaluated = true;
+    const smartenv = new plugins.smartenv.Smartenv();
+    if (!smartenv.isBrowser) {
+      this.polyfillStatusEvaluated = true;
+      const fetchMod = await smartenv.getSafeNodeModule('node-fetch');
+      globalThis.Response = fetchMod.Response;
+      globalThis.fetch = fetchMod.default;
+    }
+    this.neededPolyfillsLoadedDeferred.resolve();
+  }
+
+  public cacheStore = new plugins.webstore.WebStore({
+    dbName: 'webrequest',
+    storeName: 'webrequest',
+  });
+
+  constructor() {
+    WebRequest.loadNeededPolyfills();
+  }
+
+  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);
+    return responseResult;
+  }
 
   /**
    * postJson
    */
-  postJson() {}
+  public async postJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    const response: Response = await this.request(urlArg, {
+      body: plugins.smartjson.stringify(requestBody),
+      method: 'POST',
+    });
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
+  }
 
   /**
    * put js
    */
-  putJson() {}
+  public async putJson(urlArg: string, requestBody?: any, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    const response: Response = await this.request(urlArg, {
+      body: plugins.smartjson.stringify(requestBody),
+      method: 'PUT',
+    });
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
+  }
 
   /**
-   *
+   * put js
    */
-  async request(
+  public async deleteJson(urlArg: string, useStoreAsFallback: boolean = false) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    const response: Response = await this.request(urlArg, {
+      method: 'GET',
+    });
+    const responseText = await response.text();
+    const responseResult = plugins.smartjson.parse(responseText);
+    return responseResult;
+  }
+
+  public async request(
+    urlArg: string,
+    optionsArg: {
+      method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+      body?: any;
+      headers?: HeadersInit;
+      useCache?: boolean;
+      timeoutMs?: number;
+    }
+  ) {
+    await WebRequest.neededPolyfillsLoadedDeferred.promise;
+    const controller = new AbortController();
+    if (optionsArg.timeoutMs) {
+      plugins.smartdelay.delayFor(optionsArg.timeoutMs).then(() => {
+        controller.abort();
+      });
+    }
+    let cachedResponseDeferred = plugins.smartpromise.defer<Response>();
+    let cacheUsed = false;
+    if (optionsArg.useCache && this.cacheStore.check(urlArg)) {
+      const responseBuffer: ArrayBuffer = await this.cacheStore.get(urlArg)
+      cachedResponseDeferred.resolve(new Response(responseBuffer, {}));
+    } else {
+      cachedResponseDeferred.resolve(null);
+    }
+    const response: Response = await fetch(urlArg, {
+      signal: controller.signal,
+      method: optionsArg.method,
+      headers: {
+        'Content-Type': 'application/json',
+        ...(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 (!cacheUsed && optionsArg.useCache && response.status < 300) {
+      const buffer = await response.clone().arrayBuffer();
+      await this.cacheStore.set(urlArg, buffer);
+    }
+    console.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;
 
@@ -41,51 +156,53 @@ export class WebRequest {
 
     const requestHistory: string[] = []; // keep track of the request history
 
-    const doHistoryCheck = async ( // check history for a 
+    const doHistoryCheck = async (
+      // check history for a
       historyEntryTypeArg: string
     ) => {
       requestHistory.push(historyEntryTypeArg);
       if (historyEntryTypeArg === '429') {
-        console.log('got 429, so waiting a little bit.')
+        console.log('got 429, so waiting a little bit.');
-        await plugins.smartdelay.delayFor(
+        await plugins.smartdelay.delayFor(Math.floor(Math.random() * (2000 - 1000 + 1)) + 1000); // wait between 1 and 10 seconds
-          Math.floor(Math.random() * (2000 - 1000 +1)) + 1000
-        ); // wait between 1 and 10 seconds
       }
 
       let numOfHistoryType = 0;
       for (const entry of requestHistory) {
         if (entry === historyEntryTypeArg) numOfHistoryType++;
       }
-      if (numOfHistoryType > (2 * allUrls.length * usedUrlIndex)) {
+      if (numOfHistoryType > 2 * allUrls.length * usedUrlIndex) {
         usedUrlIndex++;
       }
     };
 
     // 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}`);
       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}`);
 
       if (response.status >= 200 && response.status < 300) {
         return response;
       } else {
+        // lets perform a history check to determine failed urls
         await doHistoryCheck(response.status.toString());
-        return await doRequest(allUrls[usedUrlIndex]);
+        // lets fire the request
+        const result = await doRequest(allUrls[usedUrlIndex]);
+        return result;
       }
     };
 
-    const finalResponse: Response = await doRequest(urlArg[usedUrlIndex]);
+    const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
-    console.log(finalResponse)
+    return finalResponse;
-    return JSON.parse(await finalResponse.text());
   }
 }

ts/webrequest.plugins.ts

@@ -1,5 +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 {
+export { smartdelay, smartenv, smartjson, smartpromise, webstore };
-  smartdelay
-}