@zero-server/sdk 0.9.1 → 0.9.3

package/types/request.d.ts

@@ -1,109 +1,109 @@
-import { IncomingMessage, IncomingHttpHeaders } from 'http';
-import { App } from './app';
-
-export interface RangeResult {
-    type: string;
-    ranges: Array<{ start: number; end: number }>;
-}
-
-export interface Request {
-    /** Original Node request. */
-    raw: IncomingMessage;
-    /** HTTP method (e.g. 'GET'). */
-    method: string;
-    /** Full request URL including query string. */
-    url: string;
-    /** URL path without query string. */
-    path: string;
-    /** Lower-cased request headers. */
-    headers: IncomingHttpHeaders;
-    /** Parsed query-string key/value pairs. */
-    query: Record<string, string>;
-    /** Route parameters populated by the router. */
-    params: Record<string, string>;
-    /** Request body (set by body-parsing middleware). */
-    body: any;
-    /** Raw request body as a Buffer (set by body-parsing middleware before parsing). */
-    rawBody?: Buffer;
-    /** Remote IP address (trust-proxy-aware). */
-    readonly ip: string | null;
-    /** Proxy chain addresses from X-Forwarded-For when trust proxy is enabled. */
-    readonly ips: string[];
-    /** `true` when the connection is over TLS (trust-proxy-aware). */
-    readonly secure: boolean;
-    /** Protocol string — `'https'` or `'http'` (trust-proxy-aware). */
-    readonly protocol: 'http' | 'https';
-    /** HTTP version string (e.g. '1.1', '2.0'). */
-    httpVersion: string;
-    /** Whether this request arrived over HTTP/2. */
-    isHTTP2: boolean;
-    /** ALPN protocol negotiated on the TLS socket (e.g. 'h2'), or null. */
-    alpnProtocol: string | null;
-    /** Parsed cookies (populated by cookieParser middleware). */
-    cookies: Record<string, string>;
-    /** Verified signed cookies (populated by cookieParser middleware). */
-    signedCookies?: Record<string, string>;
-    /** Request-scoped locals store. */
-    locals: Record<string, any>;
-    /** Request ID (populated by requestId middleware). */
-    id?: string;
-    /** Whether the request timed out (populated by timeout middleware). */
-    timedOut?: boolean;
-    /** The original URL as received — never rewritten by middleware. */
-    originalUrl: string;
-    /** The URL path on which the current router was mounted. */
-    baseUrl: string;
-    /** Reference to the parent App instance. */
-    app: App | null;
-    /** CSRF token (populated by csrf middleware). */
-    csrfToken?: string;
-    /** First signing secret (populated by cookieParser middleware). */
-    secret?: string;
-    /** All signing secrets (populated by cookieParser middleware). */
-    secrets?: string[];
-
-    /**
-     * Get a specific request header (case-insensitive).
-     */
-    get(name: string): string | undefined;
-
-    /**
-     * Check if the request Content-Type matches the given type.
-     */
-    is(type: string): boolean;
-
-    /**
-     * Get the hostname from the Host header.
-     */
-    readonly hostname: string;
-
-    /**
-     * Get the subdomains as an array.
-     */
-    subdomains(offset?: number): string[];
-
-    /**
-     * Content negotiation — check which types the client accepts.
-     */
-    accepts(...types: string[]): string | false;
-
-    /**
-     * Check if the request is "fresh" (client cache valid).
-     */
-    readonly fresh: boolean;
-
-    /**
-     * Inverse of `fresh`.
-     */
-    readonly stale: boolean;
-
-    /**
-     * Check whether this request was made with XMLHttpRequest.
-     */
-    readonly xhr: boolean;
-
-    /**
-     * Parse the Range header.
-     */
-    range(size: number): RangeResult | -1 | -2;
-}
+import { IncomingMessage, IncomingHttpHeaders } from 'http';
+import { App } from './app';
+
+export interface RangeResult {
+    type: string;
+    ranges: Array<{ start: number; end: number }>;
+}
+
+export interface Request {
+    /** Original Node request. */
+    raw: IncomingMessage;
+    /** HTTP method (e.g. 'GET'). */
+    method: string;
+    /** Full request URL including query string. */
+    url: string;
+    /** URL path without query string. */
+    path: string;
+    /** Lower-cased request headers. */
+    headers: IncomingHttpHeaders;
+    /** Parsed query-string key/value pairs. */
+    query: Record<string, string>;
+    /** Route parameters populated by the router. */
+    params: Record<string, string>;
+    /** Request body (set by body-parsing middleware). */
+    body: any;
+    /** Raw request body as a Buffer (set by body-parsing middleware before parsing). */
+    rawBody?: Buffer;
+    /** Remote IP address (trust-proxy-aware). */
+    readonly ip: string | null;
+    /** Proxy chain addresses from X-Forwarded-For when trust proxy is enabled. */
+    readonly ips: string[];
+    /** `true` when the connection is over TLS (trust-proxy-aware). */
+    readonly secure: boolean;
+    /** Protocol string — `'https'` or `'http'` (trust-proxy-aware). */
+    readonly protocol: 'http' | 'https';
+    /** HTTP version string (e.g. '1.1', '2.0'). */
+    httpVersion: string;
+    /** Whether this request arrived over HTTP/2. */
+    isHTTP2: boolean;
+    /** ALPN protocol negotiated on the TLS socket (e.g. 'h2'), or null. */
+    alpnProtocol: string | null;
+    /** Parsed cookies (populated by cookieParser middleware). */
+    cookies: Record<string, string>;
+    /** Verified signed cookies (populated by cookieParser middleware). */
+    signedCookies?: Record<string, string>;
+    /** Request-scoped locals store. */
+    locals: Record<string, any>;
+    /** Request ID (populated by requestId middleware). */
+    id?: string;
+    /** Whether the request timed out (populated by timeout middleware). */
+    timedOut?: boolean;
+    /** The original URL as received — never rewritten by middleware. */
+    originalUrl: string;
+    /** The URL path on which the current router was mounted. */
+    baseUrl: string;
+    /** Reference to the parent App instance. */
+    app: App | null;
+    /** CSRF token (populated by csrf middleware). */
+    csrfToken?: string;
+    /** First signing secret (populated by cookieParser middleware). */
+    secret?: string;
+    /** All signing secrets (populated by cookieParser middleware). */
+    secrets?: string[];
+
+    /**
+     * Get a specific request header (case-insensitive).
+     */
+    get(name: string): string | undefined;
+
+    /**
+     * Check if the request Content-Type matches the given type.
+     */
+    is(type: string): boolean;
+
+    /**
+     * Get the hostname from the Host header.
+     */
+    readonly hostname: string;
+
+    /**
+     * Get the subdomains as an array.
+     */
+    subdomains(offset?: number): string[];
+
+    /**
+     * Content negotiation — check which types the client accepts.
+     */
+    accepts(...types: string[]): string | false;
+
+    /**
+     * Check if the request is "fresh" (client cache valid).
+     */
+    readonly fresh: boolean;
+
+    /**
+     * Inverse of `fresh`.
+     */
+    readonly stale: boolean;
+
+    /**
+     * Check whether this request was made with XMLHttpRequest.
+     */
+    readonly xhr: boolean;
+
+    /**
+     * Parse the Range header.
+     */
+    range(size: number): RangeResult | -1 | -2;
+}

