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

.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 command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - 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",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

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
+

npmextra.json

@@ -9,12 +9,29 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "smartrequest",
-      "shortDescription": "dropin replacement for request",
-      "npmPackagename": "@pushrocks/smartrequest",
-      "license": "MIT"
+      "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,41 +1,52 @@
 {
-  "name": "@pushrocks/smartrequest",
-  "version": "1.1.53",
+  "name": "@push.rocks/smartrequest",
+  "version": "2.0.23",
   "private": false,
-  "description": "dropin replacement for request",
+  "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": "(tstest test/ --web)",
-    "build": "(tsbuild --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": {
-    "@pushrocks/smartpromise": "^3.1.6",
-    "@pushrocks/smarturl": "^2.0.1",
-    "agentkeepalive": "^4.2.0",
-    "form-data": "^4.0.0"
+    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smarturl": "^3.1.0",
+    "agentkeepalive": "^4.5.0",
+    "form-data": "^4.0.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.29",
-    "@gitzone/tsrun": "^1.2.18",
-    "@gitzone/tstest": "^1.0.64",
-    "@pushrocks/tapbundle": "^4.0.7",
-    "@types/node": "^17.0.18",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@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/**/*",

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

@@ -1,96 +1,139 @@
-# @pushrocks/smartrequest
-dropin replacement for request
+# @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.
 
-## 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/)
+## Install
+To install `@push.rocks/smartrequest`, use the following npm command:
 
-## 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
-    })
-})
+```bash
+npm install @push.rocks/smartrequest --save
 ```
 
-## Contribution
+This command will add `@push.rocks/smartrequest` to your project's dependencies.
 
-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). :)
+## 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.
 
-For further information read the linked docs at the top of this readme.
+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.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+### Simple GET Request
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+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.ts

@@ -1,9 +1,9 @@
 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 expectAsync(smartrequest.getJson('https://encrypted.google.com/')).toHaveProperty('body')
