IF Commons GitHub

physical/planctl

Written to: 1 requirement: 0 proved, 0 partly, 0 failing, 1 with no test recorded. 0005-planning-surfaces FR-003

The program planctl as Headless' tree (0037-planning FR-032, FR-034, FR-035; commons headless 0003-headless-output, 0010-audience-tiers, 0013-mcp-surface): the verbs collect, show, query, views, confirm, plan and apply, each returning a typed outcome that a surface draws, and mcp, which serves the same verbs as a tool server. plan is the dry run that prints the preview and its hash; apply writes exactly the plan of the hash it is given and refuses another, and in check mode (--check) prints the hash and ends with the status of something pending where anything would change. The tool server takes its principal from the session it was launched for (PLANCTL_PRINCIPAL), makes every caller an agent acting for that person, never reads a principal or a trust from a call, and refuses every call where no principal is established.

The repository is the folder the run started in: the configuration is read from its root and from nowhere else. A person at the command line is a person with the principal of --principal or of the configuration; the tool server is an agent with the principal of its session, and an agent cannot confirm a proposal.

import { planctlProgram } from "./planctl.ts";
// planctlProgram(host).name // "planctl"

Source: commons/planning/src/physical/planctl.ts

0 of 14 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

physical.PLANCTL_VERSIONconstno test imports it
const PLANCTL_VERSION: "0.1.0"

The version of the program.

physical.TIERSconstno test imports it
const TIERS: { readonly reader: TierName; readonly writer: TierName; }

The tiers: a reader sees what only reads, a writer also what changes the store or a place.

physical.LADDERconstno test imports it
const LADDER: TierLadder

The ladder of the program.

physical.CATALOGUEconstno test imports it
const CATALOGUE: Readonly<Record<string, Explanation>>

The problem codes of the program, with what each means.

physical.renderAllfunctionno test imports it
function renderAll(items: readonly Item[], formats: readonly ("json5" | "markdown")[]): readonly { readonly format: string; readonly text: string; readonly unexpressed: readonly string[]; }[]

The formats a configuration renders, one rendering for each, of the items of the store.

physical.mcpRefusalfunctionno test imports it
function mcpRefusal(env: (name: string) => string | undefined): string | undefined

The tool server refuses every call where no principal is established.

physical.planctlProgramfunctionno test imports it
function planctlProgram(host: Host): Program

planctl as a Headless program for a host.

PLANCTL_VERSIONconstno test imports it
const PLANCTL_VERSION: "0.1.0"

The version of the program.

TIERSconstno test imports it
const TIERS: { readonly reader: TierName; readonly writer: TierName; }

The tiers: a reader sees what only reads, a writer also what changes the store or a place.

LADDERconstno test imports it
const LADDER: TierLadder

The ladder of the program.

CATALOGUEconstno test imports it
const CATALOGUE: Readonly<Record<string, Explanation>>

The problem codes of the program, with what each means.

renderAllfunctionno test imports it
function renderAll(items: readonly Item[], formats: readonly ("json5" | "markdown")[]): readonly { readonly format: string; readonly text: string; readonly unexpressed: readonly string[]; }[]

The formats a configuration renders, one rendering for each, of the items of the store.

mcpRefusalfunctionno test imports it
function mcpRefusal(env: (name: string) => string | undefined): string | undefined

The tool server refuses every call where no principal is established.

planctlProgramfunctionno test imports it
function planctlProgram(host: Host): Program

planctl as a Headless program for a host.

Titles, headings, exports, tables, columns and requirements. Esc closes.