@readme/httpsnippet 4.0.0 → 4.0.3

package/dist/targets/ocaml/cohttp/client.js

@@ -0,0 +1,72 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for OCaml using CoHTTP.
+ *
+ * @author
+ * @SGrondin
+ *
+ * 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.cohttp = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+exports.cohttp = {
+    info: {
+        key: 'cohttp',
+        title: 'CoHTTP',
+        link: 'https://github.com/mirage/ocaml-cohttp',
+        description: 'Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml'
+    },
+    convert: function (_a, options) {
+        var fullUrl = _a.fullUrl, allHeaders = _a.allHeaders, postData = _a.postData, method = _a.method;
+        var opts = __assign({ indent: '  ' }, options);
+        var methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options'];
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, blank = _b.blank, join = _b.join;
+        push('open Cohttp_lwt_unix');
+        push('open Cohttp');
+        push('open Lwt');
+        blank();
+        push("let uri = Uri.of_string \"".concat(fullUrl, "\" in"));
+        // Add headers, including the cookies
+        var headers = Object.keys(allHeaders);
+        if (headers.length === 1) {
+            push("let headers = Header.add (Header.init ()) \"".concat(headers[0], "\" \"").concat(allHeaders[headers[0]], "\" in"));
+        }
+        else if (headers.length > 1) {
+            push('let headers = Header.add_list (Header.init ()) [');
+            headers.forEach(function (key) {
+                push("(\"".concat(key, "\", \"").concat(allHeaders[key], "\");"), 1);
+            });
+            push('] in');
+        }
+        // Add body
+        if (postData.text) {
+            // Just text
+            push("let body = Cohttp_lwt_body.of_string ".concat(JSON.stringify(postData.text), " in"));
+        }
+        // Do the request
+        blank();
+        var h = headers.length ? '~headers ' : '';
+        var b = postData.text ? '~body ' : '';
+        var m = methods.includes(method.toLowerCase())
+            ? "`".concat(method.toUpperCase())
+            : "(Code.method_of_string \"".concat(method, "\")");
+        push("Client.call ".concat(h).concat(b).concat(m, " uri"));
+        // Catch result
+        push('>>= fun (res, body_stream) ->');
+        push('(* Do stuff with the result *)', 1);
+        return join();
+    }
+};

package/dist/targets/ocaml/target.d.ts

@@ -0,0 +1,2 @@
+import type { Target } from '../targets';
+export declare const ocaml: Target;

package/dist/targets/ocaml/target.js

@@ -0,0 +1,15 @@
+"use strict";
+exports.__esModule = true;
+exports.ocaml = void 0;
+var client_1 = require("./cohttp/client");
+exports.ocaml = {
+    info: {
+        key: 'ocaml',
+        title: 'OCaml',
+        extname: '.ml',
+        "default": 'cohttp'
+    },
+    clientsById: {
+        cohttp: client_1.cohttp
+    }
+};

package/dist/targets/php/curl/client.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @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 interface CurlOptions {
+    closingTag?: boolean;
+    maxRedirects?: number;
+    nameErrors?: boolean;
+    noTags?: boolean;
+    shortTags?: boolean;
+    timeout?: number;
+}
+export declare const curl: Client<CurlOptions>;

package/dist/targets/php/curl/client.js

