@readme/httpsnippet 4.0.1 → 4.0.2

package/dist/package.json

@@ -0,0 +1,86 @@
+{
+    "version": "4.0.2",
+    "name": "@readme/httpsnippet",
+    "description": "HTTP Request snippet generator for *most* languages",
+    "homepage": "https://github.com/readmeio/httpsnippet",
+    "license": "MIT",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "keywords": [
+        "api",
+        "clojure",
+        "csharp",
+        "curl",
+        "go",
+        "har",
+        "http",
+        "httpie",
+        "httr",
+        "java",
+        "javascript",
+        "jquery",
+        "kotlin",
+        "objc",
+        "objective-c",
+        "ocaml",
+        "php",
+        "python",
+        "request",
+        "requests",
+        "ruby",
+        "shell",
+        "snippet",
+        "swift",
+        "swift",
+        "unirest",
+        "xhr",
+        "xmlhttprequest"
+    ],
+    "engines": {
+        "node": ">=14"
+    },
+    "files": [
+        "dist"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/readmeio/httpsnippet.git"
+    },
+    "scripts": {
+        "build": "tsc --build tsconfig.build.json",
+        "clean": "tsc --build tsconfig.build.json --clean",
+        "lint": "eslint .",
+        "prebuild": "npm run clean",
+        "prepack": "npm run build",
+        "pretest": "npm run lint",
+        "prettier": "prettier --list-different --write \"./**/**.js\"",
+        "test": "jest --coverage"
+    },
+    "devDependencies": {
+        "@readme/eslint-config": "^8.8.3",
+        "@types/eslint": "^8.4.1",
+        "@types/event-stream": "^4.0.0",
+        "@types/har-format": "^1.2.8",
+        "@types/jest": "^27.4.1",
+        "@types/node": "^16.11.26",
+        "@types/qs": "^6.9.7",
+        "@types/stringify-object": "^4.0.1",
+        "eslint": "^8.19.0",
+        "glob": "^8.0.1",
+        "jest": "^28.0.3",
+        "prettier": "^2.7.1",
+        "require-directory": "^2.1.1",
+        "ts-jest": "^28.0.5",
+        "type-fest": "^2.12.2",
+        "typescript": "^4.6.3"
+    },
+    "dependencies": {
+        "ajv": "^6.12.6",
+        "event-stream": "4.0.1",
+        "form-data": "^4.0.0",
+        "har-schema": "^2.0.0",
+        "qs": "^6.10.1",
+        "stringify-object": "^3.3.0"
+    },
+    "prettier": "@readme/eslint-config/prettier"
+}

package/dist/src/fixtures/customTarget.js

@@ -0,0 +1,15 @@
+"use strict";
+exports.__esModule = true;
+exports.customTarget = void 0;
+var client_1 = require("../targets/node/request/client");
+exports.customTarget = {
+    info: {
+        key: 'js-variant',
+        title: 'JavaScript Variant',
+        extname: '.js',
+        "default": 'request'
+    },
+    clientsById: {
+        request: client_1.request
+    }
+};

package/dist/src/fixtures/mimetypes.js

@@ -0,0 +1,77 @@
+"use strict";
+exports.__esModule = true;
+exports.mimetypes = void 0;
+exports.mimetypes = {
+    'multipart/mixed': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'multipart/mixed',
+            text: ''
+        }
+    },
+    'multipart/related': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'multipart/related',
+            text: ''
+        }
+    },
+    'multipart/form-data': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'multipart/form-data',
+            text: ''
+        }
+    },
+    'multipart/alternative': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'multipart/alternative',
+            text: ''
+        }
+    },
+    'application/x-www-form-urlencoded': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'application/x-www-form-urlencoded',
+            text: ''
+        }
+    },
+    'text/json': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'text/json',
+            text: ''
+        }
+    },
+    'text/x-json': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'text/x-json',
+            text: ''
+        }
+    },
+    'application/x-json': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'application/x-json',
+            text: ''
+        }
+    },
+    'invalid-json': {
+        method: 'POST',
+        url: 'https://httpbin.org/anything',
+        postData: {
+            mimeType: 'application/json',
+            text: 'foo/bar'
+        }
+    }
+};

package/dist/src/fixtures/requests/application-form-encoded.js

@@ -0,0 +1,69 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'POST',
+                    url: 'https://httpbin.org/anything',
+                    headers: [
+                        {
+                            name: 'content-type',
+                            value: 'application/x-www-form-urlencoded'
+                        },
+                    ],
+                    postData: {
+                        mimeType: 'application/x-www-form-urlencoded',
+                        params: [
+                            {
+                                name: 'foo',
+                                value: 'bar'
+                            },
+                            {
+                                name: 'hello',
+                                value: 'world'
+                            },
+                        ]
+                    }
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            args: {},
+                            data: '',
+                            files: {},
+                            form: {
+                                foo: 'bar',
+                                hello: 'world'
+                            },
+                            headers: {
+                                'Content-Type': 'application/x-www-form-urlencoded'
+                            },
+                            json: null,
+                            method: 'POST',
+                            url: 'https://httpbin.org/anything'
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/application-json.js

