Reference

ts

import { applyPlanOps, createPlan, validatePlan } from '@adecore/plan';
import type { Plan, PlanActor, PlanOp } from '@adecore/plan/protocol';

Schemas

On @adecore/plan/protocol. They drop keys they do not know.

Schema	Type	Schema	Type
`PlanSchema`	`Plan`	`PlanOpSchema`	`PlanOp`
`PlanMetaSchema`	`PlanMeta`	`PlanPersonOpSchema`	`PlanPersonOp`
`PlanItemSchema`	`PlanItem`	`PlanSetOpSchema`	`PlanSetOp`
`PlanSectionSchema`	`PlanSection`	`PlanNoteOpSchema`	`PlanNoteOp`
`PlanTextSchema`	`PlanText`	`PlanUnlockOpSchema`	`PlanUnlockOp`
`PlanStepSchema`	`PlanStep`	`PlanAddOpSchema`	`PlanAddOp`
`PlanIdSchema`	`PlanId`	`PlanEditOpSchema`	`PlanEditOp`
`PlanItemIdSchema`	`PlanItemId`	`PlanMoveOpSchema`	`PlanMoveOp`
`PlanStepStateSchema`	`PlanStepState`	`PlanRemoveOpSchema`	`PlanRemoveOp`
`PlanChecksSchema`	`PlanChecks`	`PlanMetaOpSchema`	`PlanMetaOp`
`PlanActorSchema`	`PlanActor`
`PlanKindSchema`	`PlanKind`

On @adecore/plan, the strict draft schemas: PlanDraftMetaSchema, PlanDraftSectionSchema, PlanDraftTextSchema and PlanDraftStepSchema.

Where each subject lives

Subject	Page
`PLAN_LIMITS`	Plans
States and their markers	State and progress
The eight operations and `PlanRefusalCode`	Operations
Who may set which step	Permissions
`PlanTextOptions`	Text for an agent

Exports

Every name each entry point exports, read from its source. Anything not listed is internal and may change in any release.

`@adecore/plan`

Creating, validating and changing plans, permissions, the tree helpers, Markdown and text.

Name	Kind	Source
`PlanApplyOptions`	type	`apply`
`PlanApplied`	type	`apply`
`randomItemId`	function	`apply`
`applyPlanOps`	function	`apply`
`validatePlan`	function	`apply`
`PlanDraftStepSchema`	const	`apply`
`PlanDraftStep`	type	`apply`
`PlanDraftTextSchema`	const	`apply`
`PlanDraftText`	type	`apply`
`PlanDraftSectionSchema`	const	`apply`
`PlanDraftSection`	type	`apply`
`PlanDraftItem`	type	`apply`
`PlanDraftMetaSchema`	const	`apply`
`PlanDraft`	type	`apply`
`parsePlanDraft`	function	`apply`
`PlanCreateOptions`	type	`apply`
`createPlan`	function	`apply`
`planToMarkdown`	function	`markdown`
`parsePlanMarkdown`	function	`markdown`
`PlanVerdict`	type	`permissions`
`canApply`	function	`permissions`
`canDeletePlan`	function	`permissions`
`PLAN_STATE_MARKERS`	const	`text`
`PLAN_LEGEND`	const	`text`
`PlanTextOptions`	type	`text`
`progressText`	function	`text`
`renderPlanText`	function	`text`
`PlanRefusalCode`	type	`tree`
`PlanRefusal`	type	`tree`
`refuse`	function	`tree`
`findItem`	function	`tree`
`allItems`	function	`tree`
`allSteps`	function	`tree`
`isParentStep`	function	`tree`
`effectiveChecks`	function	`tree`
`stepState`	function	`tree`
`PlanProgress`	type	`tree`
`planProgress`	function	`tree`
`leafSteps`	function	`tree`
`activeStepIds`	function	`tree`

`@adecore/plan/protocol`

The schemas and types of a plan and its operations, and PLAN_LIMITS.

Name	Kind	Source
`PLAN_LIMITS`	const	`protocol`
`PlanItemIdSchema`	const	`protocol`
`PlanItemId`	type	`protocol`
`PlanIdSchema`	const	`protocol`
`PlanId`	type	`protocol`
`PlanStepStateSchema`	const	`protocol`
`PlanStepState`	type	`protocol`
`PlanChecksSchema`	const	`protocol`
`PlanChecks`	type	`protocol`
`PlanActorSchema`	const	`protocol`
`PlanActor`	type	`protocol`
`PlanKindSchema`	const	`protocol`
`PlanKind`	type	`protocol`
`PlanMetaSchema`	const	`protocol`
`PlanMeta`	type	`protocol`
`PlanStepSchema`	const	`protocol`
`PlanStep`	type	`protocol`
`PlanTextSchema`	const	`protocol`
`PlanText`	type	`protocol`
`PlanSectionSchema`	const	`protocol`
`PlanSection`	type	`protocol`
`PlanItemSchema`	const	`protocol`
`PlanItem`	type	`protocol`
`PlanSchema`	const	`protocol`
`Plan`	type	`protocol`
`PlanSetOpSchema`	const	`protocol`
`PlanSetOp`	type	`protocol`
`PlanNoteOpSchema`	const	`protocol`
`PlanNoteOp`	type	`protocol`
`PlanUnlockOpSchema`	const	`protocol`
`PlanUnlockOp`	type	`protocol`
`PlanAddOpSchema`	const	`protocol`
`PlanAddOp`	type	`protocol`
`PlanEditOpSchema`	const	`protocol`
`PlanEditOp`	type	`protocol`
`PlanMoveOpSchema`	const	`protocol`
`PlanMoveOp`	type	`protocol`
`PlanRemoveOpSchema`	const	`protocol`
`PlanRemoveOp`	type	`protocol`
`PlanMetaOpSchema`	const	`protocol`
`PlanMetaOp`	type	`protocol`
`PlanPersonOpSchema`	const	`protocol`
`PlanPersonOp`	type	`protocol`
`PlanOpSchema`	const	`protocol`
`PlanOp`	type	`protocol`