@wireweave/ux-rules 1.0.0 → 1.1.0

package/dist/index.d.cts

@@ -13,7 +13,7 @@ type UXIssueSeverity = 'error' | 'warning' | 'info';
 /**
  * Category of UX rule
  */
-type UXRuleCategory = 'accessibility' | 'usability' | 'consistency' | 'touch-target' | 'contrast' | 'navigation' | 'form' | 'feedback';
+type UXRuleCategory = 'accessibility' | 'usability' | 'consistency' | 'touch-target' | 'navigation' | 'form' | 'feedback' | 'content' | 'data-display' | 'interaction';
 /**
  * UX validation issue
  */
@@ -136,12 +136,168 @@ declare const rulesByCategory: {
     consistency: UXRule[];
     usability: UXRule[];
     navigation: UXRule[];
+    content: UXRule[];
+    'data-display': UXRule[];
+    feedback: UXRule[];
+    interaction: UXRule[];
 };
 /**
  * Get rules for specific categories
  */
 declare function getRulesForCategories(categories: string[]): UXRule[];
 
+/**
+ * UX Rules Constants
+ *
+ * Centralized constants for UX validation rules.
+ * Based on WCAG, Material Design, Apple HIG, and UX research.
+ */
+/** Maximum navigation items (Miller's Law: 7±2) */
+declare const MAX_NAV_ITEMS = 7;
+/** Maximum tab count */
+declare const MAX_TABS = 5;
+/** Maximum nesting depth for layouts */
+declare const MAX_NESTING_DEPTH = 6;
+/** Maximum buttons in a single container (decision fatigue prevention) */
+declare const MAX_BUTTONS = 5;
+/** Maximum form fields before recommending multi-step */
+declare const MAX_FORM_FIELDS = 10;
+/** Maximum elements on a page (cognitive overload prevention) */
+declare const MAX_PAGE_ELEMENTS = 50;
+/** Maximum button text length */
+declare const MAX_BUTTON_TEXT_LENGTH = 25;
+/** Maximum title length */
+declare const MAX_TITLE_LENGTH = 60;
+/** Maximum tooltip content length */
+declare const MAX_TOOLTIP_LENGTH = 100;
+/** Maximum list items before recommending pagination */
+declare const MAX_LIST_ITEMS = 20;
+/** Maximum table columns */
+declare const MAX_TABLE_COLUMNS = 8;
+/** Minimum touch target size (WCAG 2.5.5 AAA: 44x44px) */
+declare const MIN_TOUCH_TARGET = 44;
+/** Recommended touch target size (Material Design: 48x48px) */
+declare const RECOMMENDED_TOUCH_TARGET = 48;
+/** Size presets mapping to pixels */
+declare const SIZE_MAP: Record<string, number>;
+/** Minimum toast duration (ms) */
+declare const MIN_TOAST_DURATION = 2000;
+/** Maximum toast duration (ms) */
+declare const MAX_TOAST_DURATION = 10000;
+/** Generic/non-descriptive link texts that should be avoided */
+declare const GENERIC_LINK_TEXTS: string[];
+/** Words indicating asynchronous/loading actions */
+declare const ASYNC_ACTION_WORDS: string[];
+/** Words indicating destructive/dangerous actions */
+declare const DESTRUCTIVE_WORDS: string[];
+/** Words indicating form submission */
+declare const SUBMIT_WORDS: string[];
+/** Words indicating errors */
+declare const ERROR_WORDS: string[];
+/** Words indicating success */
+declare const SUCCESS_WORDS: string[];
+/** Words indicating warnings */
+declare const WARNING_WORDS: string[];
+/** Words indicating home/root navigation */
+declare const HOME_WORDS: string[];
+/** Words indicating close/dismiss actions */
+declare const CLOSE_WORDS: string[];
+/** Placeholder content patterns that should be replaced */
+declare const PLACEHOLDER_PATTERNS: string[];
+/** Input type suggestions based on keywords */
+declare const INPUT_TYPE_SUGGESTIONS: {
+    keywords: string[];
+    type: string;
+}[];
+/** Form input node types */
+declare const FORM_INPUT_TYPES: string[];
+/** Container node types */
+declare const CONTAINER_TYPES: string[];
+/** Text content node types */
+declare const TEXT_CONTENT_TYPES: string[];
+
+/**
+ * UX Rules Utilities
+ *
+ * Helper functions for common rule patterns.
+ */
+
+/**
+ * Safely get text content from a node.
+ * Checks 'content', 'text', and 'label' properties.
+ */
+declare function getNodeText(node: AnyNode): string;
+/**
+ * Get text content in lowercase for comparison.
+ */
+declare function getNodeTextLower(node: AnyNode): string;
+/**
+ * Check if node has children array.
+ */
+declare function hasChildren(node: AnyNode): node is AnyNode & {
+    children: AnyNode[];
+};
+/**
+ * Get children array from node (returns empty array if none).
+ */
+declare function getChildren(node: AnyNode): AnyNode[];
+/**
+ * Find first child matching predicate (recursive).
+ */
+declare function findInChildren(node: AnyNode, predicate: (child: AnyNode) => boolean): AnyNode | null;
+/**
+ * Check if any child matches predicate (recursive).
+ */
+declare function hasChildMatching(node: AnyNode, predicate: (child: AnyNode) => boolean): boolean;
+/**
+ * Count children matching predicate (recursive).
+ */
+declare function countInChildren(node: AnyNode, predicate: (child: AnyNode) => boolean): number;
+/**
+ * Get all children matching predicate (recursive).
+ */
+declare function filterChildren(node: AnyNode, predicate: (child: AnyNode) => boolean): AnyNode[];
+/**
+ * Get numeric size from size attribute.
+ */
+declare function getSizeValue(node: AnyNode): number | null;
+/**
+ * Check if text contains any of the given words.
+ */
+declare function containsAnyWord(text: string, words: string[]): boolean;
+/**
+ * Check if text exactly matches any of the given words.
+ */
+declare function matchesAnyWord(text: string, words: string[]): boolean;
+/**
+ * Get location info from node for issue reporting.
+ */
+declare function getNodeLocation(node: AnyNode): {
+    line: number;
+    column: number;
+} | undefined;
+/**
+ * Check if node is a specific type.
+ */
+declare function isNodeType(node: AnyNode, type: string | string[]): boolean;
+/**
+ * Get button style from node.
+ */
+declare function getButtonStyle(node: AnyNode): string;
+/**
+ * Type guard to check if a value is a valid AnyNode.
+ */
+declare function isAnyNode(value: unknown): value is AnyNode;
+/**
+ * Safely convert an array of unknown values to AnyNode array.
+ * Filters out invalid nodes.
+ */
+declare function toAnyNodeArray(values: unknown[]): AnyNode[];
+/**
+ * Get items array from node (for components like Nav, List, Dropdown, etc.)
+ */
+declare function getNodeItems(node: AnyNode): unknown[];
+
 /**
  * UX Rules Validation Engine
  *
@@ -184,4 +340,4 @@ declare function getUXScore(ast: WireframeDocument): number;
  */
 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 };
