# @communities-webruntime/metadata-schema 中文文档

规范地址：https://npmcn.com/package/%40communities-webruntime/metadata-schema/

版本：1\.66\.8
npm 元数据更新时间：2022-04-05T00:32:27.247Z
中文译文更新时间：2026-11-10T13:01:35.116Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40communities-webruntime/metadata-schema
原文对照：https://npmcn.com/package/%40communities-webruntime/metadata-schema/?lang=original

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

- 包体积（解压后）：22.2 kB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2020-01-23T13:00:58.314Z
- 最新版本发布：2021-12-02T03:25:52.223Z
- 近 30 天下载量：2965（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：359（近 12 个月 0 个）

## 中文简介

闪电网络运行时间的 UI 元数据图谱

## 安装

```sh
npm install @communities-webruntime/metadata-schema
```

也可以使用：`pnpm add @communities-webruntime/metadata-schema`、`yarn add @communities-webruntime/metadata-schema`、`bun add @communities-webruntime/metadata-schema`

## README

# UI 元数据Schema

使用一个统一的计划来模拟你在JSON的UI形状.

此工程目前仅用于 `@communities-webruntime` 及其相应的验证人.

## 概览

元数据-schema为 LWR 项目验证不同类型JSON元数据的形状.

目前得到支持的计划包括:

-   `base` (单位:千美元)_犬科元数据_(中文(简体) )
-   `communities` (单位:千美元)_申报元数据_(中文(简体) )

元数据类型包括:

-   `branding`
-   `routes`
-   `theme`
-   `view`

## 使用量

对照计划进行验证,导入 `MetadataValidator`数字 :

```
import MetadataValidator from '@communities-webruntime/metadata-schema';

const schema = 'communities';   // name of the schema to validate against
const metadataType = 'routes';  // name of the metadata type
const data = ...;
new MetadataValidator(schema).validate(data, metadataType);
```

例如,见 [元数据验证.ts](https://npmcn.com/package/%40communities-webruntime/metadata-schema/metadata-validation.ts)。 。 。 .

## 定义

| 名称 | 说明 |
| :-- | :-- |
| 视图 | 一个屏幕上的景色。 也被称为 _页次_。 。 。 . |
| 构成部分 | 一个可重复使用的可堆叠的UI碎片. 这是对技术不可知的,即这可能是LWC组件或可再使用的HTML组件. |
| 地区 | 观点中可能包含一个或多个组成部分的部分 |
| 产品 | 一块存储颜色或字体等视觉信息的数据. 这通常是一个键: 值对 |
| 路线 | 路由包含关于 URL 方案的元数据, 或任何位置指定符 |
| 主题 | 一个主题是一个复杂类型,它包含关于应用程序更高水平视觉的元数据 |
| 主题Layout | 主题布局只是视图的另一个名称 |

关于元数据的更详细记录,见 [社区解剖 LWR 模板](https://confluence.internal.salesforce.com/x/dI-vD)。 。 。 .

## 捐款

1.  编辑 _仅限_ 受你变化影响的计划 要知道任何定义的改变都会影响所有计划. 确保您不会通过查看文件来破坏他人 `/config` 文件夹,并验证您的计划变化的影响.
2.  进一步确保您不会通过进行所有测试来打破别人.
3.  添加您更改的测试, 以确保其他人不会打断您 .

## 常见问题

### @communities-webruntime/metadata-schema 是什么？

闪电网络运行时间的 UI 元数据图谱

### 如何安装 @communities-webruntime/metadata-schema？

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

### @communities-webruntime/metadata-schema 支持 TypeScript 吗？

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

### @communities-webruntime/metadata-schema 支持 ESM 还是 CommonJS？

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

### @communities-webruntime/metadata-schema 可以商用吗？

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

### @communities-webruntime/metadata-schema 的下载量有多少？

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

### @communities-webruntime/metadata-schema 还在维护吗？

最新版本 1\.66\.8 发布于 2021/12/02（4 年前）；至今共发布 359 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/01/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。