@kevisual/router 0.0.39 → 0.0.41

package/dist/router-simple.d.ts

@@ -1,4 +1,4 @@
-import * as querystring from 'querystring';
+import * as node_querystring from 'node:querystring';
 import { Key } from 'path-to-regexp';
 import { IncomingMessage, ServerResponse, Server } from 'node:http';
 import { ListenOptions } from 'node:net';
@@ -25,7 +25,7 @@ declare class SimpleRouter {
         exclude?: string[];
     });
     getBody(req: Req): Promise<Record<string, any>>;
-    getSearch(req: Req): querystring.ParsedUrlQuery;
+    getSearch(req: Req): node_querystring.ParsedUrlQuery;
     parseSearchValue: (value?: string, opts?: {
         decode?: boolean;
     }) => any;

package/dist/router.d.ts

@@ -1,7 +1,6 @@
 import http, { IncomingMessage, ServerResponse } from 'node:http';
 import https from 'node:https';
 import http2 from 'node:http2';
-import * as cookie from 'cookie';
 import { z } from 'zod';
 import { WebSocketServer, WebSocket } from 'ws';
 import { IncomingMessage as IncomingMessage$1, ServerResponse as ServerResponse$1 } from 'http';
@@ -86,16 +85,14 @@ type RouteMiddleware = {
     key?: string;
     id?: string;
 } | string;
