@readme/httpsnippet 4.0.0 → 4.0.3

package/dist/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/targets/javascript/axios/fixtures/short.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/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/targets/javascript/axios/fixtures/text-plain.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/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/targets/javascript/fetch/client.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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.
+ */
+import type { Client } from '../../targets';
+interface FetchOptions {
+    credentials?: Record<string, string> | null;
+}
+export declare const fetch: Client<FetchOptions>;
+export {};

package/dist/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/targets/javascript/fetch/fixtures/application-form-encoded.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: import("url").URLSearchParams;
+}

package/dist/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); });

package/dist/targets/javascript/fetch/fixtures/application-json.d.ts

@@ -0,0 +1,7 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: string;
+}

package/dist/targets/javascript/fetch/fixtures/application-json.js

@@ -0,0 +1,16 @@
+"use strict";
+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('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); });

package/dist/targets/javascript/fetch/fixtures/cookies.d.ts

@@ -0,0 +1,6 @@
+declare namespace options {
+    const method: string;
+    namespace headers {
+        const cookie: string;
+    }
+}

package/dist/targets/javascript/fetch/fixtures/cookies.js

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

package/dist/targets/javascript/fetch/fixtures/custom-method.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}

package/dist/targets/javascript/fetch/fixtures/custom-method.js

@@ -0,0 +1,5 @@
+"use strict";
+var options = { method: 'PROPFIND' };
+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); });

package/dist/targets/javascript/fetch/fixtures/full.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+declare namespace options {
+    const method: string;
+    const headers: {
+        cookie: string;
+        accept: string;
+        'content-type': string;
+    };
+    const body: import("url").URLSearchParams;
+}

package/dist/targets/javascript/fetch/fixtures/full.js

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

package/dist/targets/javascript/fetch/fixtures/headers.d.ts

@@ -0,0 +1,8 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        accept: string;
+        'x-foo': string;
+        'x-bar': string;
+    };
+}

package/dist/targets/javascript/fetch/fixtures/headers.js

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

package/dist/targets/javascript/fetch/fixtures/http-insecure.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}

package/dist/targets/javascript/fetch/fixtures/http-insecure.js

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

package/dist/targets/javascript/fetch/fixtures/jsonObj-multiline.d.ts

@@ -0,0 +1,7 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: string;
+}

package/dist/targets/javascript/fetch/fixtures/jsonObj-multiline.js

@@ -0,0 +1,9 @@
+"use strict";
+var options = {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify({ foo: 'bar' })
+};
+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); });

package/dist/targets/javascript/fetch/fixtures/jsonObj-null-value.d.ts

@@ -0,0 +1,7 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: string;
+}

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

@@ -0,0 +1,9 @@
+"use strict";
+var options = {
+    method: 'POST',
+    headers: { 'content-type': 'application/json' },
+    body: JSON.stringify({ foo: null })
+};
+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); });

package/dist/targets/javascript/fetch/fixtures/multipart-data.d.ts

@@ -0,0 +1,4 @@
+declare const form: any;
+declare namespace options {
+    export { form as body };
+}

package/dist/targets/javascript/fetch/fixtures/multipart-data.js

@@ -0,0 +1,9 @@
+"use strict";
+var form = new FormData();
+form.append('foo', 'Hello World');
+form.append('bar', 'Bonjour le monde');
+var options = { method: 'POST' };
+options.body = form;
+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); });

package/dist/targets/javascript/fetch/fixtures/multipart-file.d.ts

@@ -0,0 +1,4 @@
+declare const form: any;
+declare namespace options {
+    const body: any;
+}

package/dist/targets/javascript/fetch/fixtures/multipart-file.js

@@ -0,0 +1,8 @@
+"use strict";
+var form = new FormData();
+form.append('foo', 'src/fixtures/files/hello.txt');
+var options = { method: 'POST' };
+options.body = form;
+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); });

package/dist/targets/javascript/fetch/fixtures/multipart-form-data-no-params.d.ts

@@ -0,0 +1,6 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        'Content-Type': string;
+    };
+}

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

@@ -0,0 +1,5 @@
+"use strict";
+var options = { method: 'POST', headers: { 'Content-Type': 'multipart/form-data' } };
+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); });

package/dist/targets/javascript/fetch/fixtures/multipart-form-data.d.ts

@@ -0,0 +1,4 @@
+declare const form: any;
+declare namespace options {
+    const body: any;
+}

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

