@readme/httpsnippet 8.0.0 → 8.1.0

package/README.md

@@ -16,13 +16,13 @@ npm install --save @readme/httpsnippet
 
 ## Usage
 
-### HTTPSnippet(source [, options])
+### HTTPSnippet(input [, options])
 
-#### source
+#### input
 
 _Required_ Type: `object`
 
-Name of [conversion target](https://github.com/Kong/httpsnippet/wiki/Targets)
+The [HAR](http://www.softwareishard.com/blog/har-12-spec/#request) request object to generate a snippet for.
 
 ```ts
 import { HTTPSnippet } from 'httpsnippet';
@@ -128,13 +128,13 @@ HTTPSnippet.addTarget(customLanguageTarget);
 
 ### addTargetClient(target, client)
 
-### Target
+#### Target
 
 _Required_ Type: `string`
 
 Name of [conversion target](https://github.com/Kong/httpsnippet/wiki/Targets)
 
-### Client
+#### Client
 
 _Required_ Type: `object`
 
@@ -145,6 +145,34 @@ import { customClient } from 'httpsnippet-for-my-node-http-client';
 HTTPSnippet.addTargetClient('node', customClient);
 ```
 
+### addClientPlugin(plugin)
+
+#### Plugin
+
+_Required_ Type: `object`
+
+The client plugin to install.
+
+```ts
+addClientPlugin({
+  target: 'node',
+  client: {
+    info: {
+      key: 'custom',
+      title: 'Custom HTTP library',
+      link: 'https://example.com',
+      description: 'A custom HTTP library',
+      extname: '.custom',
+    },
+    convert: () => {
+      return 'This was generated from a custom client.';
+    },
+  },
+});
+```
+
+The above example will create a new `custom` client snippet generator for the `node` target.
+
 ## Documentation
 
 At the heart of this module is the [HAR Format](http://www.softwareishard.com/blog/har-12-spec/#request) as the HTTP request description format, please review some of the sample JSON HAR Request objects in [test fixtures](/test/fixtures/requests), or read the [HAR Docs](http://www.softwareishard.com/blog/har-12-spec/#request) for more details.
@@ -161,6 +189,7 @@ There are some major differences between this library and the [httpsnippet](http
 - The main `HTTPSnippet` export contains an `options` argument for an `harIsAlreadyEncoded` option for disabling [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs.
   - We added this because all HARs that we interact with already have this data escaped and this option prevents them from being double encoded, thus corrupting the data.
 - Does not support the `insecureSkipVerify` option on `go:native`, `node:native`, `ruby:native`, and `shell:curl` as we don't want snippets generated for our users to bypass SSL certificate verification.
+- Includes a full plugin system, `#addClientPlugin`, for quick installation of a target client.
 - Node
   - `fetch`
     - Body payloads are treated as an object literal and wrapped within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads. This also applies to the JS `fetch` target as well.

package/dist/{chunk-IAWYVBVW.js → chunk-XPQ7YGTP.js}

@@ -431,7 +431,8 @@ var restsharp = {
     title: "RestSharp",
     link: "http://restsharp.org/",
     description: "Simple REST and HTTP API Client for .NET",
-    extname: ".cs"
+    extname: ".cs",
+    installation: "dotnet add package RestSharp"
   },
   convert: ({ method, fullUrl, headersObj, cookies, postData, uriObj }) => {
     const { push, join } = new CodeBuilder();
@@ -843,7 +844,8 @@ var axios = {
     title: "Axios",
     link: "https://github.com/axios/axios",
     description: "Promise based HTTP client for the browser and node.js",
-    extname: ".js"
+    extname: ".js",
+    installation: "npm install axios --save"
   },
   convert: ({ allHeaders, method, url, queryObj, postData }, options) => {
     const opts = {
@@ -1275,7 +1277,8 @@ var axios2 = {
     title: "Axios",
     link: "https://github.com/axios/axios",
     description: "Promise based HTTP client for the browser and node.js",
-    extname: ".cjs"
+    extname: ".cjs",
+    install: "npm install axios --save"
   },
   convert: ({ method, fullUrl, allHeaders, postData }, options) => {
     const opts = {
@@ -1337,7 +1340,8 @@ var fetch2 = {
     title: "Fetch",
     link: "https://github.com/bitinn/node-fetch",
     description: "Simplified HTTP node-fetch client",
-    extname: ".cjs"
+    extname: ".cjs",
+    installation: "npm install node-fetch@2 --save"
   },
   convert: ({ method, fullUrl, postData, headersObj, cookies }, options) => {
     const opts = {
@@ -1511,7 +1515,8 @@ var request = {
     title: "Request",
     link: "https://github.com/request/request",
     description: "Simplified HTTP request client",
-    extname: ".cjs"
+    extname: ".cjs",
+    installation: "npm install request --save"
   },
   convert: ({ method, url, fullUrl, postData, headersObj, cookies }, options) => {
     const opts = {
@@ -1875,7 +1880,8 @@ var cohttp = {
     title: "CoHTTP",
     link: "https://github.com/mirage/ocaml-cohttp",
     description: "Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml",
-    extname: ".ml"
+    extname: ".ml",
+    installation: "opam install cohttp-lwt-unix cohttp-async"
   },
   convert: ({ fullUrl, allHeaders, postData, method }, options) => {
     const opts = {
@@ -2121,7 +2127,8 @@ var guzzle = {
     title: "Guzzle",
     link: "http://docs.guzzlephp.org/en/stable/",
     description: "PHP with Guzzle",
-    extname: ".php"
+    extname: ".php",
+    installation: "composer require guzzlehttp/guzzle"
   },
   convert: ({ postData, fullUrl, method, cookies, headersObj }, options) => {
     const opts = {
@@ -2546,7 +2553,8 @@ var requests = {
     title: "Requests",
     link: "http://docs.python-requests.org/en/latest/api/#requests.request",
     description: "Requests HTTP library",
-    extname: ".py"
+    extname: ".py",
+    installation: "python -m pip install requests"
   },
   convert: ({ fullUrl, postData, allHeaders, method }, options) => {
     const opts = {
@@ -3007,7 +3015,8 @@ var httpie = {
     title: "HTTPie",
     link: "http://httpie.org/",
     description: "a CLI, cURL-like tool for humans",
-    extname: ".sh"
+    extname: ".sh",
+    installation: "brew install httpie"
   },
   convert: ({ allHeaders, postData, queryObj, fullUrl, method, url }, options) => {
     const opts = {
@@ -3425,6 +3434,9 @@ var isClient = (client) => {
   }
   return true;
 };
+var addClientPlugin = (plugin) => {
+  addTargetClient(plugin.target, plugin.client);
+};
 var addTargetClient = (targetId, client) => {
   if (!isClient(client)) ;
   if (!Object.prototype.hasOwnProperty.call(targets, targetId)) {
@@ -3438,6 +3450,6 @@ var addTargetClient = (targetId, client) => {
   targets[targetId].clientsById[client.info.key] = client;
 };
 
-export { addTarget, addTargetClient, getHeaderName, isClient, isTarget, targets };
+export { addClientPlugin, addTarget, addTargetClient, getHeaderName, isClient, isTarget, targets };
 //# sourceMappingURL=out.js.map
-//# sourceMappingURL=chunk-IAWYVBVW.js.map
+//# sourceMappingURL=chunk-XPQ7YGTP.js.map