package/types/response.d.ts

@@ -1,157 +1,157 @@
-import { ServerResponse } from 'http';
-import { App } from './app';
-import { SSEStream, SSEOptions } from './sse';
-
-export interface SendFileOptions {
-    headers?: Record<string, string>;
-    root?: string;
-}
-
-export interface CookieOptions {
-    domain?: string;
-    path?: string;
-    expires?: Date | number;
-    maxAge?: number;
-    httpOnly?: boolean;
-    secure?: boolean;
-    sameSite?: 'Strict' | 'Lax' | 'None';
-    /** Auto-sign the cookie value using req.secret. */
-    signed?: boolean;
-    /** Cookie priority: 'Low', 'Medium', or 'High'. */
-    priority?: 'Low' | 'Medium' | 'High';
-    /** Partitioned attribute (CHIPS). Requires secure: true. */
-    partitioned?: boolean;
-}
-
-export interface PushOptions {
-    /** Absolute path to a file to stream as the push body. */
-    filePath?: string;
-    /** Additional headers to include in the push promise. */
-    headers?: Record<string, string>;
-}
-
-export interface Response {
-    /** Original Node response. */
-    raw: ServerResponse;
-    /** Request-scoped locals store. */
-    locals: Record<string, any>;
-    /** Reference to the parent App instance. */
-    app: App | null;
-    /** Whether this response supports HTTP/2 server push. */
-    readonly supportsPush: boolean;
-
-    /**
-     * Set HTTP status code. Chainable.
-     */
-    status(code: number): Response;
-
-    /**
-     * Set a response header. Chainable.
-     */
-    set(name: string, value: string): Response;
-
-    /**
-     * Get a previously-set response header.
-     */
-    get(name: string): string | undefined;
-
-    /**
-     * Append a value to a header.
-     */
-    append(name: string, value: string): Response;
-
-    /**
-     * Add a field to the Vary response header.
-     */
-    vary(field: string): Response;
-
-    /**
-     * Set the Content-Type header. Chainable.
-     */
-    type(ct: string): Response;
-
-    /**
-     * Whether headers have been sent.
-     */
-    readonly headersSent: boolean;
-
-    /**
-     * Send a response body and finalize.
-     */
-    send(body?: string | Buffer | object | null): void;
-
-    /**
-     * Send a JSON response.
-     */
-    json(obj: any): void;
-
-    /**
-     * Send a plain-text response.
-     */
-    text(str: string): void;
-
-    /**
-     * Send an HTML response.
-     */
-    html(str: string): void;
-
-    /**
-     * Send only the status code with reason phrase.
-     */
-    sendStatus(code: number): void;
-
-    /**
-     * Send a file as the response.
-     */
-    sendFile(filePath: string, opts?: SendFileOptions, cb?: (err: Error | null) => void): void;
-    sendFile(filePath: string, cb?: (err: Error | null) => void): void;
-
-    /**
-     * Prompt a file download.
-     */
-    download(filePath: string, filename?: string, cb?: (err: Error | null) => void): void;
-    download(filePath: string, cb?: (err: Error | null) => void): void;
-
-    /**
-     * Set a cookie. Objects are auto-serialized as JSON cookies (j: prefix).
-     */
-    cookie(name: string, value: string | object, opts?: CookieOptions): Response;
-
-    /**
-     * Clear a cookie.
-     */
-    clearCookie(name: string, opts?: CookieOptions): Response;
-
-    /**
-     * Redirect to a URL.
-     */
-    redirect(url: string): void;
-    redirect(status: number, url: string): void;
-
-    /**
-     * Open a Server-Sent Events stream.
-     */
-    sse(opts?: SSEOptions): SSEStream;
-
-    /**
-     * Content-negotiated response based on Accept header.
-     * Keys are MIME types, values are handler functions.
-     */
-    format(types: Record<string, () => void> & { default?: () => void }): void;
-
-    /**
-     * Set the Link header from a map of rel → URL.
-     */
-    links(links: Record<string, string>): Response;
-
-    /**
-     * Set the Location response header.
-     */
-    location(url: string): Response;
-
-    /**
-     * Initiate an HTTP/2 server push.
-     * Returns null if the connection is not HTTP/2 or the stream is closed.
-     */
-    push(path: string, opts?: PushOptions): any;
-}
+import { ServerResponse } from 'http';
+import { App } from './app';
+import { SSEStream, SSEOptions } from './sse';
+
+export interface SendFileOptions {
+    headers?: Record<string, string>;
+    root?: string;
+}
+
+export interface CookieOptions {
+    domain?: string;
+    path?: string;
+    expires?: Date | number;
+    maxAge?: number;
+    httpOnly?: boolean;
+    secure?: boolean;
+    sameSite?: 'Strict' | 'Lax' | 'None';
+    /** Auto-sign the cookie value using req.secret. */
+    signed?: boolean;
+    /** Cookie priority: 'Low', 'Medium', or 'High'. */
+    priority?: 'Low' | 'Medium' | 'High';
+    /** Partitioned attribute (CHIPS). Requires secure: true. */
+    partitioned?: boolean;
+}
+
+export interface PushOptions {
+    /** Absolute path to a file to stream as the push body. */
+    filePath?: string;
+    /** Additional headers to include in the push promise. */
+    headers?: Record<string, string>;
+}
+
+export interface Response {
+    /** Original Node response. */
+    raw: ServerResponse;
+    /** Request-scoped locals store. */
+    locals: Record<string, any>;
+    /** Reference to the parent App instance. */
+    app: App | null;
+    /** Whether this response supports HTTP/2 server push. */
+    readonly supportsPush: boolean;
+
+    /**
+     * Set HTTP status code. Chainable.
+     */
+    status(code: number): Response;
+
+    /**
+     * Set a response header. Chainable.
+     */
+    set(name: string, value: string): Response;
+
+    /**
+     * Get a previously-set response header.
+     */
+    get(name: string): string | undefined;
+
+    /**
+     * Append a value to a header.
+     */
+    append(name: string, value: string): Response;
+
+    /**
+     * Add a field to the Vary response header.
+     */
+    vary(field: string): Response;
+
+    /**
+     * Set the Content-Type header. Chainable.
+     */
+    type(ct: string): Response;
+
+    /**
+     * Whether headers have been sent.
+     */
+    readonly headersSent: boolean;
+
+    /**
+     * Send a response body and finalize.
+     */
+    send(body?: string | Buffer | object | null): void;
+
+    /**
+     * Send a JSON response.
+     */
+    json(obj: any): void;
+
+    /**
+     * Send a plain-text response.
+     */
+    text(str: string): void;
+
+    /**
+     * Send an HTML response.
+     */
+    html(str: string): void;
+
+    /**
+     * Send only the status code with reason phrase.
+     */
+    sendStatus(code: number): void;
+
+    /**
+     * Send a file as the response.
+     */
+    sendFile(filePath: string, opts?: SendFileOptions, cb?: (err: Error | null) => void): void;
+    sendFile(filePath: string, cb?: (err: Error | null) => void): void;
+
+    /**
+     * Prompt a file download.
+     */
+    download(filePath: string, filename?: string, cb?: (err: Error | null) => void): void;
+    download(filePath: string, cb?: (err: Error | null) => void): void;
+
+    /**
+     * Set a cookie. Objects are auto-serialized as JSON cookies (j: prefix).
+     */
+    cookie(name: string, value: string | object, opts?: CookieOptions): Response;
+
+    /**
+     * Clear a cookie.
+     */
+    clearCookie(name: string, opts?: CookieOptions): Response;
+
+    /**
+     * Redirect to a URL.
+     */
+    redirect(url: string): void;
+    redirect(status: number, url: string): void;
+
+    /**
+     * Open a Server-Sent Events stream.
+     */
+    sse(opts?: SSEOptions): SSEStream;
+
+    /**
+     * Content-negotiated response based on Accept header.
+     * Keys are MIME types, values are handler functions.
+     */
+    format(types: Record<string, () => void> & { default?: () => void }): void;
+
+    /**
+     * Set the Link header from a map of rel → URL.
+     */
+    links(links: Record<string, string>): Response;
+
+    /**
+     * Set the Location response header.
+     */
+    location(url: string): Response;
+
+    /**
+     * Initiate an HTTP/2 server push.
+     * Returns null if the connection is not HTTP/2 or the stream is closed.
+     */
+    push(path: string, opts?: PushOptions): any;
+}