npm - browsermob-proxy-api-client - Versions diffs - 0.0.3 → 0.0.5 - Mend

browsermob-proxy-api-client 0.0.3 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,47 @@
 # BrowserMob Proxy API Client
-Client library  for [browsermob-proxy] API
+Client library for [BrowserMob Proxy] API
-[browsermob-proxy]: https://github.com/lightbody/browsermob-proxy
+Refer to [REST API] section of BrowserMob Proxy documentation for detailed information
+[![npm](https://img.shields.io/npm/v/browsermob-proxy-api-client.svg?style=flat-square)](https://www.npmjs.org/package/browsermob-proxy-api-client)
+[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=browsermob-proxy-api-client&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.now.sh/result?p=browsermob-proxy-api-client)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/browsermob-proxy-api-client?style=flat-square)](https://bundlephobia.com/package/browsermob-proxy-api-client@latest)
+[![npm downloads](https://img.shields.io/npm/dm/browsermob-proxy-api-client.svg?style=flat-square)](https://npm-stat.com/charts.html?package=browsermob-proxy-api-client)
+[![Known Vulnerabilities](https://snyk.io/test/npm/browsermob-proxy-api-client/badge.svg?style=flat-square)](https://snyk.io/test/npm/browsermob-proxy-api-client)
+## Installing
+Using npm:
+```bash
+$ npm install browsermob-proxy-api-client
+```
+Using yarn:
+```bash
+$ yarn add browsermob-proxy-api-client
+```
+## Example
+```typescript
+import BrowserMobProxyAPIClient from 'browsermob-proxy-api-client';
+const proxy = new BrowserMobProxyAPIClient('localhost', '8080');
+const port = await proxy.start();
+if (port) {
+  try {
+    await proxy.startHar(port);
+    // exec `curl google.com --proxy localhost:${port}`
+    const har = await proxy.getHar(port);
+  } catch (e) {
+    console.error(e);
+  } finally {
+    await proxy.stop(port);
+  }
+}
+```
+[BrowserMob Proxy]: https://github.com/lightbody/browsermob-proxy
+[REST API]: https://github.com/lightbody/browsermob-proxy#rest-api

package/dist/index.d.ts CHANGED Viewed

@@ -1,11 +1,126 @@
-import { ProxyList } from './typings/proxy';
-export default class BMPClient {
+/// <reference types="node" />
+import { RequestOptions } from 'http';
+import { Har } from 'har-format';
+import { BandwidthLimitsResponse, BlacklistItem, NewHarPageArgs, ProxyList, SetBandwidthLimitArgs, SetBlacklistArgs, SetRetryCountArgs, SetRewriteArgs, SetTimeoutsArgs, SetWhitelistArgs, StartHarArgs, StartProxyArgs, WaitArgs } from './typings/proxy';
+declare enum Method {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE"
+}
+export default class BrowserMobProxyAPIClient {
     readonly host: string;
     readonly port: number;
     constructor(host?: string, port?: number);
-    private httpRequest;
+    protected httpRequest(options: RequestOptions, payload?: string): Promise<string>;
+    protected httpRequestWithArgs(path?: string, method?: Method, args?: Record<string, string | number | boolean>): Promise<string>;
     /***
      * Get a list of ports attached to ProxyServer instances managed by ProxyManager
      */
     getProxyList(): Promise<ProxyList>;
+    /**
+     * Creates a new proxy to run requests off of
+     */
+    start(args?: StartProxyArgs): Promise<number | null>;
+    /**
+     * Shuts down the proxy and closes the port.
+     */
+    stop(port: number): Promise<void>;
+    /**
+     * Creates a new HAR attached to the proxy
+     * returns the HAR content if there was a previous HAR
+     */
+    startHar(port: number, args?: StartHarArgs): Promise<Har | undefined>;
+    /**
+     * Starts a new page on the existing HAR
+     */
+    newHarPage(port: number, args?: NewHarPageArgs): Promise<void>;
+    /**
+     * Returns the JSON/HAR content representing all the HTTP traffic passed through the proxy
+     * provided you have already created the HAR with this.startHar
+     */
+    getHar(port: number): Promise<Har | undefined>;
+    /**
+     * Get whitelisted items
+     */
+    getWhitelist(port: number): Promise<string[]>;
+    /**
+     * Sets a list of URL patterns to whitelist
+     */
+    setWhitelist(port: number, args: SetWhitelistArgs): Promise<void>;
+    /**
+     * Clears all URL patterns from the whitelist
+     */
+    clearWhitelist(port: number): Promise<void>;
+    /**
+     * Get blacklisted items
+     */
+    getBlacklist(port: number): Promise<BlacklistItem[]>;
+    /**
+     * Set a URL to blacklist
+     */
+    setBlacklist(port: number, args: SetBlacklistArgs): Promise<void>;
+    /**
+     * Clears all URL patterns from the blacklist
+     */
+    clearBlacklist(port: number): Promise<void>;
+    /**
+     * Limit the bandwidth through the proxy
+     */
+    setBandwidthLimit(port: number, args?: SetBandwidthLimitArgs): Promise<void>;
+    /**
+     * Displays the amount of data remaining to be uploaded/downloaded until the limit is reached
+     */
+    getBandwidthLimit(port: number): Promise<BandwidthLimitsResponse>;
+    /**
+     * Set and override HTTP Request headers
+     * Key is a header name (such as "User-Agent") and value is a value of HTTP header (such as "BrowserMob-Agent")
+     */
+    setRequestHeaders(port: number, headers: Record<string, string>): Promise<void>;
+    /**
+     * Overrides normal DNS lookups and remaps the given hosts with the associated IP address
+     * Key is a host name (such as "example.com") and value is the IP address (such as "1.2.3.4")
+     */
+    setHosts(port: number, hosts: Record<string, string>): Promise<void>;
+    /**
+     * Set username and passwords to be sent for requests on a specific domain that are protected by Basic Authentication
+     */
+    setBasicAuth(port: number, domain: string, username: string, password: string): Promise<void>;
+    /**
+     * Wait till all request are being made
+     */
+    wait(port: number, args: WaitArgs): Promise<unknown>;
+    /**
+     * Handles different proxy timeouts
+     */
+    setTimeouts(port: number, timeouts: SetTimeoutsArgs): Promise<void>;
+    /**
+     * Redirecting URLs
+     */
+    setRewrite(port: number, args: SetRewriteArgs): Promise<void>;
+    /**
+     * Removes all URL redirection rules currently in effect
+     */
+    clearRewrites(port: number): Promise<void>;
+    /**
+     * Set retry count
+     */
+    setRetryCount(port: number, args: SetRetryCountArgs): Promise<void>;
+    /**
+     * Empties the DNS cache
+     */
+    clearDNSCache(port: number): Promise<void>;
+    /**
+     * Set request interceptor
+     * example:  await proxy.setRequestInterceptor(port, "request.headers().remove('User-Agent'); request.headers().add('User-Agent', 'My-Custom-User-Agent-String 1.0');");
+     * @see https://github.com/lightbody/browsermob-proxy#rest-api-interceptors-with-littleproxy
+     */
+    setRequestInterceptor(port: number, interceptor: string): Promise<void>;
+    /**
+     * Set response interceptor
+     * example: await proxy.setResponseInterceptor(port, "response.headers().remove('User-Agent'); response.headers().add('User-Agent', 'My-Custom-User-Agent-String 1.0');");
+     * @see https://github.com/lightbody/browsermob-proxy#rest-api-interceptors-with-littleproxy
+     */
+    setResponseInterceptor(port: number, interceptor: string): Promise<void>;
 }
+export {};

package/dist/index.js CHANGED Viewed

@@ -1,102 +1,246 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-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 (g && (g = 0, op[0] && (_ = 0)), _) 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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-var http_1 = __importDefault(require("http"));
-var BMPClient = /** @class */ (function () {
-    function BMPClient(host, port) {
-        if (host === void 0) { host = 'localhost'; }
-        if (port === void 0) { port = 8080; }
+import http from 'http';
+var Method;
+(function (Method) {
+    Method["GET"] = "GET";
+    Method["POST"] = "POST";
+    Method["PUT"] = "PUT";
+    Method["DELETE"] = "DELETE";
+})(Method || (Method = {}));
+export default class BrowserMobProxyAPIClient {
+    constructor(host = 'localhost', port = 8080) {
         this.host = host;
         this.port = port;
     }
-    BMPClient.prototype.httpRequest = function (path, method, args) {
-        var _this = this;
-        if (path === void 0) { path = '/'; }
-        if (method === void 0) { method = 'GET'; }
-        if (args === void 0) { args = {}; }
-        return new Promise(function (resolve, reject) {
-            var hasPostData = ['POST', 'PUT'].includes(method) && Object.entries(args).length;
-            var headers = {};
-            if (hasPostData) {
-                headers['Content-Type'] = 'application/x-www-form-urlencoded';
-            }
-            var req = http_1["default"].request({
-                path: path,
-                method: method,
-                host: _this.host,
-                port: _this.port,
-                headers: headers
-            }, function (res) {
-                var data = [];
-                res.on('data', function (chunk) { return data.push(chunk); });
-                res.on('end', function () {
+    httpRequest(options, payload = '') {
+        return new Promise((resolve, reject) => {
+            const req = http.request({
+                host: this.host,
+                port: this.port,
+                ...options,
+            }, res => {
+                const data = [];
+                res.on('data', chunk => data.push(chunk));
+                res.on('end', () => {
                     resolve(data.join());
                 });
             });
-            req.on('error', function (error) { return reject(error); });
-            if (hasPostData) {
-                var params_1 = new URLSearchParams();
-                Object.entries(args).forEach(function (arg) { return params_1.set(arg[0], String(arg[1])); });
-                req.write(params_1.toString());
+            req.on('error', error => reject(error));
+            if (payload) {
+                req.write(payload);
             }
             req.end();
         });
-    };
+    }
+    httpRequestWithArgs(path = '/', method = Method.GET, args = {}) {
+        const headers = {};
+        const params = new URLSearchParams();
+        if ([Method.POST, Method.PUT].includes(method) && Object.entries(args).length) {
+            headers['Content-Type'] = 'application/x-www-form-urlencoded';
+            Object.entries(args).forEach(arg => params.set(arg[0], String(arg[1])));
+        }
+        return this.httpRequest({
+            path,
+            method,
+            headers,
+        }, params.toString());
+    }
     /***
      * Get a list of ports attached to ProxyServer instances managed by ProxyManager
      */
-    BMPClient.prototype.getProxyList = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var _a, _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        _b = (_a = JSON).parse;
-                        return [4 /*yield*/, this.httpRequest('/proxy', 'GET')];
-                    case 1: return [2 /*return*/, _b.apply(_a, [_c.sent()])];
-                }
-            });
-        });
-    };
-    return BMPClient;
-}());
-exports["default"] = BMPClient;
+    async getProxyList() {
+        return JSON.parse(await this.httpRequestWithArgs('/proxy', Method.GET));
+    }
+    /**
+     * Creates a new proxy to run requests off of
+     */
+    async start(args = {}) {
+        const res = await this.httpRequestWithArgs('/proxy', Method.POST, { ...args });
+        const { port } = JSON.parse(res);
+        return port || null;
+    }
+    /**
+     * Shuts down the proxy and closes the port.
+     */
+    async stop(port) {
+        await this.httpRequestWithArgs(`/proxy/${port}`, Method.DELETE);
+    }
+    /**
+     * Creates a new HAR attached to the proxy
+     * returns the HAR content if there was a previous HAR
+     */
+    async startHar(port, args = {}) {
+        const res = await this.httpRequestWithArgs(`/proxy/${port}/har`, Method.PUT, { ...args });
+        return res ? JSON.parse(res) : undefined;
+    }
+    /**
+     * Starts a new page on the existing HAR
+     */
+    async newHarPage(port, args = {}) {
+        await this.httpRequestWithArgs(`/proxy/${port}/har/pageRef`, Method.PUT, { ...args });
+    }
+    /**
+     * Returns the JSON/HAR content representing all the HTTP traffic passed through the proxy
+     * provided you have already created the HAR with this.startHar
+     */
+    async getHar(port) {
+        const res = await this.httpRequestWithArgs(`/proxy/${port}/har`, Method.GET);
+        return res ? JSON.parse(res) : undefined;
+    }
+    /**
+     * Get whitelisted items
+     */
+    async getWhitelist(port) {
+        return JSON.parse(await this.httpRequestWithArgs(`/proxy/${port}/whitelist`, Method.GET));
+    }
+    /**
+     * Sets a list of URL patterns to whitelist
+     */
+    async setWhitelist(port, args) {
+        await this.httpRequestWithArgs(`/proxy/${port}/whitelist`, Method.PUT, { ...args });
+    }
+    /**
+     * Clears all URL patterns from the whitelist
+     */
+    async clearWhitelist(port) {
+        await this.httpRequestWithArgs(`/proxy/${port}/whitelist`, Method.DELETE);
+    }
+    /**
+     * Get blacklisted items
+     */
+    async getBlacklist(port) {
+        return JSON.parse(await this.httpRequestWithArgs(`/proxy/${port}/blacklist`, Method.GET));
+    }
+    /**
+     * Set a URL to blacklist
+     */
+    async setBlacklist(port, args) {
+        await this.httpRequestWithArgs(`/proxy/${port}/blacklist`, Method.PUT, { ...args });
+    }
+    /**
+     * Clears all URL patterns from the blacklist
+     */
+    async clearBlacklist(port) {
+        await this.httpRequestWithArgs(`/proxy/${port}/blacklist`, Method.DELETE);
+    }
+    /**
+     * Limit the bandwidth through the proxy
+     */
+    async setBandwidthLimit(port, args = {}) {
+        await this.httpRequestWithArgs(`/proxy/${port}/limit`, Method.PUT, { ...args });
+    }
+    /**
+     * Displays the amount of data remaining to be uploaded/downloaded until the limit is reached
+     */
+    async getBandwidthLimit(port) {
+        return JSON.parse(await this.httpRequestWithArgs(`/proxy/${port}/limit`, Method.GET));
+    }
+    /**
+     * Set and override HTTP Request headers
+     * Key is a header name (such as "User-Agent") and value is a value of HTTP header (such as "BrowserMob-Agent")
+     */
+    async setRequestHeaders(port, headers) {
+        await this.httpRequest({
+            path: `/proxy/${port}/headers`,
+            method: Method.POST,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        }, JSON.stringify(headers));
+    }
+    /**
+     * Overrides normal DNS lookups and remaps the given hosts with the associated IP address
+     * Key is a host name (such as "example.com") and value is the IP address (such as "1.2.3.4")
+     */
+    async setHosts(port, hosts) {
+        await this.httpRequest({
+            path: `/proxy/${port}/hosts`,
+            method: Method.POST,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        }, JSON.stringify(hosts));
+    }
+    /**
+     * Set username and passwords to be sent for requests on a specific domain that are protected by Basic Authentication
+     */
+    async setBasicAuth(port, domain, username, password) {
+        await this.httpRequest({
+            path: `/proxy/${port}/auth/basic/${domain}`,
+            method: Method.POST,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        }, JSON.stringify({ username, password }));
+    }
+    /**
+     * Wait till all request are being made
+     */
+    async wait(port, args) {
+        return this.httpRequestWithArgs(`/proxy/${port}/wait`, Method.PUT, { ...args });
+    }
+    /**
+     * Handles different proxy timeouts
+     */
+    async setTimeouts(port, timeouts) {
+        await this.httpRequest({
+            path: `/proxy/${port}/timeout`,
+            method: Method.PUT,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        }, JSON.stringify(timeouts));
+    }
+    /**
+     * Redirecting URLs
+     */
+    async setRewrite(port, args) {
+        await this.httpRequestWithArgs(`/proxy/${port}/rewrite`, Method.PUT, { ...args });
+    }
+    /**
+     * Removes all URL redirection rules currently in effect
+     */
+    async clearRewrites(port) {
+        await this.httpRequestWithArgs(`/proxy/${port}/rewrite`, Method.DELETE);
+    }
+    /**
+     * Set retry count
+     */
+    async setRetryCount(port, args) {
+        await this.httpRequestWithArgs(`/proxy/${port}/retry`, Method.PUT, { ...args });
+    }
+    /**
+     * Empties the DNS cache
+     */
+    async clearDNSCache(port) {
+        await this.httpRequestWithArgs(`/proxy/${port}/dns/cache`, Method.DELETE);
+    }
+    /**
+     * Set request interceptor
+     * example:  await proxy.setRequestInterceptor(port, "request.headers().remove('User-Agent'); request.headers().add('User-Agent', 'My-Custom-User-Agent-String 1.0');");
+     * @see https://github.com/lightbody/browsermob-proxy#rest-api-interceptors-with-littleproxy
+     */
+    async setRequestInterceptor(port, interceptor) {
+        await this.httpRequest({
+            path: `/proxy/${port}/filter/request`,
+            method: Method.POST,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        }, interceptor);
+    }
+    /**
+     * Set response interceptor
+     * example: await proxy.setResponseInterceptor(port, "response.headers().remove('User-Agent'); response.headers().add('User-Agent', 'My-Custom-User-Agent-String 1.0');");
+     * @see https://github.com/lightbody/browsermob-proxy#rest-api-interceptors-with-littleproxy
+     */
+    async setResponseInterceptor(port, interceptor) {
+        await this.httpRequest({
+            path: `/proxy/${port}/filter/response`,
+            method: Method.POST,
+            headers: {
+                'Content-Type': 'text/plain',
+            },
+        }, interceptor);
+    }
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"~~;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;~~AAAA,~~8CAAwB~~;~~AAGxB~~;~~IAKE~~,~~mBAAY~~,~~IAAkB~~,~~EAAE~~,~~IAAW~~;~~QAA/B~~,~~qBAAA~~,~~EAAA~~,~~kBAAkB~~;~~QAAE~~,~~qBAAA~~,~~EAAA~~,WAAW;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;~~IAEO,+BAAW~~,~~GAAnB~~,~~UACE~~,~~IAAU~~,~~EACV~~,~~MAAiD~~,~~EACjD~~,~~IAAoD~~;~~QAHtD~~,~~iBAsCC~~;~~QArCC~~,~~qBAAA~~,~~EAAA~~,~~UAAU~~;~~QACV~~,~~uBAAA~~,~~EAAA~~,~~cAAiD~~;~~QACjD~~,~~qBAAA~~,~~EAAA~~,~~SAAoD~~;~~QAEpD~~,OAAO,IAAI,OAAO,CAAC,~~UAAC~~,OAAO,EAAE,MAAM;~~YACjC~~,~~IAAM~~,~~WAAW~~,GAAG,CAAC,MAAM,EAAE,~~KAAK~~,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;~~YAEpF~~,~~IAAM~~,OAAO,~~GAA2B~~,EAAE,CAAC;~~YAC3C~~,IAAI,WAAW,EAAE;~~gBACf~~,OAAO,CAAC,~~cAAc~~,CAAC,GAAG,~~mCAAmC~~,CAAC;~~aAC/D~~;~~YAED~~,~~IAAM~~,GAAG,GAAG,~~iBAAI~~,CAAC,OAAO,CAAC;~~gBACvB~~,IAAI,~~MAAA~~;~~gBACJ~~,MAAM,~~QAAA;gBACN~~,IAAI,EAAE,~~KAAI~~,CAAC,~~IAAI~~;~~gBACf~~,IAAI,EAAE,~~KAAI~~,CAAC,IAAI;~~gBACf~~,OAAO,~~SAAA~~;~~aACR~~,~~EACD~~,~~UAAA~~,GAAG;~~gBACD~~,~~IAAM~~,IAAI,~~GAAa~~,EAAE,CAAC;~~gBAC1B~~,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,~~UAAA~~,KAAK,IAAI,~~OAAA~~,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,~~EAAhB~~,~~CAAgB~~,CAAC,CAAC;~~gBAC1C~~,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;~~oBACZ~~,~~OAAO~~,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;~~gBACvB~~,CAAC,CAAC,CAAC;~~YACL~~,CAAC,CAAC,CAAC~~;YAEH~~,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,~~UAAA~~,KAAK,IAAI,~~OAAA~~,MAAM,CAAC,KAAK,CAAC,~~EAAb~~,~~CAAa~~,CAAC,CAAC;~~YAExC~~,IAAI,WAAW,~~EAAE~~;~~gBACf~~,~~IAAM~~,~~QAAM~~,~~GAAG~~,IAAI,eAAe,EAAE~~,CAAC~~;~~gBACrC~~,MAAM,CAAC,OAAO,~~CAAC~~,IAAI,CAAC,CAAC,OAAO,CAAC,~~UAAA~~,~~GAAG~~,IAAI,~~OAAA~~,~~QAAM~~,CAAC,GAAG,~~CAAC~~,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,~~EAAlC~~,~~CAAkC~~,CAAC,~~CAAC~~;~~gBACxE~~,GAAG,CAAC,KAAK,CAAC,~~QAAM~~,CAAC,~~QAAQ~~,EAAE,CAAC,CAAC;~~aAC9B~~;~~YAED~~,~~GAAG~~,CAAC,~~GAAG~~,EAAE,~~CAAC~~;~~QACZ~~,CAAC,CAAC,CAAC;~~IACL~~,CAAC;IAED;;OAEG;~~IACG~~,~~gCAAY~~,~~GAAlB;;;;;;wBACS~~,~~KAAA~~,~~CAAA~~,~~KAAA~~,IAAI,~~CAAA~~,CAAC,KAAK,~~CAAA~~;~~wBAAC~~,~~qBAAM~~,IAAI,CAAC,WAAW,CAAC,~~QAAQ~~,EAAE,KAAK,CAAC,~~EAAA~~;~~4BAAzD~~,~~sBAAO~~,~~cAAW~~,~~SAAuC~~,~~EAAC~~,~~EAAC;;;;KAC5D~~;~~IAEH~~,~~gBAAC~~;~~AAAD~~,CAAC,~~AAzDD~~,~~IAyDC~~"}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAwB,MAAM,MAAM,CAAC;AAkB5C,IAAK,MAKJ;AALD,WAAK,MAAM;IACT,qBAAW,CAAA;IACX,uBAAa,CAAA;IACb,qBAAW,CAAA;IACX,2BAAiB,CAAA;AACnB,CAAC,EALI,MAAM,KAAN,MAAM,QAKV;AAED,MAAM,CAAC,OAAO,OAAO,wBAAwB;IAK3C,YAAY,IAAI,GAAG,WAAW,EAAE,IAAI,GAAG,IAAI;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAES,WAAW,CACnB,OAAuB,EACvB,OAAO,GAAG,EAAE;QAEZ,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CACtB;gBACE,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,GAAG,OAAO;aACX,EACD,GAAG,CAAC,EAAE;gBACJ,MAAM,IAAI,GAAa,EAAE,CAAC;gBAC1B,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC1C,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACjB,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEL,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAExC,IAAI,OAAO,EAAE;gBACX,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aACpB;YAED,GAAG,CAAC,GAAG,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;IAES,mBAAmB,CAC3B,IAAI,GAAG,GAAG,EACV,SAAiB,MAAM,CAAC,GAAG,EAC3B,OAAkD,EAAE;QAEpD,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE;YAC7E,OAAO,CAAC,cAAc,CAAC,GAAG,mCAAmC,CAAC;YAC9D,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACzE;QAED,OAAO,IAAI,CAAC,WAAW,CACrB;YACE,IAAI;YACJ,MAAM;YACN,OAAO;SACR,EACD,MAAM,CAAC,QAAQ,EAAE,CAClB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,OAAuB,EAAE;QACnC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CACxC,QAAQ,EACR,MAAM,CAAC,IAAI,EACX,EAAE,GAAG,IAAI,EAAE,CACZ,CAAC;QACF,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjC,OAAO,IAAI,IAAI,IAAI,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,IAAY;QACrB,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,OAAqB,EAAE;QAClD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC1F,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,OAAuB,EAAE;QACtD,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,cAAc,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,IAAY;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7E,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAsB;QACrD,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,IAAY;QAC/B,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,IAAsB;QACrD,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,IAAY;QAC/B,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAY,EAAE,OAA8B,EAAE;QACpE,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,QAAQ,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAY;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAY,EAAE,OAA+B;QACnE,MAAM,IAAI,CAAC,WAAW,CACpB;YACE,IAAI,EAAE,UAAU,IAAI,UAAU;YAC9B,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,OAAO,EAAE;gBACP,cAAc,EAAE,YAAY;aAC7B;SACF,EACD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CACxB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAY,EAAE,KAA6B;QACxD,MAAM,IAAI,CAAC,WAAW,CACpB;YACE,IAAI,EAAE,UAAU,IAAI,QAAQ;YAC5B,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,OAAO,EAAE;gBACP,cAAc,EAAE,YAAY;aAC7B;SACF,EACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,MAAc,EAAE,QAAgB,EAAE,QAAgB;QACjF,MAAM,IAAI,CAAC,WAAW,CACpB;YACE,IAAI,EAAE,UAAU,IAAI,eAAe,MAAM,EAAE;YAC3C,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,OAAO,EAAE;gBACP,cAAc,EAAE,YAAY;aAC7B;SACF,EACD,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CACvC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,IAAc;QACrC,OAAO,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,QAAyB;QACvD,MAAM,IAAI,CAAC,WAAW,CACpB;YACE,IAAI,EAAE,UAAU,IAAI,UAAU;YAC9B,MAAM,EAAE,MAAM,CAAC,GAAG;YAClB,OAAO,EAAE;gBACP,cAAc,EAAE,YAAY;aAC7B;SACF,EACD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CACzB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,IAAoB;QACjD,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,UAAU,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY;QAC9B,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,IAAuB;QACvD,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,QAAQ,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY;QAC9B,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,IAAI,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAAY,EAAE,WAAmB;QAC3D,MAAM,IAAI,CAAC,WAAW,CACpB;YACE,IAAI,EAAE,UAAU,IAAI,iBAAiB;YACrC,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,OAAO,EAAE;gBACP,cAAc,EAAE,YAAY;aAC7B;SACF,EACD,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB,CAAC,IAAY,EAAE,WAAmB;QAC5D,MAAM,IAAI,CAAC,WAAW,CACpB;YACE,IAAI,EAAE,UAAU,IAAI,kBAAkB;YACtC,MAAM,EAAE,MAAM,CAAC,IAAI;YACnB,OAAO,EAAE;gBACP,cAAc,EAAE,YAAY;aAC7B;SACF,EACD,WAAW,CACZ,CAAC;IACJ,CAAC;CACF"}

package/dist/typings/proxy.d.ts ADDED Viewed

@@ -0,0 +1,221 @@
+export interface ProxyListItem {
+    port: number;
+}
+export interface ProxyList {
+    proxyList: ProxyListItem[];
+}
+export interface StartProxyArgs {
+    /**
+     * The specific port to start the proxy service on.
+     * Optional, default is generated and returned in response.
+     */
+    port?: number;
+    /**
+     * The username to use to authenticate with the chained proxy.
+     * Optional, default to null.
+     */
+    proxyUsername?: string;
+    /**
+     * The password to use to authenticate with the chained proxy.
+     * Optional, default to null.
+      */
+    proxyPassword?: string;
+    /**
+     * If running BrowserMob Proxy in a multi-homed environment,
+     * specify a desired bind address. Optional, default to "0.0.0.0".
+      */
+    bindAddress?: string;
+    /**
+     * If running BrowserMob Proxy in a multi-homed environment,
+     * specify a desired server bind address. Optional, default to "0.0.0.0".
+      */
+    serverBindAddress?: string;
+    /**
+     * Uses Elliptic Curve Cryptography for certificate impersonation.
+     * Optional, default to "false".
+      */
+    useEcc?: boolean;
+    /**
+     * Disables verification of all upstream servers' SSL certificates.
+     * All upstream servers will be trusted,
+     * even if they do not present valid certificates
+     * signed by certification authorities in the JDK's trust store.
+     * Optional, default to "false".
+      */
+    trustAllServers?: boolean;
+}
+export interface StartHarArgs {
+    /**
+     * capture headers or not
+     * Optional, default to "false".
+     */
+    captureHeaders?: boolean;
+    /**
+     * capture cookies or not
+     * Optional, default to "false"
+     */
+    captureCookies?: boolean;
+    /**
+     * capture content bodies or not
+     * Optional, default to "false"
+     */
+    captureContent?: boolean;
+    /**
+     * capture binary content or not
+     * Optional, default to "false"
+     */
+    captureBinaryContent?: boolean;
+    /**
+     * The string name of The first page ref that should be used in the HAR.
+     * Optional, default to "Page 1".
+     */
+    initialPageRef?: string;
+    /**
+     * The title of first HAR page. Optional, default to initialPageRef.
+     */
+    initialPageTitle?: string;
+}
+export interface NewHarPageArgs {
+    /**
+     * The string name of the first page ref that should be used in the HAR.
+     * Optional, default to "Page N" where N is the next page number.
+     */
+    pageRef?: string;
+    /**
+     * The title of new HAR page.
+     * Optional, default to pageRef.
+     */
+    pageTitle?: string;
+}
+export interface SetWhitelistArgs {
+    /**
+     * A comma separated list of regular expressions
+     */
+    regex: string;
+    /**
+     * The HTTP status code to return for URLs that do not match the whitelist.
+     * Optional, default to 200
+     */
+    status?: number;
+}
+export interface SetBlacklistArgs {
+    /**
+     * The blacklist regular expression
+     */
+    regex: string;
+    /**
+     * The HTTP status code to return for URLs that are blacklisted
+     */
+    status?: number;
+    /**
+     * The regular expression for matching HTTP method (GET, POST, PUT, etc).
+     * Optional, by default processing all HTTP method.
+     */
+    method?: string;
+}
+export interface BlacklistItem {
+    urlPattern: string;
+    statusCode: number;
+    httpMethodPattern: string | null;
+    responseCode: number;
+    pattern: string;
+    method: string | null;
+}
+export interface SetBandwidthLimitArgs {
+    /**
+     * Sets the downstream bandwidth limit in kbps
+     */
+    downstreamKbps?: number;
+    /**
+     * Sets the upstream bandwidth limit kbps
+     * by default unlimited
+     */
+    upstreamKbps?: number;
+    /**
+     * Specifies how many kilobytes in total the client is allowed to download through the proxy
+     * by default unlimited
+     */
+    downstreamMaxKB?: number;
+    /**
+     * Specifies how many kilobytes in total the client is allowed to upload through the proxy
+     * by default unlimited
+     */
+    upstreamMaxKB?: number;
+    /**
+     * Add the given latency to each HTTP request
+     * by default all requests are invoked without latency
+     */
+    latency?: number;
+    /**
+     * A boolean that enable bandwidth limiter.
+     * by default to "false", but setting any of the properties above will implicitly enable throttling
+     */
+    enable?: boolean;
+    /**
+     * Specifying what percentage of data sent is payload, e.g. use this to take into account overhead due to tcp/ip
+     */
+    payloadPercentage?: number;
+    /**
+     * The max bits per seconds you want this instance of StreamManager to respect
+     */
+    maxBitsPerSecond?: number;
+}
+export interface BandwidthLimitsResponse {
+    maxUpstreamKB: number;
+    remainingUpstreamKB: number;
+    maxDownstreamKB: number;
+    remainingDownstreamKB: number;
+}
+export interface SetRewriteArgs {
+    /**
+     * A matching URL regular expression
+     */
+    matchRegex: string;
+    /**
+     * replacement URL
+     */
+    replace: string;
+}
+export interface SetRetryCountArgs {
+    /**
+     * The number of times a method will be retried.
+     */
+    retrycount: number;
+}
+export interface WaitArgs {
+    /**
+     * Wait till all request are being made
+     */
+    quietPeriodInMs: number;
+    /**
+     * Sets quiet period in milliseconds
+     */
+    timeoutInMs: number;
+}
+export interface SetTimeoutsArgs {
+    /**
+     * Request timeout in milliseconds.
+     * A timeout value of -1 is interpreted as infinite timeout.
+     * default to "-1".
+     */
+    requestTimeout?: number;
+    /**
+     * Read timeout in milliseconds. Which is the timeout for waiting for data or,
+     * put differently, a maximum period inactivity between two consecutive data packets.
+     * A timeout value of zero is interpreted as an infinite timeout.
+     * default to "60000".
+     */
+    readTimeout?: number;
+    /**
+     * Determines the timeout in milliseconds until a connection is established.
+     * A timeout value of zero is interpreted as an infinite timeout.
+     * default to "60000".
+     */
+    connectionTimeout?: number;
+    /**
+     * Sets the maximum length of time that records will be stored in this Cache.
+     * A nonpositive value disables this feature (that is, sets no limit).
+     * default to "0".
+     */
+    dnsCacheTimeout?: number;
+}

package/dist/typings/proxy.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=proxy.js.map

package/dist/typings/proxy.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"proxy.js","sourceRoot":"","sources":["../../typings/proxy.ts"],"names":[],"mappings":""}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "browsermob-proxy-api-client",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",
@@ -13,6 +13,9 @@
     "type": "git",
     "url": "git@github.com:raul72/browsermob-proxy-api-client.git"
   },
+  "dependencies": {
+    "@types/har-format": "^1.2.10"
+  },
   "devDependencies": {
     "@microsoft/eslint-formatter-sarif": "2.1.7",
     "@types/node": "^16",