mocktp 0.0.1-security → 3.15.3

package/dist/rules/base-rule-builder.js

@@ -0,0 +1,251 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseRuleBuilder = void 0;
+const lodash_1 = require("lodash");
+const types_1 = require("../types");
+const completion_checkers_1 = require("./completion-checkers");
+const matchers_1 = require("./matchers");
+/**
+ * @class BaseRuleBuilder
+ *
+ * Defines the base matching & completion methods, used for both normal
+ * and websocket request handling, but excluding the handling itself
+ * which differs between the two cases.
+ */
+class BaseRuleBuilder {
+    /**
+     * Mock rule builders should be constructed through the Mockttp instance you're
+     * using, not directly. You shouldn't ever need to call this constructor.
+     */
+    constructor() {
+        this.matchers = [];
+        this.priority = types_1.RulePriority.DEFAULT;
+    }
+    buildBaseRuleData() {
+        return {
+            priority: this.priority,
+            matchers: this.matchers,
+            completionChecker: this.completionChecker
+        };
+    }
+    /**
+     * Set the rule priority. Any matching rule with a higher priority will always
+     * take precedence over a matching lower-priority rule, unless the higher rule
+     * has an explicit completion check (like `.once()`) that has already been
+     * completed.
+     *
+     * The RulePriority enum defines the standard values useful for most cases,
+     * but any positive number may be used for advanced configurations.
+     *
+     * In many cases it may be simpler to use forUnmatchedRequest() to set a fallback
+     * rule explicitly, rather than manually setting the priority here.
+     */
+    asPriority(priority) {
+        this.priority = priority;
+        return this;
+    }
+    /**
+     * Match only requests sent to the given host, i.e. the full hostname plus
+     * port included in the request.
+     *
+     * This can behave somewhat confusingly when matching against the default
+     * ports for a protocol (i.e. 80/443), or when specifying a hostname here
+     * without specifying the port. In those cases it's usually better to use
+     * forHostname and/or forPort instead to explicit match the content you're
+     * interested in.
+     *
+     * @category Matching
+     */
+    forHost(host) {
+        this.matchers.push(new matchers_1.HostMatcher(host));
+        return this;
+    }
+    /**
+     * Match only requests sent to the given hostname, ignoring the port.
+     *
+     * @category Matching
+     */
+    forHostname(hostname) {
+        this.matchers.push(new matchers_1.HostnameMatcher(hostname));
+        return this;
+    }
+    /**
+     * Match only requests sent to the given port.
+     *
+     * @category Matching
+     */
+    forPort(port) {
+        this.matchers.push(new matchers_1.PortMatcher(port));
+        return this;
+    }
+    /**
+     * Match only requests that include the given headers.
+     * @category Matching
+     */
+    withHeaders(headers) {
+        this.matchers.push(new matchers_1.HeaderMatcher(headers));
+        return this;
+    }
+    /**
+     * Match only requests that include the given query parameters.
+     * @category Matching
+     */
+    withQuery(query) {
+        this.matchers.push(new matchers_1.QueryMatcher(query));
+        return this;
+    }
+    /**
+     * Match only requests that include the exact query string provided.
+     * The query string must start with a ? or be entirely empty.
+     * @category Matching
+     */
+    withExactQuery(query) {
+        this.matchers.push(new matchers_1.ExactQueryMatcher(query));
+        return this;
+    }
+    /**
+     * Match only requests whose bodies include the given URL-encoded form data.
+     * @category Matching
+     */
+    withForm(formData) {
+        this.matchers.push(new matchers_1.FormDataMatcher(formData));
+        return this;
+    }
+    /**
+     * Match only requests whose bodies include the given multipart form data.
+     *
+     * This can take any number of form parts to look for. Each part is specified
+     * with {@link MultipartFieldMatchCondition} object containing one or more of
+     * `name` (string), `filename` (string) and `content` (string or buffer) as
+     * fields to match against in the form data.
+     *
+     * Requests are matched if all conditions match at least one part in the
+     * request's form data.
+     *
+     * @category Matching
+     */
+    withMultipartForm(...matchConditions) {
+        this.matchers.push(new matchers_1.MultipartFormDataMatcher(matchConditions));
+        return this;
+    }
+    /**
+     * Match only requests whose bodies either exactly match the given string
+     * (if a string is passed) or whose bodies match a regular expression
+     * (if a regex is passed).
+     * @category Matching
+     */
+    withBody(content) {
+        this.matchers.push((0, lodash_1.isString)(content)
+            ? new matchers_1.RawBodyMatcher(content)
+            : new matchers_1.RegexBodyMatcher(content));
+        return this;
+    }
+    /**
+     * Match only requests whose bodies include the given string.
+     * @category Matching
+     */
+    withBodyIncluding(content) {
+        this.matchers.push(new matchers_1.RawBodyIncludesMatcher(content));
+        return this;
+    }
+    /**
+     * Match only requests whose bodies exactly match the given
+     * object, when parsed as JSON.
+     *
+     * Note that this only tests that the body can be parsed
+     * as JSON - it doesn't require a content-type header.
+     * @category Matching
+     */
+    withJsonBody(json) {
+        this.matchers.push(new matchers_1.JsonBodyMatcher(json));
+        return this;
+    }
+    /**
+     * Match only requests whose bodies match (contain equivalent
+     * values, ignoring extra values) the given object, when
+     * parsed as JSON. Matching behaviour is the same as Lodash's
+     * _.isMatch method.
+     *
+     * Note that this only tests that the body can be parsed
+     * as JSON - it doesn't require a content-type header.
+     * @category Matching
+     */
+    withJsonBodyIncluding(json) {
+        this.matchers.push(new matchers_1.JsonBodyFlexibleMatcher(json));
+        return this;
+    }
+    /**
+     * Match only requests that include the given cookies
+     * @category Matching
+     */
+    withCookie(cookie) {
+        this.matchers.push(new matchers_1.CookieMatcher(cookie));
+        return this;
+    }
+    /**
+     * Match only requests sent with the given protocol.
+     * @category Matching
+     */
+    withProtocol(protocol) {
+        this.matchers.push(new matchers_1.ProtocolMatcher(protocol));
+        return this;
+    }
+    /**
+     * Match only requests whose absolute url matches the given RegExp.
+     * @category Matching
+     */
+    withUrlMatching(pattern) {
+        this.matchers.push(new matchers_1.RegexUrlMatcher(pattern));
+        return this;
+    }
+    /**
+     * Match only requests when the callback returns true
+     * @category Matching
+     */
+    matching(content) {
+        this.matchers.push(new matchers_1.CallbackMatcher(content));
+        return this;
+    }
+    /**
+     * Run this rule forever, for all matching requests
+     * @category Completion
+     */
+    always() {
+        this.completionChecker = new completion_checkers_1.Always();
+        return this;
+    }
+    /**
+     * Run this rule only once, for the first matching request
+     * @category Completion
+     */
+    once() {
+        this.completionChecker = new completion_checkers_1.Once();
+        return this;
+    }
+    /**
+     * Run this rule twice, for the first two matching requests
+     * @category Completion
+     */
+    twice() {
+        this.completionChecker = new completion_checkers_1.Twice();
+        return this;
+    }
+    /**
+     * Run this rule three times, for the first three matching requests
+     * @category Completion
+     */
+    thrice() {
+        this.completionChecker = new completion_checkers_1.Thrice();
+        return this;
+    }
+    /**
+     * Run this rule the given number of times, for the first matching requests
+     * @category Completion
+     */
+    times(n) {
+        this.completionChecker = new completion_checkers_1.NTimes(n);
+        return this;
+    }
+}
+exports.BaseRuleBuilder = BaseRuleBuilder;
+//# sourceMappingURL=base-rule-builder.js.map

