@ttsc/graph 0.16.6 → 0.16.7

package/src/structures/ITtscGraphEntrypoints.ts

@@ -1,7 +1,8 @@
 import { ITtscGraphDecorator } from "./ITtscGraphDecorator";
 import { ITtscGraphEvidence } from "./ITtscGraphEvidence";
+import { ITtscGraphNext } from "./ITtscGraphNext";
 
-/** The compact source-free entrypoint list returned for a code question. */
+/** The first compact source-free handle list for a TypeScript code question. */
 export interface ITtscGraphEntrypoints {
   /** Discriminator for first-pass question indexing. */
   type: "entrypoints";
@@ -18,8 +19,11 @@ export interface ITtscGraphEntrypoints {
   /** Direct dependency context for the resolved mentions and highest hits. */
   neighborhood: ITtscGraphEntrypoints.INeighborhood[];
 
-  /** Follow-up handles for deeper graph calls. */
-  next: ITtscGraphEntrypoints.INext;
+  /** How to use this source-free result next. */
+  next: ITtscGraphNext;
+
+  /** Human-readable compatibility note mirroring `next`. */
+  guide: string;
 
   /** True when result caps hid additional seeds or references. */
   truncated?: boolean;
@@ -27,9 +31,10 @@ export interface ITtscGraphEntrypoints {
 
 export namespace ITtscGraphEntrypoints {
   /**
-   * Ask the graph for the first entrypoints an agent should read before opening
-   * source: ranked symbols, exact mentioned handles, and nearby dependency
-   * edges.
+   * Ask for first handles when the question is narrow but the symbol is not yet
+   * known. For broad tours, read-next, architecture, or multi-phase runtime
+   * flow, use `tour` instead of decomposing the answer into entrypoints and
+   * follow-up calls.
    */
   export interface IRequest {
     /** Discriminator for first-pass question indexing. */
@@ -38,13 +43,17 @@ export namespace ITtscGraphEntrypoints {
     /**
      * A natural code question or search phrase. Mix prose with code handles,
      * for example `how Repository.find loads relations` or
-     * `SelectQueryBuilder.setFindOptions join aliases`.
+     * `SelectQueryBuilder.setFindOptions join aliases`. Keep this close to the
+     * user's question; do not turn it into a broad keyword dump.
      */
     query: string;
 
     /**
      * Maximum ranked hits to return.
      *
+     * Prefer the default. Raise only when the first result was truncated and
+     * the missing handle is named.
+     *
      * @default 4
      */
     limit?: number;
@@ -53,6 +62,7 @@ export namespace ITtscGraphEntrypoints {
      * Maximum direct dependencies and dependents to return per indexed symbol.
      * This is an orientation slice, not a dependency dump; use `trace` or
      * `details` with `neighbors:true` after choosing the specific handles.
+     * Prefer the default zero for the first call.
      *
      * @default 0
      */
@@ -61,14 +71,24 @@ export namespace ITtscGraphEntrypoints {
 
   /** A compact symbol coordinate, optionally with its declaration signature. */
   export interface INode {
+    /** Stable node id for subsequent graph calls. */
     id: string;
+
+    /** Qualified symbol name when available, otherwise the simple name. */
     name: string;
+
+    /** Declaration kind (`class`, `method`, `function`, ...). */
     kind: string;
+
+    /** Project-relative path of the declaration file. */
     file: string;
+
     /** 1-based declaration line, when known. */
     line?: number;
+
     /** Declaration head, included only for indexed symbols. */
     signature?: string;
+
     /** Decorators written on this declaration, when any. */
     decorators?: ITtscGraphDecorator[];
   }
@@ -81,38 +101,49 @@ export namespace ITtscGraphEntrypoints {
 
   /** A code handle written in the query, with its resolution status. */
   export interface IMention {
+    /** The exact handle text found in the query. */
     handle: string;
+
+    /** Resolved node when the handle maps unambiguously. */
     node?: INode;
+
+    /** Candidate nodes when the handle is ambiguous. */
     candidates?: INode[];
   }
 
   /** Direct dependency context around one indexed symbol. */
   export interface INeighborhood extends INode {
+    /** Symbols this node directly uses, capped by `neighbors`. */
     dependsOn: IReference[];
+
+    /** Symbols that directly use this node, capped by `neighbors`. */
     dependedOnBy: IReference[];
   }
 
   /** One neighboring symbol and the relationship leading to it. */
   export interface IReference {
+    /** Stable id of the neighboring node. */
     id: string;
+
+    /** Neighbor symbol name, qualified when available. */
     name: string;
+
+    /** Neighbor declaration kind. */
     kind: string;
+
+    /** Project-relative declaration file for the neighbor. */
     file: string;
+
     /** 1-based declaration line, when known. */
     line?: number;
+
+    /** Edge kind connecting the indexed node and this neighbor. */
     relation: string;
+
     /**
      * Source span for the expression that produced this relationship. It lets
      * an agent see why the edge exists without opening the file.
      */
     evidence?: ITtscGraphEvidence;
   }
-
-  /** Tool-call handles suggested by this first entrypoints result. */
-  export interface INext {
-    /** Pass these ids to `details` for source-free symbol facts. */
-    details: string[];
-    /** Pass these ids to `trace` when following dependency flow. */
-    traceFrom: string[];
-  }
 }

package/src/structures/ITtscGraphEscape.ts

@@ -1,4 +1,6 @@
-/** The no-op graph result returned when reasoning rejects the graph call. */
+import { ITtscGraphNext } from "./ITtscGraphNext";
+
+/** The no-op result for when graph is not the useful next evidence source. */
 export interface ITtscGraphEscape {
   /** Discriminator for the no-op escape route. */
   type: "escape";
@@ -9,12 +11,18 @@ export interface ITtscGraphEscape {
   /** Why no graph operation should run. */
   reason: string;
 
-  /** The next non-graph step, if useful. */
+  /** How to proceed after skipping graph work. */
+  next: ITtscGraphNext;
+
+  /** Human-readable compatibility note mirroring `next`. */
+  guide: string;
+
+  /** Optional note about the next non-graph step. */
   nextStep?: string;
 }
 
 export namespace ITtscGraphEscape {
-  /** Exit after the reasoning review decides graph evidence is unnecessary. */
+  /** Skip graph work when graph evidence is unnecessary or exhausted. */
   export interface IRequest {
     /** Discriminator for the no-op escape route. */
     type: "escape";
@@ -22,17 +30,19 @@ export namespace ITtscGraphEscape {
     /**
      * Why no graph operation should run.
      *
-     * Use this when the review finds the user is asking about package scripts,
-     * config files, generated output, prose documentation, or an answer that
-     * the current graph result already settled.
+     * Use this only when the next evidence is outside the indexed TypeScript
+     * graph: package scripts, config files, generated output, prose docs, exact
+     * text, or exact source body text. Name the smallest returned sourceSpan
+     * when source body text is truly required.
      */
     reason: string;
 
     /**
-     * The next non-graph step, if useful.
+     * The final non-graph note, if useful.
      *
-     * Keep this short. Examples: `answer from the prior graph result`, `inspect
-     * package.json`, or `ask the user for a concrete symbol`.
+     * Keep this short. Examples: `answer from the prior graph result`, `source
+     * body needed at returned sourceSpan`, or `ask the user for a concrete
+     * symbol`.
      */
     nextStep?: string;
   }

package/src/structures/ITtscGraphLookup.ts

@@ -1,61 +1,82 @@
 import { ITtscGraphDecorator } from "./ITtscGraphDecorator";
+import { ITtscGraphNext } from "./ITtscGraphNext";
 
-/** The ranked hits returned by targeted symbol lookup. */
+/** Targeted symbol lookup when a concrete name or handle is being resolved. */
 export interface ITtscGraphLookup {
   /** Discriminator for targeted symbol lookup. */
   type: "lookup";
 
+  /** Ranked symbol matches for the query. */
   hits: ITtscGraphLookup.IHit[];
 
-  /** Follow-up handles for selected symbol details. */
-  next: ITtscGraphLookup.INext;
+  /** How to use this source-free result next. */
+  next: ITtscGraphNext;
+
+  /** Human-readable compatibility note mirroring `next`. */
+  guide: string;
 }
 export namespace ITtscGraphLookup {
-  /** Find the symbols and clusters most relevant to a natural code query. */
+  /** Find a concrete class, method, function, property, type, or dotted handle. */
   export interface IRequest {
     /** Discriminator for targeted symbol lookup. */
     type: "lookup";
 
     /**
      * What to find, in natural language and code vocabulary mixed freely: a
-     * symbol name, a dotted member (`OrderService.create`), or a phrase
-     * (`shopping order create`, `repository find relations`). Exact names are
-     * not required; subword and CamelCase matches rank too.
+     * symbol name, a dotted member (`Service.create`), or a short phrase
+     * (`request handler`). Exact names are not required, but this is not a
+     * second broad entrypoints call. Use it when a named handle is missing or
+     * ambiguous.
      */
     query: string;
 
     /**
      * Maximum hits to return.
      *
+     * Prefer the default. Large hit lists usually mean the query is too broad;
+     * refine the name instead of raising this.
+     *
      * @default 5
      */
     limit?: number;
+
+    /**
+     * Include dependency-boundary declarations from node_modules or bundled
+     * `.d.ts` libraries. Leave false for project-source answers; enable only
+     * when external type/API boundaries are the question.
+     *
+     * @default false
+     */
+    includeExternal?: boolean;
   }
 
   /** One ranked hit with a handle to follow via `details` or `trace`. */
   export interface IHit {
+    /** Stable node id for subsequent graph calls. */
     id: string;
+
+    /** Qualified symbol name when available, otherwise the simple name. */
     name: string;
+
+    /** Declaration kind (`class`, `method`, `function`, ...). */
     kind: string;
+
+    /** Project-relative path of the declaration file. */
     file: string;
+
     /** 1-based declaration line, when known. */
     line?: number;
+
     /**
      * The hit's declaration signature, so you can often answer without
      * requesting details.
      */
     signature?: string;
+
     /** Decorators written on this declaration, when any. */
     decorators?: ITtscGraphDecorator[];
+
     /** Relative relevance; higher is a better match. */
     score: number;
   }
-
-  /** Tool-call handles suggested by this lookup result. */
-  export interface INext {
-    /** Pass these ids to `details` for source-free symbol facts. */
-    details: string[];
-    /** Pass these ids to `trace` when following dependency flow. */
-    traceFrom: string[];
-  }
 }

package/src/structures/ITtscGraphNext.ts

@@ -0,0 +1,23 @@
+/** The required next step from a compiler-derived graph result. */
+export interface ITtscGraphNext {
+  /**
+   * Answer, continue graph inspection, leave graph, or clarify.
+   *
+   * `answer` means the returned graph result already carries the evidence
+   * contract for the current question, even when the slice is capped. Do not
+   * call graph again or read files to re-check or complete it.
+   */
+  action: "answer" | "inspect" | "outside" | "clarify";
+
+  /** Smallest graph request type to use when `action` is `inspect`. */
+  request?:
+    | "entrypoints"
+    | "lookup"
+    | "trace"
+    | "details"
+    | "overview"
+    | "tour";
+
+  /** Why the returned graph evidence supports that action. */
+  reason: string;
+}

package/src/structures/ITtscGraphOverview.ts

@@ -1,7 +1,6 @@
-/**
- * A compact, source-read-free architecture map of the project returned by
- * `overview`.
- */
+import { ITtscGraphNext } from "./ITtscGraphNext";
+
+/** A compact, source-read-free project map for broad orientation only. */
 export interface ITtscGraphOverview {
   /** Discriminator for source-free project overview. */
   type: "overview";
@@ -12,6 +11,12 @@ export interface ITtscGraphOverview {
   /** Size of the graph. */
   counts: ITtscGraphOverview.ICounts;
 
+  /** How to use this source-free result next. */
+  next: ITtscGraphNext;
+
+  /** Human-readable compatibility note mirroring `next`. */
+  guide: string;
+
   /** Folder layering, largest first. */
   layers?: ITtscGraphOverview.ILayer[];
 
@@ -22,7 +27,7 @@ export interface ITtscGraphOverview {
   publicApi?: ITtscGraphOverview.IPublicApi[];
 }
 export namespace ITtscGraphOverview {
-  /** Which architecture facets `overview` should return. */
+  /** Which broad architecture facets `overview` should return. */
   export interface IRequest {
     /** Discriminator for source-free project overview. */
     type: "overview";
@@ -32,6 +37,10 @@ export namespace ITtscGraphOverview {
      * layering, `hotspots` the highest-dependency symbols, `publicApi` the
      * exported API symbols ranked by how depended-on they are.
      *
+     * Use this only for broad public API or layer orientation. For behavior,
+     * lifecycle, request-flow, rendering-flow, validation-flow, caller, or
+     * dependency questions, use `entrypoints` then `trace` instead.
+     *
      * @default "all"
      */
     aspect?: "all" | "layers" | "hotspots" | "publicApi";
@@ -39,9 +48,15 @@ export namespace ITtscGraphOverview {
 
   /** Size of the graph by node/edge totals and per-kind node counts. */
   export interface ICounts {
+    /** Number of source file container nodes. */
     files: number;
+
+    /** Total node count, including declarations and file containers. */
     nodes: number;
+
+    /** Total edge count, including structural edges. */
     edges: number;
+
     /** Node count per kind. */
     byKind: Record<string, number>;
   }

package/src/structures/ITtscGraphTour.ts

@@ -0,0 +1,150 @@
+import { ITtscGraphDecorator } from "./ITtscGraphDecorator";
+import { ITtscGraphNext } from "./ITtscGraphNext";
+
+/** Answer-ready, source-free tour evidence for broad code-flow questions. */
+export interface ITtscGraphTour {
+  /** Discriminator for code-tour indexing. */
+  type: "tour";
+
+  /** Natural code question this tour was built for. */
+  query: string;
+
+  /** Central entrypoints selected for the tour. */
+  entrypoints: ITtscGraphTour.INode[];
+
+  /** Selected primary runtime flows; sufficient for an index-level tour. */
+  primaryFlow: ITtscGraphTour.IFlow[];
+
+  /** Nearby dependency anchors around the selected entrypoints. */
+  nearby: ITtscGraphTour.IAnchor[];
+
+  /** Test or usage anchors reached through graph impact edges. */
+  tests: ITtscGraphTour.IAnchor[];
+
+  /** Ordered file/line anchors to cite in the final answer, not file reads. */
+  answerAnchors: ITtscGraphTour.IAnchor[];
+
+  /** How to use this source-free result next. */
+  next: ITtscGraphNext;
+
+  /** Human-readable compatibility note mirroring `next`. */
+  guide: string;
+
+  /** True when any internal slice hit its cap. */
+  truncated?: boolean;
+}
+
+export namespace ITtscGraphTour {
+  /**
+   * Build the complete index-level answer surface for broad code tours: central
+   * entrypoints, primary flow, nearby paths, tests, and answer anchors. Use
+   * this instead of decomposing repository-orientation, read-next,
+   * architecture, or multi-phase runtime-flow questions into many
+   * lookup/details/trace calls.
+   */
+  export interface IRequest {
+    /** Discriminator for code-tour indexing. */
+    type: "tour";
+
+    /** The user's natural code-tour question. */
+    query: string;
+
+    /**
+     * Maximum central entrypoints to seed the tour.
+     *
+     * Prefer the default. Raise only when the question names several distinct
+     * public paths that must all appear in one answer.
+     *
+     * @default 4
+     */
+    limit?: number;
+
+    /**
+     * Include graph-reached test or usage anchors when available.
+     *
+     * @default true
+     */
+    includeTests?: boolean;
+  }
+
+  /** A compact symbol coordinate for a tour. */
+  export interface INode {
+    /** Stable node id for later graph calls. */
+    id: string;
+
+    /** Qualified symbol name when available, otherwise the simple name. */
+    name: string;
+
+    /** Declaration kind (`class`, `method`, `function`, ...). */
+    kind: string;
+
+    /** Project-relative declaration file. */
+    file: string;
+
+    /** 1-based declaration line, when known. */
+    line?: number;
+
+    /** Declaration or implementation range, when known. */
+    sourceSpan?: ITtscGraphTour.ISpan;
+
+    /** Declaration head, when available. */
+    signature?: string;
+
+    /** Decorators written on the declaration, when any. */
+    decorators?: ITtscGraphDecorator[];
+  }
+
+  /** A primary flow slice from one selected entrypoint. */
+  export interface IFlow {
+    /** Flow start node. */
+    start: ITtscGraphTour.INode;
+
+    /** Compact edge summaries in graph order. */
+    steps: string[];
+
+    /** Nodes reached by this flow. */
+    reached: ITtscGraphTour.INode[];
+
+    /** Edge and node anchors that explain the flow. */
+    anchors: ITtscGraphTour.IAnchor[];
+
+    /** True when the flow hit graph caps. */
+    truncated?: boolean;
+  }
+
+  /** A file/line citation chosen by the graph, not source body text. */
+  export interface IAnchor {
+    /** Why this anchor matters in the tour. */
+    reason: string;
+
+    /** Stable node id when the anchor belongs to a node. */
+    id?: string;
+
+    /** Symbol, edge, or test name to show in the answer. */
+    name: string;
+
+    /** Declaration kind, when this anchor belongs to a node. */
+    kind?: string;
+
+    /** Project-relative file. */
+    file: string;
+
+    /** 1-based start line. */
+    startLine: number;
+
+    /** 1-based end line, when known. */
+    endLine?: number;
+  }
+
+  /** Source coordinates without source text. */
+  export interface ISpan {
+    /** Project-relative file. */
+    file: string;
+
+    /** 1-based start line. */
+    startLine: number;
+
+    /** 1-based end line, when known. */
+    endLine?: number;
+  }
+}