mocktp 0.0.1-security → 3.15.3

package/dist/rules/matchers.d.ts

@@ -0,0 +1,214 @@
+import { CompletedRequest, Method, Explainable, OngoingRequest } from "../types";
+import { Serializable, ClientServerChannel } from "../serialization/serialization";
+import { MaybePromise } from '../util/type-utils';
+export interface RequestMatcher extends Explainable, Serializable {
+    type: keyof typeof MatcherLookup;
+    matches(request: OngoingRequest): MaybePromise<boolean>;
+}
+export interface SerializedCallbackMatcherData {
+    type: string;
+    name?: string;
+    version?: number;
+}
+export declare class WildcardMatcher extends Serializable implements RequestMatcher {
+    readonly type = "wildcard";
+    matches(): boolean;
+    explain(): string;
+}
+export declare class MethodMatcher extends Serializable implements RequestMatcher {
+    method: Method;
+    readonly type = "method";
+    constructor(method: Method);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class ProtocolMatcher extends Serializable implements RequestMatcher {
+    protocol: "http" | "https" | "ws" | "wss";
+    readonly type = "protocol";
+    constructor(protocol: "http" | "https" | "ws" | "wss");
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class HostMatcher extends Serializable implements RequestMatcher {
+    host: string;
+    readonly type = "host";
+    constructor(host: string);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class HostnameMatcher extends Serializable implements RequestMatcher {
+    readonly hostname: string;
+    readonly type = "hostname";
+    constructor(hostname: string);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class PortMatcher extends Serializable implements RequestMatcher {
+    readonly type = "port";
+    port: string;
+    constructor(port: number);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class SimplePathMatcher extends Serializable implements RequestMatcher {
+    path: string;
+    readonly type = "simple-path";
+    constructor(path: string);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class RegexPathMatcher extends Serializable implements RequestMatcher {
+    readonly type = "regex-path";
+    readonly regexSource: string;
+    readonly regexFlags: string;
+    constructor(regex: RegExp);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class RegexUrlMatcher extends Serializable implements RequestMatcher {
+    readonly type = "regex-url";
+    readonly regexSource: string;
+    readonly regexFlags: string;
+    constructor(regex: RegExp);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class HeaderMatcher extends Serializable implements RequestMatcher {
+    readonly type = "header";
+    headers: {
+        [key: string]: string;
+    };
+    constructor(headersInput: {
+        [key: string]: string;
+    });
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class ExactQueryMatcher extends Serializable implements RequestMatcher {
+    query: string;
+    readonly type = "exact-query-string";
+    constructor(query: string);
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class QueryMatcher extends Serializable implements RequestMatcher {
+    readonly type = "query";
+    queryObject: {
+        [key: string]: string | string[];
+    };
+    constructor(queryObjectInput: {
+        [key: string]: string | number | (string | number)[];
+    });
+    matches(request: OngoingRequest): boolean;
+    explain(): string;
+}
+export declare class FormDataMatcher extends Serializable implements RequestMatcher {
+    formData: {
+        [key: string]: string;
+    };
+    readonly type = "form-data";
+    constructor(formData: {
+        [key: string]: string;
+    });
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export type MultipartFieldMatchCondition = {
+    name?: string;
+    filename?: string;
+    content?: string | Uint8Array;
+};
+export declare class MultipartFormDataMatcher extends Serializable implements RequestMatcher {
+    matchConditions: Array<MultipartFieldMatchCondition>;
+    readonly type = "multipart-form-data";
+    constructor(matchConditions: Array<MultipartFieldMatchCondition>);
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class RawBodyMatcher extends Serializable implements RequestMatcher {
+    content: string;
+    readonly type = "raw-body";
+    constructor(content: string);
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class RawBodyIncludesMatcher extends Serializable implements RequestMatcher {
+    content: string;
+    readonly type = "raw-body-includes";
+    constructor(content: string);
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class RegexBodyMatcher extends Serializable implements RequestMatcher {
+    readonly type = "raw-body-regexp";
+    readonly regexString: string;
+    constructor(regex: RegExp);
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class JsonBodyMatcher extends Serializable implements RequestMatcher {
+    body: {};
+    readonly type = "json-body";
+    constructor(body: {});
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class JsonBodyFlexibleMatcher extends Serializable implements RequestMatcher {
+    body: {};
+    readonly type = "json-body-matching";
+    constructor(body: {});
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class CookieMatcher extends Serializable implements RequestMatcher {
+    cookie: {
+        [key: string]: string;
+    };
+    readonly type = "cookie";
+    constructor(cookie: {
+        [key: string]: string;
+    });
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+}
+export declare class CallbackMatcher extends Serializable implements RequestMatcher {
+    callback: (request: CompletedRequest) => MaybePromise<boolean>;
+    readonly type = "callback";
+    constructor(callback: (request: CompletedRequest) => MaybePromise<boolean>);
+    matches(request: OngoingRequest): Promise<boolean>;
+    explain(): string;
+    /**
+     * @internal
+     */
+    serialize(channel: ClientServerChannel): SerializedCallbackMatcherData;
+    /**
+     * @internal
+     */
+    static deserialize({ name }: SerializedCallbackMatcherData, channel: ClientServerChannel): CallbackMatcher;
+}
+export declare const MatcherLookup: {
+    wildcard: typeof WildcardMatcher;
+    method: typeof MethodMatcher;
+    protocol: typeof ProtocolMatcher;
+    host: typeof HostMatcher;
+    hostname: typeof HostnameMatcher;
+    port: typeof PortMatcher;
+    'simple-path': typeof SimplePathMatcher;
+    'regex-path': typeof RegexPathMatcher;
+    'regex-url': typeof RegexUrlMatcher;
+    header: typeof HeaderMatcher;
+    query: typeof QueryMatcher;
+    'exact-query-string': typeof ExactQueryMatcher;
+    'form-data': typeof FormDataMatcher;
+    'multipart-form-data': typeof MultipartFormDataMatcher;
+    'raw-body': typeof RawBodyMatcher;
+    'raw-body-regexp': typeof RegexBodyMatcher;
+    'raw-body-includes': typeof RawBodyIncludesMatcher;
+    'json-body': typeof JsonBodyMatcher;
+    'json-body-matching': typeof JsonBodyFlexibleMatcher;
+    cookie: typeof CookieMatcher;
+    callback: typeof CallbackMatcher;
+};
+export declare function matchesAll(req: OngoingRequest, matchers: RequestMatcher[]): Promise<boolean>;
+export declare function explainMatchers(matchers: RequestMatcher[]): string;
+//# sourceMappingURL=matchers.d.ts.map

package/dist/rules/matchers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.d.ts","sourceRoot":"","sources":["../../src/rules/matchers.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AASjF,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAEnF,OAAO,EAAE,YAAY,EAAW,MAAM,oBAAoB,CAAC;AAE3D,MAAM,WAAW,cAAe,SAAQ,WAAW,EAAE,YAAY;IAC7D,IAAI,EAAE,MAAM,OAAO,aAAa,CAAC;IACjC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,6BAA6B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;IACvE,QAAQ,CAAC,IAAI,cAAc;IAE3B,OAAO;IAIP,OAAO;CAGV;AAED,qBAAa,aAAc,SAAQ,YAAa,YAAW,cAAc;IAI1D,MAAM,EAAE,MAAM;IAHzB,QAAQ,CAAC,IAAI,YAAY;gBAGd,MAAM,EAAE,MAAM;IAKzB,OAAO,CAAC,OAAO,EAAE,cAAc;IAI/B,OAAO;CAGV;AAED,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;IAI5D,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,KAAK;IAHpD,QAAQ,CAAC,IAAI,cAAc;gBAGhB,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,KAAK;IAepD,OAAO,CAAC,OAAO,EAAE,cAAc;IAI/B,OAAO;CAGV;AAED,qBAAa,WAAY,SAAQ,YAAa,YAAW,cAAc;IAIxD,IAAI,EAAE,MAAM;IAHvB,QAAQ,CAAC,IAAI,UAAU;gBAGZ,IAAI,EAAE,MAAM;IAevB,OAAO,CAAC,OAAO,EAAE,cAAc;IAgB/B,OAAO;CAGV;AAED,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;aAInD,QAAQ,EAAE,MAAM;IAHpC,QAAQ,CAAC,IAAI,cAAc;gBAGP,QAAQ,EAAE,MAAM;IAepC,OAAO,CAAC,OAAO,EAAE,cAAc;IAI/B,OAAO;CAGV;AAED,qBAAa,WAAY,SAAQ,YAAa,YAAW,cAAc;IACnE,QAAQ,CAAC,IAAI,UAAU;IAEhB,IAAI,EAAE,MAAM,CAAC;gBAER,IAAI,EAAE,MAAM;IAKxB,OAAO,CAAC,OAAO,EAAE,cAAc;IAe/B,OAAO;CAGV;AAED,qBAAa,iBAAkB,SAAQ,YAAa,YAAW,cAAc;IAI9D,IAAI,EAAE,MAAM;IAHvB,QAAQ,CAAC,IAAI,iBAAiB;gBAGnB,IAAI,EAAE,MAAM;IAkBvB,OAAO,CAAC,OAAO,EAAE,cAAc;IAkB/B,OAAO;CAGV;AAED,qBAAa,gBAAiB,SAAQ,YAAa,YAAW,cAAc;IACxE,QAAQ,CAAC,IAAI,gBAAgB;IAE7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;gBAEhB,KAAK,EAAE,MAAM;IAMzB,OAAO,CAAC,OAAO,EAAE,cAAc;IAU/B,OAAO;CAIV;AAED,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;IACvE,QAAQ,CAAC,IAAI,eAAe;IAE5B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;gBAEhB,KAAK,EAAE,MAAM;IAMzB,OAAO,CAAC,OAAO,EAAE,cAAc;IAQ/B,OAAO;CAIV;AAED,qBAAa,aAAc,SAAQ,YAAa,YAAW,cAAc;IACrE,QAAQ,CAAC,IAAI,YAAY;IAElB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;gBAE9B,YAAY,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAKnD,OAAO,CAAC,OAAO,EAAE,cAAc;IAI/B,OAAO;CAGV;AAED,qBAAa,iBAAkB,SAAQ,YAAa,YAAW,cAAc;IAI9D,KAAK,EAAE,MAAM;IAHxB,QAAQ,CAAC,IAAI,wBAAwB;gBAG1B,KAAK,EAAE,MAAM;IASxB,OAAO,CAAC,OAAO,EAAE,cAAc;IAK/B,OAAO;CAKV;AAED,qBAAa,YAAa,SAAQ,YAAa,YAAW,cAAc;IACpE,QAAQ,CAAC,IAAI,WAAW;IAEjB,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC;gBAGrD,gBAAgB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;KAAE;IAQ9E,OAAO,CAAC,OAAO,EAAE,cAAc;IAK/B,OAAO;CAGV;AAED,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;IAI5D,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAH9C,QAAQ,CAAC,IAAI,eAAe;gBAGjB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAKxC,OAAO,CAAC,OAAO,EAAE,cAAc;IAQrC,OAAO;CAGV;AAED,MAAM,MAAM,4BAA4B,GAAG;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;CAChC,CAAC;AAEF,qBAAa,wBAAyB,SAAQ,YAAa,YAAW,cAAc;IAIrE,eAAe,EAAE,KAAK,CAAC,4BAA4B,CAAC;IAH/D,QAAQ,CAAC,IAAI,yBAAyB;gBAG3B,eAAe,EAAE,KAAK,CAAC,4BAA4B,CAAC;IAKzD,OAAO,CAAC,OAAO,EAAE,cAAc;IAwBrC,OAAO;CAGV;AAED,qBAAa,cAAe,SAAQ,YAAa,YAAW,cAAc;IAI3D,OAAO,EAAE,MAAM;IAH1B,QAAQ,CAAC,IAAI,cAAc;gBAGhB,OAAO,EAAE,MAAM;IAKpB,OAAO,CAAC,OAAO,EAAE,cAAc;IAIrC,OAAO;CAGV;AAED,qBAAa,sBAAuB,SAAQ,YAAa,YAAW,cAAc;IAInE,OAAO,EAAE,MAAM;IAH1B,QAAQ,CAAC,IAAI,uBAAuB;gBAGzB,OAAO,EAAE,MAAM;IAKpB,OAAO,CAAC,OAAO,EAAE,cAAc;IAIrC,OAAO;CAGV;AAED,qBAAa,gBAAiB,SAAQ,YAAa,YAAW,cAAc;IACxE,QAAQ,CAAC,IAAI,qBAAqB;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;gBAEjB,KAAK,EAAE,MAAM;IAKnB,OAAO,CAAC,OAAO,EAAE,cAAc;IAKrC,OAAO;CAIV;AAED,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;IAI5D,IAAI,EAAE,EAAE;IAHnB,QAAQ,CAAC,IAAI,eAAe;gBAGjB,IAAI,EAAE,EAAE;IAKb,OAAO,CAAC,OAAO,EAAE,cAAc;IAOrC,OAAO;CAIV;AAED,qBAAa,uBAAwB,SAAQ,YAAa,YAAW,cAAc;IAIpE,IAAI,EAAE,EAAE;IAHnB,QAAQ,CAAC,IAAI,wBAAwB;gBAG1B,IAAI,EAAE,EAAE;IAKb,OAAO,CAAC,OAAO,EAAE,cAAc;IAOrC,OAAO;CAIV;AAED,qBAAa,aAAc,SAAQ,YAAa,YAAW,cAAc;IAI1D,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAH5C,QAAQ,CAAC,IAAI,YAAY;gBAGd,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAKtC,OAAO,CAAC,OAAO,EAAE,cAAc;IAcrC,OAAO;CAGV;AAED,qBAAa,eAAgB,SAAQ,YAAa,YAAW,cAAc;IAI5D,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,YAAY,CAAC,OAAO,CAAC;IAHzE,QAAQ,CAAC,IAAI,cAAc;gBAGhB,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,KAAK,YAAY,CAAC,OAAO,CAAC;IAKnE,OAAO,CAAC,OAAO,EAAE,cAAc;IAKrC,OAAO;IAMP;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,mBAAmB,GAAG,6BAA6B;IAYtE;;OAEG;IACH,MAAM,CAAC,WAAW,CAChB,EAAE,IAAI,EAAE,EAAE,6BAA6B,EACvC,OAAO,EAAE,mBAAmB,GAC3B,eAAe;CAgBrB;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;CAsBzB,CAAC;AAEF,wBAAsB,UAAU,CAAC,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBlG;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,cAAc,EAAE,UAWzD"}