+export { ASYNC_ACTION_WORDS, CLOSE_WORDS, CONTAINER_TYPES, DESTRUCTIVE_WORDS, ERROR_WORDS, FORM_INPUT_TYPES, GENERIC_LINK_TEXTS, HOME_WORDS, INPUT_TYPE_SUGGESTIONS, MAX_BUTTONS, MAX_BUTTON_TEXT_LENGTH, MAX_FORM_FIELDS, MAX_LIST_ITEMS, MAX_NAV_ITEMS, MAX_NESTING_DEPTH, MAX_PAGE_ELEMENTS, MAX_TABLE_COLUMNS, MAX_TABS, MAX_TITLE_LENGTH, MAX_TOAST_DURATION, MAX_TOOLTIP_LENGTH, MIN_TOAST_DURATION, MIN_TOUCH_TARGET, PLACEHOLDER_PATTERNS, RECOMMENDED_TOUCH_TARGET, SIZE_MAP, SUBMIT_WORDS, SUCCESS_WORDS, TEXT_CONTENT_TYPES, type UXIssue, type UXIssueSeverity, type UXRule, type UXRuleCategory, type UXRuleContext, type UXValidationOptions, type UXValidationResult, WARNING_WORDS, allRules, containsAnyWord, countInChildren, filterChildren, findInChildren, formatUXResult, getButtonStyle, getChildren, getNodeItems, getNodeLocation, getNodeText, getNodeTextLower, getRulesForCategories, getSizeValue, getUXIssues, getUXScore, hasChildMatching, hasChildren, isAnyNode, isNodeType, isUXValid, matchesAnyWord, rulesByCategory, toAnyNodeArray, validateUX };

