@ cmsy/ 核心
框架不可知客户端 学问 无头站. 构建 发送请求、 定义块和布局、 解决介质和地块,以及 验证网友. 所有框架软件包都建立在其中.
pnpm add @cmssy/core
大多数站点不直接安装此设备 。 使用
@cmssy/next 与
@cmssy/react,或
@cmssy/astro 编号 :
@cmssy/remix把它拉进来.
到达 @cmssy/core 当你在布置一个框架时 我们不会装订
为.
配置一次
import { defineCmssyConfig, createCmssyClient } from "@cmssy/core";
export const cmssy = defineCmssyConfig({
org: process.env.CMSSY_ORG_SLUG,
workspaceSlug: process.env.CMSSY_WORKSPACE_SLUG,
});
export const client = createCmssyClient(cmssy);
defineCmssyConfig 验证所需的值,如果缺少,则丢出.
不要在缺少的 Org 或工作空间弹片上用纸 ?? "" - 一个空的
分区构建一个像 /public//graphql 远远没有成功
事业.
盒子里装的是什么
defineCmssyConfig, (中文(简体) ), createCmssyClient, (中文(简体) ), graphqlRequest 用于运输;
fields 财务报告和审定财务报表 defineCmssyLayout 区块和布局定义; mediaUrl, (中文(简体) ),
mediaUrls, (中文(简体) ), mediaAlt, (中文(简体) ), mediaType, (中文(简体) ), mediaDuration 编辑 MediaType
媒体词汇; localizeHref, (中文(简体) ), resolveCmssyLocale, (中文(简体) ),
CMSSY_LOCALE_HEADER 为i18n; applyCmssyCsp 财务报告和审定财务报表 verifyCmssyWebhook 联 合 国
边缘 完全签名于
文献/参考资料/sdk-api.md。 。 。 .
版本: 此软件包, 不是 API
固定此套件不会将它所讲的API 绑起 . 它们是两个独立的 事情 只有一个在你档案里.
- 这个 软件包版本 包括该客户:其出口、其签名、 行为。 通常的Semver - 一个主要意味着你的代码可能需要改变.
- 这个 发送 API 是一种托管服务。 它的图形QL 方案可以在任意
部署,它这样做,没有在这里释放。 从计划取出的一个字段
不见了
@cmssy/[email protected]和下一个版本一样.
这么说吧 "@cmssy/core": "16.9.0" 在你身边 package.json 不是兼容性
以服务器为对象的保证,目前没有您可以标注的 API 版本
而不是 - 交付端点没有版本段 .
今天保护你的是什么
- 计划的每一改变都与SDK在CI的操作相违背 它可以合并,所以这里传输的查询会继续工作.
- 断裂变化不能默默地合并 。 门没关了,一通接一通 无论如何,需要明确、记录批准.
- 我们打算删除的字段被标记
@deprecated在计划的第一个 出现在您的代码输出和编辑器中.
尚不存在的,是明确而非暗示的: 保证折旧窗口、无最低通知期和无日期API 版本到针。 如果您自己的文档选择此软件包以外的字段 询问,验证他们 与现场计划 在你自己的CI.
许可证
麻省理工学院