@zero-server/sdk 0.9.1 → 0.9.3

package/types/router.d.ts

@@ -1,78 +1,78 @@
-import { Request } from './request';
-import { Response } from './response';
-import { MiddlewareFunction, NextFunction } from './middleware';
-
-export interface RouteOptions {
-    /** When `true`, route matches only HTTPS; when `false`, only HTTP. */
-    secure?: boolean;
-}
-
-export type RouteHandler = (req: Request, res: Response, next?: NextFunction) => void | Promise<void>;
-
-export interface RouteEntry {
-    method: string;
-    path: string;
-    regex: RegExp;
-    keys: string[];
-    handlers: RouteHandler[];
-    secure?: boolean;
-}
-
-export interface RouteInfo {
-    method: string;
-    path: string;
-    secure?: boolean;
-    maxPayload?: number;
-    pingInterval?: number;
-}
-
-export interface RouteChain {
-    get(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    post(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    put(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    delete(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    patch(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    options(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    head(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-    all(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
-}
-
-export interface RouterInstance {
-    /** Registered routes. */
-    routes: RouteEntry[];
-
-    /**
-     * Register a route.
-     */
-    add(method: string, path: string, handlers: RouteHandler[], options?: RouteOptions): void;
-
-    /**
-     * Mount a child router under a path prefix.
-     */
-    use(prefix: string, router: RouterInstance): void;
-
-    /**
-     * Match and handle request.
-     */
-    handle(req: Request, res: Response): void;
-
-    /**
-     * Chainable route builder.
-     */
-    route(path: string): RouteChain;
-
-    /**
-     * Return a flat list of all registered routes.
-     */
-    inspect(prefix?: string): RouteInfo[];
-
-    // HTTP method shortcuts
-    get(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    post(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    put(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    delete(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    patch(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    options(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    head(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-    all(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
-}
+import { Request } from './request';
+import { Response } from './response';
+import { MiddlewareFunction, NextFunction } from './middleware';
+
+export interface RouteOptions {
+    /** When `true`, route matches only HTTPS; when `false`, only HTTP. */
+    secure?: boolean;
+}
+
+export type RouteHandler = (req: Request, res: Response, next?: NextFunction) => void | Promise<void>;
+
+export interface RouteEntry {
+    method: string;
+    path: string;
+    regex: RegExp;
+    keys: string[];
+    handlers: RouteHandler[];
+    secure?: boolean;
+}
+
+export interface RouteInfo {
+    method: string;
+    path: string;
+    secure?: boolean;
+    maxPayload?: number;
+    pingInterval?: number;
+}
+
+export interface RouteChain {
+    get(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    post(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    put(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    delete(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    patch(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    options(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    head(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+    all(...handlers: (RouteOptions | RouteHandler)[]): RouteChain;
+}
+
+export interface RouterInstance {
+    /** Registered routes. */
+    routes: RouteEntry[];
+
+    /**
+     * Register a route.
+     */
+    add(method: string, path: string, handlers: RouteHandler[], options?: RouteOptions): void;
+
+    /**
+     * Mount a child router under a path prefix.
+     */
+    use(prefix: string, router: RouterInstance): void;
+
+    /**
+     * Match and handle request.
+     */
+    handle(req: Request, res: Response): void;
+
+    /**
+     * Chainable route builder.
+     */
+    route(path: string): RouteChain;
+
+    /**
+     * Return a flat list of all registered routes.
+     */
+    inspect(prefix?: string): RouteInfo[];
+
+    // HTTP method shortcuts
+    get(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    post(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    put(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    delete(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    patch(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    options(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    head(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+    all(path: string, ...handlers: (RouteOptions | RouteHandler)[]): RouterInstance;
+}

package/types/sse.d.ts

@@ -1,78 +1,78 @@
-export interface SSEOptions {
-    retry?: number;
-    headers?: Record<string, string>;
-    keepAlive?: number;
-    keepAliveComment?: string;
-    autoId?: boolean;
-    startId?: number;
-    pad?: number;
-    status?: number;
-}
-
-export interface SSEStream {
-    /** Whether the stream is still open. */
-    readonly connected: boolean;
-    /** The Last-Event-ID from client reconnection. */
-    lastEventId: string | null;
-    /** Total events sent. */
-    eventCount: number;
-    /** Total bytes written. */
-    bytesSent: number;
-    /** Timestamp when stream was opened. */
-    connectedAt: number;
-    /** Milliseconds since opened. */
-    readonly uptime: number;
-    /** Whether connection is over TLS. */
-    secure: boolean;
-    /** Arbitrary user-data store. */
-    data: Record<string, any>;
-
-    /**
-     * Send an unnamed data event.
-     */
-    send(data: string | object, id?: string | number): SSEStream;
-
-    /**
-     * Send a JSON event (alias for send).
-     */
-    sendJSON(obj: any, id?: string | number): SSEStream;
-
-    /**
-     * Send a named event.
-     */
-    event(eventName: string, data: string | object, id?: string | number): SSEStream;
-
-    /**
-     * Send a comment line.
-     */
-    comment(text: string): SSEStream;
-
-    /**
-     * Send or update the retry interval.
-     */
-    retry(ms: number): SSEStream;
-
-    /**
-     * Start/restart keep-alive timer.
-     */
-    keepAlive(intervalMs: number, comment?: string): SSEStream;
-
-    /**
-     * Flush buffered data.
-     */
-    flush(): SSEStream;
-
-    /**
-     * Close the SSE connection.
-     */
-    close(): void;
-
-    // Event emitter
-    on(event: 'close', fn: () => void): SSEStream;
-    on(event: 'error', fn: (err: Error) => void): SSEStream;
-    once(event: 'close', fn: () => void): SSEStream;
-    once(event: 'error', fn: (err: Error) => void): SSEStream;
-    off(event: string, fn: Function): SSEStream;
-    removeAllListeners(event?: string): SSEStream;
-    listenerCount(event: string): number;
-}
+export interface SSEOptions {
+    retry?: number;
+    headers?: Record<string, string>;
+    keepAlive?: number;
+    keepAliveComment?: string;
+    autoId?: boolean;
+    startId?: number;
+    pad?: number;
+    status?: number;
+}
+
+export interface SSEStream {
+    /** Whether the stream is still open. */
+    readonly connected: boolean;
+    /** The Last-Event-ID from client reconnection. */
+    lastEventId: string | null;
+    /** Total events sent. */
+    eventCount: number;
+    /** Total bytes written. */
+    bytesSent: number;
+    /** Timestamp when stream was opened. */
+    connectedAt: number;
+    /** Milliseconds since opened. */
+    readonly uptime: number;
+    /** Whether connection is over TLS. */
+    secure: boolean;
+    /** Arbitrary user-data store. */
+    data: Record<string, any>;
+
+    /**
+     * Send an unnamed data event.
+     */
+    send(data: string | object, id?: string | number): SSEStream;
+
+    /**
+     * Send a JSON event (alias for send).
+     */
+    sendJSON(obj: any, id?: string | number): SSEStream;
+
+    /**
+     * Send a named event.
+     */
+    event(eventName: string, data: string | object, id?: string | number): SSEStream;
+
+    /**
+     * Send a comment line.
+     */
+    comment(text: string): SSEStream;
+
+    /**
+     * Send or update the retry interval.
+     */
+    retry(ms: number): SSEStream;
+
+    /**
+     * Start/restart keep-alive timer.
+     */
+    keepAlive(intervalMs: number, comment?: string): SSEStream;
+
+    /**
+     * Flush buffered data.
+     */
+    flush(): SSEStream;
+
+    /**
+     * Close the SSE connection.
+     */
+    close(): void;
+
+    // Event emitter
+    on(event: 'close', fn: () => void): SSEStream;
+    on(event: 'error', fn: (err: Error) => void): SSEStream;
+    once(event: 'close', fn: () => void): SSEStream;
+    once(event: 'error', fn: (err: Error) => void): SSEStream;
+    off(event: string, fn: Function): SSEStream;
+    removeAllListeners(event?: string): SSEStream;
+    listenerCount(event: string): number;
+}

package/types/websocket.d.ts

@@ -1,126 +1,126 @@
-import { IncomingMessage, IncomingHttpHeaders } from 'http';
-
-export interface WebSocketOptions {
-    /** Maximum incoming frame size in bytes (default 1 MB). */
-    maxPayload?: number;
-    /** Auto-ping interval in ms. Set `0` to disable. */
-    pingInterval?: number;
-    /** Return false to reject the upgrade. */
-    verifyClient?: (req: IncomingMessage) => boolean;
-}
-
-export type WebSocketHandler = (ws: WebSocketConnection, req: IncomingMessage) => void;
-
-export declare const WebSocketReadyState: {
-    readonly CONNECTING: 0;
-    readonly OPEN: 1;
-    readonly CLOSING: 2;
-    readonly CLOSED: 3;
-};
-
-export interface WebSocketConnection {
-    /** Unique connection identifier. */
-    id: string;
-    /** Current ready state (0-3). */
-    readyState: number;
-    /** Negotiated sub-protocol. */
-    protocol: string;
-    /** Requested extensions. */
-    extensions: string;
-    /** Request headers from the upgrade. */
-    headers: IncomingHttpHeaders;
-    /** Remote IP address. */
-    ip: string | null;
-    /** Parsed query params from the upgrade URL. */
-    query: Record<string, string>;
-    /** Full upgrade URL. */
-    url: string;
-    /** Whether connection is over TLS. */
-    secure: boolean;
-    /** Maximum incoming payload bytes. */
-    maxPayload: number;
-    /** Timestamp when connected. */
-    connectedAt: number;
-    /** Arbitrary user-data store. */
-    data: Record<string, any>;
-    /** Bytes waiting in send buffer. */
-    readonly bufferedAmount: number;
-    /** Milliseconds since connected. */
-    readonly uptime: number;
-
-    /**
-     * Send a text or binary message.
-     */
-    send(data: string | Buffer, opts?: { binary?: boolean; callback?: Function }): boolean;
-
-    /**
-     * Send a JSON-serialised message.
-     */
-    sendJSON(obj: any, cb?: Function): boolean;
-
-    /**
-     * Send a ping frame.
-     */
-    ping(payload?: string | Buffer, cb?: Function): boolean;
-
-    /**
-     * Send a pong frame.
-     */
-    pong(payload?: string | Buffer, cb?: Function): boolean;
-
-    /**
-     * Close the connection.
-     */
-    close(code?: number, reason?: string): void;
-
-    /**
-     * Forcefully destroy the socket.
-     */
-    terminate(): void;
-
-    // Event emitter
-    on(event: 'message', fn: (data: string | Buffer) => void): WebSocketConnection;
-    on(event: 'close', fn: (code: number, reason: string) => void): WebSocketConnection;
-    on(event: 'error', fn: (err: Error) => void): WebSocketConnection;
-    on(event: 'pong', fn: (payload: Buffer) => void): WebSocketConnection;
-    on(event: 'ping', fn: (payload: Buffer) => void): WebSocketConnection;
-    on(event: 'drain', fn: () => void): WebSocketConnection;
-    once(event: string, fn: Function): WebSocketConnection;
-    off(event: string, fn: Function): WebSocketConnection;
-    removeAllListeners(event?: string): WebSocketConnection;
-    listenerCount(event: string): number;
-}
-
-export interface WebSocketPool {
-    /** Total active connections. */
-    readonly size: number;
-    /** All active room names. */
-    readonly rooms: string[];
-    /** All active connections. */
-    readonly clients: WebSocketConnection[];
-
-    /** Add a connection to the pool. */
-    add(ws: WebSocketConnection): WebSocketPool;
-    /** Remove a connection from the pool. */
-    remove(ws: WebSocketConnection): WebSocketPool;
-    /** Join a connection to a room. */
-    join(ws: WebSocketConnection, room: string): WebSocketPool;
-    /** Remove a connection from a room. */
-    leave(ws: WebSocketConnection, room: string): WebSocketPool;
-    /** Get all rooms a connection belongs to. */
-    roomsOf(ws: WebSocketConnection): string[];
-    /** Broadcast to ALL connections. */
-    broadcast(data: string | Buffer, exclude?: WebSocketConnection): void;
-    /** Broadcast JSON to ALL connections. */
-    broadcastJSON(obj: any, exclude?: WebSocketConnection): void;
-    /** Send to all connections in a room. */
-    toRoom(room: string, data: string | Buffer, exclude?: WebSocketConnection): void;
-    /** Send JSON to all connections in a room. */
-    toRoomJSON(room: string, obj: any, exclude?: WebSocketConnection): void;
-    /** Get all connections in a room. */
-    in(room: string): WebSocketConnection[];
-    /** Number of connections in a room. */
-    roomSize(room: string): number;
-    /** Close all connections. */
-    closeAll(code?: number, reason?: string): void;
-}
+import { IncomingMessage, IncomingHttpHeaders } from 'http';
+
+export interface WebSocketOptions {
+    /** Maximum incoming frame size in bytes (default 1 MB). */
+    maxPayload?: number;
+    /** Auto-ping interval in ms. Set `0` to disable. */
+    pingInterval?: number;
+    /** Return false to reject the upgrade. */
+    verifyClient?: (req: IncomingMessage) => boolean;
+}
+
+export type WebSocketHandler = (ws: WebSocketConnection, req: IncomingMessage) => void;
+
+export declare const WebSocketReadyState: {
+    readonly CONNECTING: 0;
+    readonly OPEN: 1;
+    readonly CLOSING: 2;
+    readonly CLOSED: 3;
+};
+
+export interface WebSocketConnection {
+    /** Unique connection identifier. */
+    id: string;
+    /** Current ready state (0-3). */
+    readyState: number;
+    /** Negotiated sub-protocol. */
+    protocol: string;
+    /** Requested extensions. */
+    extensions: string;
+    /** Request headers from the upgrade. */
+    headers: IncomingHttpHeaders;
+    /** Remote IP address. */
+    ip: string | null;
+    /** Parsed query params from the upgrade URL. */
+    query: Record<string, string>;
+    /** Full upgrade URL. */
+    url: string;
+    /** Whether connection is over TLS. */
+    secure: boolean;
+    /** Maximum incoming payload bytes. */
+    maxPayload: number;
+    /** Timestamp when connected. */
+    connectedAt: number;
+    /** Arbitrary user-data store. */
+    data: Record<string, any>;
+    /** Bytes waiting in send buffer. */
+    readonly bufferedAmount: number;
+    /** Milliseconds since connected. */
+    readonly uptime: number;
+
+    /**
+     * Send a text or binary message.
+     */
+    send(data: string | Buffer, opts?: { binary?: boolean; callback?: Function }): boolean;
+
+    /**
+     * Send a JSON-serialised message.
+     */
+    sendJSON(obj: any, cb?: Function): boolean;
+
+    /**
+     * Send a ping frame.
+     */
+    ping(payload?: string | Buffer, cb?: Function): boolean;
+
+    /**
+     * Send a pong frame.
+     */
+    pong(payload?: string | Buffer, cb?: Function): boolean;
+
+    /**
+     * Close the connection.
+     */
+    close(code?: number, reason?: string): void;
+
+    /**
+     * Forcefully destroy the socket.
+     */
+    terminate(): void;
+
+    // Event emitter
+    on(event: 'message', fn: (data: string | Buffer) => void): WebSocketConnection;
+    on(event: 'close', fn: (code: number, reason: string) => void): WebSocketConnection;
+    on(event: 'error', fn: (err: Error) => void): WebSocketConnection;
+    on(event: 'pong', fn: (payload: Buffer) => void): WebSocketConnection;
+    on(event: 'ping', fn: (payload: Buffer) => void): WebSocketConnection;
+    on(event: 'drain', fn: () => void): WebSocketConnection;
+    once(event: string, fn: Function): WebSocketConnection;
+    off(event: string, fn: Function): WebSocketConnection;
+    removeAllListeners(event?: string): WebSocketConnection;
+    listenerCount(event: string): number;
+}
+
+export interface WebSocketPool {
+    /** Total active connections. */
+    readonly size: number;
+    /** All active room names. */
+    readonly rooms: string[];
+    /** All active connections. */
+    readonly clients: WebSocketConnection[];
+
+    /** Add a connection to the pool. */
+    add(ws: WebSocketConnection): WebSocketPool;
+    /** Remove a connection from the pool. */
+    remove(ws: WebSocketConnection): WebSocketPool;
+    /** Join a connection to a room. */
+    join(ws: WebSocketConnection, room: string): WebSocketPool;
+    /** Remove a connection from a room. */
+    leave(ws: WebSocketConnection, room: string): WebSocketPool;
+    /** Get all rooms a connection belongs to. */
+    roomsOf(ws: WebSocketConnection): string[];
+    /** Broadcast to ALL connections. */
+    broadcast(data: string | Buffer, exclude?: WebSocketConnection): void;
+    /** Broadcast JSON to ALL connections. */
+    broadcastJSON(obj: any, exclude?: WebSocketConnection): void;
+    /** Send to all connections in a room. */
+    toRoom(room: string, data: string | Buffer, exclude?: WebSocketConnection): void;
+    /** Send JSON to all connections in a room. */
+    toRoomJSON(room: string, obj: any, exclude?: WebSocketConnection): void;
+    /** Get all connections in a room. */
+    in(room: string): WebSocketConnection[];
+    /** Number of connections in a room. */
+    roomSize(room: string): number;
+    /** Close all connections. */
+    closeAll(code?: number, reason?: string): void;
+}