@xyit/wellspring 0.0.0-stage → 1.0.0

package/src/plugin/models-service.ts

@@ -0,0 +1,383 @@
+/*
+ * 宿主模型服务：给 sandbox 插件提供自定义供应商与模型切换。
+ *
+ * 配置写在 app-setting.json 的 models 节（每次调用实时读写，改完下一轮对话生效），
+ * 每个供应商的 Key 写在 credentials.json；状态只返回掩码。
+ */
+
+import type { Logger } from "pino"
+
+import type {
+    HostModelProvider,
+    HostModelProviderInput,
+    HostModelsApi,
+    HostModelsFetchResult,
+    HostModelsState,
+    HostModelsStateResult,
+} from "../api/host/models.ts"
+import { CONFIG_CODES } from "../config/codes.ts"
+import {
+    clearProviderApiKey,
+    credentialsFile,
+    normalizeApiKey,
+    providerKeyStatusSync,
+    saveProviderApiKey,
+} from "../config/credentials.ts"
+import { DEFAULT_SETTINGS } from "../config/defaults.ts"
+import { REASONING_LEVELS, type ReasoningLevel } from "../config/types.ts"
+import { loadSettings, saveSettings, SETTING_FILE_NAME } from "../config/loader.ts"
+import {
+    BUILTIN_PROVIDER_ID,
+    listModelProviders,
+    modelsSetting,
+    providerApiKey,
+} from "../config/providers.ts"
+import type { AppSetting, ModelProviderSetting } from "../config/types.ts"
+import { OpenAIClient } from "../network/openai.ts"
+import { createProxyFetch } from "../network/proxy.ts"
+
+export interface HostModelsServiceOptions {
+    readonly settings: AppSetting
+    /** app-setting.json 的绝对路径 */
+    readonly settingsFile: string
+    /** 凭据文件所在 config 目录 */
+    readonly configDir: string
+    readonly logger: Logger
+}
+
+export interface HostModelsService extends HostModelsApi {
+    state(): Promise<HostModelsState>
+}
+
+const PROVIDER_ID = /^[a-z0-9][a-z0-9._-]{0,31}$/
+const MAX_MODEL_CHARS = 120
+
+function normalizeModels(value: readonly string[] | undefined): string[] {
+    const models: string[] = []
+    for (const item of value ?? []) {
+        if (typeof item !== "string") {
+            continue
+        }
+        const model = item.trim()
+        if (model === "" || model.length > MAX_MODEL_CHARS || models.includes(model)) {
+            continue
+        }
+        models.push(model)
+    }
+    return models
+}
+
+function slugOf(name: string): string {
+    const slug = name
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "-")
+        .replace(/^-+|-+$/g, "")
+        .slice(0, 32)
+    return PROVIDER_ID.test(slug) ? slug : "provider"
+}
+
+function uniqueId(base: string, taken: ReadonlySet<string>): string {
+    if (!taken.has(base) && base !== BUILTIN_PROVIDER_ID) {
+        return base
+    }
+    for (let index = 2; index < 100; index += 1) {
+        const candidate = `${base}-${index}`
+        if (
+            !taken.has(candidate) &&
+            candidate !== BUILTIN_PROVIDER_ID &&
+            PROVIDER_ID.test(candidate)
+        ) {
+            return candidate
+        }
+    }
+    return `provider-${Date.now().toString(36)}`
+}
+
+export function createHostModelsService(options: HostModelsServiceOptions): HostModelsService {
+    const logger = options.logger.child({ module: "models" })
+    const settingsFile = options.settingsFile
+    const credentialsPath = credentialsFile(options.configDir)
+
+    const currentSettings = async (): Promise<AppSetting> => {
+        const loaded = await loadSettings(settingsFile)
+        return loaded.getData() ?? options.settings ?? DEFAULT_SETTINGS
+    }
+
+    const stateOf = (settings: AppSetting): HostModelsState => {
+        const models = modelsSetting(settings)
+        const providers: HostModelProvider[] = listModelProviders(settings).map((provider) => {
+            const key = providerKeyStatusSync(
+                { id: provider.id, apiKeyEnv: provider.apiKeyEnv },
+                credentialsPath,
+            )
+            return {
+                id: provider.id,
+                name: provider.name,
+                baseUrl: provider.baseUrl,
+                models: provider.models,
+                defaultModel: provider.defaultModel,
+                apiKeyEnv: provider.apiKeyEnv,
+                builtin: provider.builtin,
+                keyConfigured: key.configured,
+                keySource: key.source,
+                keyMasked: key.masked,
+                envVar: key.envVar,
+                keyStored: key.stored,
+            }
+        })
+        const activeProvider = providers.some((provider) => provider.id === models.activeProvider)
+            ? models.activeProvider
+            : BUILTIN_PROVIDER_ID
+        return {
+            providers,
+            activeProvider,
+            activeModel: models.activeModel,
+            activeReasoning: models.activeReasoning,
+            reasoningLevels: REASONING_LEVELS,
+        }
+    }
+
+    const saveProviderConfig = async (
+        settings: AppSetting,
+        provider: ModelProviderSetting,
+    ): Promise<HostModelsStateResult> => {
+        const models = modelsSetting(settings)
+        const providers = [...models.providers]
+        const index = providers.findIndex((item) => item.id === provider.id)
+        if (index === -1) {
+            if (providers.length >= 20) {
+                return { ok: false, code: "models.too-many-providers", state: stateOf(settings) }
+            }
+            providers.push(provider)
+        } else {
+            providers[index] = provider
+        }
+        const next: AppSetting = {
+            ...settings,
+            models: { ...models, providers },
+        }
+        const saved = await saveSettings(next, settingsFile)
+        if (!saved.isSuccess()) {
+            return {
+                ok: false,
+                code: saved.getCode() ?? CONFIG_CODES.invalid,
+                state: stateOf(settings),
+            }
+        }
+        return { ok: true, state: stateOf(next) }
+    }
+
+    const fail = async (code: string): Promise<HostModelsStateResult> => ({
+        ok: false,
+        code,
+        state: stateOf(await currentSettings()),
+    })
+
+    return {
+        async state(): Promise<HostModelsState> {
+            return stateOf(await currentSettings())
+        },
+
+        async setActive(
+            providerId: string,
+            model: string | null,
+            reasoning?: string | null,
+        ): Promise<HostModelsState> {
+            const settings = await currentSettings()
+            const models = modelsSetting(settings)
+            const id = providerId.trim()
+            const exists = listModelProviders(settings).some((provider) => provider.id === id)
+            if (!exists) {
+                throw new Error("models.provider-not-found")
+            }
+            const nextModel = typeof model === "string" && model.trim() !== "" ? model.trim() : null
+            if (nextModel !== null && nextModel.length > MAX_MODEL_CHARS) {
+                throw new Error("models.invalid-model")
+            }
+            const nextReasoning =
+                typeof reasoning === "string" && reasoning.trim() !== ""
+                    ? reasoning.trim()
+                    : models.activeReasoning
+            if (!(REASONING_LEVELS as readonly string[]).includes(nextReasoning)) {
+                throw new Error("models.invalid-reasoning")
+            }
+            const next: AppSetting = {
+                ...settings,
+                models: {
+                    ...models,
+                    activeProvider: id,
+                    activeModel: nextModel,
+                    activeReasoning: nextReasoning as ReasoningLevel,
+                },
+            }
+            const saved = await saveSettings(next, settingsFile)
+            if (!saved.isSuccess()) {
+                throw new Error(saved.getCode() ?? CONFIG_CODES.invalid)
+            }
+            logger.info({ provider: id, model: nextModel, reasoning: nextReasoning }, "切换模型")
+            return stateOf(next)
+        },
+
+        async saveProvider(input: HostModelProviderInput): Promise<HostModelsStateResult> {
+            const settings = await currentSettings()
+            const models = modelsSetting(settings)
+            const name = typeof input.name === "string" ? input.name.trim() : ""
+            if (name === "" || name.length > 60) {
+                return await fail(CONFIG_CODES.invalid)
+            }
+            const explicitId =
+                typeof input.id === "string" && input.id.trim() !== "" ? input.id.trim() : ""
+            const taken = new Set(models.providers.map((provider) => provider.id))
+            let id = explicitId
+            if (id === "") {
+                id = uniqueId(slugOf(name), taken)
+            } else if (!PROVIDER_ID.test(id) || id === BUILTIN_PROVIDER_ID) {
+                return await fail(CONFIG_CODES.invalid)
+            }
+            const apiKey =
+                typeof input.apiKey === "string" && input.apiKey.trim() !== ""
+                    ? normalizeApiKey(input.apiKey)
+                    : null
+            if (typeof input.apiKey === "string" && input.apiKey.trim() !== "" && apiKey === null) {
+                return { ok: false, code: CONFIG_CODES.invalidApiKey, state: stateOf(settings) }
+            }
+            const rawBaseUrl = input.baseUrl
+            const baseUrl =
+                typeof rawBaseUrl === "string" && rawBaseUrl.trim() !== ""
+                    ? rawBaseUrl.trim()
+                    : null
+            const provider: ModelProviderSetting = {
+                id,
+                name,
+                baseUrl,
+                models: normalizeModels(input.models),
+                defaultModel:
+                    typeof input.defaultModel === "string" && input.defaultModel.trim() !== ""
+                        ? input.defaultModel.trim()
+                        : null,
+                apiKeyEnv:
+                    typeof input.apiKeyEnv === "string" && input.apiKeyEnv.trim() !== ""
+                        ? input.apiKeyEnv.trim()
+                        : null,
+            }
+            const result = await saveProviderConfig(settings, provider)
+            if (!result.ok) {
+                return result
+            }
+            if (apiKey !== null) {
+                const keyed = await saveProviderApiKey(id, apiKey, credentialsPath)
+                if (!keyed.isSuccess()) {
+                    return await fail(keyed.getCode() ?? CONFIG_CODES.credentialsWriteFailed)
+                }
+            }
+            return { ok: true, state: stateOf(await currentSettings()) }
+        },
+
+        async removeProvider(id: string): Promise<HostModelsStateResult> {
+            const settings = await currentSettings()
+            const models = modelsSetting(settings)
+            if (id === BUILTIN_PROVIDER_ID) {
+                return await fail("models.builtin-provider")
+            }
+            const providers = models.providers.filter((provider) => provider.id !== id)
+            if (providers.length === models.providers.length) {
+                return await fail("models.provider-not-found")
+            }
+            const next: AppSetting = {
+                ...settings,
+                models: {
+                    ...models,
+                    providers,
+                    activeProvider:
+                        models.activeProvider === id ? BUILTIN_PROVIDER_ID : models.activeProvider,
+                    activeModel: models.activeProvider === id ? null : models.activeModel,
+                },
+            }
+            const saved = await saveSettings(next, settingsFile)
+            if (!saved.isSuccess()) {
+                return await fail(saved.getCode() ?? CONFIG_CODES.invalid)
+            }
+            await clearProviderApiKey(id, credentialsPath)
+            logger.info({ provider: id }, "删除自定义供应商")
+            return { ok: true, state: stateOf(next) }
+        },
+
+        async fetchModels(id: string, candidate?: string): Promise<HostModelsFetchResult> {
+            const settings = await currentSettings()
+            const provider = listModelProviders(settings).find((item) => item.id === id)
+            if (provider === undefined) {
+                return { ok: false, code: "models.provider-not-found" }
+            }
+            let apiKey: string | undefined
+            if (typeof candidate === "string" && candidate.trim() !== "") {
+                const normalized = normalizeApiKey(candidate)
+                if (normalized === null) {
+                    return { ok: false, code: CONFIG_CODES.invalidApiKey }
+                }
+                apiKey = normalized
+            } else {
+                apiKey = providerApiKey(provider, options.configDir) ?? undefined
+            }
+            if (apiKey === undefined) {
+                return { ok: false, code: "openai.missing-api-key" }
+            }
+            let proxyFetch: ReturnType<typeof createProxyFetch> | undefined
+            try {
+                proxyFetch = createProxyFetch(settings.network.proxy)
+            } catch {
+                proxyFetch = undefined
+            }
+            const created = OpenAIClient.create({
+                settings: {
+                    ...settings.openai,
+                    baseUrl: provider.baseUrl,
+                    model: provider.defaultModel ?? provider.models[0] ?? settings.openai.model,
+                },
+                apiKey,
+                credentialsFile: credentialsPath,
+                logger,
+                fetch: proxyFetch,
+            })
+            const client = created.getData()
+            if (!created.isSuccess() || client === null) {
+                return { ok: false, code: created.getCode() ?? "openai.missing-api-key" }
+            }
+            const listed = await client.listModels()
+            const data = listed.getData()
+            if (!listed.isSuccess() || data === null) {
+                return { ok: false, code: listed.getCode() ?? "openai.request-failed" }
+            }
+            return { ok: true, models: data }
+        },
+
+        async saveKey(id: string, apiKey: string): Promise<HostModelsStateResult> {
+            const settings = await currentSettings()
+            const exists = listModelProviders(settings).some((provider) => provider.id === id)
+            if (!exists) {
+                return await fail("models.provider-not-found")
+            }
+            const saved = await saveProviderApiKey(id, apiKey, credentialsPath)
+            if (!saved.isSuccess()) {
+                return {
+                    ok: false,
+                    code: saved.getCode() ?? CONFIG_CODES.invalidApiKey,
+                    state: stateOf(settings),
+                }
+            }
+            return { ok: true, state: stateOf(settings) }
+        },
+
+        async clearKey(id: string): Promise<HostModelsState> {
+            const settings = await currentSettings()
+            const exists = listModelProviders(settings).some((provider) => provider.id === id)
+            if (!exists) {
+                throw new Error("models.provider-not-found")
+            }
+            const cleared = await clearProviderApiKey(id, credentialsPath)
+            if (!cleared.isSuccess()) {
+                throw new Error(cleared.getCode() ?? CONFIG_CODES.credentialsWriteFailed)
+            }
+            return stateOf(settings)
+        },
+    }
+}

