@eightmedia/flightcheck 0.0.0-stage → 0.1.0

package/dist/analyze/report.d.ts

@@ -0,0 +1,283 @@
+import { z } from "zod";
+import { type BuildMarkdownOptions, type CrawlIssueCounts, type Tier1ReportData } from "./reportTier1.js";
+import { type StackProfile } from "./stack.js";
+export type { Tier1ReportData, BuildMarkdownOptions } from "./reportTier1.js";
+declare const recordSchema: z.ZodObject<{
+    url: z.ZodString;
+    status: z.ZodNullable<z.ZodNumber>;
+    h1: z.ZodString;
+    title: z.ZodString;
+    metaTitle: z.ZodString;
+    metaDescription: z.ZodString;
+    robots: z.ZodString;
+    template: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    mainCount: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
+    charset: z.ZodString;
+    language: z.ZodString;
+    colorScheme: z.ZodString;
+    themeColor: z.ZodString;
+    doctype: z.ZodString;
+    viewport: z.ZodString;
+    canonical: z.ZodString;
+    favicon: z.ZodString;
+    icons: z.ZodArray<z.ZodObject<{
+        rel: z.ZodString;
+        href: z.ZodString;
+        type: z.ZodString;
+        sizes: z.ZodString;
+        media: z.ZodString;
+    }, z.core.$strip>>;
+    og: z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        image: z.ZodString;
+        url: z.ZodString;
+        type: z.ZodString;
+        siteName: z.ZodString;
+    }, z.core.$strip>;
+    twitter: z.ZodObject<{
+        card: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        image: z.ZodString;
+    }, z.core.$strip>;
+    tracking: z.ZodObject<{
+        tagManager: z.ZodArray<z.ZodObject<{
+            provider: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>>;
+        analytics: z.ZodArray<z.ZodObject<{
+            provider: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    stack: z.ZodOptional<z.ZodObject<{
+        detections: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            categories: z.ZodArray<z.ZodString>;
+            confidence: z.ZodEnum<{
+                high: "high";
+                medium: "medium";
+                low: "low";
+            }>;
+            evidence: z.ZodArray<z.ZodString>;
+            website: z.ZodOptional<z.ZodString>;
+            version: z.ZodOptional<z.ZodString>;
+            detector: z.ZodOptional<z.ZodLiteral<"flightcheck-v1">>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    security: z.ZodOptional<z.ZodObject<{
+        secrets: z.ZodArray<z.ZodObject<{
+            type: z.ZodString;
+            provider: z.ZodString;
+            severity: z.ZodEnum<{
+                critical: "critical";
+                review: "review";
+            }>;
+            masked: z.ZodString;
+            source: z.ZodString;
+        }, z.core.$strip>>;
+        scannedAssets: z.ZodNumber;
+    }, z.core.$strip>>;
+    images: z.ZodOptional<z.ZodObject<{
+        issues: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            severity: z.ZodEnum<{
+                critical: "critical";
+                error: "error";
+                warning: "warning";
+                review: "review";
+            }>;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    a11yStatic: z.ZodOptional<z.ZodObject<{
+        issues: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            severity: z.ZodEnum<{
+                critical: "critical";
+                error: "error";
+                warning: "warning";
+                review: "review";
+            }>;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    note: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const reportSchema: z.ZodArray<z.ZodObject<{
+    url: z.ZodString;
+    status: z.ZodNullable<z.ZodNumber>;
+    h1: z.ZodString;
+    title: z.ZodString;
+    metaTitle: z.ZodString;
+    metaDescription: z.ZodString;
+    robots: z.ZodString;
+    template: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    mainCount: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodNumber>>>;
+    charset: z.ZodString;
+    language: z.ZodString;
+    colorScheme: z.ZodString;
+    themeColor: z.ZodString;
+    doctype: z.ZodString;
+    viewport: z.ZodString;
+    canonical: z.ZodString;
+    favicon: z.ZodString;
+    icons: z.ZodArray<z.ZodObject<{
+        rel: z.ZodString;
+        href: z.ZodString;
+        type: z.ZodString;
+        sizes: z.ZodString;
+        media: z.ZodString;
+    }, z.core.$strip>>;
+    og: z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        image: z.ZodString;
+        url: z.ZodString;
+        type: z.ZodString;
+        siteName: z.ZodString;
+    }, z.core.$strip>;
+    twitter: z.ZodObject<{
+        card: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodString;
+        image: z.ZodString;
+    }, z.core.$strip>;
+    tracking: z.ZodObject<{
+        tagManager: z.ZodArray<z.ZodObject<{
+            provider: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>>;
+        analytics: z.ZodArray<z.ZodObject<{
+            provider: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    stack: z.ZodOptional<z.ZodObject<{
+        detections: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            categories: z.ZodArray<z.ZodString>;
+            confidence: z.ZodEnum<{
+                high: "high";
+                medium: "medium";
+                low: "low";
+            }>;
+            evidence: z.ZodArray<z.ZodString>;
+            website: z.ZodOptional<z.ZodString>;
+            version: z.ZodOptional<z.ZodString>;
+            detector: z.ZodOptional<z.ZodLiteral<"flightcheck-v1">>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    security: z.ZodOptional<z.ZodObject<{
+        secrets: z.ZodArray<z.ZodObject<{
+            type: z.ZodString;
+            provider: z.ZodString;
+            severity: z.ZodEnum<{
+                critical: "critical";
+                review: "review";
+            }>;
+            masked: z.ZodString;
+            source: z.ZodString;
+        }, z.core.$strip>>;
+        scannedAssets: z.ZodNumber;
+    }, z.core.$strip>>;
+    images: z.ZodOptional<z.ZodObject<{
+        issues: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            severity: z.ZodEnum<{
+                critical: "critical";
+                error: "error";
+                warning: "warning";
+                review: "review";
+            }>;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    a11yStatic: z.ZodOptional<z.ZodObject<{
+        issues: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            severity: z.ZodEnum<{
+                critical: "critical";
+                error: "error";
+                warning: "warning";
+                review: "review";
+            }>;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    note: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>;
+export type ReportRecord = z.infer<typeof recordSchema>;
+export declare function parseReport(json: unknown): ReportRecord[];
+type UrlTodoItem = {
+    url: string;
+    status: number | null;
+    template: string;
+    missingFields: string[];
+    warnings: string[];
+    warningKeys: string[];
+    tier1IssueKeys: string[];
+    imageIssues: {
+        id: string;
+        severity: string;
+        message: string;
+    }[];
+    a11yStaticIssues: {
+        id: string;
+        severity: string;
+        message: string;
+    }[];
+    mainLandmarkTodos: string[];
+    mainCount?: number | null;
+    note?: string;
+    error?: string;
+};
+export type RemainingA11yIssue = {
+    id: string;
+    message: string;
+};
+export type PageFix = {
+    item: UrlTodoItem;
+    remainingTodos: string[];
+    /** SEO fields still missing after site-wide and template coverage is removed. */
+    remainingFields: string[];
+    /** Best-practice warning keys (template, robots, landmark) still open after coverage. */
+    remainingWarningKeys: string[];
+    /** Accessibility issues (image alt, heading skip, lang, etc.) still open after coverage. Landmarks live in remainingWarningKeys. */
+    remainingA11yIssues: RemainingA11yIssue[];
+};
+export type ReportAnalysis = {
+    allItems: UrlTodoItem[];
+    totalPages: number;
+    redirectOnly: boolean;
+    siteWideFields: Set<string>;
+    siteWideWarningKeys: Set<string>;
+    siteWideTier1Keys: Set<string>;
+    siteWideFixTodos: string[];
+    templateGroups: Map<string, UrlTodoItem[]>;
+    templateFieldMap: Map<string, Set<string>>;
+    templateWarningKeyMap: Map<string, Set<string>>;
+    templateTier1KeyMap: Map<string, Set<string>>;
+    coveredFieldsByTemplate: Map<string, Set<string>>;
+    coveredWarningKeysByTemplate: Map<string, Set<string>>;
+    coveredTier1KeysByTemplate: Map<string, Set<string>>;
+    pageFixes: PageFix[];
+    securityPages: Array<{
+        url: string;
+        secrets: Array<{
+            type: string;
+            provider: string;
+            severity: string;
+            masked: string;
+            source: string;
+        }>;
+    }>;
+    stackProfile: StackProfile;
+    crawlIssueCounts: CrawlIssueCounts;
+};
+export declare function buildReportAnalysis(records: ReportRecord[], tier1?: Tier1ReportData, options?: BuildMarkdownOptions): Promise<ReportAnalysis>;
+export declare function buildMarkdown(inputPath: string, records: ReportRecord[], includeOnlyErrors: boolean, tier1?: Tier1ReportData, options?: BuildMarkdownOptions): Promise<string>;
+//# sourceMappingURL=report.d.ts.map

package/dist/analyze/report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.d.ts","sourceRoot":"","sources":["../../src/analyze/report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACrB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAA6B,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1E,YAAY,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAuC9E,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoDhB,CAAC;AAEH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAwB,CAAC;AAElD,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAExD,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,YAAY,EAAE,CAEzD;AA8PD,KAAK,WAAW,GAAG;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,WAAW,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACjE,gBAAgB,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACtE,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAmXF,MAAM,MAAM,kBAAkB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjE,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,WAAW,CAAC;IAClB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,iFAAiF;IACjF,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,yFAAyF;IACzF,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,oIAAoI;IACpI,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;CAC3C,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,mBAAmB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAC3C,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3C,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAChD,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,4BAA4B,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACvD,0BAA0B,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACrD,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,aAAa,EAAE,KAAK,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACtG,CAAC,CAAC;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,YAAY,EAAE,EACvB,KAAK,GAAE,eAAoB,EAC3B,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,cAAc,CAAC,CAkGzB;AAED,wBAAsB,aAAa,CACjC,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,YAAY,EAAE,EACvB,iBAAiB,EAAE,OAAO,EAC1B,KAAK,GAAE,eAAoB,EAC3B,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,MAAM,CAAC,CAUjB"}