@clozeinc/forge-api

Cloze Forge API 的TypeScript客户端. 被用在脚手架上 Cloze Forge 应用模板.

安装

npm install @clozeinc/forge-api

使用量

import { Cloze } from "@clozeinc/forge-api";

const cloze = new Cloze();

const { data, error } = await cloze.projects.get({
  query: { id: "direct:12345" },
});

if (error) {
  // transport / HTTP failure
} else if (data.errorcode !== 0) {
  // application-level Cloze error (data.message has details)
} else {
  const project = data.project;
}

成绩= !error && data.errorcode === 0. 两层关系——礼物 data 单靠自己是不够的.

住在这里的东西

• 生成的 Cloze 类别和每种资源(People, (中文(简体) ), Projects, (中文(简体) ), Companies, (中文(简体) ), Timeline, (中文(简体) ), Analytics, (中文(简体) ), Team, (中文(简体) ), User, (中文(简体) ), Webhooks, (中文(简体) ), Messages, (中文(简体) ), Account+ 每个请求/答复类型.
• 自动检测三种运行时环境的传输接线:
  1. 嵌入 Cloze 主机 iframe = 向父程序请求 窗口结束 postMessage。 。 。 .
  2. 运行在一个 cloze.app 编号 : cloze.build 子域 - 使用 网站的会话 cookie 加上 X-CSRF 头曰.
  3. 独立在别处 解决无记名标志 明确 auth 配置, a ?api_key= URL 参数, 或提示 .

需要超越运输的消费者可以自行通过 client 改为 new Cloze({ client }) 或导入 createClientConfig 财务报告和审定财务报表 postMessageFetch 从软件包根开始,然后编出自己的设置.

不要手动编辑 .gen.ts 文件

结束于 .gen.ts 由 @hey-api/openapi-ts 从 克洛兹OpenAPI spec (forge-openapi.json) (中文(简体) ). 他们被重新生成 批发——手版编辑会丢失.

运行时的行为 src/api-config.ts 财务报告和审定财务报表 src/iframe-transport.ts;这些可以编辑.