@shrkcrft/inspector 0.1.0-alpha.2

package/dist/report-site.d.ts

@@ -0,0 +1,92 @@
+import type { ISharkcraftInspection } from './sharkcraft-inspector.js';
+export interface IBuildReportSiteOptions {
+    bundleId?: string;
+    /** Optional path to a pre-built review packet JSON to embed (v3 preferred). */
+    reviewPacketFile?: string;
+    /** Optional inclusion list — when present, only listed pages render. */
+    include?: readonly ReportSitePage[];
+    /** Optional path to a single impact report JSON to embed. */
+    impactFile?: string;
+    /** Optional directory of impact-report-*.json files to embed as a list. */
+    impactDir?: string;
+    /**
+     * When true, every embedded impact detail page also gets its Mermaid + DOT
+     * graph source rendered as copy-pasteable text. No JS / no external renderer
+     * required. Optionally we try `mmdc` or `dot` if available, but the page
+     * always works without them.
+     */
+    withImpactGraphs?: boolean;
+    /**
+     * When true (and `withImpactGraphs` is set), SharkCraft also tries to render
+     * the Mermaid + DOT source to SVG via `mmdc` / `dot` if those binaries are on
+     * PATH. Always best-effort: if the binary is missing or the render fails,
+     * the source-only behaviour is preserved.
+     *
+     * Setting this opts the user into running an external subprocess against
+     * locally-generated source files only.
+     */
+    renderImpactGraphs?: boolean;
+    /** Optional title shown in the report-site banner. */
+    title?: string;
+    /** Optional brand text shown in the page nav. */
+    brand?: string;
+    /** Optional URL of the safety-matrix doc to surface in the nav. */
+    safetyMatrixUrl?: string;
+    /** Optional URL of the runtime-compatibility report. */
+    runtimeCompatibilityUrl?: string;
+    /** Optional path to a bundle-diff JSON to embed. */
+    bundleDiffFile?: string;
+    /** Optional path to a pack-compat JSON report to embed as `pack-compat.html`. */
+    packCompatFile?: string;
+}
+export type ReportSitePage = 'overview' | 'quality' | 'bundles' | 'review' | 'coverage' | 'drift' | 'policies' | 'adoption' | 'safety' | 'impact' | 'area-map' | 'constructs' | 'pack-compat';
+export interface IReportSiteResult {
+    outputDir: string;
+    files: readonly string[];
+    /** Page → relative path map for quick links. */
+    pages: Record<string, string>;
+    /** Number of impact reports embedded. */
+    impactCount: number;
+    /** Whether a review packet was embedded. */
+    hasReview: boolean;
+    /** Pages we deliberately wrote a placeholder for. */
+    placeholderPages: readonly ReportSitePage[];
+    /** Mermaid / DOT artifacts written by --with-impact-graphs. */
+    impactGraphFiles?: readonly {
+        impact: number;
+        format: 'mermaid' | 'dot';
+        file: string;
+    }[];
+    /** SVG artifacts produced by --render-impact-graphs. */
+    impactSvgFiles?: readonly {
+        impact: number;
+        format: 'mermaid' | 'dot';
+        file: string;
+        renderer: 'mmdc' | 'dot';
+    }[];
+    /** Per-graph render diagnostics (e.g. renderer-missing). */
+    impactRenderDiagnostics?: readonly {
+        impact: number;
+        format: 'mermaid' | 'dot';
+        rendered: boolean;
+        reason?: string;
+        renderer?: string | null;
+    }[];
+}
+export interface IReportSitePage {
+    id: ReportSitePage;
+    file: string;
+    title: string;
+    kind: 'page' | 'detail' | 'placeholder';
+    populated: boolean;
+}
+export interface IReportSiteManifest {
+    schema: 'sharkcraft.report-site-manifest/v1';
+    outputDir: string;
+    generatedAt: string;
+    pages: readonly IReportSitePage[];
+    notes: readonly string[];
+}
+export declare function buildReportSite(inspection: ISharkcraftInspection, outputDir: string, options?: IBuildReportSiteOptions): Promise<IReportSiteResult>;
+export declare function buildReportSiteManifest(result: IReportSiteResult, hasReview: boolean): IReportSiteManifest;
+//# sourceMappingURL=report-site.d.ts.map

package/dist/report-site.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-site.d.ts","sourceRoot":"","sources":["../src/report-site.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAEvE,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wEAAwE;IACxE,OAAO,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IACpC,6DAA6D;IAC7D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wDAAwD;IACxD,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iFAAiF;IACjF,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,cAAc,GACtB,UAAU,GACV,SAAS,GACT,SAAS,GACT,QAAQ,GACR,UAAU,GACV,OAAO,GACP,UAAU,GACV,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,aAAa,CAAC;AAElB,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,4CAA4C;IAC5C,SAAS,EAAE,OAAO,CAAC;IACnB,qDAAqD;IACrD,gBAAgB,EAAE,SAAS,cAAc,EAAE,CAAC;IAC5C,+DAA+D;IAC/D,gBAAgB,CAAC,EAAE,SAAS;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,SAAS,GAAG,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC1F,wDAAwD;IACxD,cAAc,CAAC,EAAE,SAAS;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,SAAS,GAAG,KAAK,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,GAAG,KAAK,CAAC;KAC1B,EAAE,CAAC;IACJ,4DAA4D;IAC5D,uBAAuB,CAAC,EAAE,SAAS;QACjC,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,SAAS,GAAG,KAAK,CAAC;QAC1B,QAAQ,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B,EAAE,CAAC;CACL;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,cAAc,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,aAAa,CAAC;IACxC,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,oCAAoC,CAAC;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;IAClC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAgMD,wBAAsB,eAAe,CACnC,UAAU,EAAE,qBAAqB,EACjC,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,iBAAiB,CAAC,CAqe5B;AAiBD,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,OAAO,GACjB,mBAAmB,CAgDrB"}