@readme/httpsnippet 3.1.3 → 4.0.2

package/dist/src/targets/java/unirest/client.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for Java using Unirest.
+ *
+ * @author
+ * @shashiranjan84
+ *
+ * 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);
+};
+exports.__esModule = true;
+exports.unirest = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+exports.unirest = {
+    info: {
+        key: 'unirest',
+        title: 'Unirest',
+        link: 'http://unirest.io/java.html',
+        description: 'Lightweight HTTP Request Client Library'
+    },
+    convert: function (_a, options) {
+        var method = _a.method, allHeaders = _a.allHeaders, postData = _a.postData, fullUrl = _a.fullUrl;
+        var opts = __assign({ indent: '  ' }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), join = _b.join, push = _b.push;
+        var methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
+        if (!methods.includes(method.toUpperCase())) {
+            push("HttpResponse<String> response = Unirest.customMethod(\"".concat(method.toUpperCase(), "\",\"").concat(fullUrl, "\")"));
+        }
+        else {
+            push("HttpResponse<String> response = Unirest.".concat(method.toLowerCase(), "(\"").concat(fullUrl, "\")"));
+        }
+        // Add headers, including the cookies
+        Object.keys(allHeaders).forEach(function (key) {
+            push(".header(\"".concat(key, "\", \"").concat(allHeaders[key], "\")"), 1);
+        });
+        if (postData.text) {
+            push(".body(".concat(JSON.stringify(postData.text), ")"), 1);
+        }
+        push('.asString();', 1);
+        return join();
+    }
+};

package/dist/src/targets/javascript/axios/client.js

@@ -0,0 +1,101 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for Javascript & Node.js using Axios.
+ *
+ * @author
+ * @rohit-gohri
+ *
+ * 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.axios = void 0;
+var stringify_object_1 = __importDefault(require("stringify-object"));
+var code_builder_1 = require("../../../helpers/code-builder");
+exports.axios = {
+    info: {
+        key: 'axios',
+        title: 'Axios',
+        link: 'https://github.com/axios/axios',
+        description: 'Promise based HTTP client for the browser and node.js'
+    },
+    convert: function (_a, options) {
+        var allHeaders = _a.allHeaders, method = _a.method, url = _a.url, queryObj = _a.queryObj, postData = _a.postData;
+        var opts = __assign({ indent: '  ' }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), blank = _b.blank, push = _b.push, join = _b.join, addPostProcessor = _b.addPostProcessor;
+        push("import axios from 'axios';");
+        blank();
+        var requestOptions = {
+            method: method,
+            url: url
+        };
+        if (Object.keys(queryObj).length) {
+            requestOptions.params = queryObj;
+        }
+        if (Object.keys(allHeaders).length) {
+            requestOptions.headers = allHeaders;
+        }
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                if (postData.params) {
+                    push('const encodedParams = new URLSearchParams();');
+                    postData.params.forEach(function (param) {
+                        push("encodedParams.set('".concat(param.name, "', '").concat(param.value, "');"));
+                    });
+                    blank();
+                    requestOptions.data = 'encodedParams,';
+                    addPostProcessor(function (code) { return code.replace(/'encodedParams,'/, 'encodedParams,'); });
+                }
+                break;
+            case 'application/json':
+                if (postData.jsonObj) {
+                    requestOptions.data = postData.jsonObj;
+                }
+                break;
+            case 'multipart/form-data':
+                if (!postData.params) {
+                    break;
+                }
+                push('const form = new FormData();');
+                postData.params.forEach(function (param) {
+                    push("form.append('".concat(param.name, "', '").concat(param.value || param.fileName || '', "');"));
+                });
+                blank();
+                requestOptions.data = '[form]';
+                break;
+            default:
+                if (postData.text) {
+                    requestOptions.data = postData.text;
+                }
+        }
+        var optionString = (0, stringify_object_1["default"])(requestOptions, {
+            indent: '  ',
+            inlineCharacterLimit: 80
+        }).replace('"[form]"', 'form');
+        push("const options = ".concat(optionString, ";"));
+        blank();
+        push('axios');
+        push('.request(options)', 1);
+        push('.then(function (response) {', 1);
+        push('console.log(response.data);', 2);
+        push('})', 1);
+        push('.catch(function (error) {', 1);
+        push('console.error(error);', 2);
+        push('});', 1);
+        return join();
+    }
+};

