ux-toolkit 0.5.0 → 0.5.3

package/dist/index.d.ts

@@ -1,323 +1,35 @@
-declare function getSkillPath(skillName: string): string;
-declare function getAgentPath(agentName: string): string;
-declare function getCommandPath(commandName: string): string;
+import * as _opencode_ai_plugin from '@opencode-ai/plugin';
+import * as zod from 'zod';
+
 /**
- * Get the global OpenCode config directory.
+ * UX Toolkit - OpenCode Plugin
  *
- * Priority:
- * 1. UX_TOOLKIT_CONFIG_DIR env var (explicit override)
- * 2. OPENCODE_CONFIG_DIR env var (OpenCode convention)
- * 3. Platform-specific defaults:
- *    - Linux: $XDG_CONFIG_HOME/opencode or ~/.config/opencode
- *    - macOS: ~/.config/opencode
- *    - Windows: ~/.config/opencode (matches OpenCode behavior)
- */
-declare function getGlobalConfigDir(): string;
-/**
- * Check if the OpenCode config directory exists.
- * Useful for pre-flight checks before installation.
- */
-declare function isOpenCodeInstalled(): boolean;
-/**
- * Get the Claude Code config directory.
- * Claude Code always uses ~/.claude/ on all platforms.
- */
-declare function getClaudeConfigDir(): string;
-/**
- * Check if Claude Code is installed.
- */
-declare function isClaudeInstalled(): boolean;
-/**
- * Supported installation targets
+ * Provides UX review skills, agents, and tools for OpenCode
  */
-type InstallTarget = 'opencode' | 'claude';
 /**
- * Get platform information for diagnostics
+ * OpenCode Plugin Export
  */