-type RouteOpts<T = {}> = {
+type RouteOpts<U = {}, T = SimpleObject$1> = {
     path?: string;
     key?: string;
     id?: string;
-    run?: Run<T>;
+    run?: Run<U>;
     nextRoute?: NextRoute;
     description?: string;
-    metadata?: {
-        [key: string]: any;
-    };
+    metadata?: T;
     middleware?: RouteMiddleware[];
     type?: 'route' | 'middleware';
     /**
@@ -113,7 +110,7 @@ declare const pickValue: readonly ["path", "key", "id", "description", "type", "
 type RouteInfo = Pick<Route, (typeof pickValue)[number]>;
 declare class Route<U = {
     [key: string]: any;
-}> {
+}, T extends SimpleObject$1 = SimpleObject$1> {
     /**
      * 一级路径
      */
@@ -126,9 +123,7 @@ declare class Route<U = {
     run?: Run;
     nextRoute?: NextRoute;
     description?: string;
-    metadata?: {
-        [key: string]: any;
-    };
+    metadata?: T;
     middleware?: RouteMiddleware[];
     type?: string;
     data?: any;
@@ -256,7 +251,7 @@ declare class QueryRouter {
      * @param ctx
      */
     setContext(ctx: RouteContext): void;
-    getList(): RouteInfo[];
+    getList(filter?: (route: Route) => boolean): RouteInfo[];
     /**
      * 获取handle函数, 这里会去执行parse函数
      */
@@ -281,13 +276,13 @@ declare class QueryRouter {
     }>;
     exportRoutes(): Route<{
         [key: string]: any;
-    }>[];
+    }, SimpleObject$1>[];
     importRoutes(routes: Route[]): void;
     importRouter(router: QueryRouter): void;
     throw(code?: number | string, message?: string, tips?: string): void;
     hasRoute(path: string, key?: string): Route<{
         [key: string]: any;
-    }>;
+    }, SimpleObject$1>;
     createRouteList(force?: boolean): void;
     /**
      * 等待程序运行, 获取到message的数据,就执行
@@ -387,8 +382,103 @@ declare class QueryConnect {
     }[];
 }
 
+interface StringifyOptions {
+    /**
+     * Specifies a function that will be used to encode a [cookie-value](https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.1).
+     * Since value of a cookie has a limited character set (and must be a simple string), this function can be used to encode
+     * a value into a string suited for a cookie's value, and should mirror `decode` when parsing.
+     *
+     * @default encodeURIComponent
+     */
+    encode?: (str: string) => string;
+}
+/**
+ * Set-Cookie object.
+ */
+interface SetCookie {
+    /**
+     * Specifies the name of the cookie.
+     */
+    name: string;
+    /**
+     * Specifies the string to be the value for the cookie.
+     */
+    value: string | undefined;
+    /**
+     * Specifies the `number` (in seconds) to be the value for the [`Max-Age` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.2).
+     *
+     * The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and
+     * `maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients by obey this,
+     * so if both are set, they should point to the same date and time.
+     */
+    maxAge?: number;
+    /**
+     * Specifies the `Date` object to be the value for the [`Expires` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.1).
+     * When no expiration is set, clients consider this a "non-persistent cookie" and delete it when the current session is over.
+     *
+     * The [cookie storage model specification](https://tools.ietf.org/html/rfc6265#section-5.3) states that if both `expires` and
+     * `maxAge` are set, then `maxAge` takes precedence, but it is possible not all clients by obey this,
+     * so if both are set, they should point to the same date and time.
+     */
+    expires?: Date;
+    /**
+     * Specifies the value for the [`Domain` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.3).
+     * When no domain is set, clients consider the cookie to apply to the current domain only.
+     */
+    domain?: string;
+    /**
+     * Specifies the value for the [`Path` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.4).
+     * When no path is set, the path is considered the ["default path"](https://tools.ietf.org/html/rfc6265#section-5.1.4).
+     */
+    path?: string;
+    /**
+     * Enables the [`HttpOnly` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.6).
+     * When enabled, clients will not allow client-side JavaScript to see the cookie in `document.cookie`.
+     */
+    httpOnly?: boolean;
+    /**
+     * Enables the [`Secure` `Set-Cookie` attribute](https://tools.ietf.org/html/rfc6265#section-5.2.5).
+     * When enabled, clients will only send the cookie back if the browser has an HTTPS connection.
+     */
+    secure?: boolean;
+    /**
+     * Enables the [`Partitioned` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-cutler-httpbis-partitioned-cookies/).
+     * When enabled, clients will only send the cookie back when the current domain _and_ top-level domain matches.
+     *
+     * This is an attribute that has not yet been fully standardized, and may change in the future.
+     * This also means clients may ignore this attribute until they understand it. More information
+     * about can be found in [the proposal](https://github.com/privacycg/CHIPS).
+     */
+    partitioned?: boolean;
+    /**
+     * Specifies the value for the [`Priority` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1).
+     *
+     * - `'low'` will set the `Priority` attribute to `Low`.
+     * - `'medium'` will set the `Priority` attribute to `Medium`, the default priority when not set.
+     * - `'high'` will set the `Priority` attribute to `High`.
+     *
+     * More information about priority levels can be found in [the specification](https://tools.ietf.org/html/draft-west-cookie-priority-00#section-4.1).
+     */
+    priority?: "low" | "medium" | "high";
+    /**
+     * Specifies the value for the [`SameSite` `Set-Cookie` attribute](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-09#section-5.4.7).
+     *
+     * - `true` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
+     * - `'lax'` will set the `SameSite` attribute to `Lax` for lax same site enforcement.
+     * - `'none'` will set the `SameSite` attribute to `None` for an explicit cross-site cookie.
+     * - `'strict'` will set the `SameSite` attribute to `Strict` for strict same site enforcement.
+     *
+     * More information about enforcement levels can be found in [the specification](https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-09#section-5.4.7).
+     */
+    sameSite?: boolean | "lax" | "strict" | "none";
+}
+/**
+ * Backward compatibility serialize options.
+ */
+type SerializeOptions = StringifyOptions & Omit<SetCookie, "name" | "value">;
+
 type Listener = (...args: any[]) => void;
-type CookieFn = (name: string, value: string, options?: cookie.SerializeOptions, end?: boolean) => void;
+type CookieFn = (name: string, value: string, options?: SerializeOptions, end?: boolean) => void;
 type HandleCtx = {
     req: IncomingMessage & {
         cookies: Record<string, string>;
@@ -441,7 +531,7 @@ declare class Server {
     listen(path: string, listeningListener?: () => void): void;
     listen(handle: any, backlog?: number, listeningListener?: () => void): void;
     listen(handle: any, listeningListener?: () => void): void;
-    createServer(): http.Server<typeof IncomingMessage, typeof ServerResponse> | https.Server<typeof IncomingMessage, typeof ServerResponse> | http2.Http2SecureServer<typeof IncomingMessage, typeof ServerResponse, typeof http2.Http2ServerRequest, typeof http2.Http2ServerResponse>;
+    createServer(): http.Server<typeof IncomingMessage, typeof ServerResponse> | http2.Http2SecureServer<typeof IncomingMessage, typeof ServerResponse, typeof http2.Http2ServerRequest, typeof http2.Http2ServerResponse>;
     setHandle(handle?: any): void;
     /**
      * get callback
@@ -495,7 +585,7 @@ declare class CustomError extends Error {
      * @param err
      * @returns
      */
-    static isError(err: any): boolean;
+    static isError(error: unknown): error is CustomError;
     parse(e?: CustomError): {
         code: number;
         data: any;
@@ -724,7 +814,7 @@ declare class App<U = {}> {
     }>;
     exportRoutes(): Route<{
         [key: string]: any;
-    }>[];
+    }, SimpleObject$1>[];
     importRoutes(routes: any[]): void;
     importApp(app: App): void;
     throw(code?: number | string, message?: string, tips?: string): void;