@beignet/cli 0.0.40 → 0.0.42

package/dist/explain.d.ts

@@ -0,0 +1,100 @@
+import { type AppMapEdge, type AppMapNodeKind, type AppMapNodeStatus, type AppMapResult, type AppMapSource } from "./app-map.js";
+/** Targets supported by `beignet explain` and the MCP `explain` tool. */
+export declare const explainTargetKinds: readonly ["feature", "contract", "route", "route-group", "use-case", "policy", "ability", "event", "listener", "job", "schedule", "task", "notification", "upload", "agent-capability", "registry", "port", "provider", "table", "openapi", "entrypoint", "test", "diagnostic"];
+/** One supported explanation target kind. */
+export type ExplainTargetKind = (typeof explainTargetKinds)[number];
+/** Options for resolving one app concept into a deterministic explanation. */
+export type ExplainAppOptions = {
+    cwd?: string;
+    kind: ExplainTargetKind;
+    target: string;
+};
+/** Identity and source metadata for the resolved explanation target. */
+export type ExplainTarget = {
+    kind: ExplainTargetKind;
+    id: string;
+    name: string;
+    runtimeName?: string;
+    feature?: string;
+    source?: AppMapSource;
+    status?: AppMapNodeStatus;
+    details?: Record<string, unknown>;
+};
+/** Compact app-map node embedded in an explained relationship. */
+export type ExplainRelatedNode = {
+    id: string;
+    kind: AppMapNodeKind;
+    name: string;
+    runtimeName?: string;
+    feature?: string;
+    source: AppMapSource;
+    status?: AppMapNodeStatus;
+    details?: Record<string, unknown>;
+};
+/** One source-backed relationship connected to the explanation scope. */
+export type ExplainRelationship = {
+    kind: AppMapEdge["kind"];
+    from: ExplainRelatedNode;
+    to: ExplainRelatedNode;
+    evidence: AppMapEdge["evidence"];
+    details?: Record<string, unknown>;
+};
+/** Normalized doctor, lint, or app-map finding relevant to the target. */
+export type ExplainFinding = {
+    source: "doctor" | "lint" | "app-map";
+    severity: "error" | "warning" | "hint";
+    code: string;
+    message: string;
+    location?: AppMapSource;
+    details?: Record<string, unknown>;
+};
+/** Source location supporting one part of the explanation. */
+export type ExplainEvidence = {
+    source: AppMapSource;
+    reason: string;
+};
+/** Source file suggested for inspection, with the reasons it is relevant. */
+export type ExplainSuggestedFile = {
+    file: string;
+    line?: number;
+    column?: number;
+    reasons: string[];
+};
+/** Deterministic next action derived from the mapped target and findings. */
+export type ExplainSuggestedAction = {
+    kind: "inspect" | "address-finding" | "validate";
+    description: string;
+    command?: string;
+    cwd?: string;
+    file?: string;
+};
+/** Version 1 deterministic explanation of one app-map target. */
+export type ExplainAppResult = {
+    schemaVersion: 1;
+    targetDir: string;
+    app: AppMapResult["app"];
+    query: {
+        kind: ExplainTargetKind;
+        target: string;
+    };
+    target: ExplainTarget;
+    summary: string;
+    scope: {
+        nodes: number;
+        relationships: number;
+        returnedRelationships: number;
+        findings: number;
+        truncated: boolean;
+    };
+    evidence: ExplainEvidence[];
+    relationships: ExplainRelationship[];
+    conventions: string[];
+    findings: ExplainFinding[];
+    suggestedFiles: ExplainSuggestedFile[];
+    suggestedActions: ExplainSuggestedAction[];
+};
+/** Explain one source-backed Beignet app concept without generating advice. */
+export declare function explainApp(options: ExplainAppOptions): Promise<ExplainAppResult>;
+/** Format a concise, source-backed explanation for terminal use. */
+export declare function formatExplain(result: ExplainAppResult): string;
+//# sourceMappingURL=explain.d.ts.map

package/dist/explain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explain.d.ts","sourceRoot":"","sources":["../src/explain.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EAEf,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,YAAY,EAGlB,MAAM,cAAc,CAAC;AAGtB,yEAAyE;AACzE,eAAO,MAAM,kBAAkB,iRAA8C,CAAC;AAE9E,6CAA6C;AAC7C,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEpE,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wEAAwE;AACxE,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,iBAAiB,CAAC;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACzB,IAAI,EAAE,kBAAkB,CAAC;IACzB,EAAE,EAAE,kBAAkB,CAAC;IACvB,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,0EAA0E;AAC1E,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,YAAY,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,6EAA6E;AAC7E,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,6EAA6E;AAC7E,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,SAAS,GAAG,iBAAiB,GAAG,UAAU,CAAC;IACjD,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,EAAE,CAAC,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;IACzB,KAAK,EAAE;QACL,IAAI,EAAE,iBAAiB,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,aAAa,EAAE,MAAM,CAAC;QACtB,qBAAqB,EAAE,MAAM,CAAC;QAC9B,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;IACF,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,cAAc,EAAE,oBAAoB,EAAE,CAAC;IACvC,gBAAgB,EAAE,sBAAsB,EAAE,CAAC;CAC5C,CAAC;AAQF,+EAA+E;AAC/E,wBAAsB,UAAU,CAC9B,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAwD3B;AAED,oEAAoE;AACpE,wBAAgB,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CA6C9D"}