package/dist/src/targets/javascript/axios/fixtures/application-form-encoded.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var encodedParams = new URLSearchParams();
+encodedParams.set('foo', 'bar');
+encodedParams.set('hello', 'world');
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'application/x-www-form-urlencoded' },
+    data: encodedParams
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/application-json.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'application/json' },
+    data: {
+        number: 1,
+        string: 'f"oo',
+        arr: [1, 2, 3],
+        nested: { a: 'b' },
+        arr_mix: [1, 'a', { arr_mix_nested: {} }],
+        boolean: false
+    }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/cookies.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'GET',
+    url: 'https://httpbin.org/cookies',
+    headers: { cookie: 'foo=bar; bar=baz' }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/custom-method.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = { method: 'PROPFIND', url: 'https://httpbin.org/anything' };
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/full.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var encodedParams = new URLSearchParams();
+encodedParams.set('foo', 'bar');
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    params: { foo: ['bar', 'baz'], baz: 'abc', key: 'value' },
+    headers: {
+        cookie: 'foo=bar; bar=baz',
+        accept: 'application/json',
+        'content-type': 'application/x-www-form-urlencoded'
+    },
+    data: encodedParams
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/headers.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'GET',
+    url: 'https://httpbin.org/headers',
+    headers: { accept: 'application/json', 'x-foo': 'Bar', 'x-bar': 'Foo' }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/http-insecure.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = { method: 'GET', url: 'http://httpbin.org/anything' };
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/jsonObj-multiline.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'application/json' },
+    data: { foo: 'bar' }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/jsonObj-null-value.js

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'application/json' },
+    data: { foo: null }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var form = new FormData();
+form.append('foo', 'Hello World');
+form.append('bar', 'Bonjour le monde');
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'multipart/form-data; boundary=---011000010111000001101001' },
+    data: '[form]'
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

package/dist/src/targets/javascript/axios/fixtures/multipart-file.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var form = new FormData();
+form.append('foo', 'src/fixtures/files/hello.txt');
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'multipart/form-data; boundary=---011000010111000001101001' },
+    data: '[form]'
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'Content-Type': 'multipart/form-data' }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var form = new FormData();
+form.append('foo', 'bar');
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001' },
+    data: '[form]'
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'GET',
+    url: 'https://httpbin.org/anything',
+    params: { 'foo[bar]': 'baz,zap', fiz: 'buz', key: 'value' }
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

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

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

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

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

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = { method: 'GET', url: 'https://httpbin.org/anything' };
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

@@ -0,0 +1,19 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var axios_1 = __importDefault(require("axios"));
+var options = {
+    method: 'POST',
+    url: 'https://httpbin.org/anything',
+    headers: { 'content-type': 'text/plain' },
+    data: 'Hello World'
+};
+axios_1["default"]
+    .request(options)
+    .then(function (response) {
+    console.log(response.data);
+})["catch"](function (error) {
+    console.error(error);
+});

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

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for fetch
+ *
+ * @author
+ * @pmdroid
+ *
+ * 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://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch',
+        description: 'Perform asynchronous HTTP requests with the Fetch API'
+    },
+    convert: function (_a, inputOpts) {
+        var method = _a.method, allHeaders = _a.allHeaders, postData = _a.postData, fullUrl = _a.fullUrl;
+        var opts = __assign({ indent: '  ', credentials: null }, inputOpts);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), blank = _b.blank, join = _b.join, push = _b.push;
+        var options = {
+            method: method
+        };
+        if (Object.keys(allHeaders).length) {
+            options.headers = allHeaders;
+        }
+        if (opts.credentials !== null) {
+            options.credentials = opts.credentials;
+        }
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                options.body = postData.paramsObj ? postData.paramsObj : postData.text;
+                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.
+                    options.body = postData.jsonObj;
+                }
+                break;
+            case 'multipart/form-data':
+                if (!postData.params) {
+                    break;
+                }
+                // The FormData API 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)(allHeaders, 'content-type');
+                if (contentTypeHeader) {
+                    delete allHeaders[contentTypeHeader];
+                }
+                push('const form = new FormData();');
+                postData.params.forEach(function (param) {
+                    push("form.append('".concat(param.name, "', '").concat(param.value || param.fileName || '', "');"));
+                });
+                blank();
+                break;
+            default:
+                if (postData.text) {
+                    options.body = postData.text;
+                }
+        }
+        // If we ultimately don't have any headers to send then we shouldn't add an empty object into the request options.
+        if (options.headers && !Object.keys(options.headers).length) {
+            delete options.headers;
+        }
+        push("const options = ".concat((0, stringify_object_1["default"])(options, {
+            indent: opts.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') {
+                    if (postData.mimeType === 'application/x-www-form-urlencoded') {
+                        return "new URLSearchParams(".concat(originalResult, ")");
+                    }
+                    else if (postData.mimeType === 'application/json') {
+                        return "JSON.stringify(".concat(originalResult, ")");
+                    }
+                }
+                return originalResult;
+            }
+        }), ";"));
+        blank();
+        if (postData.params && postData.mimeType === 'multipart/form-data') {
+            push('options.body = form;');
+            blank();
+        }
+        push("fetch('".concat(fullUrl, "', options)"));
+        push('.then(response => response.json())', 1);
+        push('.then(response => console.log(response))', 1);
+        push('.catch(err => console.error(err));', 1);
+        return join();
+    }
+};

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

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