@wireweave/ux-rules 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,187 @@
+import { AnyNode, WireframeDocument } from '@wireweave/core';
+
+/**
+ * UX Rules Type Definitions
+ *
+ * Types for UX validation rules engine.
+ */
+
+/**
+ * Severity level of UX issues
+ */
+type UXIssueSeverity = 'error' | 'warning' | 'info';
+/**
+ * Category of UX rule
+ */
+type UXRuleCategory = 'accessibility' | 'usability' | 'consistency' | 'touch-target' | 'contrast' | 'navigation' | 'form' | 'feedback';
+/**
+ * UX validation issue
+ */
+interface UXIssue {
+    /** Unique rule ID */
+    ruleId: string;
+    /** Rule category */
+    category: UXRuleCategory;
+    /** Issue severity */
+    severity: UXIssueSeverity;
+    /** Human-readable message */
+    message: string;
+    /** Detailed description of the issue */
+    description: string;
+    /** How to fix the issue */
+    suggestion: string;
+    /** Path to the problematic node */
+    path: string;
+    /** Node type where issue occurred */
+    nodeType: string;
+    /** Source location (if available) */
+    location?: {
+        line: number;
+        column: number;
+    };
+}
+/**
+ * UX validation result
+ */
+interface UXValidationResult {
+    /** Whether all checks passed (no errors) */
+    valid: boolean;
+    /** Total score (0-100) */
+    score: number;
+    /** Issues found */
+    issues: UXIssue[];
+    /** Summary by category */
+    summary: {
+        category: UXRuleCategory;
+        passed: number;
+        failed: number;
+        warnings: number;
+    }[];
+    /** Summary by severity */
+    severityCounts: {
+        errors: number;
+        warnings: number;
+        info: number;
+    };
+}
+/**
+ * UX rule definition
+ */
+interface UXRule {
+    /** Unique rule ID */
+    id: string;
+    /** Rule category */
+    category: UXRuleCategory;
+    /** Default severity */
+    severity: UXIssueSeverity;
+    /** Rule name */
+    name: string;
+    /** Rule description */
+    description: string;
+    /** Component types this rule applies to (empty = all) */
+    appliesTo: string[];
+    /** Check function */
+    check: (node: AnyNode, context: UXRuleContext) => UXIssue | UXIssue[] | null;
+}
+/**
+ * Context provided to rule check functions
+ */
+interface UXRuleContext {
+    /** Path to current node */
+    path: string;
+    /** Parent node (if any) */
+    parent: AnyNode | null;
+    /** Root document */
+    root: AnyNode;
+    /** All siblings of current node */
+    siblings: AnyNode[];
+    /** Index in parent's children */
+    index: number;
+    /** Depth in tree */
+    depth: number;
+}
+/**
+ * UX validation options
+ */
+interface UXValidationOptions {
+    /** Categories to check (empty = all) */
+    categories?: UXRuleCategory[];
+    /** Minimum severity to report */
+    minSeverity?: UXIssueSeverity;
+    /** Maximum issues to collect */
+    maxIssues?: number;
+    /** Custom rules to add */
+    customRules?: UXRule[];
+    /** Rules to disable by ID */
+    disabledRules?: string[];
+}
+
+/**
+ * UX Rules Index
+ *
+ * Exports all UX rules organized by category.
+ */
+
+/**
+ * All built-in UX rules
+ */
+declare const allRules: UXRule[];
+/**
+ * Rules organized by category
+ */
+declare const rulesByCategory: {
+    accessibility: UXRule[];
+    form: UXRule[];
+    'touch-target': UXRule[];
+    consistency: UXRule[];
+    usability: UXRule[];
+    navigation: UXRule[];
+};
+/**
+ * Get rules for specific categories
+ */
+declare function getRulesForCategories(categories: string[]): UXRule[];
+
+/**
+ * UX Rules Validation Engine
+ *
+ * Validates wireframe AST against UX best practices.
+ * Provides actionable feedback for improving user experience.
+ */
+
+/**
+ * Validate a wireframe document against UX rules
+ *
+ * @param ast - The parsed AST document
+ * @param options - Validation options
+ * @returns Validation result with issues and score
+ */
+declare function validateUX(ast: WireframeDocument, options?: UXValidationOptions): UXValidationResult;
+/**
+ * Quick UX validation - returns true if no errors
+ *
+ * @param ast - The parsed AST document
+ * @returns true if no UX errors found
+ */
+declare function isUXValid(ast: WireframeDocument): boolean;
+/**
+ * Get UX issues from an AST
+ *
+ * @param ast - The parsed AST document
+ * @param options - Validation options
+ * @returns Array of UX issues
+ */
+declare function getUXIssues(ast: WireframeDocument, options?: UXValidationOptions): UXIssue[];
+/**
+ * Get UX score for a wireframe (0-100)
+ *
+ * @param ast - The parsed AST document
+ * @returns UX score from 0 to 100
+ */
+declare function getUXScore(ast: WireframeDocument): number;
+/**
+ * Format UX validation result as human-readable string
+ */
+declare function formatUXResult(result: UXValidationResult): string;
+
+export { type UXIssue, type UXIssueSeverity, type UXRule, type UXRuleCategory, type UXRuleContext, type UXValidationOptions, type UXValidationResult, allRules, formatUXResult, getRulesForCategories, getUXIssues, getUXScore, isUXValid, rulesByCategory, validateUX };