package/dist/index.d.ts

@@ -13,7 +13,7 @@ type UXIssueSeverity = 'error' | 'warning' | 'info';
 /**
  * Category of UX rule
  */
-type UXRuleCategory = 'accessibility' | 'usability' | 'consistency' | 'touch-target' | 'contrast' | 'navigation' | 'form' | 'feedback';
+type UXRuleCategory = 'accessibility' | 'usability' | 'consistency' | 'touch-target' | 'navigation' | 'form' | 'feedback' | 'content' | 'data-display' | 'interaction';
 /**
  * UX validation issue
  */
@@ -136,12 +136,168 @@ declare const rulesByCategory: {
     consistency: UXRule[];
     usability: UXRule[];
     navigation: UXRule[];
+    content: UXRule[];
+    'data-display': UXRule[];
+    feedback: UXRule[];
+    interaction: UXRule[];
 };
 /**
  * Get rules for specific categories
  */
 declare function getRulesForCategories(categories: string[]): UXRule[];
 
+/**
+ * UX Rules Constants
+ *
+ * Centralized constants for UX validation rules.
+ * Based on WCAG, Material Design, Apple HIG, and UX research.
+ */
+/** Maximum navigation items (Miller's Law: 7±2) */
+declare const MAX_NAV_ITEMS = 7;
+/** Maximum tab count */
+declare const MAX_TABS = 5;
+/** Maximum nesting depth for layouts */
+declare const MAX_NESTING_DEPTH = 6;
+/** Maximum buttons in a single container (decision fatigue prevention) */
+declare const MAX_BUTTONS = 5;
+/** Maximum form fields before recommending multi-step */
+declare const MAX_FORM_FIELDS = 10;
+/** Maximum elements on a page (cognitive overload prevention) */
+declare const MAX_PAGE_ELEMENTS = 50;
+/** Maximum button text length */
+declare const MAX_BUTTON_TEXT_LENGTH = 25;
+/** Maximum title length */
+declare const MAX_TITLE_LENGTH = 60;
+/** Maximum tooltip content length */
+declare const MAX_TOOLTIP_LENGTH = 100;
+/** Maximum list items before recommending pagination */
+declare const MAX_LIST_ITEMS = 20;
+/** Maximum table columns */
+declare const MAX_TABLE_COLUMNS = 8;
+/** Minimum touch target size (WCAG 2.5.5 AAA: 44x44px) */
+declare const MIN_TOUCH_TARGET = 44;
+/** Recommended touch target size (Material Design: 48x48px) */
+declare const RECOMMENDED_TOUCH_TARGET = 48;
+/** Size presets mapping to pixels */
+declare const SIZE_MAP: Record<string, number>;
+/** Minimum toast duration (ms) */
+declare const MIN_TOAST_DURATION = 2000;
+/** Maximum toast duration (ms) */
+declare const MAX_TOAST_DURATION = 10000;
+/** Generic/non-descriptive link texts that should be avoided */
+declare const GENERIC_LINK_TEXTS: string[];
+/** Words indicating asynchronous/loading actions */
+declare const ASYNC_ACTION_WORDS: string[];
+/** Words indicating destructive/dangerous actions */
+declare const DESTRUCTIVE_WORDS: string[];
+/** Words indicating form submission */
+declare const SUBMIT_WORDS: string[];
+/** Words indicating errors */
+declare const ERROR_WORDS: string[];
+/** Words indicating success */
+declare const SUCCESS_WORDS: string[];
+/** Words indicating warnings */
+declare const WARNING_WORDS: string[];
+/** Words indicating home/root navigation */
+declare const HOME_WORDS: string[];
+/** Words indicating close/dismiss actions */
+declare const CLOSE_WORDS: string[];
+/** Placeholder content patterns that should be replaced */
+declare const PLACEHOLDER_PATTERNS: string[];
+/** Input type suggestions based on keywords */
+declare const INPUT_TYPE_SUGGESTIONS: {
+    keywords: string[];
+    type: string;
+}[];
+/** Form input node types */
+declare const FORM_INPUT_TYPES: string[];
+/** Container node types */
+declare const CONTAINER_TYPES: string[];
+/** Text content node types */
+declare const TEXT_CONTENT_TYPES: string[];
+
+/**
+ * UX Rules Utilities
+ *
+ * Helper functions for common rule patterns.
+ */
+
+/**
+ * Safely get text content from a node.
+ * Checks 'content', 'text', and 'label' properties.
+ */
+declare function getNodeText(node: AnyNode): string;
+/**
+ * Get text content in lowercase for comparison.
+ */
+declare function getNodeTextLower(node: AnyNode): string;
+/**
+ * Check if node has children array.
+ */
+declare function hasChildren(node: AnyNode): node is AnyNode & {
+    children: AnyNode[];
+};
+/**
+ * Get children array from node (returns empty array if none).
+ */
+declare function getChildren(node: AnyNode): AnyNode[];
+/**
+ * Find first child matching predicate (recursive).
+ */
+declare function findInChildren(node: AnyNode, predicate: (child: AnyNode) => boolean): AnyNode | null;
+/**
+ * Check if any child matches predicate (recursive).
+ */
+declare function hasChildMatching(node: AnyNode, predicate: (child: AnyNode) => boolean): boolean;
+/**
+ * Count children matching predicate (recursive).
+ */
+declare function countInChildren(node: AnyNode, predicate: (child: AnyNode) => boolean): number;
+/**
+ * Get all children matching predicate (recursive).
+ */
+declare function filterChildren(node: AnyNode, predicate: (child: AnyNode) => boolean): AnyNode[];
+/**
+ * Get numeric size from size attribute.
+ */
+declare function getSizeValue(node: AnyNode): number | null;
+/**
+ * Check if text contains any of the given words.
+ */
+declare function containsAnyWord(text: string, words: string[]): boolean;
+/**
+ * Check if text exactly matches any of the given words.
+ */
+declare function matchesAnyWord(text: string, words: string[]): boolean;
+/**
+ * Get location info from node for issue reporting.
+ */
+declare function getNodeLocation(node: AnyNode): {
+    line: number;
+    column: number;
+} | undefined;
+/**
+ * Check if node is a specific type.
+ */
+declare function isNodeType(node: AnyNode, type: string | string[]): boolean;
+/**
+ * Get button style from node.
+ */
+declare function getButtonStyle(node: AnyNode): string;
+/**
+ * Type guard to check if a value is a valid AnyNode.
+ */
+declare function isAnyNode(value: unknown): value is AnyNode;
+/**
+ * Safely convert an array of unknown values to AnyNode array.
+ * Filters out invalid nodes.
+ */
+declare function toAnyNodeArray(values: unknown[]): AnyNode[];
+/**
+ * Get items array from node (for components like Nav, List, Dropdown, etc.)
+ */
+declare function getNodeItems(node: AnyNode): unknown[];
+
 /**
  * UX Rules Validation Engine
  *
@@ -184,4 +340,4 @@ declare function getUXScore(ast: WireframeDocument): number;
  */
 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 };
