@leyyo/http-mock 1.1.1 → 1.3.1

package/dist/index.d.ts

@@ -1 +1,6 @@
+export * from './shared';
+export * from './application';
+export * from './request';
+export * from './response';
 export * from './http-mock';
+export * from './index.types';

package/dist/index.js

@@ -14,5 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./shared"), exports);
+__exportStar(require("./application"), exports);
+__exportStar(require("./request"), exports);
+__exportStar(require("./response"), exports);
 __exportStar(require("./http-mock"), exports);
+__exportStar(require("./index.types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,gDAA8B;AAC9B,4CAA0B;AAC1B,6CAA2B;AAC3B,8CAA4B;AAC5B,gDAA8B"}

package/dist/index.types.d.ts

@@ -0,0 +1,32 @@
+import { Application, Request, Response } from "express";
+import { MockResponseResolve, ResponseData } from "./response";
+import { MockServiceRequest } from "./request";
+import { Dict } from "@leyyo/common";
+export type HttpMockTuple = [Request, Response, Application];
+/**
+ * Http mock interface
+ * */
+export interface HttpMockLike {
+    /**
+     * Initialize http mock
+     *
+     * @param {Request} req
+     * */
+    init(req: Request): void;
+    /**
+     * Fork http mock as tuple
+     *
+     * @return {HttpMockTuple}
+     * */
+    fork(): HttpMockTuple;
+    /**
+     * Run it for http bulk
+     *
+     * @param {Request} req - real request
+     * @param {MockServiceRequest} service - service payloads
+     * @param {MockResponseResolve} resolver - response resolver to collect response
+     * @param {object} custom - custom parameters
+     * @return {HttpMockTuple}
+     * */
+    forBulk<R = ResponseData>(req: Request, service: MockServiceRequest<R>, resolver: MockResponseResolve<R>, custom?: Dict): HttpMockTuple;
+}

package/dist/index.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.types.js.map

package/dist/index.types.js.map

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

package/dist/internal.d.ts

@@ -0,0 +1 @@
+export declare const FQN = "leyyo.http-mock";

package/dist/internal.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FQN = void 0;
+// noinspection JSUnusedGlobalSymbols
+exports.FQN = 'leyyo.http-mock';
+//# sourceMappingURL=internal.js.map

package/dist/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACxB,QAAA,GAAG,GAAG,iBAAiB,CAAC"}

package/dist/request/index.d.ts

@@ -1,2 +1,2 @@
-export * from './index-types';
-export * from './mock-request';
+export * from './index.types';
+export * from './mock.request';

package/dist/request/index.js

@@ -14,6 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./index-types"), exports);
-__exportStar(require("./mock-request"), exports);
+__exportStar(require("./index.types"), exports);
+__exportStar(require("./mock.request"), exports);
 //# sourceMappingURL=index.js.map

package/dist/request/index.types.d.ts

@@ -0,0 +1,61 @@
+import { Request } from "express";
+import { ResponseData } from "../response";
+import { Arr } from "@leyyo/common";
+import { HttpCookies, HttpData, HttpHeaders, HttpMethod, HttpParams, HttpQuery } from "../shared";
+export interface RequestLocal {
+}
+export type RequestBody = Arr | HttpData | string | unknown;
+export type RequestErrorCallback = (error?: Error) => void;
+/**
+ * It's used for bulk http calls
+ * */
+export interface MockServiceRequest<B extends RequestBody = RequestBody> {
+    /**
+     * Http method
+     * */
+    method: HttpMethod;
+    /**
+     * Local path
+     * */
+    url: string;
+    /**
+     * Request payload
+     * */
+    body?: B;
+    /**
+     * Custom headers
+     * */
+    headers?: HttpHeaders;
+    /**
+     * Client cookies
+     * */
+    cookies?: HttpCookies;
+    /**
+     * Server cookies
+     * */
+    signedCookies?: HttpCookies;
+}
+/**
+ * Http mock request, it extends express request
+ * */
+export interface MockRequestLike<B extends RequestBody = RequestBody, L extends RequestLocal = RequestLocal> extends Request<HttpParams, B, ResponseData, HttpQuery, L> {
+    /**
+     * Indicates that it's fake/mock request
+     * */
+    readonly isFake?: boolean;
+    /**
+     * Temporary local storage
+     * */
+    readonly locals?: L;
+    /**
+     * Get query parameter
+     * */
+    param(name: string, defaultValue?: any): string;
+    /**
+     * Custom properties
+     * */
+    [another: string]: unknown;
+}
+export interface PipeOption {
+    end?: boolean;
+}

package/dist/request/index.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.types.js.map

package/dist/request/index.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.types.js","sourceRoot":"","sources":["../../src/request/index.types.ts"],"names":[],"mappings":""}

package/dist/request/mock.request.d.ts

@@ -0,0 +1,248 @@
+import { Application, MediaType, NextFunction, Request, Response } from "express";
+import { Socket } from "net";
+import { IncomingHttpHeaders } from "http";
+import RangeParser from "range-parser";
+import { MockRequestLike, MockServiceRequest, PipeOption, RequestBody, RequestErrorCallback, RequestLocal } from "./index.types";
+import { _StreamAbort, _StreamBool, _StreamCompose, _StreamGeneric, _StreamIterator, _StreamReduce, _StreamVoid, HttpCookies, HttpEvent, HttpMethod, HttpParams, HttpProtocol, HttpQuery } from "../shared";
+import { Dict, Fnc, HttpStatus, OneOrMore } from "@leyyo/common";
+import { ArrayOptions, Readable } from "node:stream";
+export declare class MockRequest<B extends RequestBody = RequestBody, L extends RequestLocal = RequestLocal> extends HttpEvent<Request> implements MockRequestLike<B, L> {
+    /** @inheritDoc */
+    readonly isFake: boolean;
+    /** @inheritDoc */
+    readonly locals: L;
+    /** @inheritDoc */
+    [another: string]: unknown;
+    /**
+     * Constructor
+     *
+     * @param {MockServiceRequest} service - for bulk request
+     * @param {Request} origin - first real request
+     * @param {object} custom - custom values
+     * */
+    constructor(service?: MockServiceRequest<B>, origin?: Request, custom?: Dict);
+    /** @inheritDoc*/
+    accepted: MediaType[];
+    /** @inheritDoc*/
+    readonly protocol: HttpProtocol;
+    /** @inheritDoc*/
+    readonly secure: boolean;
+    /** @inheritDoc*/
+    readonly ip: string;
+    /** @inheritDoc*/
+    readonly ips: string[];
+    /** @inheritDoc*/
+    readonly subdomains: string[];
+    /** @inheritDoc*/
+    readonly path: string;
+    /** @inheritDoc*/
+    readonly host: string;
+    /** @inheritDoc*/
+    readonly hostname: string;
+    /** @inheritDoc*/
+    readonly httpVersion: string;
+    /** @inheritDoc*/
+    readonly httpVersionMajor: number;
+    /** @inheritDoc*/
+    readonly httpVersionMinor: number;
+    /** @inheritDoc*/
+    readonly fresh: boolean;
+    /** @inheritDoc*/
+    readonly stale: boolean;
+    /** @inheritDoc*/
+    readonly xhr: boolean;
+    /** @inheritDoc*/
+    body: RequestBody;
+    /** @inheritDoc*/
+    cookies: any;
+    /** @inheritDoc*/
+    method: HttpMethod;
+    /** @inheritDoc*/
+    params: HttpParams;
+    /** @inheritDoc*/
+    query: HttpQuery;
+    /** @inheritDoc*/
+    route: any;
+    /** @inheritDoc*/
+    signedCookies: HttpCookies;
+    /** @inheritDoc*/
+    originalUrl: string;
+    /** @inheritDoc*/
+    url: string;
+    /** @inheritDoc*/
+    baseUrl: string;
+    /** @inheritDoc*/
+    app: Application;
+    /** @inheritDoc*/
+    res?: Response<unknown, L>;
+    /** @inheritDoc*/
+    next?: NextFunction;
+    /** @inheritDoc*/
+    headers: IncomingHttpHeaders;
+    /** @inheritDoc*/
+    is(t: OneOrMore<string>): string | false | null;
+    /** @inheritDoc*/
+    get(n: "set-cookie"): string[] | undefined;
+    /** @inheritDoc*/
+    get(n: string): string | undefined;
+    /** @inheritDoc*/
+    header(n: "set-cookie"): string[] | undefined;
+    /** @inheritDoc*/
+    header(n: string): string | undefined;
+    /** @inheritDoc*/
+    accepts(): string[];
+    /** @inheritDoc*/
+    accepts(t: string): string | false;
+    /** @inheritDoc*/
+    accepts(t: string[]): string | false;
+    /** @inheritDoc*/
+    accepts(...t: string[]): string | false;
+    /** @inheritDoc*/
+    acceptsCharsets(): string[];
+    /** @inheritDoc*/
+    acceptsCharsets(c: string): string | false;
+    /** @inheritDoc*/
+    acceptsCharsets(c: string[]): string | false;
+    /** @inheritDoc*/
+    acceptsCharsets(...c: string[]): string | false;
+    /** @inheritDoc*/
+    acceptsEncodings(): string[];
+    /** @inheritDoc*/
+    acceptsEncodings(e: string): string | false;
+    /** @inheritDoc*/
+    acceptsEncodings(e: string[]): string | false;
+    /** @inheritDoc*/
+    acceptsEncodings(...e: string[]): string | false;
+    /** @inheritDoc*/
+    acceptsLanguages(): string[];
+    /** @inheritDoc*/
+    acceptsLanguages(l: string): string | false;
+    /** @inheritDoc*/
+    acceptsLanguages(l: string[]): string | false;
+    /** @inheritDoc*/
+    acceptsLanguages(...l: string[]): string | false;
+    /** @inheritDoc*/
+    range(s: number, o?: RangeParser.Options): RangeParser.Ranges | RangeParser.Result | undefined;
+    /** @inheritDoc*/
+    aborted: boolean;
+    /** @inheritDoc*/
+    complete: boolean;
+    /** @inheritDoc*/
+    statusCode: HttpStatus | undefined;
+    /** @inheritDoc*/
+    statusMessage: string | undefined;
+    /** @inheritDoc*/
+    socket: Socket;
+    /** @inheritDoc*/
+    headersDistinct: NodeJS.Dict<string[]>;
+    /** @inheritDoc*/
+    rawHeaders: string[];
+    /** @inheritDoc*/
+    trailers: Record<string, string>;
+    /** @inheritDoc*/
+    rawTrailers: string[];
+    /** @inheritDoc*/
+    trailersDistinct: NodeJS.Dict<string[]>;
+    /** @inheritDoc*/
+    get connection(): Socket;
+    /** @inheritDoc*/
+    destroy(_e?: Error): this;
+    /** @inheritDoc*/
+    setTimeout(_m: number, _c?: Fnc): this;
+    /** @inheritDoc*/
+    [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+    /** @inheritDoc*/
+    [Symbol.asyncDispose](): Promise<void>;
+    /** @inheritDoc*/
+    readonly closed: boolean;
+    /** @inheritDoc*/
+    readonly errored: Error;
+    /** @inheritDoc*/
+    destroyed: boolean;
+    /** @inheritDoc*/
+    readonly readableDidRead: boolean;
+    /** @inheritDoc*/
+    readonly readableEncoding: BufferEncoding | null;
+    /** @inheritDoc*/
+    readonly readableEnded: boolean;
+    /** @inheritDoc*/
+    readonly readableAborted: boolean;
+    /** @inheritDoc*/
+    readonly readableFlowing: boolean | null;
+    /** @inheritDoc*/
+    readonly readableHighWaterMark: number;
+    /** @inheritDoc*/
+    readonly readableLength: number;
+    /** @inheritDoc*/
+    readonly readableObjectMode: boolean;
+    /** @inheritDoc*/
+    readable: boolean;
+    /** @inheritDoc*/
+    _construct(_c: RequestErrorCallback): void;
+    /** @inheritDoc*/
+    _destroy(_e: Error | null, _c: RequestErrorCallback): void;
+    /** @inheritDoc*/
+    _read(_s: number): void;
+    /** @inheritDoc*/
+    read(_s: number | undefined): string | Buffer;
+    /** @inheritDoc*/
+    push(_c: any, _e?: BufferEncoding): boolean;
+    /** @inheritDoc*/
+    isPaused(): boolean;
+    /** @inheritDoc*/
+    resume(): this;
+    /** @inheritDoc*/
+    pause(): this;
+    /** @inheritDoc*/
+    pipe<T extends NodeJS.WritableStream>(_d: T, _o?: PipeOption): T;
+    /** @inheritDoc*/
+    setEncoding(_e: BufferEncoding): this;
+    /** @inheritDoc*/
+    unpipe(_d?: NodeJS.WritableStream): this;
+    /** @inheritDoc*/
+    unshift(_c: string | Uint8Array, _e?: BufferEncoding): void;
+    /** @inheritDoc*/
+    wrap(_s: NodeJS.ReadableStream): this;
+    /** @inheritDoc*/
+    asIndexedPairs(_o: _StreamAbort | undefined): Readable;
+    /** @inheritDoc*/
+    compose<T extends NodeJS.ReadableStream>(_s: _StreamCompose | Iterable<T> | AsyncIterable<T> | T, _o: _StreamAbort | undefined): T;
+    /** @inheritDoc*/
+    drop(_l: number, _o: _StreamAbort | undefined): Readable;
+    /** @inheritDoc*/
+    every(_f: _StreamBool, _o: ArrayOptions | undefined): Promise<boolean>;
+    /** @inheritDoc*/
+    filter(_f: _StreamBool, _o: ArrayOptions | undefined): Readable;
+    /** @inheritDoc*/
+    find<T>(_f: _StreamGeneric<T>, _o: ArrayOptions | undefined): Promise<T | undefined>;
+    /** @inheritDoc*/
+    flatMap(_f: _StreamGeneric<any>, _o: ArrayOptions | undefined): Readable;
+    /** @inheritDoc*/
+    forEach(_f: _StreamVoid, _o: ArrayOptions | undefined): Promise<void>;
+    /** @inheritDoc*/
+    iterator(_o: _StreamIterator | undefined): NodeJS.AsyncIterator<any>;
+    /** @inheritDoc*/
+    map(_f: _StreamGeneric<any>, _o: ArrayOptions | undefined): Readable;
+    /** @inheritDoc*/
+    reduce<T>(_f: _StreamReduce<T>, _i: undefined, _o: _StreamAbort | undefined): Promise<T>;
+    /** @inheritDoc*/
+    some(_f: _StreamBool, _o: ArrayOptions | undefined): Promise<boolean>;
+    /** @inheritDoc*/
+    take(_l: number, _o: _StreamAbort | undefined): Readable;
+    /** @inheritDoc*/
+    toArray(_o: _StreamAbort | undefined): Promise<any[]>;
+    /** @inheritDoc*/
+    param(name: string, defaultValue?: any): string;
+    /**
+     * Set first real request
+     *
+     * @param {Request} origin
+     * */
+    static setFirstOrigin(origin: Request): void;
+    /**
+     * Get first real request
+     *
+     * @return {Request}
+     * */
+    static get firstOrigin(): Request;
+}