codegraph-java 0.1.0

package/dist/ui-server/api/deadcode.d.ts

@@ -0,0 +1,84 @@
+/**
+ * `GET /api/deadcode` — symbols nothing in this repository reaches, grouped by
+ * the file they live in (design spec §3.11).
+ *
+ * The derivation is `src/graph/dead-code.ts`, shared so that a second surface
+ * asking the same question cannot get a different answer. This module is the
+ * renderer, and it has exactly two jobs beyond flattening: hand the report a
+ * source reader that goes through the viewer's read chokepoint, and carry the
+ * exclusion counts onto the wire so the screen can say what the list could not
+ * see. A dead code list without that sentence is a screen that quietly invites
+ * somebody to delete a route handler.
+ *
+ * The rows come back ranked (largest first) and are grouped by file for
+ * display, not re-ranked: the group order follows the best row in it, so the
+ * biggest finding is still at the top of the screen.
+ */
+import type { CodeGraph } from '../../index';
+import type { NodeKind } from '../../types';
+import { MAX_DEAD_CODE_CANDIDATES, type DeadCodeExclusions } from '../../graph/dead-code';
+import { type WireList, type WireNodeRef } from './wire';
+/** Rows carried on the payload. The screen shows every one it is given. */
+export declare const MAX_DEAD_CODE_ROWS = 300;
+/** Members folded under one row before the row just counts them. */
+export declare const MAX_DEAD_CODE_MEMBERS = 12;
+/** One symbol nothing reaches. */
+export interface WireDeadCodeRow extends WireNodeRef {
+    /** Source lines it spans — the rank, and what deleting it would remove. */
+    lines: number;
+    /**
+     * Members that are unreferenced and live inside this one: a class nobody
+     * instantiates takes its methods with it. Capped; `total` stays real.
+     */
+    members: WireList<WireNodeRef>;
+}
+/** The rows of one file, in source order. */
+export interface WireDeadCodeGroup {
+    file: string;
+    /** Tool-generated — drawn dimmed wherever it appears (design spec §2.6). */
+    generated: boolean;
+    test: boolean;
+    /** Lines the rows in this group add up to. */
+    lines: number;
+    rows: WireDeadCodeRow[];
+}
+/** One reason candidates were dropped, in the words the screen prints. */
+export interface WireDeadCodeExclusion {
+    reason: keyof DeadCodeExclusions;
+    count: number;
+    label: string;
+}
+export interface WireDeadCode {
+    /** Ranked, flat, capped. `total` is the real number of findings. */
+    rows: WireList<WireDeadCodeRow>;
+    /** The SHOWN rows, grouped by file — group order follows the best row. */
+    groups: WireDeadCodeGroup[];
+    /** Symbols with no incoming reference at all, before any exclusion ran. */
+    candidates: number;
+    /** Every exclusion that removed at least one candidate, biggest first. */
+    excluded: WireDeadCodeExclusion[];
+    /** How many candidates every exclusion removed between them. */
+    excludedTotal: number;
+    kinds: NodeKind[];
+    /** Symbols reachable from outside the index are on the list. */
+    includeExported: boolean;
+    includeTests: boolean;
+    includeGenerated: boolean;
+    /** The candidate scan stopped at its cap; there are more. */
+    bounded: boolean;
+    /** Every row was checked against the text of the files that can reach it. */
+    corroborated: boolean;
+    timing: {
+        elapsedMs: number;
+    };
+}
+export declare function parseDeadCodeQuery(query: URLSearchParams): {
+    limit: number;
+    includeExported: boolean;
+    includeTests: boolean;
+    includeGenerated: boolean;
+    kinds: NodeKind[] | undefined;
+};
+export declare function buildDeadCode(cg: CodeGraph, projectRoot: string, query: URLSearchParams): WireDeadCode;
+export { MAX_DEAD_CODE_CANDIDATES };
+//# sourceMappingURL=deadcode.d.ts.map

