1.1.41

README.md

@@ -20,7 +20,22 @@ dropin replacement for request
 
 Use TypeScript for best in class instellisense.
 
-> note: smartrequest uses the **native** node request module under the hood (not the one from npm)
+### 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'
@@ -31,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
-smartrequest.get(...)
-smartrequest.put(...)
-smartrequest.del(...)
+// dedicated JSON metods 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

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrequest",
-  "version": "1.1.36",
+  "version": "1.1.41",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",

ts/smartrequest.formdata.ts

@@ -8,18 +8,33 @@ import { request } from './smartrequest.request';
 export interface IFormField {
   name: string;
   type: 'string' | 'filePath' | 'Buffer';
-  payload: string;
+  payload: string | Buffer;
+  fileName?: string;
 }
 
 const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
-  if (formDataField.type === 'filePath') {
-    const fileData = plugins.fs.readFileSync(
-      plugins.path.join(process.cwd(), formDataField.payload)
-    );
-    formDataArg.append('file', fileData, {
-      filename: 'upload.pdf',
-      contentType: 'application/pdf'
-    });
+  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('file', formDataField.payload, {
+        filename: formDataField.fileName ? formDataField.fileName : 'upload.pdf',
+        contentType: 'application/pdf'
+      });
+      break;
   }
 };