@atomic-content-protocol/core

中文文档
0.3.2发布于 2026/10/22Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 4542

Core schema, validation, and file I/O for the Atomic Content Protocol

原始使用文档
文档目录7 节
  1. Install
  2. Quick start
  3. Runtime support
  4. What's in the package
  5. Links
  6. Stewardship
  7. License

@atomic-content-protocol/core

Core schema, validation, and file I/O for the Atomic Content Protocol.

An Atomic Content Object (ACO) is a Markdown file with structured YAML frontmatter — a format that's both human-readable and machine-addressable.

Install

npm install @atomic-content-protocol/core

Quick start

import { createACO, validateACO, parseACO, serializeACO, FilesystemAdapter } from "@atomic-content-protocol/core";

const aco = await createACO({
  title: "My First ACO",
  author: { id: "[email protected]", name: "Your Name" },
  body: "# Hello, world\n\nThe smallest valid ACO.",
});

const { valid, errors } = validateACO(aco.frontmatter);

const markdown = serializeACO(aco.frontmatter, aco.body); // "---\n…\n---\n# Hello, world…\n"
const parsed = parseACO(markdown);                          // { frontmatter, body, raw }

const vault = new FilesystemAdapter("./vault");
await vault.putACO(aco);

Runtime support

Node.js ≥ 20. The package entry point uses node:fs, node:crypto and node:dns (filesystem vault, content hashing, SSRF-safe URL fetching), so it is not browser-bundleable as a whole. The Zod schemas in schema/ have no Node dependencies and can be deep-imported by browser code once subpath exports land (planned for 0.3).

What's in the package

  • schema/ — Zod validators for ACO, Container, Collection, edges, provenance
  • types/ — Runtime TypeScript interfaces
  • io/ — parseACO, parseAndValidateACO, serializeACO
  • storage/ — IStorageAdapter, FilesystemAdapter
  • graph/ — getRelatedACOs for relationship traversal
  • utils/ — generateId, computeContentHash, computeTokenCounts, error classes
  • migrate — version migration helpers

Stewardship

The Atomic Content Protocol is an open standard stewarded by Stacks, Inc — the company behind Stacklist.

License

Apache-2.0

版本与发布记录

@atomic-content-protocol/core 共发布 9 个版本,首次发布于 2026/04/20;过去 12 个月发布了 9 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.2latest2026/10/2216 天前
0.3.12026/10/1127 天前
0.3.02026/10/1127 天前
0.2.12026/09/141 个月前
0.2.02026/09/141 个月前
0.1.32026/05/036 个月前

关于 @atomic-content-protocol/core 的常见问题

@atomic-content-protocol/core 是什么?

Core schema, validation, and file I/O for the Atomic Content Protocol

如何安装 @atomic-content-protocol/core?

在项目目录运行 npm install @atomic-content-protocol/core,或使用 pnpm add / yarn add / bun add。

@atomic-content-protocol/core 支持 TypeScript 吗?

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

@atomic-content-protocol/core 支持 ESM 还是 CommonJS?

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

@atomic-content-protocol/core 需要什么版本的 Node.js?

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

@atomic-content-protocol/core 可以商用吗?

@atomic-content-protocol/core 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@atomic-content-protocol/core 的下载量有多少?

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

@atomic-content-protocol/core 还在维护吗?

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