@readme/httpsnippet 6.0.0 → 6.1.0

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

@@ -1,15 +1,4 @@
 "use strict";
-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);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.http2 = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
@@ -23,12 +12,14 @@ exports.http2 = {
         description: 'PHP with pecl/http v2',
     },
     convert: function (_a, options) {
+        var _b;
         var postData = _a.postData, headersObj = _a.headersObj, method = _a.method, queryObj = _a.queryObj, cookiesObj = _a.cookiesObj, url = _a.url;
-        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 (options === void 0) { options = {}; }
+        var _c = options.closingTag, closingTag = _c === void 0 ? false : _c, _d = options.indent, indent = _d === void 0 ? '  ' : _d, _e = options.noTags, noTags = _e === void 0 ? false : _e, _f = options.shortTags, shortTags = _f === void 0 ? false : _f;
+        var _g = new code_builder_1.CodeBuilder({ indent: indent }), push = _g.push, blank = _g.blank, join = _g.join;
         var hasBody = false;
-        if (!opts.noTags) {
-            push(opts.shortTags ? '<?' : '<?php');
+        if (!noTags) {
+            push(shortTags ? '<?' : '<?php');
             blank();
         }
         push('$client = new http\\Client;');
@@ -37,7 +28,7 @@ exports.http2 = {
         switch (postData.mimeType) {
             case 'application/x-www-form-urlencoded':
                 push('$body = new http\\Message\\Body;');
-                push("$body->append(new http\\QueryString(".concat((0, helpers_1.convertType)(postData.paramsObj, opts.indent), "));"));
+                push("$body->append(new http\\QueryString(".concat((0, helpers_1.convertType)(postData.paramsObj, indent), "));"));
                 blank();
                 hasBody = true;
                 break;
@@ -62,13 +53,13 @@ exports.http2 = {
                         fields_1[name] = value;
                     }
                 });
-                var field = Object.keys(fields_1).length ? (0, helpers_1.convertType)(fields_1, opts.indent) : 'null';
-                var formValue = files_1.length ? (0, helpers_1.convertType)(files_1, opts.indent) : 'null';
+                var field = Object.keys(fields_1).length ? (0, helpers_1.convertType)(fields_1, indent) : 'null';
+                var formValue = files_1.length ? (0, helpers_1.convertType)(files_1, indent) : 'null';
                 push('$body = new http\\Message\\Body;');
                 push("$body->addForm(".concat(field, ", ").concat(formValue, ");"));
                 // remove the contentType header
                 if ((0, headers_1.hasHeader)(headersObj, 'content-type')) {
-                    if (String((0, headers_1.getHeader)(headersObj, 'content-type')).indexOf('boundary')) {
+                    if ((_b = (0, headers_1.getHeader)(headersObj, 'content-type')) === null || _b === void 0 ? void 0 : _b.indexOf('boundary')) {
                         var headerName = (0, headers_1.getHeaderName)(headersObj, 'content-type');
                         if (headerName) {
                             delete headersObj[headerName];
@@ -79,6 +70,11 @@ exports.http2 = {
                 hasBody = true;
                 break;
             }
+            case 'application/json':
+                push('$body = new http\\Message\\Body;');
+                push("$body->append(json_encode(".concat((0, helpers_1.convertType)(postData.jsonObj, indent), "));"));
+                hasBody = true;
+                break;
             default:
                 if (postData.text) {
                     push('$body = new http\\Message\\Body;');
@@ -94,23 +90,23 @@ exports.http2 = {
             blank();
         }
         if (Object.keys(queryObj).length) {
-            push("$request->setQuery(new http\\QueryString(".concat((0, helpers_1.convertType)(queryObj, opts.indent), "));"));
+            push("$request->setQuery(new http\\QueryString(".concat((0, helpers_1.convertType)(queryObj, indent), "));"));
             blank();
         }
         if (Object.keys(headersObj).length) {
-            push("$request->setHeaders(".concat((0, helpers_1.convertType)(headersObj, opts.indent), ");"));
+            push("$request->setHeaders(".concat((0, helpers_1.convertType)(headersObj, indent), ");"));
             blank();
         }
         if (Object.keys(cookiesObj).length) {
             blank();
-            push("$client->setCookies(".concat((0, helpers_1.convertType)(cookiesObj, opts.indent), ");"));
+            push("$client->setCookies(".concat((0, helpers_1.convertType)(cookiesObj, indent), ");"));
             blank();
         }
         push('$client->enqueue($request)->send();');
         push('$response = $client->getResponse();');
         blank();
         push('echo $response->getBody();');
-        if (!opts.noTags && opts.closingTag) {
+        if (!noTags && closingTag) {
             blank();
             push('?>');
         }

package/dist/targets/powershell/common.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generatePowershellConvert = void 0;
 var code_builder_1 = require("../../helpers/code-builder");
+var escape_1 = require("../../helpers/escape");
 var headers_1 = require("../../helpers/headers");
 var generatePowershellConvert = function (command) {
     var convert = function (_a) {
@@ -20,7 +21,7 @@ var generatePowershellConvert = function (command) {
             headers.forEach(function (key) {
                 if (key !== 'connection') {
                     // Not allowed
-                    push("$headers.Add(\"".concat(key, "\", \"").concat(headersObj[key], "\")"));
+                    push("$headers.Add(\"".concat(key, "\", \"").concat((0, escape_1.escapeString)(headersObj[key], { escapeChar: '`' }), "\")"));
                 }
             });
             commandOptions.push('-Headers $headers');
@@ -38,7 +39,7 @@ var generatePowershellConvert = function (command) {
             commandOptions.push('-WebSession $session');
         }
         if (postData.text) {
-            commandOptions.push("-ContentType '".concat((0, headers_1.getHeader)(allHeaders, 'content-type'), "'"));
+            commandOptions.push("-ContentType '".concat((0, escape_1.escapeString)((0, headers_1.getHeader)(allHeaders, 'content-type'), { delimiter: "'", escapeChar: '`' }), "'"));
             commandOptions.push("-Body '".concat(postData.text, "'"));
         }
         push("$response = ".concat(command, " -Uri '").concat(fullUrl, "' -Method ").concat(method, " ").concat(commandOptions.join(' ')).trim());

package/dist/targets/python/helpers.js

@@ -1,29 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.literalRepresentation = void 0;
-/**
- * Create an string of given length filled with blank spaces
- *
- * @param length Length of the array to return
- * @param str String to pad out with
- */
-function buildString(length, str) {
-    return str.repeat(length);
-}
 /**
  * Create a string corresponding to a Dictionary or Array literal representation with pretty option
  * and indentation.
  */
 function concatValues(concatType, values, pretty, indentation, indentLevel) {
-    var currentIndent = buildString(indentLevel, indentation);
-    var closingBraceIndent = buildString(indentLevel - 1, indentation);
+    var currentIndent = indentation.repeat(indentLevel);
+    var closingBraceIndent = indentation.repeat(indentLevel - 1);
     var join = pretty ? ",\n".concat(currentIndent) : ', ';
     var openingBrace = concatType === 'object' ? '{' : '[';
     var closingBrace = concatType === 'object' ? '}' : ']';
     if (pretty) {
         return "".concat(openingBrace, "\n").concat(currentIndent).concat(values.join(join), "\n").concat(closingBraceIndent).concat(closingBrace);
     }
-    return openingBrace + values.join(join) + closingBrace;
+    if (concatType === 'object' && values.length > 0) {
+        return "".concat(openingBrace, " ").concat(values.join(join), " ").concat(closingBrace);
+    }
+    return "".concat(openingBrace).concat(values.join(join)).concat(closingBrace);
 }
 /**
  * Create a valid Python string of a literal value according to its type.

package/dist/targets/python/requests/client.js

@@ -13,8 +13,10 @@ var __assign = (this && this.__assign) || function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.requests = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
+var escape_1 = require("../../../helpers/escape");
 var headers_1 = require("../../../helpers/headers");
 var helpers_1 = require("../helpers");
+var builtInMethods = ['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'];
 exports.requests = {
     info: {
         key: 'requests',
@@ -94,6 +96,11 @@ exports.requests = {
                 });
                 break;
             default: {
+                if (postData.mimeType === 'application/x-www-form-urlencoded' && postData.paramsObj) {
+                    push("payload = ".concat((0, helpers_1.literalRepresentation)(postData.paramsObj, opts)));
+                    hasPayload = true;
+                    break;
+                }
                 var stringPayload = JSON.stringify(postData.text);
                 if (stringPayload) {
                     push("payload = ".concat(stringPayload));
@@ -109,7 +116,7 @@ exports.requests = {
         }
         else if (headerCount === 1) {
             Object.keys(headers).forEach(function (header) {
-                push("headers = {\"".concat(header, "\": \"").concat(headers[header], "\"}"));
+                push("headers = {\"".concat(header, "\": \"").concat((0, escape_1.escapeForDoubleQuotes)(headers[header]), "\"}"));
                 blank();
             });
         }
@@ -118,10 +125,10 @@ exports.requests = {
             push('headers = {');
             Object.keys(headers).forEach(function (header) {
                 if (count_1 !== headerCount) {
-                    push("\"".concat(header, "\": \"").concat(headers[header], "\","), 1);
+                    push("\"".concat(header, "\": \"").concat((0, escape_1.escapeForDoubleQuotes)(headers[header]), "\","), 1);
                 }
                 else {
-                    push("\"".concat(header, "\": \"").concat(headers[header], "\""), 1);
+                    push("\"".concat(header, "\": \"").concat((0, escape_1.escapeForDoubleQuotes)(headers[header]), "\""), 1);
                 }
                 count_1 += 1;
             });
@@ -129,14 +136,9 @@ exports.requests = {
             blank();
         }
         // Construct request
-        var request;
-        // Method list pulled from their api reference https://docs.python-requests.org/en/latest/api/#requests.head
-        if (['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {
-            request = "response = requests.".concat(method.toLowerCase(), "(url");
-        }
-        else {
-            request = "response = requests.request(\"".concat(method, "\", url");
-        }
+        var request = builtInMethods.includes(method)
+            ? "response = requests.".concat(method.toLowerCase(), "(url")
+            : "response = requests.request(\"".concat(method, "\", url");
         if (hasPayload) {
             if (jsonPayload) {
                 request += ', json=payload';
@@ -154,7 +156,6 @@ exports.requests = {
         request += ')';
         push(request);
         blank();
-        // Print response
         push('print(response.text)');
         return join();
     },

package/dist/targets/r/httr/client.js

@@ -1,7 +1,25 @@
 "use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.httr = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
+var escape_1 = require("../../../helpers/escape");
+var headers_1 = require("../../../helpers/headers");
 exports.httr = {
     info: {
         key: 'httr',
@@ -68,40 +86,36 @@ exports.httr = {
             }
         }
         // Construct headers
-        var headers = [];
-        var cookies;
-        var accept;
-        Object.keys(allHeaders).forEach(function (header) {
-            if (header.toLowerCase() === 'accept') {
-                accept = ", accept(\"".concat(allHeaders[header], "\")");
-            }
-            else if (header.toLowerCase() === 'cookie') {
-                cookies = ", set_cookies(`".concat(String(allHeaders[header])
-                    .replace(/;/g, '", `')
-                    .replace(/` /g, '`')
-                    .replace(/[=]/g, '` = "'), "\")");
-            }
-            else if (header.toLowerCase() !== 'content-type') {
-                headers.push("'".concat(header, "' = '").concat(allHeaders[header], "'"));
-            }
-        });
+        var cookieHeader = (0, headers_1.getHeader)(allHeaders, 'cookie');
+        var acceptHeader = (0, headers_1.getHeader)(allHeaders, 'accept');
+        var setCookies = cookieHeader
+            ? "set_cookies(`".concat(String(cookieHeader).replace(/;/g, '", `').replace(/` /g, '`').replace(/[=]/g, '` = "'), "\")")
+            : undefined;
+        var setAccept = acceptHeader ? "accept(\"".concat((0, escape_1.escapeForDoubleQuotes)(acceptHeader), "\")") : undefined;
+        var setContentType = "content_type(\"".concat((0, escape_1.escapeForDoubleQuotes)(postData.mimeType), "\")");
+        var otherHeaders = Object.entries(allHeaders)
+            // These headers are all handled separately:
+            .filter(function (_a) {
+            var _b = __read(_a, 1), key = _b[0];
+            return !['cookie', 'accept', 'content-type'].includes(key.toLowerCase());
+        })
+            .map(function (_a) {
+            var _b = __read(_a, 2), key = _b[0], value = _b[1];
+            return "'".concat(key, "' = '").concat((0, escape_1.escapeForSingleQuotes)(value), "'");
+        })
+            .join(', ');
+        var setHeaders = otherHeaders ? "add_headers(".concat(otherHeaders, ")") : undefined;
         // Construct request
         var request = "response <- VERB(\"".concat(method, "\", url");
         if (payload) {
             request += ', body = payload';
         }
-        if (headers.length) {
-            request += ", add_headers(".concat(headers.join(', '), ")");
-        }
         if (queryString.length) {
             request += ', query = queryString';
         }
-        request += ", content_type(\"".concat(postData.mimeType, "\")");
-        if (typeof accept !== 'undefined') {
-            request += accept;
-        }
-        if (typeof cookies !== 'undefined') {
-            request += cookies;
+        var headerAdditions = [setHeaders, setContentType, setAccept, setCookies].filter(function (x) { return !!x; }).join(', ');
+        if (headerAdditions) {
+            request += ", ".concat(headerAdditions);
         }
         if (postData.text || postData.jsonObj || postData.params) {
             request += ', encode = encode';

package/dist/targets/ruby/native/client.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.native = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
+var escape_1 = require("../../../helpers/escape");
 exports.native = {
     info: {
         key: 'native',
@@ -14,9 +15,6 @@ exports.native = {
         var _b = new code_builder_1.CodeBuilder(), push = _b.push, blank = _b.blank, join = _b.join;
         push("require 'uri'");
         push("require 'net/http'");
-        if (uriObj.protocol === 'https:') {
-            push("require 'openssl'");
-        }
         blank();
         // To support custom methods we check for the supported methods
         // and if doesn't exist then we build a custom class for it
@@ -55,7 +53,7 @@ exports.native = {
         var headers = Object.keys(allHeaders);
         if (headers.length) {
             headers.forEach(function (key) {
-                push("request[\"".concat(key, "\"] = '").concat(allHeaders[key], "'"));
+                push("request[\"".concat(key, "\"] = '").concat((0, escape_1.escapeForSingleQuotes)(allHeaders[key]), "'"));
             });
         }
         if (postData.text) {

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

@@ -10,10 +10,10 @@
  */
 import type { Client } from '../../targets';
 export interface CurlOptions {
-    short?: boolean;
     binary?: boolean;
     globOff?: boolean;
     indent?: string | false;
-    escapeBrackets?: boolean;
+    prettifyJson?: boolean;
+    short?: boolean;
 }
 export declare const curl: Client<CurlOptions>;

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

@@ -19,14 +19,15 @@ var shell_1 = require("../../../helpers/shell");
  * This is a const record with keys that correspond to the long names and values that correspond to the short names for cURL arguments.
  */
 var params = {
-    globoff: 'g',
-    request: 'X',
-    'url ': '',
     'http1.0': '0',
-    header: 'H',
+    'url ': '',
     cookie: 'b',
-    form: 'F',
     data: 'd',
+    form: 'F',
+    globoff: 'g',
+    header: 'H',
+    insecure: 'k',
+    request: 'X',
 };
 var getArg = function (short) { return function (longName) {
     if (short) {
@@ -49,16 +50,13 @@ exports.curl = {
         var _b;
         var fullUrl = _a.fullUrl, method = _a.method, httpVersion = _a.httpVersion, headersObj = _a.headersObj, allHeaders = _a.allHeaders, postData = _a.postData;
         if (options === void 0) { options = {}; }
-        var _c = options.indent, indent = _c === void 0 ? '  ' : _c, _d = options.short, short = _d === void 0 ? false : _d, _e = options.binary, binary = _e === void 0 ? false : _e, _f = options.globOff, globOff = _f === void 0 ? false : _f, _g = options.escapeBrackets, escapeBrackets = _g === void 0 ? false : _g;
+        var _c = options.indent, indent = _c === void 0 ? '  ' : _c, _d = options.short, short = _d === void 0 ? false : _d, _e = options.binary, binary = _e === void 0 ? false : _e, _f = options.globOff, globOff = _f === void 0 ? false : _f;
         // In the interest of having nicer looking snippets JSON should be indented separately from the
         // main command argument indentation.
         var indentJSON = '  ';
-        var _h = new code_builder_1.CodeBuilder(__assign(__assign({}, (typeof indent === 'string' ? { indent: indent } : {})), { join: indent !== false ? " \\\n".concat(indent) : ' ' })), push = _h.push, join = _h.join;
+        var _g = new code_builder_1.CodeBuilder(__assign(__assign({}, (typeof indent === 'string' ? { indent: indent } : {})), { join: indent !== false ? " \\\n".concat(indent) : ' ' })), push = _g.push, join = _g.join;
         var arg = getArg(short);
         var formattedUrl = (0, shell_1.quote)(fullUrl);
-        if (escapeBrackets) {
-            formattedUrl = formattedUrl.replace(/\[/g, '\\[').replace(/\]/g, '\\]');
-        }
         push("curl ".concat(arg('request'), " ").concat(method));
         if (globOff) {
             formattedUrl = unescape(formattedUrl);
@@ -68,6 +66,10 @@ exports.curl = {
         if (httpVersion === 'HTTP/1.0') {
             push(arg('http1.0'));
         }
+        if ((0, headers_1.getHeader)(allHeaders, 'accept-encoding')) {
+            // note: there is no shorthand for this cURL option
+            push('--compressed');
+        }
         // if multipart form data, we want to remove the boundary
         if (postData.mimeType === 'multipart/form-data') {
             var contentTypeHeaderName = (0, headers_1.getHeaderName)(headersObj, 'content-type');

package/dist/targets/swift/nsurlsession/client.js

@@ -38,9 +38,10 @@ exports.nsurlsession = {
         description: "Foundation's NSURLSession request",
     },
     convert: function (_a, options) {
+        var _b;
         var allHeaders = _a.allHeaders, postData = _a.postData, fullUrl = _a.fullUrl, method = _a.method;
         var opts = __assign({ indent: '  ', pretty: true, timeout: '10' }, 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 }), push = _c.push, blank = _c.blank, join = _c.join;
         // Markers for headers to be created as litteral objects and later be set on the NSURLRequest if exist
         var req = {
             hasHeaders: false,
@@ -61,8 +62,8 @@ exports.nsurlsession = {
                     // we make it easier for the user to edit it according to his or her needs after pasting.
                     // The user can just add/remove lines adding/removing body parameters.
                     blank();
-                    if (postData.params) {
-                        var _c = __read(postData.params), head = _c[0], tail = _c.slice(1);
+                    if ((_b = postData.params) === null || _b === void 0 ? void 0 : _b.length) {
+                        var _d = __read(postData.params), head = _d[0], tail = _d.slice(1);
                         push("let postData = NSMutableData(data: \"".concat(head.name, "=").concat(head.value, "\".data(using: String.Encoding.utf8)!)"));
                         tail.forEach(function (_a) {
                             var name = _a.name, value = _a.value;

package/dist/targets/targets.d.ts

@@ -4,27 +4,27 @@ import type { Merge } from 'type-fest';
 export type TargetId = keyof typeof targets;
 export type ClientId = string;
 export interface ClientInfo {
+    description: string;
     key: ClientId;
-    title: string;
     link: string;
-    description: string;
+    title: string;
 }
 export type Converter<T extends Record<string, any>> = (request: Request, options?: Merge<CodeBuilderOptions, T>) => string;
 export interface Client<T extends Record<string, any> = Record<string, any>> {
-    info: ClientInfo;
     convert: Converter<T>;
+    info: ClientInfo;
 }
 export type Extension = `.${string}` | null;
 export interface TargetInfo {
+    cli?: string;
+    default: string;
+    extname: Extension;
     key: TargetId;
     title: string;
-    extname: Extension;
-    default: string;
-    cli?: string;
 }
 export interface Target {
-    info: TargetInfo;
     clientsById: Record<ClientId, Client>;
+    info: TargetInfo;
 }
 export declare const targets: {
     c: Target;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.0.0",
+  "version": "6.1.0",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -57,20 +57,20 @@
     "test": "jest --coverage"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^10.5.3",
-    "@types/eslint": "^8.40.0",
+    "@readme/eslint-config": "^10.6.0",
+    "@types/eslint": "^8.40.2",
     "@types/event-stream": "^4.0.1",
-    "@types/har-format": "^1.2.8",
+    "@types/har-format": "^1.2.11",
     "@types/jest": "^29.5.2",
-    "@types/node": "^20.2.5",
+    "@types/node": "^20.3.2",
     "@types/qs": "^6.9.7",
     "@types/stringify-object": "^4.0.2",
-    "eslint": "^8.41.0",
+    "eslint": "^8.43.0",
     "jest": "^29.5.0",
     "prettier": "^2.8.8",
     "require-directory": "^2.1.1",
     "ts-jest": "^29.1.0",
-    "type-fest": "^3.11.1",
+    "type-fest": "^3.12.0",
     "typescript": "^5.1.3"
   },
   "dependencies": {