@vibe-forge/core 0.3.0 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibe-forge/core",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "imports": {
     "#~/*.js": {
       "__vibe-forge__": {
@@ -22,22 +22,22 @@
         "require": "./dist/index.js"
       }
     },
-    "./utils/*": {
+    "./adapter": {
       "__vibe-forge__": {
-        "default": "./src/utils/*.ts"
+        "default": "./src/adapter/index.ts"
       },
       "default": {
-        "import": "./dist/utils/*.mjs",
-        "require": "./dist/utils/*.js"
+        "import": "./dist/adapter.mjs",
+        "require": "./dist/adapter.js"
       }
     },
-    "./controllers/task": {
+    "./channel": {
       "__vibe-forge__": {
-        "default": "./src/controllers/task/index.ts"
+        "default": "./src/channel.ts"
       },
       "default": {
-        "import": "./dist/controllers/task/index.mjs",
-        "require": "./dist/controllers/task/index.js"
+        "import": "./dist/channel.mjs",
+        "require": "./dist/channel.js"
       }
     },
     "./schema": {
@@ -57,7 +57,26 @@
         "import": "./dist/hooks/index.mjs",
         "require": "./dist/hooks/index.js"
       }
-    }
+    },
+    "./utils/*": {
+      "__vibe-forge__": {
+        "default": "./src/utils/*.ts"
+      },
+      "default": {
+        "import": "./dist/utils/*.mjs",
+        "require": "./dist/utils/*.js"
+      }
+    },
+    "./controllers/*": {
+      "__vibe-forge__": {
+        "default": "./src/controllers/*/index.ts"
+      },
+      "default": {
+        "import": "./dist/controllers/*/index.mjs",
+        "require": "./dist/controllers/*/index.js"
+      }
+    },
+    "./package.json": "./package.json"
   },
   "dependencies": {
     "fast-glob": "^3.3.3",

package/src/adapter/type.ts

@@ -10,7 +10,7 @@ export type AdapterOutputEvent =
   | { type: 'init'; data: SessionInitInfo }
   | { type: 'summary'; data: SessionSummaryInfo }
   | { type: 'message'; data: ChatMessage }
-  | { type: 'exit'; data: { exitCode: number | null; stderr?: string } }
+  | { type: 'exit'; data: { exitCode?: number; stderr?: string } }
   | { type: 'stop'; data?: ChatMessage }
 
 export type SessionInfo =
@@ -66,6 +66,7 @@ export interface AdapterQueryOptions {
 
   systemPrompt?: string
   appendSystemPrompt?: boolean
+  permissionMode?: 'default' | 'acceptEdits' | 'plan' | 'dontAsk' | 'bypassPermissions'
 
   mcpServers?: {
     include?: string[]
@@ -85,6 +86,10 @@ export interface AdapterQueryOptions {
   onEvent: (event: AdapterOutputEvent) => void
 }
 
+export interface AdapterInitOptions {
+  force?: boolean
+}
+
 export interface AdapterSession {
   kill: () => void
   emit: (event: AdapterEvent) => void
@@ -92,6 +97,10 @@ export interface AdapterSession {
 }
 
 export interface Adapter {
+  init?: (
+    ctx: AdapterCtx,
+    options: AdapterInitOptions
+  ) => Promise<void>
   query: (
     ctx: AdapterCtx,
     options: AdapterQueryOptions

package/src/channel.ts

@@ -0,0 +1,132 @@
+import { z } from 'zod'
+
+export interface ChannelMap {}
+
+export type ChannelType = keyof ChannelMap
+
+export const channelAccessSchema = z.object({
+  // 管理员
+  admins: z.array(z.string()).optional().describe(
+    '频道管理员账号（sender ID），管理员拥有管理操作权限且不受以下访问控制限制'
+  ),
+  // 会话类型控制
+  allowPrivateChat: z.boolean().optional().describe('是否允许私聊消息，默认 true'),
+  allowGroupChat: z.boolean().optional().describe('是否允许群聊消息，默认 true'),
+  // 群组访问控制
+  allowedGroups: z.array(z.string()).optional().describe('群组白名单（channel ID），设置后仅在指定群中响应'),
+  blockedGroups: z.array(z.string()).optional().describe('群组黑名单（channel ID），在指定群中不响应'),
+  // 用户访问控制
+  allowedSenders: z.array(z.string()).optional().describe('发送者白名单（sender ID），设置后仅白名单内的用户可交互'),
+  blockedSenders: z.array(z.string()).optional().describe('发送者黑名单（sender ID），黑名单内的用户消息将被忽略')
+})
+
+export type ChannelAccessConfig = z.infer<typeof channelAccessSchema>
+
+export const channelBaseSchema = z.object({
+  // 基础配置
+  type: z
+    .string().min(1)
+    .describe('频道类型'),
+  title: z
+    .string().optional()
+    .describe('频道标题'),
+  description: z
+    .string().optional()
+    .describe('频道说明'),
+  enabled: z
+    .boolean().optional()
+    .describe('是否启用'),
+  // 会话行为
+  systemPrompt: z
+    .string().optional()
+    .describe('在此频道启动会话时注入的系统提示词'),
+  // 访问权限控制
+  access: channelAccessSchema
+    .optional()
+    .describe('频道访问权限配置')
+})
+
+export type ChannelBaseConfig = z.infer<typeof channelBaseSchema>
+
+export type ChannelConfigByType<K extends ChannelType> = ChannelBaseConfig & { type: K } & ChannelMap[K]
+
+export type ChannelConfig = {
+  [K in ChannelType]: ChannelConfigByType<K>
+}[ChannelType]
+
+export interface ChannelConnection<TMessage> {
+  sendMessage: (message: TMessage) => Promise<void>
+  startReceiving?: (options: {
+    handlers: ChannelEventHandlers
+  }) => Promise<void>
+  /**
+   * Called when a new session is being created for this channel.
+   * The channel implementation can use this to inject channel-specific context
+   * (e.g. bot profile fetched from platform API) into the system prompt.
+   */
+  generateSystemPrompt?: (inbound: ChannelInboundEvent) => Promise<string | undefined>
+  close?: () => Promise<void>
+}
+
+export interface ChannelLogger {
+  error: (...msg: unknown[]) => void | Promise<void>
+  warn: (...msg: unknown[]) => void | Promise<void>
+  info: (...msg: unknown[]) => void | Promise<void>
+  debug: (...msg: unknown[]) => void | Promise<void>
+  trace: (...msg: unknown[]) => void | Promise<void>
+}
+
+export interface ChannelConnectionOptions {
+  logger?: ChannelLogger
+}
+
+export interface ChannelInboundEvent {
+  channelType: string
+  sessionType: string
+  channelId: string
+  senderId?: string
+  messageId?: string
+  text?: string
+  replyTo?: {
+    receiveId: string
+    receiveIdType: string
+  }
+  ack?: () => Promise<void>
+  unack?: () => Promise<void>
+  raw: unknown
+}
+
+export type ChannelEventHandler<TPayload = unknown> = (payload: TPayload) => void | Promise<void>
+
+export interface ChannelEventHandlers {
+  message?: ChannelEventHandler<ChannelInboundEvent>
+  [event: string]: ChannelEventHandler | ChannelEventHandler<ChannelInboundEvent> | undefined
+}
+
+export interface ChannelDescriptor<
+  TConfigSchema extends z.ZodTypeAny = z.ZodTypeAny,
+  TMessageSchema extends z.ZodTypeAny = z.ZodTypeAny,
+> {
+  type: string
+  label: string
+  description?: string
+  configSchema: TConfigSchema
+  messageSchema: TMessageSchema
+}
+
+export const defineChannelDescriptor = <TConfigSchema extends z.ZodTypeAny, TMessageSchema extends z.ZodTypeAny>(
+  descriptor: ChannelDescriptor<TConfigSchema, TMessageSchema>
+) => descriptor
+
+export const defineChannel = <TConfigSchema extends z.ZodTypeAny, TMessageSchema extends z.ZodTypeAny>(
+  descriptor: ChannelDescriptor<TConfigSchema, TMessageSchema>
+) => descriptor
+
+export type ChannelCreateFn<TConfig = unknown, TMessage = unknown> = (
+  config: TConfig,
+  options?: ChannelConnectionOptions
+) => Promise<ChannelConnection<TMessage>>
+
+export const defineCreateChannelConnection = <TConfigSchema extends z.ZodTypeAny, TMessageSchema extends z.ZodTypeAny>(
+  connect: ChannelCreateFn<z.infer<TConfigSchema>, z.infer<TMessageSchema>>
+): ChannelCreateFn<z.infer<TConfigSchema>, z.infer<TMessageSchema>> => connect

package/src/config/load.ts

@@ -0,0 +1,122 @@
+import { existsSync } from 'node:fs'
+import { readFile } from 'node:fs/promises'
+import { resolve } from 'node:path'
+import process from 'node:process'
+
+import { load } from 'js-yaml'
+
+import type { AdapterMap, Config } from './types'
+
+const loadJSConfig = async (paths: string[]) => {
+  for (const path of paths) {
+    try {
+      const configPath = resolve(process.cwd(), path)
+      if (!existsSync(configPath)) {
+        continue
+      }
+      // eslint-disable-next-line ts/no-require-imports
+      return (require(configPath)?.default ?? {}) as Config
+    } catch (e) {
+      console.error(`Failed to load config file ${path}: ${e}`)
+    }
+  }
+}
+
+const loadJSONConfig = async (paths: string[], jsonVariables: Record<string, string | null | undefined>) => {
+  for (const path of paths) {
+    try {
+      const configPath = resolve(process.cwd(), path)
+      if (!existsSync(configPath)) {
+        continue
+      }
+      const configContent = await readFile(configPath, 'utf-8')
+      const configResolvedContent = configContent
+        .replace(/\$\{(\w+)\}/g, (_, key) => jsonVariables[key] ?? `$\{${key}}`)
+      return JSON.parse(configResolvedContent) as Config
+    } catch (e) {
+      console.error(`Failed to load config file ${path}: ${e}`)
+    }
+  }
+}
+
+const loadYAMLConfig = async (paths: string[], jsonVariables: Record<string, string | null | undefined>) => {
+  for (const path of paths) {
+    try {
+      const configPath = resolve(process.cwd(), path)
+      if (!existsSync(configPath)) {
+        continue
+      }
+      const configContent = await readFile(configPath, 'utf-8')
+      const configResolvedContent = configContent
+        .replace(/\$\{(\w+)\}/g, (_, key) => jsonVariables[key] ?? `$\{${key}}`)
+      return load(configResolvedContent) as Config
+    } catch (e) {
+      console.error(`Failed to load config file ${path}: ${e}`)
+    }
+  }
+}
+
+let configCache: Promise<readonly [Config | undefined, Config | undefined]> | null = null
+
+export const resetConfigCache = () => {
+  configCache = null
+}
+
+export const loadConfig = (options: {
+  jsonVariables?: Record<string, string | null | undefined>
+}) => {
+  if (configCache) {
+    return configCache
+  }
+
+  configCache = (async () =>
+    [
+      await loadJSONConfig(
+        [
+          './.ai.config.json',
+          './infra/.ai.config.json'
+        ],
+        options.jsonVariables ?? {}
+      ) ??
+        await loadYAMLConfig(
+          [
+            './.ai.config.yaml',
+            './.ai.config.yml',
+            './infra/.ai.config.yaml',
+            './infra/.ai.config.yml'
+          ],
+          options.jsonVariables ?? {}
+        ),
+      await loadJSONConfig(
+        [
+          './.ai.dev.config.json',
+          './infra/.ai.dev.config.json'
+        ],
+        options.jsonVariables ?? {}
+      ) ??
+        await loadYAMLConfig(
+          [
+            './.ai.dev.config.yaml',
+            './.ai.dev.config.yml',
+            './infra/.ai.dev.config.yaml',
+            './infra/.ai.dev.config.yml'
+          ],
+          options.jsonVariables ?? {}
+        )
+    ] as const)()
+  return configCache
+}
+
+export const loadAdapterConfig = async <
+  K extends keyof AdapterMap,
+>(
+  name: K,
+  options: { jsonVariables?: Record<string, string> }
+) => {
+  const [projectConfig, userConfig] = await loadConfig(options)
+  return {
+    ...(projectConfig?.adapters?.[name] ?? {}),
+    ...(userConfig?.adapters?.[name] ?? {})
+  } as unknown as NonNullable<Config['adapters']>[K]
+}
+

package/src/config/types.ts

@@ -0,0 +1,269 @@
+import type { ChannelConfig } from '../channel'
+import type { PluginConfig } from '../hooks'
+
+export interface AdapterMap {}
+
+export interface AdapterBuiltinModel {
+  value: string
+  title: string
+  description: string
+}
+
+export interface ModelServiceConfig {
+  /**
+   * 模型服务展示标题
+   */
+  title?: string
+  /**
+   * 模型服务展示描述
+   */
+  description?: string
+  /**
+   * 模型服务 API 基础 URL
+   */
+  apiBaseUrl: string
+  /**
+   * 模型服务 API 密钥
+   */
+  apiKey: string
+  /**
+   * 模型服务支持的模型列表
+   */
+  models?: string[]
+  /**
+   * 模型服务支持的模型别名
+   */
+  modelsAlias?: Record<string, string[]>
+  /**
+   * 拓展配置，由下游自行消费
+   */
+  extra?: Record<string, unknown>
+}
+
+export interface RecommendedModelConfig {
+  service?: string
+  model: string
+  title?: string
+  description?: string
+  placement?: 'modelSelector'
+}
+
+export type LanguageCode = 'zh' | 'en'
+
+export type NotificationTrigger = 'completed' | 'failed' | 'terminated' | 'waiting_input'
+
+export interface NotificationEventConfig {
+  title?: string
+  description?: string
+  disabled?: boolean
+  sound?: string
+}
+
+export interface NotificationConfig {
+  disabled?: boolean
+  volume?: number
+  events?: Partial<Record<NotificationTrigger, NotificationEventConfig>>
+}
+
+export interface Config {
+  /**
+   * 配置目录
+   */
+  baseDir?: string
+  /**
+   * 适配器配置
+   */
+  adapters?: Partial<AdapterMap>
+  /**
+   * 默认适配器名称
+   */
+  defaultAdapter?: keyof AdapterMap
+  /**
+   * 模型服务配置
+   */
+  modelServices?: Record<string, ModelServiceConfig>
+  /**
+   * 频道配置
+   */
+  channels?: Record<string, ChannelConfig>
+  /**
+   * 默认模型服务名称
+   */
+  defaultModelService?: string
+  /**
+   * 默认模型名称
+   */
+  defaultModel?: string
+  recommendedModels?: RecommendedModelConfig[]
+  interfaceLanguage?: LanguageCode
+  modelLanguage?: LanguageCode
+  /**
+   * MCP 服务器配置
+   */
+  mcpServers?: Record<
+    string,
+    & {
+      /**
+       * 是否启用
+       */
+      enabled?: boolean
+      /**
+       * 环境变量配置
+       */
+      env?: Record<string, string>
+    }
+    & (
+      | {
+        type?: undefined
+        command: string
+        args: string[]
+      }
+      | {
+        type: 'sse'
+        url: string
+        headers: Record<string, string>
+      }
+      | {
+        type: 'http'
+        url: string
+        headers?: Record<string, string>
+      }
+    )
+  >
+  /**
+   * 默认启用的 MCP 服务器列表
+   */
+  defaultIncludeMcpServers?: string[]
+  /**
+   * 默认禁用的 MCP 服务器列表
+   */
+  defaultExcludeMcpServers?: string[]
+  noDefaultVibeForgeMcpServer?: boolean
+  /**
+   * 权限配置
+   */
+  permissions?: {
+    allow?: string[]
+    deny?: string[]
+    ask?: string[]
+    defaultMode?: 'default' | 'acceptEdits' | 'plan' | 'dontAsk' | 'bypassPermissions'
+  }
+  /**
+   * 环境变量配置
+   */
+  env?: Record<string, string>
+  /**
+   * 公告配置
+   */
+  announcements?: string[]
+  /**
+   * 快捷键配置
+   */
+  shortcuts?: {
+    newSession?: string
+    openConfig?: string
+  }
+  notifications?: NotificationConfig
+  /**
+   * 会话配置
+   */
+  conversation?: {
+    /**
+     * 对话风格
+     * - `friendly`: 友好的对话风格，适合用户与助手交互
+     * - `programmatic`: 程序化的对话风格，适合助手执行任务
+     */
+    style?: 'friendly' | 'programmatic'
+    /**
+     * 自定义对话风格。通过指定提示词约束对话风格。
+     */
+    customInstructions?: string
+  }
+  /**
+   * 插件配置
+   */
+  plugins?: PluginConfig
+  enabledPlugins?: Record<string, boolean>
+  extraKnownMarketplaces?: Record<
+    string,
+    {
+      source:
+        | {
+          source: 'github'
+          repo: string
+        }
+        | {
+          source: 'git'
+          url: string
+        }
+        | {
+          source: 'directory'
+          path: string
+        }
+    }
+  >
+}
+
+export interface AboutInfo {
+  version?: string
+  lastReleaseAt?: string
+  urls?: {
+    repo?: string
+    docs?: string
+    contact?: string
+    issues?: string
+    releases?: string
+  }
+}
+
+export interface ConfigSection {
+  general?: {
+    baseDir?: Config['baseDir']
+    defaultAdapter?: Config['defaultAdapter']
+    defaultModelService?: Config['defaultModelService']
+    defaultModel?: Config['defaultModel']
+    recommendedModels?: Config['recommendedModels']
+    interfaceLanguage?: Config['interfaceLanguage']
+    modelLanguage?: Config['modelLanguage']
+    announcements?: Config['announcements']
+    permissions?: Config['permissions']
+    env?: Config['env']
+    notifications?: Config['notifications']
+  }
+  conversation?: Config['conversation']
+  modelServices?: Config['modelServices']
+  channels?: Config['channels']
+  adapters?: Config['adapters']
+  adapterBuiltinModels?: Record<string, AdapterBuiltinModel[]>
+  plugins?: {
+    plugins?: Config['plugins']
+    enabledPlugins?: Config['enabledPlugins']
+    extraKnownMarketplaces?: Config['extraKnownMarketplaces']
+  }
+  mcp?: {
+    mcpServers?: Config['mcpServers']
+    defaultIncludeMcpServers?: Config['defaultIncludeMcpServers']
+    defaultExcludeMcpServers?: Config['defaultExcludeMcpServers']
+    noDefaultVibeForgeMcpServer?: Config['noDefaultVibeForgeMcpServer']
+  }
+  shortcuts?: Config['shortcuts']
+}
+
+export interface ConfigResponse {
+  sources?: {
+    project?: ConfigSection
+    user?: ConfigSection
+    merged?: ConfigSection
+  }
+  meta?: {
+    workspaceFolder?: string
+    configPresent?: {
+      project?: boolean
+      user?: boolean
+    }
+    experiments?: Record<string, unknown>
+    about?: AboutInfo
+  }
+}
+
+export const defineConfig = (config: Config) => config