1.1.39

.gitlab-ci.yml

@@ -54,7 +54,7 @@ testBuild:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm install
   - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
@@ -65,7 +65,7 @@ testBuild:
 release:
   stage: release
   script:
-  - npmci node install lts
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
@@ -81,6 +81,7 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:

README.md

@@ -20,6 +20,21 @@ dropin replacement for request
 
 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 request module under the hood (not the one from npm)
 
 ```javascript

package-lock.json

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

package.json

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

ts/smartrequest.formdata.ts

@@ -8,16 +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;
   }
 };
 
@@ -30,13 +47,15 @@ export const postFormData = async (
   for (const formField of payloadArg) {
     await appendFormField(form, formField);
   }
-  const requestOptions = {...optionsArg, 
+  const requestOptions = {
+    ...optionsArg,
     method: 'POST',
     headers: {
       ...optionsArg.headers,
       ...form.getHeaders()
     },
-    requestBody: form};
+    requestBody: form
+  };
 
   // lets fire the actual request for sending the formdata
   const response = await request(urlArg, requestOptions);

ts/smartrequest.plugins.ts

@@ -12,6 +12,4 @@ export { formData, http, https, fs, path, url, smartpromise };
 // third party scope
 import * as agentkeepalive from 'agentkeepalive';
 
-export {
-  agentkeepalive
-};
+export { agentkeepalive };

ts/smartrequest.request.ts

@@ -125,13 +125,13 @@ export let request = async (
       case parsedUrl.protocol === 'https:' && optionsArg.keepAlive:
         optionsArg.agent = httpsAgent;
         return plugins.https;
-      case parsedUrl.protocol === 'https:' && (!optionsArg.keepAlive):
+      case parsedUrl.protocol === 'https:' && !optionsArg.keepAlive:
         optionsArg.agent = httpsAgentKeepAliveFalse;
         return plugins.https;
       case parsedUrl.protocol === 'http:' && optionsArg.keepAlive:
         optionsArg.agent = httpAgent;
         return plugins.http;
-      case parsedUrl.protocol === 'http:' && (!optionsArg.keepAlive):
+      case parsedUrl.protocol === 'http:' && !optionsArg.keepAlive:
         optionsArg.agent = httpAgentKeepAliveFalse;
         return plugins.http;
     }