@readme/httpsnippet 4.0.0 → 4.0.3

package/dist/helpers/code-builder.d.ts

@@ -0,0 +1,49 @@
+export declare type PostProcessor = (unreplacedCode: string) => string;
+export interface CodeBuilderOptions {
+    /**
+     * Desired indentation character for aggregated lines of code
+     * @default ''
+     */
+    indent?: string;
+    /**
+     * Desired character to join each line of code
+     * @default \n
+     */
+    join?: string;
+}
+export declare class CodeBuilder {
+    postProcessors: PostProcessor[];
+    code: string[];
+    indentationCharacter: string;
+    lineJoin: string;
+    /**
+     * Helper object to format and aggragate lines of code.
+     * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
+     */
+    constructor({ indent, join }?: CodeBuilderOptions);
+    /**
+     * Add given indentation level to given line of code
+     */
+    indentLine: (line: string, indentationLevel?: number) => string;
+    /**
+     * Add the line at the beginning of the current lines
+     */
+    unshift: (line: string, indentationLevel?: number) => void;
+    /**
+     * Add the line at the end of the current lines
+     */
+    push: (line: string, indentationLevel?: number) => void;
+    /**
+     * Add an empty line at the end of current lines
+     */
+    blank: () => void;
+    /**
+     * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added
+     */
+    join: () => string;
+    /**
+     * Often when writing modules you may wish to add a literal tag or bit of metadata that you wish to transform after other processing as a final step.
+     * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.
+     */
+    addPostProcessor: (postProcessor: PostProcessor) => void;
+}

package/dist/helpers/code-builder.js

@@ -0,0 +1,91 @@
+"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;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+exports.__esModule = true;
+exports.CodeBuilder = void 0;
+var DEFAULT_INDENTATION_CHARACTER = '';
+var DEFAULT_LINE_JOIN = '\n';
+var CodeBuilder = /** @class */ (function () {
+    /**
+     * Helper object to format and aggragate lines of code.
+     * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
+     */
+    function CodeBuilder(_a) {
+        var _b = _a === void 0 ? {} : _a, indent = _b.indent, join = _b.join;
+        var _this = this;
+        this.postProcessors = [];
+        this.code = [];
+        this.indentationCharacter = DEFAULT_INDENTATION_CHARACTER;
+        this.lineJoin = DEFAULT_LINE_JOIN;
+        /**
+         * Add given indentation level to given line of code
+         */
+        this.indentLine = function (line, indentationLevel) {
+            if (indentationLevel === void 0) { indentationLevel = 0; }
+            var indent = _this.indentationCharacter.repeat(indentationLevel);
+            return "".concat(indent).concat(line);
+        };
+        /**
+         * Add the line at the beginning of the current lines
+         */
+        this.unshift = function (line, indentationLevel) {
+            var newLine = _this.indentLine(line, indentationLevel);
+            _this.code.unshift(newLine);
+        };
+        /**
+         * Add the line at the end of the current lines
+         */
+        this.push = function (line, indentationLevel) {
+            var newLine = _this.indentLine(line, indentationLevel);
+            _this.code.push(newLine);
+        };
+        /**
+         * Add an empty line at the end of current lines
+         */
+        this.blank = function () {
+            _this.code.push('');
+        };
+        /**
+         * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added
+         */
+        this.join = function () {
+            var unreplacedCode = _this.code.join(_this.lineJoin);
+            var replacedOutput = _this.postProcessors.reduce(function (accumulator, replacer) { return replacer(accumulator); }, unreplacedCode);
+            return replacedOutput;
+        };
+        /**
+         * Often when writing modules you may wish to add a literal tag or bit of metadata that you wish to transform after other processing as a final step.
+         * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.
+         */
+        this.addPostProcessor = function (postProcessor) {
+            _this.postProcessors = __spreadArray(__spreadArray([], __read(_this.postProcessors), false), [postProcessor], false);
+        };
+        this.indentationCharacter = indent || DEFAULT_INDENTATION_CHARACTER;
+        this.lineJoin = join !== null && join !== void 0 ? join : DEFAULT_LINE_JOIN;
+    }
+    return CodeBuilder;
+}());
+exports.CodeBuilder = CodeBuilder;

package/dist/helpers/form-data.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license https://raw.githubusercontent.com/node-fetch/node-fetch/master/LICENSE.md
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 - 2020 Node Fetch Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * Extracted from https://github.com/node-fetch/node-fetch/blob/64c5c296a0250b852010746c76144cb9e14698d9/src/utils/form-data.js
+ */
+import type FormData from 'form-data';
+export declare const isBlob: (object: any) => boolean;
+export declare const formDataIterator: (form: FormData, boundary: string) => Generator<any, void, any>;

package/dist/helpers/form-data.js

