@specverse/engine-realize 3.5.3

package/libs/instance-factories/views/templates/shared/component-metadata.d.ts

@@ -0,0 +1,254 @@
+/**
+ * Component Metadata - Runtime Rendering Hints
+ *
+ * Provides metadata for runtime interpretation and dynamic rendering.
+ * Bridges the static atomic components registry with dynamic runtime engines.
+ *
+ * Used by:
+ * - app-demo runtime engine for dynamic component rendering
+ * - Documentation generation for component catalogs
+ * - AI-powered component suggestions
+ * - IDE tooling and autocomplete
+ *
+ * Architecture:
+ * - Enriches atomic component definitions with runtime hints
+ * - Provides property descriptions and validation rules
+ * - Includes rendering capabilities and constraints
+ * - Supports dynamic component discovery
+ */
+import { AtomicComponentDefinition } from './atomic-components-registry.js';
+/**
+ * Property metadata for runtime interpretation
+ */
+export interface PropertyMetadata {
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array' | 'enum';
+    required: boolean;
+    default?: any;
+    description: string;
+    enumValues?: string[];
+    validation?: {
+        min?: number;
+        max?: number;
+        pattern?: string;
+        options?: string[];
+    };
+    /**
+     * Common property that maps across frameworks
+     * (variant, size, color, position, orientation)
+     */
+    isCommon?: boolean;
+    /**
+     * Property affects layout/rendering significantly
+     */
+    affectsLayout?: boolean;
+}
+/**
+ * Event metadata for runtime interpretation
+ */
+export interface EventMetadata {
+    name: string;
+    description: string;
+    parameters?: {
+        name: string;
+        type: string;
+        description: string;
+    }[];
+    /**
+     * Event bubbles up to parent components
+     */
+    bubbles?: boolean;
+}
+/**
+ * Rendering capability metadata
+ */
+export interface RenderingCapability {
+    /**
+     * Component can contain children
+     */
+    supportsChildren: boolean;
+    /**
+     * Component supports conditional rendering (v-if, *ngIf, etc.)
+     */
+    supportsConditional: boolean;
+    /**
+     * Component supports list rendering (v-for, *ngFor, map, etc.)
+     */
+    supportsList: boolean;
+    /**
+     * Component supports slots/content projection
+     */
+    supportsSlots: boolean;
+    /**
+     * Maximum recommended nesting depth
+     */
+    maxDepth?: number;
+    /**
+     * Preferred position in component tree
+     */
+    preferredPosition?: 'root' | 'container' | 'leaf' | 'any';
+}
+/**
+ * Accessibility metadata
+ */
+export interface AccessibilityMetadata {
+    /**
+     * ARIA role
+     */
+    role?: string;
+    /**
+     * Keyboard navigable
+     */
+    keyboardNavigable: boolean;
+    /**
+     * Required ARIA attributes
+     */
+    requiredAriaAttrs?: string[];
+    /**
+     * Screen reader description template
+     */
+    screenReaderDescription?: string;
+}
+/**
+ * Component state metadata
+ */
+export interface StateMetadata {
+    /**
+     * Component manages internal state
+     */
+    hasInternalState: boolean;
+    /**
+     * State properties managed by component
+     */
+    stateProperties?: {
+        name: string;
+        type: string;
+        description: string;
+        defaultValue?: any;
+    }[];
+}
+/**
+ * Complete component metadata for runtime
+ */
+export interface ComponentMetadata extends AtomicComponentDefinition {
+    /**
+     * Property definitions with validation
+     */
+    propertyMetadata: PropertyMetadata[];
+    /**
+     * Event definitions
+     */
+    eventMetadata?: EventMetadata[];
+    /**
+     * Rendering capabilities
+     */
+    capabilities: RenderingCapability;
+    /**
+     * Accessibility information
+     */
+    accessibility: AccessibilityMetadata;
+    /**
+     * State management information
+     */
+    state: StateMetadata;
+    /**
+     * Related components (alternatives, compositions)
+     */
+    related?: {
+        alternatives?: string[];
+        compositions?: string[];
+        containers?: string[];
+    };
+    /**
+     * Usage examples for runtime
+     */
+    usageExamples?: {
+        title: string;
+        description: string;
+        code: string;
+    }[];
+}
+/**
+ * Metadata for the 5 universal properties
+ */
+export declare const COMMON_PROPERTY_METADATA: Record<string, PropertyMetadata>;
+/**
+ * Enhanced metadata for all atomic components
+ */
+export declare const COMPONENT_METADATA_REGISTRY: Record<string, ComponentMetadata>;
+/**
+ * Get metadata for a component type
+ *
+ * @param componentType - Component type from atomic registry
+ * @returns Component metadata or undefined
+ */
+export declare function getComponentMetadata(componentType: string): ComponentMetadata | undefined;
+/**
+ * Get all available component types with metadata
+ *
+ * @returns Array of component type names
+ */
+export declare function getAllComponentTypes(): string[];
+/**
+ * Get components by category
+ *
+ * @param category - Component category
+ * @returns Array of component metadata
+ */
+export declare function getComponentsByCategory(category: ComponentMetadata['category']): ComponentMetadata[];
+/**
+ * Get components that can contain children
+ *
+ * @returns Array of container component metadata
+ */
+export declare function getContainerComponents(): ComponentMetadata[];
+/**
+ * Get leaf components (cannot contain children)
+ *
+ * @returns Array of leaf component metadata
+ */
+export declare function getLeafComponents(): ComponentMetadata[];
+/**
+ * Check if a component supports a specific property
+ *
+ * @param componentType - Component type
+ * @param propertyName - Property name
+ * @returns True if property is supported
+ */
+export declare function supportsProperty(componentType: string, propertyName: string): boolean;
+/**
+ * Get property metadata for a component
+ *
+ * @param componentType - Component type
+ * @param propertyName - Property name
+ * @returns Property metadata or undefined
+ */
+export declare function getPropertyMetadata(componentType: string, propertyName: string): PropertyMetadata | undefined;
+/**
+ * Validate property value against metadata
+ *
+ * @param componentType - Component type
+ * @param propertyName - Property name
+ * @param value - Property value
+ * @returns Validation result with errors
+ */
+export declare function validatePropertyValue(componentType: string, propertyName: string, value: any): {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * Get recommended components for composition
+ *
+ * @param componentType - Component type
+ * @returns Array of recommended component types
+ */
+export declare function getRecommendedCompositions(componentType: string): string[];
+/**
+ * Check if two components can be nested
+ *
+ * @param parentType - Parent component type
+ * @param childType - Child component type
+ * @returns True if nesting is allowed
+ */
+export declare function canNest(parentType: string, childType: string): boolean;
+//# sourceMappingURL=component-metadata.d.ts.map

package/libs/instance-factories/views/templates/shared/component-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-metadata.d.ts","sourceRoot":"","sources":["component-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAA8B,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAMxG;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IACpE,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,UAAU,CAAC,EAAE;QACX,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;IACJ;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,KAAK,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,GAAG,CAAC;KACpB,EAAE,CAAC;CACL;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,yBAAyB;IAClE;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IAChC;;OAEG;IACH,YAAY,EAAE,mBAAmB,CAAC;IAClC;;OAEG;IACH,aAAa,EAAE,qBAAqB,CAAC;IACrC;;OAEG;IACH,KAAK,EAAE,aAAa,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;IACF;;OAEG;IACH,aAAa,CAAC,EAAE;QACd,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;CACL;AAMD;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAmDrE,CAAC;AAMF;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CA6XzE,CAAC;AAMF;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,EAAE,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,iBAAiB,CAAC,UAAU,CAAC,GACtC,iBAAiB,EAAE,CAIrB;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,iBAAiB,EAAE,CAI5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,iBAAiB,EAAE,CAIvD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAKrF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,GACnB,gBAAgB,GAAG,SAAS,CAK9B;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,GAAG,GACT;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAmCtC;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAG1E;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAatE"}