Planning content from many places as one item each with one stable id, its history as append-only events and its state a fold of them, with every act of an agent made on behalf of a person; sources are lenses over the places, and a write goes back in the place's own form.
| Fact | Value |
|---|
| Version | 0.1.0 |
| Conformance level | L1 |
| Distributed | github, npm |
| License | PolyForm-Noncommercial-1.0.0, source-available: free for noncommercial use, commercial use needs a license from the owner (see Licensing in Start here) |
| Import it as | @intellectual-frontiers/planning |
#Areas
#Layers
| Layer | Folder | May import of this library |
|---|
| governance | src/governance/ | nothing |
| logical | src/logical/records/ | src/governance/, src/logical/ |
| logical | src/logical/ | governance |
| physical | src/physical/ | src/governance/, src/logical/, src/logical/records/ |
#Imports
AnyFS, Core, Crypto, Formats, Githost, Headless, System, Terminal
#Imported by
Findings, Planning Query
#Specifications
#Folders
| Folder | What it is | May import |
|---|
spec-kit/ | The library's own specifications, numbered from 0001. | nothing: Markdown and TSV |
src/governance/ | Layer 1: what an item is and what may happen to it: the closed lists with their registries, instants and days, ids of UUID version 7, actors (an agent names the person it acts for), events and items with their state. | core, by package name; the governance of anyfs, for the syntax of a version id |
src/logical/records/ | Layer 2: the records at the boundary: the store's files of events and items in JSON5 with the order of keys of RFC 8785, the monorepo's issue files, event objects and summaries, and an issue file read as an item with its events. | logical, by relative path; governance, by package name; core and the JSON5 of formats |
src/logical/ | Layer 2: the model the library reasons with: the fold of events into an item with the authority over each field, the cycle check of links, the clock that makes ids (the hybrid clock of anyfs's merge), the ids of records read from another scheme, reconcile of what a source read with the store, duplicates, the outbox and previews with their hash, the query algebra, the views, the matrix of what a source can hold and the configuration. Pure: no input or output and no clock. | governance, by package name; core and the SHA-256 of crypto; the governance and the merge of anyfs |
src/physical/ | Layer 3: what reads files, runs programs and reaches the network: the store of events over AnyFS, the port a source implements and the laws of a lens, the sources (typed issues, event files, Markdown, comments, a Git host), the configuration read from the repository, and the program planctl with its tool server. | governance and logical, by package name, and the records of the logical layer; core, AnyFS, the SHA-256 and JSON5 of commons, the Git host contract, Headless, the terminal and the system, by package name |
suite/ | The tests: every requirement. | src/; the test module of commons' runtime, by package name |
tools/ | The trace check bun run verify runs. | the kernel, the runtime and the packer of commons, by package name |
#Quality
Quality: 6 tests: 6 passed, 0 failed, 0 skipped, 3 of 44 requirements proved, 0 open issues, 0 open tickets. The tests and issues of the library