@@ -0,0 +1,72 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'POST',
+                    url: 'https://httpbin.org/anything',
+                    headers: [
+                        {
+                            name: 'content-type',
+                            value: 'application/json'
+                        },
+                    ],
+                    postData: {
+                        mimeType: 'application/json',
+                        text: '{"number":1,"string":"f\\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}'
+                    }
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            args: {},
+                            data: '{\n  "number": 1,\n  "string": "f\\"oo",\n  "arr": [\n    1,\n    2,\n    3\n  ],\n  "nested": {\n    "a": "b"\n  },\n  "arr_mix": [\n    1,\n    "a",\n    {\n      "arr_mix_nested": {}\n    }\n  ],\n  "boolean": false\n}',
+                            files: {},
+                            form: {},
+                            headers: {
+                                'Content-Type': 'application/json'
+                            },
+                            json: {
+                                arr: [1, 2, 3],
+                                arr_mix: [
+                                    1,
+                                    'a',
+                                    {
+                                        arr_mix_nested: {}
+                                    },
+                                ],
+                                boolean: false,
+                                nested: {
+                                    a: 'b'
+                                },
+                                number: 1,
+                                string: 'f"oo'
+                            },
+                            method: 'POST',
+                            url: 'https://httpbin.org/anything'
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/cookies.js

@@ -0,0 +1,51 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'GET',
+                    url: 'https://httpbin.org/cookies',
+                    cookies: [
+                        {
+                            name: 'foo',
+                            value: 'bar'
+                        },
+                        {
+                            name: 'bar',
+                            value: 'baz'
+                        },
+                    ]
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            cookies: {
+                                bar: 'baz',
+                                foo: 'bar'
+                            }
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/custom-method.js

@@ -0,0 +1,41 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'PROPFIND',
+                    url: 'https://httpbin.org/anything'
+                },
+                response: {
+                    status: 405,
+                    statusText: 'Method Not Allowed',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'text/html'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'text/html',
+                        text: [
+                            '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">',
+                            '<title>405 Method Not Allowed</title>',
+                            '<h1>Method Not Allowed</h1>',
+                            '<p>The method is not allowed for the requested URL.</p>',
+                        ].join('\n')
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/full.js

@@ -0,0 +1,99 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'POST',
+                    url: 'https://httpbin.org/anything?key=value',
+                    httpVersion: 'HTTP/1.1',
+                    queryString: [
+                        {
+                            name: 'foo',
+                            value: 'bar'
+                        },
+                        {
+                            name: 'foo',
+                            value: 'baz'
+                        },
+                        {
+                            name: 'baz',
+                            value: 'abc'
+                        },
+                    ],
+                    headers: [
+                        {
+                            name: 'accept',
+                            value: 'application/json'
+                        },
+                        {
+                            name: 'content-type',
+                            value: 'application/x-www-form-urlencoded'
+                        },
+                    ],
+                    cookies: [
+                        {
+                            name: 'foo',
+                            value: 'bar'
+                        },
+                        {
+                            name: 'bar',
+                            value: 'baz'
+                        },
+                    ],
+                    postData: {
+                        mimeType: 'application/x-www-form-urlencoded',
+                        params: [
+                            {
+                                name: 'foo',
+                                value: 'bar'
+                            },
+                        ]
+                    }
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            args: {
+                                baz: 'abc',
+                                foo: ['bar', 'baz'],
+                                key: 'value'
+                            },
+                            data: '',
+                            files: {},
+                            form: {
+                                foo: 'bar'
+                            },
+                            headers: {
+                                Accept: 'application/json',
+                                'Content-Type': 'application/x-www-form-urlencoded',
+                                Cookie: 'foo=bar; bar=baz'
+                            },
+                            json: null,
+                            method: 'POST',
+                            url: 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/headers.js

@@ -0,0 +1,56 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'GET',
+                    url: 'https://httpbin.org/headers',
+                    headers: [
+                        {
+                            name: 'accept',
+                            value: 'application/json'
+                        },
+                        {
+                            name: 'x-foo',
+                            value: 'Bar'
+                        },
+                        {
+                            name: 'x-bar',
+                            value: 'Foo'
+                        },
+                    ]
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            headers: {
+                                Accept: 'application/json',
+                                'X-Bar': 'Foo',
+                                'X-Foo': 'Bar'
+                            }
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/http-insecure.js

@@ -0,0 +1,45 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'GET',
+                    url: 'http://httpbin.org/anything'
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            args: {},
+                            data: '',
+                            files: {},
+                            form: {},
+                            headers: {},
+                            json: null,
+                            method: 'GET',
+                            url: 'http://httpbin.org/anything'
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};

package/dist/src/fixtures/requests/jsonObj-multiline.js

@@ -0,0 +1,59 @@
+"use strict";
+module.exports = {
+    log: {
+        version: '1.2',
+        creator: {
+            name: 'HTTPSnippet',
+            version: '1.0.0'
+        },
+        entries: [
+            {
+                request: {
+                    method: 'POST',
+                    url: 'https://httpbin.org/anything',
+                    headers: [
+                        {
+                            name: 'content-type',
+                            value: 'application/json'
+                        },
+                    ],
+                    postData: {
+                        text: '{\n  "foo": "bar"\n}',
+                        mimeType: 'application/json'
+                    }
+                },
+                response: {
+                    status: 200,
+                    statusText: 'OK',
+                    httpVersion: 'HTTP/1.1',
+                    headers: [
+                        {
+                            name: 'Content-Type',
+                            value: 'application/json'
+                        },
+                    ],
+                    content: {
+                        size: -1,
+                        mimeType: 'application/json',
+                        text: JSON.stringify({
+                            args: {},
+                            data: '{\n  "foo": "bar"\n}',
+                            files: {},
+                            form: {},
+                            headers: {
+                                'Content-Type': 'application/json'
+                            },
+                            json: {
+                                foo: 'bar'
+                            },
+                            method: 'POST',
+                            url: 'https://httpbin.org/anything'
+                        })
+                    },
+                    headersSize: -1,
+                    bodySize: -1
+                }
+            },
+        ]
+    }
+};