package/src/plugin/network-service.ts

@@ -0,0 +1,102 @@
+/*
+ * 宿主网络配置服务：读写 app-setting.json 的 network.proxy。
+ *
+ * 只写这一个字段，其余配置原样保留；写入前经过 validateSettings，
+ * 非法 URL / noProxy 不会落盘。模型调用、拉模型、网页搜索每轮都会重新读配置，
+ * 所以保存后不需要重启服务，下一轮请求生效。
+ */
+
+import type { Logger } from "pino"
+
+import type { HostNetworkApi, HostNetworkResult, HostNetworkState } from "../api/host/network.ts"
+import { CONFIG_CODES, invalidCode } from "../config/codes.ts"
+import { loadSettings, saveSettings } from "../config/loader.ts"
+import type { AppSetting, ProxySetting } from "../config/types.ts"
+
+const MAX_NO_PROXY = 100
+const MAX_NO_PROXY_LENGTH = 256
+
+export interface HostNetworkServiceOptions {
+    /** 启动时的配置；配置文件不存在或读取失败时回退到它 */
+    readonly settings: AppSetting
+    readonly settingsFile: string
+    readonly logger?: Logger
+}
+
+function isHttpUrl(value: string): boolean {
+    try {
+        const url = new URL(value)
+        return url.protocol === "http:" || url.protocol === "https:"
+    } catch {
+        return false
+    }
+}
+
+/** 去空、去重、限长，避免把超大/空白的 noProxy 写进配置 */
+function normalizeNoProxy(values: readonly string[] | undefined): string[] {
+    const result: string[] = []
+    for (const raw of values ?? []) {
+        if (typeof raw !== "string") continue
+        const value = raw.trim()
+        if (value === "" || value.length > MAX_NO_PROXY_LENGTH) continue
+        if (result.includes(value)) continue
+        if (result.length >= MAX_NO_PROXY) break
+        result.push(value)
+    }
+    return result
+}
+
+export function createHostNetworkService(options: HostNetworkServiceOptions): HostNetworkApi {
+    const currentSettings = async (): Promise<AppSetting> => {
+        try {
+            const loaded = await loadSettings(options.settingsFile)
+            return loaded.getData() ?? options.settings
+        } catch {
+            return options.settings
+        }
+    }
+
+    const stateOf = (settings: AppSetting): HostNetworkState => ({
+        proxy: settings.network.proxy,
+    })
+
+    return {
+        async state(): Promise<HostNetworkState> {
+            return stateOf(await currentSettings())
+        },
+
+        async saveProxy(input): Promise<HostNetworkResult> {
+            const settings = await currentSettings()
+            const rawUrl = typeof input.url === "string" ? input.url.trim() : ""
+            if (rawUrl !== "" && !isHttpUrl(rawUrl)) {
+                return {
+                    ok: false,
+                    code: invalidCode("network.proxy.url"),
+                    state: stateOf(settings),
+                }
+            }
+            let proxy: ProxySetting | null = null
+            if (rawUrl !== "") {
+                proxy = {
+                    type: "http",
+                    url: rawUrl,
+                    noProxy: normalizeNoProxy(input.noProxy),
+                }
+            }
+            const next: AppSetting = { ...settings, network: { proxy } }
+            const saved = await saveSettings(next, options.settingsFile)
+            if (!saved.isSuccess()) {
+                return {
+                    ok: false,
+                    code: saved.getCode() ?? CONFIG_CODES.invalid,
+                    state: stateOf(settings),
+                }
+            }
+            options.logger?.info(
+                { proxy: proxy?.url ?? null, noProxy: proxy?.noProxy ?? [] },
+                proxy === null ? "已关闭 HTTP 代理" : "已更新 HTTP 代理",
+            )
+            return { ok: true, state: stateOf(next) }
+        },
+    }
+}

