@zhin.js/core 1.0.3 → 1.0.4

package/src/app.ts

@@ -19,20 +19,22 @@ import { fileURLToPath } from "url";
 import { generateEnvTypes } from "./types-generator.js";
 import logger, { setName } from "@zhin.js/logger";
 import { sleep } from "./utils.js";
-
+import { PermissionChecker, Permissions } from "./permissions.js";
 // 创建静态logger用于配置加载等静态操作
 setName("Zhin");
 import { MessageMiddleware, Plugin } from "./plugin.js";
 import { Adapter } from "./adapter";
 import { MessageCommand } from "./command";
 import { Component } from "./component";
-import { RelatedDatabase,DocumentDatabase,KeyValueDatabase,Schema,Registry} from "@zhin.js/database";
+import { RelatedDatabase, DocumentDatabase, KeyValueDatabase, Schema, Registry } from "@zhin.js/database";
 import { DatabaseLogTransport } from "./log-transport.js";
 import { SystemLog, SystemLogSchema } from "./models/system-log.js";
+import { User, UserSchema } from './models/user.js'
 import { addTransport, removeTransport } from "@zhin.js/logger";
-declare module "@zhin.js/types"{
-  interface Models{
-    SystemLog:SystemLog;
+declare module "@zhin.js/types" {
+  interface Models {
+    SystemLog: SystemLog;
+    User: User
   }
 }
 
@@ -46,8 +48,10 @@ declare module "@zhin.js/types"{
 export class App extends HMR<Plugin> {
   static currentPlugin: Plugin;
   private config: AppConfig;
+  middlewares: MessageMiddleware[] = [];
   adapters: string[] = [];
-  database?: RelatedDatabase<any,Models>|DocumentDatabase<any,Models>|KeyValueDatabase<any,Models>;
+  database?: RelatedDatabase<any, Models> | DocumentDatabase<any, Models> | KeyValueDatabase<any, Models>;
+  permissions: Permissions = new Permissions(this);
   private logTransport?: DatabaseLogTransport;
   /**
    * 构造函数：初始化应用，加载配置，注册全局异常处理
@@ -77,7 +81,7 @@ export class App extends HMR<Plugin> {
     super("Zhin", {
       logger,
       dirs: finalConfig.plugin_dirs || [],
-      extensions: new Set([".js", ".ts",".jsx",".tsx"]),
+      extensions: new Set([".js", ".ts", ".jsx", ".tsx"]),
       debug: finalConfig.debug,
     });
     this.on("message.send", this.sendMessage.bind(this));
@@ -103,6 +107,9 @@ export class App extends HMR<Plugin> {
     bots: [],
     debug: false,
   };
+  middleware(middleware: MessageMiddleware) {
+    this.middlewares.push(middleware)
+  }
   /**
    * 发送消息到指定适配器和机器人
    * @param options 消息发送参数（包含 context、bot、内容等）
@@ -119,7 +126,7 @@ export class App extends HMR<Plugin> {
       );
     return bot.$sendMessage(options);
   }
-  async recallMessage(adapter_name:string,bot_name:string,id:string){
+  async recallMessage(adapter_name: string, bot_name: string, id: string) {
     const adapter = this.getContext<Adapter>(adapter_name);
     if (!adapter)
       throw new Error(`can't find adapter for name ${adapter_name}`);
@@ -188,14 +195,15 @@ export class App extends HMR<Plugin> {
 
     this.logger.info("App configuration updated", this.config);
   }
-  get schemas(){
+  get schemas() {
     return this.dependencyList.reduce((result, plugin) => {
       plugin.schemas.forEach((schema, name) => {
         result.set(name, schema);
       });
       return result;
-    }, new Map<string,Schema<any>>([
-      ['SystemLog', SystemLogSchema]
+    }, new Map<string, Schema<any>>([
+      ['SystemLog', SystemLogSchema],
+      ['User', UserSchema]
     ]));
   }
   /** 使用插件 */
@@ -211,15 +219,15 @@ export class App extends HMR<Plugin> {
       this.use(pluginName);
     }
     await sleep(200);
-    const schemas:Record<string,Schema>={};
+    const schemas: Record<string, Schema> = {};
     for (const [name, schema] of this.schemas) {
-      schemas[name]=schema;
+      schemas[name] = schema;
     }
     if (this.config.database) {
-      this.database=Registry.create((this.config.database as any).dialect,this.config.database,schemas);
+      this.database = Registry.create((this.config.database as any).dialect, this.config.database, schemas);
       await this.database?.start();
       this.logger.info(`database init success`);
-      
+
       // 初始化日志传输器
       this.logTransport = new DatabaseLogTransport(this);
       addTransport(this.logTransport);
@@ -227,7 +235,7 @@ export class App extends HMR<Plugin> {
     } else {
       this.logger.info(`database not configured, skipping database init`);
     }
-    this.dispatch("database.ready",this.database);
+    this.dispatch("database.ready", this.database);
     // 等待所有插件就绪
     await this.waitForReady();
     this.logger.info("started successfully");
@@ -237,14 +245,14 @@ export class App extends HMR<Plugin> {
   /** 停止App */
   async stop(): Promise<void> {
     this.logger.info("Stopping app...");
-    
+
     // 停止日志清理任务并移除日志传输器
     if (this.logTransport) {
       this.logTransport.stopCleanup();
       removeTransport(this.logTransport);
       this.logger.info("database log transport removed");
     }
-    
+
     // 销毁所有插件
     this.dispose();
 
@@ -315,7 +323,10 @@ export function defineModel<T extends Record<string, any>>(
   const plugin = usePlugin();
   return plugin.defineModel(name, schema);
 }
-
+export function addPermit<T extends RegisteredAdapter>(name: string | RegExp, checker: PermissionChecker<T>) {
+  const plugin = usePlugin()
+  return plugin.addPermit(name, checker)
+}
 /** 获取当前插件实例 */
 export function usePlugin(): Plugin {
   const hmr = HMR.currentHMR;
@@ -371,7 +382,7 @@ export function addMiddleware(middleware: MessageMiddleware): void {
   const plugin = usePlugin();
   plugin.addMiddleware(middleware);
 }
-export function onDatabaseReady(callback: (database: RelatedDatabase<any,Models>|DocumentDatabase<any,Models>|KeyValueDatabase<any,Models>) => PromiseLike<void>) {
+export function onDatabaseReady(callback: (database: RelatedDatabase<any, Models> | DocumentDatabase<any, Models> | KeyValueDatabase<any, Models>) => PromiseLike<void>) {
   const plugin = usePlugin();
   if (plugin.app.database?.isStarted) callback(plugin.app.database);
   plugin.on("database.ready", callback);

package/src/command.ts

@@ -3,6 +3,8 @@ import {AdapterMessage, SendContent} from "./types.js";
 import {RegisteredAdapters} from "@zhin.js/types";
 import type {Message} from "./message.js";
 import {MaybePromise} from "@zhin.js/types";
+import { Plugin } from "./plugin.js";
+import { PluginError } from "./errors.js";
 
 /**
  * MessageCommand类：命令系统核心，基于segment-matcher实现。
@@ -10,15 +12,8 @@ import {MaybePromise} from "@zhin.js/types";
  */
 export class MessageCommand<T extends keyof RegisteredAdapters=keyof RegisteredAdapters> extends SegmentMatcher{
     #callbacks:MessageCommand.Callback<T>[]=[];
+    #permissions:string[]=[];
     #checkers:MessageCommand.Checker<T>[]=[]
-    /**
-     * 限定命令作用域（适配器名）
-     * @param scopes 适配器名列表
-     */
-    scope<R extends T>(...scopes:R[]):MessageCommand<R>{
-        this.#checkers.push((m)=>(scopes as string[]).includes(m.$adapter))
-        return this as MessageCommand<R>
-    }
     /**
      * 注册命令回调
      * @param callback 命令处理函数
@@ -27,12 +22,25 @@ export class MessageCommand<T extends keyof RegisteredAdapters=keyof RegisteredA
         this.#callbacks.push(callback)
         return this as MessageCommand<T>;
     }
+    permit(...permissions:string[]){
+        this.#permissions.push(...permissions)
+        return this as MessageCommand<T>;
+    }
     /**
      * 处理消息，自动匹配命令并执行回调
      * @param message 消息对象
+     * @param plugin 插件实例
      * @returns 命令返回内容或undefined
      */
-    async handle(message:Message<AdapterMessage<T>>):Promise<SendContent|undefined>{
+    async handle(message:Message<AdapterMessage<T>>,plugin:Plugin):Promise<SendContent|undefined>{
+        for(const permission of this.#permissions){
+            const permit=plugin.getPermit(permission)
+            if(!permit) {
+                throw new PluginError(`权限 ${permission} 不存在`,plugin.name)
+            }
+            const result=await permit.check(permission,message)
+            if(!result) return;
+        }
         for(const check of this.#checkers){
             const result=await check(message)
             if(!result) return;

package/src/models/user.ts

@@ -0,0 +1,15 @@
+import { Schema } from '@zhin.js/database'
+export interface User{
+    id:string
+    name?:string
+    password?:string
+    third_part:string[];
+    permissions?:string[]
+}
+export const UserSchema:Schema<User>={
+    id:{type:"text",nullable:false},
+    name:{type:'text',nullable:true},
+    password:{type:'text',nullable:true},
+    third_part:{type:'json',default:[]},
+    permissions:{type:'json',default:[]}
+}

package/src/permissions.ts

@@ -0,0 +1,62 @@
+import { MaybePromise } from "@zhin.js/types";
+import { RegisteredAdapter } from "./types.js";
+import { Message } from "./message.js";
+import { AdapterMessage } from "./types.js";
+import { App } from "./app.js";
+export type PermissionItem<T extends RegisteredAdapter = RegisteredAdapter> = {
+    name: string | RegExp
+    check: PermissionChecker<T>
+}
+export type PermissionChecker<T extends RegisteredAdapter = RegisteredAdapter> = (name: string, message: Message<AdapterMessage<T>>) => MaybePromise<boolean>
+export class Permissions extends Array<PermissionItem>{
+    constructor(private readonly app: App) {
+        super();
+        this.add(Permissions.define(/^adapter\([^)]+\)$/, (name, message) => {
+            return message.$adapter === name.replace(/^adapter\(([^)]+)\)$/, '$1');
+        }));
+        this.add(Permissions.define(/^group\([^)]+\)$/, (name, message) => {
+            const match=name.match(/^group\(([^)]+)\)$/);
+            if(!match) return false;
+            const id=match[1];
+            if(message.$channel.type !== 'group') return false;
+            if(id===''||id==='*') return true;
+            return message.$channel.id === id;
+        }));
+        this.add(Permissions.define(/^private\([^)]+\)$/, (name, message) => {
+            const match=name.match(/^private\(([^)]+)\)$/);
+            if(!match) return false;
+            const id=match[1];
+            if(message.$channel.type !== 'private') return false;
+            if(id===''||id==='*') return true;
+            return message.$channel.id === id;
+        }));
+        this.add(Permissions.define(/^channel\([^)]+\)$/, (name, message) => {
+            const match=name.match(/^channel\(([^)]+)\)$/);
+            if(!match) return false;
+            const id=match[1];
+            if(message.$channel.type !== 'channel') return false;
+            if(id===''||id==='*') return true;
+            return message.$channel.id === id;
+        }));
+        this.add(Permissions.define(/^user\([^)]+\)$/,(name,message)=>{
+            const match=name.match(/^channel\(([^)]+)\)$/);
+            if(!match) return false;
+            const id=match[1];
+            return message.$sender.id===id;
+        }))
+    }
+    add(permission: PermissionItem) {
+        this.push(permission);
+    }
+    get(name: string): PermissionItem | undefined {
+        return this.app.dependencyList.reduce((result,dep)=>{
+            result.push(...dep.permissions)
+            return result;
+        },[...this]).find(p => new RegExp(p.name).test(name));
+    }
+}
+export namespace Permissions{
+    export function define<T extends RegisteredAdapter = RegisteredAdapter>(name: string | RegExp, check: PermissionChecker<T>): PermissionItem<T> {
+        return { name, check };
+    }
+}

package/src/plugin.ts

@@ -5,6 +5,7 @@
 
 import {MaybePromise} from '@zhin.js/types'
 import {AdapterMessage, BeforeSendHandler, RegisteredAdapter, SendOptions} from "./types.js";
+import { PermissionItem,PermissionChecker } from './permissions.js';
 import {Message} from './message.js'
 import {Dependency, Logger,} from "@zhin.js/hmr";
 import {App} from "./app";
@@ -31,6 +32,7 @@ export type MessageMiddleware<P extends RegisteredAdapter=RegisteredAdapter> = (
 export class Plugin extends Dependency<Plugin> {
     middlewares: MessageMiddleware<RegisteredAdapter>[] = [];
     components: Map<string, Component<any>> = new Map();
+    permissions: PermissionItem<RegisteredAdapter>[]=[];
     schemas: Map<string,Schema<any>>=new Map();
     commands:MessageCommand[]=[];
     crons:Cron[]=[];
@@ -48,7 +50,7 @@ export class Plugin extends Dependency<Plugin> {
         // 注册命令处理为默认中间件
         this.addMiddleware(async (message,next)=>{
             for(const command of this.commands){
-                const result=await command.handle(message);
+                const result=await command.handle(message,this);
                 if(result) message.$reply(result);
             }
             return next()
@@ -90,20 +92,26 @@ export class Plugin extends Dependency<Plugin> {
             try {
                 await message.$reply('抱歉，处理您的消息时出现了错误。')
             } catch (replyError) {
-                // 静默处理回复错误，避免错误循环
-                // console.error 已替换为注释
             }
         }
     }
+    addPermit<T extends RegisteredAdapter>(name:string|RegExp,check:PermissionChecker<T>){
+        this.permissions.push({name,check});
+        return this;
+    }
+    getPermit<T extends RegisteredAdapter>(name:string):PermissionItem<T>|undefined{
+        return this.app.permissions.get(name);
+    }
     cron(cronExpression:string,callback:()=>void){
         const cronJob = new Cron(cronExpression,callback);
         this.crons.push(cronJob);
         return this;
     }
     async #runMiddlewares(message: Message, index: number): Promise<void> {
-        if (index >= this.middlewares.length) return
+        const middlewareList=[...this.app.middlewares,...this.middlewares]
+        if (index >= middlewareList.length) return
         
-        const middleware = this.middlewares[index]
+        const middleware = middlewareList[index]
         
         try {
             await middleware(message, () => this.#runMiddlewares(message, index + 1))

package/src/types.ts

@@ -1,5 +1,5 @@
 import {MaybePromise,RegisteredAdapters}from '@zhin.js/types'
-import {MessageChannel} from "./message.js";
+import {MessageChannel,Message} from "./message.js";
 import {Adapter} from "./adapter.js";
 import {Bot,BotConfig} from "./bot.js";
 import { Databases,Registry } from "@zhin.js/database";
@@ -57,6 +57,7 @@ export type SendContent=MaybeArray<string|MessageElement>
 export interface MessageSender{
   id: string;
   name?: string;
+  permissions?:string[]
 }
 /**
  * 通用字典类型