package/dist/rules/base-rule-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-rule-builder.js","sourceRoot":"","sources":["../../src/rules/base-rule-builder.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAGlC,oCAAkE;AAElE,+DAO+B;AAE/B,yCAoBoB;AAEpB;;;;;;GAMG;AACH,MAAsB,eAAe;IAEjC;;;OAGG;IACH;QAEU,aAAQ,GAAqB,EAAE,CAAC;QAElC,aAAQ,GAAW,oBAAY,CAAC,OAAO,CAAC;IAJjC,CAAC;IAON,iBAAiB;QACvB,OAAO;YACH,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;SAC5C,CAAC;IACN,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,QAA+B;QACtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,IAAY;QAChB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,sBAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,QAAgB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,0BAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAY;QAChB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,sBAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,OAAkC;QAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,wBAAa,CAAC,OAAO,CAAC,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAA+D;QACrE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,uBAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,KAAa;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,4BAAiB,CAAC,KAAK,CAAC,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,QAAmC;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,0BAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,GAAG,eAAoD;QACrE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,mCAAwB,CAAC,eAAe,CAAC,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,OAAwB;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CACd,IAAA,iBAAQ,EAAC,OAAO,CAAC;YACb,CAAC,CAAC,IAAI,yBAAc,CAAC,OAAO,CAAC;YAC7B,CAAC,CAAC,IAAI,2BAAgB,CAAC,OAAO,CAAC,CACtC,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,OAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,iCAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,IAAQ;QACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CACd,IAAI,0BAAe,CAAC,IAAI,CAAC,CAC5B,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,qBAAqB,CAAC,IAAQ;QAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CACd,IAAI,kCAAuB,CAAC,IAAI,CAAC,CACpC,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAAiC;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,wBAAa,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,QAAyC;QAClD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,0BAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,OAAe;QAC3B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,0BAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,QAAQ,CACJ,OAA6D;QAE7D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,0BAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,MAAM;QACF,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAM,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,IAAI;QACA,IAAI,CAAC,iBAAiB,GAAG,IAAI,0BAAI,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,2BAAK,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,MAAM;QACF,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAM,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,CAAS;QACX,IAAI,CAAC,iBAAiB,GAAG,IAAI,4BAAM,CAAC,CAAC,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA5QD,0CA4QC"}

