@readme/httpsnippet 5.0.0 → 5.1.1

package/dist/targets/python/target.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.python = void 0;
 var client_1 = require("./requests/client");
 exports.python = {
@@ -7,10 +7,10 @@ exports.python = {
         key: 'python',
         title: 'Python',
         extname: '.py',
-        "default": 'requests',
-        cli: 'python3 %s'
+        default: 'requests',
+        cli: 'python3 %s',
     },
     clientsById: {
-        requests: client_1.requests
-    }
+        requests: client_1.requests,
+    },
 };

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

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.httr = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
 exports.httr = {
@@ -7,7 +7,7 @@ exports.httr = {
         key: 'httr',
         title: 'httr',
         link: 'https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html',
-        description: 'httr: Tools for Working with URLs and HTTP'
+        description: 'httr: Tools for Working with URLs and HTTP',
     },
     convert: function (_a) {
         var url = _a.url, queryObj = _a.queryObj, queryString = _a.queryString, postData = _a.postData, allHeaders = _a.allHeaders, method = _a.method;
@@ -112,5 +112,5 @@ exports.httr = {
         // Print response
         push('content(response, "text")');
         return join();
-    }
+    },
 };

package/dist/targets/r/target.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.r = void 0;
 var client_1 = require("./httr/client");
 exports.r = {
@@ -7,9 +7,9 @@ exports.r = {
         key: 'r',
         title: 'R',
         extname: '.r',
-        "default": 'httr'
+        default: 'httr',
     },
     clientsById: {
-        httr: client_1.httr
-    }
+        httr: client_1.httr,
+    },
 };

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

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.native = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
 exports.native = {
@@ -7,7 +7,7 @@ exports.native = {
         key: 'native',
         title: 'net::http',
         link: 'http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html',
-        description: 'Ruby HTTP client'
+        description: 'Ruby HTTP client',
     },
     convert: function (_a) {
         var uriObj = _a.uriObj, rawMethod = _a.method, fullUrl = _a.fullUrl, postData = _a.postData, allHeaders = _a.allHeaders;
@@ -65,5 +65,5 @@ exports.native = {
         push('response = http.request(request)');
         push('puts response.read_body');
         return join();
-    }
+    },
 };

package/dist/targets/ruby/target.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.ruby = void 0;
 var client_1 = require("./native/client");
 exports.ruby = {
@@ -7,9 +7,9 @@ exports.ruby = {
         key: 'ruby',
         title: 'Ruby',
         extname: '.rb',
-        "default": 'native'
+        default: 'native',
     },
     clientsById: {
-        native: client_1.native
-    }
+        native: client_1.native,
+    },
 };

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

@@ -10,7 +10,7 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.curl = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
 var headers_1 = require("../../../helpers/headers");