+  await expectAsync(smartrequest.getJson('https://encrypted.google.com/')).toHaveProperty('body');
 });
 
 tap.test('should request a JSON document over https', async () => {
@@ -13,13 +13,18 @@ tap.test('should request a JSON document over https', async () => {
     .toEqual(1);
 });
 
-tap.skip.test('should post a JSON document over http', async () => {
+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');
 });
 
+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',

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,6 +1,8 @@
-export { request, IExtendedIncomingMessage } from './smartrequest.request';
-export { ISmartRequestOptions } from './smartrequest.interfaces';
+export { request, safeGet } from './smartrequest.request.js';
+export type { IExtendedIncomingMessage } from './smartrequest.request.js';
+export type { ISmartRequestOptions } from './smartrequest.interfaces.js';
 
-export * from './smartrequest.jsonrest';
-export * from './smartrequest.binaryrest';
-export * from './smartrequest.formdata';
+export * from './smartrequest.jsonrest.js';
+export * from './smartrequest.binaryrest.js';
+export * from './smartrequest.formdata.js';
+export * from './smartrequest.stream.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 { request } from './smartrequest.request';
+import * as interfaces from './smartrequest.interfaces.js';
+import { request, type IExtendedIncomingMessage } from './smartrequest.request.js';
 
-import * as plugins from './smartrequest.plugins';
+import * as plugins from './smartrequest.plugins.js';
 
 export const getBinary = async (
   domainArg: string,
@@ -29,5 +29,5 @@ export const getBinary = async (
       done.resolve();
     });
   await done.promise;
-  return response;
+  return response as IExtendedIncomingMessage<Buffer>;
 };

ts/smartrequest.formdata.ts

@@ -1,6 +1,6 @@
-import * as plugins from './smartrequest.plugins';
-import * as interfaces from './smartrequest.interfaces';
-import { request } from './smartrequest.request';
+import * as plugins from './smartrequest.plugins.js';
+import * as interfaces from './smartrequest.interfaces.js';
+import { request } from './smartrequest.request.js';
 
 /**
  * the interfae for FormFieldData
@@ -70,28 +70,30 @@ export const postFormData = async (
 export const postFormDataUrlEncoded = async (
   urlArg: string,
   optionsArg: interfaces.ISmartRequestOptions = {},
-  payloadArg: {key: string, content: string}[]
+  payloadArg: { key: string; content: string }[]
 ) => {
-  const requestOptions = {
-    ...optionsArg,
-    method: 'POST',
-    headers: {
-      ...optionsArg.headers,
-      'content-type': 'application/x-www-form-urlencoded'
-    }
-  };
-
   let resultString = '';
 
   for (const keyContentPair of payloadArg) {
     if (resultString) {
       resultString += '&';
     }
-    resultString += `${encodeURIComponent(keyContentPair.key)}=${encodeURIComponent(keyContentPair.content)}`;
+    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 + resultString, requestOptions);
+  const response = await request(urlArg, requestOptions);
   return response;
 };

ts/smartrequest.interfaces.ts

@@ -1,9 +1,10 @@
-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}
+  queryParams?: { [key: string]: string };
+  hardDataCuttingTimeout?: number;
 }

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 { request } from './smartrequest.request';
+import * as interfaces from './smartrequest.interfaces.js';
+import { request } from './smartrequest.request.js';
 
 /**
  * gets Json and puts the right headers + handles response aggregation

ts/smartrequest.plugins.ts

@@ -7,8 +7,8 @@ import * as path from 'path';
 export { http, https, fs, path };
 
 // pushrocks scope
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as smarturl from '@pushrocks/smarturl';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smarturl from '@push.rocks/smarturl';
 
 export { smartpromise, smarturl };
 

ts/smartrequest.request.ts

@@ -1,14 +1,12 @@
-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';
 
-import { IncomingMessage } from 'http';
-
-export interface IExtendedIncomingMessage extends IncomingMessage {
-  body: any;
+export interface IExtendedIncomingMessage<T = any> extends plugins.http.IncomingMessage {
+  body: T;
 }
 
 const buildUtf8Response = (
-  incomingMessageArg: IncomingMessage,
+  incomingMessageArg: plugins.http.IncomingMessage,
   autoJsonParse = true
 ): Promise<IExtendedIncomingMessage> => {
   const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
@@ -57,29 +55,39 @@ 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();
+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.http.Agent({
-  maxFreeSockets: 0,
+const httpAgentKeepAliveFalse = new plugins.agentkeepalive({
   keepAlive: false,
-  keepAliveMsecs: 0,
+  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();
+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.https.Agent({
-  maxFreeSockets: 0,
+const httpsAgentKeepAliveFalse = new plugins.agentkeepalive.HttpsAgent({
   keepAlive: false,
-  keepAliveMsecs: 0,
+  timeout: 60000,
 });
 
 export let request = async (
@@ -88,7 +96,7 @@ export let request = async (
   responseStreamArg: boolean = false,
   requestDataFunc: (req: plugins.http.ClientRequest) => void = null
 ): Promise<IExtendedIncomingMessage> => {
-  const done = plugins.smartpromise.defer<any>();
+  const done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
 
   // merge options
   const defaultOptions: interfaces.ISmartRequestOptions = {
@@ -104,7 +112,7 @@ export let request = async (
 
   // parse url
   const parsedUrl = plugins.smarturl.Smarturl.createFromUrl(urlArg, {
-    searchParams: optionsArg.queryParams || {}
+    searchParams: optionsArg.queryParams || {},
   });
   optionsArg.hostname = parsedUrl.hostname;
   if (parsedUrl.port) {
@@ -122,20 +130,30 @@ export let request = async (
 
   // 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:' && optionsArg.keepAlive:
-        optionsArg.agent = httpsAgent;
+      case parsedUrl.protocol === 'https:':
         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;
+      case parsedUrl.protocol === 'http:':
         return plugins.http;
     }
   })() as typeof plugins.https;
@@ -146,11 +164,18 @@ export let request = async (
   }
 
   // lets perform the actual request
-  const requestToFire = requestModule.request(optionsArg, async (response) => {
+  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(response);
+      done.resolve(resArg as IExtendedIncomingMessage);
     } else {
-      const builtResponse = await buildUtf8Response(response, optionsArg.autoJsonParse);
+      const builtResponse = await buildUtf8Response(resArg, optionsArg.autoJsonParse);
       done.resolve(builtResponse);
     }
   });
@@ -177,8 +202,30 @@ export let request = async (
   // lets handle an error
   requestToFire.on('error', (e) => {
     console.error(e);
+    requestToFire.destroy();
   });
 
-  const result = await done.promise;
-  return result;
+  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,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"
-}