package/dist/rules/completion-checkers.d.ts

@@ -0,0 +1,41 @@
+import { Serializable } from '../serialization/serialization';
+export interface RuleCompletionChecker extends Serializable {
+    type: keyof typeof CompletionCheckerLookup;
+    isComplete(seenRequestCount: number): boolean;
+    explain(seenRequestCount: number | undefined): string;
+}
+export declare class Always extends Serializable implements RuleCompletionChecker {
+    readonly type = "always";
+    isComplete(): boolean;
+    explain(seenRequestCount: number | undefined): string;
+}
+export declare class Once extends Serializable implements RuleCompletionChecker {
+    readonly type = "once";
+    isComplete(seenRequestCount: number): boolean;
+    explain(seenRequestCount: number | undefined): string;
+}
+export declare class Twice extends Serializable implements RuleCompletionChecker {
+    readonly type = "twice";
+    isComplete(seenRequestCount: number): boolean;
+    explain(seenRequestCount: number | undefined): string;
+}
+export declare class Thrice extends Serializable implements RuleCompletionChecker {
+    readonly type = "thrice";
+    isComplete(seenRequestCount: number): boolean;
+    explain(seenRequestCount: number | undefined): string;
+}
+export declare class NTimes extends Serializable implements RuleCompletionChecker {
+    count: number;
+    readonly type = "times";
+    constructor(count: number);
+    isComplete(seenRequestCount: number): boolean;
+    explain(seenRequestCount: number | undefined): string;
+}
+export declare const CompletionCheckerLookup: {
+    always: typeof Always;
+    once: typeof Once;
+    twice: typeof Twice;
+    thrice: typeof Thrice;
+    times: typeof NTimes;
+};
+//# sourceMappingURL=completion-checkers.d.ts.map

