embed-types
What is this?
A public NPM package with types describing Embed public API.
Why is it needed?
- We want to call out breaking changes for our Embed consumers (e.g., customers and colleagues).
- The Embed interface should be stable. Having types defined in a separate package helps to track changes to the Embed public API with more scrutiny.
- Types described in this package can be used across Ada frontend applications that communicate with Embed.
Set up and development
Install dependencies:
sh yarn
Run ESLint
sh yarn lint
Deployment
The NPM publish job will run automatically via Github actions upon merging your branch to main
Installation
In your repository:
yarn add @ada-support/embed-types -D
Usage
import type { AdaEmbedAPI } from "@ada-support/embed-types";
You can also import any exported items exposed in our public API.
关于 @ada-support/embed-types 的常见问题
@ada-support/embed-types 是什么？
A public NPM package with types describing Embed public API.
如何安装 @ada-support/embed-types？
在项目目录运行 npm install @ada-support/embed-types，或使用 pnpm add / yarn add / bun add。
@ada-support/embed-types 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@ada-support/embed-types 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@ada-support/embed-types 可以商用吗？
@ada-support/embed-types 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@ada-support/embed-types 的下载量有多少？
根据 npm 官方下载统计，@ada-support/embed-types 在 2026/10/05 – 2026/11/03 这 30 天内被下载 32,912 次，日均约 1,097 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@ada-support/embed-types 还在维护吗？
最新版本 1.10.2 发布于 2026/09/02（2 个月前）；至今共发布 30 个版本，其中过去 12 个月发布了 4 个；首次发布于 2022/03/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。