@eggjs/supertest 8.0.0

package/dist/esm/test.d.ts

@@ -0,0 +1,80 @@
+import type { Server } from 'node:net';
+import { Request, type Response } from 'superagent';
+import { AssertError } from './error/AssertError.js';
+export type TestApplication = Server | string;
+export type AssertFunction = (res: Response) => AssertError | void;
+export type CallbackFunction = (err: AssertError | Error | null, res: Response) => void;
+export type ResponseError = Error & {
+    syscall?: string;
+    code?: string;
+    status?: number;
+};
+export interface ExpectHeader {
+    name: string;
+    value: string | number | RegExp;
+}
+export declare class Test extends Request {
+    app: TestApplication;
+    _server: Server;
+    _asserts: AssertFunction[];
+    /**
+     * Initialize a new `Test` with the given `app`,
+     * request `method` and `path`.
+     */
+    constructor(app: TestApplication, method: string, path: string);
+    /**
+     * Returns a URL, extracted from a server.
+     *
+     * @return {String} URL address
+     * @private
+     */
+    protected serverAddress(app: Server, path: string): string;
+    /**
+     * Expectations:
+     *
+     * ```js
+     *   .expect(200)
+     *   .expect(200, fn)
+     *   .expect(200, body)
+     *   .expect('Some body')
+     *   .expect('Some body', fn)
+     *   .expect(['json array body', { key: 'val' }])
+     *   .expect('Content-Type', 'application/json')
+     *   .expect('Content-Type', 'application/json', fn)
+     *   .expect(fn)
+     *   .expect([200, 404])
+     * ```
+     *
+     * @return {Test} The current Test instance for chaining.
+     */
+    expect(a: number | string | RegExp | object | AssertFunction, b?: string | number | RegExp | CallbackFunction, c?: CallbackFunction): Test;
+    /**
+     * Defer invoking superagent's `.end()` until
+     * the server is listening.
+     */
+    end(fn: CallbackFunction): this;
+    /**
+     * Perform assertions and invoke `fn(err, res)`.
+     */
+    assert(resError: ResponseError | null, res: Response, fn: CallbackFunction): void;
+    /**
+     * Perform assertions on a response body and return an Error upon failure.
+     */
+    _assertBody(body: RegExp | string | number | object | null | undefined, res: Response): AssertError | undefined;
+    /**
+     * Perform assertions on a response header and return an Error upon failure.
+     */
+    _assertHeader(header: ExpectHeader, res: Response): AssertError | undefined;
+    /**
+     * Perform assertions on the response status and return an Error upon failure.
+     */
+    _assertStatus(status: number, res: Response): AssertError | undefined;
+    /**
+     * Perform assertions on the response status and return an Error upon failure.
+     */
+    _assertStatusArray(statusArray: number[], res: Response): AssertError | undefined;
+    /**
+     * Performs an assertion by calling a function and return an Error upon failure.
+     */
+    _assertFunction(fn: AssertFunction, res: Response): Error | undefined;
+}

package/dist/esm/test.js