package/dist/rules/completion-checkers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion-checkers.d.ts","sourceRoot":"","sources":["../../src/rules/completion-checkers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE9D,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACvD,IAAI,EAAE,MAAM,OAAO,uBAAuB,CAAC;IAC3C,UAAU,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9C,OAAO,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;CACzD;AAED,qBAAa,MAAO,SAAQ,YAAa,YAAW,qBAAqB;IACrE,QAAQ,CAAC,IAAI,YAAY;IAEzB,UAAU;IAIV,OAAO,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS;CAG/C;AAED,qBAAa,IAAK,SAAQ,YAAa,YAAW,qBAAqB;IACnE,QAAQ,CAAC,IAAI,UAAU;IAEvB,UAAU,CAAC,gBAAgB,EAAE,MAAM;IAInC,OAAO,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS;CAG/C;AAED,qBAAa,KAAM,SAAQ,YAAa,YAAW,qBAAqB;IACpE,QAAQ,CAAC,IAAI,WAAW;IAExB,UAAU,CAAC,gBAAgB,EAAE,MAAM;IAInC,OAAO,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS;CAG/C;AAED,qBAAa,MAAO,SAAQ,YAAa,YAAW,qBAAqB;IACrE,QAAQ,CAAC,IAAI,YAAY;IAEzB,UAAU,CAAC,gBAAgB,EAAE,MAAM;IAInC,OAAO,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS;CAG/C;AAED,qBAAa,MAAO,SAAQ,YAAa,YAAW,qBAAqB;IAI1D,KAAK,EAAE,MAAM;IAHxB,QAAQ,CAAC,IAAI,WAAW;gBAGb,KAAK,EAAE,MAAM;IAKxB,UAAU,CAAC,gBAAgB,EAAE,MAAM;IAInC,OAAO,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS;CAG/C;AAED,eAAO,MAAM,uBAAuB;;;;;;CAMnC,CAAA"}

package/dist/rules/completion-checkers.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompletionCheckerLookup = exports.NTimes = exports.Thrice = exports.Twice = exports.Once = exports.Always = void 0;
+const serialization_1 = require("../serialization/serialization");
+class Always extends serialization_1.Serializable {
+    constructor() {
+        super(...arguments);
+        this.type = 'always';
+    }
+    isComplete() {
+        return false;
+    }
+    explain(seenRequestCount) {
+        return explainUntil(seenRequestCount, Infinity, 'always');
+    }
+}
+exports.Always = Always;
+class Once extends serialization_1.Serializable {
+    constructor() {
+        super(...arguments);
+        this.type = 'once';
+    }
+    isComplete(seenRequestCount) {
+        return seenRequestCount >= 1;
+    }
+    explain(seenRequestCount) {
+        return explainUntil(seenRequestCount, 1, 'once');
+    }
+}
+exports.Once = Once;
+class Twice extends serialization_1.Serializable {
+    constructor() {
+        super(...arguments);
+        this.type = 'twice';
+    }
+    isComplete(seenRequestCount) {
+        return seenRequestCount >= 2;
+    }
+    explain(seenRequestCount) {
+        return explainUntil(seenRequestCount, 2, 'twice');
+    }
+}
+exports.Twice = Twice;
+class Thrice extends serialization_1.Serializable {
+    constructor() {
+        super(...arguments);
+        this.type = 'thrice';
+    }
+    isComplete(seenRequestCount) {
+        return seenRequestCount >= 3;
+    }
+    explain(seenRequestCount) {
+        return explainUntil(seenRequestCount, 3, 'thrice');
+    }
+}
+exports.Thrice = Thrice;
+class NTimes extends serialization_1.Serializable {
+    constructor(count) {
+        super();
+        this.count = count;
+        this.type = 'times';
+    }
+    isComplete(seenRequestCount) {
+        return seenRequestCount >= this.count;
+    }
+    explain(seenRequestCount) {
+        return explainUntil(seenRequestCount, this.count, `${this.count} times`);
+    }
+}
+exports.NTimes = NTimes;
+exports.CompletionCheckerLookup = {
+    'always': Always,
+    'once': Once,
+    'twice': Twice,
+    'thrice': Thrice,
+    'times': NTimes
+};
+function explainUntil(seen, n, name) {
+    if (seen === undefined) {
+        // Generic explainer, without the specific count
+        return name;
+    }
+    else {
+        return name + " " + (seen < n ? `(seen ${seen})` : "(done)");
+    }
+}
+//# sourceMappingURL=completion-checkers.js.map

