@mojojs/core 1.26.18 → 2.0.0

package/lib/user-agent/response.js

@@ -1,8 +1,21 @@
-import { Body } from '../body.js';
+import { Body } from "../body.js";
+import { parseEvent } from "../sse.js";
 /**
  * User-agent response class.
  */
 export class UserAgentResponse extends Body {
+    /**
+     * HTTP version.
+     */
+    httpVersion;
+    /**
+     * Response status code.
+     */
+    statusCode;
+    /**
+     * Response status message.
+     */
+    statusMessage;
     constructor(options) {
         super(options.headers, options.body);
         this.httpVersion = options.httpVersion;
@@ -43,6 +56,28 @@ export class UserAgentResponse extends Body {
         const { statusCode } = this;
         return statusCode >= 200 && statusCode <= 299;
     }
+    /**
+     * Get async iterator for Server-Sent Events from response body. Note that this method is EXPERIMENTAL and might
+     * change without warning!
+     * @example
+     * // Iterate over events
+     * for await (const {id, type, text} of res.sse()) {
+     *   console.log(`${type}: ${text}`);
+     * }
+     */
+    async *sse() {
+        const decoder = new TextDecoder();
+        let buffer = '';
+        for await (const chunk of this.createReadStream()) {
+            buffer += decoder.decode(chunk, { stream: true });
+            let [event, rest] = parseEvent(buffer);
+            while (event !== null) {
+                yield event;
+                [event, rest] = parseEvent(rest);
+            }
+            buffer = rest;
+        }
+    }
     /**
      * Get `Content-Type` header value.
      */
@@ -50,4 +85,3 @@ export class UserAgentResponse extends Body {
         return this.get('Content-Type');
     }
 }
-//# sourceMappingURL=response.js.map

package/lib/user-agent/test.d.ts

@@ -1,10 +1,10 @@
-import type { UserAgentResponse } from './response.js';
-import type { App } from '../app.js';
-import type { JSONValue, ServerOptions, TestContext, TestUserAgentOptions, UserAgentRequestOptions, UserAgentWebSocketOptions } from '../types.js';
-import type { WebSocket } from '../websocket.js';
+import type { UserAgentResponse } from './response.ts';
+import type { App } from '../app.ts';
+import type { JSONValue, SSEEvent, ServerOptions, TestContext, TestUserAgentOptions, UserAgentRequestOptions, UserAgentWebSocketOptions } from '../types.ts';
+import type { WebSocket } from '../websocket.ts';
 import type { URL } from 'node:url';
 import assert from 'node:assert/strict';
-import { MockUserAgent } from './mock.js';
+import { MockUserAgent } from './mock.ts';
 import DOM from '@mojojs/dom';
 import StackUtils from 'stack-utils';
 type SkipFunction = (...args: any[]) => any;
@@ -21,6 +21,8 @@ export declare class TestUserAgent extends MockUserAgent {
     _finished: [number, string] | null | undefined;
     _messages: AsyncIterableIterator<JSONValue> | undefined;
     _res: UserAgentResponse | undefined;
+    _sse: SSEEvent | undefined;
+    _sseEvents: AsyncIterator<SSEEvent> | undefined;
     _stack: StackUtils;
     _ws: WebSocket | undefined;
     constructor(options?: TestUserAgentOptions);
@@ -68,6 +70,11 @@ export declare class TestUserAgent extends MockUserAgent {
      * Perform a `GET` request and check for transport errors.
      */
     getOk(url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
+    /**
+     * Perform a `GET` request and check for transport errors, but leave the response body for Server-Sent Events. Note
+     * that this method is EXPERIMENTAL and might change without warning!
+     */
+    getSSEOk(url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
     /**
      * Perform a `HEAD` request and check for transport errors.
      */
@@ -121,10 +128,19 @@ export declare class TestUserAgent extends MockUserAgent {
      * Perform a `POST` request and check for transport errors.
      */
     postOk(url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
+    /**
+     * Perform a `POST` request and check for transport errors, but leave the response body for Server-Sent Events. Note
+     * that this method is EXPERIMENTAL and might change without warning!
+     */
+    postSSEOk(url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
     /**
      * Perform a `PUT` request and check for transport errors.
      */
     putOk(url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
+    /**
+     * Perform a `QUERY` request and check for transport errors.
+     */
+    queryOk(url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
     /**
      * Current HTTP response.
      */
@@ -133,6 +149,58 @@ export declare class TestUserAgent extends MockUserAgent {
      * Send message or frame via WebSocket.
      */
     sendOk(message: any): Promise<void>;
+    /**
+     * Current Server-Sent Event. Note that this property is EXPERIMENTAL and might change without warning!
+     */
+    get sse(): SSEEvent;
+    /**
+     * Close Server-Sent Events connection. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseFinishOk(): Promise<this>;
+    /**
+     * Wait for Server-Sent Events connection to be closed by the server. Note that this method is EXPERIMENTAL and might
+     * change without warning!
+     */
+    sseFinishedOk(): Promise<this>;
+    /**
+     * Check Server-Sent Event id for exact match. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseIdIs(id: string | null): this;
+    /**
+     * Opposite of `sseIdIs`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseIdIsnt(id: string | null): this;
+    /**
+     * Wait for next Server-Sent Event to arrive. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseOk(): Promise<this>;
+    /**
+     * Check Server-Sent Event text for exact match. Note that this method is EXPERIMENTAL and might change without
+     * warning!
+     */
+    sseTextIs(text: string): this;
+    /**
+     * Opposite of `sseTextIs`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseTextIsnt(text: string): this;
+    /**
+     * Check Server-Sent Event text for similar match. Note that this method is EXPERIMENTAL and might change without
+     * warning!
+     */
+    sseTextLike(regex: RegExp): this;
+    /**
+     * Opposite of `sseTextLike`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseTextUnlike(regex: RegExp): this;
+    /**
+     * Check Server-Sent Event type for exact match. Note that this method is EXPERIMENTAL and might change without
+     * warning!
+     */
+    sseTypeIs(type: string): this;
+    /**
+     * Opposite of `sseTypeIs`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseTypeIsnt(type: string): this;
     /**
      * Check response status for exact match.
      */
@@ -173,6 +241,8 @@ export declare class TestUserAgent extends MockUserAgent {
     get _html(): DOM;
     _prepareTap(tap: TestContext): void;
     _requestOk(skip: SkipFunction, method: string, url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
+    get _sseIterator(): AsyncIterator<SSEEvent>;
+    _sseOk(skip: SkipFunction, method: string, url: string | URL, options?: UserAgentRequestOptions): Promise<this>;
     _waitFinished(): Promise<void>;
 }
 export {};

package/lib/user-agent/test.js

@@ -1,6 +1,6 @@
 import assert from 'node:assert/strict';
 import { on } from 'node:events';
-import { MockUserAgent } from './mock.js';
+import { MockUserAgent } from "./mock.js";
 import DOM from '@mojojs/dom';
 import { jsonPointer } from '@mojojs/util';
 import * as yaml from 'js-yaml';
@@ -18,19 +18,21 @@ function addNodeAssertMethods(tapInstance) {
  * Test user-agent class.
  */
 export class TestUserAgent extends MockUserAgent {
+    /**
+     * Current HTTP response content.
+     */
+    body = Buffer.from('');
+    _assert = undefined;
+    _dom = undefined;
+    _finished = undefined;
+    _messages = undefined;
+    _res = undefined;
+    _sse = undefined;
+    _sseEvents = undefined;
+    _stack = new StackUtils();
+    _ws = undefined;
     constructor(options = {}) {
         super(options);
-        /**
-         * Current HTTP response content.
-         */
-        this.body = Buffer.from('');
-        this._assert = undefined;
-        this._dom = undefined;
-        this._finished = undefined;
-        this._messages = undefined;
-        this._res = undefined;
-        this._stack = new StackUtils();
-        this._ws = undefined;
         if (options.tap !== undefined)
             this._prepareTap(options.tap);
     }
@@ -113,6 +115,13 @@ export class TestUserAgent extends MockUserAgent {
     async getOk(url, options) {
         return await this._requestOk(this.getOk, 'GET', url, options);
     }
+    /**
+     * Perform a `GET` request and check for transport errors, but leave the response body for Server-Sent Events. Note
+     * that this method is EXPERIMENTAL and might change without warning!
+     */
+    async getSSEOk(url, options) {
+        return await this._sseOk(this.getSSEOk, 'GET', url, options);
+    }
     /**
      * Perform a `HEAD` request and check for transport errors.
      */
@@ -206,12 +215,25 @@ export class TestUserAgent extends MockUserAgent {
     async postOk(url, options) {
         return await this._requestOk(this.postOk, 'POST', url, options);
     }
+    /**
+     * Perform a `POST` request and check for transport errors, but leave the response body for Server-Sent Events. Note
+     * that this method is EXPERIMENTAL and might change without warning!
+     */
+    async postSSEOk(url, options) {
+        return await this._sseOk(this.postSSEOk, 'POST', url, options);
+    }
     /**
      * Perform a `PUT` request and check for transport errors.
      */
     async putOk(url, options) {
         return await this._requestOk(this.putOk, 'PUT', url, options);
     }
+    /**
+     * Perform a `QUERY` request and check for transport errors.
+     */
+    async queryOk(url, options) {
+        return await this._requestOk(this.queryOk, 'QUERY', url, options);
+    }
     /**
      * Current HTTP response.
      */
@@ -228,6 +250,105 @@ export class TestUserAgent extends MockUserAgent {
         await this.ws.send(message);
         this.assert('ok', [true], 'send message', this.sendOk);
     }
+    /**
+     * Current Server-Sent Event. Note that this property is EXPERIMENTAL and might change without warning!
+     */
+    get sse() {
+        const sse = this._sse;
+        if (sse === undefined)
+            throw new Error('No Server-Sent Event received');
+        return sse;
+    }
+    /**
+     * Close Server-Sent Events connection. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    async sseFinishOk() {
+        await this._sseIterator.return?.();
+        this._sseEvents = undefined;
+        this.assert('ok', [true], 'closed SSE connection', this.sseFinishOk);
+        return this;
+    }
+    /**
+     * Wait for Server-Sent Events connection to be closed by the server. Note that this method is EXPERIMENTAL and might
+     * change without warning!
+     */
+    async sseFinishedOk() {
+        const events = this._sseIterator;
+        while ((await events.next()).done !== true)
+            ;
+        this._sseEvents = undefined;
+        this.assert('ok', [true], 'SSE connection has been closed', this.sseFinishedOk);
+        return this;
+    }
+    /**
+     * Check Server-Sent Event id for exact match. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseIdIs(id) {
+        this.assert('strictEqual', [this.sse.id, id], 'exact match for SSE event id', this.sseIdIs);
+        return this;
+    }
+    /**
+     * Opposite of `sseIdIs`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseIdIsnt(id) {
+        this.assert('notStrictEqual', [this.sse.id, id], 'no match for SSE event id', this.sseIdIsnt);
+        return this;
+    }
+    /**
+     * Wait for next Server-Sent Event to arrive. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    async sseOk() {
+        const { done, value } = await this._sseIterator.next();
+        if (done !== true)
+            this._sse = value;
+        this.assert('ok', [done !== true], 'event received', this.sseOk);
+        return this;
+    }
+    /**
+     * Check Server-Sent Event text for exact match. Note that this method is EXPERIMENTAL and might change without
+     * warning!
+     */
+    sseTextIs(text) {
+        this.assert('strictEqual', [this.sse.text, text], 'exact match for SSE event text', this.sseTextIs);
+        return this;
+    }
+    /**
+     * Opposite of `sseTextIs`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseTextIsnt(text) {
+        this.assert('notStrictEqual', [this.sse.text, text], 'no match for SSE event text', this.sseTextIsnt);
+        return this;
+    }
+    /**
+     * Check Server-Sent Event text for similar match. Note that this method is EXPERIMENTAL and might change without
+     * warning!
+     */
+    sseTextLike(regex) {
+        this.assert('match', [this.sse.text, regex], 'similar match for SSE event text', this.sseTextLike);
+        return this;
+    }
+    /**
+     * Opposite of `sseTextLike`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseTextUnlike(regex) {
+        this.assert('doesNotMatch', [this.sse.text, regex], 'no similar match for SSE event text', this.sseTextUnlike);
+        return this;
+    }
+    /**
+     * Check Server-Sent Event type for exact match. Note that this method is EXPERIMENTAL and might change without
+     * warning!
+     */
+    sseTypeIs(type) {
+        this.assert('strictEqual', [this.sse.type, type], 'exact match for SSE event type', this.sseTypeIs);
+        return this;
+    }
+    /**
+     * Opposite of `sseTypeIs`. Note that this method is EXPERIMENTAL and might change without warning!
+     */
+    sseTypeIsnt(type) {
+        this.assert('notStrictEqual', [this.sse.type, type], 'no match for SSE event type', this.sseTypeIsnt);
+        return this;
+    }
     /**
      * Check response status for exact match.
      */
@@ -327,6 +448,20 @@ export class TestUserAgent extends MockUserAgent {
         this.assert('ok', [true], `${method.toUpperCase()} request for ${url.toString()}`, skip);
         return this;
     }
+    get _sseIterator() {
+        const events = this._sseEvents;
+        if (events === undefined)
+            throw new Error('No active SSE connection');
+        return events;
+    }
+    async _sseOk(skip, method, url, options) {
+        this._res = await this.request({ method, url, ...options });
+        this._dom = undefined;
+        this._sse = undefined;
+        this._sseEvents = this.res.sse();
+        this.assert('ok', [true], `${method.toUpperCase()} request for ${url.toString()}`, skip);
+        return this;
+    }
     async _waitFinished() {
         if (this._finished != null)
             return;
@@ -337,4 +472,3 @@ export class TestUserAgent extends MockUserAgent {
         });
     }
 }
-//# sourceMappingURL=test.js.map

package/lib/user-agent/transport/http.d.ts

@@ -1,7 +1,7 @@
-import type { UserAgentRequestOptions } from '../../types.js';
+import type { UserAgentRequestOptions } from '../../types.ts';
 import type { URL } from 'node:url';
 import http from 'node:http';
-import { UserAgentResponse } from '../response.js';
+import { UserAgentResponse } from '../response.ts';
 /**
  * HTTP transport class.
  */

package/lib/user-agent/transport/http.js

@@ -1,17 +1,15 @@
 import http from 'node:http';
 import Stream from 'node:stream';
-import { UserAgentResponse } from '../response.js';
+import { UserAgentResponse } from "../response.js";
 import { termEscape } from '@mojojs/util';
 /**
  * HTTP transport class.
  */
 export class HTTPTransport {
-    constructor() {
-        /**
-         * HTTP agent.
-         */
-        this.agent = new http.Agent();
-    }
+    /**
+     * HTTP agent.
+     */
+    agent = new http.Agent();
     /**
      * Destroy active keep-alive connections.
      */
@@ -40,9 +38,9 @@ export class HTTPTransport {
                     const stderr = process.stderr;
                     socket.on('data', (chunk) => stderr.write(termEscape(`-- Client <<< Server\n${chunk}`)));
                     const write = socket.write;
-                    socket.write = (chunk, cb) => {
+                    socket.write = (chunk, ...args) => {
                         stderr.write(termEscape(`-- Client >>> Server\n${chunk}`));
-                        return write.apply(socket, [chunk, cb]);
+                        return write.apply(socket, [chunk, ...args]);
                     };
                 });
             }
@@ -75,4 +73,3 @@ export class HTTPTransport {
         return http.request(url, options, cb);
     }
 }
-//# sourceMappingURL=http.js.map

package/lib/user-agent/transport/https.d.ts

@@ -1,8 +1,8 @@
-import type { UserAgentRequestOptions } from '../../types.js';
+import type { UserAgentRequestOptions } from '../../types.ts';
 import type http from 'node:http';
 import type { URL } from 'node:url';
 import https from 'node:https';
-import { HTTPTransport } from './http.js';
+import { HTTPTransport } from './http.ts';
 /**
  * HTTPS transport class.
  */

package/lib/user-agent/transport/https.js

@@ -1,13 +1,10 @@
 import https from 'node:https';
-import { HTTPTransport } from './http.js';
+import { HTTPTransport } from "./http.js";
 /**
  * HTTPS transport class.
  */
 export class HTTPSTransport extends HTTPTransport {
-    constructor() {
-        super(...arguments);
-        this.agent = new https.Agent();
-    }
+    agent = new https.Agent();
     _prepareOptions(config) {
         const options = super._prepareOptions(config);
         if (config.ca !== undefined)
@@ -22,4 +19,3 @@ export class HTTPSTransport extends HTTPTransport {
         return https.request(url, options, cb);
     }
 }
-//# sourceMappingURL=https.js.map

package/lib/user-agent/transport/ws.d.ts

@@ -1,5 +1,5 @@
-import type { UserAgentWebSocketOptions } from '../../types.js';
-import { WebSocket } from '../../websocket.js';
+import type { UserAgentWebSocketOptions } from '../../types.ts';
+import { WebSocket } from '../../websocket.ts';
 /**
  * WebSocket transport class.
  */

package/lib/user-agent/transport/ws.js

@@ -1,5 +1,5 @@
-import { WebSocket } from '../../websocket.js';
-import { UserAgentResponse } from '../response.js';
+import { WebSocket } from "../../websocket.js";
+import { UserAgentResponse } from "../response.js";
 import WS from 'ws';
 /**
  * WebSocket transport class.
@@ -37,4 +37,3 @@ export class WSTransport {
         });
     }
 }
-//# sourceMappingURL=ws.js.map

package/lib/user-agent.d.ts

@@ -1,17 +1,16 @@
-import type { UserAgentOptions, UserAgentRequestOptions, UserAgentWebSocketOptions } from './types.js';
-import type { UserAgentResponse } from './user-agent/response.js';
-import type { WebSocket } from './websocket.js';
+import type { UserAgentOptions, UserAgentRequestOptions, UserAgentWebSocketOptions } from './types.ts';
+import type { UserAgentResponse } from './user-agent/response.ts';
+import type { WebSocket } from './websocket.ts';
 import { URL } from 'node:url';
-import { CookieJar } from './user-agent/cookie-jar.js';
-import { HTTPTransport } from './user-agent/transport/http.js';
-import { HTTPSTransport } from './user-agent/transport/https.js';
-import { WSTransport } from './user-agent/transport/ws.js';
+import { CookieJar } from './user-agent/cookie-jar.ts';
+import { HTTPTransport } from './user-agent/transport/http.ts';
+import { HTTPSTransport } from './user-agent/transport/https.ts';
+import { WSTransport } from './user-agent/transport/ws.ts';
 import { AsyncHooks } from '@mojojs/util';
-import FormData from 'form-data';
 interface Upload {
     content: string;
     filename: string;
-    type: string;
+    type?: string;
 }
 type UserAgentHook = (ua: UserAgent, ...args: any[]) => any;
 /**
@@ -63,31 +62,35 @@ declare class UserAgent {
     /**
      * Perform `DELETE` request.
      */
-    delete(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    delete(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform `GET` request.
      */
-    get(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    get(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform `HEAD` request.
      */
-    head(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    head(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform `OPTIONS` request.
      */
-    options(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    options(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform `PATCH` request.
      */
-    patch(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    patch(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform `POST` request.
      */
-    post(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    post(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform `PUT` request.
      */
-    put(url: string | URL, options: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    put(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
+    /**
+     * Perform `QUERY` request.
+     */
+    query(url: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
     /**
      * Perform HTTP request.
      */
@@ -97,9 +100,9 @@ declare class UserAgent {
      */
     websocket(url: string | URL, options?: UserAgentWebSocketOptions): Promise<WebSocket>;
     _filterConfig(config: UserAgentRequestOptions): Promise<Record<string, any>>;
-    _filterSharedConfig(config: UserAgentRequestOptions | UserAgentWebSocketOptions): Promise<Record<string, any>>;
+    _filterSharedConfig(options: UserAgentRequestOptions | UserAgentWebSocketOptions): Promise<Record<string, any>>;
     _formData(values?: Record<string, string | Upload>): FormData;
-    _handleRedirect(config: Record<string, any>, res: UserAgentResponse): Promise<UserAgentResponse>;
+    _handleRedirect(config: Record<string, any>, base: URL, res: UserAgentResponse): Promise<UserAgentResponse>;
     _requestConfig(method: string, url?: string | URL, options?: UserAgentRequestOptions): Promise<UserAgentResponse>;
 }
 export { UserAgent };