koishi-plugin-dify-ai 0.0.0-stage → 0.1.0

package/lib/api/client.d.ts

@@ -0,0 +1,59 @@
+import { Context } from 'koishi';
+import { ChatBlockingResponse, CompletionBlockingResponse, DifyAppInfo, DifyInputFileObject, DifyUploadFileResult, WorkflowBlockingResponse } from './types';
+/** 构造 DifyClient 所需的最小应用字段 */
+export interface DifyClientApp {
+    apiURL: string;
+    apiKey: string;
+}
+export declare class DifyClient {
+    private http;
+    private app;
+    private timeout;
+    constructor(http: Context['http'], app: DifyClientApp, timeout?: number);
+    private buildUrl;
+    private buildJsonHeaders;
+    private errorFrom;
+    /** 非 2xx 时抛出带状态码与 Dify 错误码的 DifyApiError */
+    private ensureOk;
+    /** blocking JSON 请求（本插件只用 blocking 模式） */
+    private request;
+    getAppInfo(): Promise<DifyAppInfo>;
+    getParameters(): Promise<any>;
+    /** chat / agent-chat / advanced-chat（conversation_id 传空串表示新建会话） */
+    runChat(body: {
+        inputs: Record<string, any>;
+        query: string;
+        response_mode: 'blocking';
+        user: string;
+        conversation_id?: string;
+        files?: DifyInputFileObject[];
+        auto_generate_name?: boolean;
+    }): Promise<ChatBlockingResponse>;
+    /** workflow 应用 */
+    runWorkflow(body: {
+        inputs: Record<string, any>;
+        response_mode: 'blocking';
+        user: string;
+        files?: DifyInputFileObject[];
+    }): Promise<WorkflowBlockingResponse>;
+    /** 文本生成应用 */
+    runCompletion(body: {
+        inputs: Record<string, any>;
+        response_mode: 'blocking';
+        user: string;
+        files?: DifyInputFileObject[];
+    }): Promise<CompletionBlockingResponse>;
+    deleteConversation(conversationId: string, user: string): Promise<any>;
+    uploadFile(file: {
+        data: Buffer | Uint8Array;
+        filename: string;
+        mime?: string;
+    }, user: string): Promise<DifyUploadFileResult>;
+}
+/**
+ * 构造客户端的统一入口：凭据缺失时记 warn 并返回 null，
+ * 调用方以此直接放弃本次操作。
+ */
+export declare function createDifyClient(ctx: Context, app: DifyClientApp & {
+    name?: string;
+}, timeout?: number): DifyClient | null;

package/lib/api/types.d.ts

@@ -0,0 +1,52 @@
+/** Dify 应用类型（GET /info 返回的 mode 字段） */
+export type DifyAppMode = 'chat' | 'agent-chat' | 'advanced-chat' | 'workflow' | 'completion';
+export interface DifyAppInfo {
+    name: string;
+    description?: string;
+    tags?: string[];
+    mode: DifyAppMode;
+    author_name?: string;
+}
+export interface DifyInputFileObject {
+    type: 'image' | 'document' | 'audio' | 'video' | 'custom';
+    transfer_method: 'remote_url' | 'local_file';
+    url?: string;
+    upload_file_id?: string;
+}
+/** workflow outputs 里的文件对象形态 */
+export interface DifyFilePayload {
+    url: string;
+    type?: string;
+}
+/** POST /chat-messages（blocking）：完整回复 + 会话 id */
+export interface ChatBlockingResponse {
+    answer: string;
+    conversation_id?: string;
+}
+/** POST /workflows/run（blocking）：结果都在 data 内 */
+export interface WorkflowBlockingResponse {
+    data: {
+        id?: string;
+        /** succeeded / failed / stopped / partial-succeeded / paused */
+        status?: string;
+        outputs?: Record<string, any> | null;
+        error?: string | null;
+        total_tokens?: number;
+    };
+}
+/** POST /completion-messages（blocking）：文本生成应用无会话概念 */
+export interface CompletionBlockingResponse {
+    answer: string;
+}
+export interface DifyUploadFileResult {
+    id: string;
+    name?: string;
+    mime_type?: string;
+    size?: number;
+    [key: string]: any;
+}
+export declare class DifyApiError extends Error {
+    status: number;
+    code: string;
+    constructor(message: string, status?: number, code?: string);
+}

package/lib/commands/app.d.ts

@@ -0,0 +1,4 @@
+import { Command, Context } from 'koishi';
+import { RequestRunner } from '../requester/runner';
+/** dify.app.* 管理命令（authority 3；koishi 子命令不继承父命令权限，需各自声明） */
+export declare function registerAppCommands(parent: Command, ctx: Context, runner: RequestRunner): void;

package/lib/commands/misc.d.ts

@@ -0,0 +1,4 @@
+import { Command } from 'koishi';
+import { ConversationStore } from '../state/conversation';
+/** dify.conv.reset 维护命令（authority 3） */
+export declare function registerMiscCommands(parent: Command, conversationStore: ConversationStore): void;

package/lib/commands/rule.d.ts

