k99 0.6.0 → 0.7.0

package/index.d.ts

@@ -1,6 +1,6 @@
 /*!
- * k99 v0.6.0
- * (c) 2019-2024 猛火Fierflame
+ * k99 v0.7.0
+ * (c) 2019-2025 猛火Fierflame
  * @license MIT
  */
 type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'OPTIONS';
@@ -26,6 +26,7 @@ declare namespace Service {
 }
 type StoreService<T> = Service<T | undefined, [s?: T]>;
 type StateService<T> = Service<T, []>;
+type Params = Record<string | symbol, string | string[]>;
 interface Context {
     readonly environment?: object | null;
     /** 当前的路由 */
@@ -47,9 +48,7 @@ interface Context {
     /** 请求 url (不含协议及主机名等) */
     readonly url: URL;
     /** 路径参数 */
-    readonly params: Readonly<{
-        [p: string]: string;
-    }>;
+    readonly params: Readonly<Params>;
     /** 请求方法 */
     readonly method: Method;
     /** 请求头 */
@@ -118,19 +117,19 @@ interface Handler {
     plugin?: string;
 }
 interface FindHandler {
-    (ctx: Context, setParams: (v: any) => void): PromiseLike<Handler | null> | Handler | null;
+    (ctx: Context, setParams: (v: Params) => void): PromiseLike<Handler | null> | Handler | null;
 }
 
 /**
  *
  * @param  {...(Onionskin | Onionskin[])} handlers
- * @returns {import('./main/types').Handler}
+ * @returns {Handler}
  */
 declare function onionskin(...handlers: (Onionskin | Onionskin[])[]): Handler;
 type Onionskin = (ctx: Context, next: () => Promise<HandlerResult>) => PromiseLike<HandlerResult> | HandlerResult;
 
 type Guard = (ctx: Context) => PromiseLike<boolean | Handler | void> | boolean | Handler | void;
-type FindItem = [Handler | Router, Record<string, any>, string[]];
+type FindItem = [Handler | Router, Record<string | symbol, any>, string[]];
 type Finder = (this: Router, method: Method, path: string[], ctx: Context) => AsyncIterable<FindItem> | Iterable<FindItem>;
 /**
  * @abstract
@@ -139,7 +138,7 @@ declare class Router {
     /**
      *
      * @param {Router[]} routers
-     * @returns {import('./main/types').FindHandler}
+     * @returns {FindHandler}
      */
     static make(routers: Router[]): FindHandler;
     /**
@@ -151,9 +150,9 @@ declare class Router {
     disabled: boolean;
     /**
      * @abstract
-     * @param {import('./main/types').Method} method
+     * @param {Method} method
      * @param {string[]} path
-     * @param {import('./main/types').Context} ctx
+     * @param {Context} ctx
      * @returns {AsyncIterable<FindItem> | Iterable<FindItem>}
      */
     find(method: Method, path: string[], ctx: Context): AsyncIterable<FindItem> | Iterable<FindItem>;
@@ -161,30 +160,30 @@ declare class Router {
     readonly guards: Set<Guard>;
     /**
      *
-     * @param {import('./main/types').Handler} h
-     * @returns {import('./main/types').Handler}
+     * @param {Handler} h
+     * @returns {Handler}
      */
     __onionskin: (h: Handler) => Handler;
-    /** @param {import('./onionskin.mjs').Onionskin} os */
+    /** @param {Onionskin} os */
     onionskin(os: Onionskin): void;
 }
 
 declare class ApiRouter extends Router {
     /**
      * 添加子路由
-     * @template {Router | import('../Router.mjs').Finder} [T=ApiRouter]
+     * @template {Router | Finder} [T=ApiRouter]
      * @overload
      * @param {T} [router] 要注册的子路由或子路由的 Finder
-     * @returns {T extends import('../Router.mjs').Finder ? Router : T}
+     * @returns {T extends Finder ? Router : T}
      */
     route<T extends Router | Finder = ApiRouter>(router?: T | undefined): T extends Finder ? Router : T;
     /**
      * 添加子路由
-     * @template {Router | import('../Router.mjs').Finder} [T=ApiRouter]
+     * @template {Router | Finder} [T=ApiRouter]
      * @overload
      * @param {string} path   要注册的路径
      * @param {T} [router] 要注册的子路由或子路由的 Finder
-     * @returns {T extends import('../Router.mjs').Finder ? Router : T}
+     * @returns {T extends Finder ? Router : T}
      */
     route<T extends Router | Finder = ApiRouter>(path: string, router?: T | undefined): T extends Finder ? Router : T;
     /**
@@ -197,33 +196,33 @@ declare class ApiRouter extends Router {
     route(template: TemplateStringsArray, ...substitutions: any[]): RouteBinder;
     /**
      *
-     * @param {import('../main/types').Method} method
+     * @param {Method} method
      * @param {string[]} path
-     * @param {import('../main/types').Context} ctx
-     * @returns {Iterable<import('../Router.mjs').FindItem>}
+     * @param {Context} ctx
+     * @returns {Iterable<FindItem>}
      */
     find(method: Method, path: string[], ctx: Context): Iterable<FindItem>;
     /**
      * 注册处理函数
      * @overload
-     * @param {import('../main/types').Method | Iterable<import('../main/types').Method> | ArrayLike<import('../main/types').Method>} method  要注册的方法
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Method | Iterable<Method> | ArrayLike<Method>} method  要注册的方法
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     verb(method: Method | Iterable<Method> | ArrayLike<Method>, handler: Handler): () => void;
     /**
      * 注册处理函数
      * @overload
-     * @param {import('../main/types').Method | Iterable<import('../main/types').Method> | ArrayLike<import('../main/types').Method>} method  要注册的方法
+     * @param {Method | Iterable<Method> | ArrayLike<Method>} method  要注册的方法
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     verb(method: Method | Iterable<Method> | ArrayLike<Method>, path: string, handler: Handler): () => void;
     /**
      * 注册处理函数
      * @overload
-     * @param {import('../main/types').Method | Iterable<import('../main/types').Method> | ArrayLike<import('../main/types').Method>} method  要注册的方法
+     * @param {Method | Iterable<Method> | ArrayLike<Method>} method  要注册的方法
      * @param {string} path   要注册的路径
      * @returns {Binder}
      */
@@ -231,7 +230,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP GET/POST/PUT/DELETE 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     match(handler: Handler): () => void;
@@ -239,7 +238,7 @@ declare class ApiRouter extends Router {
      * 注册处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     match(path: string, handler: Handler): () => void;
@@ -261,7 +260,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP GET 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     get(handler: Handler): () => void;
@@ -269,7 +268,7 @@ declare class ApiRouter extends Router {
      * 注册 HTTP GET 处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     get(path: string, handler: Handler): () => void;
@@ -291,7 +290,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP POST 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     post(handler: Handler): () => void;
@@ -299,7 +298,7 @@ declare class ApiRouter extends Router {
      * 注册 HTTP POST 处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     post(path: string, handler: Handler): () => void;
@@ -321,7 +320,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP PUT 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     put(handler: Handler): () => void;
@@ -329,7 +328,7 @@ declare class ApiRouter extends Router {
      * 注册 HTTP PUT 处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     put(path: string, handler: Handler): () => void;
@@ -351,7 +350,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP DELETE 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     delete(handler: Handler): () => void;
@@ -359,7 +358,7 @@ declare class ApiRouter extends Router {
      * 注册 HTTP DELETE 处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     delete(path: string, handler: Handler): () => void;
@@ -381,7 +380,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP HEAD 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     head(handler: Handler): () => void;
@@ -389,7 +388,7 @@ declare class ApiRouter extends Router {
      * 注册 HTTP HEAD 处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     head(path: string, handler: Handler): () => void;
@@ -411,7 +410,7 @@ declare class ApiRouter extends Router {
     /**
      * 注册 HTTP OPTIONS 处理函数
      * @overload
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     options(handler: Handler): () => void;
@@ -419,7 +418,7 @@ declare class ApiRouter extends Router {
      * 注册 HTTP OPTIONS 处理函数
      * @overload
      * @param {string} path 要注册的路径
-     * @param {import('../main/types').Handler} handler 要注册的处理函数
+     * @param {Handler} handler 要注册的处理函数
      * @returns {() => void}
      */
     options(path: string, handler: Handler): () => void;
@@ -440,8 +439,8 @@ declare class ApiRouter extends Router {
     options(template: TemplateStringsArray, ...substitutions: any[]): Binder;
     #private;
 }
-type Match = (paths: string[]) => [Record<string, string | string[]>, string[]] | undefined;
-type Binder = (handler: Handler) => () => void;
+type Match = (paths: string[]) => [Params, string[]] | undefined;
+type Binder = (handler: Handler, ...handlers: Handler[]) => () => void;
 type Route = {
     /**
      * 路径匹配
@@ -472,34 +471,35 @@ type RouteBinder<T extends Router | Finder = ApiRouter> = (router?: T | undefine
 
 /**
  *
- * @param {import('./onionskin.mjs').Onionskin} onionskin
+ * @param {Onionskin} onionskin
  * @param {Packer} [packer]
  * @returns {Packer}
  */
-declare function packer(onionskin: Onionskin, packer?: Packer | undefined): Packer;
+declare function packer(onionskin: Onionskin, packer?: Packer): Packer;
 type Packer = (handler: Handler) => Handler;
 
 /**
  *
  * @param {Request} request
- * @param {import('./types').FindHandler} getHandler
- * @param {import('./types').Options} [options]
+ * @param {FindHandler} getHandler
+ * @param {Options} [options]
  * @returns {Promise<Response | null>}
  */
-declare function main(request: Request, getHandler: FindHandler, { runner, error: echoError, catch: catchError, method: toMethod, environment }?: Options | undefined): Promise<Response | null>;
+declare function main(request: Request, getHandler: FindHandler, { runner, error: echoError, catch: catchError, method: toMethod, environment }?: Options): Promise<Response | null>;
 
+/** @import { FindHandler, Options } from './main/types' */
 /**
  *
- * @param {import('./main/types').FindHandler} getHandler
- * @param {import('./main/types').Options} options
+ * @param {FindHandler} getHandler
+ * @param {Options} options
  * @returns {(request: Request) => Promise<Response | null>}
  */
 declare function make(getHandler: FindHandler, options: Options): (request: Request) => Promise<Response | null>;
 
 /**
  *
- * @param  {...(import('./main/types').Handler | import('./main/types').Handler[])} handlers
- * @returns {import('./main/types').Handler}
+ * @param  {...(Handler | Handler[])} handlers
+ * @returns {Handler}
  */
 declare function merge(...handlers: (Handler | Handler[])[]): Handler;
 
@@ -508,10 +508,10 @@ declare function merge(...handlers: (Handler | Handler[])[]): Handler;
  * @template T
  * @template {any[]} P
  * @overload
- * @param {(ctx: import('./main/types').Context, ...p: P) => T} exec
- * @param {((ctx: import('./main/types').Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').Service<T, P>}
+ * @param {(ctx: Context, ...p: P) => T} exec
+ * @param {((ctx: Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
+ * @param {Service.Options?} [options]
+ * @returns {Service<T, P>}
  */
 declare function service<T, P extends any[]>(exec: (ctx: Context, ...p: P) => T, destroy?: ((ctx: Context, error?: unknown) => PromiseLike<void> | void) | null | undefined, options?: Service.Options | null | undefined): Service<T, P>;
 /**
@@ -519,9 +519,9 @@ declare function service<T, P extends any[]>(exec: (ctx: Context, ...p: P) => T,
  * @template T
  * @template {any[]} P
  * @overload
- * @param {(ctx: import('./main/types').Context, ...p: P) => T} exec
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').Service<T, P>}
+ * @param {(ctx: Context, ...p: P) => T} exec
+ * @param {Service.Options?} [options]
+ * @returns {Service<T, P>}
  */
 declare function service<T, P extends any[]>(exec: (ctx: Context, ...p: P) => T, options?: Service.Options | null | undefined): Service<T, P>;
 
@@ -529,30 +529,30 @@ declare function service<T, P extends any[]>(exec: (ctx: Context, ...p: P) => T,
  *
  * @template T
  * @overload
- * @param {(ctx: import('./main/types').Context) => T} init
- * @param {import('./main/types').Service.Options} [options]
- * @returns {import('./main/types').StateService<T>}
+ * @param {(ctx: Context) => T} init
+ * @param {Service.Options} [options]
+ * @returns {StateService<T>}
  */
 declare function stateService<T>(init: (ctx: Context) => T, options?: Service.Options | undefined): StateService<T>;
 /**
  *
  * @template T
  * @overload
- * @param {(ctx: import('./main/types').Context) => T} init
- * @param {((state: T | undefined, ctx: import('./main/types').Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').StateService<T>}
+ * @param {(ctx: Context) => T} init
+ * @param {((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
+ * @param {Service.Options?} [options]
+ * @returns {StateService<T>}
  */
 declare function stateService<T>(init: (ctx: Context) => T, destroy?: ((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void) | null | undefined, options?: Service.Options | null | undefined): StateService<T>;
 /**
  *
  * @template T
  * @overload
- * @param {(ctx: import('./main/types').Context) => T} init
- * @param {((state: T | undefined, ctx: import('./main/types').Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
- * @param {((state: T, ctx: import('./main/types').Context) => any)?} [exec]
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').StateService<T>}
+ * @param {(ctx: Context) => T} init
+ * @param {((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
+ * @param {((state: T, ctx: Context) => any)?} [exec]
+ * @param {Service.Options?} [options]
+ * @returns {StateService<T>}
  */
 declare function stateService<T>(init: (ctx: Context) => T, destroy?: ((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void) | null | undefined, exec?: ((state: T, ctx: Context) => any) | null | undefined, options?: Service.Options | null | undefined): StateService<T>;
 
@@ -560,27 +560,27 @@ declare function stateService<T>(init: (ctx: Context) => T, destroy?: ((state: T
  *
  * @template T
  * @overload
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').StoreService<T>}
+ * @param {Service.Options?} [options]
+ * @returns {StoreService<T>}
  */
 declare function storeService<T>(options?: Service.Options | null | undefined): StoreService<T>;
 /**
  *
  * @template T
  * @overload
- * @param {((state: T | undefined, ctx: import('./main/types').Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').StoreService<T>}
+ * @param {((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
+ * @param {Service.Options?} [options]
+ * @returns {StoreService<T>}
  */
 declare function storeService<T>(destroy?: ((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void) | null | undefined, options?: Service.Options | null | undefined): StoreService<T>;
 /**
  *
  * @template T
  * @overload
- * @param {((state: T | undefined, ctx: import('./main/types').Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
- * @param {((state: T | undefined, ctx: import('./main/types').Context) => any)?} [exec]
- * @param {import('./main/types').Service.Options?} [options]
- * @returns {import('./main/types').StoreService<T>}
+ * @param {((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void)?} [destroy]
+ * @param {((state: T | undefined, ctx: Context) => any)?} [exec]
+ * @param {Service.Options?} [options]
+ * @returns {StoreService<T>}
  */
 declare function storeService<T>(destroy?: ((state: T | undefined, ctx: Context, error?: unknown) => PromiseLike<void> | void) | null | undefined, exec?: ((state: T | undefined, ctx: Context) => any) | null | undefined, options?: Service.Options | null | undefined): StoreService<T>;
 
@@ -590,6 +590,7 @@ declare function storeService<T>(destroy?: ((state: T | undefined, ctx: Context,
  * @param {((request: Request) => Response | Promise<Response>)?} [notFound]
  * @returns {(input: RequestInfo, init?: RequestInit) => Promise<Response>}
  */
-declare function createFetch(run: (request: Request) => Promise<Response | null>, notFound?: ((request: Request) => Response | Promise<Response>) | null | undefined): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+declare function createFetch(run: (request: Request) => Promise<Response | null>, notFound?: ((request: Request) => Response | Promise<Response>) | null): (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 
-export { ApiRouter, type Binder, type Context, type Cookie, type CookieOption, type FindHandler, type FindItem, type Finder, type Guard, type Handler, type HandlerResult, type Match, type Method, type Onionskin, type Options, type Packer, type Route, type RouteBinder, Router, type RouterRoute, type Runner, Service, type StateService, type StoreService, createFetch, main, make, merge, onionskin, packer, service, stateService, storeService };
+export { ApiRouter, Router, Service, createFetch, main, make, merge, onionskin, packer, service, stateService, storeService };
+export type { Binder, Context, Cookie, CookieOption, FindHandler, FindItem, Finder, Guard, Handler, HandlerResult, Match, Method, Onionskin, Options, Packer, Route, RouteBinder, RouterRoute, Runner, StateService, StoreService };