@@ -26,7 +26,7 @@ var params = {
     header: 'H',
     cookie: 'b',
     form: 'F',
-    data: 'd'
+    data: 'd',
 };
 var getArg = function (short) { return function (longName) {
     if (short) {
@@ -43,13 +43,16 @@ exports.curl = {
         key: 'curl',
         title: 'cURL',
         link: 'http://curl.haxx.se/',
-        description: 'cURL is a command line tool and library for transferring data with URL syntax'
+        description: 'cURL is a command line tool and library for transferring data with URL syntax',
     },
     convert: function (_a, options) {
         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;
+        // 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 arg = getArg(short);
         var formattedUrl = (0, shell_1.quote)(fullUrl);
@@ -141,10 +144,10 @@ exports.curl = {
                             // Basically this boils down to `--data @- <<EOF...EOF` vs `--data '...'`.
                             builtPayload = true;
                             if (postData.text.indexOf("'") > 0) {
-                                push("".concat(binary ? '--data-binary' : arg('data'), " @- <<EOF\n").concat(JSON.stringify(jsonPayload, null, indent || ' '), "\nEOF"));
+                                push("".concat(binary ? '--data-binary' : arg('data'), " @- <<EOF\n").concat(JSON.stringify(jsonPayload, null, indentJSON), "\nEOF"));
                             }
                             else {
-                                push("".concat(binary ? '--data-binary' : arg('data'), " '\n").concat(JSON.stringify(jsonPayload, null, indent || ' '), "\n'"));
+                                push("".concat(binary ? '--data-binary' : arg('data'), " '\n").concat(JSON.stringify(jsonPayload, null, indentJSON), "\n'"));
                             }
                         }
                         catch (err) {
@@ -157,5 +160,5 @@ exports.curl = {
                 }
         }
         return join();
-    }
+    },
 };

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

@@ -10,7 +10,7 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.httpie = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
 var shell_1 = require("../../../helpers/shell");
@@ -19,7 +19,7 @@ exports.httpie = {
         key: 'httpie',
         title: 'HTTPie',
         link: 'http://httpie.org/',
-        description: 'a CLI, cURL-like tool for humans'
+        description: 'a CLI, cURL-like tool for humans',
     },
     convert: function (_a, options) {
         var allHeaders = _a.allHeaders, postData = _a.postData, queryObj = _a.queryObj, fullUrl = _a.fullUrl, method = _a.method, url = _a.url;
@@ -27,7 +27,7 @@ exports.httpie = {
         var _b = new code_builder_1.CodeBuilder({
             indent: opts.indent,
             // @ts-expect-error SEEMS LEGIT
-            join: opts.indent !== false ? " \\\n".concat(opts.indent) : ' '
+            join: opts.indent !== false ? " \\\n".concat(opts.indent) : ' ',
         }), push = _b.push, join = _b.join, unshift = _b.unshift;
         var raw = false;
         var flags = [];
@@ -98,5 +98,5 @@ exports.httpie = {
             unshift("echo ".concat(postDataText, " | "));
         }
         return join();
-    }
+    },
 };

package/dist/targets/shell/target.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.shell = void 0;
 var client_1 = require("./curl/client");
 var client_2 = require("./httpie/client");
@@ -9,12 +9,12 @@ exports.shell = {
         key: 'shell',
         title: 'Shell',
         extname: '.sh',
-        "default": 'curl',
-        cli: '%s'
+        default: 'curl',
+        cli: '%s',
     },
     clientsById: {
         curl: client_1.curl,
         httpie: client_2.httpie,
-        wget: client_3.wget
-    }
+        wget: client_3.wget,
+    },
 };

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

@@ -10,7 +10,7 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.wget = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
 var shell_1 = require("../../../helpers/shell");
@@ -19,7 +19,7 @@ exports.wget = {
         key: 'wget',
         title: 'Wget',
         link: 'https://www.gnu.org/software/wget/',
-        description: 'a free software package for retrieving files using HTTP, HTTPS'
+        description: 'a free software package for retrieving files using HTTP, HTTPS',
     },
     convert: function (_a, options) {
         var method = _a.method, postData = _a.postData, allHeaders = _a.allHeaders, fullUrl = _a.fullUrl;
@@ -42,5 +42,5 @@ exports.wget = {
         push(opts.short ? '-O' : '--output-document');
         push("- ".concat((0, shell_1.quote)(fullUrl)));
         return join();
-    }
+    },
 };