@@ -0,0 +1,8 @@
+"use strict";
+var form = new FormData();
+form.append('foo', 'bar');
+var options = { method: 'POST' };
+options.body = form;
+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); });

package/dist/targets/javascript/fetch/fixtures/nested.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}

package/dist/targets/javascript/fetch/fixtures/nested.js

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

package/dist/targets/javascript/fetch/fixtures/query-encoded.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}

package/dist/targets/javascript/fetch/fixtures/query-encoded.js

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

package/dist/targets/javascript/fetch/fixtures/query.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}

package/dist/targets/javascript/fetch/fixtures/query.js

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

package/dist/targets/javascript/fetch/fixtures/short.d.ts

@@ -0,0 +1,3 @@
+declare namespace options {
+    const method: string;
+}

package/dist/targets/javascript/fetch/fixtures/short.js

@@ -0,0 +1,5 @@
+"use strict";
+var options = { method: 'GET' };
+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); });

package/dist/targets/javascript/fetch/fixtures/text-plain.d.ts

@@ -0,0 +1,7 @@
+declare namespace options {
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const body: string;
+}

package/dist/targets/javascript/fetch/fixtures/text-plain.js

@@ -0,0 +1,5 @@
+"use strict";
+var options = { method: 'POST', headers: { 'content-type': 'text/plain' }, body: '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); });

package/dist/targets/javascript/jquery/client.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @description
+ * HTTP code snippet generator for native XMLHttpRequest
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export declare const jquery: Client;

package/dist/targets/javascript/jquery/client.js

@@ -0,0 +1,93 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for native XMLHttpRequest
+ *
+ * @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.jquery = 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.jquery = {
+    info: {
+        key: 'jquery',
+        title: 'jQuery',
+        link: 'http://api.jquery.com/jquery.ajax/',
+        description: 'Perform an asynchronous HTTP (Ajax) requests with jQuery'
+    },
+    convert: function (_a, options) {
+        var _b;
+        var fullUrl = _a.fullUrl, 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, push = _c.push, join = _c.join;
+        var settings = {
+            async: true,
+            crossDomain: true,
+            url: fullUrl,
+            method: method,
+            headers: allHeaders
+        };
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                settings.data = postData.paramsObj ? postData.paramsObj : postData.text;
+                break;
+            case 'application/json':
+                settings.processData = false;
+                settings.data = postData.text;
+                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 || '', "');"));
+                });
+                settings.processData = false;
+                settings.contentType = false;
+                settings.mimeType = 'multipart/form-data';
+                settings.data = '[form]';
+                // remove the contentType header
+                if ((0, headers_1.hasHeader)(allHeaders, 'content-type')) {
+                    if ((_b = String((0, headers_1.getHeader)(allHeaders, 'content-type'))) === null || _b === void 0 ? void 0 : _b.includes('boundary')) {
+                        var headerName = (0, headers_1.getHeaderName)(allHeaders, 'content-type');
+                        if (headerName) {
+                            delete settings.headers[headerName];
+                        }
+                    }
+                }
+                blank();
+                break;
+            default:
+                if (postData.text) {
+                    settings.data = postData.text;
+                }
+        }
+        var stringifiedSettings = (0, stringify_object_1["default"])(settings, { indent: opts.indent }).replace("'[form]'", 'form');
+        push("const settings = ".concat(stringifiedSettings, ";"));
+        blank();
+        push('$.ajax(settings).done(function (response) {');
+        push('console.log(response);', 1);
+        push('});');
+        return join();
+    }
+};

package/dist/targets/javascript/jquery/fixtures/application-form-encoded.d.ts

@@ -0,0 +1,13 @@
+declare namespace settings {
+    const async: boolean;
+    const crossDomain: boolean;
+    const url: string;
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    namespace data {
+        const foo: string;
+        const hello: string;
+    }
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+var settings = {
+    async: true,
+    crossDomain: true,
+    url: 'https://httpbin.org/anything',
+    method: 'POST',
+    headers: {
+        'content-type': 'application/x-www-form-urlencoded'
+    },
+    data: {
+        foo: 'bar',
+        hello: 'world'
+    }
+};
+$.ajax(settings).done(function (response) {
+    console.log(response);
+});

package/dist/targets/javascript/jquery/fixtures/application-json.d.ts

@@ -0,0 +1,11 @@
+declare namespace settings {
+    const async: boolean;
+    const crossDomain: boolean;
+    const url: string;
+    const method: string;
+    const headers: {
+        'content-type': string;
+    };
+    const processData: boolean;
+    const data: string;
+}