@@ -0,0 +1,278 @@
+import { inspect } from 'node:util';
+import { STATUS_CODES } from 'node:http';
+import { Server as HttpsServer } from 'node:tls';
+import { deepStrictEqual } from 'node:assert';
+import { Request } from 'superagent';
+import { AssertError } from './error/AssertError.js';
+export class Test extends Request {
+    app;
+    _server;
+    _asserts = [];
+    /**
+     * Initialize a new `Test` with the given `app`,
+     * request `method` and `path`.
+     */
+    constructor(app, method, path) {
+        super(method.toUpperCase(), path);
+        this.redirects(0);
+        this.buffer();
+        this.app = app;
+        this.url = typeof app === 'string'
+            ? app + path
+            : this.serverAddress(app, path);
+    }
+    /**
+     * Returns a URL, extracted from a server.
+     *
+     * @return {String} URL address
+     * @private
+     */
+    serverAddress(app, path) {
+        const addr = app.address();
+        if (!addr) {
+            this._server = app.listen(0);
+        }
+        const port = app.address().port;
+        const protocol = (app instanceof HttpsServer || this._server instanceof HttpsServer) ? 'https' : 'http';
+        return `${protocol}://127.0.0.1:${port}${path}`;
+    }
+    /**
+     * Expectations:
+     *
+     * ```js
+     *   .expect(200)
+     *   .expect(200, fn)
+     *   .expect(200, body)
+     *   .expect('Some body')
+     *   .expect('Some body', fn)
+     *   .expect(['json array body', { key: 'val' }])
+     *   .expect('Content-Type', 'application/json')
+     *   .expect('Content-Type', 'application/json', fn)
+     *   .expect(fn)
+     *   .expect([200, 404])
+     * ```
+     *
+     * @return {Test} The current Test instance for chaining.
+     */
+    expect(a, b, c) {
+        // callback
+        if (typeof a === 'function') {
+            // .expect(fn)
+            this._asserts.push(wrapAssertFn(a));
+            return this;
+        }
+        if (typeof b === 'function') {
+            // .expect('Some body', fn)
+            this.end(b);
+        }
+        if (typeof c === 'function') {
+            // .expect('Content-Type', 'application/json', fn)
+            this.end(c);
+        }
+        // status
+        if (typeof a === 'number') {
+            this._asserts.push(wrapAssertFn(this._assertStatus.bind(this, a)));
+            // body
+            if (typeof b !== 'function' && arguments.length > 1) {
+                // .expect(200, 'body')
+                // .expect(200, null)
+                // .expect(200, 9999999)
+                this._asserts.push(wrapAssertFn(this._assertBody.bind(this, b)));
+            }
+            return this;
+        }
+        // multiple statuses
+        if (Array.isArray(a) && a.length > 0 && a.every(val => typeof val === 'number')) {
+            // .expect([200, 300])
+            this._asserts.push(wrapAssertFn(this._assertStatusArray.bind(this, a)));
+            return this;
+        }
+        // header field
+        if (typeof b === 'string' || typeof b === 'number' || b instanceof RegExp) {
+            // .expect('Content-Type', 'application/json')
+            // .expect('Content-Type', /json/)
+            this._asserts.push(wrapAssertFn(this._assertHeader.bind(this, { name: String(a), value: b })));
+            return this;
+        }
+        // body
+        // .expect('body')
+        // .expect(['json array body', { key: 'val' }])
+        // .expect(/foo/)
+        this._asserts.push(wrapAssertFn(this._assertBody.bind(this, a)));
+        return this;
+    }
+    /**
+     * Defer invoking superagent's `.end()` until
+     * the server is listening.
+     */
+    end(fn) {
+        const server = this._server;
+        super.end((err, res) => {
+            const localAssert = () => {
+                this.assert(err, res, fn);
+            };
+            if (server && '_handle' in server && server._handle) {
+                return server.close(localAssert);
+            }
+            localAssert();
+        });
+        return this;
+    }
+    /**
+     * Perform assertions and invoke `fn(err, res)`.
+     */
+    assert(resError, res, fn) {
+        let errorObj;
+        // check for unexpected network errors or server not running/reachable errors
+        // when there is no response and superagent sends back a System Error
+        // do not check further for other asserts, if any, in such case
+        // https://nodejs.org/api/errors.html#errors_common_system_errors
+        const sysErrors = {
+            ECONNREFUSED: 'Connection refused',
+            ECONNRESET: 'Connection reset by peer',
+            EPIPE: 'Broken pipe',
+            ETIMEDOUT: 'Operation timed out',
+        };
+        if (!res && resError) {
+            if (resError instanceof Error
+                && resError.syscall === 'connect'
+                && resError.code
+                && sysErrors[resError.code]) {
+                errorObj = new Error(resError.code + ': ' + sysErrors[resError.code]);
+            }
+            else {
+                errorObj = resError;
+            }
+        }
+        // asserts
+        for (let i = 0; i < this._asserts.length && !errorObj; i += 1) {
+            errorObj = this._assertFunction(this._asserts[i], res);
+        }
+        // set unexpected superagent error if no other error has occurred.
+        if (!errorObj && resError instanceof Error && (!res || resError.status !== res.status)) {
+            errorObj = resError;
+        }
+        fn.call(this, errorObj || null, res);
+    }
+    /**
+     * Perform assertions on a response body and return an Error upon failure.
+     */
+    _assertBody(body, res) {
+        const isRegexp = body instanceof RegExp;
+        // parsed
+        if (typeof body === 'object' && !isRegexp) {
+            try {
+                deepStrictEqual(body, res.body);
+            }
+            catch (err) {
+                const a = inspect(body);
+                const b = inspect(res.body);
+                return new AssertError('expected ' + a + ' response body, got ' + b, body, res.body, { cause: err });
+            }
+        }
+        else if (body !== res.text) {
+            // string
+            const a = inspect(body);
+            const b = inspect(res.text);
+            // regexp
+            if (isRegexp) {
+                if (!body.test(res.text)) {
+                    return new AssertError('expected body ' + b + ' to match ' + body, body, res.body);
+                }
+            }
+            else {
+                return new AssertError('expected ' + a + ' response body, got ' + b, body, res.body);
+            }
+        }
+    }
+    /**
+     * Perform assertions on a response header and return an Error upon failure.
+     */
+    _assertHeader(header, res) {
+        const field = header.name;
+        const actual = res.header[field.toLowerCase()];
+        const fieldExpected = header.value;
+        if (typeof actual === 'undefined') {
+            return new AssertError('expected "' + field + '" header field', header, actual);
+        }
+        // This check handles header values that may be a String or single element Array
+        if ((Array.isArray(actual) && actual.toString() === fieldExpected)
+            || fieldExpected === actual) {
+            return;
+        }
+        if (fieldExpected instanceof RegExp) {
+            if (!fieldExpected.test(actual)) {
+                return new AssertError('expected "' + field + '" matching '
+                    + fieldExpected + ', got "' + actual + '"', header, actual);
+            }
+        }
+        else {
+            return new AssertError('expected "' + field + '" of "' + fieldExpected + '", got "' + actual + '"', header, actual);
+        }
+    }
+    /**
+     * Perform assertions on the response status and return an Error upon failure.
+     */
+    _assertStatus(status, res) {
+        if (res.status !== status) {
+            const a = STATUS_CODES[status];
+            const b = STATUS_CODES[res.status];
+            return new AssertError('expected ' + status + ' "' + a + '", got ' + res.status + ' "' + b + '"', status, res.status);
+        }
+    }
+    /**
+     * Perform assertions on the response status and return an Error upon failure.
+     */
+    _assertStatusArray(statusArray, res) {
+        if (!statusArray.includes(res.status)) {
+            const b = STATUS_CODES[res.status];
+            const expectedList = statusArray.join(', ');
+            return new AssertError('expected one of "' + expectedList + '", got ' + res.status + ' "' + b + '"', statusArray, res.status);
+        }
+    }
+    /**
+     * Performs an assertion by calling a function and return an Error upon failure.
+     */
+    _assertFunction(fn, res) {
+        let err;
+        try {
+            err = fn(res);
+        }
+        catch (e) {
+            err = e;
+        }
+        if (err instanceof Error) {
+            return err;
+        }
+    }
+}
+/**
+ * Wraps an assert function into another.
+ * The wrapper function edit the stack trace of any assertion error, prepending a more useful stack to it.
+ *
+ * @param {Function} assertFn
+ * @return {Function} wrapped assert function
+ */
+function wrapAssertFn(assertFn) {
+    const savedStack = new Error().stack.split('\n').slice(3);
+    return (res) => {
+        let badStack;
+        let err;
+        try {
+            err = assertFn(res);
+        }
+        catch (e) {
+            err = e;
+        }
+        if (err instanceof Error && err.stack) {
+            badStack = err.stack.replace(err.message, '').split('\n').slice(1);
+            err.stack = [err.toString()]
+                .concat(savedStack)
+                .concat('----')
+                .concat(badStack)
+                .join('\n');
+        }
+        return err;
+    };
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,UAAU,CAAC;AAEjD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAiB,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAYrD,MAAM,OAAO,IAAK,SAAQ,OAAO;IAC/B,GAAG,CAAkB;IACrB,OAAO,CAAS;IAChB,QAAQ,GAAqB,EAAE,CAAC;IAEhC;;;OAGG;IACH,YAAY,GAAoB,EAAE,MAAc,EAAE,IAAY;QAC5D,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;QAElC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ;YAChC,CAAC,CAAC,GAAG,GAAG,IAAI;YACZ,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACO,aAAa,CAAC,GAAW,EAAE,IAAY;QAC/C,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;QACD,MAAM,IAAI,GAAI,GAAG,CAAC,OAAO,EAAkB,CAAC,IAAI,CAAC;QACjD,MAAM,QAAQ,GAAG,CAAC,GAAG,YAAY,WAAW,IAAI,IAAI,CAAC,OAAO,YAAY,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QACxG,OAAO,GAAG,QAAQ,gBAAgB,IAAI,GAAG,IAAI,EAAE,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,CAAqD,EAAE,CAA+C,EAAE,CAAoB;QACjI,WAAW;QACX,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC5B,cAAc;YACd,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAmB,CAAC,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC5B,2BAA2B;YAC3B,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,CAAC;QACD,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC5B,kDAAkD;YAClD,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,CAAC;QAED,SAAS;QACT,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC1B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACnE,OAAO;YACP,IAAI,OAAO,CAAC,KAAK,UAAU,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACpD,uBAAuB;gBACvB,qBAAqB;gBACrB,wBAAwB;gBACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACnE,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,oBAAoB;QACpB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,EAAE,CAAC;YAChF,sBAAsB;YACtB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACxE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,eAAe;QACf,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,YAAY,MAAM,EAAE,CAAC;YAC1E,8CAA8C;YAC9C,kCAAkC;YAClC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC/F,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;QACP,kBAAkB;QAClB,+CAA+C;QAC/C,iBAAiB;QACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,EAAoB;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAE5B,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACrB,MAAM,WAAW,GAAG,GAAG,EAAE;gBACvB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;YAC5B,CAAC,CAAC;YAEF,IAAI,MAAM,IAAI,SAAS,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpD,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACnC,CAAC;YAED,WAAW,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAA8B,EAAE,GAAa,EAAE,EAAoB;QACxE,IAAI,QAA2B,CAAC;QAEhC,6EAA6E;QAC7E,qEAAqE;QACrE,+DAA+D;QAC/D,iEAAiE;QACjE,MAAM,SAAS,GAA2B;YACxC,YAAY,EAAE,oBAAoB;YAClC,UAAU,EAAE,0BAA0B;YACtC,KAAK,EAAE,aAAa;YACpB,SAAS,EAAE,qBAAqB;SACjC,CAAC;QAEF,IAAI,CAAC,GAAG,IAAI,QAAQ,EAAE,CAAC;YACrB,IAAI,QAAQ,YAAY,KAAK;mBACxB,QAAQ,CAAC,OAAO,KAAK,SAAS;mBAC9B,QAAQ,CAAC,IAAI;mBACb,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,QAAQ,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;YACxE,CAAC;iBAAM,CAAC;gBACN,QAAQ,GAAG,QAAQ,CAAC;YACtB,CAAC;QACH,CAAC;QAED,UAAU;QACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACzD,CAAC;QAED,kEAAkE;QAClE,IAAI,CAAC,QAAQ,IAAI,QAAQ,YAAY,KAAK,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACvF,QAAQ,GAAG,QAAQ,CAAC;QACtB,CAAC;QAED,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,IAAI,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,IAA0D,EAAE,GAAa;QACnF,MAAM,QAAQ,GAAG,IAAI,YAAY,MAAM,CAAC;QAExC,SAAS;QACT,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,IAAI,CAAC;gBACH,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;gBACxB,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC5B,OAAO,IAAI,WAAW,CAAC,WAAW,GAAG,CAAC,GAAG,sBAAsB,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YACvG,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC;YAC7B,SAAS;YACT,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAE5B,SAAS;YACT,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzB,OAAO,IAAI,WAAW,CAAC,gBAAgB,GAAG,CAAC,GAAG,YAAY,GAAG,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACrF,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,IAAI,WAAW,CAAC,WAAW,GAAG,CAAC,GAAG,sBAAsB,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;YACvF,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,MAAoB,EAAE,GAAa;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;QAC1B,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/C,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,CAAC;QAEnC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,OAAO,IAAI,WAAW,CAAC,YAAY,GAAG,KAAK,GAAG,gBAAgB,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAClF,CAAC;QACD,gFAAgF;QAChF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,KAAK,aAAa,CAAC;eAC7D,aAAa,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO;QACT,CAAC;QACD,IAAI,aAAa,YAAY,MAAM,EAAE,CAAC;YACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChC,OAAO,IAAI,WAAW,CAAC,YAAY,GAAG,KAAK,GAAG,aAAa;sBACvD,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,WAAW,CAAC,YAAY,GAAG,KAAK,GAAG,QAAQ,GAAG,aAAa,GAAG,UAAU,GAAG,MAAM,GAAG,GAAG,EAChG,MAAM,EAAE,MAAM,CACf,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,MAAc,EAAE,GAAa;QACzC,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;YAC/B,MAAM,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACnC,OAAO,IAAI,WAAW,CAAC,WAAW,GAAG,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,SAAS,GAAG,GAAG,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,GAAG,EAC9F,MAAM,EAAE,GAAG,CAAC,MAAM,CACnB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,WAAqB,EAAE,GAAa;QACrD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACnC,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5C,OAAO,IAAI,WAAW,CACpB,mBAAmB,GAAG,YAAY,GAAG,SAAS,GAAG,GAAG,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,GAAG,EAC5E,WAAW,EAAE,GAAG,CAAC,MAAM,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,EAAkB,EAAE,GAAa;QAC/C,IAAI,GAAG,CAAC;QACR,IAAI,CAAC;YACH,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,GAAG,GAAG,CAAC,CAAC;QACV,CAAC;QACD,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;CACF;AAED;;;;;;GAMG;AAEH,SAAS,YAAY,CAAC,QAAwB;IAC5C,MAAM,UAAU,GAAG,IAAI,KAAK,EAAE,CAAC,KAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAE3D,OAAO,CAAC,GAAa,EAAE,EAAE;QACvB,IAAI,QAAQ,CAAC;QACb,IAAI,GAAG,CAAC;QACR,IAAI,CAAC;YACH,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,GAAG,GAAG,CAAC,CAAC;QACV,CAAC;QACD,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;YACtC,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACnE,GAAG,CAAC,KAAK,GAAG,CAAE,GAAG,CAAC,QAAQ,EAAE,CAAE;iBAC3B,MAAM,CAAC,UAAU,CAAC;iBAClB,MAAM,CAAC,MAAM,CAAC;iBACd,MAAM,CAAC,QAAQ,CAAC;iBAChB,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;AACJ,CAAC"}

package/dist/esm/types.d.ts

@@ -0,0 +1,10 @@
+import type { RequestListener } from 'node:http';
+import type { Http2ServerRequest, Http2ServerResponse } from 'node:http2';
+import type { Server } from 'node:net';
+import type { AgentOptions as SAgentOptions } from 'superagent';
+export type H2RequestListener = (request: Http2ServerRequest, response: Http2ServerResponse) => void;
+export type H1RequestListener = RequestListener;
+export type App = Server | H1RequestListener | H2RequestListener | string;
+export interface AgentOptions extends SAgentOptions {
+    http2?: boolean;
+}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@eggjs/supertest",
+  "version": "8.0.0"
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@eggjs/supertest",
+  "description": "SuperAgent driven library for testing HTTP servers",
+  "version": "8.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "TJ Holowaychuk",
+  "keywords": [
+    "bdd",
+    "http",
+    "request",
+    "superagent",
+    "tdd",
+    "test",
+    "testing"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eggjs/supertest.git"
+  },
+  "engines": {
+    "node": ">= 18.19.0"
+  },
+  "dependencies": {
+    "superagent": "^9.0.1"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.1",
+    "@eggjs/tsconfig": "1",
+    "@types/body-parser": "^1.19.5",
+    "@types/cookie-parser": "^1.4.8",
+    "@types/express": "^5.0.0",
+    "@types/mocha": "10",
+    "@types/node": "22",
+    "@types/superagent": "^8.1.9",
+    "body-parser": "^1.20.3",
+    "cookie-parser": "^1.4.6",
+    "egg-bin": "6",
+    "eslint": "8",
+    "eslint-config-egg": "14",
+    "express": "^4.18.2",
+    "nock": "^13.3.0",
+    "nyc": "^15.1.0",
+    "should": "^13.2.3",
+    "tshy": "3",
+    "tshy-after": "1",
+    "typescript": "5"
+  },
+  "scripts": {
+    "lint": "eslint --cache src test --ext .ts",
+    "pretest": "npm run lint -- --fix && npm run prepublishOnly",
+    "test": "egg-bin test",
+    "preci": "npm run lint && npm run prepublishOnly && attw --pack",
+    "ci": "egg-bin cov",
+    "prepublishOnly": "tshy && tshy-after"
+  },
+  "type": "module",
+  "tshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json"
+    }
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "types": "./dist/commonjs/index.d.ts",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/esm/index.js"
+}