package/dist/rules/completion-checkers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion-checkers.js","sourceRoot":"","sources":["../../src/rules/completion-checkers.ts"],"names":[],"mappings":";;;AAAA,kEAA8D;AAQ9D,MAAa,MAAO,SAAQ,4BAAY;IAAxC;;QACa,SAAI,GAAG,QAAQ,CAAC;IAS7B,CAAC;IAPG,UAAU;QACN,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,gBAAoC;QACxC,OAAO,YAAY,CAAC,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;CACJ;AAVD,wBAUC;AAED,MAAa,IAAK,SAAQ,4BAAY;IAAtC;;QACa,SAAI,GAAG,MAAM,CAAC;IAS3B,CAAC;IAPG,UAAU,CAAC,gBAAwB;QAC/B,OAAO,gBAAgB,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,gBAAoC;QACxC,OAAO,YAAY,CAAC,gBAAgB,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;CACJ;AAVD,oBAUC;AAED,MAAa,KAAM,SAAQ,4BAAY;IAAvC;;QACa,SAAI,GAAG,OAAO,CAAC;IAS5B,CAAC;IAPG,UAAU,CAAC,gBAAwB;QAC/B,OAAO,gBAAgB,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,gBAAoC;QACxC,OAAO,YAAY,CAAC,gBAAgB,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CACJ;AAVD,sBAUC;AAED,MAAa,MAAO,SAAQ,4BAAY;IAAxC;;QACa,SAAI,GAAG,QAAQ,CAAC;IAS7B,CAAC;IAPG,UAAU,CAAC,gBAAwB;QAC/B,OAAO,gBAAgB,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,gBAAoC;QACxC,OAAO,YAAY,CAAC,gBAAgB,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;CACJ;AAVD,wBAUC;AAED,MAAa,MAAO,SAAQ,4BAAY;IAGpC,YACW,KAAa;QAEpB,KAAK,EAAE,CAAC;QAFD,UAAK,GAAL,KAAK,CAAQ;QAHf,SAAI,GAAG,OAAO,CAAC;IAMxB,CAAC;IAED,UAAU,CAAC,gBAAwB;QAC/B,OAAO,gBAAgB,IAAI,IAAI,CAAC,KAAK,CAAC;IAC1C,CAAC;IAED,OAAO,CAAC,gBAAoC;QACxC,OAAO,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC;IAC7E,CAAC;CACJ;AAhBD,wBAgBC;AAEY,QAAA,uBAAuB,GAAG;IACnC,QAAQ,EAAE,MAAM;IAChB,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,KAAK;IACd,QAAQ,EAAE,MAAM;IAChB,OAAO,EAAE,MAAM;CAClB,CAAA;AAED,SAAS,YAAY,CAAC,IAAwB,EAAE,CAAS,EAAE,IAAY;IACnE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,gDAAgD;QAChD,OAAO,IAAI,CAAC;IAChB,CAAC;SAAM,CAAC;QACJ,OAAO,IAAI,GAAG,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;AACL,CAAC"}

package/dist/rules/http-agents.d.ts

@@ -0,0 +1,11 @@
+import * as http from 'http';
+import { ProxySettingSource } from './proxy-config';
+export declare function getAgent({ protocol, hostname, port, tryHttp2, keepAlive, proxySettingSource }: {
+    protocol: 'http:' | 'https:' | 'ws:' | 'wss:' | undefined;
+    hostname: string;
+    port: number;
+    tryHttp2: boolean;
+    keepAlive: boolean;
+    proxySettingSource: ProxySettingSource;
+}): Promise<http.Agent | undefined>;
+//# sourceMappingURL=http-agents.d.ts.map

package/dist/rules/http-agents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-agents.d.ts","sourceRoot":"","sources":["../../src/rules/http-agents.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAW7B,OAAO,EAAmC,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAsCrF,wBAAsB,QAAQ,CAAC,EAC3B,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,kBAAkB,EACpE,EAAE;IACC,QAAQ,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,SAAS,CAAC;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,kBAAkB,EAAE,kBAAkB,CAAA;CACzC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,CA0DlC"}

