@cmssy/types

中文文档
0.74.0发布于 2026/11/10MITTypeScriptES Module零依赖近 30 天下载 1.1万

Cmsy 平台的共享类型定义

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 出口
  4. 发展
  5. 出版

@ cmsy/ 类型

Cmsy平台的共享类型Script类型定义.

安装

npm install @cmssy/types

使用量

import {
  FieldType,
  LayoutRegionId,
  BlockConfig,
  TemplateConfig
} from "@cmssy/types";

// Use in block.config.ts
const config: BlockConfig = {
  name: "My Block",
  category: "content",
  schema: {
    title: {
      type: FieldType.SINGLE_LINE,
      label: "Title",
    },
  },
};

出口

  • 字段类型数字 : FieldType, (中文(简体) ), FieldConfig, (中文(简体) ), FieldValidation, (中文(简体) ), ShowWhenCondition
  • 媒体价值数字 : MediaReference (单位:千美元)assetId, (中文(简体) ), transform?, (中文(简体) ), altText? - 空标记使用装饰, MEDIA_ALT_TEXT_MAX, (中文(简体) ), ResolvedMedia (单位:千美元)alt 这是要翻译的文本, altText 参考文献本身)
  • 版式数字 : LayoutRegionId (弦声), LayoutRegion, (中文(简体) ), DEFAULT_LAYOUT_REGIONS, (中文(简体) ), LAYOUT_REGION_ID_PATTERN, (中文(简体) ), LAYOUT_REGIONS_MAX, (中文(简体) ), LAYOUT_REGION_LABEL_MAX
  • 模块数字 : WorkspaceModule, (中文(简体) ), FeatureFlag, (中文(简体) ), BlockRequires
  • 块配置数字 : BlockConfig, (中文(简体) ), BlockSource, (中文(简体) ), PackageType
  • 模板配置数字 : TemplateConfig, (中文(简体) ), TemplatePageBlueprint, (中文(简体) ), TemplateLayoutRegion
  • 媒体转型数字 : MediaTransform, (中文(简体) ), MediaTrim, (中文(简体) ), MediaFit, (中文(简体) ), MediaBox, (中文(简体) ), FocalPoint, (中文(简体) ), MEDIA_FIT_MODES, (中文(简体) ), MEDIA_TRANSFORM_WIDTHS, (中文(简体) ), MEDIA_TRANSFORM_MAX_SIDE, (中文(简体) ), MEDIA_TRIM_MAX_SIDE, (中文(简体) ), MEDIA_QUALITY_MIN, (中文(简体) ), MEDIA_QUALITY_MAX, (中文(简体) ), MEDIA_QUALITY_DEFAULT, (中文(简体) ), parseMediaTransform, (中文(简体) ), parseMediaTrim, (中文(简体) ), snapWidth, (中文(简体) ), snapWidthDown, (中文(简体) ), renderedBox, (中文(简体) ), effectiveMediaFit, (中文(简体) ), transformForTrim, (中文(简体) ), trimmedFocalPoint, (中文(简体) ), mediaTransformUrl

发展

npm install
npm run build
npm run typecheck

出版

发行由标签驱动,并由 OIDC 信任的出版认证 - 有 没有标志,和 npm publish 从工作副本不是路径。 也会 无论之前的建筑还剩多少 dist/,哪个 npm run build 没有 干净.

npm version patch|minor|major   # bumps package.json and creates the tag
git push origin main
git push origin v<version>      # one tag, never --tags

.github/workflows/release.yml 检查标签对应 package.json,构建 从新的退票和出版。 它跳过 Npm 上的版本,所以 重运行是安全的 - 所以重复发布版本的标签会变绿色 没有发表任何东西.

版本与发布记录

@cmssy/types 共发布 95 个版本,首次发布于 2026/02/01;过去 12 个月发布了 95 个版本。

版本发布日期距今
0.74.0latest2026/11/10今天
0.73.02026/11/063 天前
0.72.02026/10/2614 天前
0.71.02026/10/2317 天前
0.70.02026/10/2318 天前
0.69.02026/10/2318 天前

关于 @cmssy/types 的常见问题

@cmssy/types 是什么?

Cmsy 平台的共享类型定义

如何安装 @cmssy/types?

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

@cmssy/types 支持 TypeScript 吗?

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

@cmssy/types 支持 ESM 还是 CommonJS?

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

@cmssy/types 可以商用吗?

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

@cmssy/types 的下载量有多少?

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

@cmssy/types 还在维护吗?

最新版本 0.74.0 发布于 2026/11/10(今天);至今共发布 95 个版本,其中过去 12 个月发布了 95 个;首次发布于 2026/02/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。