@ai_mind/ade-plugin-sdk 0.0.0-stage → 0.1.1

package/types/api.d.ts

@@ -0,0 +1,207 @@
+// 由 sdk/scripts/sync-types.mjs 从 ADE 宿主生成，请勿手工修改。
+import type { PluginCommandContext, PluginConfig, PluginInstallRequest } from './plugins.js';
+import type { AdeSettingsFile, AgentSettingInfo, AoneBoardData, AoneBoardRequest, AoneCreateField, AoneCreateRequest, AoneStatus, AoneUpdateRequest, AoneWorkItem, AoneWorkItemDetail, ChatApprovalResponse, ChatAdapterInfo, ChatAttachment, ChatAttachmentKind, ChatSessionInfo, ChatSessionRecord, CliModelOption, CliOption, CopiedEntry, DingTalkBlockWriteResult, DingTalkDocDownloadFormat, DingTalkDocItem, DingTalkDownloadResult, DingTalkJsonmlDocument, DingTalkJsonmlInput, DingTalkJsonmlReadOptions, DingTalkJsonmlWriteResult, DingTalkMinutesItem, DingTalkStatus, DingTalkUploadFolderNode, DingTalkUploadResult, DingTalkUploadJob, DingTalkUploadTarget, DingTalkUploadWorkspace, FileNode, FileStat, LogEntry, LogFilter, PluginInfo, Project, SettingsPatch, StructuredEvent, Worktree } from './ade-types.js';
+export interface ChatEvent {
+    id: string;
+    data?: string;
+    code?: number;
+    message?: string;
+    info?: ChatSessionInfo;
+    record?: ChatSessionRecord;
+}
+declare const api: {
+    projects: {
+        list: () => Promise<Project[]>;
+        add: (dir: string) => Promise<Project>;
+        remove: (dir: string) => Promise<void>;
+        touch: (dir: string) => Promise<void>;
+        pickDirectory: (title?: string, defaultPath?: string) => Promise<string | null>;
+        pickMarkdownFile: () => Promise<string | null>;
+    };
+    worktrees: {
+        list: (projectPath: string) => Promise<Worktree[]>;
+        create: (projectPath: string, taskName: string) => Promise<Worktree[]>;
+        remove: (projectPath: string, worktreePath: string) => Promise<Worktree[]>;
+    };
+    files: {
+        tree: (dir: string) => Promise<FileNode[]>;
+        read: (filePath: string) => Promise<string>;
+        readBinary: (filePath: string) => Promise<ArrayBuffer>;
+        write: (filePath: string, content: string) => Promise<void>;
+        isMarkdown: (filePath: string) => Promise<boolean>;
+        stat: (filePath: string) => Promise<FileStat>;
+        /** 过滤出确实存在的普通文件（清理持久化的历史标签页用） */
+        filterExisting: (filePaths: string[]) => Promise<string[]>;
+        watch: (filePath: string, callback: () => void) => (() => void);
+        createFile: (dir: string, name: string) => Promise<void>;
+        createDir: (dir: string, name: string) => Promise<void>;
+        rename: (oldPath: string, newName: string, clipboardPaths?: string[]) => Promise<string>;
+        /** 复制到目标目录；同名时自动使用「副本」命名，返回实际创建的条目 */
+        copy: (sourcePaths: string[], targetDir: string) => Promise<CopiedEntry[]>;
+        /** 把文件列表写进系统剪贴板（Finder / 资源管理器可以直接粘贴）；自动剔除不存在的路径 */
+        writeClipboard: (sourcePaths: string[]) => Promise<void>;
+        /** 读取系统剪贴板里的文件列表（Finder / 资源管理器复制的文件，或绝对路径文本） */
+        readClipboard: () => Promise<string[]>;
+        trash: (filePath: string) => Promise<void>;
+        reveal: (filePath: string) => Promise<void>;
+        openExternal: (filePath: string) => Promise<void>;
+        /** Electron 32+ 不再提供 File.path；只暴露单个用户拖入文件的本地路径。 */
+        pathForFile: (file: File) => string;
+    };
+    chat: {
+        listAdapters: () => Promise<ChatAdapterInfo[]>;
+        listSessions: () => Promise<ChatSessionInfo[]>;
+        listHistory: () => Promise<ChatSessionRecord[]>;
+        syncProjectHistory: (projectPath: string, cwdPaths: string[]) => Promise<ChatSessionRecord[]>;
+        getRecord: (id: string) => Promise<ChatSessionRecord | undefined>;
+        pickAttachments: (kinds?: ChatAttachmentKind[]) => Promise<ChatAttachment[]>;
+        adapterOptions: (adapterId: string, refresh?: boolean) => Promise<CliOption[]>;
+        adapterModels: (adapterId: string, refresh?: boolean) => Promise<CliModelOption[]>;
+        updateConfig: (id: string, config: Record<string, string>) => Promise<void>;
+        start: (adapterId: string, cwd: string, worktree: string, config?: Record<string, string>, projectPath?: string | null) => Promise<ChatSessionRecord>;
+        write: (id: string, data: string) => Promise<void>;
+        resize: (id: string, cols: number, rows: number) => Promise<void>;
+        sendMessage: (id: string, prompt: string, attachments?: ChatAttachment[]) => Promise<void>;
+        switchView: (id: string, view: "terminal" | "chat") => Promise<void>;
+        stop: (id: string) => Promise<void>;
+        cancelTurn: (id: string) => Promise<void>;
+        activate: (id: string) => Promise<void>;
+        rename: (id: string, name: string) => Promise<void>;
+        touch: (id: string) => Promise<void>;
+        deleteHistory: (id: string) => Promise<void>;
+        deleteHistories: (ids: string[]) => Promise<void>;
+        respondApproval: (id: string, requestId: string, response: ChatApprovalResponse) => Promise<void>;
+        onData: (cb: (e: ChatEvent) => void) => (() => void);
+        onEvent: (cb: (e: {
+            id: string;
+            event: StructuredEvent;
+        }) => void) => (() => void);
+        onInfo: (cb: (e: {
+            id: string;
+            info: ChatSessionInfo;
+        }) => void) => (() => void);
+        onRecord: (cb: (e: {
+            id: string;
+            record: ChatSessionRecord;
+        }) => void) => (() => void);
+        onExit: (cb: (e: ChatEvent) => void) => (() => void);
+        onError: (cb: (e: ChatEvent) => void) => (() => void);
+        onStopped: (cb: (e: ChatEvent) => void) => (() => void);
+        onDeleted: (cb: (e: ChatEvent) => void) => (() => void);
+    };
+    app: {
+        getVersion: () => Promise<string>;
+        copyText: (text: string) => Promise<void>;
+        closeWindow: () => Promise<void>;
+        onCloseTab: (cb: () => void) => (() => void);
+        openDownload: (url: string) => Promise<void>;
+        checkUpdate: () => Promise<void>;
+        getUpdateStatus: () => Promise<unknown>;
+        installUpdate: () => Promise<void>;
+        onUpdateStatus: (cb: (status: unknown) => void) => (() => void);
+    };
+    daemon: {
+        getInfo: () => Promise<{
+            serverId: string;
+            publicKeyB64: string;
+            relay: {
+                enabled: boolean;
+                endpoint: string;
+                useTls: boolean;
+                offerBaseUrl: string;
+                status: string;
+            };
+            offerUrl: string;
+            configPath: string;
+        }>;
+        updateRelay: (config: {
+            enabled: boolean;
+            endpoint: string;
+            useTls: boolean;
+            offerBaseUrl: string;
+        }) => Promise<unknown>;
+    };
+    plugins: {
+        list: () => Promise<PluginInfo[]>;
+        exportSdk: () => Promise<string | null>;
+        pick: (source: "directory" | "zip") => Promise<string | null>;
+        install: (request: PluginInstallRequest) => Promise<PluginInfo>;
+        setEnabled: (id: string, enabled: boolean) => Promise<void>;
+        uninstall: (id: string) => Promise<void>;
+        getConfig: (id: string) => Promise<PluginConfig>;
+        setConfig: (id: string, patch: PluginConfig) => Promise<PluginConfig>;
+        executeCommand: (id: string, command: string, args?: unknown, context?: PluginCommandContext) => Promise<unknown>;
+        invokeService: (id: string, name: string, method: string, args?: unknown[]) => Promise<unknown>;
+        onChanged: (cb: (plugins: PluginInfo[]) => void) => (() => void);
+    };
+    settings: {
+        get: () => Promise<AdeSettingsFile>;
+        set: (patch: SettingsPatch) => Promise<AdeSettingsFile>;
+        listAgents: () => Promise<AgentSettingInfo[]>;
+        onChanged: (cb: (file: AdeSettingsFile) => void) => (() => void);
+    };
+    dingtalk: {
+        getUploadJob: (filePath: string) => Promise<DingTalkUploadJob | null>;
+        runUploadJob: (request: {
+            filePath: string;
+            title?: string;
+            folder?: string;
+            workspace?: string;
+            nodeId?: string;
+        }, retry?: boolean) => Promise<DingTalkUploadJob>;
+        getStatus: () => Promise<DingTalkStatus>;
+        login: () => Promise<{
+            started: boolean;
+        }>;
+        restartWukong: () => Promise<{
+            restarted: boolean;
+            message: string;
+        }>;
+        searchDocs: (query: string, source?: "recent" | "mine") => Promise<DingTalkDocItem[]>;
+        listMinutes: (query: string) => Promise<DingTalkMinutesItem[]>;
+        previewDoc: (node: string, preferredName?: string) => Promise<DingTalkDownloadResult>;
+        downloadDoc: (node: string, targetDir: string, format?: DingTalkDocDownloadFormat, preferredName?: string) => Promise<DingTalkDownloadResult>;
+        downloadMinutes: (taskUuid: string, targetDir: string, outputName?: string, format?: "dingmin" | "markdown") => Promise<DingTalkDownloadResult>;
+        uploadMarkdown: (filePath: string, title: string, folder: string, workspace: string) => Promise<DingTalkUploadResult>;
+        listUploadWorkspaces: () => Promise<DingTalkUploadWorkspace[]>;
+        listUploadFolders: (workspaceId: string, parentNodeId?: string) => Promise<DingTalkUploadFolderNode[]>;
+        resolveUploadTarget: (input: string) => Promise<DingTalkUploadTarget>;
+        listUploadDocs: (workspaceId: string, parentNodeId?: string) => Promise<DingTalkUploadFolderNode[]>;
+        overwriteDoc: (nodeId: string, filePath: string) => Promise<DingTalkUploadResult>;
+        readDocJsonml: (nodeId: string, options?: DingTalkJsonmlReadOptions) => Promise<DingTalkJsonmlDocument>;
+        overwriteDocJsonml: (nodeId: string, input: DingTalkJsonmlInput) => Promise<DingTalkJsonmlWriteResult>;
+        createDocWithJsonml: (name: string, input: DingTalkJsonmlInput, location?: {
+            folder?: string;
+            workspace?: string;
+        }) => Promise<DingTalkJsonmlWriteResult>;
+        listDocBlockElements: (nodeId: string, options?: {
+            startIndex?: number;
+            contentFormat?: "element" | "jsonml";
+        }) => Promise<unknown[]>;
+        updateDocBlock: (nodeId: string, blockId: string, element: unknown) => Promise<DingTalkBlockWriteResult>;
+        insertDocBlock: (nodeId: string, index: number, element: unknown) => Promise<DingTalkBlockWriteResult>;
+    };
+    aone: {
+        getStatus: () => Promise<AoneStatus>;
+        loadBoard: (request: AoneBoardRequest) => Promise<AoneBoardData>;
+        getWorkItem: (id: string) => Promise<AoneWorkItemDetail>;
+        getCreateFields: (projectId: string, typeId: string) => Promise<AoneCreateField[]>;
+        createWorkItem: (request: AoneCreateRequest) => Promise<AoneWorkItem>;
+        updateWorkItem: (request: AoneUpdateRequest) => Promise<void>;
+        createComment: (id: string, message: string) => Promise<void>;
+        changeRelation: (action: "add" | "remove", id: string, relationType: string, target: string) => Promise<void>;
+        pickAttachment: () => Promise<string | null>;
+        uploadAttachment: (id: string, projectId: string, filePath: string) => Promise<void>;
+        downloadAttachment: (id: string, attachmentId: string, suggestedName: string) => Promise<string | null>;
+        deleteAttachment: (id: string, attachmentId: string) => Promise<void>;
+    };
+    logs: {
+        list: (filter?: LogFilter) => Promise<LogEntry[]>;
+        scopes: () => Promise<string[]>;
+        clear: () => Promise<boolean>;
+        dir: () => Promise<string>;
+        summary: () => Promise<string>;
+    };
+};
+export type AdeApi = typeof api;
+export {};

