# @cmssy/core 中文文档

规范地址：https://npmcn.com/package/%40cmssy/core/

版本：19\.30\.0
npm 元数据更新时间：2026-11-06T09:03:35.893Z
中文译文更新时间：2026-11-10T04:23:31.056Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cmssy/core
原文对照：https://npmcn.com/package/%40cmssy/core/?lang=original
项目主页：https://cmssy.com/
源码仓库：https://github.com/cmssy-io/cmssy-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：402 kB，28 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2026-07-14T11:50:45.347Z
- 最新版本发布：2026-11-06T09:03:35.422Z
- 近 30 天下载量：8268（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：147（近 12 个月 147 个）

## 中文简介

框架-不可知的cmsy网关:GraphQL客户端,块/域系统,编辑器协议. 没有反应,没有下一个.

## 安装

```sh
npm install @cmssy/core
```

也可以使用：`pnpm add @cmssy/core`、`yarn add @cmssy/core`、`bun add @cmssy/core`

## README

# @ cmsy/ 核心

框架不可知客户端 [学问](https://cmssy.com/) 无头站. 构建 发送请求、 定义块和布局、 解决介质和地块,以及 验证网友. 所有框架软件包都建立在其中.

```bash
pnpm add @cmssy/core
```

大多数站点不直接安装此设备 。 使用 [`@cmssy/next`](https://www.npmjs.com/package/@cmssy/next) 与 [`@cmssy/react`](https://www.npmjs.com/package/@cmssy/react),或 [`@cmssy/astro`](https://www.npmjs.com/package/@cmssy/astro) 编号 : [`@cmssy/remix`](https://www.npmjs.com/package/@cmssy/remix)把它拉进来. 到达 `@cmssy/core` 当你在布置一个框架时 我们不会装订 为.

## 配置一次

```ts
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](https://github.com/cmssy-io/cmssy-sdk/blob/main/docs/reference/sdk-api.md)。 。 。 .

## 版本: 此软件包, 不是 API

**固定此套件不会将它所讲的API 绑起 .** 它们是两个独立的 事情 只有一个在你档案里.

-   这个 **软件包版本** 包括该客户:其出口、其签名、 行为。 通常的Semver - 一个主要意味着你的代码可能需要改变.
-   这个 **发送 API** 是一种托管服务。 它的图形QL 方案可以在任意 部署,它这样做,没有在这里释放。 从计划取出的一个字段 不见了 `@cmssy/core@16.9.0` 和下一个版本一样.

这么说吧 `"@cmssy/core": "16.9.0"` 在你身边 `package.json` 不是兼容性 以服务器为对象的保证,目前没有您可以标注的 API 版本 而不是 - 交付端点没有版本段 .

今天保护你的是什么

-   计划的每一改变都与SDK在CI的操作相违背 它可以合并,所以这里传输的查询会继续工作.
-   断裂变化不能默默地合并 。 门没关了,一通接一通 无论如何,需要明确、记录批准.
-   我们打算删除的字段被标记 `@deprecated` 在计划的第一个 出现在您的代码输出和编辑器中.

尚不存在的,是明确而非暗示的: 保证折旧窗口、无最低通知期和无日期API 版本到针。 如果您自己的文档选择此软件包以外的字段 询问,验证他们 与现场计划 在你自己的CI.

## 许可证

麻省理工学院

## 常见问题

### @cmssy/core 是什么？

框架-不可知的cmsy网关:GraphQL客户端,块/域系统,编辑器协议\. 没有反应,没有下一个\.

### 如何安装 @cmssy/core？

在项目目录运行 npm install @cmssy/core，或使用 pnpm add / yarn add / bun add。

### @cmssy/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cmssy/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cmssy/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cmssy/core 可以商用吗？

@cmssy/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cmssy/core 的下载量有多少？

根据 npm 官方下载统计，@cmssy/core 在 2026/10/10 – 2026/11/08 这 30 天内被下载 8,268 次，日均约 276 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cmssy/core 还在维护吗？

最新版本 19\.30\.0 发布于 2026/11/06（3 天前）；至今共发布 147 个版本，其中过去 12 个月发布了 147 个；首次发布于 2026/07/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。