package/src/plugin/paths.ts

@@ -0,0 +1,19 @@
+/*
+ * 插件目录与命名规则。
+ */
+
+import { join } from "node:path"
+
+import { getPaths, type ResolvedPaths } from "../platform/path.ts"
+
+/** 插件目录名/包名：字母数字开头，允许 . _ -，最长 64 */
+export const PLUGIN_NAME = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/
+
+/** 插件根目录：<dataDir>/plugins */
+export function pluginsRoot(paths: ResolvedPaths = getPaths()): string {
+    return join(paths.dataDir, "plugins")
+}
+
+export function isValidPluginName(name: string): boolean {
+    return PLUGIN_NAME.test(name)
+}

package/src/plugin/registry.ts

@@ -0,0 +1,103 @@
+/*
+ * 插件命令注册表。
+ * 内置命令保留，插件命令挂在顶级；重名拒绝，别名同样参与冲突检查。
+ */
+
+import type { PluginCommand } from "../api/host/plugin.ts"
+
+/** 内置命令名，插件不可占用 */
+export const RESERVED_COMMANDS: ReadonlySet<string> = new Set([
+    "chat",
+    "run",
+    "session",
+    "config",
+    "plugin",
+    "doctor",
+    "version",
+    "help",
+])
+
+const COMMAND_NAME = /^[a-z][a-z0-9-]*$/
+
+export interface RegisteredPluginCommand {
+    readonly pluginName: string
+    readonly command: PluginCommand
+}
+
+export class PluginRegistry {
+    readonly #reserved: ReadonlySet<string>
+    readonly #commands = new Map<string, RegisteredPluginCommand>()
+    readonly #aliases = new Map<string, RegisteredPluginCommand>()
+    readonly #pluginNames = new Set<string>()
+
+    constructor(reserved: ReadonlySet<string> = RESERVED_COMMANDS) {
+        this.#reserved = reserved
+    }
+
+    /** 注册插件命令；非法、保留名或重名时抛错 */
+    register(pluginName: string, command: PluginCommand): void {
+        if (
+            !COMMAND_NAME.test(command.name) ||
+            command.name.length < 2 ||
+            command.name.length > 32
+        ) {
+            throw new Error(`插件命令名不合法：${command.name}`)
+        }
+        if (this.#reserved.has(command.name)) {
+            throw new Error(`插件不能覆盖内置命令：${command.name}`)
+        }
+        if (this.#commands.has(command.name) || this.#aliases.has(command.name)) {
+            throw new Error(`插件命令重名：${command.name}`)
+        }
+        if (typeof command.summary !== "string" || command.summary.trim() === "") {
+            throw new Error(`插件命令缺少 summary：${command.name}`)
+        }
+        if (typeof command.run !== "function") {
+            throw new Error(`插件命令缺少 run：${command.name}`)
+        }
+
+        const record: RegisteredPluginCommand = { pluginName, command }
+        this.#commands.set(command.name, record)
+        this.#pluginNames.add(pluginName)
+
+        for (const alias of command.aliases ?? []) {
+            if (!COMMAND_NAME.test(alias) || alias.length < 2 || alias.length > 32) {
+                throw new Error(`插件命令别名不合法：${alias}`)
+            }
+            if (
+                this.#reserved.has(alias) ||
+                this.#commands.has(alias) ||
+                this.#aliases.has(alias)
+            ) {
+                throw new Error(`插件命令别名冲突：${alias}`)
+            }
+            this.#aliases.set(alias, record)
+        }
+    }
+
+    resolve(name: string): RegisteredPluginCommand | undefined {
+        return this.#commands.get(name) ?? this.#aliases.get(name)
+    }
+
+    list(): readonly RegisteredPluginCommand[] {
+        return [...this.#commands.values()]
+    }
+
+    removePlugin(pluginName: string): void {
+        for (const [name, record] of this.#commands) {
+            if (record.pluginName === pluginName) {
+                this.#commands.delete(name)
+            }
+        }
+        for (const [alias, record] of this.#aliases) {
+            if (record.pluginName === pluginName) {
+                this.#aliases.delete(alias)
+            }
+        }
+        this.#pluginNames.delete(pluginName)
+    }
+
+    pluginNames(): readonly string[] {
+        return [...this.#pluginNames]
+    }
+}

package/src/plugin/runtime.ts

@@ -0,0 +1,57 @@
+/*
+ * 插件运行时目录：
+ * - 数据：<dataDir>/plugin-data/<id>/
+ * - 配置：<configDir>/plugins/<id>.json（插件自己的 JSON 配置）
+ */
+
+import { join } from "node:path"
+
+import type { PluginConfig } from "../api/host/plugin.ts"
+import { ensureDir, readJsonIfExists } from "../platform/file.ts"
+import { getPaths, type ResolvedPaths } from "../platform/path.ts"
+import { PLUGIN_NAME } from "./paths.ts"
+
+// eslint-disable-next-line no-control-regex
+const CONTROL_CHARS = /[\u0000-\u001f\u007f]/
+
+function assertPluginId(id: string): void {
+    if (!PLUGIN_NAME.test(id) || CONTROL_CHARS.test(id)) {
+        throw new Error(`插件 id 不合法：${id}`)
+    }
+}
+
+/** 插件专属数据目录，平台会确保存在 */
+export function pluginDataDir(id: string, paths: ResolvedPaths = getPaths()): string {
+    assertPluginId(id)
+    return join(paths.dataDir, "plugin-data", id)
+}
+
+/** 插件专属配置文件 */
+export function pluginConfigFile(id: string, paths: ResolvedPaths = getPaths()): string {
+    assertPluginId(id)
+    return join(paths.configDir, "plugins", `${id}.json`)
+}
+
+export async function ensurePluginDataDir(
+    id: string,
+    paths: ResolvedPaths = getPaths(),
+): Promise<string> {
+    const dir = pluginDataDir(id, paths)
+    await ensureDir(dir)
+    return dir
+}
+
+/** 读取插件配置；文件不存在时返回空对象 */
+export async function loadPluginConfig(
+    id: string,
+    paths: ResolvedPaths = getPaths(),
+): Promise<PluginConfig> {
+    const value = await readJsonIfExists<unknown>(pluginConfigFile(id, paths))
+    if (value === null) {
+        return {}
+    }
+    if (typeof value !== "object" || value === null || Array.isArray(value)) {
+        throw new Error(`插件配置必须是 JSON 对象：${pluginConfigFile(id, paths)}`)
+    }
+    return value as Record<string, unknown>
+}