package/dist/rules/http-agents.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAgent = getAgent;
+const url = require("url");
+const http = require("http");
+const https = require("https");
+const LRU = require("lru-cache");
+const getHttpsProxyAgent = require("https-proxy-agent");
+const pac_proxy_agent_1 = require("pac-proxy-agent");
+const socks_proxy_agent_1 = require("socks-proxy-agent");
+const getSocksProxyAgent = (opts) => new socks_proxy_agent_1.SocksProxyAgent(opts);
+const util_1 = require("../util/util");
+const proxy_config_1 = require("./proxy-config");
+const passthrough_handling_1 = require("./passthrough-handling");
+const KeepAliveAgents = util_1.isNode
+    ? {
+        'http:': new http.Agent({
+            keepAlive: true
+        }),
+        'https:': new https.Agent({
+            keepAlive: true
+        })
+    } : {};
+const ProxyAgentFactoryMap = {
+    'http:': getHttpsProxyAgent, // HTTPS here really means 'CONNECT-tunnelled' - it can do either
+    'https:': getHttpsProxyAgent,
+    'pac+http:': (...args) => new pac_proxy_agent_1.PacProxyAgent(...args),
+    'pac+https:': (...args) => new pac_proxy_agent_1.PacProxyAgent(...args),
+    'socks:': getSocksProxyAgent,
+    'socks4:': getSocksProxyAgent,
+    'socks4a:': getSocksProxyAgent,
+    'socks5:': getSocksProxyAgent,
+    'socks5h:': getSocksProxyAgent
+};
+const proxyAgentCache = new LRU({
+    max: 20,
+    ttl: 1000 * 60 * 5, // Drop refs to unused agents after 5 minutes
+    ttlResolution: 1000 * 60, // Check for expiry once every minute maximum
+    ttlAutopurge: true, // Actively drop expired agents
+    updateAgeOnGet: true // Don't drop agents while they're in use
+});
+const getCacheKey = (options) => JSON.stringify(options);
+async function getAgent({ protocol, hostname, port, tryHttp2, keepAlive, proxySettingSource }) {
+    const proxySetting = await (0, proxy_config_1.getProxySetting)(proxySettingSource, { hostname });
+    if (proxySetting?.proxyUrl) {
+        // If there's a (non-empty) proxy configured, use it. We require non-empty because empty strings
+        // will fall back to detecting from the environment, which is likely to behave unexpectedly.
+        if (!(0, proxy_config_1.matchesNoProxy)(hostname, port, proxySetting.noProxy)) {
+            // We notably ignore HTTP/2 upstream in this case: it's complicated to mix that up with proxying
+            // so for now we ignore it entirely.
+            const cacheKey = getCacheKey({
+                url: proxySetting.proxyUrl,
+                trustedCAs: proxySetting.trustedCAs,
+                additionalTrustedCAs: proxySetting.additionalTrustedCAs
+            });
+            if (!proxyAgentCache.has(cacheKey)) {
+                const { href, protocol, auth, hostname, port } = url.parse(proxySetting.proxyUrl);
+                const buildProxyAgent = ProxyAgentFactoryMap[protocol];
+                // If you specify trusted CAs, we override the CAs used for this connection, i.e. the trusted
+                // CA for the certificate of an HTTPS proxy. This is *not* the CAs trusted for upstream servers
+                // on the otherside of the proxy - see the corresponding passthrough options for that.
+                const trustedCerts = await (0, passthrough_handling_1.getTrustedCAs)(proxySetting.trustedCAs, proxySetting.additionalTrustedCAs);
+                proxyAgentCache.set(cacheKey, buildProxyAgent({
+                    href,
+                    protocol,
+                    auth,
+                    hostname,
+                    port,
+                    ...(trustedCerts
+                        ? { ca: trustedCerts }
+                        : {})
+                }));
+            }
+            return proxyAgentCache.get(cacheKey);
+        }
+    }
+    if (tryHttp2 && (protocol === 'https:' || protocol === 'wss:')) {
+        // H2 wrapper takes multiple agents, uses the appropriate one for the detected protocol.
+        // We notably never use H2 upstream for plaintext, it's rare and we can't use ALPN to detect it.
+        return { https: KeepAliveAgents['https:'], http2: undefined };
+    }
+    else if (keepAlive && protocol !== 'wss:' && protocol !== 'ws:') {
+        // HTTP/1.1 or HTTP/1 with explicit keep-alive
+        return KeepAliveAgents[protocol || 'http:'];
+    }
+    else {
+        // HTTP/1 without KA - just send the request with no agent
+        return undefined;
+    }
+}
+//# sourceMappingURL=http-agents.js.map

