koishi-plugin-chatluna 1.0.0-beta.100

package/README.MD

@@ -0,0 +1,173 @@
+<div align="center">
+
+<img src="./logo.png" alt="Project Logo" title="Project Logo" />
+
+[中文](./README.MD) | English
+
+#
+
+_A bot plugin for LLM chat services with multi-model integration, extensibility, and various output formats._
+
+[![npm](https://img.shields.io/npm/v/koishi-plugin-chatluna)](https://www.npmjs.com/package/koishi-plugin-chatluna) [![npm](https://img.shields.io/npm/dm/koishi-plugin-chatluna)](https://www.npmjs.com/package/koishi-plugin-chatluna) ![node version](https://img.shields.io/badge/node-%3E=18-green) ![github top language](https://img.shields.io/github/languages/top/ChatLunaLab/chatluna?logo=github)
+
+[![Telegram](https://img.shields.io/badge/Join-Telegram_Group-blue)](https://t.me/koishi_chatluna) [![QQ](https://img.shields.io/badge/Join-QQ_Group-ff69b4)](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=eEBVq6GK7HYX2y61x55WD6hnXTIRop-0&authKey=i4pG5%2BJ%2FY8auWprBubhremTkn3vroPigQq5m9RENGBLrLmlj%2BSu3G%2BqllK7Wts2M&noverify=0&group_code=282381753) [![doc](https://img.shields.io/badge/See-Document(WIP)-green)](https://chatluna.chat/)
+
+**Project Status: Iterating towards v1.0 (Contributors needed for documentation)**
+
+</div>
+
+## Screenshots
+
+Work in progress...
+
+## Features
+
+- 🚀 Highly extensible (LangChain & Koishi APIs)
+- 🎭 Custom conversation presets
+- 🛡️ Rate limiting & blacklist system
+- 🎨 Multi-format output (text, voice, image, mixed)
+- 🧠 Context-aware with long-term memory
+- 🔀 Three modes: chat, browsing, plugin
+- 🔒 Content moderation via [Koishi censor](https://censor.koishi.chat/)
+
+## Roadmap
+
+- [x] Room-based conversation system
+- [x] Content moderation
+- [x] TTS support (via [vits service](https://github.com/initialencounter/mykoishi/blame/master/vits/readme.md))
+- [x] Image rendering for replies
+- [x] Multi-model integration
+- [x] Preset system
+- [x] ~~Conversation import/export~~ (abandoned)
+- [x] v1 refactoring
+- [x] Streaming responses
+- [x] i18n support
+
+## Quick Start
+
+Install the plugin in Koishi for basic functionality. For detailed setup, see our [docs](https://chatluna.chat/guide/getting-started.html).
+
+## Supported Models
+
+| Model/Platform | Integration | Features | Notes |
+|:---------------|:------------|:---------|:------|
+| [OpenAI](./packages/openai-adapter/README.md) | Official API | Customizable, plugin/browsing modes | Paid API |
+| [Azure OpenAI](./packages/azure-openai-adapter/README.md) | Official API | Similar to OpenAI | Paid API |
+| [Google Gemini](./packages/gemini-adapter/README.md) | Official API | Fast, outperforms GPT-3.5 | Requires account, may be charged |
+| [New Bing](./packages/newbing-adapter/README.md) | Reverse-engineered | Web search, no login required | Proxy needed, CAPTCHA required |
+| [Claude API](./packages/claude-adapter) | Official API | Large context, often beats GPT-3.5 | Paid, no Function Call |
+| [Tongyi Qianwen](./packages/qwen-adapter/README.md) | Official API | Free quota available | Slightly better than Zhipu |
+| [Zhipu](./packages/zhipu-adapter/README.md) | Official API | Free tokens for new users | Better than Xunfei Spark |
+| [Xunfei Spark](./packages/spark-adapter/README.md) | Official API | Free quota for new users | Similar to GPT-3.5 |
+| [Wenxin Yiyan](./packages/wenxin-adapter/README.md) | Official API | Baidu's model | Slightly worse than Xunfei Spark |
+| [Hunyuan](./packages/hunyuan-adapter/README.md) | Official API | Tencent's model | Better than Wenxin Yiyan |
+| [Ollama](./packages/ollama-adapter/README.md) | Self-hosted | Open-source, CPU/GPU support | Requires backend setup |
+| [GPT Free](./packages/gptfree-adapter/README.md) | Unofficial | Uses other websites' GPT models | Unstable, may fail |
+| [ChatGLM](./packages/chatglm-adapter/README.md) | Self-hosted | Can be self-hosted | Requires backend, suboptimal performance |
+| [RWKV](./packages/rwkv-adapter/README.md) | Self-hosted | Open-source model | Requires backend setup |
+
+[Web search support](/packages/search-service/README.md):
+
+- Google (API)
+- Bing (API)
+- DuckDuckGO (Lite & Web)
+
+## Presets
+
+From `1.0.0-alpha.10`, we use YAML for more customizable presets. Default preset: [catgirl.yml](/packages/core/resources/presets/catgirl.yml)
+
+Preset folder: `<koishi_dir>/data/chathub/presets`
+
+For more info, see [preset system docs](https://chatluna.chat/guide/preset-system/introduction.html).
+
+## Development
+
+Clone the repo:
+
+```bash
+# yarn
+yarn clone ChatLunaLab/chatluna
+# npm
+npm run clone ChatLunaLab/chatluna
+```
+
+Update `tsconfig.json`:
+
+``` json
+{
+  "extends": "./tsconfig.base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "koishi-plugin-chatluna-*": ["external/chatluna/packages/*/src"]
+    }
+  }
+}
+```
+
+Build the project:
+
+``` bash
+# yarn
+yarn workspace @root/chatluna-koishi build
+# npm
+npm run build -w @root/chatluna-koishi
+```
+
+Start development with `yarn dev` or `npm run dev`.
+
+> Note: HMR may not be fully compatible. If issues occur, rebuild and restart.
+
+## Contributing
+
+We need help with:
+
+- [ ] Web UI
+- [ ] HTTP Server
+- [ ] Project Documentation
+
+PRs and discussions are welcome!
+
+## Contributors
+
+<a href="https://github.com/ChatLunaLab/chatluna/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ChatLunaLab/chatluna" />
+</a>
+
+![Alt](https://repobeats.axiom.co/api/embed/d92b5a9398ee02a797355ed9b866aa93231c25b3.svg "Repobeats analytics image")
+
+[![Star History Chart](https://api.star-history.com/svg?repos=ChatLunaLab/chatluna&type=Date)](https://star-history.com/#ChatLunaLab/chatluna)
+
+## Usage Notice
+
+Developed by [ChatLunaLab](https://github.com/ChatLunaLab).
+
+ChatLuna is an LLM-based chatbot framework. We collaborate with the open-source community to advance LLM technology. Users must comply with open-source agreements and avoid using this project for potentially harmful purposes or unevaluated services.
+
+This project doesn't provide AI services directly. Users must obtain API access from AI service providers.
+
+Users are responsible for complying with local laws and using locally available AI services.
+
+The project isn't responsible for algorithm-generated results. All results and operations are the user's responsibility.
+
+Users configure their own data storage. The project doesn't provide direct data storage.
+
+The project isn't liable for user-caused data security issues, public opinion risks, or model misuse.
+
+## Acknowledgments
+
+Thanks to these projects:
+
+[koishi-plugin-openai](https://github.com/TomLBZ/koishi-plugin-openai)
+
+[node-chatgpt-api](https://github.com/waylaidwanderer/node-chatgpt-api)
+
+[poe-api](https://github.com/ading2210/poe-api)
+
+[Bard](https://github.com/muhiris/wgpt)
+
+[chathub](https://github.com/chathub-dev/chathub)
+
+Thanks to [JetBrains](https://www.jetbrains.com/?from=ChatLuna) for open-source [WebStorm](https://www.jetbrains.com/webstorm/?from=ChatLuna) licenses.
+
+[<img src=".github/jetbrains-variant-3.png" width="200"/>](https://www.jetbrains.com/?from=ChatLuna)

package/lib/authorization/service.d.ts

@@ -0,0 +1,25 @@
+import { Context, Service, Session } from 'koishi';
+import { ChatHubAuthGroup, ChatHubAuthUser } from './types';
+export declare class ChatLunaAuthService extends Service {
+    readonly ctx: Context;
+    config: any;
+    constructor(ctx: Context, config: any);
+    getUser(session: Session, userId?: string): Promise<ChatHubAuthUser>;
+    private _createUser;
+    createAuthGroup(session: Session, group: ChatHubAuthGroup): Promise<void>;
+    resolveAuthGroup(session: Session, platform: string, userId?: string): Promise<ChatHubAuthGroup>;
+    getAuthGroups(platform?: string): Promise<ChatHubAuthGroup[]>;
+    getAuthGroup(name: string, throwError?: boolean): Promise<ChatHubAuthGroup>;
+    calculateBalance(session: Session, platform: string, usedTokenNumber: number, userId?: string): Promise<number>;
+    getBalance(session: Session, userId?: string): Promise<number>;
+    modifyBalance(session: Session, amount: number, userId?: string): Promise<number>;
+    setBalance(session: Session, amount: number, userId?: string): Promise<number>;
+    private _getAuthGroup;
+    resetAuthGroup(authGroupId: number): Promise<ChatHubAuthGroup>;
+    increaseAuthGroupCount(authGroupId: number): Promise<void>;
+    addUserToGroup(user: ChatHubAuthUser, groupName: string): Promise<void>;
+    removeUserFormGroup(user: ChatHubAuthUser, groupName: string): Promise<void>;
+    setAuthGroup(groupName: string, group: Partial<ChatHubAuthGroup>): Promise<void>;
+    private _initAuthGroup;
+    private _defineDatabase;
+}

package/lib/authorization/types.d.ts

@@ -0,0 +1,36 @@
+import { ChatLunaAuthService } from './service';
+export interface ChatHubAuthUser {
+    userId: string;
+    balance: number;
+    authType: AuthType;
+}
+export interface ChatHubAuthJoinedUser {
+    userId: string;
+    groupId: number;
+    groupName: string;
+    id: number;
+}
+export type AuthType = 'guest' | 'user' | 'admin';
+export interface ChatHubAuthGroup {
+    name: string;
+    platform?: string;
+    priority: number;
+    id: number;
+    limitPerMin: number;
+    limitPerDay: number;
+    costPerToken: number;
+    currentLimitPerMin?: number;
+    currentLimitPerDay?: number;
+    lastCallTime?: number;
+    supportModels: string[];
+}
+declare module 'koishi' {
+    interface Context {
+        chatluna_auth: ChatLunaAuthService;
+    }
+    interface Tables {
+        chathub_auth_group: ChatHubAuthGroup;
+        chathub_auth_user: ChatHubAuthUser;
+        chathub_auth_joined_user: ChatHubAuthJoinedUser;
+    }
+}

package/lib/cache.d.ts

@@ -0,0 +1,18 @@
+import { Tables } from '@koishijs/cache';
+import { Context } from 'koishi';
+import { Config } from './config';
+export declare class Cache<K extends keyof Tables, T extends Tables[K]> {
+    private ctx;
+    readonly config: Config;
+    readonly tableName: K;
+    constructor(ctx: Context, config: Config, tableName: K);
+    get(id: string): Promise<T>;
+    set(id: string, value: T): Promise<void>;
+    delete(id: string): Promise<void>;
+    clear(): Promise<void>;
+}
+declare module '@koishijs/cache' {
+    interface Tables {
+        'chathub/keys': string;
+    }
+}

package/lib/chains/chain.d.ts

@@ -0,0 +1,67 @@
+import { Context, h, Session } from 'koishi';
+import { Config } from '../config';
+import '../middlewares/lifecycle';
+/**
+ * ChatChain为消息的发送和接收提供了一个统一的中间提供交互
+ */
+export declare class ChatChain {
+    private readonly ctx;
+    private readonly config;
+    readonly _graph: ChatChainDependencyGraph;
+    private readonly _senders;
+    private isSetErrorMessage;
+    constructor(ctx: Context, config: Config);
+    receiveMessage(session: Session, ctx?: Context): Promise<boolean>;
+    receiveCommand(session: Session, command: string, options?: ChainMiddlewareContextOptions): Promise<boolean>;
+    middleware<T extends keyof ChainMiddlewareName>(name: T, middleware: ChainMiddlewareFunction, ctx?: Context): ChainMiddleware;
+    sender(sender: ChatChainSender): void;
+    private _runMiddleware;
+    private sendMessage;
+}
+declare class ChatChainDependencyGraph {
+    private _tasks;
+    private _dependencies;
+    private _eventEmitter;
+    private _listeners;
+    constructor();
+    addNode(middleware: ChainMiddleware): void;
+    removeNode(name: string): void;
+    once(name: string, listener: (...args: any[]) => void): void;
+    before(taskA: ChainMiddleware | string, taskB: ChainMiddleware | string): void;
+    after(taskA: ChainMiddleware | string, taskB: ChainMiddleware | string): void;
+    getDependencies(task: string): Set<string>;
+    getDependents(task: string): string[];
+    build(): ChainMiddleware[];
+}
+export declare class ChainMiddleware {
+    readonly name: string;
+    private readonly execute;
+    private readonly graph;
+    constructor(name: string, execute: ChainMiddlewareFunction, graph: ChatChainDependencyGraph);
+    before<T extends keyof ChainMiddlewareName>(name: T): this;
+    after<T extends keyof ChainMiddlewareName>(name: T): this;
+    run(session: Session, options: ChainMiddlewareContext): Promise<string | h[] | ChainMiddlewareRunStatus | h[][]>;
+}
+export interface ChainMiddlewareContext {
+    config: Config;
+    ctx: Context;
+    session: Session;
+    message: string | h[] | h[][];
+    options?: ChainMiddlewareContextOptions;
+    command?: string;
+    recallThinkingMessage?: () => Promise<void>;
+    send: (message: h[][] | h[] | h | string) => Promise<void>;
+}
+export interface ChainMiddlewareContextOptions {
+    [key: string]: any;
+}
+export interface ChainMiddlewareName {
+}
+export type ChainMiddlewareFunction = (session: Session, context: ChainMiddlewareContext) => Promise<string | h[] | h[][] | ChainMiddlewareRunStatus | null>;
+export type ChatChainSender = (session: Session, message: (h[] | h | string)[]) => Promise<void>;
+export declare enum ChainMiddlewareRunStatus {
+    SKIPPED = 0,
+    STOP = 1,
+    CONTINUE = 2
+}
+export {};