-declare function getPlatformInfo(): {
-    platform: string;
-    opencode: {
-        configDir: string;
-        exists: boolean;
+declare const UxToolkitPlugin: (_ctx: unknown) => Promise<{
+    tool: {
+        use_ux_skill: {
+            description: string;
+            args: {
+                skill_name: zod.ZodString;
+            };
+            execute(args: {
+                skill_name: string;
+            }, context: _opencode_ai_plugin.ToolContext): Promise<string>;
+        };
+        find_ux_skills: {
+            description: string;
+            args: {
+                category: zod.ZodOptional<zod.ZodString>;
+            };
+            execute(args: {
+                category?: string | undefined;
+            }, context: _opencode_ai_plugin.ToolContext): Promise<string>;
+        };
     };
-    claude: {
-        configDir: string;
-        exists: boolean;
-    };
-};
-declare function getProjectConfigDir(projectRoot?: string, target?: InstallTarget): string;
-interface DestinationPathsOptions {
-    global?: boolean;
-    projectRoot?: string;
-    target?: InstallTarget;
-}
-declare function getDestinationPaths(global: boolean, projectRoot?: string, target?: InstallTarget): {
-    skills: string;
-    agents: string;
-    commands: string;
-};
-
-interface InstallOptions {
-    /** Install globally to config directory */
-    global?: boolean;
-    /** Project root for local installation */
-    projectRoot?: string;
-    /** Target platform: 'opencode' or 'claude' */
-    target?: InstallTarget;
-    /** Only install specific categories */
-    categories?: ('skills' | 'agents' | 'commands')[];
-    /** Specific skills to install (by name) */
-    skills?: string[];
-    /** Specific agents to install (by name) */
-    agents?: string[];
-    /** Specific commands to install (by name) */
-    commands?: string[];
-    /** Overwrite existing files */
-    force?: boolean;
-    /** Verbose output */
-    verbose?: boolean;
-}
-interface InstallResult {
-    installed: string[];
-    skipped: string[];
-    errors: string[];
-}
-declare function install(options?: InstallOptions): Promise<InstallResult>;
-interface ComponentStatus {
-    name: string;
-    installed: boolean;
-    path?: string;
-    modifiedAt?: Date;
-}
-interface CategoryStatus {
-    installed: number;
-    total: number;
-    components: ComponentStatus[];
-}
-interface TargetStatus {
-    target: InstallTarget;
-    available: boolean;
-    configDir: string;
-    skills: CategoryStatus;
-    agents: CategoryStatus;
-    commands: CategoryStatus;
-}
-interface StatusOptions {
-    /** Check global installation */
-    global?: boolean;
-    /** Project root for local check */
-    projectRoot?: string;
-}
-interface StatusResult {
-    opencode: TargetStatus;
-    claude: TargetStatus;
-}
-declare function getStatus(options?: StatusOptions): Promise<StatusResult>;
-interface UninstallOptions {
-    /** Uninstall from global config directory */
-    global?: boolean;
-    /** Project root for local uninstallation */
-    projectRoot?: string;
-    /** Target platform: 'opencode' or 'claude' */
-    target?: InstallTarget;
-    /** Only uninstall specific categories */
-    categories?: ('skills' | 'agents' | 'commands')[];
-    /** Verbose output */
-    verbose?: boolean;
-}
-interface UninstallResult {
-    removed: string[];
-    notFound: string[];
-    errors: string[];
-}
-declare function uninstall(options?: UninstallOptions): Promise<UninstallResult>;
-
-declare const SKILLS: readonly [{
-    readonly name: "ux-heuristics";
-    readonly description: "Nielsen's 10 usability heuristics with evaluation methodology";
-    readonly category: "core";
-}, {
-    readonly name: "wcag-accessibility";
-    readonly description: "WCAG 2.2 compliance checklist and ARIA patterns";
-    readonly category: "core";
-}, {
-    readonly name: "visual-design-system";
-    readonly description: "Layout, typography, color theory, spacing systems";
-    readonly category: "core";
-}, {
-    readonly name: "interaction-patterns";
-    readonly description: "Micro-interactions, loading states, feedback mechanisms";
-    readonly category: "core";
-}, {
-    readonly name: "mobile-responsive-ux";
-    readonly description: "Touch targets, gestures, responsive patterns";
-    readonly category: "core";
-}, {
-    readonly name: "page-structure-patterns";
-    readonly description: "Base requirements for page states, layout, and structure";
-    readonly category: "structure";
-}, {
-    readonly name: "list-page-patterns";
-    readonly description: "Filters, sorting, pagination, and grid/table displays";
-    readonly category: "structure";
-}, {
-    readonly name: "detail-page-patterns";
-    readonly description: "Headers, tabs, multi-column layouts, related data";
-    readonly category: "structure";
-}, {
-    readonly name: "navigation-patterns";
-    readonly description: "Sidebar, mobile drawer, breadcrumbs, app shell";
-    readonly category: "structure";
-}, {
-    readonly name: "modal-patterns";
-    readonly description: "Confirmation, edit, selector, and wizard modals";
-    readonly category: "component";
-}, {
-    readonly name: "form-patterns";
-    readonly description: "Validation, field layouts, multi-step wizards";
-    readonly category: "component";
-}, {
-    readonly name: "data-density-patterns";
-    readonly description: "Dense layouts, z-index, overflow, readability";
-    readonly category: "component";
-}, {
-    readonly name: "toast-notification-patterns";
-    readonly description: "Toast notifications, alerts, and system feedback";
-    readonly category: "component";
-}, {
-    readonly name: "keyboard-shortcuts-patterns";
-    readonly description: "Keyboard shortcuts, command palette (Cmd+K), power user navigation";
-    readonly category: "interaction";
-}, {
-    readonly name: "drag-drop-patterns";
-    readonly description: "Drag and drop interactions, visual feedback, drop zones";
-    readonly category: "interaction";
-}, {
-    readonly name: "editor-workspace-patterns";
-    readonly description: "Multi-tab editors, dirty state, real-time validation, workspaces";
-    readonly category: "editor";
-}, {
-    readonly name: "comparison-patterns";
-    readonly description: "Side-by-side comparison, diff highlighting, multi-item comparison";
-    readonly category: "editor";
-}, {
-    readonly name: "split-panel-patterns";
-    readonly description: "Resizable panels, dividers, collapsible sidebars, synchronized views";
-    readonly category: "editor";
-}, {
-    readonly name: "canvas-grid-patterns";
-    readonly description: "Hex grids, tactical maps, pan/zoom, tokens, coordinate systems";
-    readonly category: "game";
-}, {
-    readonly name: "turn-based-ui-patterns";
-    readonly description: "Phase banners, turn indicators, action bars, game state feedback";
-    readonly category: "game";
-}, {
-    readonly name: "playback-replay-patterns";
-    readonly description: "VCR controls, timeline scrubbing, speed selection, replay viewers";
-    readonly category: "game";
-}, {
-    readonly name: "status-visualization-patterns";
-    readonly description: "Health bars, progress meters, heat gauges, pip displays, stat blocks";
-    readonly category: "game";
-}, {
-    readonly name: "info-card-patterns";
-    readonly description: "Compact/standard/expanded cards, stat blocks, badges, entity displays";
-    readonly category: "data";
-}, {
-    readonly name: "event-timeline-patterns";
-    readonly description: "Activity feeds, audit logs, chronological events, filtering, infinite scroll";
-    readonly category: "data";
-}, {
-    readonly name: "react-ux-patterns";
-    readonly description: "React/Next.js specific UX patterns";
-    readonly category: "framework";
-}];
-declare const AGENTS: readonly [{
-    readonly name: "ux-auditor";
-    readonly description: "Full UX audit against heuristics (read-only)";
-    readonly mode: "analysis";
-}, {
-    readonly name: "ux-engineer";
-    readonly description: "UX analysis + implements fixes";
-    readonly mode: "fix";
-}, {
-    readonly name: "accessibility-auditor";
-    readonly description: "WCAG 2.2 compliance review (read-only)";
-    readonly mode: "analysis";
-}, {
-    readonly name: "accessibility-engineer";
-    readonly description: "Accessibility fixes";
-    readonly mode: "fix";
-}, {
-    readonly name: "visual-reviewer";
-    readonly description: "Design system consistency check";
-    readonly mode: "analysis";
-}, {
-    readonly name: "interaction-reviewer";
-    readonly description: "Micro-interactions and feedback review";
-    readonly mode: "analysis";
-}, {
-    readonly name: "list-page-reviewer";
-    readonly description: "List/browse page UX review";
-    readonly mode: "analysis";
-}, {
-    readonly name: "detail-page-reviewer";
-    readonly description: "Detail/entity page UX review";
-    readonly mode: "analysis";
-}, {
-    readonly name: "navigation-reviewer";
-    readonly description: "Navigation and routing review";
-    readonly mode: "analysis";
-}, {
-    readonly name: "form-reviewer";
-    readonly description: "Form and input UX review";
-    readonly mode: "analysis";
-}, {
-    readonly name: "density-reviewer";
-    readonly description: "Data density and layout review";
-    readonly mode: "analysis";
-}, {
-    readonly name: "editor-reviewer";
-    readonly description: "Editor/workspace UI with multi-tab, drag-drop, validation";
-    readonly mode: "analysis";
-}, {
-    readonly name: "comparison-reviewer";
-    readonly description: "Side-by-side comparison and diff UIs";
-    readonly mode: "analysis";
-}, {
-    readonly name: "settings-reviewer";
-    readonly description: "Settings, preferences, and configuration pages";
-    readonly mode: "analysis";
-}, {
-    readonly name: "game-ui-reviewer";
-    readonly description: "Tactical maps, turn-based combat, status displays, hex grids";
-    readonly mode: "analysis";
-}, {
-    readonly name: "replay-reviewer";
-    readonly description: "Playback controls, timeline scrubbing, event feeds";
-    readonly mode: "analysis";
-}, {
-    readonly name: "card-reviewer";
-    readonly description: "Info cards, stat blocks, entity displays with density levels";
-    readonly mode: "analysis";
-}, {
-    readonly name: "panel-reviewer";
-    readonly description: "Resizable panels, collapsible sidebars, split views";
-    readonly mode: "analysis";
-}];
-declare const COMMANDS: readonly [{
-    readonly name: "ux-audit";
-    readonly description: "Comprehensive UX audit";
-}, {
-    readonly name: "a11y-check";
-    readonly description: "Quick accessibility scan";
-}, {
-    readonly name: "design-review";
-    readonly description: "Visual consistency check";
-}, {
-    readonly name: "screenshot-review";
-    readonly description: "Visual review from screenshot";
-}];
+}>;
 
-export { AGENTS, COMMANDS, type CategoryStatus, type ComponentStatus, type DestinationPathsOptions, type InstallOptions, type InstallResult, type InstallTarget, SKILLS, type StatusOptions, type StatusResult, type TargetStatus, type UninstallOptions, type UninstallResult, getAgentPath, getClaudeConfigDir, getCommandPath, getDestinationPaths, getGlobalConfigDir, getPlatformInfo, getProjectConfigDir, getSkillPath, getStatus, install, isClaudeInstalled, isOpenCodeInstalled, uninstall };
+export { UxToolkitPlugin as default };