2.0.9

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

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${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

@@ -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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

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

package.json

@@ -1,28 +1,42 @@
 {
   "name": "@pushrocks/webrequest",
-  "version": "1.0.7",
+  "version": "2.0.9",
   "private": false,
   "description": "securely request from browsers",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)",
+    "build": "(tsbuild --web && tsbundle npm)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.3",
-    "@gitzone/tstest": "^1.0.17",
-    "@pushrocks/smartexpress": "^2.0.4",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.12",
-    "node-fetch": "^2.3.0",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0"
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbundle": "^1.0.69",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/smartexpress": "^3.0.72",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.14",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2"
-  }
+    "@pushrocks/smartdelay": "^2.0.9",
+    "@pushrocks/smartenv": "^4.0.10",
+    "node-fetch": "^2.6.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

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.ts

@@ -1,16 +1,5 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as webrequest from '../ts/index';
-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';
@@ -24,43 +13,58 @@ tap.test('setup test server', async () => {
     port: 2345
   });
 
-  testServer.addRoute('/apiroute1', new smartexpress.Handler("GET", (req, res) => {
-    res.status(429);
-    res.end();
-  }));
+  testServer.addRoute(
+    '/apiroute1',
+    new smartexpress.Handler('GET', (req, res) => {
+      res.status(429);
+      res.end();
+    })
+  );
 
-  testServer.addRoute('/apiroute2', new smartexpress.Handler("GET", (req, res) => {
-    res.status(500);
-    res.end();
-  }));
+  testServer.addRoute(
+    '/apiroute2',
+    new smartexpress.Handler('GET', (req, res) => {
+      res.status(500);
+      res.end();
+    })
+  );
 
-  testServer.addRoute('/apiroute3', new smartexpress.Handler("GET", (req, res) => {
-    res.status(200);
-    res.send({
-      hithere: 'hi'
-    });
-  }));
+  testServer.addRoute(
+    '/apiroute3',
+    new smartexpress.Handler('GET', (req, res) => {
+      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([
+tap.test('first test', async tools => {
+  const response = await new webrequest.WebRequest().getJson([
     'http://localhost:2345/apiroute1',
     'http://localhost:2345/apiroute2',
     'http://localhost:2345/apiroute4',
     'http://localhost:2345/apiroute3'
-  ], {
-    method: 'GET'
-  })
+  ]);
+
+  const response2 = await new webrequest.WebRequest().getJson('http://localhost:2345/apiroute3');
 
   console.log(response);
+  console.log(response2);
 
-  expect(response).property('hithere').to.equal('hi');
-})
+  expect(response)
+    .property('hithere')
+    .to.equal('hi');
+  expect(response2)
+    .property('hithere')
+    .to.equal('hi');
+});
 
 tap.test('tear down server', async () => {
   testServer.stop();
-})
+});
 
-tap.start()
+tap.start();

ts/index.ts

@@ -4,31 +4,68 @@ import * as plugins from './webrequest.plugins';
  * web request
  */
 export class WebRequest {
-  /**
-   * gets json
-   */
-  async getJson(url: string | string[]) {}
+  private static polyfillsLoaded = false;
+  public static loadNeededPolyfills() {
+    const smartenv = new plugins.smartenv.Smartenv();
+    if (!smartenv.isBrowser && !this.polyfillsLoaded) {
+      this.polyfillsLoaded = true;
+      globalThis.fetch = smartenv.getSafeNodeModule('node-fetch');
+    }
+  }
+
+  constructor() {
+    WebRequest.loadNeededPolyfills();
+  }
+
+  public async getJson(urlArg: string | string[]) {
+    const response: Response = await this.request(urlArg, {
+      method: 'GET'
+    });
+    return response.json();
+  }
 
   /**
    * postJson
    */
-  postJson() {}
+  public async postJson(urlArg: string, requestBody?: any) {
+    const response: Response = await this.request(urlArg, {
+      body: JSON.stringify(requestBody),
+      method: 'POST'
+    });
+    return response.json();
+  }
 
   /**
    * put js
    */
-  putJson() {}
+  public async putJson(urlArg: string, requestBody?: any) {
+    const response: Response = await this.request(urlArg, {
+      body: JSON.stringify(requestBody),
+      method: 'PUT'
+    });
+    return response.json();
+  }
 
   /**
-   *
+   * put js
    */
-  async request(
+  public async deleteJson(urlArg: string) {
+    const response: Response = await this.request(urlArg, {
+      method: 'GET'
+    });
+    return response.json();
+  }
+
+  /**
+   * a fault tolerant request
+   */
+  public async request(
     urlArg: string | string[],
     optionsArg: {
       method: 'GET' | 'POST' | 'PUT' | 'DELETE';
       body?: any;
     }
-  ) {
+  ): Promise<Response> {
     let allUrls: string[];
     let usedUrlIndex = 0;
 
@@ -41,22 +78,21 @@ 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.')
-        await plugins.smartdelay.delayFor(
-          Math.floor(Math.random() * (2000 - 1000 +1)) + 1000
-        ); // wait between 1 and 10 seconds
+        console.log('got 429, so waiting a little bit.');
+        await plugins.smartdelay.delayFor(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++;
       }
     };
@@ -66,7 +102,7 @@ export class WebRequest {
       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: {
@@ -80,12 +116,13 @@ export class WebRequest {
         return response;
       } else {
         await doHistoryCheck(response.status.toString());
+        // tslint:disable-next-line: no-return-await
         return await doRequest(allUrls[usedUrlIndex]);
       }
     };
 
-    const finalResponse: Response = await doRequest(urlArg[usedUrlIndex]);
-    console.log(finalResponse)
-    return JSON.parse(await finalResponse.text());
+    const finalResponse: Response = await doRequest(allUrls[usedUrlIndex]);
+    console.log(finalResponse);
+    return finalResponse;
   }
 }

ts/webrequest.plugins.ts

@@ -1,5 +1,4 @@
 import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartenv from '@pushrocks/smartenv';
 
-export {
-  smartdelay
-}
+export { smartdelay, smartenv };