Skip to content
API reference

@fungi.computer/issues

Kind Export Description
type alias IssueStatus Canonical triage state stored in ticket frontmatter.
type alias IssueFrontmatter Ticket metadata accepted by the local issue frontmatter schema.
type alias IssueDiagnostic A path, content or dependency rule violation in the supplied issue tree.
type alias IssueSummary Ticket identity and dependency state used to assemble the ready frontier.
type alias IssueIndexRecord The validated frontmatter fields Grove reads from the Team issue index.
type alias IssueTrackerReport Validation result and index projections for one complete issue tree.
function inspectIssueTree() Validate one pushed issues/ tree as a schema and dependency graph.

IssueStatustype alias

Section titled “IssueStatus”
Signature
type IssueStatus =
| "needs-triage"
| "needs-info"
| "ready-for-agent"
| "ready-for-human"
| "in-progress"
| "resolved"
| "wontfix";

Canonical triage state stored in ticket frontmatter.


IssueFrontmattertype alias

Section titled “IssueFrontmatter”
Signature
type IssueFrontmatter = object;

Ticket metadata accepted by the local issue frontmatter schema.

Signature
readonly id: string;

Stable effort-and-number identifier, independent of the ticket slug.

Signature
readonly title: string;

Ticket title, which must match the body’s first Markdown heading.

Signature
readonly type: "bug" | "enhancement" | "task" | "research" | "prototype" | "decision";

Ticket kind selecting the required body sections.

Signature
readonly status: IssueStatus;

Triage state; blocking is derived separately from dependency edges.

Signature
readonly priority: "p0" | "p1" | "p2" | "p3";

Priority code, independent of triage state and blocking.

Signature
readonly created: string;

Creation date written as YYYY-MM-DD.

Signature
readonly assignee: string | null;

Claimed owner, or null while the ticket is unassigned.

Signature
readonly areas: readonly string[];

Searchable area slugs from the governing Wiki’s domain language.

Signature
readonly blocked_by: readonly string[];

Stable ticket IDs that must be resolved or wontfix to settle blockers.


IssueDiagnostictype alias

Section titled “IssueDiagnostic”
Signature
type IssueDiagnostic = object;

A path, content or dependency rule violation in the supplied issue tree.

Signature
readonly path: string;

Input file key identifying the ticket that needs correction.

Signature
readonly code:
| "invalid-ticket-path"
| "invalid-frontmatter"
| "id-path-mismatch"
| "duplicate-id"
| "title-mismatch"
| "missing-section"
| "unknown-blocker"
| "self-blocker"
| "blocker-cycle";

Machine-readable rule violated by the ticket or its dependency graph.

Signature
readonly detail: string;

Human-readable explanation of the failed rule.


IssueSummarytype alias

Section titled “IssueSummary”
Signature
type IssueSummary = object;

Ticket identity and dependency state used to assemble the ready frontier.

Signature
readonly id: string;

Stable ticket identifier from its parsed frontmatter.

Signature
readonly path: string;

Ticket path relative to the supplied issue tree.

Signature
readonly status: IssueStatus;

Current triage state, without a synthetic blocked state.

Signature
readonly blocked: boolean;

Whether a declared blocker is absent or outside resolved and wontfix.


IssueIndexRecordtype alias

Section titled “IssueIndexRecord”
Signature
type IssueIndexRecord = Readonly<
Pick<
IssueFrontmatter,
"id" | "title" | "status" | "priority" | "assignee" | "areas" | "blocked_by"
> &
object
>;

The validated frontmatter fields Grove reads from the Team issue index.


IssueTrackerReporttype alias

Section titled “IssueTrackerReport”
Signature
type IssueTrackerReport = object;

Validation result and index projections for one complete issue tree.

Signature
readonly schemaVersion: 1;

Version of this report representation, currently 1.

Signature
readonly status: "pass" | "fail";

Pass only when the complete tree has no diagnostics.

Signature
readonly issues: readonly IssueSummary[];

Parsed graph summaries, retained even when validation fails.

Signature
readonly records: readonly IssueIndexRecord[];

Validated index records; empty if any diagnostic exists.

Signature
readonly frontier: readonly string[];

Unassigned ready ticket IDs with all declared blockers settled.

Signature
readonly diagnostics: readonly IssueDiagnostic[];

Rule violations sorted by input path and diagnostic code.

inspectIssueTree()function

Section titled “inspectIssueTree()”
Signature
function inspectIssueTree(files): IssueTrackerReport;

Validate one pushed issues/ tree as a schema and dependency graph.

Parameter Type
files Readonly<Record<string, string>>

IssueTrackerReport