@@ -0,0 +1,157 @@
+"use strict";
+/**
+ * @license https://raw.githubusercontent.com/node-fetch/node-fetch/master/LICENSE.md
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 - 2020 Node Fetch Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * Extracted from https://github.com/node-fetch/node-fetch/blob/64c5c296a0250b852010746c76144cb9e14698d9/src/utils/form-data.js
+ */
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+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;
+};
+exports.__esModule = true;
+exports.formDataIterator = exports.isBlob = void 0;
+var carriage = '\r\n';
+var dashes = '-'.repeat(2);
+var NAME = Symbol.toStringTag;
+var isBlob = function (object) {
+    return typeof object === 'object' &&
+        typeof object.arrayBuffer === 'function' &&
+        typeof object.type === 'string' &&
+        typeof object.stream === 'function' &&
+        typeof object.constructor === 'function' &&
+        /^(Blob|File)$/.test(object[NAME]);
+};
+exports.isBlob = isBlob;
+var getFooter = function (boundary) { return "".concat(dashes).concat(boundary).concat(dashes).concat(carriage.repeat(2)); };
+var getHeader = function (boundary, name, field) {
+    var header = '';
+    header += "".concat(dashes).concat(boundary).concat(carriage);
+    header += "Content-Disposition: form-data; name=\"".concat(name, "\"");
+    if ((0, exports.isBlob)(field)) {
+        header += "; filename=\"".concat(field.name, "\"").concat(carriage);
+        header += "Content-Type: ".concat(field.type || 'application/octet-stream');
+    }
+    return "".concat(header).concat(carriage.repeat(2));
+};
+var formDataIterator = function (form, boundary) {
+    var form_1, form_1_1, _a, name, value, e_1_1;
+    var e_1, _b;
+    return __generator(this, function (_c) {
+        switch (_c.label) {
+            case 0:
+                _c.trys.push([0, 10, 11, 12]);
+                form_1 = __values(form), form_1_1 = form_1.next();
+                _c.label = 1;
+            case 1:
+                if (!!form_1_1.done) return [3 /*break*/, 9];
+                _a = __read(form_1_1.value, 2), name = _a[0], value = _a[1];
+                return [4 /*yield*/, getHeader(boundary, name, value)];
+            case 2:
+                _c.sent();
+                if (!(0, exports.isBlob)(value)) return [3 /*break*/, 4];
+                return [5 /*yield**/, __values(value.stream())];
+            case 3:
+                _c.sent();
+                return [3 /*break*/, 6];
+            case 4: return [4 /*yield*/, value];
+            case 5:
+                _c.sent();
+                _c.label = 6;
+            case 6: return [4 /*yield*/, carriage];
+            case 7:
+                _c.sent();
+                _c.label = 8;
+            case 8:
+                form_1_1 = form_1.next();
+                return [3 /*break*/, 1];
+            case 9: return [3 /*break*/, 12];
+            case 10:
+                e_1_1 = _c.sent();
+                e_1 = { error: e_1_1 };
+                return [3 /*break*/, 12];
+            case 11:
+                try {
+                    if (form_1_1 && !form_1_1.done && (_b = form_1["return"])) _b.call(form_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+                return [7 /*endfinally*/];
+            case 12: return [4 /*yield*/, getFooter(boundary)];
+            case 13:
+                _c.sent();
+                return [2 /*return*/];
+        }
+    });
+};
+exports.formDataIterator = formDataIterator;

package/dist/helpers/har-validator.d.ts

@@ -0,0 +1,9 @@
+import type { ErrorObject } from 'ajv';
+import type { Request } from 'har-format';
+export declare class HARError extends Error {
+    name: string;
+    message: string;
+    errors: ErrorObject[];
+    constructor(errors: ErrorObject[]);
+}
+export declare const validateHarRequest: (request: any) => request is Request;

package/dist/helpers/har-validator.js

@@ -0,0 +1,76 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.validateHarRequest = exports.HARError = void 0;
+var ajv_1 = __importDefault(require("ajv"));
+var schema = __importStar(require("har-schema"));
+var HARError = /** @class */ (function (_super) {
+    __extends(HARError, _super);
+    function HARError(errors) {
+        var _this = _super.call(this) || this;
+        _this.name = 'HARError';
+        _this.message = 'validation failed';
+        _this.errors = [];
+        _this.errors = errors;
+        Error.captureStackTrace(_this, _this.constructor);
+        return _this;
+    }
+    return HARError;
+}(Error));
+exports.HARError = HARError;
+var ajv = new ajv_1["default"]({
+    allErrors: true
+});
+ajv.addSchema(schema);
+var validateHarRequest = function (request) {
+    var validate = ajv.getSchema('request.json');
+    if (!validate) {
+        throw new Error('failed to find HAR request schema');
+    }
+    var valid = validate(request);
+    if (!valid && validate.errors) {
+        throw new HARError(validate.errors);
+    }
+    return true;
+};
+exports.validateHarRequest = validateHarRequest;

package/dist/helpers/headers.d.ts

@@ -0,0 +1,18 @@
+declare type Headers<T> = Record<string, T>;
+/**
+ * Given a headers object retrieve a specific header out of it via a case-insensitive key.
+ */
+export declare const getHeaderName: <T>(headers: Headers<T>, name: string) => string | undefined;
+/**
+ * Given a headers object retrieve the contents of a header out of it via a case-insensitive key.
+ */
+export declare const getHeader: <T>(headers: Headers<T>, name: string) => T | undefined;
+/**
+ * Determine if a given case-insensitive header exists within a header object.
+ */
+export declare const hasHeader: <T>(headers: Headers<T>, name: string) => boolean;
+/**
+ * Determines if a given MIME type is JSON, or a variant of such.
+ */
+export declare const isMimeTypeJSON: (mimeType: string) => boolean;
+export {};

package/dist/helpers/headers.js

@@ -0,0 +1,33 @@
+"use strict";
+exports.__esModule = true;
+exports.isMimeTypeJSON = exports.hasHeader = exports.getHeader = exports.getHeaderName = void 0;
+/**
+ * Given a headers object retrieve a specific header out of it via a case-insensitive key.
+ */
+var getHeaderName = function (headers, name) {
+    return Object.keys(headers).find(function (header) { return header.toLowerCase() === name.toLowerCase(); });
+};
+exports.getHeaderName = getHeaderName;
+/**
+ * Given a headers object retrieve the contents of a header out of it via a case-insensitive key.
+ */
+var getHeader = function (headers, name) {
+    var headerName = (0, exports.getHeaderName)(headers, name);
+    if (!headerName) {
+        return undefined;
+    }
+    return headers[headerName];
+};
+exports.getHeader = getHeader;
+/**
+ * Determine if a given case-insensitive header exists within a header object.
+ */
+var hasHeader = function (headers, name) { return Boolean((0, exports.getHeaderName)(headers, name)); };
+exports.hasHeader = hasHeader;
+/**
+ * Determines if a given MIME type is JSON, or a variant of such.
+ */
+var isMimeTypeJSON = function (mimeType) {
+    return ['application/json', 'application/x-json', 'text/json', 'text/x-json', '+json'].some(function (type) { return mimeType.indexOf(type) > -1; });
+};
+exports.isMimeTypeJSON = isMimeTypeJSON;

package/dist/helpers/reducer.d.ts

@@ -0,0 +1,5 @@
+export declare type ReducedHelperObject = Record<string, string[] | string>;
+export declare const reducer: <T extends {
+    name: string;
+    value: string;
+}>(accumulator: ReducedHelperObject, pair: T) => ReducedHelperObject;

package/dist/helpers/reducer.js

@@ -0,0 +1,19 @@
+"use strict";
+exports.__esModule = true;
+exports.reducer = void 0;
+var reducer = function (accumulator, pair) {
+    var currentValue = accumulator[pair.name];
+    if (currentValue === undefined) {
+        accumulator[pair.name] = pair.value;
+        return accumulator;
+    }
+    // If we already have it as array just push the value
+    if (Array.isArray(currentValue)) {
+        currentValue.push(pair.value);
+        return accumulator;
+    }
+    // convert to array since now we have more than one value for this key
+    accumulator[pair.name] = [currentValue, pair.value];
+    return accumulator;
+};
+exports.reducer = reducer;

package/dist/helpers/shell.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Use 'strong quoting' using single quotes so that we only need to deal with nested single quote characters.
+ * see: http://wiki.bash-hackers.org/syntax/quoting#strong_quoting
+ */
+export declare const quote: (value?: string) => string;
+export declare const escape: (value: string) => string;

package/dist/helpers/shell.js

@@ -0,0 +1,20 @@
+"use strict";
+exports.__esModule = true;
+exports.escape = exports.quote = void 0;
+/**
+ * Use 'strong quoting' using single quotes so that we only need to deal with nested single quote characters.
+ * see: http://wiki.bash-hackers.org/syntax/quoting#strong_quoting
+ */
+var quote = function (value) {
+    if (value === void 0) { value = ''; }
+    var safe = /^[a-z0-9-_/.@%^=:]+$/i;
+    var isShellSafe = safe.test(value);
+    if (isShellSafe) {
+        return value;
+    }
+    // if the value is not shell safe, then quote it
+    return "'".concat(value.replace(/'/g, "'\\''"), "'");
+};
+exports.quote = quote;
+var escape = function (value) { return value.replace(/\r/g, '\\r').replace(/\n/g, '\\n'); };
+exports.escape = escape;

package/dist/helpers/utils.d.ts

@@ -0,0 +1,6 @@
+import type { ClientInfo, TargetId, TargetInfo } from '../targets/targets';
+export interface AvailableTarget extends TargetInfo {
+    clients: ClientInfo[];
+}
+export declare const availableTargets: () => AvailableTarget[];
+export declare const extname: (targetId: TargetId) => "" | `.${string}`;

package/dist/helpers/utils.js

@@ -0,0 +1,21 @@
+"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);
+};
+exports.__esModule = true;
+exports.extname = exports.availableTargets = void 0;
+var targets_1 = require("../targets/targets");
+var availableTargets = function () {
+    return Object.keys(targets_1.targets).map(function (targetId) { return (__assign(__assign({}, targets_1.targets[targetId].info), { clients: Object.keys(targets_1.targets[targetId].clientsById).map(function (clientId) { return targets_1.targets[targetId].clientsById[clientId].info; }) })); });
+};
+exports.availableTargets = availableTargets;
+var extname = function (targetId) { var _a; return ((_a = targets_1.targets[targetId]) === null || _a === void 0 ? void 0 : _a.info.extname) || ''; };
+exports.extname = extname;

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="node" />
+import type { Param, PostDataCommon, Request as NpmHarRequest } from 'har-format';
+import type { UrlWithParsedQuery } from 'url';
+import type { ReducedHelperObject } from './helpers/reducer';
+import type { ClientId, TargetId } from './targets/targets';
+export { availableTargets, extname } from './helpers/utils';
+export { addTarget, addTargetClient } from './targets/targets';
+/** is this wrong?  yes.  according to the spec (http://www.softwareishard.com/blog/har-12-spec/#postData) it's technically wrong since `params` and `text` are (by the spec) mutually exclusive.  However, in practice, this is not what is often the case.
+ *
+ * In general, this library takes a _descriptive_ rather than _perscriptive_ approach (see https://amyrey.web.unc.edu/classes/ling-101-online/tutorials/understanding-prescriptive-vs-descriptive-grammar/).
+ *
+ * Then, in addition to that, it really adds to complexity with TypeScript (TypeScript takes this constraint very very seriously) in a way that's not actually super useful.  So, we treat this object as though it could have both or either of `params` and/or `text`.
+ */
+declare type PostDataBase = PostDataCommon & {
+    text?: string;
+    params?: Param[];
+};
+export declare type HarRequest = Omit<NpmHarRequest, 'postData'> & {
+    postData: PostDataBase;
+};
+export interface RequestExtras {
+    postData: PostDataBase & {
+        jsonObj?: ReducedHelperObject;
+        paramsObj?: ReducedHelperObject;
+        boundary?: string;
+    };
+    fullUrl: string;
+    queryObj: ReducedHelperObject;
+    headersObj: ReducedHelperObject;
+    uriObj: UrlWithParsedQuery;
+    cookiesObj: ReducedHelperObject;
+    allHeaders: ReducedHelperObject;
+}
+export declare type Request = HarRequest & RequestExtras;
+interface Entry {
+    request: Partial<HarRequest>;
+}
+interface HarEntry {
+    log: {
+        version: string;
+        creator: {
+            name: string;
+            version: string;
+        };
+        entries: Entry[];
+    };
+}
+export interface HTTPSnippetOptions {
+    harIsAlreadyEncoded?: boolean;
+}
+export declare class HTTPSnippet {
+    requests: Request[];
+    constructor(input: HarEntry | HarRequest, opts?: HTTPSnippetOptions);
+    prepare: (harRequest: HarRequest, options: HTTPSnippetOptions) => {
+        allHeaders: {
+            [x: string]: string | string[];
+        };
+        fullUrl: string;
+        url: string;
+        uriObj: {
+            query: ReducedHelperObject;
+            search: string;
+            path: string | null;
+            auth: string | null;
+            hash: string | null;
+            host: string | null;
+            hostname: string | null;
+            href: string;
+            pathname: string | null;
+            protocol: string | null;
+            slashes: boolean | null;
+            port: string | null;
+        };
+        comment?: string | undefined;
+        method: string;
+        httpVersion: string;
+        cookies: import("har-format").Cookie[];
+        headers: import("har-format").Header[];
+        queryString: import("har-format").QueryString[];
+        headersSize: number;
+        bodySize: number;
+        postData: PostDataCommon & {
+            text?: string | undefined;
+            params?: Param[] | undefined;
+        } & {
+            jsonObj?: ReducedHelperObject | undefined;
+            paramsObj?: ReducedHelperObject | undefined;
+            boundary?: string | undefined;
+        };
+        queryObj: ReducedHelperObject;
+        headersObj: ReducedHelperObject;
+        cookiesObj: ReducedHelperObject;
+    };
+    convert: (targetId: TargetId, clientId?: ClientId, options?: any) => string | false | string[];
+}