mirror of
https://github.com/hansjone/oclaw.git
synced 2026-10-09 13:53:18 +08:00
重构仓库目录为统一的 runtime 分层并清理历史 openclaw 残留。
本次迁移将网关/通道/工具/技能/脚本与协议资源集中到新结构,统一路径常量与脚本转发机制,减少顶层噪音并保证运行与测试行为一致。 Made-with: Cursor
This commit is contained in:
parent
ba3836f00f
commit
4a23b715a2
498 changed files with 2760 additions and 2200 deletions
22
runtime/extensions/api/README.md
Normal file
22
runtime/extensions/api/README.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# API 总览(extensions)
|
||||
|
||||
本文是 `vendor/oclaw/extensions` 的 API 视角重写,中文优先。
|
||||
|
||||
## extension API 是什么
|
||||
- 每个 extension 是一个插件单元,通常通过 `oclaw.plugin.json` 声明 `id`、`name`、`configSchema`。
|
||||
- 代码入口一般通过 `index.ts` 注册插件行为(如路由注册、事件处理、任务绑定)。
|
||||
- `api.ts` 常用于统一导出插件 SDK 类型或对外公开接口。
|
||||
|
||||
## 统一接入链路
|
||||
1. 读取插件配置(含 schema 校验)。
|
||||
2. 插件注册阶段挂载能力(HTTP 路由、channel 能力、provider 能力等)。
|
||||
3. 运行时把入站事件转换为 TaskFlow 或 channel 消息处理。
|
||||
4. 输出日志、错误码、可观测事件用于排障。
|
||||
|
||||
## 当前重点扩展
|
||||
- `whatsapp`:渠道接入、目标规范化、目录/群策略、登录二维码等。
|
||||
- `webhooks`:认证入站 webhook,绑定到指定会话 TaskFlow。
|
||||
|
||||
## 维护建议
|
||||
- 业务侧只改本目录说明,不直接改 vendor 源码。
|
||||
- 真正改行为时,先在主工程实现适配层,再决定是否回写上游。
|
||||
10
runtime/extensions/api/__init__.py
Normal file
10
runtime/extensions/api/__init__.py
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
from .plugin_api import PluginApi, PluginEntry, PluginLogger, PluginRuntime, define_plugin_entry
|
||||
|
||||
__all__ = [
|
||||
"PluginApi",
|
||||
"PluginEntry",
|
||||
"PluginLogger",
|
||||
"PluginRuntime",
|
||||
"define_plugin_entry",
|
||||
]
|
||||
|
||||
39
runtime/extensions/api/plugin_api.py
Normal file
39
runtime/extensions/api/plugin_api.py
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from typing import Any, Callable, Protocol
|
||||
|
||||
|
||||
class PluginLogger(Protocol):
|
||||
def info(self, message: str) -> None: ...
|
||||
|
||||
def warning(self, message: str) -> None: ...
|
||||
|
||||
def error(self, message: str) -> None: ...
|
||||
|
||||
|
||||
class PluginRuntime(Protocol):
|
||||
pass
|
||||
|
||||
|
||||
class PluginApi(Protocol):
|
||||
plugin_config: dict[str, Any]
|
||||
config: dict[str, Any]
|
||||
runtime: PluginRuntime
|
||||
logger: PluginLogger
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class PluginEntry:
|
||||
id: str
|
||||
name: str
|
||||
description: str
|
||||
register: Callable[[PluginApi], None]
|
||||
|
||||
|
||||
def define_plugin_entry(*, id: str, name: str, description: str, register: Callable[[PluginApi], None]) -> PluginEntry:
|
||||
return PluginEntry(id=id, name=name, description=description, register=register)
|
||||
|
||||
|
||||
__all__ = ["PluginApi", "PluginEntry", "PluginLogger", "PluginRuntime", "define_plugin_entry"]
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue