2.0.23

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.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,59 +1,128 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
-- release
-- trigger
-- pages
+  - security
+  - test
+  - release
+  - metadata
 
-testLEGACY:
-  stage: test
+before_script:
+  - npm install -g @shipzone/npmci
+
+# ====================
+# security stage
+# ====================
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
-    - npmci test legacy
+    - 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
   allow_failure: true
 
-testLTS:
-  stage: test
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
-    - npmci test lts
+    - 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
-    
-testSTABLE:
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test stable
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
 
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  only:
+    - tags
+  script:
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --publish gitlab
+    - npmci node install stable 
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command npm run buildDocs
+  tags:
+    - lossless
+    - docker
+    - notpriv
   only:
     - tags
   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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,66 +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)

changelog.md

@@ -0,0 +1,62 @@
+# Changelog
+
+## 2024-11-06 - 2.0.23 - fix(core)
+Enhance type safety for response in binary requests
+
+- Updated the dependency versions in package.json to their latest versions.
+- Improved type inference for the response body in getBinary method of smartrequest.binaryrest.ts.
+- Introduced generic typing to IExtendedIncomingMessage interface for better type safety.
+
+## 2024-05-29 - 2.0.22 - Documentation
+update description
+
+## 2024-04-01 - 2.0.21 - Configuration
+Updated configuration files
+
+- Updated `tsconfig`
+- Updated `npmextra.json`: githost
+
+## 2023-07-10 - 2.0.15 - Structure
+Refactored the organization structure
+
+- Switched to a new organization scheme
+
+## 2022-07-29 - 1.1.57 to 2.0.0 - Major Update
+Significant changes and improvements leading to a major version update
+
+- **BREAKING CHANGE**: Switched the core to use ECMAScript modules (ESM)
+
+## 2018-08-14 - 1.1.12 to 1.1.13 - Functional Enhancements
+Enhanced request capabilities and removed unnecessary dependencies
+
+- Fixed request module to allow sending strings
+- Removed CI dependencies
+
+## 2018-07-19 - 1.1.1 to 1.1.11 - Various Fixes and Improvements
+Improvements and fixes across various components
+
+- Added formData capability
+- Corrected path resolution to use current working directory (CWD)
+- Improved formData handling
+- Included correct headers
+- Updated request ending method
+
+## 2018-06-19 - 1.0.14 - Structural Fix
+Resolved conflicts with file extensions
+
+- Changed `.json.ts` to `.jsonrest.ts` to avoid conflicts
+
+## 2018-06-13 - 1.0.8 to 1.0.10 - Core Updates
+Ensured binary handling compliance
+
+- Enhanced core to uphold latest standards
+- Correct binary file handling response
+- Fix for handling and returning binary responses
+
+## 2017-06-09 - 1.0.4 to 1.0.6 - Infrastructure and Type Improvements
+Types and infrastructure updates
+
+- Improved types
+- Removed need for content type on post requests
+- Updated for new infrastructure
+

dist/index.d.ts

@@ -1,7 +0,0 @@
-import * as interfaces from './smartrequest.interfaces';
-export { request } from './smartrequest.request';
-export { ISmartRequestOptions } from './smartrequest.interfaces';
-export declare let get: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<{}>;
-export declare let post: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<{}>;
-export declare let put: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<{}>;
-export declare let del: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<{}>;

dist/index.js

@@ -1,33 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-const smartrequest_request_1 = require("./smartrequest.request");
-var smartrequest_request_2 = require("./smartrequest.request");
-exports.request = smartrequest_request_2.request;
-exports.get = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'GET';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-exports.post = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'POST';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-exports.put = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'PUT';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-exports.del = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'DELETE';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFLQSxpRUFBZ0Q7QUFHaEQsK0RBQWdEO0FBQXZDLHlDQUFBLE9BQU8sQ0FBQTtBQUdMLFFBQUEsR0FBRyxHQUFHLENBQU8sU0FBaUIsRUFBRSxhQUE4QyxFQUFFO0lBQ3ZGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFBO0lBQ3pCLElBQUksUUFBUSxHQUFHLE1BQU0sOEJBQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUE7SUFDbkQsTUFBTSxDQUFDLFFBQVEsQ0FBQTtBQUNuQixDQUFDLENBQUEsQ0FBQTtBQUVVLFFBQUEsSUFBSSxHQUFHLENBQU8sU0FBaUIsRUFBRSxhQUE4QyxFQUFFO0lBQ3hGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFBO0lBQzFCLElBQUksUUFBUSxHQUFHLE1BQU0sOEJBQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUE7SUFDbkQsTUFBTSxDQUFDLFFBQVEsQ0FBQTtBQUNuQixDQUFDLENBQUEsQ0FBQTtBQUVVLFFBQUEsR0FBRyxHQUFHLENBQU8sU0FBaUIsRUFBRSxhQUE4QyxFQUFFO0lBQ3ZGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFBO0lBQ3pCLElBQUksUUFBUSxHQUFHLE1BQU0sOEJBQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUE7SUFDbkQsTUFBTSxDQUFDLFFBQVEsQ0FBQTtBQUNuQixDQUFDLENBQUEsQ0FBQTtBQUVVLFFBQUEsR0FBRyxHQUFHLENBQU8sU0FBaUIsRUFBRSxhQUE4QyxFQUFFO0lBQ3ZGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsUUFBUSxDQUFBO0lBQzVCLElBQUksUUFBUSxHQUFHLE1BQU0sOEJBQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUE7SUFDbkQsTUFBTSxDQUFDLFFBQVEsQ0FBQTtBQUNuQixDQUFDLENBQUEsQ0FBQSJ9

