@nikkory/vibe-engine 4.0.0

package/dist/ui-studio/types/granularity-levels/template.config.d.ts

@@ -0,0 +1,340 @@
+/**
+ * Template Configuration Types
+ *
+ * Template-level configuration for complete applications like Admin, E-commerce.
+ * Templates are the highest granularity level, containing layouts, pages, and
+ * shared components that form a complete application.
+ *
+ * @packageDocumentation
+ * @module types/granularity-levels
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+import type { GranularityLevel, GranularityFactorValues, GranularityStyleOverrides, GranularityLayoutConfig, GranularityTemplateVisibility } from '../granularity/base.types';
+import type { GranularityConfig, ChildReference } from '../granularity/config.types';
+import type { GranularitySlotPosition, GranularitySlotConfig } from '../granularity/slot.types';
+import type { GranularityTemplateMetadata, GranularityTemplate } from '../granularity/template.types';
+import type { DesignSystem, Tier } from '../../../types';
+/**
+ * Template slot positions - pages, shared, assets
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export type TemplateSlotPosition = GranularitySlotPosition<'template'>;
+/**
+ * Template slot configuration
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export type TemplateSlotConfig = GranularitySlotConfig<'template'>;
+/**
+ * Template type categories - 20+ types organized by purpose
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * @example
+ * ```typescript
+ * const category: TemplateCategory = 'admin';
+ * ```
+ *
+ * Powered by Nikkory
+ */
+export type TemplateCategory = 'admin' | 'ecommerce' | 'saas' | 'portfolio' | 'blog' | 'landing' | 'documentation' | 'social' | 'marketplace' | 'booking';
+/**
+ * Template type identifiers (20+ types)
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export type TemplateType = 'admin-dashboard' | 'cms-admin' | 'analytics-dashboard' | 'ecommerce-store' | 'marketplace-vendor' | 'digital-products' | 'saas-landing' | 'saas-dashboard' | 'saas-onboarding' | 'portfolio-minimal' | 'portfolio-creative' | 'resume-cv' | 'blog-personal' | 'blog-magazine' | 'blog-technical' | 'landing-product' | 'landing-startup' | 'landing-agency' | 'docs-technical' | 'docs-api' | 'knowledge-base';
+/**
+ * Technology stack configuration
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface TechStack {
+    /** Frontend framework */
+    readonly framework: 'react' | 'vue' | 'angular' | 'svelte' | 'solid';
+    /** UI library */
+    readonly uiLibrary?: 'tailwind' | 'styled-components' | 'emotion' | 'vanilla';
+    /** State management */
+    readonly stateManagement?: 'zustand' | 'redux' | 'jotai' | 'mobx' | 'none';
+    /** Form handling */
+    readonly formLibrary?: 'react-hook-form' | 'formik' | 'final-form' | 'none';
+    /** API layer */
+    readonly apiLayer?: 'trpc' | 'graphql' | 'rest' | 'none';
+    /** Authentication */
+    readonly auth?: 'next-auth' | 'clerk' | 'supabase' | 'firebase' | 'custom';
+    /** Database */
+    readonly database?: 'prisma' | 'drizzle' | 'mongoose' | 'none';
+    /** Testing framework */
+    readonly testing?: 'vitest' | 'jest' | 'playwright' | 'cypress';
+}
+/**
+ * Pages configuration for template
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface TemplatePages {
+    /** All page IDs included in template */
+    readonly included: readonly string[];
+    /** Default/home page ID */
+    readonly homePage: string;
+    /** 404 page ID */
+    readonly notFoundPage?: string;
+    /** Error page ID */
+    readonly errorPage?: string;
+    /** Page groups for navigation */
+    readonly groups?: readonly PageGroup[];
+}
+/**
+ * Page group for navigation organization
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface PageGroup {
+    /** Group identifier */
+    readonly id: string;
+    /** Group display name */
+    readonly name: string;
+    /** Page IDs in this group */
+    readonly pages: readonly string[];
+    /** Group icon */
+    readonly icon?: string;
+    /** Whether group is collapsible */
+    readonly collapsible?: boolean;
+}
+/**
+ * Shared assets configuration
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface TemplateAssets {
+    /** Shared components IDs */
+    readonly components?: readonly string[];
+    /** Shared layouts IDs */
+    readonly layouts?: readonly string[];
+    /** Image assets */
+    readonly images?: readonly AssetReference[];
+    /** Icon set */
+    readonly icons?: 'lucide' | 'heroicons' | 'phosphor' | 'custom';
+    /** Font configuration */
+    readonly fonts?: FontConfig;
+}
+/**
+ * Asset reference
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface AssetReference {
+    /** Asset identifier */
+    readonly id: string;
+    /** Asset path or URL */
+    readonly path: string;
+    /** Asset type */
+    readonly type: 'image' | 'svg' | 'video' | 'font';
+    /** Asset alt text */
+    readonly alt?: string;
+}
+/**
+ * Font configuration
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface FontConfig {
+    /** Primary font family */
+    readonly primary: string;
+    /** Secondary font family */
+    readonly secondary?: string;
+    /** Monospace font family */
+    readonly mono?: string;
+    /** Font weights to include */
+    readonly weights?: readonly number[];
+}
+/**
+ * Template-specific extension fields beyond GranularityConfig
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface TemplateExtensions {
+    /** Template type identifier */
+    readonly templateType: TemplateType;
+    /** Template category for organization */
+    readonly templateCategory: TemplateCategory;
+    /** Technology stack */
+    readonly stack: TechStack;
+    /** Pages configuration */
+    readonly pages: TemplatePages;
+    /** Shared assets */
+    readonly assets?: TemplateAssets;
+    /** Template version */
+    readonly version: string;
+    /** Template visibility */
+    readonly visibility: GranularityTemplateVisibility;
+    /** License type */
+    readonly license?: 'mit' | 'apache-2.0' | 'proprietary' | 'custom';
+    /** Pricing tier (if applicable) */
+    readonly pricingTier?: 'free' | 'starter' | 'pro' | 'enterprise';
+    /** Preview URL */
+    readonly previewUrl?: string;
+    /** Repository URL */
+    readonly repositoryUrl?: string;
+    /** Documentation URL */
+    readonly docsUrl?: string;
+    /** Whether template is featured */
+    readonly featured?: boolean;
+    /** Download count */
+    readonly downloads?: number;
+    /** Rating (1-5) */
+    readonly rating?: number;
+}
+/**
+ * TemplateLevelConfig - Full configuration for template-level elements
+ *
+ * Extends GranularityConfig<'template'> with template-specific fields.
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * @example
+ * ```typescript
+ * const adminTemplate: TemplateLevelConfig = {
+ *   id: 'admin-dashboard-template',
+ *   granularity: 'template',
+ *   designSystem: 'material-design',
+ *   tier: 'enterprise',
+ *   title: 'Admin Dashboard',
+ *   subtitle: 'Complete admin panel with analytics',
+ *   templateType: 'admin-dashboard',
+ *   templateCategory: 'admin',
+ *   version: '1.0.0',
+ *   visibility: 'public',
+ *   stack: {
+ *     framework: 'react',
+ *     uiLibrary: 'tailwind',
+ *     stateManagement: 'zustand',
+ *     apiLayer: 'trpc'
+ *   },
+ *   pages: {
+ *     included: ['dashboard', 'users', 'settings'],
+ *     homePage: 'dashboard',
+ *     notFoundPage: '404',
+ *     groups: [
+ *       { id: 'main', name: 'Main', pages: ['dashboard'] },
+ *       { id: 'admin', name: 'Admin', pages: ['users', 'settings'] }
+ *     ]
+ *   }
+ * };
+ * ```
+ *
+ * Powered by Nikkory
+ */
+export interface TemplateLevelConfig extends TemplateExtensions {
+    /** Unique identifier */
+    readonly id: string;
+    /** Granularity level - always 'template' */
+    readonly granularity: 'template';
+    /** Design system */
+    readonly designSystem: DesignSystem;
+    /** Quality tier */
+    readonly tier: Tier;
+    /** Display title */
+    readonly title: string;
+    /** Optional subtitle/description */
+    readonly subtitle?: string;
+    /** Layout configuration */
+    readonly layout?: GranularityLayoutConfig;
+    /** Slots for template organization */
+    readonly slots?: readonly TemplateSlotConfig[];
+    /** Factor values */
+    readonly factors?: GranularityFactorValues;
+    /** Children references (layouts and pages) */
+    readonly children?: readonly ChildReference<'template'>[];
+    /** Style overrides */
+    readonly styleOverrides?: GranularityStyleOverrides;
+}
+/**
+ * Default slot configurations for templates
+ *
+ * @category constants
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export declare const DEFAULT_TEMPLATE_SLOTS: readonly TemplateSlotConfig[];
+/**
+ * FullTemplate - Complete template with metadata for marketplace
+ *
+ * Combines TemplateLevelConfig with TemplateMetadata for full template definition.
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export interface FullTemplate extends TemplateLevelConfig, GranularityTemplateMetadata {
+}
+/**
+ * Type guard to check if a config is a TemplateLevelConfig
+ *
+ * @category utils
+ * @since 4.0.0
+ *
+ * @param config - The config to check
+ * @returns True if config is a TemplateLevelConfig
+ *
+ * Powered by Nikkory
+ */
+export declare function isTemplateLevelConfig(config: GranularityConfig<GranularityLevel>): config is TemplateLevelConfig & GranularityConfig<'template'>;
+/**
+ * TemplateGranularityConfig - Alias to GranularityConfig<'template'>
+ *
+ * Use TemplateLevelConfig for the full extended version with template-specific fields.
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export type TemplateGranularityConfig = GranularityConfig<'template'>;
+/**
+ * Re-export GranularityTemplate for convenience
+ *
+ * @category types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+export type { GranularityTemplate, GranularityTemplateMetadata as TemplateMetadata };
+//# sourceMappingURL=template.config.d.ts.map

package/dist/ui-studio/types.d.ts

@@ -0,0 +1,323 @@
+/**
+ * Generator Types - Shared type definitions for TierGenerator and CompositionGenerator
+ * @packageDocumentation
+ * @module generators/generator-types
+ * @since 4.0.0
+ *
+ * Powered by Nikkory
+ */
+import type { BaseRegistryDefinition, RegistrySectionDefinition, RegistryPageDefinition, RegistryLayoutDefinition, RegistryTemplateDefinition } from './presets/registry.types';
+import type { DesignSystem, Tier, ComponentType } from '../types';
+import type { SectionCategory, SlotConfig, SlotPosition, SectionConfig, SectionFactors, SectionWithFactors, LayoutType, SpacingLevel, AlignmentType, StoredComponentInSlot, StyleOverrides } from '../types/section.types';
+export type { DesignSystem, Tier, ComponentType };
+export type { SectionCategory, SlotConfig, SlotPosition, SectionConfig, SectionFactors, SectionWithFactors, LayoutType, SpacingLevel, AlignmentType, StoredComponentInSlot, StyleOverrides, };
+/**
+ * Options for component generation
+ */
+export interface GenerationOptions {
+    /**
+     * Whether to include TypeScript types file
+     * @default true
+     */
+    readonly includeTypes?: boolean;
+    /**
+     * Whether to include test file
+     * @default true
+     */
+    readonly includeTests?: boolean;
+    /**
+     * Whether to include Storybook stories
+     * @default false
+     */
+    readonly includeStories?: boolean;
+    /**
+     * Custom template overrides
+     */
+    readonly templateOverrides?: Record<string, string>;
+    /**
+     * Additional props to inject into component
+     */
+    readonly additionalProps?: Record<string, string>;
+    /**
+     * Whether to use CSS Modules instead of Tailwind
+     * @default false
+     */
+    readonly useCSSModules?: boolean;
+}
+/**
+ * Configuration for generating a single component (TierGenerator)
+ */
+export interface TierGenerationConfig {
+    /**
+     * Registry definition to generate from
+     */
+    readonly definition: BaseRegistryDefinition;
+    /**
+     * Design system to apply
+     */
+    readonly designSystem: DesignSystem;
+    /**
+     * Quality tier to generate
+     */
+    readonly tier: Tier;
+    /**
+     * Output directory for generated files
+     */
+    readonly outputDir: string;
+    /**
+     * Optional generation settings
+     */
+    readonly options?: GenerationOptions;
+}
+/**
+ * Result of a single component generation
+ */
+export interface GenerationResult {
+    /**
+     * File path of generated component
+     */
+    readonly componentPath: string;
+    /**
+     * File path of generated types (if includeTypes=true)
+     */
+    readonly typesPath?: string;
+    /**
+     * File path of generated test (if includeTests=true)
+     */
+    readonly testPath?: string;
+    /**
+     * File path of generated story (if includeStories=true)
+     */
+    readonly storyPath?: string;
+    /**
+     * Lines of code in component file
+     */
+    readonly linesOfCode: number;
+    /**
+     * Generated component display name
+     */
+    readonly displayName: string;
+    /**
+     * Whether generation succeeded
+     */
+    readonly success: boolean;
+    /**
+     * Error message if generation failed
+     */
+    readonly error?: string;
+}
+/**
+ * Configuration for batch generation
+ */
+export interface BatchGenerationConfig {
+    /**
+     * Registry definitions to generate from
+     */
+    readonly definitions: BaseRegistryDefinition[];
+    /**
+     * Design systems to generate for each definition
+     * @default All design systems from definition
+     */
+    readonly designSystems?: DesignSystem[];
+    /**
+     * Tiers to generate for each definition
+     * @default All tiers from definition
+     */
+    readonly tiers?: Tier[];
+    /**
+     * Base output directory
+     */
+    readonly outputDir: string;
+    /**
+     * Optional generation settings
+     */
+    readonly options?: GenerationOptions;
+    /**
+     * Maximum parallel generations
+     * @default 4
+     */
+    readonly maxParallel?: number;
+}
+/**
+ * Result of batch generation
+ */
+export interface BatchGenerationResult {
+    /**
+     * Total number of components attempted
+     */
+    readonly total: number;
+    /**
+     * Number of successful generations
+     */
+    readonly successful: number;
+    /**
+     * Number of failed generations
+     */
+    readonly failed: number;
+    /**
+     * Individual generation results
+     */
+    readonly results: GenerationResult[];
+    /**
+     * Total lines of code generated
+     */
+    readonly totalLinesOfCode: number;
+    /**
+     * Generation duration in milliseconds
+     */
+    readonly durationMs: number;
+}
+/**
+ * Component template data for rendering
+ */
+export interface ComponentTemplateData {
+    /**
+     * Component name in PascalCase
+     */
+    readonly componentName: string;
+    /**
+     * Display name for React DevTools
+     */
+    readonly displayName: string;
+    /**
+     * Component description
+     */
+    readonly description: string;
+    /**
+     * Design system identifier
+     */
+    readonly designSystem: DesignSystem;
+    /**
+     * Quality tier
+     */
+    readonly tier: Tier;
+    /**
+     * Props interface name
+     */
+    readonly propsInterface: string;
+    /**
+     * HTML element type for ref
+     */
+    readonly elementType: string;
+    /**
+     * Base CSS classes
+     */
+    readonly baseClasses: string;
+    /**
+     * Variant definitions
+     */
+    readonly variants?: Record<string, Record<string, string>>;
+    /**
+     * Default prop values
+     */
+    readonly defaults?: Record<string, string>;
+    /**
+     * Additional imports
+     */
+    readonly imports?: string[];
+    /**
+     * Analytics event name (Enterprise tier)
+     */
+    readonly analyticsEvent?: string;
+    /**
+     * ARIA attributes (Enterprise tier)
+     */
+    readonly ariaAttributes?: Record<string, string>;
+}
+/**
+ * Section generation configuration (for CompositionGenerator)
+ */
+export interface SectionGenerationConfig extends TierGenerationConfig {
+    readonly definition: RegistrySectionDefinition;
+}
+/**
+ * Page generation configuration (for CompositionGenerator)
+ */
+export interface PageGenerationConfig extends TierGenerationConfig {
+    readonly definition: RegistryPageDefinition;
+}
+/**
+ * Layout generation configuration (for CompositionGenerator)
+ */
+export interface LayoutGenerationConfig extends TierGenerationConfig {
+    readonly definition: RegistryLayoutDefinition;
+}
+/**
+ * Template generation configuration (for CompositionGenerator)
+ */
+export interface TemplateGenerationConfig extends TierGenerationConfig {
+    readonly definition: RegistryTemplateDefinition;
+}
+/**
+ * Tier-specific features to include in generated component
+ */
+export interface TierFeatures {
+    /**
+     * Use React.memo wrapper
+     */
+    readonly useMemo: boolean;
+    /**
+     * Use forwardRef
+     */
+    readonly useForwardRef: boolean;
+    /**
+     * Set displayName
+     */
+    readonly setDisplayName: boolean;
+    /**
+     * Include analytics tracking
+     */
+    readonly includeAnalytics: boolean;
+    /**
+     * Include ARIA attributes
+     */
+    readonly includeAria: boolean;
+    /**
+     * Use useCallback for event handlers
+     */
+    readonly useCallback: boolean;
+    /**
+     * Include variants system
+     */
+    readonly includeVariants: boolean;
+    /**
+     * Include size variants
+     */
+    readonly includeSizes: boolean;
+}
+/**
+ * Get tier-specific features based on tier level
+ * @param tier - Quality tier
+ * @returns Tier features configuration
+ */
+export declare function getTierFeatures(tier: Tier): TierFeatures;
+/**
+ * Generator statistics
+ */
+export interface GeneratorStats {
+    /**
+     * Total components generated
+     */
+    readonly totalGenerated: number;
+    /**
+     * Components by tier
+     */
+    readonly byTier: Record<Tier, number>;
+    /**
+     * Components by design system
+     */
+    readonly byDesignSystem: Record<DesignSystem, number>;
+    /**
+     * Total lines of code
+     */
+    readonly totalLOC: number;
+    /**
+     * Average LOC per tier
+     */
+    readonly avgLOCByTier: Record<Tier, number>;
+    /**
+     * Total generation time (ms)
+     */
+    readonly totalTimeMs: number;
+}
+//# sourceMappingURL=types.d.ts.map