plan/contract

Import

Import

import * as api from "@fungi.computer/shiitake-extensions/plan";

Exports

Kind	Export	Description
Ttype alias	Plan	One Session’s ordered checklist and optional explanation.
constconstant	Plan	One Session’s replaceable checklist, independent of goals and loops. No steps means no plan: replacing it with an empty checklist clears it.
constconstant	PlanInput	Checklist replacement that permits at most one in-progress step.
constconstant	PlanProjection	The current checklist and every committed replacement, clears included.
constconstant	PlanCommandInput	Arguments of the human /plan command: a bare call views, clear empties it.
constconstant	planContract	Session-owned human plan control and checklist projection.
fnfunction	planIsOpen()	Open work remains: some step is not completed. Cleared and finished plans are closed.

PlanTtype alias

Signature

type Plan = Schema.Schema.Type<typeof Plan>;

One Session’s ordered checklist and optional explanation.

Planconstconstant

Signature

const Plan: Struct<{
  explanation: optionalKey<String>;
  steps: $Array<
    Struct<{
      step: String;
      status: Literals<readonly ["pending", "in_progress", "completed"]>;
    }>
  >;
}>;

One Session’s replaceable checklist, independent of goals and loops. No steps means no plan: replacing it with an empty checklist clears it.

---

PlanInputconstconstant

Signature

const PlanInput: Struct<{
  explanation: optionalKey<String>;
  steps: $Array<
    Struct<{
      step: String;
      status: Literals<readonly ["pending", "in_progress", "completed"]>;
    }>
  >;
}>;

Checklist replacement that permits at most one in-progress step.

---

PlanProjectionconstconstant

Signature

const PlanProjection: Struct<{
  plan: Struct<{
    explanation: optionalKey<String>;
    steps: $Array<
      Struct<{
        step: String;
        status: Literals<readonly ["pending", "in_progress", "completed"]>;
      }>
    >;
  }>;
  history: Struct<{
    nextSequence: Int;
    omitted: Int;
    events: $Array<
      Struct<{
        id: String;
        sequence: Int;
        at: Int;
        commandId: NullOr<String>;
        event: Codec<
          {
            explanation?: string;
            steps: readonly object[];
          },
          {
            explanation?: string;
            steps: readonly object[];
          },
          never,
          never
        >;
      }>
    >;
  }>;
}>;

The current checklist and every committed replacement, clears included.

---

PlanCommandInputconstconstant

Signature

const PlanCommandInput: Union<
  readonly [
    Struct<{
      action: Literal<"clear">;
    }>,
    Struct<{}>,
  ]
>;

Arguments of the human /plan command: a bare call views, clear empties it.

---

planContractconstconstant

Signature

const planContract: object;

Session-owned human plan control and checklist projection.

Type Declaration

Name	Type	Default value	Description
id	string & Brand<"ExtensionId">	-	Stable extension identity.
commands	object	-	Human checklist controls.
commands.plan	object	-	View or clear the current checklist.
commands.plan.scope	"session"	"session"	The Session owns the checklist.
commands.plan.input	Union<readonly [Struct<{ action: Literal<"clear">; }>, Struct<{ }>]>	PlanCommandInput	Decode the selected human control.
commands.plan.output	declare<WhistleCatalogStepV1, WhistleCatalogStepV1>	CatalogStep	Return the server-owned conversation step.
projection	object	-	Current checklist and its replacement history.
projection.schema	Struct<{ plan: Struct<{ explanation: optionalKey<String>; steps: $Array<Struct<{ step: String; status: Literals<readonly […, …, …]>; }>>; }>; history: Struct<{ nextSequence: Int; omitted: Int; events: $Array<Struct<{ id: String; sequence: Int; at: Int; commandId: NullOr<String>; event: Codec<{ explanation?: …; steps: …; }, { explanation?: …; steps: …; }, never, never>; }>>; }>; }>	PlanProjection	Decoder for visible plan state.

planIsOpen()fnfunction

Signature

function planIsOpen(plan): boolean;

Open work remains: some step is not completed. Cleared and finished plans are closed.

Parameters

Parameter	Type	Description
plan	{ explanation?: string; steps: readonly object[]; }	-
plan.explanation?	string	Optional explanation for this checklist replacement.
plan.steps	readonly object[]	Ordered checklist; an empty array clears the plan.

Returns

boolean