package/dist/index.d.ts

@@ -0,0 +1,187 @@
+import { AnyNode, WireframeDocument } from '@wireweave/core';
+
+/**
+ * UX Rules Type Definitions
+ *
+ * Types for UX validation rules engine.
+ */
+
+/**
+ * Severity level of UX issues
+ */
+type UXIssueSeverity = 'error' | 'warning' | 'info';
+/**
+ * Category of UX rule
+ */
+type UXRuleCategory = 'accessibility' | 'usability' | 'consistency' | 'touch-target' | 'contrast' | 'navigation' | 'form' | 'feedback';
+/**
+ * UX validation issue
+ */
+interface UXIssue {
+    /** Unique rule ID */
+    ruleId: string;
+    /** Rule category */
+    category: UXRuleCategory;
+    /** Issue severity */
+    severity: UXIssueSeverity;
+    /** Human-readable message */
+    message: string;
+    /** Detailed description of the issue */
+    description: string;
+    /** How to fix the issue */
+    suggestion: string;
+    /** Path to the problematic node */
+    path: string;
+    /** Node type where issue occurred */
+    nodeType: string;
+    /** Source location (if available) */
+    location?: {
+        line: number;
+        column: number;
+    };
+}
+/**
+ * UX validation result
+ */
+interface UXValidationResult {
+    /** Whether all checks passed (no errors) */
+    valid: boolean;
+    /** Total score (0-100) */
+    score: number;
+    /** Issues found */
+    issues: UXIssue[];
+    /** Summary by category */
+    summary: {
+        category: UXRuleCategory;
+        passed: number;
+        failed: number;
+        warnings: number;
+    }[];
+    /** Summary by severity */
+    severityCounts: {
+        errors: number;
+        warnings: number;
+        info: number;
+    };
+}
+/**
+ * UX rule definition
+ */
+interface UXRule {
+    /** Unique rule ID */
+    id: string;
+    /** Rule category */
+    category: UXRuleCategory;
+    /** Default severity */
+    severity: UXIssueSeverity;
+    /** Rule name */
+    name: string;
+    /** Rule description */
+    description: string;
+    /** Component types this rule applies to (empty = all) */
+    appliesTo: string[];
+    /** Check function */
+    check: (node: AnyNode, context: UXRuleContext) => UXIssue | UXIssue[] | null;
+}
+/**
+ * Context provided to rule check functions
+ */
+interface UXRuleContext {
+    /** Path to current node */
+    path: string;
+    /** Parent node (if any) */
+    parent: AnyNode | null;
+    /** Root document */
+    root: AnyNode;
+    /** All siblings of current node */
+    siblings: AnyNode[];
+    /** Index in parent's children */
+    index: number;
+    /** Depth in tree */
+    depth: number;
+}
+/**
+ * UX validation options
+ */
+interface UXValidationOptions {
+    /** Categories to check (empty = all) */
+    categories?: UXRuleCategory[];
+    /** Minimum severity to report */
+    minSeverity?: UXIssueSeverity;
+    /** Maximum issues to collect */
+    maxIssues?: number;
+    /** Custom rules to add */
+    customRules?: UXRule[];
+    /** Rules to disable by ID */
+    disabledRules?: string[];
+}
+
+/**
+ * UX Rules Index
+ *
+ * Exports all UX rules organized by category.
+ */
+
+/**
+ * All built-in UX rules
+ */
+declare const allRules: UXRule[];
+/**
+ * Rules organized by category
+ */
+declare const rulesByCategory: {
+    accessibility: UXRule[];
+    form: UXRule[];
+    'touch-target': UXRule[];
+    consistency: UXRule[];
+    usability: UXRule[];
+    navigation: UXRule[];
+};
+/**
+ * Get rules for specific categories
+ */
+declare function getRulesForCategories(categories: string[]): UXRule[];
+
+/**
+ * UX Rules Validation Engine
+ *
+ * Validates wireframe AST against UX best practices.
+ * Provides actionable feedback for improving user experience.
+ */
+
+/**
+ * Validate a wireframe document against UX rules
+ *
+ * @param ast - The parsed AST document
+ * @param options - Validation options
+ * @returns Validation result with issues and score
+ */
+declare function validateUX(ast: WireframeDocument, options?: UXValidationOptions): UXValidationResult;
+/**
+ * Quick UX validation - returns true if no errors
+ *
+ * @param ast - The parsed AST document
+ * @returns true if no UX errors found
+ */
+declare function isUXValid(ast: WireframeDocument): boolean;
+/**
+ * Get UX issues from an AST
+ *
+ * @param ast - The parsed AST document
+ * @param options - Validation options
+ * @returns Array of UX issues
+ */
+declare function getUXIssues(ast: WireframeDocument, options?: UXValidationOptions): UXIssue[];
+/**
+ * Get UX score for a wireframe (0-100)
+ *
+ * @param ast - The parsed AST document
+ * @returns UX score from 0 to 100
+ */
+declare function getUXScore(ast: WireframeDocument): number;
+/**
+ * Format UX validation result as human-readable string
+ */
+declare function formatUXResult(result: UXValidationResult): string;
+
+export { type UXIssue, type UXIssueSeverity, type UXRule, type UXRuleCategory, type UXRuleContext, type UXValidationOptions, type UXValidationResult, allRules, formatUXResult, getRulesForCategories, getUXIssues, getUXScore, isUXValid, rulesByCategory, validateUX };