From ef905af1b8b3be564524a787af85cb0954e35e12 Mon Sep 17 00:00:00 2001 From: xiongxiao Date: Mon, 23 Mar 2026 18:35:57 +0800 Subject: [PATCH] =?UTF-8?q?chore:=20=E6=9B=B4=E6=96=B0=E7=89=88=E6=9C=AC?= =?UTF-8?q?=E5=8F=B7=E8=87=B3=200.2.2=EF=BC=8C=E4=BF=AE=E6=94=B9=E8=B7=AF?= =?UTF-8?q?=E7=94=B1=E7=9B=B8=E5=85=B3=E5=B1=9E=E6=80=A7=E4=B8=BA=20rid?= =?UTF-8?q?=EF=BC=8C=E9=87=8D=E6=9E=84=E8=AE=A4=E8=AF=81=E4=B8=AD=E9=97=B4?= =?UTF-8?q?=E4=BB=B6=EF=BC=8C=E6=B7=BB=E5=8A=A0=20README=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .npmrc | 4 +-- readme.md => README.md | 18 +++++------ package.json | 4 +-- src/opencode.ts | 4 +-- src/route.ts | 68 +++++++++++++++++++++--------------------- src/router-define.ts | 4 +-- 6 files changed, 51 insertions(+), 51 deletions(-) rename readme.md => README.md (94%) diff --git a/.npmrc b/.npmrc index 7446745..a106ba7 100644 --- a/.npmrc +++ b/.npmrc @@ -1,2 +1,2 @@ -//npm.xiongxiao.me/:_authToken=${ME_NPM_TOKEN} -//registry.npmjs.org/:_authToken=${NPM_TOKEN} \ No newline at end of file +/npm.cnb.cool/kevisual/registry/-/packages/:_authToken=${CNB_API_KEY} +//registry.npmjs.org/:_authToken=${NPM_TOKEN} diff --git a/readme.md b/README.md similarity index 94% rename from readme.md rename to README.md index e616e10..c24e6a8 100644 --- a/readme.md +++ b/README.md @@ -55,7 +55,7 @@ app | 方法 | 参数 | 说明 | | ----------------------------------- | ----------------------------------------- | -------------------------------------------- | -| `ctx.call(msg, ctx?)` | `{ path, key?, payload?, ... } \| { id }` | 调用其他路由，返回完整 context | +| `ctx.call(msg, ctx?)` | `{ path, key?, payload?, ... } \| { rid }` | 调用其他路由，返回完整 context | | `ctx.run(msg, ctx?)` | `{ path, key?, payload? }` | 调用其他路由，返回 `{ code, data, message }` | | `ctx.forward(res)` | `{ code, data?, message? }` | 设置响应结果 | | `ctx.throw(code?, message?, tips?)` | - | 抛出自定义错误 | @@ -64,13 +64,13 @@ app ```ts import { App } from '@kevisual/router'; -import z from 'zod'; +import { z } from 'zod'; const app = new App(); app.listen(4002); // 基本路由 app - .route({ path: 'user', key: 'info', id: 'user-info' }) + .route({ path: 'user', key: 'info', rid: 'user-info' }) .define(async (ctx) => { // ctx.query 包含请求参数 const { id } = ctx.query; @@ -129,7 +129,7 @@ const app = new App(); // 定义中间件 app .route({ - id: 'auth-example', + rid: 'auth-example', description: '权限校验中间件', }) .define(async (ctx) => { @@ -142,7 +142,7 @@ app }) .addTo(app); -// 使用中间件（通过 id 引用） +// 使用中间件（通过 rid 引用） app .route({ path: 'admin', key: 'panel', middleware: ['auth-example'] }) .define(async (ctx) => { @@ -164,17 +164,17 @@ app path: 'dog', key: 'info', description: '获取狗的信息', - metedata: { + metadata: { args: { - owner: z.string().describe('狗主人姓名'), + name: z.string().describe('狗的姓名'), age: z.number().describe('狗的年龄'), }, }, }) .define(async (ctx) => { - const { owner, age } = ctx.query; + const { name, age } = ctx.query; ctx.body = { - content: `这是一只${age}岁的狗，主人是${owner}`, + content: `这是一只${age}岁的狗，名字是${name}`, }; }) .addTo(app); diff --git a/package.json b/package.json index cd80c41..e3d15af 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "$schema": "https://json.schemastore.org/package", "name": "@kevisual/router", - "version": "0.1.7", + "version": "0.2.2", "description": "", "type": "module", "main": "./dist/router.js", @@ -30,7 +30,7 @@ "@kevisual/query": "^0.0.55", "@kevisual/remote-app": "^0.0.7", "@kevisual/use-config": "^1.0.30", - "@opencode-ai/plugin": "^1.2.27", + "@opencode-ai/plugin": "^1.3.0", "@types/bun": "^1.3.11", "@types/crypto-js": "^4.2.2", "@types/node": "^25.5.0", diff --git a/src/opencode.ts b/src/opencode.ts index 562b324..b527de4 100644 --- a/src/opencode.ts +++ b/src/opencode.ts @@ -60,11 +60,11 @@ export const createRouterAgentPluginFn = (opts?: { addCallFn(router as App) } if (router) { - (router as any).route({ path: 'auth', key: '', id: 'auth', description: '认证' }).define(async (ctx) => { }).addTo(router as App, { + (router as any).route({ path: 'auth', key: '', rid: 'auth', description: '认证' }).define(async (ctx) => { }).addTo(router as App, { overwrite: false }); - (router as any).route({ path: 'auth-admin', key: '', id: 'auth-admin', description: '认证' }).define(async (ctx) => { }).addTo(router as App, { + (router as any).route({ path: 'auth-admin', key: '', rid: 'auth-admin', description: '认证' }).define(async (ctx) => { }).addTo(router as App, { overwrite: false }) } diff --git a/src/route.ts b/src/route.ts index 47ad4e7..a505d0a 100644 --- a/src/route.ts +++ b/src/route.ts @@ -78,18 +78,18 @@ export type RouteContext; export type Run = (ctx: Required>) => Promise; export type RunMessage = { path?: string; key?: string; id?: string; payload?: any; }; -export type NextRoute = Pick; +export type NextRoute = Pick; export type RouteMiddleware = | { path?: string; key?: string; - id?: string; + rid?: string; } | string; export type RouteOpts = { path?: string; key?: string; - id?: string; + rid?: string; run?: Run; nextRoute?: NextRoute; // route to run after this route description?: string; @@ -99,7 +99,7 @@ export type RouteOpts = { isDebug?: boolean; }; export type DefineRouteOpts = Omit; -const pickValue = ['path', 'key', 'id', 'description', 'type', 'middleware', 'metadata'] as const; +const pickValue = ['path', 'key', 'rid', 'description', 'type', 'middleware', 'metadata'] as const; export type Skill = { @@ -143,7 +143,7 @@ export class Route>; nextRoute?: NextRoute; // route to run after this route description?: string; @@ -164,7 +164,7 @@ export class Route>; this.nextRoute = opts.nextRoute; this.description = opts.description; @@ -176,8 +176,8 @@ export class Route implements throw * @param uniqueId */ removeById(uniqueId: string) { - this.routes = this.routes.filter((r) => r.id !== uniqueId); + this.routes = this.routes.filter((r) => r.rid !== uniqueId); } /** * 执行route @@ -327,7 +327,7 @@ export class QueryRouter implements throw const maxNextRoute = this.maxNextRoute; ctx = (ctx || {}) as RouteContext; ctx.currentPath = path; - ctx.currentId = route?.id; + ctx.currentId = route?.rid; ctx.currentKey = key; ctx.currentRoute = route; ctx.index = (ctx.index || 0) + 1; @@ -354,11 +354,11 @@ export class QueryRouter implements throw let route: Route | undefined; const isString = typeof item === 'string'; if (isString) { - route = this.routes.find((r) => r.id === item); + route = this.routes.find((r) => r.rid === item); } else { route = this.routes.find((r) => { - if (item.id) { - return r.id === item.id; + if (item.rid) { + return r.rid === item.rid; } else { // key 可以是空，所以可以不严格验证 return r.path === item.path && r.key == item.key; @@ -408,8 +408,8 @@ export class QueryRouter implements throw ctx.message = e.message; ctx.body = null; } else { - console.error(`[router error] fn:${route.path}-${route.key}:${route.id}`); - console.error(`[router error] middleware:${middleware.path}-${middleware.key}:${middleware.id}`); + console.error(`[router error] fn:${route.path}-${route.key}:${route.rid}`); + console.error(`[router error] middleware:${middleware.path}-${middleware.key}:${middleware.rid}`); console.error(e) ctx.code = 500; ctx.message = 'Internal Server Error'; @@ -438,7 +438,7 @@ export class QueryRouter implements throw ctx.code = e.code; ctx.message = e.message; } else { - console.error(`[router error] fn:${route.path}-${route.key}:${route.id}`); + console.error(`[router error] fn:${route.path}-${route.key}:${route.rid}`); console.error(`[router error] error`, e); ctx.code = 500; ctx.message = 'Internal Server Error'; @@ -455,8 +455,8 @@ export class QueryRouter implements throw if (route.nextRoute.path || route.nextRoute.key) { path = route.nextRoute.path; key = route.nextRoute.key; - } else if (route.nextRoute.id) { - const nextRoute = this.routes.find((r) => r.id === route.nextRoute.id); + } else if (route.nextRoute.rid) { + const nextRoute = this.routes.find((r) => r.rid === route.nextRoute.rid); if (nextRoute) { path = nextRoute.path; key = nextRoute.key; @@ -529,14 +529,14 @@ export class QueryRouter implements throw * @param ctx * @returns */ - async call(message: { id?: string; path?: string; key?: string; payload?: any }, ctx?: RouteContext & { [key: string]: any }) { + async call(message: { rid?: string; path?: string; key?: string; payload?: any }, ctx?: RouteContext & { [key: string]: any }) { let path = message.path; let key = message.key; // 优先 path + key if (path) { return await this.parse({ ...message, path, key }, { ...this.context, ...ctx }); - } else if (message.id) { - const route = this.routes.find((r) => r.id === message.id); + } else if (message.rid) { + const route = this.routes.find((r) => r.rid === message.rid); if (route) { path = route.path; key = route.key; @@ -630,11 +630,11 @@ export class QueryRouter implements throw hasRoute(path: string, key: string = '') { return this.routes.find((r) => r.path === path && r.key === key); } - findRoute(opts?: { path?: string; key?: string; id?: string }) { - const { path, key, id } = opts || {}; + findRoute(opts?: { path?: string; key?: string; rid?: string }) { + const { path, key, rid } = opts || {}; return this.routes.find((r) => { - if (id) { - return r.id === id; + if (rid) { + return r.rid === rid; } if (path) { if (key !== undefined) { @@ -655,14 +655,14 @@ export class QueryRouter implements throw const tokenUser = ctx.state as unknown as { tokenUser?: any }; let isUser = !!tokenUser; const list = this.getList(opts?.filter).filter((item) => { - if (item.id === 'auth' || item.id === 'auth-can' || item.id === 'check-auth-admin' || item.id === 'auth-admin') { + if (item.rid === 'auth' || item.rid === 'auth-can' || item.rid === 'check-auth-admin' || item.rid === 'auth-admin') { return false; } return true; }); ctx.body = { list: list.map((item) => { - const route = pick(item, ['id', 'path', 'key', 'description', 'middleware', 'metadata'] as const); + const route = pick(item, ['rid', 'path', 'key', 'description', 'middleware', 'metadata'] as const); return toJSONSchemaRoute(route); }), isUser @@ -766,7 +766,7 @@ export class QueryRouterServer extends Qu * @param param0 * @returns */ - async run(msg: { id?: string; path?: string; key?: string; payload?: any, token?: string, data?: any }, ctx?: Partial>) { + async run(msg: { rid?: string; path?: string; key?: string; payload?: any, token?: string, data?: any }, ctx?: Partial>) { const handle = this.handle; if (handle) { return handle(msg, ctx); @@ -774,13 +774,13 @@ export class QueryRouterServer extends Qu return super.run(msg, ctx as RouteContext); } - async runAction( + async runAction( api: T, payload: RunActionPayload, ctx?: RouteContext ) { - const { path, key, id } = api as any; - return this.run({ path, key, id, payload }, ctx); + const { path, key, rid } = api as any; + return this.run({ path, key, rid, payload }, ctx); } /** * 创建认证相关的中间件，默认是 auth, auth-admin, auth-can 三个中间件 @@ -790,7 +790,7 @@ export class QueryRouterServer extends Qu this.route({ path: 'auth', key: 'auth', - id: 'auth', + rid: 'auth', description: 'token验证', }).define(async (ctx) => { if (fun) { @@ -801,7 +801,7 @@ export class QueryRouterServer extends Qu this.route({ path: 'auth-admin', key: 'auth-admin', - id: 'auth-admin', + rid: 'auth-admin', description: 'admin token验证', middleware: ['auth'] }).define(async (ctx) => { @@ -813,7 +813,7 @@ export class QueryRouterServer extends Qu this.route({ path: 'auth-can', key: 'auth-can', - id: 'auth-can', + rid: 'auth-can', description: '权限验证' }).define(async (ctx) => { if (fun) { diff --git a/src/router-define.ts b/src/router-define.ts index d574d2d..b9fe048 100644 --- a/src/router-define.ts +++ b/src/router-define.ts @@ -53,8 +53,8 @@ class Chain { this.object.key = key; return this; } - setId(key: string) { - this.object.id = key; + setRid(key: string) { + this.object.rid = key; return this; } setRun(run: Run) {