package/src/agent.ts

@@ -0,0 +1,93 @@
+import http from 'node:http';
+import http2 from 'node:http2';
+import type { Server } from 'node:net';
+import { agent as Agent } from 'superagent';
+import { Test } from './test.js';
+import type { AgentOptions, H1RequestListener, H2RequestListener, App } from './types.js';
+
+/**
+ * Initialize a new `TestAgent`.
+ *
+ * @param {Function|Server} app
+ * @param {Object} options
+ */
+
+export class TestAgent extends Agent {
+  app: Server | string;
+  _host: string;
+  #http2 = false;
+
+  constructor(appOrListener: App, options: AgentOptions = {}) {
+    super(options);
+    if (typeof appOrListener === 'function') {
+      if (options.http2) {
+        this.#http2 = true;
+        this.app = http2.createServer(appOrListener as H2RequestListener); // eslint-disable-line no-param-reassign
+      } else {
+        this.app = http.createServer(appOrListener as H1RequestListener); // eslint-disable-line no-param-reassign
+      }
+    } else {
+      this.app = appOrListener;
+    }
+  }
+
+  // set a host name
+  host(host: string) {
+    this._host = host;
+    return this;
+  }
+
+  // TestAgent.prototype.del = TestAgent.prototype.delete;
+
+  protected _testRequest(method: string, url: string) {
+    const req = new Test(this.app, method.toUpperCase(), url);
+    if (this.#http2) {
+      req.http2();
+    }
+
+    if (this._host) {
+      req.set('host', this._host);
+    }
+
+    const that = this as any;
+    // access not internal methods
+    req.on('response', that._saveCookies.bind(this));
+    req.on('redirect', that._saveCookies.bind(this));
+    req.on('redirect', that._attachCookies.bind(this, req));
+    that._setDefaults(req);
+    that._attachCookies(req);
+
+    return req;
+  }
+  delete(url: string) {
+    return this._testRequest('delete', url);
+  }
+  del(url: string) {
+    return this._testRequest('delete', url);
+  }
+  get(url: string) {
+    return this._testRequest('get', url);
+  }
+  head(url: string) {
+    return this._testRequest('head', url);
+  }
+  put(url: string) {
+    return this._testRequest('put', url);
+  }
+  post(url: string) {
+    return this._testRequest('post', url);
+  }
+  patch(url: string) {
+    return this._testRequest('patch', url);
+  }
+  options(url: string) {
+    return this._testRequest('options', url);
+  }
+}
+
+// allow keep use by `agent()`
+export const proxyAgent = new Proxy(TestAgent, {
+  apply(target, _, argumentsList) {
+    return new target(argumentsList[0], argumentsList[1]);
+  },
+});