dist/smartrequest.interfaces.d.ts

@@ -1,4 +0,0 @@
-import * as https from 'https';
-export interface ISmartRequestOptions extends https.RequestOptions {
-    requestBody?: any;
-}

dist/smartrequest.interfaces.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRyZXF1ZXN0LmludGVyZmFjZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJlcXVlc3QuaW50ZXJmYWNlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

dist/smartrequest.plugins.d.ts

@@ -1,6 +0,0 @@
-import 'typings-global';
-import * as url from 'url';
-import * as http from 'http';
-import * as https from 'https';
-import * as q from 'smartq';
-export { url, http, https, q };

dist/smartrequest.plugins.js

@@ -1,11 +0,0 @@
-"use strict";
-require("typings-global");
-const url = require("url");
-exports.url = url;
-const http = require("http");
-exports.http = http;
-const https = require("https");
-exports.https = https;
-const q = require("smartq");
-exports.q = q;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRyZXF1ZXN0LnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJlcXVlc3QucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLDJCQUEwQjtBQU90QixrQkFBRztBQU5QLDZCQUE0QjtBQU94QixvQkFBSTtBQU5SLCtCQUE4QjtBQU8xQixzQkFBSztBQUxULDRCQUEyQjtBQU12QixjQUFDIn0=

dist/smartrequest.request.d.ts

@@ -1,2 +0,0 @@
-import * as interfaces from './smartrequest.interfaces';
-export declare let request: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions, streamArg?: boolean) => Promise<{}>;

dist/smartrequest.request.js

