# @captiveorigins/payload-plugin-onepedigree 中文文档

规范地址：https://npmcn.com/package/%40captiveorigins/payload-plugin-onepedigree/

版本：0\.1\.0-alpha\.18
npm 元数据更新时间：2026-11-09T21:14:12.055Z
中文译文更新时间：2026-11-09T21:23:41.877Z
软件包许可：PolyForm-Noncommercial-1\.0\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40captiveorigins/payload-plugin-onepedigree
原文对照：https://npmcn.com/package/%40captiveorigins/payload-plugin-onepedigree/?lang=original
项目主页：https://github.com/CaptiveOrigins/onepedigree#readme
源码仓库：https://github.com/CaptiveOrigins/onepedigree

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

- 包体积（解压后）：99.2 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- peer 依赖：react \>=19，payload ^3\.80\.0，@payloadcms/ui ^3\.80\.0
- 首次发布：2026-10-31T19:43:40.364Z
- 最新版本发布：2026-11-09T21:14:11.788Z
- 近 30 天下载量：1721（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

OnePedigree for Bayload:亲子化字段,循环安全亲子化写作,删除政策,所有13个视图的许可-意识亲子化端点,以及管理员预览.

## 安装

```sh
npm install @captiveorigins/payload-plugin-onepedigree
```

也可以使用：`pnpm add @captiveorigins/payload-plugin-onepedigree`、`yarn add @captiveorigins/payload-plugin-onepedigree`、`bun add @captiveorigins/payload-plugin-onepedigree`

## README

# @ captivegrounds/ paidload- plugin- onepedigree (中文(简体) )

[单页](https://npmcn.com/package/README.md) 用于有效载荷 CMS 3 : 由您自己收集、循环安全 写、删除政策、所有13个视图的许可端点和管理员 组件( pedigree 预览、 亲和、 色彩主题设置).

```ts
import { onePedigree } from '@captiveorigins/payload-plugin-onepedigree'

export default buildConfig({
  collections: [Animals, Clutches],
  plugins: [
    onePedigree({
      collection: 'animals',
      mode: 'standard-fields', // or 'managed' (creates the collections) or 'mapped' (your fields)
      cohorts: { collection: 'clutches' },
      hiddenRecords: 'placeholder', // a private relative shows as an anonymous "private record"
      navigation: { individualUrl: '/animals/{id}' },
    }),
  ],
})
```

## 名称外的标识符

`fields.identifier` 在每个视图、亲戚列表和 口语名称,如"Mead (CO-AQCR6T)". 给一个字段路径, 或请求者的一个函数, 每个 例如,个人可以选择登记号或自己的螺旋图号:

```ts
fields: { identifier: ({ user }) => (user?.showStudbook ? 'studbookNo' : 'coId') }
```

请求者无法读取的记录从不显示其标识符:其占位符携带无. 反应 `Terminology.identifierFormat` (默认) `{label} ({id})`)改变两者的结合方式.

## 模式

-   **`managed`**: 创建 `individuals`\- 工厂的风格和集体收藏 (单位:千美元)`createIndividualsCollection`, (中文(简体) ), `createCohortsCollection`) (中文(简体) ).
-   **`standard-fields`** (默认):添加 `parentage` 组`parents[{ individual, role }]`, (中文(简体) ), `reproductiveMode`, (中文(简体) ), `cohort`)到您现有的收藏.
-   **`mapped`**: 使用您的字段, 例如 . `{ kind: 'role-fields', roles: { mother: 'dam', father: 'sire' }, cohort: 'clutch' }` 或者说 `{ kind: 'parent-array', path: 'lineage', individualField: 'animal', roleField: 'role' }`。 。 。 .

该插件从不为家长,角色,模式,图形边缘或事件创建收藏.

## 父标签

保留所储存的角色 `mother` 编号 : `father`;只有词变了. `terminology.parents` 设置 默认( e)`'mother-father'` (违约), `'dam-sire'`, (中文(简体) ), `'female-male-parent'`,或自定义 `{ maternal, paternal }`) (中文(简体) ). 添加 `createParentTermsPreferenceField()` 到您的用户收藏 传出它的道路 `terminology.userPreference`:每个用户在 母亲/父亲采取者和亲戚.

## {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}骑马是分娩事件

组群是指一个生育事件(离合器、一窝一窝、双胞胎):一个母亲、父亲可能因性别而异 成员。 与 `cohorts.birthParentField` (组群的球场取出母亲的名字),成员: 被记录的母亲不同, 拒绝,同样改变 组组的母亲 而成员不同意.

