@kevisual/router 0.0.5 → 0.0.6-alpha-2

package/dist/router-browser.d.ts

@@ -65,9 +65,18 @@ type RouteContext<T = {
     end?: boolean;
     queryRouter?: QueryRouter;
     error?: any;
+    /** 请求 route的返回结果，包函ctx */
     call?: (message: {
         path: string;
-        key: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }) => Promise<any>;
+    /** 请求 route的返回结果，不包函ctx */
+    queryRoute?: (message: {
+        path: string;
+        key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
@@ -225,13 +234,36 @@ declare class QueryRouter {
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<any>;
+    /**
+     * 返回的数据包含所有的context的请求返回的内容，可做其他处理
+     * @param message
+     * @param ctx
+     * @returns
+     */
     call(message: {
         path: string;
-        key: string;
+        key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<any>;
+    /**
+     * 请求 result 的数据
+     * @param message
+     * @param ctx
+     * @returns
+     */
+    queryRoute(message: {
+        path: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        data: any;
+        message: any;
+    }>;
     setContext(ctx: RouteContext): Promise<void>;
     getList(): RouteInfo[];
     getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
@@ -284,16 +316,14 @@ declare class QueryRouterServer extends QueryRouter {
     route(path: string, key?: string): Route;
     route(path: string, opts?: RouteOpts): Route;
     route(path: string, key?: string, opts?: RouteOpts): Route;
-    call(message: {
-        path: string;
-        key: string;
-        payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }): Promise<any>;
+    /**
+     * 等于queryRoute，但是调用了handle
+     * @param param0
+     * @returns
+     */
     run({ path, key, payload }: {
         path: string;
-        key: string;
+        key?: string;
         payload?: any;
     }): Promise<any>;
 }

package/dist/router-browser.js

@@ -5865,12 +5865,33 @@ class QueryRouter {
         // TODO: 是否需要queryRouter，函数内部处理router路由执行，这应该是避免去内部去包含的功能过
         ctx.queryRouter = this;
         ctx.call = this.call.bind(this);
+        ctx.queryRoute = this.queryRoute.bind(this);
         ctx.index = 0;
         return await this.runRoute(path, key, ctx);
     }
+    /**
+     * 返回的数据包含所有的context的请求返回的内容，可做其他处理
+     * @param message
+     * @param ctx
+     * @returns
+     */
     async call(message, ctx) {
         return await this.parse(message, { ...this.context, ...ctx });
     }
+    /**
+     * 请求 result 的数据
+     * @param message
+     * @param ctx
+     * @returns
+     */
+    async queryRoute(message, ctx) {
+        const res = await this.parse(message, { ...this.context, ...ctx });
+        return {
+            code: res.code,
+            data: res.body,
+            message: res.message,
+        };
+    }
     async setContext(ctx) {
         this.context = ctx;
     }
@@ -5947,9 +5968,11 @@ class QueryRouterServer extends QueryRouter {
         }
         return new Route(path, key, opts);
     }
-    async call(message, ctx) {
-        return await this.parse(message, ctx);
-    }
+    /**
+     * 等于queryRoute，但是调用了handle
+     * @param param0
+     * @returns
+     */
     async run({ path, key, payload }) {
         const handle = this.handle;
         const resultError = (error, code = 500) => {

package/dist/router.d.ts

@@ -2,6 +2,7 @@ import { Schema } from 'zod';
 export { Schema } from 'zod';
 import http, { IncomingMessage, ServerResponse } from 'http';
 import https from 'https';
+import http2 from 'http2';
 import { WebSocketServer, WebSocket } from 'ws';
 
 type BaseRule = {
@@ -68,9 +69,18 @@ type RouteContext<T = {
     end?: boolean;
     queryRouter?: QueryRouter;
     error?: any;
+    /** 请求 route的返回结果，包函ctx */
     call?: (message: {
         path: string;
-        key: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }) => Promise<any>;
+    /** 请求 route的返回结果，不包函ctx */
+    queryRoute?: (message: {
+        path: string;
+        key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
@@ -228,13 +238,36 @@ declare class QueryRouter {
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<any>;
+    /**
+     * 返回的数据包含所有的context的请求返回的内容，可做其他处理
+     * @param message
+     * @param ctx
+     * @returns
+     */
     call(message: {
         path: string;
-        key: string;
+        key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<any>;
+    /**
+     * 请求 result 的数据
+     * @param message
+     * @param ctx
+     * @returns
+     */
+    queryRoute(message: {
+        path: string;
+        key?: string;
+        payload?: any;
+    }, ctx?: RouteContext & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        data: any;
+        message: any;
+    }>;
     setContext(ctx: RouteContext): Promise<void>;
     getList(): RouteInfo[];
     getHandle<T = any>(router: QueryRouter, wrapperFn?: HandleFn<T>, ctx?: RouteContext): (msg: {
@@ -287,16 +320,14 @@ declare class QueryRouterServer extends QueryRouter {
     route(path: string, key?: string): Route;
     route(path: string, opts?: RouteOpts): Route;
     route(path: string, key?: string, opts?: RouteOpts): Route;
-    call(message: {
-        path: string;
-        key: string;
-        payload?: any;
-    }, ctx?: RouteContext & {
-        [key: string]: any;
-    }): Promise<any>;
+    /**
+     * 等于queryRoute，但是调用了handle
+     * @param param0
+     * @returns
+     */
     run({ path, key, payload }: {
         path: string;
-        key: string;
+        key?: string;
         payload?: any;
     }): Promise<any>;
 }
@@ -348,7 +379,7 @@ type ServerOpts = {
         [key: string]: any;
     }) => any;
     cors?: Cors;
-    isHTTPS?: boolean;
+    httpType?: 'http' | 'https' | 'http2';
     httpsKey?: string;
     httpsCert?: string;
 };
@@ -359,7 +390,7 @@ declare class Server {
     private _callback;
     private cors;
     private hasOn;
-    private isHTTPS;
+    private httpType;
     private options;
     constructor(opts?: ServerOpts);
     listen(port: number, hostname?: string, backlog?: number, listeningListener?: () => void): void;
@@ -370,7 +401,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 http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    createServer(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | http2.Http2SecureServer<typeof http.IncomingMessage, typeof http.ServerResponse, typeof http2.Http2ServerRequest, typeof http2.Http2ServerResponse>;
     setHandle(handle?: any): void;
     /**
      * get callback
@@ -386,7 +417,7 @@ declare class Server {
      */
     on(listener: Listener | Listener[]): void;
     get callback(): any;
-    get server(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
+    get server(): http.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | https.Server<typeof http.IncomingMessage, typeof http.ServerResponse> | http2.Http2SecureServer<typeof http.IncomingMessage, typeof http.ServerResponse, typeof http2.Http2ServerRequest, typeof http2.Http2ServerResponse>;
 }
 
 /**
@@ -467,14 +498,7 @@ type AppOptions<T = {}> = {
     /** handle msg 关联 */
     routerHandle?: RouterHandle;
     routerContext?: RouteContext<T>;
-    serverOptions?: {
-        path?: string;
-        cors?: Cors;
-        handle?: any;
-        isHTTPS?: boolean;
-        httpsKey?: string;
-        httpsCert?: string;
-    };
+    serverOptions?: ServerOpts;
     io?: boolean;
     ioOpts?: {
         routerHandle?: RouterHandle;
@@ -505,11 +529,18 @@ declare class App<T = {}> {
     route(path: string, key?: string, opts?: RouteOpts): Route;
     call(message: {
         path: string;
-        key: string;
+        key?: string;
         payload?: any;
     }, ctx?: RouteContext & {
         [key: string]: any;
     }): Promise<any>;
+    queryRoute(path: string, key?: string, payload?: any, ctx?: RouteContext & {
+        [key: string]: any;
+    }): Promise<{
+        code: any;
+        data: any;
+        message: any;
+    }>;
     exportRoutes(): Route[];
     importRoutes(routes: any[]): void;
     importApp(app: App): void;

package/dist/router.js

@@ -1,6 +1,7 @@
 import { webcrypto } from 'node:crypto';
 import http from 'http';
 import https from 'https';
+import http2 from 'http2';
 import url from 'url';
 import { WebSocketServer } from 'ws';
 
@@ -5884,12 +5885,33 @@ class QueryRouter {
         // TODO: 是否需要queryRouter，函数内部处理router路由执行，这应该是避免去内部去包含的功能过
         ctx.queryRouter = this;
         ctx.call = this.call.bind(this);
+        ctx.queryRoute = this.queryRoute.bind(this);
         ctx.index = 0;
         return await this.runRoute(path, key, ctx);
     }
+    /**
+     * 返回的数据包含所有的context的请求返回的内容，可做其他处理
+     * @param message
+     * @param ctx
+     * @returns
+     */
     async call(message, ctx) {
         return await this.parse(message, { ...this.context, ...ctx });
     }
+    /**
+     * 请求 result 的数据
+     * @param message
+     * @param ctx
+     * @returns
+     */
+    async queryRoute(message, ctx) {
+        const res = await this.parse(message, { ...this.context, ...ctx });
+        return {
+            code: res.code,
+            data: res.body,
+            message: res.message,
+        };
+    }
     async setContext(ctx) {
         this.context = ctx;
     }
@@ -5966,9 +5988,11 @@ class QueryRouterServer extends QueryRouter {
         }
         return new Route(path, key, opts);
     }
-    async call(message, ctx) {
-        return await this.parse(message, ctx);
-    }
+    /**
+     * 等于queryRoute，但是调用了handle
+     * @param param0
+     * @returns
+     */
     async run({ path, key, payload }) {
         const handle = this.handle;
         const resultError = (error, code = 500) => {
@@ -6136,7 +6160,7 @@ class Server {
     _callback;
     cors;
     hasOn = false;
-    isHTTPS = false;
+    httpType = 'http';
     options = {
         key: '',
         cert: '',
@@ -6145,7 +6169,7 @@ class Server {
         this.path = opts?.path || '/api/router';
         this.handle = opts?.handle;
         this.cors = opts?.cors;
-        this.isHTTPS = opts?.isHTTPS || false;
+        this.httpType = opts?.httpType || 'http';
         this.options = {
             key: opts?.httpsKey || '',
             cert: opts?.httpsCert || '',
@@ -6159,13 +6183,26 @@ class Server {
     }
     createServer() {
         let server;
-        if (this.isHTTPS) {
+        const httpType = this.httpType;
+        if (httpType === 'https') {
             if (this.options.key && this.options.cert) {
                 server = https.createServer({
                     key: this.options.key,
                     cert: this.options.cert,
                 });
-                console.log('https server');
+                return server;
+            }
+            else {
+                console.error('https key and cert is required');
+                console.log('downgrade to http');
+            }
+        }
+        else if (httpType === 'http2') {
+            if (this.options.key && this.options.cert) {
+                server = http2.createSecureServer({
+                    key: this.options.key,
+                    cert: this.options.cert,
+                });
                 return server;
             }
             else {
@@ -6188,6 +6225,7 @@ class Server {
         const handle = this.handle;
         const cors = this.cors;
         const _callback = async (req, res) => {
+            // only handle /api/router
             if (req.url === '/favicon.ico') {
                 return;
             }
@@ -6212,7 +6250,7 @@ class Server {
                     return;
                 }
             }
-            res.writeHead(200); // 设置响应头，给予其他api知道headersSent，它已经被响应了
+            res.writeHead(200); // 设置响应头，给予其他任何listen 知道headersSent，它已经被响应了
             const url = req.url;
             if (!url.startsWith(path)) {
                 res.end(resultError(`not path:[${path}]`));
@@ -6482,6 +6520,9 @@ class App {
         const router = this.router;
         return await router.call(message, ctx);
     }
+    async queryRoute(path, key, payload, ctx) {
+        return await this.router.queryRoute({ path, key, payload }, ctx);
+    }
     exportRoutes() {
         return this.router.exportRoutes();
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@kevisual/router",
-  "version": "0.0.5",
+  "version": "0.0.6-alpha-2",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.js",