# @godspeedai/cognate-artifacts 中文文档

规范地址：https://npmcn.com/package/%40godspeedai/cognate-artifacts/

版本：0\.10\.0
npm 元数据更新时间：2026-11-16T03:38:13.691Z
中文译文更新时间：2026-11-16T18:41:31.245Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40godspeedai/cognate-artifacts
原文对照：https://npmcn.com/package/%40godspeedai/cognate-artifacts/?lang=original
项目主页：https://github.com/GodSpeedAI/Cognate#readme
源码仓库：https://github.com/GodSpeedAI/Cognate

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

- 包体积（解压后）：28 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2026-10-09T02:26:48.418Z
- 最新版本发布：2026-11-16T03:38:13.364Z
- 近 30 天下载量：3603（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

具有访问政策、保留和墓碑(第13.1节)的可持久、可处理、有内容的文物.

## 安装

```sh
npm install @godspeedai/cognate-artifacts
```

也可以使用：`pnpm add @godspeedai/cognate-artifacts`、`yarn add @godspeedai/cognate-artifacts`、`bun add @godspeedai/cognate-artifacts`

## README

# @ godspideai/ cognate- 艺术

为Cognate应用程序提供持久、内容地址、访问控制的文件存储。 艺术品 用于生成或消费二进制内容——报告、文件、, 图像,数据文件——这些文件必须活过重启,并保持可审计性.

**何时使用此软件包 :** 您的代理人或能力需要将文件附加到运行中 稍后读取, 并带有用户访问控制、保留元数据以及删除 留下明确的墓碑 而不是悄悄地消失 它将一切储存在任何 [`@godspeedai/cognate-events`](https://www.npmjs.com/package/@godspeedai/cognate-events) `DurableStore`所以坚韧不拔跟你的店一样耐用.

## 安装

```sh
bun add @godspeedai/cognate-artifacts
```

要求数 [阿宝](https://bun.sh/) 您还需要一个商店: [`@godspeedai/cognate-store-sqlite`](https://www.npmjs.com/package/@godspeedai/cognate-store-sqlite) 长期储存或 [`@godspeedai/cognate-store-memory`](https://www.npmjs.com/package/@godspeedai/cognate-store-memory) 测试。 SDK号飞船 Bun-native TypeScript源, 所以添加 `@types/bun` 财务报告和审定财务报表 `@types/node` 在检查您的工程时, 作为非依赖性 .

## 快开始

```ts
import { openSqliteStore } from "@godspeedai/cognate-store-sqlite";
import { ArtifactService } from "@godspeedai/cognate-artifacts";

const store = openSqliteStore({ path: "./app.sqlite" });
const artifacts = new ArtifactService(store);

const alice = { id: "alice", kind: "user" } as const;

const record = await artifacts.put({
  name: "refund-report.md",
  mediaType: "text/markdown",
  bytes: new TextEncoder().encode("# Refund\napproved"),
  access: { tenant: "tenant-a", scopeId: "root", readers: ["alice"] },
  runId: "run-1",
  correlationId: "corr-1",
  retention: { class: "case-7y", until: "2033-01-01T00:00:00Z" },
});

const read = await artifacts.get(record.id, alice, "tenant-a");
if (read.kind === "ok") {
  console.log(record.contentHash); // `sha256:<hex>` of the bytes
  console.log(new TextDecoder().decode(read.bytes));
}

// Only principals in `readers` of the right tenant may read:
await artifacts.get(record.id, { id: "bob", kind: "user" }, "tenant-a"); // { kind: "denied" }
```

## 如何表现

-   **写出头字节.** `put` 存储已处理的字节内容( c)`sha256:<hex>`(中文(简体) ) _在此之前_ 记录及其记录 `artifact.created` 事件,所以没有 内容。 相同的字节被存储一次,甚至跨出文物.
-   **诚实的阅读.** `get` 返回歧视性结果 : `ok`, (中文(简体) ), `denied` (租户与否) 在读者许可名单上, `not_found`, (中文(简体) ), `tombstoned` (在你的下方被彻底清除) 保留/空缺政策),或 `lost` (记录已存在,但其字节已消失——已报告) 明显是数据损失,从未隐藏在未找到的答案后).
-   **删取为墓志铭.** `delete(id, reason, actor)` 标记记录 `tombstoned` 与 他们删除了它,为什么, 然后删除字节blobs 没有剩余的文物参考文献 - 共享内容仍然可以删除任何一种引用者.
-   **示众.** 一种工艺品可以携带多种介质类型(例如: 原件外加JSON表格视图; `get(id, actor, tenant, "application/json")` 选择一个.
-   **列表(上册).** `list({ tenant, runId? }, actor)` 返回只记录已授权的演员 读取.

## 限制

-   保留(`class` 财务报告和审定财务报表 `until`)是被记录的元数据。 本套件列表中无任何内容或 执行期满——以你自己的工作为基础.
-   访问控制是每件文物和租户匹配的平面读取码许可列表. 作用, 团队 和全方位的政策 是您的应用工作.
-   `list` 扫描所有文物记录;没有二级索引.
-   墓碑记录把他们的事件记录保存在商店里. 擦除事件有效载荷是 存储的有效载荷感应特性, 不是这个包做的.

## 相关软件包

-   [`@godspeedai/cognate-events`](https://www.npmjs.com/package/@godspeedai/cognate-events) —— 说 页:1 `DurableStore` 合同和事件信封,这项服务是建立在上.
-   [`@godspeedai/cognate-store-sqlite`](https://www.npmjs.com/package/@godspeedai/cognate-store-sqlite) —— 说 耐用SQLite商店; [`@godspeedai/cognate-store-memory`](https://www.npmjs.com/package/@godspeedai/cognate-store-memory) —— 说 做测试的记忆店.
-   [`@godspeedai/cognate-runtime-bun`](https://www.npmjs.com/package/@godspeedai/cognate-runtime-bun) —— 说 参考运行时间; 它为您运行此服务, 并通过它的 API 曝光文物 .
-   [`@godspeedai/cognate`](https://www.npmjs.com/package/@godspeedai/cognate) - SDK车 雨伞;最容易获得有文物支持的运行时间.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @godspeedai/cognate-artifacts 是什么？

具有访问政策、保留和墓碑\(第13\.1节\)的可持久、可处理、有内容的文物\.

### 如何安装 @godspeedai/cognate-artifacts？

在项目目录运行 npm install @godspeedai/cognate-artifacts，或使用 pnpm add / yarn add / bun add。

### @godspeedai/cognate-artifacts 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/godspeedai\_\_cognate-artifacts 是否存在。

### @godspeedai/cognate-artifacts 支持 ESM 还是 CommonJS？

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

### @godspeedai/cognate-artifacts 可以商用吗？

@godspeedai/cognate-artifacts 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @godspeedai/cognate-artifacts 的下载量有多少？

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

### @godspeedai/cognate-artifacts 还在维护吗？

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

