2.0.5

.gitlab-ci.yml

@@ -12,20 +12,12 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
@@ -36,6 +28,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@@ -96,10 +89,9 @@ codequality:
   only:
     - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -119,11 +111,10 @@ 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"
     }
   ]
 }

npmextra.json

@@ -12,7 +12,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartrequest",
-      "shortDescription": "dropin replacement for request",
+      "description": "dropin replacement for request",
       "npmPackagename": "@pushrocks/smartrequest",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,15 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.48",
+  "version": "2.0.5",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/ --web)",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -23,18 +25,17 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "agentkeepalive": "^4.1.3",
+    "@pushrocks/smarturl": "^3.0.2",
-    "form-data": "^3.0.0"
+    "agentkeepalive": "^4.2.1",
+    "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tsrun": "^1.2.37",
-    "@gitzone/tstest": "^1.0.44",
+    "@gitzone/tstest": "^1.0.72",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^14.6.0",
+    "@types/node": "^18.6.2"
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -48,7 +48,7 @@ Use TypeScript for best in class instellisense.
 import * as smartrequest from 'smartrequest'
 
 // simple post
-let options: smartrequest.ISmartRequestOptions = { // typed options
+const options: smartrequest.ISmartRequestOptions = { // typed options
     headers: {
         "Content-Type": "application/json"
         "Authorization": "Bearer token"
@@ -66,7 +66,7 @@ smartrequest.request('https://example.com', options).then(res => {
     console.log(err)
 })
 
-// dedicated JSON metods are available:
+// dedicated JSON methods are available:
 smartrequest.getJson(...)
 smartrequest.postJson(...)
 smartrequest.putJson(...)

test/test.ts

@@ -1,31 +1,23 @@
-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');
-  await expect(smartrequest.getJson('https://encrypted.google.com/'))
-    .to.eventually.property('body')
-    .be.a('string');
-  await expect(smartrequest.getJson('https://encrypted.google.com/'))
-    .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.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.skip.test('should deal with unix socks', async () => {

ts/00_commitinfo_data.ts

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

ts/index.ts

@@ -1,6 +1,7 @@
-export { request, IExtendedIncomingMessage } 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';
+export * from './smartrequest.formdata.js';

ts/smartrequest.binaryrest.ts

@@ -1,8 +1,8 @@
 // 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,
@@ -14,10 +14,10 @@ export const getBinary = async (
   };
   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 () {

ts/smartrequest.formdata.ts

@@ -1,6 +1,6 @@
-import * as plugins from './smartrequest.plugins';
+import * as plugins from './smartrequest.plugins.js';
-import * as interfaces from './smartrequest.interfaces';
+import * as interfaces from './smartrequest.interfaces.js';
-import { request } from './smartrequest.request';
+import { request } from './smartrequest.request.js';
 
 /**
  * the interfae for FormFieldData
@@ -66,3 +66,34 @@ export const postFormData = async (
   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,8 +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

ts/smartrequest.plugins.ts

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

ts/smartrequest.request.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartrequest.plugins';
+import * as plugins from './smartrequest.plugins.js';
-import * as interfaces from './smartrequest.interfaces';
+import * as interfaces from './smartrequest.interfaces.js';
 
 import { IncomingMessage } from 'http';
 
@@ -57,33 +57,36 @@ const parseSocketPathAndRoute = (stringToParseArg: string) => {
 /**
  * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
-const httpAgent = new plugins.agentkeepalive.default();
+const httpAgent = new plugins.agentkeepalive({
+  keepAlive: true,
+  maxFreeSockets: 10,
+});
 
 /**
  * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
-const httpAgentKeepAliveFalse = new plugins.http.Agent({
+const httpAgentKeepAliveFalse = new plugins.https.Agent({
-  maxFreeSockets: 0,
+  keepAlive: false
-  keepAlive: false,
-  keepAliveMsecs: 0,
 });
 
 /**
  * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
-const httpsAgent = new plugins.agentkeepalive.HttpsAgent();
+const httpsAgent = new plugins.agentkeepalive.HttpsAgent({
+  keepAlive: true,
+  maxFreeSockets: 10,
+});
 
 /**
  * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
  */
-const httpsAgentKeepAliveFalse = new plugins.https.Agent({
+const httpsAgentKeepAliveFalse = new plugins.agentkeepalive.HttpsAgent({
   maxFreeSockets: 0,
-  keepAlive: false,
+  keepAlive: false
-  keepAliveMsecs: 0,
 });
 
 export let request = async (
-  domainArg: string,
+  urlArg: string,
   optionsArg: interfaces.ISmartRequestOptions = {},
   responseStreamArg: boolean = false,
   requestDataFunc: (req: plugins.http.ClientRequest) => void = null
@@ -103,15 +106,18 @@ export let request = async (
   };
 
   // parse url
-  const parsedUrl = plugins.url.parse(domainArg);
+  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(domainArg)) {
+  if (testForUnixSock(urlArg)) {
     const detailedUnixPath = parseSocketPathAndRoute(optionsArg.path);
     optionsArg.socketPath = detailedUnixPath.socketPath;
     optionsArg.path = detailedUnixPath.path;
@@ -122,21 +128,26 @@ export let request = async (
   // lets determine the request module to use
   const requestModule = (() => {
     switch (true) {
-      case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
+      case parsedUrl.protocol === 'https' && optionsArg.keepAlive:
         optionsArg.agent = httpsAgent;
         return plugins.https;
-      case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
+      case parsedUrl.protocol === 'https' && !optionsArg.keepAlive:
         optionsArg.agent = httpsAgentKeepAliveFalse;
         return plugins.https;
-      case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
+      case parsedUrl.protocol === 'http' && optionsArg.keepAlive:
         optionsArg.agent = httpAgent;
         return plugins.http;
-      case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
+      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) {
@@ -150,7 +161,7 @@ export let request = async (
   // lets write the requestBody
   if (optionsArg.requestBody) {
     if (optionsArg.requestBody instanceof plugins.formData) {
-      optionsArg.requestBody.pipe(requestToFire).on('finish', (event) => {
+      optionsArg.requestBody.pipe(requestToFire).on('finish', (event: any) => {
         requestToFire.end();
       });
     } else {

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"
-}