package/dist/targets/swift/helpers.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.literalRepresentation = exports.literalDeclaration = void 0;
 /**
  * Create an string of given length filled with blank spaces

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

@@ -26,7 +26,7 @@ var __read = (this && this.__read) || function (o, n) {
     }
     return ar;
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.nsurlsession = void 0;
 var code_builder_1 = require("../../../helpers/code-builder");
 var helpers_1 = require("../helpers");
@@ -35,7 +35,7 @@ exports.nsurlsession = {
         key: 'nsurlsession',
         title: 'NSURLSession',
         link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
-        description: "Foundation's NSURLSession request"
+        description: "Foundation's NSURLSession request",
     },
     convert: function (_a, options) {
         var allHeaders = _a.allHeaders, postData = _a.postData, fullUrl = _a.fullUrl, method = _a.method;
@@ -44,7 +44,7 @@ exports.nsurlsession = {
         // Markers for headers to be created as litteral objects and later be set on the NSURLRequest if exist
         var req = {
             hasHeaders: false,
-            hasBody: false
+            hasBody: false,
         };
         // We just want to make sure people understand that is the only dependency
         push('import Foundation');
@@ -143,5 +143,5 @@ exports.nsurlsession = {
         blank();
         push('dataTask.resume()');
         return join();
-    }
+    },
 };

package/dist/targets/swift/target.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.swift = void 0;
 var client_1 = require("./nsurlsession/client");
 exports.swift = {
@@ -7,9 +7,9 @@ exports.swift = {
         key: 'swift',
         title: 'Swift',
         extname: '.swift',
-        "default": 'nsurlsession'
+        default: 'nsurlsession',
     },
     clientsById: {
-        nsurlsession: client_1.nsurlsession
-    }
+        nsurlsession: client_1.nsurlsession,
+    },
 };

package/dist/targets/targets.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.addTargetClient = exports.isClient = exports.addTarget = exports.isTarget = exports.targets = void 0;
 var target_1 = require("./c/target");
 var target_2 = require("./clojure/target");
@@ -37,7 +37,7 @@ exports.targets = {
     r: target_15.r,
     ruby: target_16.ruby,
     shell: target_17.shell,
-    swift: target_18.swift
+    swift: target_18.swift,
 };
 var isTarget = function (target) {
     if (typeof target !== 'object' || target === null || Array.isArray(target)) {
@@ -73,8 +73,8 @@ var isTarget = function (target) {
     if (!Object.prototype.hasOwnProperty.call(target.info, 'default')) {
         throw new Error('targets must have an `info` object with the property `default`');
     }
-    if (!Object.prototype.hasOwnProperty.call(target.clientsById, target.info["default"])) {
-        throw new Error("target ".concat(target.info.key, " is configured with a default client ").concat(target.info["default"], ", but no such client was found in the property `clientsById` (found ").concat(JSON.stringify(Object.keys(target.clientsById)), ")"));
+    if (!Object.prototype.hasOwnProperty.call(target.clientsById, target.info.default)) {
+        throw new Error("target ".concat(target.info.key, " is configured with a default client ").concat(target.info.default, ", but no such client was found in the property `clientsById` (found ").concat(JSON.stringify(Object.keys(target.clientsById)), ")"));
     }
     Object.values(target.clientsById).forEach(exports.isClient);
     return true;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.0.0",
+  "version": "5.1.1",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -57,27 +57,26 @@
     "test": "jest --coverage"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^10.3.2",
-    "@types/eslint": "^8.4.1",
+    "@readme/eslint-config": "^10.5.2",
+    "@types/eslint": "^8.37.0",
     "@types/event-stream": "^4.0.0",
     "@types/har-format": "^1.2.8",
-    "@types/jest": "^28.1.6",
-    "@types/node": "^18.11.18",
+    "@types/jest": "^29.5.1",
+    "@types/node": "^18.16.3",
     "@types/qs": "^6.9.7",
     "@types/stringify-object": "^4.0.2",
-    "eslint": "^8.31.0",
-    "glob": "^8.0.1",
-    "jest": "^28.0.3",
-    "prettier": "^2.8.1",
+    "eslint": "^8.39.0",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
     "require-directory": "^2.1.1",
-    "ts-jest": "^28.0.5",
-    "type-fest": "^3.5.0",
-    "typescript": "^4.9.4"
+    "ts-jest": "^29.1.0",
+    "type-fest": "^3.9.0",
+    "typescript": "^5.0.4"
   },
   "dependencies": {
     "event-stream": "4.0.1",
     "form-data": "^4.0.0",
-    "qs": "^6.10.1",
+    "qs": "^6.11.1",
     "stringify-object": "^3.3.0"
   },
   "prettier": "@readme/eslint-config/prettier"