package/dist/ui-server/api/deadcode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deadcode.d.ts","sourceRoot":"","sources":["../../../src/ui-server/api/deadcode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAIL,wBAAwB,EACxB,KAAK,kBAAkB,EACxB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAuB,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE9E,2EAA2E;AAC3E,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAEtC,oEAAoE;AACpE,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,kCAAkC;AAClC,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,OAAO,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;CAChC;AAED,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,4EAA4E;IAC5E,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,OAAO,CAAC;IACd,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,eAAe,EAAE,CAAC;CACzB;AAED,0EAA0E;AAC1E,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,kBAAkB,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,oEAAoE;IACpE,IAAI,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAChC,0EAA0E;IAC1E,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAC;IACnB,0EAA0E;IAC1E,QAAQ,EAAE,qBAAqB,EAAE,CAAC;IAClC,gEAAgE;IAChE,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,gEAAgE;IAChE,eAAe,EAAE,OAAO,CAAC;IACzB,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB,6EAA6E;IAC7E,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/B;AA4BD,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,eAAe,GAAG;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,OAAO,CAAC;IACzB,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,KAAK,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC;CAC/B,CAeA;AAED,wBAAgB,aAAa,CAC3B,EAAE,EAAE,SAAS,EACb,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,eAAe,GACrB,YAAY,CA6Ed;AAED,OAAO,EAAE,wBAAwB,EAAE,CAAC"}

package/dist/ui-server/api/deadcode.js

@@ -0,0 +1,136 @@
+"use strict";
+/**
+ * `GET /api/deadcode` — symbols nothing in this repository reaches, grouped by
+ * the file they live in (design spec §3.11).
+ *
+ * The derivation is `src/graph/dead-code.ts`, shared so that a second surface
+ * asking the same question cannot get a different answer. This module is the
+ * renderer, and it has exactly two jobs beyond flattening: hand the report a
+ * source reader that goes through the viewer's read chokepoint, and carry the
+ * exclusion counts onto the wire so the screen can say what the list could not
+ * see. A dead code list without that sentence is a screen that quietly invites
+ * somebody to delete a route handler.
+ *
+ * The rows come back ranked (largest first) and are grouped by file for
+ * display, not re-ranked: the group order follows the best row in it, so the
+ * biggest finding is still at the top of the screen.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_DEAD_CODE_CANDIDATES = exports.MAX_DEAD_CODE_MEMBERS = exports.MAX_DEAD_CODE_ROWS = void 0;
+exports.parseDeadCodeQuery = parseDeadCodeQuery;
+exports.buildDeadCode = buildDeadCode;
+const dead_code_1 = require("../../graph/dead-code");
+Object.defineProperty(exports, "MAX_DEAD_CODE_CANDIDATES", { enumerable: true, get: function () { return dead_code_1.MAX_DEAD_CODE_CANDIDATES; } });
+const respond_1 = require("./respond");
+const source_1 = require("./source");
+const wire_1 = require("./wire");
+/** Rows carried on the payload. The screen shows every one it is given. */
+exports.MAX_DEAD_CODE_ROWS = 300;
+/** Members folded under one row before the row just counts them. */
+exports.MAX_DEAD_CODE_MEMBERS = 12;
+/**
+ * The sentence each exclusion prints under the list.
+ *
+ * Written as "N <label>" — so each one reads as a count of candidates, in the
+ * reader's language rather than in the rule's.
+ */
+const EXCLUSION_LABELS = {
+    tests: 'in test files',
+    generated: 'in generated files',
+    exported: 'exported, or declared in a header',
+    exportsUnknown: 'in languages this index records no exports for',
+    declarations: 'abstract, or declared on an interface',
+    decorated: 'carrying a decorator, so a framework registers them',
+    overriding: 'overriding a member declared further up',
+    implicit: 'named something the language calls by itself',
+    vendored: 'in vendored directories',
+    testScope: 'inside a test module',
+    markup: 'in component files, where markup can reference them invisibly',
+    unreachableFile: 'in files nothing reaches — islands, drawn on the map',
+    unresolvedName: 'sharing a name the index failed to resolve somewhere',
+    ambiguousName: 'sharing a name with a symbol that IS referenced',
+    mentioned: 'written more than once in a file that can reach them',
+    unreadable: 'in files that could not be read',
+    nested: 'folded into a container on this list',
+};
+function parseDeadCodeQuery(query) {
+    const raw = query.get('kinds');
+    const kinds = raw
+        ? raw
+            .split(',')
+            .map((kind) => kind.trim())
+            .filter((kind) => dead_code_1.DEAD_CODE_ALLOWED_KINDS.has(kind))
+        : undefined;
+    return {
+        limit: (0, respond_1.intParam)(query, 'limit', { min: 1, max: exports.MAX_DEAD_CODE_ROWS, default: exports.MAX_DEAD_CODE_ROWS }),
+        includeExported: query.get('exported') === '1',
+        includeTests: query.get('tests') === '1',
+        includeGenerated: query.get('generated') === '1',
+        kinds: kinds && kinds.length > 0 ? kinds : undefined,
+    };
+}
+function buildDeadCode(cg, projectRoot, query) {
+    const started = Date.now();
+    const options = parseDeadCodeQuery(query);
+    const report = (0, dead_code_1.buildDeadCodeReport)(cg, {
+        kinds: options.kinds,
+        includeExported: options.includeExported,
+        includeTests: options.includeTests,
+        includeGenerated: options.includeGenerated,
+        limit: options.limit,
+        // The chokepoint, not `fs`: the viewer never opens a path the index does
+        // not name and `resolveProjectFile` has not cleared.
+        readSource: (filePath) => (0, source_1.readIndexedFileText)(cg, projectRoot, filePath, dead_code_1.MAX_CORROBORATION_BYTES),
+    });
+    const generatedFiles = cg.generatedFilePredicate(report.entries.map((entry) => entry.node.filePath));
+    // Groups follow the rows' order: the first time a file appears is where its
+    // group sits, so the largest finding is still at the top of the screen.
+    const rows = [];
+    const groups = [];
+    const byFile = new Map();
+    for (const entry of report.entries) {
+        const row = {
+            ...(0, wire_1.toNodeRef)(entry.node),
+            lines: entry.lines,
+            members: (0, wire_1.wireList)(entry.members.slice(0, exports.MAX_DEAD_CODE_MEMBERS).map((member) => (0, wire_1.toNodeRef)(member)), entry.members.length),
+        };
+        rows.push(row);
+        let group = byFile.get(row.file);
+        if (!group) {
+            group = {
+                file: row.file,
+                // The path convention plus the indexed banner verdict, both, so a
+                // generated file dims here for the same reason it dims on the map.
+                generated: generatedFiles(entry.node.filePath),
+                test: row.test,
+                lines: 0,
+                rows: [],
+            };
+            byFile.set(row.file, group);
+            groups.push(group);
+        }
+        group.rows.push(row);
+        group.lines += row.lines;
+    }
+    for (const group of groups)
+        group.rows.sort((a, b) => a.line - b.line);
+    const excluded = Object.keys(report.excluded)
+        .map((reason) => ({ reason, count: report.excluded[reason], label: EXCLUSION_LABELS[reason] }))
+        .filter((entry) => entry.count > 0)
+        .sort((a, b) => b.count - a.count || a.reason.localeCompare(b.reason));
+    return {
+        rows: (0, wire_1.wireList)(rows, report.total),
+        groups,
+        candidates: report.candidates,
+        excluded,
+        excludedTotal: excluded.reduce((sum, entry) => sum + entry.count, 0),
+        kinds: report.kinds,
+        includeExported: report.includeExported,
+        includeTests: options.includeTests,
+        includeGenerated: options.includeGenerated,
+        bounded: report.bounded,
+        corroborated: report.corroborated,
+        timing: { elapsedMs: Date.now() - started },
+    };
+}
+//# sourceMappingURL=deadcode.js.map

