1.1.46

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,23 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +43,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -85,30 +90,31 @@ codequality:
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -116,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.40",
+  "version": "1.1.46",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.40",
+  "version": "1.1.46",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
@@ -38,12 +38,12 @@
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_web/**/*",
-    "dist_ts_web/*",
+    "dist_ts_web/**/*",
-    "assets/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

readme.md

@@ -22,18 +22,18 @@ Use TypeScript for best in class instellisense.
 
 ### Features
 
-* supports http
+- supports http
-* supports https
+- supports https
-* supports unix socks
+- supports unix socks
-* supports formData
+- supports formData
-* supports file uploads
+- supports file uploads
-* supports best practice keepAlive
+- supports best practice keepAlive
-* dedicated functions for working with JSON request/response cycles
+- dedicated functions for working with JSON request/response cycles
-* written in TypeScript
+- written in TypeScript
-* continuously updated
+- continuously updated
-* uses node native http and https modules
+- uses node native http and https modules
-* used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
+- used in modules like @pushrocks/smartproxy and @apiglobal/typedrequest
-* commercial support available at [https://lossless.support](https://lossless.support)
+- 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)
 
@@ -46,23 +46,24 @@ let options: smartrequest.ISmartRequestOptions = { // typed options
         "Content-Type": "application/json"
         "Authorization": "Bearer token"
     },
-    requestBody: {
+    requestBody: JSON.stringify({
         key1: 'value1',
         key2: 3
-    }
+    })
 }
 
-smartrequest.post('https://example.com', options).then(res => {
+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)
 })
 
-// also available
+// dedicated JSON metods are available:
-smartrequest.get(...)
+smartrequest.getJson(...)
-smartrequest.put(...)
+smartrequest.postJson(...)
-smartrequest.del(...)
+smartrequest.putJson(...)
+smartrequest.delJson(...)
 
 // streaming
 smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res => { // third arg = true signals streaming
@@ -76,6 +77,10 @@ smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res =
 })
 ```
 
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

ts/smartrequest.binaryrest.ts

@@ -21,7 +21,7 @@ export const getBinary = async (
       //so Buffer.concat() can make us a new Buffer
       //of all of them together
       const buffer = Buffer.concat(data);
-      response.body = buffer.toString('binary');
+      response.body = buffer;
       done.resolve();
     });
   await done.promise;

ts/smartrequest.formdata.ts

@@ -10,6 +10,7 @@ export interface IFormField {
   type: 'string' | 'filePath' | 'Buffer';
   payload: string | Buffer;
   fileName?: string;
+  contentType?: string;
 }
 
 const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
@@ -19,7 +20,11 @@ const appendFormField = async (formDataArg: plugins.formData, formDataField: IFo
       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.`);
+        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)
@@ -30,9 +35,9 @@ const appendFormField = async (formDataArg: plugins.formData, formDataField: IFo
       });
       break;
     case 'Buffer':
-      formDataArg.append('file', formDataField.payload, {
+      formDataArg.append(formDataField.name, formDataField.payload, {
         filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
-        contentType: 'application/pdf'
+        contentType: formDataField.contentType ? formDataField.contentType : 'application/pdf'
       });
       break;
   }