@readme/httpsnippet 3.1.3 → 4.0.2

package/dist/src/targets/node/axios/fixtures/multipart-form-data-no-params.js

@@ -0,0 +1,14 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'Content-Type': 'multipart/form-data' }
+};
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/axios/fixtures/multipart-form-data.js

@@ -0,0 +1,15 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001' },
+    data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="foo"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n'
+};
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/axios/fixtures/nested.js

@@ -0,0 +1,13 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = {
+    method: 'GET',
+    url: 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value'
+};
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/axios/fixtures/query-encoded.js

@@ -0,0 +1,13 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = {
+    method: 'GET',
+    url: 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00'
+};
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/axios/fixtures/query.js

@@ -0,0 +1,13 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = {
+    method: 'GET',
+    url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'
+};
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/axios/fixtures/short.js

@@ -0,0 +1,10 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = { method: 'GET', url: 'https://httpbin.org/anything' };
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/axios/fixtures/text-plain.js

@@ -0,0 +1,15 @@
+"use strict";
+var axios = require('axios')["default"];
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'text/plain' },
+    data: 'Hello World'
+};
+axios
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/node/fetch/client.js

@@ -0,0 +1,149 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for Node.js using node-fetch.
+ *
+ * @author
+ * @hirenoble
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.fetch = void 0;
+var stringify_object_1 = __importDefault(require("stringify-object"));
+var code_builder_1 = require("../../../helpers/code-builder");
+var headers_1 = require("../../../helpers/headers");
+exports.fetch = {
+    info: {
+        key: 'fetch',
+        title: 'Fetch',
+        link: 'https://github.com/bitinn/node-fetch',
+        description: 'Simplified HTTP node-fetch client'
+    },
+    convert: function (_a, options) {
+        var _b;
+        var method = _a.method, fullUrl = _a.fullUrl, postData = _a.postData, headersObj = _a.headersObj, cookies = _a.cookies;
+        var opts = __assign({ indent: '  ' }, options);
+        var includeFS = false;
+        var _c = new code_builder_1.CodeBuilder({ indent: opts.indent }), blank = _c.blank, push = _c.push, join = _c.join, unshift = _c.unshift;
+        push("const fetch = require('node-fetch');");
+        var url = fullUrl;
+        var reqOpts = {
+            method: method
+        };
+        if (Object.keys(headersObj).length) {
+            reqOpts.headers = headersObj;
+        }
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                unshift("const { URLSearchParams } = require('url');");
+                push('const encodedParams = new URLSearchParams();');
+                blank();
+                (_b = postData.params) === null || _b === void 0 ? void 0 : _b.forEach(function (param) {
+                    push("encodedParams.set('".concat(param.name, "', '").concat(param.value, "');"));
+                });
+                reqOpts.body = 'encodedParams';
+                break;
+            case 'application/json':
+                if (postData.jsonObj) {
+                    // Though `fetch` doesn't accept JSON objects in the `body` option we're going to
+                    // stringify it when we add this into the snippet further down.
+                    reqOpts.body = postData.jsonObj;
+                }
+                break;
+            case 'multipart/form-data':
+                if (!postData.params) {
+                    break;
+                }
+                // The `form-data` module automatically adds a `Content-Type` header for `multipart/form-data` content and if we add our own here data won't be correctly transmitted.
+                // eslint-disable-next-line no-case-declarations -- We're only using `contentTypeHeader` within this block.
+                var contentTypeHeader = (0, headers_1.getHeaderName)(headersObj, 'content-type');
+                if (contentTypeHeader) {
+                    delete headersObj[contentTypeHeader];
+                }
+                unshift("const FormData = require('form-data');");
+                push('const formData = new FormData();');
+                blank();
+                postData.params.forEach(function (param) {
+                    if (!param.fileName && !param.fileName && !param.contentType) {
+                        push("formData.append('".concat(param.name, "', '").concat(param.value, "');"));
+                        return;
+                    }
+                    if (param.fileName) {
+                        includeFS = true;
+                        push("formData.append('".concat(param.name, "', fs.createReadStream('").concat(param.fileName, "'));"));
+                    }
+                });
+                break;
+            default:
+                if (postData.text) {
+                    reqOpts.body = postData.text;
+                }
+        }
+        // construct cookies argument
+        if (cookies.length) {
+            var cookiesString = cookies
+                .map(function (_a) {
+                var name = _a.name, value = _a.value;
+                return "".concat(encodeURIComponent(name), "=").concat(encodeURIComponent(value));
+            })
+                .join('; ');
+            if (reqOpts.headers) {
+                reqOpts.headers.cookie = cookiesString;
+            }
+            else {
+                reqOpts.headers = {};
+                reqOpts.headers.cookie = cookiesString;
+            }
+        }
+        blank();
+        push("const url = '".concat(url, "';"));
+        // If we ultimately don't have any headers to send then we shouldn't add an empty object into the request options.
+        if (reqOpts.headers && !Object.keys(reqOpts.headers).length) {
+            delete reqOpts.headers;
+        }
+        var stringifiedOptions = (0, stringify_object_1["default"])(reqOpts, {
+            indent: '  ',
+            inlineCharacterLimit: 80,
+            // The Fetch API body only accepts string parameters, but stringified JSON can be difficult to
+            // read, so we keep the object as a literal and use this transform function to wrap the literal
+            // in a `JSON.stringify` call.
+            transform: function (object, property, originalResult) {
+                if (property === 'body' && postData.mimeType === 'application/json') {
+                    return "JSON.stringify(".concat(originalResult, ")");
+                }
+                return originalResult;
+            }
+        });
+        push("const options = ".concat(stringifiedOptions, ";"));
+        blank();
+        if (includeFS) {
+            unshift("const fs = require('fs');");
+        }
+        if (postData.params && postData.mimeType === 'multipart/form-data') {
+            push('options.body = formData;');
+            blank();
+        }
+        push('fetch(url, options)');
+        push('.then(res => res.json())', 1);
+        push('.then(json => console.log(json))', 1);
+        push(".catch(err => console.error('error:' + err));", 1);
+        return join()
+            .replace(/'encodedParams'/, 'encodedParams')
+            .replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")');
+    }
+};