+export { ASYNC_ACTION_WORDS, CLOSE_WORDS, CONTAINER_TYPES, DESTRUCTIVE_WORDS, ERROR_WORDS, FORM_INPUT_TYPES, GENERIC_LINK_TEXTS, HOME_WORDS, INPUT_TYPE_SUGGESTIONS, MAX_BUTTONS, MAX_BUTTON_TEXT_LENGTH, MAX_FORM_FIELDS, MAX_LIST_ITEMS, MAX_NAV_ITEMS, MAX_NESTING_DEPTH, MAX_PAGE_ELEMENTS, MAX_TABLE_COLUMNS, MAX_TABS, MAX_TITLE_LENGTH, MAX_TOAST_DURATION, MAX_TOOLTIP_LENGTH, MIN_TOAST_DURATION, MIN_TOUCH_TARGET, PLACEHOLDER_PATTERNS, RECOMMENDED_TOUCH_TARGET, SIZE_MAP, SUBMIT_WORDS, SUCCESS_WORDS, TEXT_CONTENT_TYPES, type UXIssue, type UXIssueSeverity, type UXRule, type UXRuleCategory, type UXRuleContext, type UXValidationOptions, type UXValidationResult, WARNING_WORDS, allRules, containsAnyWord, countInChildren, filterChildren, findInChildren, formatUXResult, getButtonStyle, getChildren, getNodeItems, getNodeLocation, getNodeText, getNodeTextLower, getRulesForCategories, getSizeValue, getUXIssues, getUXScore, hasChildMatching, hasChildren, isAnyNode, isNodeType, isUXValid, matchesAnyWord, rulesByCategory, toAnyNodeArray, validateUX };