package/dist/ui-server/api/deadcode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deadcode.js","sourceRoot":"","sources":["../../../src/ui-server/api/deadcode.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;AAmGH,gDAqBC;AAED,sCAiFC;AAvMD,qDAM+B;AAmMtB,yGArMP,oCAAwB,OAqMO;AAlMjC,uCAAqC;AACrC,qCAA+C;AAC/C,iCAA8E;AAE9E,2EAA2E;AAC9D,QAAA,kBAAkB,GAAG,GAAG,CAAC;AAEtC,oEAAoE;AACvD,QAAA,qBAAqB,GAAG,EAAE,CAAC;AAsDxC;;;;;GAKG;AACH,MAAM,gBAAgB,GAA6C;IACjE,KAAK,EAAE,eAAe;IACtB,SAAS,EAAE,oBAAoB;IAC/B,QAAQ,EAAE,mCAAmC;IAC7C,cAAc,EAAE,gDAAgD;IAChE,YAAY,EAAE,uCAAuC;IACrD,SAAS,EAAE,qDAAqD;IAChE,UAAU,EAAE,yCAAyC;IACrD,QAAQ,EAAE,8CAA8C;IACxD,QAAQ,EAAE,yBAAyB;IACnC,SAAS,EAAE,sBAAsB;IACjC,MAAM,EAAE,+DAA+D;IACvE,eAAe,EAAE,sDAAsD;IACvE,cAAc,EAAE,sDAAsD;IACtE,aAAa,EAAE,iDAAiD;IAChE,SAAS,EAAE,sDAAsD;IACjE,UAAU,EAAE,iCAAiC;IAC7C,MAAM,EAAE,sCAAsC;CAC/C,CAAC;AAEF,SAAgB,kBAAkB,CAAC,KAAsB;IAOvD,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,GAAG;QACf,CAAC,CAAE,GAAG;aACD,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mCAAuB,CAAC,GAAG,CAAC,IAAgB,CAAC,CAAgB;QACnF,CAAC,CAAC,SAAS,CAAC;IACd,OAAO;QACL,KAAK,EAAE,IAAA,kBAAQ,EAAC,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,0BAAkB,EAAE,OAAO,EAAE,0BAAkB,EAAE,CAAC;QACjG,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,GAAG;QAC9C,YAAY,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,GAAG;QACxC,gBAAgB,EAAE,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,GAAG;QAChD,KAAK,EAAE,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;KACrD,CAAC;AACJ,CAAC;AAED,SAAgB,aAAa,CAC3B,EAAa,EACb,WAAmB,EACnB,KAAsB;IAEtB,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;IAE1C,MAAM,MAAM,GAAG,IAAA,+BAAmB,EAAC,EAAE,EAAE;QACrC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,eAAe,EAAE,OAAO,CAAC,eAAe;QACxC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;QAC1C,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,yEAAyE;QACzE,qDAAqD;QACrD,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE,CACvB,IAAA,4BAAmB,EAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,mCAAuB,CAAC;KAC1E,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,EAAE,CAAC,sBAAsB,CAC9C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CACnD,CAAC;IAEF,4EAA4E;IAC5E,wEAAwE;IACxE,MAAM,IAAI,GAAsB,EAAE,CAAC;IACnC,MAAM,MAAM,GAAwB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAA6B,CAAC;IAEpD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnC,MAAM,GAAG,GAAoB;YAC3B,GAAG,IAAA,gBAAS,EAAC,KAAK,CAAC,IAAI,CAAC;YACxB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,IAAA,eAAQ,EACf,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,6BAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,gBAAS,EAAC,MAAM,CAAC,CAAC,EAChF,KAAK,CAAC,OAAO,CAAC,MAAM,CACrB;SACF,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEf,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG;gBACN,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,kEAAkE;gBAClE,mEAAmE;gBACnE,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC9C,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,CAAC;gBACR,IAAI,EAAE,EAAE;aACT,CAAC;YACF,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,KAAK,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC;IAC3B,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IAEvE,MAAM,QAAQ,GACZ,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAC5B;SACE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC9F,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;SAClC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAEzE,OAAO;QACL,IAAI,EAAE,IAAA,eAAQ,EAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;QAClC,MAAM;QACN,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ;QACR,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACpE,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;QAC1C,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO,EAAE;KAC5C,CAAC;AACJ,CAAC"}