@@ -0,0 +1,4 @@
+import { Command, Context } from 'koishi';
+import { TriggerEngine } from '../trigger/engine';
+/** dify.rule.* 管理命令（authority 3）：规则以 JSON 导入维护 */
+export declare function registerRuleCommands(parent: Command, ctx: Context, engine: TriggerEngine): void;

package/lib/config.d.ts

@@ -0,0 +1,83 @@
+import { Schema } from 'koishi';
+import { DifyRule } from './types';
+export type AppTypeSetting = 'auto' | 'chat' | 'agent-chat' | 'advanced-chat' | 'workflow' | 'completion';
+export interface AppConfigEntry {
+    name: string;
+    /** 会话绑定用的稳定标识；留空回退应用名 */
+    appId: string;
+    apiURL: string;
+    apiKey: string;
+    appType: AppTypeSetting;
+}
+/** 条件的 union-tagged 形态：选择分支后仅出现该分支的字段 */
+export type ConditionEntry = {
+    type: 'keyword-prefix';
+    keywords: string;
+} | {
+    type: 'keyword-contains';
+    keywords: string;
+} | {
+    type: 'at-bot';
+} | {
+    type: 'at-user';
+    userIds: string;
+} | {
+    type: 'quote-bot';
+} | {
+    type: 'quote-user';
+    userIds: string;
+} | {
+    type: 'schedule';
+    cron?: string;
+    intervalMinutes?: number;
+} | {
+    type: 'density';
+    densityCount?: number;
+    densityWindowSeconds?: number;
+};
+/** 变量映射的条件分支形态：先选来源分支，再填该分支的字段（历史消息是会话字段下的一项） */
+export type VariableEntry = {
+    source: 'session';
+    field: string;
+    key: string;
+    limit?: number;
+} | {
+    source: 'meta';
+    field: string;
+    key: string;
+};
+/** 作用域的一行：维度 + 值 */
+export interface ScopeRow {
+    dimension: string;
+    value: string;
+}
+export interface RuleEntry {
+    name: string;
+    enabled: boolean;
+    priority: number;
+    app: string;
+    conversationScope: string;
+    conditions: ConditionEntry[];
+    scope: ScopeRow[];
+    variables: VariableEntry[];
+}
+export interface Config {
+    apps: AppConfigEntry[];
+    rules: RuleEntry[];
+    parseElements: boolean;
+    quoteTrigger: boolean;
+    maxSegmentLength: number;
+    uploadFiles: boolean;
+    requestTimeout: number;
+    historyLimit: number;
+    sendErrors: boolean;
+}
+export declare const Config: Schema<Config>;
+/**
+ * 配置规范化：应用表 + 按优先级降序的规则列表。
+ * 坏条件/无名变量直接丢弃；引用不存在应用的规则保留但运行时会 warn 跳过。
+ */
+export declare function normalizeConfig(config: Config): {
+    apps: Map<string, AppConfigEntry>;
+    rules: DifyRule[];
+};

package/lib/history.d.ts

@@ -0,0 +1,41 @@
+import { Session } from 'koishi';
+/** 被引用消息的呈现所需字段（无消息 ID，与格式规范一致） */
+export interface QuotedMessage {
+    timestamp: number;
+    userId: string;
+    username: string;
+    content: string;
+}
+export interface HistoryEntry {
+    role: 'user' | 'assistant';
+    userId: string;
+    username: string;
+    messageId?: string;
+    /** 纯文本 + 图片占位符 */
+    content: string;
+    timestamp: number;
+    quote?: QuotedMessage;
+}
+/**
+ * 统一消息格式（历史消息变量 / 定时摘要 / 密度触发共用）：
+ * `[时间] 昵称 (用户ID) [msg:消息ID]（引用了 [时间] 昵称 (用户ID) 说：内容）说：内容`
+ * 引用段与外层同构但不展示消息 ID；无引用则整段省略。
+ */
+export declare function formatHistoryEntry(entry: HistoryEntry): string;
+/** 多条消息逐行拼接 */
+export declare function formatHistoryEntries(entries: HistoryEntry[]): string;
+/** 从会话消息构造记录条目（历史缓冲 / 密度窗口 / 定时窗口共用） */
+export declare function buildHistoryEntry(session: Session, role?: 'user' | 'assistant'): HistoryEntry | null;
+/**
+ * 每个频道在内存中保留最近消息（含 bot 自己的回复），
+ * 供「历史消息注入」变量与密度触发使用。重启后清空，属可接受损耗。
+ */
+export declare class MessageHistory {
+    limit: number;
+    private buffers;
+    constructor(limit?: number);
+    recordEntry(channelKey: string, entry: HistoryEntry): void;
+    get(channelKey: string, limit?: number): HistoryEntry[];
+    /** 序列化为统一消息格式的逐行拼接（变量值即完整聊天记录文本） */
+    toVariable(entries: HistoryEntry[]): string;
+}

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+import { Context } from 'koishi';
+import { Config } from './config';
+export declare const name = "dify-ai";
+export declare const inject: {
+    required: string[];
+};
+export { Config };
+export declare function apply(ctx: Context, config: Config): void;