cyber-agentkit 1.2.0 → 2.0.0

package/dist/resolve-reference-D62VJZc0.d.ts

@@ -1,246 +0,0 @@
-import { t as HarnessId } from "./harness-id-BgKL-x6C.js";
-//#region src/harness/platform.d.ts
-/**
- * An operating-system platform, spelled as `process.platform` reports it.
- *
- * The queries branch on `darwin`, `linux`, and `win32`; every other platform follows the POSIX
- * (`linux`) layout. The union lists every value Node.js reports, so `process.platform` is assignable
- * to it, but it is declared here rather than as `NodeJS.Platform` so the published types do not
- * depend on `@types/node`.
- */
-type Platform = 'aix' | 'android' | 'cygwin' | 'darwin' | 'freebsd' | 'haiku' | 'linux' | 'netbsd' | 'openbsd' | 'sunos' | 'win32';
-//#endregion
-//#region src/skills/skill-folder.d.ts
-/**
- * The `name` in a skill folder's `SKILL.md`, else the folder's own name; `undefined` when the folder
- * holds no `SKILL.md`. A package manager may link a skill under another folder name, such as pnpm's
- * `pnpm-<package>-<skill>` (E-PM-PNPM-4), so the folder name is only a fallback.
- */
-declare function skillName(folder: string): string | undefined;
-type FoundSkill = {
-  /** The `name` its `SKILL.md` gives. */
-  name: string;
-  /** The folder, with symlinks resolved. */
-  folder: string;
-};
-/**
- * The skills in each folder: the folder itself when it holds a `SKILL.md`, else each skill directly
- * under it, one level deep. A symlinked skill folder is followed, since pnpm and `npx skills` link
- * skills rather than copy them (E-PM-SK-2, E-PM-SK-7); one real folder reached twice is listed once.
- */
-declare function skillsIn(folders: readonly string[]): FoundSkill[];
-//#endregion
-//#region src/references/reference-warning.d.ts
-/**
- * A fault that never stops a name from resolving. The `code` is stable; the `message` is for a
- * person and is not a contract.
- */
-type ReferenceWarning = {
-  code: ReferenceWarningCode;
-  message: string;
-};
-type ReferenceWarningCode = 'frontmatter-invalid' | 'merge-unknown' | 'marker-unknown' | 'marker-unmatched' | 'heading-repeated' | 'remove-body-ignored' | 'extends-invalid' | 'extends-self' | 'extends-step-missing' | 'extends-all-missing' | 'extends-not-used' | 'default-not-selected' | 'default-folder-missing' | 'default-in-tier' | 'file-ignored' | 'format-mismatch' | 'selection-invalid' | 'interface-not-composed' | 'interface-check';
-/** The code of a name that is not `found`. */
-type ReferenceCode = 'reference-missing' | 'reference-ambiguous' | 'reference-invalid';
-//#endregion
-//#region src/references/reference-layers.d.ts
-/** Where a contribution lives. Listed highest first; the stack (plugins and `default`) is ordered by `extends`. */
-type ReferenceTier = 'managed' | 'project' | 'user' | 'plugin' | 'default';
-type ReferenceLayer = {
-  tier: ReferenceTier;
-  /** The folder read for contributions. */
-  dir: string;
-  /** The plugin tier: the plugin's manifest `name`, which a qualified `<plugin>/<name>` uses. */
-  plugin?: string | undefined;
-  /** The default tier: the skill's `SKILL.md` `name`. */
-  skill?: string | undefined;
-  /** Set when the layer is never read, and why: policy held in MDM, a plugin with no install folder. */
-  skipped?: string | undefined;
-  /**
-   * An `assets/` layer: a file is `<name>.<ext>` with no `.default` marker, read as written. Nothing in it
-   * merges or extends; the highest layer holding the name answers whole.
-   */
-  whole?: boolean | undefined;
-  /** Raised on every name resolved through this layer, such as a `--default` folder that does not exist. */
-  warning?: ReferenceWarning | undefined;
-};
-type ReferenceFolder = 'references' | 'assets';
-type ReferenceLayerOptions = {
-  root: string;
-  home: string;
-  platform: Platform;
-  /**
-   * The plugin running the resolver. Its `references/` is the first plugin layer, and its install,
-   * when a harness has it enabled, is not read a second time.
-   */
-  plugin?: ReferencePlugin | undefined;
-  /** The calling skill's folder: its `references/<name>.default.md` forms the `default` tier. */
-  defaultSkill?: string | undefined;
-  /** The folder every tier reads: `references` (the default), or `assets` for an assets call. */
-  folder?: ReferenceFolder | undefined;
-  /** Detects the harness and reads its settings. Defaults to `process.env`. */
-  env?: Readonly<Record<string, string | undefined>>;
-};
-type ReferencePlugin = {
-  /** Its manifest `name`, which a qualified `<plugin>/<name>` uses. */
-  name: string;
-  /** The plugin root, which holds its `references/`. */
-  root: string;
-};
-type ReferenceLayers = {
-  /** Highest first: managed, project (nearest first), user, plugin, default. */
-  layers: ReferenceLayer[];
-  /** The harnesses detected, whose managed folders and enabled plugins were read. */
-  harnesses: readonly HarnessId[];
-  /** The installed skills that hold a default, which `list`, `search`, and `check` reach. */
-  skills?: SkillDefaults | undefined;
-};
-/** The installed skills holding a default contribution, found in the skill folders the detected harnesses read. */
-type SkillDefaults = {
-  skills: FoundSkill[];
-  /** Why some skills' defaults are not listed: no harness detected, or one whose skill folders are not verified. */
-  unverified?: string | undefined;
-};
-declare function projectReferencesDir(root: string): string;
-declare function userReferencesDir(home: string): string;
-/** The `default` tier for the skill at `folder`; a folder that does not exist warns and adds no contribution. */
-declare function defaultLayer(folder: string): ReferenceLayer;
-declare function referenceLayers({ root, home, platform, plugin, defaultSkill, folder, env }: ReferenceLayerOptions): Promise<ReferenceLayers>;
-//#endregion
-//#region src/references/reference-document.d.ts
-/**
- * How a contribution applies over what is below it. `replace` puts it in place of everything below;
- * `patch` keeps what is below and puts each section's text in place of the text it matches;
- * `combine` keeps what is below and adds each section's text after the text it matches; `remove`
- * drops what is below.
- */
-type MergeOperation = 'replace' | 'patch' | 'combine' | 'remove';
-/** Which contribution supplied a section's text, and how. */
-type SectionSource = {
-  contribution: string;
-  operation: MergeOperation;
-};
-//#endregion
-//#region src/references/reference-format.d.ts
-/** The format of a reference file: `markdown`, or the extension of a data file. */
-type ReferenceFormat = 'markdown' | 'json' | 'yaml' | 'toml' | 'txt';
-//#endregion
-//#region src/references/reference-name.d.ts
-type ReferenceName = {
-  /** As asked. */
-  raw: string;
-  /** The bare name. */
-  name: string;
-  /** The plugin a qualified `<plugin>/<name>` asks for, by its manifest's `name`. */
-  plugin?: string | undefined;
-  /** Why the value is not a reference name. Set only on an invalid one; nothing is read for it. */
-  invalid?: string | undefined;
-};
-/**
- * Rejects rather than sanitizes — silently answering a different question is how untrusted input
- * reads a file outside a layer. The plugin qualifier is only ever compared with plugin names, never
- * joined into a path. A bad name comes back `invalid`, never thrown, so the other names still resolve.
- */
-declare function parseReferenceName(value: string): ReferenceName;
-//#endregion
-//#region src/references/resolve-reference.d.ts
-type ReferenceStatus = 'found' | 'missing' | 'ambiguous' | 'invalid';
-/** Why an ambiguous name's contributions cannot be put in one order. */
-type AmbiguousCause = 'unordered' | 'cycle' | 'repeat';
-/** Where a contribution's operation came from: its own `merge`, a step's key, or the default `patch`. */
-type OperationSource = 'contribution' | 'step' | 'default';
-/** One layer checked, as the trace reports it. */
-type ReferenceTraceLayer = {
-  tier: ReferenceTier;
-  plugin?: string;
-  skill?: string;
-  /** The file matched, or the folder checked when none matched. */
-  path: string;
-  /** The file that answered, relative to the folder: `<name>.md`, `<name>/README.md`, `<name>.default.md`, or the same with a data extension. */
-  file?: string;
-  /** Its frontmatter as written. */
-  frontmatter?: Record<string, unknown>;
-  operation?: MergeOperation;
-  operationFrom?: OperationSource;
-  /** `used`; `shadowed by ...`; `not used (...)`; `not read (...)`; `ambiguous`; or `missing`. */
-  outcome: string;
-  /** Set when its `extends` was written but did not build the stack, and why. */
-  extendsOutcome?: string;
-  description?: string;
-  /** A contribution with `extends` and no body: it picks the stack and changes nothing else. */
-  selection?: boolean;
-  /** A contribution with no body, which changes nothing unless it is a `remove`. */
-  empty?: boolean;
-};
-type ReferenceTraceContribution = {
-  tier: ReferenceTier;
-  plugin?: string;
-  skill?: string;
-  path: string;
-  operation: MergeOperation;
-};
-type ReferenceTraceSection = {
-  /** The heading path, such as `Review > Checklist`. */
-  path: string;
-  /** The contributions that supplied its text, bottom first, each with the operation it applied. */
-  contributions: SectionSource[];
-  /** Set on a section a `remove` dropped: the contribution that dropped it. */
-  removedBy?: string;
-};
-type ReferenceTrace = {
-  /** The plugins and `default` the name builds on, bottom first. */
-  stack: string[];
-  /** What built the stack: the contribution whose `extends` was used, a plugin's own `extends`, or `none`. */
-  builtBy: string;
-  /** The contributions whose text the document holds, bottom first. */
-  contributions: ReferenceTraceContribution[];
-  sections: ReferenceTraceSection[];
-  /** Every layer checked, highest first. */
-  layers: ReferenceTraceLayer[];
-  /** The harnesses detected, whose managed folders and enabled plugins were read. */
-  harnesses: string[];
-};
-/** A name resolved, with every field: the command prints a subset. A bad name is a status, never thrown. */
-type ResolvedReference = {
-  name: string;
-  status: ReferenceStatus;
-  /** Set when not `found`. */
-  code?: ReferenceCode;
-  /** Why it is not `found`, for a person. */
-  message?: string;
-  content?: string;
-  /** Set when `found`: `markdown`, or the format of the data file that answered whole. */
-  format?: ReferenceFormat;
-  /** The composed frontmatter, key by key with the higher contribution winning, without `merge` and `extends`. */
-  metadata?: Record<string, unknown>;
-  /** When `ambiguous`: each `<plugin>/<name>`, and `default` when the skill has one. */
-  options?: string[];
-  cause?: AmbiguousCause;
-  /** When a `remove` turned the name off: that contribution. */
-  removedBy?: string;
-  warnings: ReferenceWarning[];
-  trace: ReferenceTrace;
-};
-type ResolveOptions = {
-  /** How a path is shown in a label or a warning — the command collapses the home directory. */
-  display?: (path: string) => string;
-  /** A file read as absent, so `delete --dry-run` can report what answers once it is gone. */
-  without?: string | undefined;
-  /** Read only the layers below this folder, so `where` can report the document below a file it would write. */
-  below?: string | undefined;
-};
-/** One `extends` entry: a plugin or `default`, with the keys to use for it in place of its own. */
-type ExtendsStep = {
-  target: string;
-  merge?: MergeOperation;
-  extends?: ExtendsStep[];
-};
-type Source = ReferenceLayers | readonly ReferenceLayer[];
-/**
- * Resolves one name: reads each layer, puts the contributions in one order (the stack under the
- * user, project, and managed tiers), and composes them bottom first, each with its operation.
- */
-declare function resolveReference(input: string | ReferenceName, source: Source, { display, without, below }?: ResolveOptions): ResolvedReference;
-declare function referenceNames(source: Source): string[];
-//#endregion
-export { FoundSkill as A, defaultLayer as C, ReferenceCode as D, userReferencesDir as E, skillsIn as M, Platform as N, ReferenceWarning as O, SkillDefaults as S, referenceLayers as T, ReferenceLayer as _, ReferenceTrace as a, ReferencePlugin as b, ReferenceTraceSection as c, referenceNames as d, resolveReference as f, SectionSource as g, MergeOperation as h, ReferenceStatus as i, skillName as j, ReferenceWarningCode as k, ResolveOptions as l, parseReferenceName as m, ExtendsStep as n, ReferenceTraceContribution as o, ReferenceName as p, OperationSource as r, ReferenceTraceLayer as s, AmbiguousCause as t, ResolvedReference as u, ReferenceLayerOptions as v, projectReferencesDir as w, ReferenceTier as x, ReferenceLayers as y };