Book

Package Documentation Navigation — the book element (ADR-0046 §6).

A book is the spine of a table of contents: an ordered set of groups (sections) plus identity and access. It deliberately does NOT store its members. Membership — which doc sits in which group — is derived from a rule on each group (include glob/tag) plus an optional per-doc order/group, never held in a central array.

Why a spine and not a container (ADR-0046 §6.2.1): storing the whole tree in one array conflates low-cardinality group definitions (curated by a human, rarely changed) with high-cardinality membership (churned by the AI on every new doc). A central array forces a read-modify-write on every doc the AI adds — stale/concurrent edits silently drop or reorder siblings — and breaks overlay (RFC 7396 replaces arrays atomically, shadowing docs a later package version adds). A derived spine removes the write entirely: the AI creates a doc named to match a rule and it files itself (create-and-forget), and the only per-doc storage is the scalar doc.order, which merges cleanly.

TypeScript Usage

import { BookSchema, BookAudienceSchema, BookGroupSchema, BookIncludeSchema, BookNodeSchema } from '@objectstack/spec/system';
import type { Book, BookAudience, BookGroup, BookInclude, BookNode } from '@objectstack/spec/system';

// Validate data
const result = BookSchema.parse(data);

Book

Properties

BookAudience

Union Options

This schema accepts one of the following structures:

Option 1

Type: 'org'

Option 2

Type: 'public'

Option 3

Properties

BookGroup

Properties

BookInclude

Union Options

This schema accepts one of the following structures:

Option 1

Glob over doc names, e.g. "crm_guide_*"

Type: string

Option 2

Match by doc tag (§5 vocabulary)

Properties

BookNode

Union Options

This schema accepts one of the following structures:

Option 1

Type: string

Option 2

Properties