@@ -1,85 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-const plugins = require("./smartrequest.plugins");
-let buildResponse = (responseArg) => {
-    let done = plugins.q.defer();
-    // Continuously update stream with data
-    let body = '';
-    responseArg.on('data', function (chunkArg) {
-        body += chunkArg;
-    });
-    responseArg.on('end', function () {
-        try {
-            responseArg.body = JSON.parse(body);
-        }
-        catch (err) {
-            responseArg.body = body;
-        }
-        done.resolve(responseArg);
-    });
-    return done.promise;
-};
-exports.request = (domainArg, optionsArg = {}, streamArg = false) => __awaiter(this, void 0, void 0, function* () {
-    let done = plugins.q.defer();
-    let parsedUrl;
-    if (domainArg) {
-        parsedUrl = plugins.url.parse(domainArg);
-        optionsArg.hostname = parsedUrl.hostname;
-        if (parsedUrl.port) {
-            optionsArg.port = parseInt(parsedUrl.port);
-        }
-        optionsArg.path = parsedUrl.path;
-    }
-    if (!parsedUrl || parsedUrl.protocol === 'https:') {
-        let request = plugins.https.request(optionsArg, response => {
-            if (streamArg) {
-                done.resolve(response);
-            }
-            else {
-                buildResponse(response).then(done.resolve);
-            }
-        });
-        if (optionsArg.requestBody) {
-            if (typeof optionsArg.requestBody !== 'string') {
-                optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-            }
-            request.write(optionsArg.requestBody);
-        }
-        request.on('error', (e) => {
-            console.error(e);
-        });
-        request.end();
-    }
-    else if (parsedUrl.protocol === 'http:') {
-        let request = plugins.http.request(optionsArg, response => {
-            if (streamArg) {
-                done.resolve(response);
-            }
-            else {
-                buildResponse(response).then(done.resolve);
-            }
-        });
-        if (optionsArg.requestBody) {
-            if (typeof optionsArg.requestBody !== 'string') {
-                optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-            }
-            request.write(optionsArg.requestBody);
-        }
-        request.on('error', (e) => {
-            console.error(e);
-        });
-        request.end();
-    }
-    else {
-        throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
-    }
-    return done.promise;
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRyZXF1ZXN0LnJlcXVlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJlcXVlc3QucmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFDQSxrREFBaUQ7QUFHakQsSUFBSSxhQUFhLEdBQUcsQ0FBQyxXQUFXO0lBQzVCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7SUFDNUIsdUNBQXVDO0lBQ3ZDLElBQUksSUFBSSxHQUFHLEVBQUUsQ0FBQztJQUNkLFdBQVcsQ0FBQyxFQUFFLENBQUMsTUFBTSxFQUFFLFVBQVUsUUFBUTtRQUNyQyxJQUFJLElBQUksUUFBUSxDQUFDO0lBQ3JCLENBQUMsQ0FBQyxDQUFDO0lBQ0gsV0FBVyxDQUFDLEVBQUUsQ0FBQyxLQUFLLEVBQUU7UUFDbEIsSUFBSSxDQUFDO1lBQ0QsV0FBVyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3hDLENBQUM7UUFBQyxLQUFLLENBQUEsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO1lBQ1YsV0FBVyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUE7UUFDM0IsQ0FBQztRQUNELElBQUksQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUE7SUFDN0IsQ0FBQyxDQUFDLENBQUM7SUFDSCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtBQUN2QixDQUFDLENBQUE7QUFFVSxRQUFBLE9BQU8sR0FBRyxDQUFPLFNBQWlCLEVBQUUsYUFBOEMsRUFBRSxFQUFFLFlBQXFCLEtBQUs7SUFDdkgsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixJQUFJLFNBQTBCLENBQUE7SUFDOUIsRUFBRSxDQUFDLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQztRQUNaLFNBQVMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtRQUN4QyxVQUFVLENBQUMsUUFBUSxHQUFHLFNBQVMsQ0FBQyxRQUFRLENBQUE7UUFDeEMsRUFBRSxDQUFBLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7WUFBQyxVQUFVLENBQUMsSUFBSSxHQUFHLFFBQVEsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLENBQUE7UUFBQyxDQUFDO1FBQ2pFLFVBQVUsQ0FBQyxJQUFJLEdBQUcsU0FBUyxDQUFDLElBQUksQ0FBQTtJQUNwQyxDQUFDO0lBQ0QsRUFBRSxDQUFDLENBQUMsQ0FBQyxTQUFTLElBQUksU0FBUyxDQUFDLFFBQVEsS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDO1FBQ2hELElBQUksT0FBTyxHQUFHLE9BQU8sQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLFVBQVUsRUFBRSxRQUFRO1lBQ3BELEVBQUUsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUM7Z0JBQ1osSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQTtZQUMxQixDQUFDO1lBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ0osYUFBYSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUE7WUFDOUMsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO1FBQ0YsRUFBRSxDQUFDLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDekIsRUFBRSxDQUFBLENBQUMsT0FBTyxVQUFVLENBQUMsV0FBVyxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUM7Z0JBQzVDLFVBQVUsQ0FBQyxXQUFXLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDbkUsQ0FBQztZQUNELE9BQU8sQ0FBQyxLQUFLLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1FBQ3pDLENBQUM7UUFDRCxPQUFPLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7WUFDbEIsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNyQixDQUFDLENBQUMsQ0FBQTtRQUNGLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQTtJQUNqQixDQUFDO0lBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxRQUFRLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQztRQUN4QyxJQUFJLE9BQU8sR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxVQUFVLEVBQUUsUUFBUTtZQUNuRCxFQUFFLENBQUMsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO2dCQUNaLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUE7WUFDMUIsQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNKLGFBQWEsQ0FBQyxRQUFRLENBQUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFBO1lBQzlDLENBQUM7UUFDTCxDQUFDLENBQUMsQ0FBQTtRQUNGLEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ3pCLEVBQUUsQ0FBQSxDQUFDLE9BQU8sVUFBVSxDQUFDLFdBQVcsS0FBSyxRQUFRLENBQUMsQ0FBQyxDQUFDO2dCQUM1QyxVQUFVLENBQUMsV0FBVyxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1lBQ25FLENBQUM7WUFDRCxPQUFPLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUN6QyxDQUFDO1FBQ0QsT0FBTyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO1lBQ2xCLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDckIsQ0FBQyxDQUFDLENBQUE7UUFDRixPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7SUFDakIsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osTUFBTSxJQUFJLEtBQUssQ0FBQyx5QkFBeUIsU0FBUyxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUE7SUFDbEUsQ0FBQztJQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0FBQ3ZCLENBQUMsQ0FBQSxDQUFBIn0=

npmextra.json

@@ -0,0 +1,37 @@
+{
+  "npmts": {
+    "coverageTreshold": 50
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartrequest",
+      "description": "A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.",
+      "npmPackagename": "@push.rocks/smartrequest",
+      "license": "MIT",
+      "keywords": [
+        "HTTP",
+        "HTTPS",
+        "request library",
+        "form data",
+        "file uploads",
+        "JSON",
+        "binary data",
+        "streams",
+        "keepAlive",
+        "TypeScript",
+        "modern web requests",
+        "drop-in replacement"
+      ]
+    }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
+  }
+}

package.json

@@ -1,31 +1,66 @@
 {
-  "name": "smartrequest",
-  "version": "1.0.4",
-  "description": "dropin replacement for request",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "name": "@push.rocks/smartrequest",
+  "version": "2.0.23",
+  "private": false,
+  "description": "A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartrequest.git"
+    "url": "https://code.foss.global/push.rocks/smartrequest.git"
   },
   "keywords": [
-    "request"
+    "HTTP",
+    "HTTPS",
+    "request library",
+    "form data",
+    "file uploads",
+    "JSON",
+    "binary data",
+    "streams",
+    "keepAlive",
+    "TypeScript",
+    "modern web requests",
+    "drop-in replacement"
   ],
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/smartrequest/issues"
+    "url": "https://gitlab.com/push.rocks/smartrequest/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
+  "homepage": "https://code.foss.global/push.rocks/smartrequest",
   "dependencies": {
-    "smartq": "^1.1.0",
-    "typings-global": "^1.0.14"
+    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smarturl": "^3.1.0",
+    "agentkeepalive": "^4.5.0",
+    "form-data": "^4.0.1"
   },
   "devDependencies": {
-    "smartchai": "^1.0.1",
-    "typings-test": "^1.0.3"
-  }
+    "@git.zone/tsbuild": "^2.2.0",
+    "@git.zone/tsrun": "^1.3.3",
+    "@git.zone/tstest": "^1.0.90",
+    "@pushrocks/tapbundle": "^5.0.8",
+    "@types/node": "^22.9.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.hints.md

@@ -0,0 +1,11 @@
+- 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 @push.rocks/smartproxy and @api.global/typedrequest

readme.md

@@ -0,0 +1,139 @@
+# @push.rocks/smartrequest
+A module providing a drop-in replacement for the deprecated Request library, focusing on modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, and streams.
+
+## Install
+To install `@push.rocks/smartrequest`, use the following npm command:
+
+```bash
+npm install @push.rocks/smartrequest --save
+```
+
+This command will add `@push.rocks/smartrequest` to your project's dependencies.
+
+## Usage
+`@push.rocks/smartrequest` is designed as a versatile, modern HTTP client library for making HTTP/HTTPS requests. It supports a range of features, including handling form data, file uploads, JSON requests, binary data, streaming, and much more, all within a modern, promise-based API.
+
+Below we will cover key usage scenarios of `@push.rocks/smartrequest`, showcasing its capabilities and providing you with a solid starting point to integrate it into your projects.
+
+### Simple GET Request
+
+For fetching data from a REST API or any web service that returns JSON:
+
+```typescript
+import { getJson } from '@push.rocks/smartrequest';
+
+async function fetchGitHubUserInfo(username: string) {
+  const response = await getJson(`https://api.github.com/users/${username}`);
+  console.log(response.body); // The body contains the JSON response
+}
+
+fetchGitHubUserInfo('octocat');
+```
+
+The `getJson` function simplifies the process of sending a GET request and parsing the JSON response.
+
+### POST Requests with JSON
+
+When you need to send JSON data to a server, for example, creating a new resource:
+
+```typescript
+import { postJson } from '@push.rocks/smartrequest';
+
+async function createTodoItem(todoDetails: { title: string; completed: boolean }) {
+  const response = await postJson('https://jsonplaceholder.typicode.com/todos', {
+    requestBody: todoDetails
+  });
+  console.log(response.body); // Log the created todo item
+}
+
+createTodoItem({ title: 'Implement smartrequest', completed: false });
+```
+
+`postJson` handles setting the appropriate content-type header and stringifies the JSON body.
+
+### Handling Form Data and File Uploads
+
+`@push.rocks/smartrequest` simplifies the process of uploading files and submitting form data to a server:
+
+```typescript
+import { postFormData, IFormField } from '@push.rocks/smartrequest';
+
+async function uploadProfilePicture(formDataFields: IFormField[]) {
+  await postFormData('https://api.example.com/upload', {}, formDataFields);
+}
+
+uploadProfilePicture([
+  { name: 'avatar', type: 'filePath', payload: './path/to/avatar.jpg', fileName: 'avatar.jpg', contentType: 'image/jpeg' },
+  { name: 'user_id', type: 'string', payload: '12345' }
+]);
+```
+
+### Streaming Support
+
+For cases when dealing with large datasets or streaming APIs, `@push.rocks/smartrequest` provides streaming capabilities:
+
+```typescript
+import { getStream } from '@push.rocks/smartrequest';
+
+async function streamLargeFile(url: string) {
+  const stream = await getStream(url);
+
+  stream.on('data', (chunk) => {
+    console.log('Received chunk of data.');
+  });
+
+  stream.on('end', () => {
+    console.log('Stream ended.');
+  });
+}
+
+streamLargeFile('https://example.com/largefile');
+```
+
+`getStream` allows you to handle data as it's received, which can be beneficial for performance and scalability.
+
+### Advanced Options and Customization
+
+`@push.rocks/smartrequest` is built to be flexible, allowing you to specify additional options to tailor requests to your needs:
+
+```typescript
+import { request, ISmartRequestOptions } from '@push.rocks/smartrequest';
+
+async function customRequestExample() {
+  const options: ISmartRequestOptions = {
+    method: 'GET',
+    headers: {
+      'Custom-Header': 'Value'
+    },
+    keepAlive: true // Enables connection keep-alive
+  };
+
+  const response = await request('https://example.com/data', options);
+  console.log(response.body);
+}
+
+customRequestExample();
+```
+
+`request` is the underlying function that powers the simpler `getJson`, `postJson`, etc., and provides you with full control over the HTTP request.
+
+Through its comprehensive set of features tailored for modern web development, `@push.rocks/smartrequest` aims to provide developers with a powerful tool for handling HTTP/HTTPS requests efficiently. Whether it's a simple API call, handling form data, or processing streams, `@push.rocks/smartrequest` delivers a robust, type-safe solution to fit your project's requirements.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,18 +0,0 @@
-"use strict";
-require("typings-test");
-const smartchai_1 = require("smartchai");
-const smartrequest = require("../dist/index");
-describe('smartrequest', function () {
-    it('should request a html document over https', function () {
-        this.timeout(10000);
-        return smartchai_1.expect(smartrequest.get('https://encrypted.google.com/')).to.eventually.property('body').be.a('string');
-    });
-    it('should request a JSON document over https', function () {
-        return smartchai_1.expect(smartrequest.get('https://jsonplaceholder.typicode.com/posts/1')).to.eventually.property('body').property('id').equal(1);
-    });
-    it('should post a JSON document over http', function () {
-        this.timeout(5000);
-        return smartchai_1.expect(smartrequest.post('http://md5.jsontest.com/?text=example_text')).to.eventually.property('body').property('md5').equal('fa4c6baa0812e5b5c80ed8885e55a8a6');
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQix5Q0FBa0M7QUFFbEMsOENBQTZDO0FBRTdDLFFBQVEsQ0FBQyxjQUFjLEVBQUU7SUFDckIsRUFBRSxDQUFDLDJDQUEyQyxFQUFFO1FBQzVDLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7UUFDbkIsTUFBTSxDQUFDLGtCQUFNLENBQUMsWUFBWSxDQUFDLEdBQUcsQ0FBQywrQkFBK0IsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUNsSCxDQUFDLENBQUMsQ0FBQTtJQUVGLEVBQUUsQ0FBQywyQ0FBMkMsRUFBRTtRQUM1QyxNQUFNLENBQUMsa0JBQU0sQ0FBQyxZQUFZLENBQUMsR0FBRyxDQUFDLDhDQUE4QyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQzFJLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLHVDQUF1QyxFQUFFO1FBQ3hDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDbEIsTUFBTSxDQUFDLGtCQUFNLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyw0Q0FBNEMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxDQUFDLEtBQUssQ0FBQyxrQ0FBa0MsQ0FBQyxDQUFBO0lBQzNLLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.ts

@@ -1,21 +1,43 @@
-import 'typings-test'
+import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
 
-import { expect } from 'smartchai'
+import * as smartrequest from '../ts/index.js';
 
-import * as smartrequest from '../dist/index'
+tap.test('should request a html document over https', async () => {
+  await expectAsync(smartrequest.getJson('https://encrypted.google.com/')).toHaveProperty('body');
+});
 
-describe('smartrequest', function() {
-    it('should request a html document over https', function() {
-        this.timeout(10000)
-        return expect(smartrequest.get('https://encrypted.google.com/')).to.eventually.property('body').be.a('string')
-    })
+tap.test('should request a JSON document over https', async () => {
+  await expectAsync(smartrequest.getJson('https://jsonplaceholder.typicode.com/posts/1'))
+    .property('body')
+    .property('id')
+    .toEqual(1);
+});
 
-    it('should request a JSON document over https', function(){
-        return expect(smartrequest.get('https://jsonplaceholder.typicode.com/posts/1')).to.eventually.property('body').property('id').equal(1)
-    })
+tap.test('should post a JSON document over http', async () => {
+  await expectAsync(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
+    .property('body')
+    .property('md5')
+    .toEqual('fa4c6baa0812e5b5c80ed8885e55a8a6');
+});
 
-    it('should post a JSON document over http', function() {
-        this.timeout(5000)
-        return expect(smartrequest.post('http://md5.jsontest.com/?text=example_text')).to.eventually.property('body').property('md5').equal('fa4c6baa0812e5b5c80ed8885e55a8a6')
-    })
-})
+tap.test('should safe get stuff', async () => {
+  smartrequest.safeGet('http://coffee.link/');
+  smartrequest.safeGet('https://coffee.link/');
+});
+
+tap.skip.test('should deal with unix socks', async () => {
+  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 @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartrequest',
+  version: '2.0.23',
+  description: 'A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.'
+}

ts/index.ts

@@ -1,34 +1,8 @@
-import * as https from 'https'
+export { request, safeGet } from './smartrequest.request.js';
+export type { IExtendedIncomingMessage } from './smartrequest.request.js';
+export type { ISmartRequestOptions } from './smartrequest.interfaces.js';
 
-import * as plugins from './smartrequest.plugins'
-import * as interfaces from './smartrequest.interfaces'
-
-import { request } from './smartrequest.request'
-
-
-export { request } from './smartrequest.request'
-export { ISmartRequestOptions } from './smartrequest.interfaces'
-
-export let get = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-    optionsArg.method = 'GET'
-    let response = await request(domainArg, optionsArg)
-    return response
-}
-
-export let post = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-    optionsArg.method = 'POST'
-    let response = await request(domainArg, optionsArg)
-    return response
-}
-
-export let put = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-    optionsArg.method = 'PUT'
-    let response = await request(domainArg, optionsArg)
-    return response
-}
-
-export let del = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-    optionsArg.method = 'DELETE'
-    let response = await request(domainArg, optionsArg)
-    return response
-}
+export * from './smartrequest.jsonrest.js';
+export * from './smartrequest.binaryrest.js';
+export * from './smartrequest.formdata.js';
+export * from './smartrequest.stream.js';

ts/smartrequest.binaryrest.ts

@@ -0,0 +1,33 @@
+// this file implements methods to get and post binary data.
+import * as interfaces from './smartrequest.interfaces.js';
+import { request, type IExtendedIncomingMessage } from './smartrequest.request.js';
+
+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: Array<Buffer> = [];
+
+  response
+    .on('data', function (chunk: Buffer) {
+      data.push(chunk);
+    })
+    .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;
+      done.resolve();
+    });
+  await done.promise;
+  return response as IExtendedIncomingMessage<Buffer>;
+};

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,10 @@
-import * as plugins from './smartrequest.plugins'
-import * as https from 'https'
+import * as plugins from './smartrequest.plugins.js';
+import * as https from 'https';
 
 export interface ISmartRequestOptions extends https.RequestOptions {
-    requestBody?: any
-}
+  keepAlive?: boolean;
+  requestBody?: any;
+  autoJsonParse?: boolean;
+  queryParams?: { [key: string]: string };
+  hardDataCuttingTimeout?: number;
+}

ts/smartrequest.jsonrest.ts

@@ -0,0 +1,63 @@
+// This file implements methods to get and post JSON in a simple manner.
+
+import * as interfaces from './smartrequest.interfaces.js';
+import { request } from './smartrequest.request.js';
+
+/**
+ * gets Json and puts the right headers + handles response aggregation
+ * @param domainArg
+ * @param optionsArg
+ */
+export const getJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'GET';
+  optionsArg.headers = {
+    ...optionsArg.headers,
+  };
+  let response = await request(domainArg, optionsArg);
+  return response;
+};
+
+export const postJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'POST';
+  if (
+    typeof optionsArg.requestBody === 'object' &&
+    (!optionsArg.headers || !optionsArg.headers['Content-Type'])
+  ) {
+    // make sure headers exist
+    if (!optionsArg.headers) {
+      optionsArg.headers = {};
+    }
+
+    // assign the right Content-Type, leaving all other headers in place
+    optionsArg.headers = {
+      ...optionsArg.headers,
+      'Content-Type': 'application/json',
+    };
+  }
+  let response = await request(domainArg, optionsArg);
+  return response;
+};
+
+export const putJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'PUT';
+  let response = await request(domainArg, optionsArg);
+  return response;
+};
+
+export const delJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'DELETE';
+  let response = await request(domainArg, optionsArg);
+  return response;
+};

ts/smartrequest.plugins.ts

@@ -1,13 +1,19 @@
-import 'typings-global'
-import * as url from 'url'
-import * as http from 'http'
-import * as https from 'https'
+// 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 q from 'smartq'
+export { http, https, fs, path };
 
-export {
-    url,
-    http,
-    https,
-    q
-}
+// pushrocks scope
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smarturl from '@push.rocks/smarturl';
+
+export { smartpromise, smarturl };
+
+// third party scope
+import agentkeepalive from 'agentkeepalive';
+import formData from 'form-data';
+
+export { agentkeepalive, formData };

ts/smartrequest.request.ts

@@ -1,72 +1,231 @@
-import * as https from 'https'
-import * as plugins from './smartrequest.plugins'
-import * as interfaces from './smartrequest.interfaces'
+import * as plugins from './smartrequest.plugins.js';
+import * as interfaces from './smartrequest.interfaces.js';
 
-let buildResponse = (responseArg): Promise<any> => {
-    let done = plugins.q.defer()
-    // Continuously update stream with data
-    let body = '';
-    responseArg.on('data', function (chunkArg) {
-        body += chunkArg;
-    });
-    responseArg.on('end', function () {
-        try {
-            responseArg.body = JSON.parse(body);
-        } catch(err) {
-            responseArg.body = body
-        }
-        done.resolve(responseArg)
-    });
-    return done.promise
+export interface IExtendedIncomingMessage<T = any> extends plugins.http.IncomingMessage {
+  body: T;
 }
 
-export let request = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}, streamArg: boolean = false) => {
-    let done = plugins.q.defer()
-    let parsedUrl: plugins.url.Url
-    if (domainArg) {
-        parsedUrl = plugins.url.parse(domainArg)
-        optionsArg.hostname = parsedUrl.hostname
-        if(parsedUrl.port) { optionsArg.port = parseInt(parsedUrl.port) }
-        optionsArg.path = parsedUrl.path
-    }
-    if (!parsedUrl || parsedUrl.protocol === 'https:') {
-        let request = plugins.https.request(optionsArg, response => {
-            if (streamArg) {
-                done.resolve(response)
-            } else {
-                buildResponse(response).then(done.resolve)
-            }
-        })
-        if (optionsArg.requestBody) {
-            if(typeof optionsArg.requestBody !== 'string') {
-                optionsArg.requestBody = JSON.stringify(optionsArg.requestBody)
-            }
-            request.write(optionsArg.requestBody)
-        }
-        request.on('error', (e) => {
-            console.error(e);
-        })
-        request.end()
-    } else if (parsedUrl.protocol === 'http:') {
-        let request = plugins.http.request(optionsArg, response => {
-            if (streamArg) {
-                done.resolve(response)
-            } else {
-                buildResponse(response).then(done.resolve)
-            }
-        })
-        if (optionsArg.requestBody) {
-            if(typeof optionsArg.requestBody !== 'string') {
-                optionsArg.requestBody = JSON.stringify(optionsArg.requestBody)
-            }
-            request.write(optionsArg.requestBody)
-        }
-        request.on('error', (e) => {
-            console.error(e);
-        })
-        request.end()
+const buildUtf8Response = (
+  incomingMessageArg: plugins.http.IncomingMessage,
+  autoJsonParse = true
+): Promise<IExtendedIncomingMessage> => {
+  const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
+  // Continuously update stream with data
+  let body = '';
+  incomingMessageArg.on('data', (chunkArg) => {
+    body += chunkArg;
+  });
+
+  incomingMessageArg.on('end', () => {
+    if (autoJsonParse) {
+      try {
+        (incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
+      } catch (err) {
+        (incomingMessageArg as IExtendedIncomingMessage).body = body;
+      }
     } else {
-        throw new Error(`unsupported protocol: ${parsedUrl.protocol}`)
+      (incomingMessageArg as IExtendedIncomingMessage).body = body;
     }
-    return done.promise
-}
+    done.resolve(incomingMessageArg as IExtendedIncomingMessage);
+  });
+  return done.promise;
+};
+
+/**
+ * determine wether a url is a unix sock
+ * @param urlArg
+ */
+const testForUnixSock = (urlArg: string): boolean => {
+  const unixRegex = /^(http:\/\/|https:\/\/|)unix:/;
+  return unixRegex.test(urlArg);
+};
+
+/**
+ * determine socketPath and path for unixsock
+ */
+const parseSocketPathAndRoute = (stringToParseArg: string) => {
+  const parseRegex = /(.*):(.*)/;
+  const result = parseRegex.exec(stringToParseArg);
+  return {
+    socketPath: result[1],
+    path: result[2],
+  };
+};
+
+/**
+ * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpAgent = new plugins.agentkeepalive({
+  keepAlive: true,
+  maxFreeSockets: 10,
+  maxSockets: 100,
+  maxTotalSockets: 1000,
+  timeout: 60000,
+});
+
+/**
+ * a custom http agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpAgentKeepAliveFalse = new plugins.agentkeepalive({
+  keepAlive: false,
+  timeout: 60000,
+});
+
+/**
+ * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpsAgent = new plugins.agentkeepalive.HttpsAgent({
+  keepAlive: true,
+  maxFreeSockets: 10,
+  maxSockets: 100,
+  maxTotalSockets: 1000,
+  timeout: 60000,
+});
+
+/**
+ * a custom https agent to make sure we can set custom keepAlive options for speedy subsequent calls
+ */
+const httpsAgentKeepAliveFalse = new plugins.agentkeepalive.HttpsAgent({
+  keepAlive: false,
+  timeout: 60000,
+});
+
+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<IExtendedIncomingMessage>();
+
+  // 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 agent
+  switch (true) {
+    case !!optionsArg.agent:
+      break;
+    case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
+      optionsArg.agent = httpsAgent;
+      break;
+    case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
+      optionsArg.agent = httpsAgentKeepAliveFalse;
+      break;
+    case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
+      optionsArg.agent = httpAgent;
+      break;
+    case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
+      optionsArg.agent = httpAgentKeepAliveFalse;
+      break;
+  }
+
+  // lets determine the request module to use
+  const requestModule = (() => {
+    switch (true) {
+      case parsedUrl.protocol === 'https:':
+        return plugins.https;
+      case parsedUrl.protocol === 'http:':
+        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 (resArg) => {
+    if (optionsArg.hardDataCuttingTimeout) {
+      setTimeout(() => {
+        resArg.destroy();
+        done.reject(new Error('Request timed out'));
+      }, optionsArg.hardDataCuttingTimeout)
+    }
+
+    if (responseStreamArg) {
+      done.resolve(resArg as IExtendedIncomingMessage);
+    } else {
+      const builtResponse = await buildUtf8Response(resArg, 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);
+    requestToFire.destroy();
+  });
+
+  const response = await done.promise;
+  response.on('error', (err) => {
+    console.log(err);
+    response.destroy();
+  });
+  return response;
+};
+
+export const safeGet = async (urlArg: string) => {
+  const agentToUse = urlArg.startsWith('http://') ? new plugins.http.Agent() : new plugins.https.Agent();
+  try {
+    const response = await request(urlArg, {
+      method: 'GET',
+      agent: agentToUse,
+      timeout: 5000,
+      hardDataCuttingTimeout: 5000,
+      autoJsonParse: false,
+    });
+    return response;
+  } catch (err) {
+    console.log(err);
+    return null;
+  }
+};

ts/smartrequest.stream.ts

@@ -0,0 +1,17 @@
+import * as plugins from './smartrequest.plugins.js';
+import * as interfaces from './smartrequest.interfaces.js';
+import { request } from './smartrequest.request.js';
+
+export const getStream = async (
+  urlArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+): Promise<plugins.http.IncomingMessage> => {
+  try {
+    // Call the existing request function with responseStreamArg set to true.
+    const responseStream = await request(urlArg, optionsArg, true);
+    return responseStream;
+  } catch (err) {
+    console.error('An error occurred while getting the stream:', err);
+    throw err; // Rethrow the error to be handled by the caller.
+  }
+};

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

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