@idealyst/tooling 1.2.25 → 1.2.27

package/dist/types-CrlxbLFJ.d.cts

@@ -0,0 +1,121 @@
+/**
+ * Component Registry Types
+ *
+ * These types define the structure of the auto-generated component registry
+ * that documents all components with their props, types, and valid values.
+ */
+/**
+ * Definition of a single component prop
+ */
+interface PropDefinition {
+    /** The prop name */
+    name: string;
+    /** The TypeScript type as a string (e.g., 'Intent', 'Size', 'boolean', 'string') */
+    type: string;
+    /** Valid values for this prop (for unions, enums, theme-derived types) */
+    values?: string[];
+    /** Default value if specified in the component */
+    default?: string | number | boolean;
+    /** Description from JSDoc */
+    description?: string;
+    /** Whether the prop is required */
+    required: boolean;
+}
+/**
+ * Configuration for a controlled state binding
+ */
+interface ControlledState {
+    /** Initial value for the state */
+    initial: any;
+    /** The prop name that receives the onChange callback */
+    onChangeProp: string;
+    /** If true, the callback toggles a boolean value instead of receiving a new value */
+    toggle?: boolean;
+}
+/**
+ * Sample props for rendering the component in documentation
+ */
+interface SampleProps {
+    /** Props needed to render the component (required props, sample data) */
+    props?: Record<string, any>;
+    /** Default children for the component */
+    children?: any;
+    /** Controlled state bindings - key is the prop name, value is the state config */
+    state?: Record<string, ControlledState>;
+}
+/**
+ * Definition of a component in the registry
+ */
+interface ComponentDefinition {
+    /** Component name (e.g., 'Button', 'Card') */
+    name: string;
+    /** Component description from static property or JSDoc */
+    description?: string;
+    /** All props for this component */
+    props: Record<string, PropDefinition>;
+    /** Component category for grouping (e.g., 'form', 'display', 'layout') */
+    category?: ComponentCategory;
+    /** Path to the component file (relative) */
+    filePath?: string;
+    /** Sample props for rendering in documentation (from docs.ts) */
+    sampleProps?: SampleProps;
+}
+/**
+ * Component categories for organizing documentation
+ */
+type ComponentCategory = 'layout' | 'form' | 'display' | 'navigation' | 'overlay' | 'data' | 'feedback';
+/**
+ * The complete component registry
+ */
+type ComponentRegistry = Record<string, ComponentDefinition>;
+/**
+ * Theme values extracted from the theme configuration
+ */
+interface ThemeValues {
+    /** Intent names (e.g., ['primary', 'success', 'error', ...]) */
+    intents: string[];
+    /** Size keys per component (e.g., { button: ['xs', 'sm', 'md', ...], ... }) */
+    sizes: Record<string, string[]>;
+    /** Radius keys (e.g., ['none', 'xs', 'sm', 'md', ...]) */
+    radii: string[];
+    /** Shadow keys (e.g., ['none', 'sm', 'md', 'lg', 'xl']) */
+    shadows: string[];
+    /** Breakpoint keys (e.g., ['xs', 'sm', 'md', 'lg', 'xl']) */
+    breakpoints: string[];
+    /** Typography keys (e.g., ['h1', 'h2', 'body1', 'body2', ...]) */
+    typography: string[];
+    /** Surface color keys */
+    surfaceColors: string[];
+    /** Text color keys */
+    textColors: string[];
+    /** Border color keys */
+    borderColors: string[];
+}
+/**
+ * Options for the component analyzer
+ */
+interface ComponentAnalyzerOptions {
+    /** Paths to scan for components (e.g., ['packages/components/src']) */
+    componentPaths: string[];
+    /** Path to the theme file (e.g., 'packages/theme/src/lightTheme.ts') */
+    themePath: string;
+    /** Component names to include (default: all) */
+    include?: string[];
+    /** Component names to exclude */
+    exclude?: string[];
+    /** Whether to include internal/private components */
+    includeInternal?: boolean;
+}
+/**
+ * Options for the Vite plugin
+ */
+interface IdealystDocsPluginOptions extends ComponentAnalyzerOptions {
+    /** Output mode: 'virtual' for virtual module, 'file' for physical file */
+    output?: 'virtual' | 'file';
+    /** Path to write the registry file (if output is 'file') */
+    outputPath?: string;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+
+export type { ComponentRegistry as C, IdealystDocsPluginOptions as I, PropDefinition as P, SampleProps as S, ThemeValues as T, ComponentDefinition as a, ComponentAnalyzerOptions as b, ControlledState as c, ComponentCategory as d };

package/dist/types-CvIlSIOV.d.cts

@@ -0,0 +1,149 @@
+/**
+ * File type classification based on file extension patterns
+ */
+type FileType = 'shared' | 'web' | 'native' | 'styles' | 'types' | 'other';
+/**
+ * Platform classification for imports
+ */
+type Platform = 'react-native' | 'react-dom' | 'neutral';
+/**
+ * Violation type describing what kind of platform mismatch occurred
+ */
+type ViolationType = 'native-in-shared' | 'dom-in-shared' | 'native-in-web' | 'dom-in-native';
+/**
+ * Severity level for violations
+ */
+type Severity = 'error' | 'warning' | 'info';
+/**
+ * Information about a single import
+ */
+interface ImportInfo {
+    /** The imported identifier name */
+    name: string;
+    /** Original name if aliased (e.g., `Image as RNImage`) */
+    originalName?: string;
+    /** The module source (e.g., 'react-native', 'react-dom') */
+    source: string;
+    /** The platform this import belongs to */
+    platform: Platform;
+    /** Line number in source file */
+    line: number;
+    /** Column number in source file */
+    column: number;
+    /** Whether this is a default import */
+    isDefault: boolean;
+    /** Whether this is a namespace import (import * as X) */
+    isNamespace: boolean;
+    /** Whether this is a type-only import */
+    isTypeOnly: boolean;
+}
+/**
+ * A single violation found during analysis
+ */
+interface Violation {
+    /** Type of violation */
+    type: ViolationType;
+    /** The primitive/component that caused the violation */
+    primitive: string;
+    /** The module source (e.g., 'react-native', 'react-dom') */
+    source: string;
+    /** Path to the file with the violation */
+    filePath: string;
+    /** Line number where violation occurred */
+    line: number;
+    /** Column number where violation occurred */
+    column: number;
+    /** Human-readable message describing the violation */
+    message: string;
+    /** Severity level of this violation */
+    severity: Severity;
+}
+/**
+ * Result of analyzing a single file
+ */
+interface AnalysisResult {
+    /** Path to the analyzed file */
+    filePath: string;
+    /** Classified type of the file */
+    fileType: FileType;
+    /** List of violations found */
+    violations: Violation[];
+    /** All imports found in the file */
+    imports: ImportInfo[];
+    /** Whether the file passed validation (no violations) */
+    passed: boolean;
+}
+/**
+ * Options for configuring the platform import analyzer
+ */
+interface AnalyzerOptions {
+    /**
+     * Default severity level for violations
+     * @default 'error'
+     */
+    severity?: Severity;
+    /**
+     * Additional React Native primitives to flag beyond the built-in list
+     * Useful for flagging custom native-only components
+     */
+    additionalNativePrimitives?: string[];
+    /**
+     * Additional React DOM primitives to flag beyond the built-in list
+     * Useful for flagging custom web-only components
+     */
+    additionalDomPrimitives?: string[];
+    /**
+     * Primitives to ignore/allow even if they would normally be flagged
+     */
+    ignoredPrimitives?: string[];
+    /**
+     * Glob patterns for files to skip analysis on
+     * @example ['**\/*.test.tsx', '**\/*.stories.tsx']
+     */
+    ignoredPatterns?: string[];
+    /**
+     * Additional module sources to treat as React Native
+     * @example ['react-native-gesture-handler', 'react-native-reanimated']
+     */
+    additionalNativeSources?: string[];
+    /**
+     * Additional module sources to treat as React DOM
+     * @example ['react-dom/client']
+     */
+    additionalDomSources?: string[];
+}
+/**
+ * Input for batch file analysis
+ */
+interface FileInput {
+    /** File path */
+    path: string;
+    /** File content (source code) */
+    content: string;
+}
+/**
+ * Primitive rule definition
+ */
+interface PrimitiveRule {
+    /** Name of the primitive/component */
+    name: string;
+    /** Module source it comes from */
+    source: string;
+    /** Platform it belongs to */
+    platform: Platform;
+    /** Optional description of why it's platform-specific */
+    description?: string;
+}
+/**
+ * Rule set containing primitives for a specific platform
+ */
+interface PrimitiveRuleSet {
+    /** Platform these rules apply to */
+    platform: Platform;
+    /** List of primitive rules */
+    primitives: PrimitiveRule[];
+    /** Module sources that indicate this platform */
+    sources: string[];
+}
+
+export type { AnalysisResult as A, FileType as F, ImportInfo as I, Platform as P, Severity as S, ViolationType as V, Violation as a, AnalyzerOptions as b, FileInput as c, PrimitiveRule as d, PrimitiveRuleSet as e };