@readme/httpsnippet 3.0.0 → 3.0.1

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.0.0",
+  "version": "3.0.1",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -53,11 +53,11 @@
     "test": "jest --coverage"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^7.1.0",
-    "eslint": "^7.32.0",
+    "@readme/eslint-config": "^8.0.2",
+    "eslint": "^8.3.0",
     "glob": "^7.1.7",
     "jest": "^27.2.0",
-    "prettier": "^2.4.0",
+    "prettier": "^2.5.0",
     "require-directory": "^2.1.1"
   },
   "dependencies": {

package/src/index.js

@@ -7,7 +7,7 @@ const targets = require('./targets');
 const url = require('url');
 const validate = require('har-validator/lib/async');
 
-const { formDataIterator, isBlob } = require('./helpers/form-data.js');
+const { formDataIterator, isBlob } = require('./helpers/form-data');
 
 // constructor
 const HTTPSnippet = function (data, opts = {}) {

package/src/targets/clojure/clj_http.js

@@ -128,20 +128,22 @@ module.exports = function (source, options) {
       delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
       break;
     case 'multipart/form-data':
-      params.multipart = source.postData.params.map(function (x) {
-        if (x.fileName && !x.value) {
+      if (source.postData.params) {
+        params.multipart = source.postData.params.map(function (x) {
+          if (x.fileName && !x.value) {
+            return {
+              name: x.name,
+              content: new File(x.fileName),
+            };
+          }
+
           return {
             name: x.name,
-            content: new File(x.fileName),
+            content: x.value,
           };
-        }
-
-        return {
-          name: x.name,
-          content: x.value,
-        };
-      });
-      delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
+        });
+        delete params.headers[helpers.getHeaderName(params.headers, 'content-type')];
+      }
       break;
   }
 

package/src/targets/javascript/axios.js

@@ -46,19 +46,21 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data':
-      code.push('const form = new FormData();');
+      if (source.postData.params) {
+        code.push('const form = new FormData();');
 
-      source.postData.params.forEach(function (param) {
-        code.push(
-          'form.append(%s, %s);',
-          JSON.stringify(param.name),
-          JSON.stringify(param.value || param.fileName || '')
-        );
-      });
+        source.postData.params.forEach(function (param) {
+          code.push(
+            'form.append(%s, %s);',
+            JSON.stringify(param.name),
+            JSON.stringify(param.value || param.fileName || '')
+          );
+        });
 
-      code.blank();
+        code.blank();
 
-      reqOpts.data = '[form]';
+        reqOpts.data = '[form]';
+      }
       break;
 
     default:

package/src/targets/javascript/fetch.js

@@ -44,17 +44,19 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data':
-      code.push('const form = new FormData();');
-
-      source.postData.params.forEach(function (param) {
-        code.push(
-          'form.append(%s, %s);',
-          JSON.stringify(param.name),
-          JSON.stringify(param.value || param.fileName || '')
-        );
-      });
-
-      code.blank();
+      if (source.postData.params) {
+        code.push('const form = new FormData();');
+
+        source.postData.params.forEach(function (param) {
+          code.push(
+            'form.append(%s, %s);',
+            JSON.stringify(param.name),
+            JSON.stringify(param.value || param.fileName || '')
+          );
+        });
+
+        code.blank();
+      }
       break;
 
     default:
@@ -89,7 +91,9 @@ module.exports = function (source, options) {
     .blank();
 
   if (source.postData.mimeType === 'multipart/form-data') {
-    code.push('options.body = form;').blank();
+    if (source.postData.params) {
+      code.push('options.body = form;').blank();
+    }
   }
 
   code

package/src/targets/javascript/jquery.js

@@ -38,29 +38,31 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data':
-      code.push('const form = new FormData();');
+      if (source.postData.params) {
+        code.push('const form = new FormData();');
 
-      source.postData.params.forEach(function (param) {
-        code.push(
-          'form.append(%s, %s);',
-          JSON.stringify(param.name),
-          JSON.stringify(param.value || param.fileName || '')
-        );
-      });
+        source.postData.params.forEach(function (param) {
+          code.push(
+            'form.append(%s, %s);',
+            JSON.stringify(param.name),
+            JSON.stringify(param.value || param.fileName || '')
+          );
+        });
 
-      settings.processData = false;
-      settings.contentType = false;
-      settings.mimeType = 'multipart/form-data';
-      settings.data = '[form]';
+        settings.processData = false;
+        settings.contentType = false;
+        settings.mimeType = 'multipart/form-data';
+        settings.data = '[form]';
 
-      // remove the contentType header
-      if (helpers.hasHeader(settings.headers, 'content-type')) {
-        if (helpers.getHeader(settings.headers, 'content-type').indexOf('boundary')) {
-          delete settings.headers[helpers.getHeaderName(settings.headers, 'content-type')];
+        // remove the contentType header
+        if (helpers.hasHeader(settings.headers, 'content-type')) {
+          if (helpers.getHeader(settings.headers, 'content-type').indexOf('boundary')) {
+            delete settings.headers[helpers.getHeaderName(settings.headers, 'content-type')];
+          }
         }
-      }
 
-      code.blank();
+        code.blank();
+      }
       break;
 
     default:

package/src/targets/javascript/xhr.js

@@ -26,25 +26,27 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data':
-      code.push('const data = new FormData();');
-
-      source.postData.params.forEach(function (param) {
-        code.push(
-          'data.append(%s, %s);',
-          JSON.stringify(param.name),
-          JSON.stringify(param.value || param.fileName || '')
-        );
-      });
-
-      // remove the contentType header
-      if (helpers.hasHeader(source.allHeaders, 'content-type')) {
-        if (helpers.getHeader(source.allHeaders, 'content-type').indexOf('boundary')) {
-          // eslint-disable-next-line no-param-reassign
-          delete source.allHeaders[helpers.getHeaderName(source.allHeaders, 'content-type')];
+      if (source.postData.params) {
+        code.push('const data = new FormData();');
+
+        source.postData.params.forEach(function (param) {
+          code.push(
+            'data.append(%s, %s);',
+            JSON.stringify(param.name),
+            JSON.stringify(param.value || param.fileName || '')
+          );
+        });
+
+        // remove the contentType header
+        if (helpers.hasHeader(source.allHeaders, 'content-type')) {
+          if (helpers.getHeader(source.allHeaders, 'content-type').indexOf('boundary')) {
+            // eslint-disable-next-line no-param-reassign
+            delete source.allHeaders[helpers.getHeaderName(source.allHeaders, 'content-type')];
+          }
         }
-      }
 
-      code.blank();
+        code.blank();
+      }
       break;
 
     default:

package/src/targets/node/fetch.js

@@ -30,10 +30,12 @@ module.exports = function (source, options) {
   // The `form-data` library automatically adds a `Content-Type` header for `multipart/form-data` content and if we
   // add our own here, data won't be correctly transferred.
   if (source.postData.mimeType === 'multipart/form-data') {
-    const contentTypeHeader = headerHelpers.getHeaderName(source.allHeaders, 'content-type');
-    if (contentTypeHeader) {
-      // eslint-disable-next-line no-param-reassign
-      delete source.allHeaders[contentTypeHeader];
+    if (source.postData.params) {
+      const contentTypeHeader = headerHelpers.getHeaderName(source.allHeaders, 'content-type');
+      if (contentTypeHeader) {
+        // eslint-disable-next-line no-param-reassign
+        delete source.allHeaders[contentTypeHeader];
+      }
     }
   }
 
@@ -61,21 +63,23 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data':
-      code.unshift("const FormData = require('form-data');");
-      code.push('const formData = new FormData();');
-      code.blank();
+      if (source.postData.params) {
+        code.unshift("const FormData = require('form-data');");
+        code.push('const formData = new FormData();');
+        code.blank();
+
+        source.postData.params.forEach(function (param) {
+          if (!param.fileName && !param.contentType) {
+            code.push(`formData.append('${param.name}', '${param.value}');`);
+            return;
+          }
 
-      source.postData.params.forEach(function (param) {
-        if (!param.fileName && !param.contentType) {
-          code.push(`formData.append('${param.name}', '${param.value}');`);
-          return;
-        }
-
-        if (param.fileName) {
-          includeFS = true;
-          code.push(`formData.append('${param.name}', fs.createReadStream('${param.fileName}'));`);
-        }
-      });
+          if (param.fileName) {
+            includeFS = true;
+            code.push(`formData.append('${param.name}', fs.createReadStream('${param.fileName}'));`);
+          }
+        });
+      }
       break;
 
     default:
@@ -112,7 +116,9 @@ module.exports = function (source, options) {
   }
 
   if (source.postData.mimeType === 'multipart/form-data') {
-    code.push('options.body = formData;').blank();
+    if (source.postData.params) {
+      code.push('options.body = formData;').blank();
+    }
   }
 
   code

package/src/targets/node/request.js

@@ -44,33 +44,35 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data':
-      reqOpts.formData = {};
-
-      source.postData.params.forEach(function (param) {
-        const attachment = {};
-
-        if (!param.fileName && !param.contentType) {
-          reqOpts.formData[param.name] = param.value;
-          return;
-        }
-
-        if (param.fileName) {
-          includeFS = true;
-
-          attachment.value = `fs.createReadStream("${param.fileName}")`;
-        } else if (param.value) {
-          attachment.value = param.value;
-        }
-
-        if (param.fileName) {
-          attachment.options = {
-            filename: param.fileName,
-            contentType: param.contentType ? param.contentType : null,
-          };
-        }
-
-        reqOpts.formData[param.name] = attachment;
-      });
+      if (source.postData.params) {
+        reqOpts.formData = {};
+
+        source.postData.params.forEach(function (param) {
+          const attachment = {};
+
+          if (!param.fileName && !param.contentType) {
+            reqOpts.formData[param.name] = param.value;
+            return;
+          }
+
+          if (param.fileName) {
+            includeFS = true;
+
+            attachment.value = `fs.createReadStream("${param.fileName}")`;
+          } else if (param.value) {
+            attachment.value = param.value;
+          }
+
+          if (param.fileName) {
+            attachment.options = {
+              filename: param.fileName,
+              contentType: param.contentType ? param.contentType : null,
+            };
+          }
+
+          reqOpts.formData[param.name] = attachment;
+        });
+      }
       break;
 
     default:

package/src/targets/node/unirest.js

@@ -63,29 +63,31 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data': {
-      const multipart = [];
+      if (source.postData.params) {
+        const multipart = [];
 
-      source.postData.params.forEach(function (param) {
-        const part = {};
+        source.postData.params.forEach(function (param) {
+          const part = {};
 
-        if (param.fileName && !param.value) {
-          includeFS = true;
+          if (param.fileName && !param.value) {
+            includeFS = true;
 
-          part.body = `fs.createReadStream("${param.fileName}")`;
-        } else if (param.value) {
-          part.body = param.value;
-        }
-
-        if (part.body) {
-          if (param.contentType) {
-            part['content-type'] = param.contentType;
+            part.body = `fs.createReadStream("${param.fileName}")`;
+          } else if (param.value) {
+            part.body = param.value;
           }
 
-          multipart.push(part);
-        }
-      });
+          if (part.body) {
+            if (param.contentType) {
+              part['content-type'] = param.contentType;
+            }
+
+            multipart.push(part);
+          }
+        });
 
-      code.push('req.multipart(%s);', JSON.stringify(multipart, null, opts.indent)).blank();
+        code.push('req.multipart(%s);', JSON.stringify(multipart, null, opts.indent)).blank();
+      }
       break;
     }
 

package/src/targets/php/guzzle.js

@@ -42,38 +42,40 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data': {
-      const fields = [];
-
-      source.postData.params.forEach(function (param) {
-        if (param.fileName) {
-          const field = {
-            name: param.name,
-            filename: param.fileName,
-            contents: param.value,
-          };
-
-          if (param.contentType) {
-            field.headers = { 'Content-Type': param.contentType };
+      if (source.postData.params) {
+        const fields = [];
+
+        source.postData.params.forEach(function (param) {
+          if (param.fileName) {
+            const field = {
+              name: param.name,
+              filename: param.fileName,
+              contents: param.value,
+            };
+
+            if (param.contentType) {
+              field.headers = { 'Content-Type': param.contentType };
+            }
+
+            fields.push(field);
+          } else if (param.value) {
+            fields.push({
+              name: param.name,
+              contents: param.value,
+            });
           }
+        });
 
-          fields.push(field);
-        } else if (param.value) {
-          fields.push({
-            name: param.name,
-            contents: param.value,
-          });
+        if (fields.length) {
+          requestOptions.push(1, "'multipart' => %s", helpers.convert(fields, opts.indent + opts.indent, opts.indent));
         }
-      });
 
-      if (fields.length) {
-        requestOptions.push(1, "'multipart' => %s", helpers.convert(fields, opts.indent + opts.indent, opts.indent));
-      }
-
-      // Guzzle adds its own boundary for multipart requests.
-      if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
-        if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
-          // eslint-disable-next-line no-param-reassign
-          delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+        // Guzzle adds its own boundary for multipart requests.
+        if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
+          if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
+            // eslint-disable-next-line no-param-reassign
+            delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+          }
         }
       }
       break;

package/src/targets/php/helpers.js

@@ -31,7 +31,6 @@ const convert = function (obj, indent, lastIndent) {
         result.push(convert(item, indent + indent, indent));
       });
 
-      // eslint-disable-next-line sonarjs/no-nested-template-literals
       result = `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
       break;
 
@@ -44,7 +43,6 @@ const convert = function (obj, indent, lastIndent) {
           result.push(`${convert(i, indent)} => ${convert(obj[i], indent + indent, indent)}`);
         }
       }
-      // eslint-disable-next-line sonarjs/no-nested-template-literals
       result = `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
       break;
 

package/src/targets/php/http2.js

@@ -40,41 +40,43 @@ module.exports = function (source, options) {
       break;
 
     case 'multipart/form-data': {
-      const files = [];
-      const fields = {};
-
-      source.postData.params.forEach(function (param) {
-        if (param.fileName) {
-          files.push({
-            name: param.name,
-            type: param.contentType,
-            file: param.fileName,
-            data: param.value,
-          });
-        } else if (param.value) {
-          fields[param.name] = param.value;
-        }
-      });
+      if (source.postData.params) {
+        const files = [];
+        const fields = {};
+
+        source.postData.params.forEach(function (param) {
+          if (param.fileName) {
+            files.push({
+              name: param.name,
+              type: param.contentType,
+              file: param.fileName,
+              data: param.value,
+            });
+          } else if (param.value) {
+            fields[param.name] = param.value;
+          }
+        });
 
-      code
-        .push('$body = new http\\Message\\Body;')
-        .push(
-          '$body->addForm(%s, %s);',
-          Object.keys(fields).length ? helpers.convert(fields, opts.indent) : 'null',
-          files.length ? helpers.convert(files, opts.indent) : 'null'
-        );
-
-      // remove the contentType header
-      if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
-        if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
-          // eslint-disable-next-line no-param-reassign
-          delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+        code
+          .push('$body = new http\\Message\\Body;')
+          .push(
+            '$body->addForm(%s, %s);',
+            Object.keys(fields).length ? helpers.convert(fields, opts.indent) : 'null',
+            files.length ? helpers.convert(files, opts.indent) : 'null'
+          );
+
+        // remove the contentType header
+        if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
+          if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
+            // eslint-disable-next-line no-param-reassign
+            delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+          }
         }
-      }
 
-      code.blank();
+        code.blank();
 
-      hasBody = true;
+        hasBody = true;
+      }
       break;
     }
 

package/src/targets/shell/curl.js

@@ -75,16 +75,18 @@ module.exports = function (source, options) {
   // construct post params
   switch (source.postData.mimeType) {
     case 'multipart/form-data':
-      source.postData.params.forEach(function (param) {
-        let post = '';
-        if (param.fileName) {
-          post = format('%s=@%s', param.name, param.fileName);
-        } else {
-          post = format('%s=%s', param.name, param.value);
-        }
+      if (source.postData.params) {
+        source.postData.params.forEach(function (param) {
+          let post = '';
+          if (param.fileName) {
+            post = format('%s=@%s', param.name, param.fileName);
+          } else {
+            post = format('%s=%s', param.name, param.value);
+          }
 
-        code.push('%s %s', opts.short ? '-F' : '--form', helpers.quote(post));
-      });
+          code.push('%s %s', opts.short ? '-F' : '--form', helpers.quote(post));
+        });
+      }
       break;
 
     case 'application/x-www-form-urlencoded':