2.0.0

.gitignore

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

.gitlab-ci.yml

@@ -1,126 +1,122 @@
-# 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
 # ====================
-mirror:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-  - npmci git mirror
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+  allow_failure: true
 
-snyk:
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci command npm install -g snyk
+    - npmci npm prepare
     - 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 --only=dev
   tags:
-  - docker
+    - docker
-  - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci node install lts
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
-    
+testBuild:
-testSTABLE:
   stage: test
   script:
-  - npmci node install stable
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - 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 typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --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]
   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 stable 
+    - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command npm run buildDocs
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -128,15 +124,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
-  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
   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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,69 +0,0 @@
-# smartrequest
-
-dropin replacement for request
-
-## Availabililty
-
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartrequest)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartrequest)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartrequest)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartrequest/)
-
-## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartrequest/badges/master/build.svg)](https://GitLab.com/pushrocks/smartrequest/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartrequest/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartrequest.svg)](https://www.npmjs.com/package/smartrequest)
-[![Dependency Status](https://david-dm.org/pushrocks/smartrequest.svg)](https://david-dm.org/pushrocks/smartrequest)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartrequest/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartrequest/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartrequest/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartrequest)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
-
-```javascript
-import * as smartrequest from 'smartrequest'
-
-// simple post
-let options: smartrequest.ISmartRequestOptions = { // typed options
-    headers: {
-        "Content-Type": "application/json"
-        "Authorization": "Bearer token"
-    },
-    requestBody: {
-        key1: 'value1',
-        key2: 3
-    }
-}
-
-smartrequest.post('https://example.com', options).then(res => {
-    console.log(res.status)
-    console.log(res.body) // if json, body will be parsed automatically
-}).catch(err => {
-    console.log(err)
-})
-
-// also available
-smartrequest.get(...)
-smartrequest.put(...)
-smartrequest.del(...)
-
-// streaming
-smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
-    console.log(res.status)
-    res.on('data', data => {
-        // do something with the data chunk here
-    }
-    res.on('end', () => {
-        // do something when things have ended
-    })
-})
-```
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

npmextra.json

@@ -1,11 +1,20 @@
 {
   "npmts": {
-    "coverageTreshold": 60
+    "coverageTreshold": 50
   },
   "npmci": {
-    "npmGlobalTools": [
+    "npmGlobalTools": [],
-      "npmts"
-    ],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartrequest",
+      "description": "dropin replacement for request",
+      "npmPackagename": "@pushrocks/smartrequest",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,15 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.0.18",
+  "version": "2.0.0",
   "private": false,
   "description": "dropin replacement for request",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "tsrun test/test.ts",
+    "test": "(tstest test/ --web)",
-    "build": "(npmts)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -23,11 +25,33 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
   "dependencies": {
-    "@pushrocks/smartpromise": "^2.0.5"
+    "@pushrocks/smartpromise": "^3.1.7",
+    "@pushrocks/smarturl": "^3.0.2",
+    "agentkeepalive": "^4.2.1",
+    "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.1.9",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@pushrocks/tapbundle": "^3.0.1",
+    "@gitzone/tsrun": "^1.2.37",
-    "@types/node": "^10.5.2"
+    "@gitzone/tstest": "^1.0.72",
-  }
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.2",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "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,96 @@
+# @pushrocks/smartrequest
+dropin replacement for request
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
+* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartrequest/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartrequest)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartrequest)](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/smartrequest)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartrequest)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartrequest)](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 instellisense.
+
+### Features
+
+- supports http
+- supports https
+- supports unix socks
+- supports formData
+- supports file uploads
+- supports best practice keepAlive
+- dedicated functions for working with JSON request/response cycles
+- written in TypeScript
+- continuously updated
+- uses node native http and https modules
+- used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
+- commercial support available at [https://lossless.support](https://lossless.support)
+
+> note: smartrequest uses the **native** node http/https modules under the hood (not the bloated one from npm)
+
+```javascript
+import * as smartrequest from 'smartrequest'
+
+// simple post
+const options: smartrequest.ISmartRequestOptions = { // typed options
+    headers: {
+        "Content-Type": "application/json"
+        "Authorization": "Bearer token"
+    },
+    requestBody: JSON.stringify({
+        key1: 'value1',
+        key2: 3
+    })
+}
+
+smartrequest.request('https://example.com', options).then(res => {
+    console.log(res.status)
+    console.log(res.body) // if json, body will be parsed automatically
+}).catch(err => {
+    console.log(err)
+})
+
+// dedicated JSON methods are available:
+smartrequest.getJson(...)
+smartrequest.postJson(...)
+smartrequest.putJson(...)
+smartrequest.delJson(...)
+
+// streaming
+smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
+    console.log(res.status)
+    res.on('data', data => {
+        // do something with the data chunk here
+    }
+    res.on('end', () => {
+        // do something when things have ended
+    })
+})
+```
+
+## 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,29 +1,38 @@
-import { tap, expect } from '@pushrocks/tapbundle';
+import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
 
-import * as smartrequest from '../ts/index';
+import * as smartrequest from '../ts/index.js';
 
 tap.test('should request a html document over https', async () => {
-  await expect(smartrequest.getJson('https://encrypted.google.com/'))
+  await expectAsync(smartrequest.getJson('https://encrypted.google.com/')).toHaveProperty('body');
-    .to.eventually.property('body')
-    .be.a('string');
 });
 
 tap.test('should request a JSON document over https', async () => {
-  await expect(smartrequest.getJson('https://jsonplaceholder.typicode.com/posts/1'))
+  await expectAsync(smartrequest.getJson('https://jsonplaceholder.typicode.com/posts/1'))
-    .to.eventually.property('body')
+    .property('body')
     .property('id')
-    .equal(1);
+    .toEqual(1);
 });
 
-tap.test('should post a JSON document over http', async () => {
+tap.skip.test('should post a JSON document over http', async () => {
-  await expect(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
+  await expectAsync(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
-    .to.eventually.property('body')
+    .property('body')
     .property('md5')
-    .equal('fa4c6baa0812e5b5c80ed8885e55a8a6');
+    .toEqual('fa4c6baa0812e5b5c80ed8885e55a8a6');
 });
 
-tap.test('should deal with unix socks', async () => {
+tap.skip.test('should deal with unix socks', async () => {
-  await expect(smartrequest.request('http://unix:/var/run/docker.sock:/containers'))
+  const socketResponse = await smartrequest.request(
+    'http://unix:/var/run/docker.sock:/containers/json',
+    {
+      headers: {
+        'Content-Type': 'application/json',
+        Host: 'docker.sock',
+      },
+    }
+  );
+  console.log(socketResponse.body);
 });
 
+tap.skip.test('should correctly upload a file using formData', async () => {});
+
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartrequest',
+  version: '2.0.0',
+  description: 'dropin replacement for request'
+}

ts/index.ts

@@ -1,5 +1,7 @@
-export { request, extendedIncomingMessage } from './smartrequest.request';
+export { request } from './smartrequest.request.js';
-export { ISmartRequestOptions } from './smartrequest.interfaces';
+export type { IExtendedIncomingMessage } from './smartrequest.request.js';
+export type { ISmartRequestOptions } from './smartrequest.interfaces.js';
 
-export * from './smartrequest.jsonrest';
+export * from './smartrequest.jsonrest.js';
-export * from './smartrequest.binaryrest';
+export * from './smartrequest.binaryrest.js';
+export * from './smartrequest.formdata.js';

ts/smartrequest.binaryrest.ts

@@ -1,27 +1,31 @@
 // this file implements methods to get and post binary data.
-import * as interfaces from './smartrequest.interfaces';
+import * as interfaces from './smartrequest.interfaces.js';
-import { request } from './smartrequest.request';
+import { request } from './smartrequest.request.js';
 
-import * as plugins from './smartrequest.plugins';
+import * as plugins from './smartrequest.plugins.js';
 
 export const getBinary = async (
   domainArg: string,
   optionsArg: interfaces.ISmartRequestOptions = {}
 ) => {
+  optionsArg = {
+    ...optionsArg,
+    autoJsonParse: false,
+  };
   const done = plugins.smartpromise.defer();
   const response = await request(domainArg, optionsArg, true);
-  const data = [];
+  const data: Array<Buffer> = [];
 
   response
-    .on('data', function(chunk) {
+    .on('data', function (chunk: Buffer) {
       data.push(chunk);
     })
-    .on('end', function() {
+    .on('end', function () {
       //at this point data is an array of Buffers
       //so Buffer.concat() can make us a new Buffer
       //of all of them together
       const buffer = Buffer.concat(data);
-      response.body = buffer.toString('binary');
+      response.body = buffer;
       done.resolve();
     });
   await done.promise;

ts/smartrequest.formdata.ts

@@ -0,0 +1,99 @@
+import * as plugins from './smartrequest.plugins.js';
+import * as interfaces from './smartrequest.interfaces.js';
+import { request } from './smartrequest.request.js';
+
+/**
+ * the interfae for FormFieldData
+ */
+export interface IFormField {
+  name: string;
+  type: 'string' | 'filePath' | 'Buffer';
+  payload: string | Buffer;
+  fileName?: string;
+  contentType?: string;
+}
+
+const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
+  switch (formDataField.type) {
+    case 'string':
+      formDataArg.append(formDataField.name, formDataField.payload);
+      break;
+    case 'filePath':
+      if (typeof formDataField.payload !== 'string') {
+        throw new Error(
+          `Payload for key ${
+            formDataField.name
+          } must be of type string. Got ${typeof formDataField.payload} instead.`
+        );
+      }
+      const fileData = plugins.fs.readFileSync(
+        plugins.path.join(process.cwd(), formDataField.payload)
+      );
+      formDataArg.append('file', fileData, {
+        filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
+        contentType: 'application/pdf',
+      });
+      break;
+    case 'Buffer':
+      formDataArg.append(formDataField.name, formDataField.payload, {
+        filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
+        contentType: formDataField.contentType ? formDataField.contentType : 'application/pdf',
+      });
+      break;
+  }
+};
+
+export const postFormData = async (
+  urlArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {},
+  payloadArg: IFormField[]
+) => {
+  const form = new plugins.formData();
+  for (const formField of payloadArg) {
+    await appendFormField(form, formField);
+  }
+  const requestOptions = {
+    ...optionsArg,
+    method: 'POST',
+    headers: {
+      ...optionsArg.headers,
+      ...form.getHeaders(),
+    },
+    requestBody: form,
+  };
+
+  // lets fire the actual request for sending the formdata
+  const response = await request(urlArg, requestOptions);
+  return response;
+};
+
+export const postFormDataUrlEncoded = async (
+  urlArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {},
+  payloadArg: { key: string; content: string }[]
+) => {
+  let resultString = '';
+
+  for (const keyContentPair of payloadArg) {
+    if (resultString) {
+      resultString += '&';
+    }
+    resultString += `${encodeURIComponent(keyContentPair.key)}=${encodeURIComponent(
+      keyContentPair.content
+    )}`;
+  }
+
+  const requestOptions: interfaces.ISmartRequestOptions = {
+    ...optionsArg,
+    method: 'POST',
+    headers: {
+      ...optionsArg.headers,
+      'content-type': 'application/x-www-form-urlencoded',
+    },
+    requestBody: resultString,
+  };
+
+  // lets fire the actual request for sending the formdata
+  const response = await request(urlArg, requestOptions);
+  return response;
+};

ts/smartrequest.interfaces.ts

@@ -1,6 +1,9 @@
-import * as plugins from './smartrequest.plugins';
+import * as plugins from './smartrequest.plugins.js';
 import * as https from 'https';
 
 export interface ISmartRequestOptions extends https.RequestOptions {
+  keepAlive?: boolean;
   requestBody?: any;
+  autoJsonParse?: boolean;
+  queryParams?: { [key: string]: string };
 }

ts/smartrequest.jsonrest.ts

@@ -1,7 +1,7 @@
 // This file implements methods to get and post JSON in a simple manner.
 
-import * as interfaces from './smartrequest.interfaces';
+import * as interfaces from './smartrequest.interfaces.js';
-import { request } from './smartrequest.request';
+import { request } from './smartrequest.request.js';
 
 /**
  * gets Json and puts the right headers + handles response aggregation
@@ -14,7 +14,7 @@ export const getJson = async (
 ) => {
   optionsArg.method = 'GET';
   optionsArg.headers = {
-    ...optionsArg.headers
+    ...optionsArg.headers,
   };
   let response = await request(domainArg, optionsArg);
   return response;
@@ -37,7 +37,7 @@ export const postJson = async (
     // assign the right Content-Type, leaving all other headers in place
     optionsArg.headers = {
       ...optionsArg.headers,
-      'Content-Type': 'application/json'
+      'Content-Type': 'application/json',
     };
   }
   let response = await request(domainArg, optionsArg);

ts/smartrequest.plugins.ts

@@ -1,7 +1,19 @@
-import * as url from 'url';
+// node native scope
+import * as fs from 'fs';
 import * as http from 'http';
 import * as https from 'https';
+import * as path from 'path';
 
+export { http, https, fs, path };
+
+// pushrocks scope
 import * as smartpromise from '@pushrocks/smartpromise';
+import * as smarturl from '@pushrocks/smarturl';
 
-export { url, http, https, smartpromise };
+export { smartpromise, smarturl };
+
+// third party scope
+import agentkeepalive from 'agentkeepalive';
+import formData from 'form-data';
+
+export { agentkeepalive, formData };

ts/smartrequest.request.ts

@@ -1,85 +1,190 @@
-import * as https from 'https';
+import * as plugins from './smartrequest.plugins.js';
-import * as plugins from './smartrequest.plugins';
+import * as interfaces from './smartrequest.interfaces.js';
-import * as interfaces from './smartrequest.interfaces';
 
 import { IncomingMessage } from 'http';
 
-export interface extendedIncomingMessage extends IncomingMessage {
+export interface IExtendedIncomingMessage extends IncomingMessage {
   body: any;
 }
 
-let buildResponse = (incomingMessageArg: IncomingMessage): Promise<extendedIncomingMessage> => {
+const buildUtf8Response = (
-  let done = plugins.smartpromise.defer<extendedIncomingMessage>();
+  incomingMessageArg: IncomingMessage,
+  autoJsonParse = true
+): Promise<IExtendedIncomingMessage> => {
+  const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
   // Continuously update stream with data
   let body = '';
-  incomingMessageArg.on('data', function(chunkArg) {
+  incomingMessageArg.on('data', (chunkArg) => {
     body += chunkArg;
   });
 
-  incomingMessageArg.on('end', function() {
+  incomingMessageArg.on('end', () => {
-    try {
+    if (autoJsonParse) {
-      (incomingMessageArg as extendedIncomingMessage).body = JSON.parse(body);
+      try {
-    } catch (err) {
+        (incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
-      (incomingMessageArg as extendedIncomingMessage).body = body;
+      } catch (err) {
+        (incomingMessageArg as IExtendedIncomingMessage).body = body;
+      }
+    } else {
+      (incomingMessageArg as IExtendedIncomingMessage).body = body;
     }
-    done.resolve(incomingMessageArg as extendedIncomingMessage);
+    done.resolve(incomingMessageArg as IExtendedIncomingMessage);
   });
   return done.promise;
 };
 
-export let request = async (
+/**
-  domainArg: string,
+ * determine wether a url is a unix sock
-  optionsArg: interfaces.ISmartRequestOptions = {},
+ * @param urlArg
-  streamArg: boolean = false
+ */
-): Promise<extendedIncomingMessage> => {
+const testForUnixSock = (urlArg: string): boolean => {
-  let done = plugins.smartpromise.defer<any>();
+  const unixRegex = /^(http:\/\/|https:\/\/|)unix:/;
-  let parsedUrl: plugins.url.Url;
+  return unixRegex.test(urlArg);
-  if (domainArg) {
+};
-    parsedUrl = plugins.url.parse(domainArg);
+
-    optionsArg.hostname = parsedUrl.hostname;
+/**
-    if (parsedUrl.port) {
+ * determine socketPath and path for unixsock
-      optionsArg.port = parseInt(parsedUrl.port);
+ */
-    }
+const parseSocketPathAndRoute = (stringToParseArg: string) => {
-    optionsArg.path = parsedUrl.path;
+  const parseRegex = /(.*):(.*)/;
-  }
+  const result = parseRegex.exec(stringToParseArg);
-  if (!parsedUrl || parsedUrl.protocol === 'https:') {
+  return {
-    let request = plugins.https.request(optionsArg, response => {
+    socketPath: result[1],
-      if (streamArg) {
+    path: result[2],
-        done.resolve(response);
+  };
-      } else {
+};
-        buildResponse(response).then(done.resolve);
+
-      }
+/**
-    });
+ * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
-    if (optionsArg.requestBody) {
+ */
-      if (typeof optionsArg.requestBody !== 'string') {
+const httpAgent = new plugins.agentkeepalive({
-        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
+  keepAlive: true,
-      }
+  freeSocketTimeout: 4000,
-      request.write(optionsArg.requestBody);
+  maxFreeSockets: 1,
-    }
+  maxSockets: 100,
-    request.on('error', e => {
+  maxTotalSockets: 1000,
-      console.error(e);
+});
-    });
+
-    request.end();
+/**
-  } else if (parsedUrl.protocol === 'http:') {
+ * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
-    let request = plugins.http.request(optionsArg, response => {
+ */
-      if (streamArg) {
+const httpAgentKeepAliveFalse = new plugins.agentkeepalive({
-        done.resolve(response);
+  maxFreeSockets: 0,
-      } else {
+  keepAlive: false,
-        buildResponse(response).then(done.resolve);
+  keepAliveMsecs: 0,
-      }
+});
-    });
+
-    if (optionsArg.requestBody) {
+/**
-      if (typeof optionsArg.requestBody !== 'string') {
+ * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
-        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
+ */
-      }
+const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
-      request.write(optionsArg.requestBody);
+
-    }
+/**
-    request.on('error', e => {
+ * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
-      console.error(e);
+ */
-    });
+const httpsAgentKeepAliveFalse = new plugins.https.Agent({
-    request.end();
+  maxFreeSockets: 0,
-  } else {
+  keepAlive: false,
-    throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
+  keepAliveMsecs: 0,
-  }
+});
-  return done.promise;
+
+export let request = async (
+  urlArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {},
+  responseStreamArg: boolean = false,
+  requestDataFunc: (req: plugins.http.ClientRequest) => void = null
+): Promise<IExtendedIncomingMessage> => {
+  const done = plugins.smartpromise.defer<any>();
+
+  // merge options
+  const defaultOptions: interfaces.ISmartRequestOptions = {
+    // agent: agent,
+    autoJsonParse: true,
+    keepAlive: true,
+  };
+
+  optionsArg = {
+    ...defaultOptions,
+    ...optionsArg,
+  };
+
+  // parse url
+  const parsedUrl = plugins.smarturl.Smarturl.createFromUrl(urlArg, {
+    searchParams: optionsArg.queryParams || {},
+  });
+  optionsArg.hostname = parsedUrl.hostname;
+  if (parsedUrl.port) {
+    optionsArg.port = parseInt(parsedUrl.port, 10);
+  }
+  optionsArg.path = parsedUrl.path;
+  optionsArg.queryParams = parsedUrl.searchParams;
+
+  // determine if unixsock
+  if (testForUnixSock(urlArg)) {
+    const detailedUnixPath = parseSocketPathAndRoute(optionsArg.path);
+    optionsArg.socketPath = detailedUnixPath.socketPath;
+    optionsArg.path = detailedUnixPath.path;
+  }
+
+  // TODO: support tcp sockets
+
+  // lets determine the request module to use
+  const requestModule = (() => {
+    switch (true) {
+      case parsedUrl.protocol === 'https' && optionsArg.keepAlive:
+        optionsArg.agent = httpsAgent;
+        return plugins.https;
+      case parsedUrl.protocol === 'https' && !optionsArg.keepAlive:
+        optionsArg.agent = httpsAgentKeepAliveFalse;
+        return plugins.https;
+      case parsedUrl.protocol === 'http' && optionsArg.keepAlive:
+        optionsArg.agent = httpAgent;
+        return plugins.http;
+      case parsedUrl.protocol === 'http' && !optionsArg.keepAlive:
+        optionsArg.agent = httpAgentKeepAliveFalse;
+        return plugins.http;
+    }
+  })() as typeof plugins.https;
+
+  if (!requestModule) {
+    console.error(`The request to ${urlArg} is missing a viable protocol. Must be http or https`);
+    return;
+  }
+
+  // lets perform the actual request
+  const requestToFire = requestModule.request(optionsArg, async (response) => {
+    if (responseStreamArg) {
+      done.resolve(response);
+    } else {
+      const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
+      done.resolve(builtResponse);
+    }
+  });
+
+  // lets write the requestBody
+  if (optionsArg.requestBody) {
+    if (optionsArg.requestBody instanceof plugins.formData) {
+      optionsArg.requestBody.pipe(requestToFire).on('finish', (event: any) => {
+        requestToFire.end();
+      });
+    } else {
+      if (typeof optionsArg.requestBody !== 'string') {
+        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
+      }
+      requestToFire.write(optionsArg.requestBody);
+      requestToFire.end();
+    }
+  } else if (requestDataFunc) {
+    requestDataFunc(requestToFire);
+  } else {
+    requestToFire.end();
+  }
+
+  // lets handle an error
+  requestToFire.on('error', (e) => {
+    console.error(e);
+  });
+
+  const result = await done.promise;
+  return result;
 };

tsconfig.json

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

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}