package/types/plugins.d.ts

@@ -0,0 +1,85 @@
+/** ADE 插件 API 版本；独立于应用版本。 */
+export const PLUGIN_API_VERSION = 1
+
+export type PluginConfig = Record<string, string | number | boolean>
+export interface PluginSetting {
+  type: 'string' | 'number' | 'boolean' | 'select'
+  label: string
+  description?: string
+  default?: string | number | boolean
+  options?: { value: string; label: string }[]
+  min?: number
+  max?: number
+  multiline?: boolean
+  secret?: boolean
+}
+export type PluginSettingsSchema = Record<string, PluginSetting>
+
+export interface PluginManifest {
+  /** 旧插件沿用合法 name，其他旧名称生成稳定 ID。新插件应显式声明小写 ID。 */
+  id?: string
+  name: string
+  version: string
+  description?: string
+  apiVersion?: number
+  /** 目标 ADE 主版本；只约束 major，插件自身 version 独立。缺省兼容旧插件。 */
+  adeMajor?: number
+  defaultEnabled?: boolean
+  main?: string
+  renderer?: string
+  rendererFormat?: 'module' | 'register'
+  styles?: string[]
+  settings?: PluginSettingsSchema
+  adapters?: {
+    id: string
+    label: string
+    description?: string
+    kind: 'terminal' | 'sdk'
+    command?: string
+  }[]
+}
+
+export interface PluginInfo {
+  id: string
+  name: string
+  version: string
+  description?: string
+  path: string
+  enabled: boolean
+  builtin: boolean
+  status: 'disabled' | 'loading' | 'active' | 'error'
+  error?: string
+  adapters: string[]
+  revision: number
+  rendererUrl?: string
+  rendererFormat?: 'module' | 'register'
+  styleUrls?: string[]
+  settingsSchema: PluginSettingsSchema
+  config: PluginConfig
+}
+
+export interface PluginInstallRequest {
+  source: 'directory' | 'zip' | 'npm' | 'git'
+  location: string
+}
+
+export interface PluginCommandContext {
+  projectPath: string | null
+  worktreePath: string | null
+  filePath: string | null
+}
+
+export interface PluginViewInfo {
+  id: string
+  title: string
+  defaultVisible?: boolean
+  defaultSize?: number
+  minSize?: number
+  maxSize?: number
+  order?: number
+}
+
+export type PluginDisposer = () => void | Promise<void>
+
+/** 内置扩展位置，也允许插件定义自己的子 slot。 */
+export type PluginSlotName = 'statusBar.left' | 'statusBar.right' | 'editor.toolbar' | 'settings' | (string & {})