koishi-plugin-media-luna 0.0.1

package/lib/api/README.md

@@ -0,0 +1,643 @@
+# Media Luna WebSocket API 文档
+
+所有 API 通过 Koishi Console WebSocket 调用，使用 `send()` 方法。
+
+## 调用方式
+
+```typescript
+import { send } from '@koishijs/client'
+
+const result = await send('media-luna/channels/list')
+if (result.success) {
+  console.log(result.data)
+} else {
+  console.error(result.error)
+}
+```
+
+## 响应格式
+
+所有 API 返回统一格式：
+
+```typescript
+interface ApiResponse<T> {
+  success: boolean
+  data?: T
+  error?: string
+}
+```
+
+---
+
+## 渠道管理 API (channel-api.ts)
+
+### `media-luna/channels/list`
+获取所有渠道列表。
+
+**参数**：无
+
+**返回**：`ChannelConfig[]`
+
+---
+
+### `media-luna/channels/get`
+获取单个渠道详情。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 渠道 ID |
+
+**返回**：`ChannelConfig`
+
+---
+
+### `media-luna/channels/create`
+创建新渠道。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | string | 是 | 渠道名称（唯一） |
+| displayName | string | 否 | 显示名称 |
+| connectorId | string | 是 | 连接器 ID |
+| connectorConfig | object | 否 | 连接器配置 |
+| tags | string[] | 否 | 标签列表 |
+| enabled | boolean | 否 | 是否启用（默认 true） |
+
+**返回**：`ChannelConfig`
+
+---
+
+### `media-luna/channels/update`
+更新渠道。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 渠道 ID |
+| data | object | 是 | 更新的字段 |
+
+**返回**：`ChannelConfig`
+
+---
+
+### `media-luna/channels/delete`
+删除渠道。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 渠道 ID |
+
+**返回**：无
+
+---
+
+### `media-luna/channels/toggle`
+切换渠道启用状态。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 渠道 ID |
+| enabled | boolean | 是 | 是否启用 |
+
+**返回**：无
+
+---
+
+### `media-luna/channels/tags`
+获取所有渠道标签。
+
+**参数**：无
+
+**返回**：`string[]`
+
+---
+
+### `media-luna/channels/by-tags`
+根据标签筛选渠道。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| tags | string[] | 是 | 标签列表 |
+| matchAll | boolean | 否 | 是否匹配全部标签（默认 false） |
+
+**返回**：`ChannelConfig[]`
+
+---
+
+## 预设管理 API (preset-api.ts)
+
+### `media-luna/presets/list`
+获取预设列表。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| enabledOnly | boolean | 否 | 仅返回启用的预设 |
+
+**返回**：`PresetData[]`
+
+---
+
+### `media-luna/presets/get`
+获取单个预设。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 预设 ID |
+
+**返回**：`PresetData`
+
+---
+
+### `media-luna/presets/create`
+创建预设。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | string | 是 | 预设名称（唯一） |
+| displayName | string | 否 | 显示名称 |
+| promptTemplate | string | 是 | 提示词模板 |
+| tags | string[] | 否 | 标签列表 |
+| referenceImages | string[] | 否 | 参考图片 URL |
+| parameterOverrides | object | 否 | 参数覆盖 |
+| source | string | 否 | 来源（user/api） |
+| enabled | boolean | 否 | 是否启用 |
+
+**返回**：`PresetData`
+
+---
+
+### `media-luna/presets/update`
+更新预设。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 预设 ID |
+| data | object | 是 | 更新的字段 |
+
+**返回**：`PresetData`
+
+---
+
+### `media-luna/presets/delete`
+删除预设。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 预设 ID |
+
+**返回**：无
+
+---
+
+### `media-luna/presets/toggle`
+切换预设启用状态。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 预设 ID |
+| enabled | boolean | 是 | 是否启用 |
+
+**返回**：无
+
+---
+
+### `media-luna/presets/tags`
+获取所有预设标签。
+
+**参数**：无
+
+**返回**：`string[]`
+
+---
+
+### `media-luna/presets/by-tags`
+根据标签筛选预设。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| tags | string[] | 是 | 标签列表 |
+| matchAll | boolean | 否 | 是否匹配全部标签 |
+
+**返回**：`PresetData[]`
+
+---
+
+### `media-luna/presets/matching`
+获取与渠道匹配的预设（通过渠道标签匹配）。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| channelId | number | 是 | 渠道 ID |
+
+**返回**：`PresetData[]`
+
+---
+
+### `media-luna/presets/copy`
+复制预设。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 预设 ID |
+
+**返回**：`PresetData`（新创建的副本）
+
+---
+
+## 任务管理 API (task-api.ts)
+
+### `media-luna/tasks/list`
+获取任务列表（分页）。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| userId | number | 否 | 用户 ID 筛选 |
+| channelId | number | 否 | 渠道 ID 筛选 |
+| status | string | 否 | 状态筛选（pending/processing/success/failed） |
+| limit | number | 否 | 每页数量（默认 50，最大 100） |
+| offset | number | 否 | 偏移量 |
+
+**返回**：
+```typescript
+{
+  items: TaskData[]
+  total: number
+  limit: number
+  offset: number
+}
+```
+
+---
+
+### `media-luna/tasks/get`
+获取任务详情。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 任务 ID |
+
+**返回**：`TaskData`
+
+---
+
+### `media-luna/tasks/delete`
+删除任务。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | number | 是 | 任务 ID |
+
+**返回**：无
+
+---
+
+### `media-luna/tasks/stats`
+获取任务统计。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| channelId | number | 否 | 渠道 ID（可选筛选） |
+
+**返回**：
+```typescript
+{
+  total: number
+  byStatus: {
+    pending: number
+    processing: number
+    success: number
+    failed: number
+  }
+  successRate: string  // 例如 "85.50%"
+}
+```
+
+---
+
+### `media-luna/tasks/cleanup`
+清理旧任务。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| days | number | 否 | 保留天数（默认 30，最小 1） |
+
+**返回**：
+```typescript
+{
+  deleted: number
+  beforeDate: string  // ISO 日期字符串
+}
+```
+
+---
+
+### `media-luna/tasks/recent`
+获取用户最近任务。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| userId | number | 是 | 用户 ID |
+| limit | number | 否 | 数量（默认 10，最大 100） |
+
+**返回**：`TaskData[]`
+
+---
+
+## 中间件管理 API (middleware-api.ts)
+
+### `media-luna/middlewares/list`
+获取所有中间件及其配置。
+
+**参数**：无
+
+**返回**：
+```typescript
+Array<{
+  name: string
+  displayName: string
+  description: string
+  category: string
+  phase: string
+  configSchema: object | null
+  enabled: boolean
+  config: object
+}>
+```
+
+---
+
+### `media-luna/middlewares/get`
+获取单个中间件配置。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | string | 是 | 中间件名称 |
+
+**返回**：
+```typescript
+{
+  name: string
+  displayName: string
+  description: string
+  category: string
+  phase: string
+  before: string[]
+  after: string[]
+  configSchema: object | null
+  enabled: boolean
+  config: object
+}
+```
+
+---
+
+### `media-luna/middlewares/update`
+更新中间件配置。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | string | 是 | 中间件名称 |
+| data.enabled | boolean | 否 | 是否启用 |
+| data.config | object | 否 | 配置对象 |
+
+**返回**：无
+
+---
+
+### `media-luna/middlewares/reset`
+重置中间件配置为默认值。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | string | 是 | 中间件名称 |
+
+**返回**：无
+
+---
+
+### `media-luna/middlewares/execution-order`
+获取中间件执行顺序（拓扑排序结果）。
+
+**参数**：无
+
+**返回**：
+```typescript
+Array<{
+  level: number           // 执行层级
+  parallel: boolean       // 该层是否可并行
+  middlewares: Array<{
+    name: string
+    displayName: string
+    phase: string
+    category: string
+  }>
+}>
+```
+
+---
+
+## 连接器查询 API (connector-api.ts)
+
+### `media-luna/connectors/list`
+获取已注册连接器列表。
+
+**参数**：无
+
+**返回**：
+```typescript
+Array<{
+  id: string
+  name: string
+  supportedTypes: string[]
+}>
+```
+
+---
+
+### `media-luna/connectors/get`
+获取单个连接器详情。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | string | 是 | 连接器 ID |
+
+**返回**：
+```typescript
+{
+  id: string
+  name: string
+  supportedTypes: string[]
+  fields: FieldDefinition[]
+}
+```
+
+---
+
+### `media-luna/connectors/fields`
+获取连接器配置字段定义。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| id | string | 是 | 连接器 ID |
+
+**返回**：`FieldDefinition[]`
+
+---
+
+### `media-luna/connectors/schema`
+获取所有连接器 Schema（用于动态表单）。
+
+**参数**：无
+
+**返回**：连接器摘要列表
+
+---
+
+## 生成 API (generate-api.ts)
+
+### `media-luna/generate`
+执行图片生成任务。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| channel | number | 是 | 渠道 ID |
+| prompt | string | 是 | 用户提示词 |
+| files | FileData[] | 否 | 附件文件 |
+| parameters | object | 否 | 额外参数 |
+| parameters.preset | string | 否 | 预设名称 |
+| userId | number | 否 | 用户 ID |
+
+**返回**：`GenerationResult`
+
+---
+
+### `media-luna/generate/preview`
+预览生成参数（不实际执行）。
+
+**参数**：
+| 字段 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| channel | number | 是 | 渠道 ID |
+| prompt | string | 是 | 用户提示词 |
+| parameters | object | 否 | 额外参数 |
+
+**返回**：
+```typescript
+{
+  channelName: string
+  connectorId: string
+  finalPrompt: string
+  parameters: object
+}
+```
+
+---
+
+## 类型定义
+
+### ChannelConfig
+```typescript
+interface ChannelConfig {
+  id: number
+  name: string
+  displayName: string
+  connectorId: string
+  connectorConfig: Record<string, any>
+  tags: string[]
+  enabled: boolean
+}
+```
+
+### PresetData
+```typescript
+interface PresetData {
+  id: number
+  name: string
+  displayName: string
+  promptTemplate: string
+  tags: string[]
+  referenceImages: string[]
+  parameterOverrides: Record<string, any>
+  source: 'user' | 'api'
+  enabled: boolean
+}
+```
+
+### TaskData
+```typescript
+interface TaskData {
+  id: number
+  userId: number
+  channelId: number
+  presetId: number | null
+  prompt: string
+  finalPrompt: string
+  status: 'pending' | 'processing' | 'success' | 'failed'
+  result: string | null
+  error: string | null
+  duration: number | null
+  createdAt: Date
+  updatedAt: Date
+}
+```
+
+### GenerationResult
+```typescript
+interface GenerationResult {
+  success: boolean
+  taskId?: number
+  images?: string[]
+  duration?: number
+  error?: string
+}
+```
+
+### FileData
+```typescript
+interface FileData {
+  type: 'image' | 'audio' | 'video' | 'file'
+  url?: string
+  base64?: string
+  mimeType?: string
+  filename?: string
+}
+```
+
+### FieldDefinition
+```typescript
+interface FieldDefinition {
+  key: string
+  label: string
+  type: 'string' | 'number' | 'boolean' | 'select' | 'textarea'
+  required?: boolean
+  default?: any
+  options?: Array<{ label: string; value: any }>
+  description?: string
+}
+```

package/lib/api/cache-api.d.ts

@@ -0,0 +1,6 @@
+import { Context } from 'koishi';
+/**
+ * 注册缓存管理 API
+ */
+export declare function registerCacheApi(ctx: Context): void;
+//# sourceMappingURL=cache-api.d.ts.map

package/lib/api/cache-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-api.d.ts","sourceRoot":"","sources":["../../src/api/cache-api.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEhC;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CA0JnD"}