package/dist/rules/http-agents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-agents.js","sourceRoot":"","sources":["../../src/rules/http-agents.ts"],"names":[],"mappings":";;AAmDA,4BAmEC;AArHD,2BAA2B;AAC3B,6BAA6B;AAC7B,+BAA+B;AAE/B,iCAAiC;AAEjC,wDAAyD;AACzD,qDAAgD;AAChD,yDAAoD;AACpD,MAAM,kBAAkB,GAAG,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,mCAAe,CAAC,IAAI,CAAC,CAAC;AAEpE,uCAAsC;AACtC,iDAAqF;AACrF,iEAAuD;AAEvD,MAAM,eAAe,GAAG,aAAM;IAC1B,CAAC,CAAC;QACE,OAAO,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC;YACpB,SAAS,EAAE,IAAI;SAClB,CAAC;QACF,QAAQ,EAAE,IAAI,KAAK,CAAC,KAAK,CAAC;YACtB,SAAS,EAAE,IAAI;SAClB,CAAC;KACL,CAAC,CAAC,CAAC,EAAE,CAAC;AAEX,MAAM,oBAAoB,GAAG;IACzB,OAAO,EAAE,kBAAkB,EAAE,iEAAiE;IAC9F,QAAQ,EAAE,kBAAkB;IAE5B,WAAW,EAAE,CAAC,GAAG,IAAS,EAAE,EAAE,CAAC,IAAI,+BAAa,CAAC,GAAG,IAAI,CAAC;IACzD,YAAY,EAAE,CAAC,GAAG,IAAS,EAAE,EAAE,CAAC,IAAI,+BAAa,CAAC,GAAG,IAAI,CAAC;IAE1D,QAAQ,EAAE,kBAAkB;IAC5B,SAAS,EAAE,kBAAkB;IAC7B,UAAU,EAAE,kBAAkB;IAC9B,SAAS,EAAE,kBAAkB;IAC7B,UAAU,EAAE,kBAAkB;CACxB,CAAC;AAEX,MAAM,eAAe,GAAG,IAAI,GAAG,CAAqB;IAChD,GAAG,EAAE,EAAE;IAEP,GAAG,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,EAAE,6CAA6C;IACjE,aAAa,EAAE,IAAI,GAAG,EAAE,EAAE,6CAA6C;IACvE,YAAY,EAAE,IAAI,EAAE,+BAA+B;IACnD,cAAc,EAAE,IAAI,CAAC,yCAAyC;CACjE,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,CAAC,OAAW,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAEtD,KAAK,UAAU,QAAQ,CAAC,EAC3B,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,kBAAkB,EAQpE;IACG,MAAM,YAAY,GAAG,MAAM,IAAA,8BAAe,EAAC,kBAAkB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAE7E,IAAI,YAAY,EAAE,QAAQ,EAAE,CAAC;QACzB,gGAAgG;QAChG,4FAA4F;QAE5F,IAAI,CAAC,IAAA,6BAAc,EAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YACxD,gGAAgG;YAChG,oCAAoC;YAEpC,MAAM,QAAQ,GAAG,WAAW,CAAC;gBACzB,GAAG,EAAE,YAAY,CAAC,QAAQ;gBAC1B,UAAU,EAAE,YAAY,CAAC,UAAU;gBACnC,oBAAoB,EAAE,YAAY,CAAC,oBAAoB;aAC1D,CAAC,CAAC;YAEH,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBAClF,MAAM,eAAe,GAAG,oBAAoB,CAAC,QAA6C,CAAC,CAAC;gBAE5F,6FAA6F;gBAC7F,+FAA+F;gBAC/F,sFAAsF;gBACtF,MAAM,YAAY,GAAG,MAAM,IAAA,oCAAa,EACpC,YAAY,CAAC,UAAU,EACvB,YAAY,CAAC,oBAAoB,CACpC,CAAC;gBAEF,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC;oBAC1C,IAAI;oBACJ,QAAQ;oBACR,IAAI;oBACJ,QAAQ;oBACR,IAAI;oBAEJ,GAAG,CAAC,YAAY;wBACZ,CAAC,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE;wBACtB,CAAC,CAAC,EAAE,CACP;iBACJ,CAAC,CAAC,CAAC;YACR,CAAC;YAED,OAAO,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAED,IAAI,QAAQ,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,MAAM,CAAC,EAAE,CAAC;QAC7D,wFAAwF;QACxF,gGAAgG;QAChG,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,SAAS,EAAuB,CAAC;IACvF,CAAC;SAAM,IAAI,SAAS,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;QAChE,8CAA8C;QAC9C,OAAO,eAAe,CAAC,QAAQ,IAAI,OAAO,CAAC,CAAA;IAC/C,CAAC;SAAM,CAAC;QACJ,0DAA0D;QAC1D,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC"}