package/dist/src/targets/node/fetch/fixtures/application-form-encoded.js

@@ -0,0 +1,15 @@
+"use strict";
+var URLSearchParams = require('url').URLSearchParams;
+var fetch = require('node-fetch');
+var encodedParams = new URLSearchParams();
+encodedParams.set('foo', 'bar');
+encodedParams.set('hello', 'world');
+var url = 'https://httpbin.org/anything';
+var options = {
+    method: 'POST',
+    headers: { 'content-type': 'application/x-www-form-urlencoded' },
+    body: encodedParams
+};
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/application-json.js

@@ -0,0 +1,18 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify({
+        number: 1,
+        string: 'f"oo',
+        arr: [1, 2, 3],
+        nested: { a: 'b' },
+        arr_mix: [1, 'a', { arr_mix_nested: {} }],
+        boolean: false
+    })
+};
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/cookies.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/cookies';
+var options = { method: 'GET', headers: { cookie: 'foo=bar; bar=baz' } };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/custom-method.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = { method: 'PROPFIND' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/full.js

@@ -0,0 +1,18 @@
+"use strict";
+var URLSearchParams = require('url').URLSearchParams;
+var fetch = require('node-fetch');
+var encodedParams = new URLSearchParams();
+encodedParams.set('foo', 'bar');
+var url = 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value';
+var options = {
+    method: 'POST',
+    headers: {
+        accept: 'application/json',
+        'content-type': 'application/x-www-form-urlencoded',
+        cookie: 'foo=bar; bar=baz'
+    },
+    body: encodedParams
+};
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/headers.js

@@ -0,0 +1,10 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/headers';
+var options = {
+    method: 'GET',
+    headers: { accept: 'application/json', 'x-foo': 'Bar', 'x-bar': 'Foo' }
+};
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/http-insecure.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'http://httpbin.org/anything';
+var options = { method: 'GET' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/jsonObj-multiline.js

@@ -0,0 +1,11 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify({ foo: 'bar' })
+};
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/jsonObj-null-value.js

@@ -0,0 +1,11 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify({ foo: null })
+};
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/multipart-data.js

@@ -0,0 +1,13 @@
+"use strict";
+var fs = require('fs');
+var FormData = require('form-data');
+var fetch = require('node-fetch');
+var formData = new FormData();
+formData.append('foo', fs.createReadStream('src/fixtures/files/hello.txt'));
+formData.append('bar', 'Bonjour le monde');
+var url = 'https://httpbin.org/anything';
+var options = { method: 'POST' };
+options.body = formData;
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/multipart-file.js

@@ -0,0 +1,12 @@
+"use strict";
+var fs = require('fs');
+var FormData = require('form-data');
+var fetch = require('node-fetch');
+var formData = new FormData();
+formData.append('foo', fs.createReadStream('src/fixtures/files/hello.txt'));
+var url = 'https://httpbin.org/anything';
+var options = { method: 'POST' };
+options.body = formData;
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/multipart-form-data-no-params.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = { method: 'POST', headers: { 'Content-Type': 'multipart/form-data' } };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/multipart-form-data.js