## 诚信

每次写( admin, REST, GraphQL, 本地 API, 导入) :

-   单亲父母、双亲和双亲 **周期** 以可处理的字段错误拒绝; 循环检查将存储的后人行走;
-   一个父编辑器 **无法读取** 被拒绝,其信息与缺失信息相同;
-   东道主 `rules` (例如分类学)在提议的记录上运行;
-   父系变化是 **序列化**: 每一个都更新一个相同的图订正全局 交易,所以两个同时编辑,共同构成一个循环,不能同时执行 (需要一个MongoDB复制件集或另一个有交易的适配器). 订正案也 用作缓存密钥.

删除已记录的父程序被拒绝( E)`onReferencedIndividualDelete: 'restrict'`,默认)或 删除引用( n)`'detach'`) (中文(简体) ).

## 终点

| 路线 |  |
| --- | --- |
| `GET /api/<collection>/:id/pedigree?view=…` | 预测+布局; `ancestorDepth`, (中文(简体) ), `descendantDepth`, (中文(简体) ), `relatedId`, (中文(简体) ), `cohortId`, (中文(简体) ), `occurrenceMode`, (中文(简体) ), `includeSiblings`, (中文(简体) ), `orientation`, (中文(简体) ), `maxNodes`, (中文(简体) ), `layout=false` |
| `GET /api/<collection>/:id/relatives` | 父母、子女、兄弟姐妹(完全/部分/未解决),组别伴侣 |
| `POST /api/<collection>/:id/pedigree/validate` | 检查 `{ parents, reproductiveMode, cohort }` 不保存( 需要更新访问) |
| `GET /api/<cohorts>/:id/members` | 请求者可能看到的成员 |

每个读取运行随请求者( 使用访问控制) , 以 `limits` (单位:千美元)`maxDepth`, (中文(简体) ), `maxNodes`)和返回显示预测,而不是文档。 记录请求者 无法读取被匿名占位符省略或替换;其身份、姓名和链接从未 在答复中出现.

普通收藏的同样内容为(REST、GraphQL、行政主管和当地API) `overrideAccess: false`),单或列表,任意深度. 读者不能读的家长回来 `{ "private": true }` 与 `hiddenRecords: 'placeholder'`,或被排除在外 `'omit'`。图QL 返回时 `null` 对于它。 信任的本地 API 读取( 默认) `overrideAccess: true`)不变. 当有人保存了显示他们为私生子的记录时,该父子被保存为: a 占位符、取空取取取器或缺一行表示“未更改”,取而代之的是另一个 父关系被拒绝。 保留的父母也通过母字段的验证 否则,只要字段有,编辑器就可以访问 `filterOptions` (作为 多租户插件添加;其他值按常态验证.

在父路径上添加索引( E)`parentage.parents.individual`时,或您的 ; 标准字段声明.

## 管理员

-   编辑视图上的 pedigree 面板: 在任意视图中预览所保存的记录( pan, 缩放, 缩放), 选择、亲属和结构通知.
-   A 类 **Pedigre 设置** 全球:颜色主题(七个预设,每个视图口音,十六进制编辑) 用于预览;在前端读取以匹配.

## 许可证

[非商业形式 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0). 免费用于非商业用途,具有归属性;商业用途需要从Captive Origins获得单独的许可证. 这一变化之前出版的版本仍然属于麻省理工学院.

## 常见问题

### @captiveorigins/payload-plugin-onepedigree 是什么？

OnePedigree for Bayload:亲子化字段,循环安全亲子化写作,删除政策,所有13个视图的许可-意识亲子化端点,以及管理员预览\.

### 如何安装 @captiveorigins/payload-plugin-onepedigree？

在项目目录运行 npm install @captiveorigins/payload-plugin-onepedigree，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19）、payload（^3\.80\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @captiveorigins/payload-plugin-onepedigree 支持 TypeScript 吗？

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

### @captiveorigins/payload-plugin-onepedigree 支持 ESM 还是 CommonJS？

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

### @captiveorigins/payload-plugin-onepedigree 需要什么版本的 Node\.js？

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

### @captiveorigins/payload-plugin-onepedigree 可以商用吗？

@captiveorigins/payload-plugin-onepedigree 使用 PolyForm-Noncommercial-1\.0\.0 许可。声明的许可为 PolyForm-Noncommercial-1\.0\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @captiveorigins/payload-plugin-onepedigree 的下载量有多少？

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

### @captiveorigins/payload-plugin-onepedigree 还在维护吗？

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