@webability/core 1.0.1 → 1.1.0

package/dist/index.d.cts

@@ -161,4 +161,78 @@ declare function dismissModals(page: PageLike): Promise<void>;
 
 declare function toHtmlReport(result: ScanResult): string;
 
-export { type BrowserDetector, type DetectedIssue, type FixDetector, type FixIssueType, type IssueImpact, type IssueSource, type PageLike, type ScanIssue, type ScanOptions, type ScanResult, type SiteTheme, VIEWPORT_SIZES, type ViewportPreset, WCAG_BY_ISSUE, type WcagLevel, dismissModals, extractSiteTheme, runAxe, runDetectors, scan, toHtmlReport };
+type Framework = 'tailwind' | 'bootstrap' | 'mui' | 'plain-css';
+interface FrameworkInfo {
+    framework: Framework;
+    version?: string;
+    confidence: number;
+}
+declare function detectFramework(page: PageLike): Promise<FrameworkInfo>;
+
+/**
+ * Contrast Solver — finds the nearest color that passes WCAG contrast requirements.
+ * Instead of picking a generic gray, it stays within the same hue family.
+ */
+interface ContrastSuggestion {
+    currentColor: string;
+    suggestedColor: string;
+    currentRatio: number;
+    suggestedRatio: number;
+    requiredRatio: number;
+    bgColor: string;
+}
+declare function getContrastRatio(fg: string, bg: string): number;
+/**
+ * Find the nearest color in the same hue that passes the required contrast ratio.
+ * Darkens or lightens the color along its own hue axis.
+ */
+declare function solveContrast(fgHex: string, bgHex: string, requiredRatio?: number): ContrastSuggestion | null;
+
+/**
+ * Tailwind Mapper — maps hex colors to Tailwind class names
+ * and suggests the nearest passing Tailwind class for contrast issues.
+ */
+interface TailwindSuggestion {
+    currentClass: string | null;
+    suggestedClass: string;
+    currentHex: string;
+    suggestedHex: string;
+    currentRatio: number;
+    suggestedRatio: number;
+    requiredRatio: number;
+}
+/**
+ * Find the nearest Tailwind class that passes contrast requirements.
+ */
+declare function suggestTailwindFix(fgHex: string, bgHex: string, requiredRatio?: number, prefix?: string): TailwindSuggestion | null;
+
+/**
+ * Developer Suggestions — transforms raw detector output into
+ * framework-aware, actionable guidance for developers.
+ */
+
+interface DevSuggestion {
+    /** The original issue */
+    issue: ScanIssue;
+    /** Human-readable explanation of what's wrong */
+    problem: string;
+    /** Framework-aware fix suggestion */
+    fix: string;
+    /** What to change (before → after) */
+    before?: string;
+    after?: string;
+    /** Contrast data if applicable */
+    contrast?: {
+        current: number;
+        required: number;
+        suggested: number;
+        fgColor: string;
+        bgColor: string;
+        suggestedColor: string;
+    };
+    /** WCAG reference */
+    wcagLink: string;
+}
+declare function generateDevSuggestion(issue: ScanIssue, framework: Framework, elementClasses?: string, fgColor?: string, bgColor?: string): DevSuggestion;
+
+export { type BrowserDetector, type ContrastSuggestion, type DetectedIssue, type DevSuggestion, type FixDetector, type FixIssueType, type Framework, type FrameworkInfo, type IssueImpact, type IssueSource, type PageLike, type ScanIssue, type ScanOptions, type ScanResult, type SiteTheme, type TailwindSuggestion, VIEWPORT_SIZES, type ViewportPreset, WCAG_BY_ISSUE, type WcagLevel, detectFramework, dismissModals, extractSiteTheme, generateDevSuggestion, getContrastRatio, runAxe, runDetectors, scan, solveContrast, suggestTailwindFix, toHtmlReport };

package/dist/index.d.ts

@@ -161,4 +161,78 @@ declare function dismissModals(page: PageLike): Promise<void>;
 
 declare function toHtmlReport(result: ScanResult): string;
 
-export { type BrowserDetector, type DetectedIssue, type FixDetector, type FixIssueType, type IssueImpact, type IssueSource, type PageLike, type ScanIssue, type ScanOptions, type ScanResult, type SiteTheme, VIEWPORT_SIZES, type ViewportPreset, WCAG_BY_ISSUE, type WcagLevel, dismissModals, extractSiteTheme, runAxe, runDetectors, scan, toHtmlReport };
+type Framework = 'tailwind' | 'bootstrap' | 'mui' | 'plain-css';
+interface FrameworkInfo {
+    framework: Framework;
+    version?: string;
+    confidence: number;
+}
+declare function detectFramework(page: PageLike): Promise<FrameworkInfo>;
+
+/**
+ * Contrast Solver — finds the nearest color that passes WCAG contrast requirements.
+ * Instead of picking a generic gray, it stays within the same hue family.
+ */
+interface ContrastSuggestion {
+    currentColor: string;
+    suggestedColor: string;
+    currentRatio: number;
+    suggestedRatio: number;
+    requiredRatio: number;
+    bgColor: string;
+}
+declare function getContrastRatio(fg: string, bg: string): number;
+/**
+ * Find the nearest color in the same hue that passes the required contrast ratio.
+ * Darkens or lightens the color along its own hue axis.
+ */
+declare function solveContrast(fgHex: string, bgHex: string, requiredRatio?: number): ContrastSuggestion | null;
+
+/**
+ * Tailwind Mapper — maps hex colors to Tailwind class names
+ * and suggests the nearest passing Tailwind class for contrast issues.
+ */
+interface TailwindSuggestion {
+    currentClass: string | null;
+    suggestedClass: string;
+    currentHex: string;
+    suggestedHex: string;
+    currentRatio: number;
+    suggestedRatio: number;
+    requiredRatio: number;
+}
+/**
+ * Find the nearest Tailwind class that passes contrast requirements.
+ */
+declare function suggestTailwindFix(fgHex: string, bgHex: string, requiredRatio?: number, prefix?: string): TailwindSuggestion | null;
+
+/**
+ * Developer Suggestions — transforms raw detector output into
+ * framework-aware, actionable guidance for developers.
+ */
+
+interface DevSuggestion {
+    /** The original issue */
+    issue: ScanIssue;
+    /** Human-readable explanation of what's wrong */
+    problem: string;
+    /** Framework-aware fix suggestion */
+    fix: string;
+    /** What to change (before → after) */
+    before?: string;
+    after?: string;
+    /** Contrast data if applicable */
+    contrast?: {
+        current: number;
+        required: number;
+        suggested: number;
+        fgColor: string;
+        bgColor: string;
+        suggestedColor: string;
+    };
+    /** WCAG reference */
+    wcagLink: string;
+}
+declare function generateDevSuggestion(issue: ScanIssue, framework: Framework, elementClasses?: string, fgColor?: string, bgColor?: string): DevSuggestion;
+
+export { type BrowserDetector, type ContrastSuggestion, type DetectedIssue, type DevSuggestion, type FixDetector, type FixIssueType, type Framework, type FrameworkInfo, type IssueImpact, type IssueSource, type PageLike, type ScanIssue, type ScanOptions, type ScanResult, type SiteTheme, type TailwindSuggestion, VIEWPORT_SIZES, type ViewportPreset, WCAG_BY_ISSUE, type WcagLevel, detectFramework, dismissModals, extractSiteTheme, generateDevSuggestion, getContrastRatio, runAxe, runDetectors, scan, solveContrast, suggestTailwindFix, toHtmlReport };