@adep/types
v0.2.0
Published
AgentDeploy 用户 SDK 类型契约(纯类型包,零运行时代码,见任务单 CORE-006)
Readme
@adep/types — AgentDeploy 用户 SDK 类型契约
纯类型包:零运行时代码、无运行时依赖,只提供类型定义(任务单 CORE-006)。
@adep/types 定义 AgentDeploy 云函数侧统一的能力契约:函数上下文 ctx、cloud 挂载点以及数据库 / 存储 / 请求 / 实时等能力接口。它是平台与函数代码之间的「SDK 契约层」——FN 域实现 Provider,ST / DB 域注册 Consumer,三方只依赖这里的类型,互不 import 内部实现。
npm install -D @adep/types
# 或
pnpm add -D @adep/types包含哪些契约
| 模块 | 说明 |
| ----------------- | ---------------------------------------------------------------------------------------- |
| FunctionContext | 云函数处理函数上下文(ctx.params/query/body/headers/...) |
| CloudContainer | cloud 挂载点容器:cloud.db() / cloud.storage() / cloud.fetch() / cloud.chain() |
| CloudDb | 数据库能力:table() / query() / raw() 等 |
| CloudStorage | 文件存储能力:put() / get() / list() / signURL() 等 |
| CloudFetch | HTTP 请求能力:get() / post() 等 |
| Harness | Web 组件(widget)在宿主中的挂载 / 卸载契约 |
用法
import type { FunctionContext, CloudContainer } from '@adep/types'
export default async function handler(ctx: FunctionContext) {
const db = (ctx.cloud as CloudContainer).db()
const row = await db.get('users', ctx.params.id)
return { ok: true, row }
}说明
- 该包
sideEffects: false,可安全 tree-shake;类型测试用「import 后无值导出」钉死其纯类型属性。 - 本包不负责运行时实现,运行时代码在
@adep/runtime。
