# @cmscraft/schema 中文文档

规范地址：https://npmcn.com/package/%40cmscraft/schema/

版本：0\.3\.29
npm 元数据更新时间：2026-11-09T12:38:43.666Z
中文译文更新时间：2026-11-10T04:16:03.939Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cmscraft/schema
原文对照：https://npmcn.com/package/%40cmscraft/schema/?lang=original
项目主页：https://docs.cms-craft.com/
源码仓库：https://github.com/cmsCraft/toolbox

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

- 包体积（解压后）：238 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-20T11:20:44.766Z
- 最新版本发布：2026-11-09T12:38:43.439Z
- 近 30 天下载量：2395（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

用于 cms- craft API 的公共 GraphQL 计划( SDL) 和 TypeScript 类型

## 安装

```sh
npm install @cmscraft/schema
```

也可以使用：`pnpm add @cmscraft/schema`、`yarn add @cmscraft/schema`、`bun add @cmscraft/schema`

## README

# @cmscraft/schema (英语)

公众图QL计划 [CMS 工艺](https://docs.cms-craft.com/) API作为SDL,外加生成了TypeScript类型. 使用它生成一个打入的客户端而无需回顾活的API.

> Β期间免费. 付款计划将随之而来;我们将宣布定价并在收取任何费用之前发出通知.

## 安装

```bash
npm i -D @cmscraft/schema
```

`pnpm add -D @cmscraft/schema` 财务报告和审定财务报表 `yarn add -D @cmscraft/schema` 一样的工作方式.

## 用作编码图

`@cmscraft/schema/schema.gql` 是计划文件。 点 [GraphQL 代码生成器](https://the-guild.dev/graphql/codegen) 写着:

```ts
// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli'

const config: CodegenConfig = {
    schema: 'node_modules/@cmscraft/schema/schema.gql',
    documents: ['src/**/*.graphql'],
    generates: {
        'src/generated/graphql.ts': { plugins: ['typescript', 'typescript-operations'] }
    }
}

export default config
```

## 类型

生成的策略类型导出自 `@cmscraft/schema/types`数字 :

```ts
import type { Query } from '@cmscraft/schema/types'
```

## 文档

端点、 认证和 API 指南 : [https://docs.cms-craft.com (中文(简体) )](https://docs.cms-craft.com/)

问题: [支持@cms-craft.com](mailto:support@cms-craft.com)

## 许可证

麻省理工学院

## 常见问题

### @cmscraft/schema 是什么？

用于 cms- craft API 的公共 GraphQL 计划\( SDL\) 和 TypeScript 类型

### 如何安装 @cmscraft/schema？

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

### @cmscraft/schema 支持 TypeScript 吗？

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

### @cmscraft/schema 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cmscraft/schema 可以商用吗？

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

### @cmscraft/schema 的下载量有多少？

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

### @cmscraft/schema 还在维护吗？

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