skills/source

Import

Import

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

Exports

Kind	Export	Description
Ttype alias	SkillOrigin	Where a skill folder came from: the work itself, the person, or an installed extension.
Ttype alias	SkillDescription	Host-owned discovery metadata; bodies are loaded only through skill.load.
Ttype alias	SkillDiagnostic	Safe discovery explanation, with the original cause kept separately for redacted logs.
Ttype alias	SkillCatalog	Discovered skill descriptions and diagnostics from the same scan.
Ttype alias	SkillSource	Read-only host port. The host owns frontmatter, discovery and containment.

SkillOriginTtype alias

Signature

type SkillOrigin =
  | Readonly<{
      kind: "project" | "personal";
    }>
  | Readonly<{
      kind: "extension";
      extensionId: string;
    }>;

Where a skill folder came from: the work itself, the person, or an installed extension.

---

SkillDescriptionTtype alias

Signature

type SkillDescription = Readonly<{
  name: string;
  description: string;
  location: string;
  origin: SkillOrigin;
  displayLocation: string;
}>;

Host-owned discovery metadata; bodies are loaded only through skill.load.

---

SkillDiagnosticTtype alias

Signature

type SkillDiagnostic = Readonly<{
  path: string;
  reason:
    | "invalid"
    | "collision"
    | "unavailable"
    | "bound"
    | "warning"
    | "skipped"
    | "empty";
  message: string;
  cause: unknown;
}>;

Safe discovery explanation, with the original cause kept separately for redacted logs.

---

SkillCatalogTtype alias

Signature

type SkillCatalog = Readonly<{
  skills: readonly SkillDescription[];
  diagnostics: readonly SkillDiagnostic[];
}>;

Discovered skill descriptions and diagnostics from the same scan.

---

SkillSourceTtype alias

Signature

type SkillSource = Readonly<{
  catalog: (signal) => Promise<SkillCatalog>;
  read: (
    name,
    file,
    signal,
  ) => Promise<
    Readonly<{
      name: string;
      file: string;
      content: string;
      baseDirectory: string;
      supportingFiles: readonly string[];
    }>
  >;
}>;

Read-only host port. The host owns frontmatter, discovery and containment.