@atomic-content-protocol/core
v0.1.1
Published
Core schema, validation, and file I/O for the Atomic Content Protocol
Readme
@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/coreQuick start
import { createACO, validateACO, parseACO, serializeACO } from "@atomic-content-protocol/core";
const aco = createACO({
title: "My First ACO",
author: { id: "[email protected]", name: "Your Name" },
body: "# Hello, world\n\nThe smallest valid ACO.",
});
const markdown = serializeACO(aco);
const parsed = parseACO(markdown);What's in the package
schema/— Zod validators for ACO, Container, Collection, edges, provenancetypes/— Runtime TypeScript interfacesio/—parseACO,parseAndValidateACO,serializeACOstorage/—IStorageAdapter,FilesystemAdaptergraph/—getRelatedACOsfor relationship traversalutils/—generateId,computeContentHash,computeTokenCounts, error classesmigrate— version migration helpers
Links
- Protocol spec: atomiccontentprotocol.org
- Repository: github.com/atomic-content-protocol/sdk
- Issues: github.com/atomic-content-protocol/sdk/issues
Stewardship
The Atomic Content Protocol is an open standard stewarded by Stacks, Inc — the company behind Stacklist.
License
Apache-2.0