@@ -0,0 +1,11 @@
+"use strict";
+var FormData = require('form-data');
+var fetch = require('node-fetch');
+var formData = new FormData();
+formData.append('foo', 'bar');
+var url = 'https://httpbin.org/anything';
+var options = { method: 'POST' };
+options.body = formData;
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/nested.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value';
+var options = { method: 'GET' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/query-encoded.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00';
+var options = { method: 'GET' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/query.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value';
+var options = { method: 'GET' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/short.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = { method: 'GET' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/fetch/fixtures/text-plain.js

@@ -0,0 +1,7 @@
+"use strict";
+var fetch = require('node-fetch');
+var url = 'https://httpbin.org/anything';
+var options = { method: 'POST', headers: { 'content-type': 'text/plain' }, body: 'Hello World' };
+fetch(url, options)
+    .then(function (res) { return res.json(); })
+    .then(function (json) { return console.log(json); })["catch"](function (err) { return console.error('error:' + err); });

package/dist/src/targets/node/native/client.js

@@ -0,0 +1,91 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for native Node.js.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.native = void 0;
+var stringify_object_1 = __importDefault(require("stringify-object"));
+var code_builder_1 = require("../../../helpers/code-builder");
+exports.native = {
+    info: {
+        key: 'native',
+        title: 'HTTP',
+        link: 'http://nodejs.org/api/http.html#http_http_request_options_callback',
+        description: 'Node.js native HTTP interface'
+    },
+    convert: function (_a, options) {
+        var _b;
+        var uriObj = _a.uriObj, method = _a.method, allHeaders = _a.allHeaders, postData = _a.postData;
+        var opts = __assign({ indent: '  ' }, options);
+        var _c = new code_builder_1.CodeBuilder({ indent: opts.indent }), blank = _c.blank, join = _c.join, push = _c.push, unshift = _c.unshift;
+        var reqOpts = {
+            method: method,
+            hostname: uriObj.hostname,
+            port: uriObj.port,
+            path: uriObj.path,
+            headers: allHeaders
+        };
+        push("const http = require('".concat((_b = uriObj.protocol) === null || _b === void 0 ? void 0 : _b.replace(':', ''), "');"));
+        blank();
+        push("const options = ".concat((0, stringify_object_1["default"])(reqOpts, { indent: opts.indent }), ";"));
+        blank();
+        push('const req = http.request(options, function (res) {');
+        push('const chunks = [];', 1);
+        blank();
+        push("res.on('data', function (chunk) {", 1);
+        push('chunks.push(chunk);', 2);
+        push('});', 1);
+        blank();
+        push("res.on('end', function () {", 1);
+        push('const body = Buffer.concat(chunks);', 2);
+        push('console.log(body.toString());', 2);
+        push('});', 1);
+        push('});');
+        blank();
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                if (postData.paramsObj) {
+                    unshift("const qs = require('querystring');");
+                    push("req.write(qs.stringify(".concat((0, stringify_object_1["default"])(postData.paramsObj, {
+                        indent: '  ',
+                        inlineCharacterLimit: 80
+                    }), "));"));
+                }
+                break;
+            case 'application/json':
+                if (postData.jsonObj) {
+                    push("req.write(JSON.stringify(".concat((0, stringify_object_1["default"])(postData.jsonObj, {
+                        indent: '  ',
+                        inlineCharacterLimit: 80
+                    }), "));"));
+                }
+                break;
+            default:
+                if (postData.text) {
+                    push("req.write(".concat((0, stringify_object_1["default"])(postData.text, { indent: opts.indent }), ");"));
+                }
+        }
+        push('req.end();');
+        return join();
+    }
+};

package/dist/src/targets/node/native/fixtures/application-form-encoded.js

@@ -0,0 +1,24 @@
+"use strict";
+var qs = require('querystring');
+var http = require('https');
+var options = {
+    method: 'POST',
+    hostname: 'httpbin.org',
+    port: null,
+    path: '/anything',
+    headers: {
+        'content-type': 'application/x-www-form-urlencoded'
+    }
+};
+var req = http.request(options, function (res) {
+    var chunks = [];
+    res.on('data', function (chunk) {
+        chunks.push(chunk);
+    });
+    res.on('end', function () {
+        var body = Buffer.concat(chunks);
+        console.log(body.toString());
+    });
+});
+req.write(qs.stringify({ foo: 'bar', hello: 'world' }));
+req.end();

package/dist/src/targets/node/native/fixtures/application-json.js

@@ -0,0 +1,30 @@
+"use strict";
+var http = require('https');
+var options = {
+    method: 'POST',
+    hostname: 'httpbin.org',
+    port: null,
+    path: '/anything',
+    headers: {
+        'content-type': 'application/json'
+    }
+};
+var req = http.request(options, function (res) {
+    var chunks = [];
+    res.on('data', function (chunk) {
+        chunks.push(chunk);
+    });
+    res.on('end', function () {
+        var body = Buffer.concat(chunks);
+        console.log(body.toString());
+    });
+});
+req.write(JSON.stringify({
+    number: 1,
+    string: 'f"oo',
+    arr: [1, 2, 3],
+    nested: { a: 'b' },
+    arr_mix: [1, 'a', { arr_mix_nested: {} }],
+    boolean: false
+}));
+req.end();

package/dist/src/targets/node/native/fixtures/cookies.js

@@ -0,0 +1,22 @@
+"use strict";
+var http = require('https');
+var options = {
+    method: 'GET',
+    hostname: 'httpbin.org',
+    port: null,
+    path: '/cookies',
+    headers: {
+        cookie: 'foo=bar; bar=baz'
+    }
+};
+var req = http.request(options, function (res) {
+    var chunks = [];
+    res.on('data', function (chunk) {
+        chunks.push(chunk);
+    });
+    res.on('end', function () {
+        var body = Buffer.concat(chunks);
+        console.log(body.toString());
+    });
+});
+req.end();