@@ -0,0 +1,135 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @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);
+};
+exports.__esModule = true;
+exports.curl = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+exports.curl = {
+    info: {
+        key: 'curl',
+        title: 'cURL',
+        link: 'http://php.net/manual/en/book.curl.php',
+        description: 'PHP with ext-curl'
+    },
+    convert: function (_a, options) {
+        var uriObj = _a.uriObj, postData = _a.postData, fullUrl = _a.fullUrl, method = _a.method, httpVersion = _a.httpVersion, cookies = _a.cookies, headersObj = _a.headersObj;
+        var opts = __assign({ closingTag: false, indent: '  ', maxRedirects: 10, namedErrors: false, noTags: false, shortTags: false, timeout: 30 }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, blank = _b.blank, join = _b.join;
+        if (!opts.noTags) {
+            push(opts.shortTags ? '<?' : '<?php');
+            blank();
+        }
+        push('$curl = curl_init();');
+        blank();
+        var curlOptions = [
+            {
+                escape: true,
+                name: 'CURLOPT_PORT',
+                value: uriObj.port
+            },
+            {
+                escape: true,
+                name: 'CURLOPT_URL',
+                value: fullUrl
+            },
+            {
+                escape: false,
+                name: 'CURLOPT_RETURNTRANSFER',
+                value: 'true'
+            },
+            {
+                escape: true,
+                name: 'CURLOPT_ENCODING',
+                value: ''
+            },
+            {
+                escape: false,
+                name: 'CURLOPT_MAXREDIRS',
+                value: opts.maxRedirects
+            },
+            {
+                escape: false,
+                name: 'CURLOPT_TIMEOUT',
+                value: opts.timeout
+            },
+            {
+                escape: false,
+                name: 'CURLOPT_HTTP_VERSION',
+                value: httpVersion === 'HTTP/1.0' ? 'CURL_HTTP_VERSION_1_0' : 'CURL_HTTP_VERSION_1_1'
+            },
+            {
+                escape: true,
+                name: 'CURLOPT_CUSTOMREQUEST',
+                value: method
+            },
+            {
+                escape: true,
+                name: 'CURLOPT_POSTFIELDS',
+                value: postData ? postData.text : undefined
+            },
+        ];
+        push('curl_setopt_array($curl, [');
+        var curlopts = new code_builder_1.CodeBuilder({ indent: opts.indent, join: "\n".concat(opts.indent) });
+        curlOptions.forEach(function (_a) {
+            var value = _a.value, name = _a.name, escape = _a.escape;
+            if (value !== null && value !== undefined) {
+                curlopts.push("".concat(name, " => ").concat(escape ? JSON.stringify(value) : value, ","));
+            }
+        });
+        // construct cookies
+        var curlCookies = cookies.map(function (cookie) { return "".concat(encodeURIComponent(cookie.name), "=").concat(encodeURIComponent(cookie.value)); });
+        if (curlCookies.length) {
+            curlopts.push("CURLOPT_COOKIE => \"".concat(curlCookies.join('; '), "\","));
+        }
+        // construct cookies
+        var headers = Object.keys(headersObj)
+            .sort()
+            .map(function (key) { return "\"".concat(key, ": ").concat(headersObj[key], "\""); });
+        if (headers.length) {
+            curlopts.push('CURLOPT_HTTPHEADER => [');
+            curlopts.push(headers.join(",\n".concat(opts.indent).concat(opts.indent)), 1);
+            curlopts.push('],');
+        }
+        push(curlopts.join(), 1);
+        push(']);');
+        blank();
+        push('$response = curl_exec($curl);');
+        push('$err = curl_error($curl);');
+        blank();
+        push('curl_close($curl);');
+        blank();
+        push('if ($err) {');
+        if (opts.namedErrors) {
+            push('echo array_flip(get_defined_constants(true)["curl"])[$err];', 1);
+        }
+        else {
+            push('echo "cURL Error #:" . $err;', 1);
+        }
+        push('} else {');
+        push('echo $response;', 1);
+        push('}');
+        if (!opts.noTags && opts.closingTag) {
+            blank();
+            push('?>');
+        }
+        return join();
+    }
+};

package/dist/targets/php/guzzle/client.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using Guzzle.
+ *
+ * @author @RobertoArruda
+ * @author @erunion
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import type { Client } from '../../targets';
+export interface GuzzleOptions {
+    closingTag?: boolean;
+    indent?: string;
+    noTags?: boolean;
+    shortTags?: boolean;
+}
+export declare const guzzle: Client<GuzzleOptions>;

package/dist/targets/php/guzzle/client.js

@@ -0,0 +1,126 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for PHP using Guzzle.
+ *
+ * @author @RobertoArruda
+ * @author @erunion
+ *
+ * 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.guzzle = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+var headers_1 = require("../../../helpers/headers");
+var helpers_1 = require("../helpers");
+exports.guzzle = {
+    info: {
+        key: 'guzzle',
+        title: 'Guzzle',
+        link: 'http://docs.guzzlephp.org/en/stable/',
+        description: 'PHP with Guzzle'
+    },
+    convert: function (_a, options) {
+        var postData = _a.postData, fullUrl = _a.fullUrl, method = _a.method, cookies = _a.cookies, headersObj = _a.headersObj;
+        var opts = __assign({ closingTag: false, indent: '  ', noTags: false, shortTags: false }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, blank = _b.blank, join = _b.join;
+        var _c = new code_builder_1.CodeBuilder({ indent: opts.indent }), requestCode = _c.code, requestPush = _c.push, requestJoin = _c.join;
+        if (!opts.noTags) {
+            push(opts.shortTags ? '<?' : '<?php');
+        }
+        push("require_once('vendor/autoload.php');");
+        blank();
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                requestPush("'form_params' => ".concat((0, helpers_1.convertType)(postData.paramsObj, opts.indent + opts.indent, opts.indent), ","), 1);
+                break;
+            case 'multipart/form-data': {
+                var fields_1 = [];
+                if (postData.params) {
+                    postData.params.forEach(function (param) {
+                        if (param.fileName) {
+                            var field = {
+                                name: param.name,
+                                filename: param.fileName,
+                                contents: param.value
+                            };
+                            if (param.contentType) {
+                                field.headers = { 'Content-Type': param.contentType };
+                            }
+                            fields_1.push(field);
+                        }
+                        else if (param.value) {
+                            fields_1.push({
+                                name: param.name,
+                                contents: param.value
+                            });
+                        }
+                    });
+                }
+                if (fields_1.length) {
+                    requestPush("'multipart' => ".concat((0, helpers_1.convertType)(fields_1, opts.indent + opts.indent, opts.indent)), 1);
+                    // Guzzle adds its own boundary for multipart requests.
+                    if ((0, headers_1.hasHeader)(headersObj, 'content-type')) {
+                        if (String((0, headers_1.getHeader)(headersObj, 'content-type')).indexOf('boundary')) {
+                            var headerName = (0, headers_1.getHeaderName)(headersObj, 'content-type');
+                            if (headerName) {
+                                delete headersObj[headerName];
+                            }
+                        }
+                    }
+                }
+                break;
+            }
+            default:
+                if (postData.text) {
+                    requestPush("'body' => ".concat((0, helpers_1.convertType)(postData.text), ","), 1);
+                }
+        }
+        // construct headers
+        var headers = Object.keys(headersObj)
+            .sort()
+            .map(function (key) {
+            return "".concat(opts.indent).concat(opts.indent, "'").concat(key, "' => '").concat(headersObj[key], "',");
+        });
+        // construct cookies
+        var cookieString = cookies
+            .map(function (cookie) { return "".concat(encodeURIComponent(cookie.name), "=").concat(encodeURIComponent(cookie.value)); })
+            .join('; ');
+        if (cookieString.length) {
+            headers.push("".concat(opts.indent).concat(opts.indent, "'cookie' => '").concat(cookieString, "',"));
+        }
+        if (headers.length) {
+            requestPush("'headers' => [", 1);
+            requestPush(headers.join('\n'));
+            requestPush('],', 1);
+        }
+        push('$client = new \\GuzzleHttp\\Client();');
+        blank();
+        if (requestCode.length) {
+            push("$response = $client->request('".concat(method, "', '").concat(fullUrl, "', ["));
+            push(requestJoin());
+            push(']);');
+        }
+        else {
+            push("$response = $client->request('".concat(method, "', '").concat(fullUrl, "');"));
+        }
+        blank();
+        push('echo $response->getBody();');
+        if (!opts.noTags && opts.closingTag) {
+            blank();
+            push('?>');
+        }
+        return join();
+    }
+};

package/dist/targets/php/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare const convertType: (obj: any[] | any, indent?: string, lastIndent?: string) => any;
+export declare const supportedMethods: string[];

package/dist/targets/php/helpers.js

@@ -0,0 +1,63 @@
+"use strict";
+exports.__esModule = true;
+exports.supportedMethods = exports.convertType = void 0;
+var convertType = function (obj, indent, lastIndent) {
+    lastIndent = lastIndent || '';
+    indent = indent || '';
+    switch (Object.prototype.toString.call(obj)) {
+        case '[object Null]':
+            return 'null';
+        case '[object Undefined]':
+            return 'null';
+        case '[object String]':
+            return "'".concat(obj.replace(/\\/g, '\\\\').replace(/'/g, "'"), "'");
+        case '[object Number]':
+            return obj.toString();
+        case '[object Array]': {
+            var contents = obj.map(function (item) { return (0, exports.convertType)(item, "".concat(indent).concat(indent), indent); }).join(",\n".concat(indent));
+            return "[\n".concat(indent).concat(contents, "\n").concat(lastIndent, "]");
+        }
+        case '[object Object]': {
+            var result = [];
+            // eslint-disable-next-line no-restricted-syntax
+            for (var i in obj) {
+                if (Object.prototype.hasOwnProperty.call(obj, i)) {
+                    result.push("".concat((0, exports.convertType)(i, indent), " => ").concat((0, exports.convertType)(obj[i], "".concat(indent).concat(indent), indent)));
+                }
+            }
+            return "[\n".concat(indent).concat(result.join(",\n".concat(indent)), "\n").concat(lastIndent, "]");
+        }
+        default:
+            return 'null';
+    }
+};
+exports.convertType = convertType;
+exports.supportedMethods = [
+    'ACL',
+    'BASELINE_CONTROL',
+    'CHECKIN',
+    'CHECKOUT',
+    'CONNECT',
+    'COPY',
+    'DELETE',
+    'GET',
+    'HEAD',
+    'LABEL',
+    'LOCK',
+    'MERGE',
+    'MKACTIVITY',
+    'MKCOL',
+    'MKWORKSPACE',
+    'MOVE',
+    'OPTIONS',
+    'POST',
+    'PROPFIND',
+    'PROPPATCH',
+    'PUT',
+    'REPORT',
+    'TRACE',
+    'UNCHECKOUT',
+    'UNLOCK',
+    'UPDATE',
+    'VERSION_CONTROL',
+];

package/dist/targets/php/http1/client.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @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 interface Http1Options {
+    closingTag?: boolean;
+    noTags?: boolean;
+    shortTags?: boolean;
+}
+export declare const http1: Client<Http1Options>;

package/dist/targets/php/http1/client.js

@@ -0,0 +1,90 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @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);
+};
+exports.__esModule = true;
+exports.http1 = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+var helpers_1 = require("../helpers");
+exports.http1 = {
+    info: {
+        key: 'http1',
+        title: 'HTTP v1',
+        link: 'http://php.net/manual/en/book.http.php',
+        description: 'PHP with pecl/http v1'
+    },
+    convert: function (_a, options) {
+        var method = _a.method, url = _a.url, postData = _a.postData, queryObj = _a.queryObj, headersObj = _a.headersObj, cookiesObj = _a.cookiesObj;
+        var opts = __assign({ closingTag: false, indent: '  ', noTags: false, shortTags: false }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, blank = _b.blank, join = _b.join;
+        if (!opts.noTags) {
+            push(opts.shortTags ? '<?' : '<?php');
+            blank();
+        }
+        if (!helpers_1.supportedMethods.includes(method.toUpperCase())) {
+            push("HttpRequest::methodRegister('".concat(method, "');"));
+        }
+        push('$request = new HttpRequest();');
+        push("$request->setUrl(".concat((0, helpers_1.convertType)(url), ");"));
+        if (helpers_1.supportedMethods.includes(method.toUpperCase())) {
+            push("$request->setMethod(HTTP_METH_".concat(method.toUpperCase(), ");"));
+        }
+        else {
+            push("$request->setMethod(HttpRequest::HTTP_METH_".concat(method.toUpperCase(), ");"));
+        }
+        blank();
+        if (Object.keys(queryObj).length) {
+            push("$request->setQueryData(".concat((0, helpers_1.convertType)(queryObj, opts.indent), ");"));
+            blank();
+        }
+        if (Object.keys(headersObj).length) {
+            push("$request->setHeaders(".concat((0, helpers_1.convertType)(headersObj, opts.indent), ");"));
+            blank();
+        }
+        if (Object.keys(cookiesObj).length) {
+            push("$request->setCookies(".concat((0, helpers_1.convertType)(cookiesObj, opts.indent), ");"));
+            blank();
+        }
+        switch (postData.mimeType) {
+            case 'application/x-www-form-urlencoded':
+                push("$request->setContentType(".concat((0, helpers_1.convertType)(postData.mimeType), ");"));
+                push("$request->setPostFields(".concat((0, helpers_1.convertType)(postData.paramsObj, opts.indent), ");"));
+                blank();
+                break;
+            default:
+                if (postData.text) {
+                    push("$request->setBody(".concat((0, helpers_1.convertType)(postData.text), ");"));
+                    blank();
+                }
+        }
+        push('try {');
+        push('$response = $request->send();', 1);
+        blank();
+        push('echo $response->getBody();', 1);
+        push('} catch (HttpException $ex) {');
+        push('echo $ex;', 1);
+        push('}');
+        if (!opts.noTags && opts.closingTag) {
+            blank();
+            push('?>');
+        }
+        return join();
+    }
+};

package/dist/targets/php/http2/client.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using curl-ext.
+ *
+ * @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 interface Http2Options {
+    closingTag?: boolean;
+    noTags?: boolean;
+    shortTags?: boolean;
+}
+export declare const http2: Client<Http2Options>;