package/dist/ui-server/api/effects.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Effects — calls that leave the index and change something outside the
+ * process — for the Steps view. A curated table, deliberately: "any call into
+ * a package" is every `Date` and `Math.max`, and a box for each would bury
+ * the ones that matter. Matched on the CALL AS WRITTEN — the whole member
+ * chain read from the source at request time (`prisma.article.findFirst`,
+ * `this.jwtService.signAsync`, `res.status(404).json`), because the index
+ * keeps only the last segment of a deep chain — and, for a few families, on
+ * the declared type of the receiver when the graph has it (`OwnerRepository
+ * owners` → `owners.save` is the database).
+ *
+ * The categories are the reader's, not a library's: what a request sets in
+ * motion is a database write, a response, a job on a queue, an email, a
+ * charge, a cache read, a token check, a call to another service, a file, a
+ * process. `response` is the endpoint's contract as the code has it — every
+ * `res.status(404).json(…)`, `throw new NotFoundException(…)`,
+ * `raise HTTPException(…)`, `ResponseEntity.notFound()` — and each site
+ * carries the status code when it is literal.
+ *
+ * Language gates keep a rule from firing where it means something else: a
+ * bare `open(…)` is a file in Python and nothing in particular in TypeScript;
+ * `session.get` is the ORM in Python and a request in the browser. A rule
+ * without a gate applies everywhere. Order matters — the first match wins —
+ * so the specific rows sit above the general ones.
+ */
+import type { Language } from '../../types';
+export type EffectCategory = 'network' | 'storage' | 'device' | 'telemetry' | 'database' | 'response' | 'queue' | 'email' | 'payments' | 'cache' | 'auth' | 'process';
+export type ProjectKind = 'app' | 'api' | 'web';
+type Family = 'js' | 'py' | 'jvm' | 'cs' | 'go' | 'c' | 'rb' | 'php' | 'swift' | 'rs';
+export interface EffectRule {
+    category: EffectCategory;
+    test: RegExp;
+    /** Families the rule applies to; absent = every language. */
+    only?: readonly Family[];
+    /** Only for `new X(…)` / a constructor call. */
+    instantiates?: boolean;
+}
+/** The table. Order matters: first match wins. */
+export declare const EFFECT_RULES: ReadonlyArray<EffectRule>;
+export interface EffectInput {
+    /** The call as written (the whole member chain), or the reference name the index kept. */
+    text: string;
+    kind: 'calls' | 'instantiates';
+    language?: Language | null;
+    project?: ProjectKind;
+    /** The declared type of the receiver, when the graph has it (`OwnerRepository`). */
+    receiverType?: string | null;
+    /** The argument list, abbreviated, when it was read — where the model of a `knex('users')` comes from. */
+    args?: string | null;
+}
+export interface Effect {
+    category: EffectCategory;
+    /** The table / model / collection, when it can be read off the call: `user`, `Owner`, `TodoItems`. */
+    model?: string;
+    /** Read or write, from the method name. Only for `database`. */
+    access?: 'read' | 'write';
+}
+/** Normalise the call text the rules see: `await`/`new` dropped, `?.` as `.`, `this.` kept. */
+export declare function normaliseCall(text: string): string;
+/**
+ * What a call is, when it is one of the things the table names. `null` for
+ * everything else — a plain call into a library is not an effect.
+ */
+export declare function classifyEffect(input: EffectInput): Effect | null;
+/**
+ * The status code a response site sends, when it is literal: the number in
+ * `res.status(404)`, the name in `ResponseEntity.notFound()`,
+ * `throw new NotFoundException()`, `c.JSON(http.StatusCreated, …)`,
+ * `HTTPException(status_code=404)`, `Abort(.notFound)`. Null when the code
+ * is a variable or the site sets none.
+ */
+export declare function responseStatus(text: string, args: string | null | undefined, _kind?: 'calls' | 'instantiates'): number | null;
+/**
+ * The status a reply sends when it sets none — 200 — for the calls that send a
+ * body and default to it: Express / Koa / Fastify / Hono `res.json`,
+ * `res.send`, `res.render`, `reply.send`, `c.json`; `NextResponse.json`;
+ * Python's `JSONResponse`, `jsonify`, `render_template`, `HttpResponse`;
+ * Rails' `render`; Laravel's `response()->json`. Null when the chain sets a
+ * status of its own (`res.status(code).json` — a variable code is unknown,
+ * not 200), when the call ends a response without a body (`end`,
+ * `sendStatus`), or when the call is not one of these.
+ */
+export declare function implicitResponseStatus(text: string): number | null;
+/** The word the legend and a box's sub line use for a category. */
+export declare function categoryWord(category: string): string;
+export {};
+//# sourceMappingURL=effects.d.ts.map

package/dist/ui-server/api/effects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"effects.d.ts","sourceRoot":"","sources":["../../../src/ui-server/api/effects.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,MAAM,cAAc,GACtB,SAAS,GACT,SAAS,GACT,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,OAAO,GACP,OAAO,GACP,UAAU,GACV,OAAO,GACP,MAAM,GACN,SAAS,CAAC;AAEd,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAEhD,KAAK,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,KAAK,GAAG,OAAO,GAAG,IAAI,CAAC;AAetF,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,cAAc,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAYD,kDAAkD;AAClD,eAAO,MAAM,YAAY,EAAE,aAAa,CAAC,UAAU,CAiIlD,CAAC;AAsBF,MAAM,WAAW,WAAW;IAC1B,0FAA0F;IAC1F,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,GAAG,cAAc,CAAC;IAC/B,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC3B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,0GAA0G;IAC1G,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,cAAc,CAAC;IACzB,sGAAsG;IACtG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B;AASD,+FAA+F;AAC/F,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQlD;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAoChE;AAsFD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,KAAK,GAAE,OAAO,GAAG,cAAwB,GAAG,MAAM,GAAG,IAAI,CAiDtI;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAUlE;AAoCD,mEAAmE;AACnE,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAqBrD"}