package/src/error/AssertError.ts

@@ -0,0 +1,12 @@
+export class AssertError extends Error {
+  expected: any;
+  actual: any;
+
+  constructor(message: string, expected: any, actual: any, options?: ErrorOptions) {
+    super(message, options);
+    this.name = this.constructor.name;
+    this.expected = expected;
+    this.actual = actual;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}

package/src/index.ts

@@ -0,0 +1,39 @@
+import { Request, RequestOptions } from './request.js';
+import { TestAgent, proxyAgent } from './agent.js';
+import type { App, AgentOptions } from './types.js';
+
+/**
+ * Test against the given `app`,
+ * returning a new `Test`.
+ */
+export function request(app: App, options: RequestOptions = {}) {
+  return new Request(app, options);
+}
+
+export {
+  Request, RequestOptions,
+  TestAgent,
+  // import { agent } from '@eggjs/supertest';
+  // agent()
+  proxyAgent as agent,
+};
+
+export * from './test.js';
+
+// import request from '@eggjs/supertest';
+// request()
+export default new Proxy(request, {
+  apply(target, _, argumentsList) {
+    return target(argumentsList[0], argumentsList[1]);
+  },
+  get(target, property, receiver) {
+    // import request from '@eggjs/supertest';
+    // request.agent()
+    if (property === 'agent') {
+      return proxyAgent;
+    }
+    return Reflect.get(target, property, receiver);
+  },
+}) as unknown as ((app: App, options?: RequestOptions) => Request) & {
+  agent: (app: App, options?: AgentOptions) => TestAgent;
+};