@bravostudioai/react 0.1.28 → 0.1.29

package/README.md

@@ -0,0 +1,553 @@
+# @bravostudioai/react
+
+> Transform your Encore Studio designs into production-ready, type-safe React components in seconds.
+
+[![npm version](https://img.shields.io/npm/v/@bravostudioai/react.svg)](https://www.npmjs.com/package/@bravostudioai/react)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+[![React](https://img.shields.io/badge/React-18%2B%20%7C%2019%2B-blue.svg)](https://reactjs.org/)
+
+**What you get:**
+- 🎨 Design in Encore Studio → Generate typed React components
+- 🔒 100% TypeScript with full IntelliSense support
+- 🚀 Zero configuration, instant productivity
+- 📝 Auto-generated documentation for every component
+- 🎯 Human-readable prop names, not cryptic IDs
+
+**At a Glance:**
+
+| Feature | Included |
+|---------|----------|
+| TypeScript Interfaces | ✅ Yes |
+| Form Handling | ✅ Yes |
+| Event Handlers | ✅ Yes |
+| List/Array Props | ✅ Yes |
+| Dropdown Controls | ✅ Yes |
+| Auto Documentation | ✅ Yes |
+| Production Bundles | ✅ Yes |
+| Live Updates | ✅ Yes (via Pusher) |
+
+## Table of Contents
+
+- [What is Encore Studio?](#what-is-encore-studio)
+- [Perfect For](#perfect-for)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [What Gets Generated](#what-gets-generated)
+- [Real-World Examples](#real-world-examples)
+- [How It Works](#how-it-works)
+- [CLI Commands](#cli-commands)
+- [Advanced Features](#advanced-features)
+- [Package Exports](#package-exports)
+- [Troubleshooting](#troubleshooting)
+- [Support](#support)
+
+## Why This Matters
+
+Stop manually translating designs into code. Stop writing boilerplate. Stop maintaining prop interfaces that fall out of sync with your designs.
+
+With `@bravostudioai/react`, you design in Encore Studio and instantly get:
+
+- **Type-safe React components** with full TypeScript interfaces
+- **Intelligent prop detection** that understands your data bindings, forms, buttons, and interactive elements
+- **Human-readable APIs** with clean, semantic prop names (not cryptic IDs)
+- **Automatic event handlers** for clicks, form submissions, and state changes
+- **Self-documenting code** with README files for every component
+- **Zero manual configuration** - the generator understands your design intent
+
+## What is Encore Studio?
+
+Encore Studio is a design-to-code platform that lets you create mobile and web app interfaces visually. This package bridges the gap between your Encore Studio designs and your React application, automatically generating type-safe components from your visual designs.
+
+## Perfect For
+
+✅ **Design teams** who want to iterate quickly without waiting for developers
+✅ **Full-stack developers** building prototypes or MVPs fast
+✅ **Product teams** who need to validate designs with real functionality
+✅ **Agencies** shipping client projects with tight deadlines
+✅ **Startups** optimizing for speed without sacrificing code quality
+
+**Not ideal for:**
+❌ Projects without Encore Studio designs
+❌ Teams needing 100% custom, hand-coded components
+
+## Installation
+
+```bash
+npm install @bravostudioai/react
+```
+
+**Requirements:**
+- Node.js 16+
+- React 18.2.0+ or 19.0.0+
+- TypeScript (recommended)
+
+## Quick Start
+
+### Generate Components from Your Encore Studio App
+
+```bash
+# Generate all pages from an app
+npx encore-lib generate <appId> ./src/components
+
+# Generate a specific page
+npx encore-lib generate <appId> <pageId> ./src/components
+```
+
+This creates a folder structure like:
+
+```
+src/components/
+  YourApp/
+    PageName/
+      index.tsx       # Type-safe React component
+      README.md       # Complete documentation
+```
+
+### Use Your Generated Component
+
+```tsx
+import { PageName } from './components/YourApp/PageName';
+
+function App() {
+  return (
+    <PageName
+      headline="Welcome to our app"
+      items={[
+        { title: "Item 1", image: "https://..." },
+        { title: "Item 2", image: "https://..." }
+      ]}
+      onSubmitClick={() => console.log('Submitted!')}
+    />
+  );
+}
+```
+
+That's it. No configuration files. No manual prop mapping. Just clean, typed React components.
+
+## What Gets Generated
+
+### 1. Type-Safe Component Interfaces
+
+Every data binding, form input, and interactive element in your design becomes a typed prop:
+
+```typescript
+export interface SalaryCalculatorProps {
+  // Data bindings from your design
+  estimatedCost?: string;
+
+  // Dropdown controls
+  contractType?: string;
+  contractTypeOptions?: Array<string | { value: string; label: string }>;
+  onContractTypeChange?: (value: string) => void;
+
+  // Button actions
+  onBookButtonClick?: () => void;
+}
+```
+
+### 2. Smart List/Repeater Support
+
+Repeating containers become typed array props:
+
+```typescript
+export interface TimelineItem {
+  title: string;
+  description: string;
+  image: string;
+}
+
+export interface PageProps {
+  timeline: TimelineItem[];
+  timelineCurrentIndex?: number;
+  onTimelineIndexChange?: (index: number) => void;
+}
+```
+
+Use it like this:
+
+```tsx
+<Page
+  timeline={[
+    { title: "Step 1", description: "...", image: "..." },
+    { title: "Step 2", description: "...", image: "..." }
+  ]}
+  timelineCurrentIndex={currentSlide}
+  onTimelineIndexChange={setCurrentSlide}
+/>
+```
+
+### 3. Complete Form Handling
+
+Forms get typed interfaces and submission callbacks:
+
+```typescript
+export interface ContactFormData {
+  name: string;
+  email: string;
+  message: string;
+}
+
+export interface PageProps {
+  onContactFormSubmit?: (formData: ContactFormData) => void;
+}
+```
+
+Your form handler receives clean, typed data:
+
+```tsx
+<Page
+  onContactFormSubmit={(data) => {
+    console.log(data.name);    // Type-safe!
+    console.log(data.email);   // Type-safe!
+    console.log(data.message); // Type-safe!
+  }}
+/>
+```
+
+### 4. Comprehensive Documentation
+
+Every component includes a README with:
+
+- Complete prop documentation
+- Type information for every prop
+- Usage examples
+- Component metadata (App ID, Page ID)
+
+## Real-World Examples
+
+### Example 1: Interactive Salary Calculator
+
+A salary calculator with multiple dropdowns and a submit button:
+
+```typescript
+export interface DeelSalaryCalculatorProps {
+  estimatedCost?: string;
+
+  // Three interconnected dropdowns
+  contractTypeSelectInput?: string;
+  contractTypeSelectInputOptions?: Array<string | { value: string; label: string }>;
+  onContractTypeSelectInputChange?: (value: string) => void;
+
+  contractCountrySelectInput?: string;
+  contractCountrySelectInputOptions?: Array<string | { value: string; label: string }>;
+  onContractCountrySelectInputChange?: (value: string) => void;
+
+  contractSalarySelectInput?: string;
+  contractSalarySelectInputOptions?: Array<string | { value: string; label: string }>;
+  onContractSalarySelectInputChange?: (value: string) => void;
+
+  onBookButtonClick?: () => void;
+}
+```
+
+**Using it in your app:**
+
+```tsx
+function SalaryCalculator() {
+  const [contractType, setContractType] = useState('full-time');
+  const [country, setCountry] = useState('US');
+  const [salary, setSalary] = useState('100000');
+
+  return (
+    <DeelSalaryCalculator
+      contractTypeSelectInput={contractType}
+      contractTypeSelectInputOptions={['full-time', 'contractor', 'part-time']}
+      onContractTypeSelectInputChange={setContractType}
+      contractCountrySelectInput={country}
+      contractCountrySelectInputOptions={['US', 'UK', 'CA', 'AU']}
+      onContractCountrySelectInputChange={setCountry}
+      contractSalarySelectInput={salary}
+      contractSalarySelectInputOptions={['50000', '75000', '100000', '150000']}
+      onContractSalarySelectInputChange={setSalary}
+      onBookButtonClick={() => console.log('Booking consultation')}
+    />
+  );
+}
+```
+
+### Example 2: Content Sections with Data Bindings
+
+A simple layout with text content:
+
+```typescript
+export interface ContentSectionProps {
+  headline?: string;
+  topline?: string;
+  line1?: string;
+  line2?: string;
+}
+```
+
+**Using it in your app:**
+
+```tsx
+<ContentSection
+  headline="Transform Your Business"
+  topline="Introducing Our New Platform"
+  line1="Built for modern teams"
+  line2="Scales with your growth"
+/>
+```
+
+Simple, clean props that map directly to your design's data bindings.
+
+## How It Works
+
+The generator intelligently analyzes your Encore Studio pages and:
+
+1. **Detects data bindings** - Any component tagged with `encore:data` becomes a prop
+2. **Identifies repeating containers** - Lists and sliders become array props with typed items
+3. **Finds forms** - Input groups become typed form data interfaces
+4. **Discovers interactive elements** - Buttons, selects, and inputs get event handlers
+5. **Generates human-readable names** - Component names become `headline`, not `component_01ABC123`
+
+## CLI Commands
+
+### Generate Components
+
+```bash
+# Generate all pages from an app
+npx encore-lib generate <appId> <outputPath>
+
+# Generate a specific page
+npx encore-lib generate <appId> <pageId> <outputPath>
+
+# Generate with bundled production data (offline mode)
+npx encore-lib generate <appId> <pageId> <outputPath> --production
+```
+
+### Download Raw Data
+
+```bash
+# Download page data for inspection
+npx encore-lib download <appId> <pageId> <targetPath>
+```
+
+## Environment Variables
+
+Configure the Encore Studio API endpoint:
+
+```bash
+APPS_SERVICE_URL=https://your-custom-endpoint.com
+```
+
+Or use in your `.env` file:
+
+```env
+VITE_APPS_SERVICE_URL=https://your-custom-endpoint.com
+```
+
+## Advanced Features
+
+### Controlled vs Uncontrolled Components
+
+Sliders and repeating containers support both modes:
+
+```tsx
+// Uncontrolled (component manages its own state)
+<Page items={myItems} />
+
+// Controlled (you control the current slide)
+<Page
+  items={myItems}
+  itemsCurrentIndex={currentIndex}
+  onItemsIndexChange={setCurrentIndex}
+/>
+```
+
+### Production Mode
+
+Bundle your app/page definitions directly into components for offline usage:
+
+```bash
+npx encore-lib generate <appId> <pageId> ./src/components --production
+```
+
+This creates a `data.json` file with all necessary data baked in.
+
+### Page Metadata
+
+Every component exports metadata about the original design:
+
+```typescript
+export const PageMeta = {
+  width: 375,
+  height: 812,
+  aspectRatio: 0.46,
+};
+```
+
+Use this for responsive layouts or aspect ratio containers.
+
+## Package Exports
+
+```typescript
+// Main component
+import { EncoreApp } from '@bravostudioai/react';
+
+// All components
+import * from '@bravostudioai/react/components';
+
+// Hooks
+import { useFontLoader } from '@bravostudioai/react/hooks/useFontLoader';
+import { usePusherUpdates } from '@bravostudioai/react/hooks/usePusherUpdates';
+
+// State management
+import { useEncoreState } from '@bravostudioai/react/stores/useEncoreState';
+
+// Version info
+import { VERSION } from '@bravostudioai/react/version';
+```
+
+## TypeScript Support
+
+Full TypeScript support out of the box. Every generated component includes:
+
+- Exported interfaces for component props
+- Exported interfaces for list item types
+- Exported interfaces for form data
+- Complete type safety for all callbacks
+
+## Requirements
+
+- React 18.2.0+ or 19.0.0+
+- React DOM 18.2.0+ or 19.0.0+
+- TypeScript (recommended but not required)
+
+## Developer Experience
+
+This isn't just code generation - it's a complete workflow:
+
+1. **Design in Encore Studio** - Use the visual editor, add data bindings with `encore:data` tags
+2. **Run the generator** - One command creates your components
+3. **Import and use** - Type-safe components with IntelliSense support
+4. **Iterate quickly** - Regenerate anytime your design changes
+
+The generated code is clean, readable, and maintainable. You can read it, understand it, and even modify it if needed.
+
+## Example Output
+
+Here's what the generator creates for a real-world salary calculator:
+
+**Generated TypeScript Interface:**
+```typescript
+export interface DeelSalaryCalculatorProps {
+  estimatedCost?: string;
+  contractTypeSelectInput?: string;
+  contractTypeSelectInputOptions?: Array<string | { value: string; label: string }>;
+  onContractTypeSelectInputChange?: (value: string) => void;
+  // ... and more typed props
+}
+```
+
+**Generated Component:**
+```typescript
+export function DeelSalaryCalculator(props: DeelSalaryCalculatorProps) {
+  const handleAction = (payload: any) => {
+    // Automatically generated event routing
+    if (action?.action === "select-change") {
+      if (nodeId === "..." && props.onContractTypeSelectInputChange) {
+        props.onContractTypeSelectInputChange(value);
+        return;
+      }
+    }
+  };
+
+  return (
+    <EncoreApp
+      appId="..."
+      pageId="..."
+      data={{ /* auto-mapped props */ }}
+      onAction={handleAction}
+    />
+  );
+}
+```
+
+**Generated README.md:**
+Complete documentation with prop descriptions, types, and usage examples.
+
+## Why Developers Love This
+
+**"No more design-to-code bottleneck"**
+Your designers can iterate in Encore Studio while you work with production-ready components.
+
+**"Type safety everywhere"**
+Catch errors at compile time, not runtime. IntelliSense shows you every available prop.
+
+**"Self-documenting components"**
+Every component includes documentation. No need to ask "what props does this take?"
+
+**"Zero configuration"**
+No webpack configs, no babel plugins, no setup guides. Just `npm install` and `generate`.
+
+**"Actually readable code"**
+The generated code looks like code you'd write by hand. Clean, idiomatic React.
+
+## Troubleshooting
+
+### Common Issues
+
+**Q: The generated component shows "Failed to load"**
+- Ensure your `appId` and `pageId` are correct
+- Check that you have network access to the Encore Studio API
+- For offline use, use `--production` flag during generation
+
+**Q: TypeScript errors in generated code**
+- Make sure you have `@types/react` installed
+- Verify your TypeScript version is 5.0+
+- Try regenerating the component with the latest package version
+
+**Q: Props not updating the component**
+- Remember that data props need to be defined in Encore Studio with `encore:data` tags
+- Check the generated README.md for the exact prop names
+- Verify the component is receiving props correctly using React DevTools
+
+**Q: How do I get my App ID and Page ID?**
+- Contact your Bravo Studio team for access credentials
+- IDs are typically found in your Encore Studio project settings
+
+### Best Practices
+
+1. **Regenerate components when designs change** - Keep your code in sync
+2. **Read the generated README** - Each component documents its own API
+3. **Use TypeScript** - Get the full benefit of type safety
+4. **Version control generated code** - Treat it like any other source code
+5. **Customize carefully** - Remember that regeneration will overwrite changes
+
+## Support
+
+For questions, issues, or feature requests, please contact the Bravo Studio team.
+
+Package: `@bravostudioai/react`
+
+## Version & Updates
+
+Check your installed version:
+
+```bash
+npm list @bravostudioai/react
+```
+
+Or programmatically:
+
+```typescript
+import { VERSION } from '@bravostudioai/react/version';
+console.log(VERSION);
+```
+
+**Updating to the latest version:**
+
+```bash
+npm update @bravostudioai/react
+```
+
+## Keywords
+
+`react`, `typescript`, `code-generation`, `design-to-code`, `encore`, `bravo-studio`, `component-generator`, `figma-to-react`, `type-safe`, `no-code`, `low-code`, `design-system`, `ui-components`
+
+---
+
+**Start building faster. Start with @bravostudioai/react.**
+
+Made with ❤️ by the Bravo Studio team

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bravostudioai/react",
-  "version": "0.1.28",
+  "version": "0.1.29",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/src/index.d.ts",

package/src/codegen/generator.ts

@@ -12,12 +12,51 @@ import {
   sanitizePropName,
 } from "./parser";
 
+/**
+ * Metadata extracted from generated component
+ */
 export interface ComponentMetadata {
+  /** List of prop names */
   props: string[];
+  /** List of event handler names */
   events: string[];
+  /** Example JSX usage string */
   jsx: string;
 }
 
+/**
+ * Generates React component wrapper code for an Encore page
+ *
+ * Creates a TypeScript React component that wraps EncoreApp with typed props
+ * for all data-bound components, sliders, forms, and interactive elements.
+ *
+ * @param appId - Encore app ID
+ * @param pageId - Encore page ID
+ * @param componentName - Name for the generated component
+ * @param sliders - Slider/list metadata from parser
+ * @param standaloneComponents - Standalone component metadata
+ * @param inputGroups - Input group metadata
+ * @param forms - Form metadata
+ * @param selectInputs - Select input metadata
+ * @param actionButtons - Action button metadata
+ * @param isProduction - Whether to include bundled data for production
+ * @param pageMeta - Optional page dimensions and aspect ratio
+ * @returns TypeScript component source code
+ *
+ * @example
+ * const code = generateComponentCode(
+ *   "01ABC123",
+ *   "01DEF456",
+ *   "MyPage",
+ *   sliders,
+ *   components,
+ *   inputGroups,
+ *   forms,
+ *   selectInputs,
+ *   actionButtons
+ * );
+ * fs.writeFileSync("MyPage.tsx", code);
+ */
 export function generateComponentCode(
   appId: string,
   pageId: string,
@@ -453,6 +492,25 @@ export const PageMeta = {
 `;
 }
 
+/**
+ * Generates README documentation for a generated component
+ *
+ * Creates comprehensive Markdown documentation explaining all props,
+ * events, and usage examples for the generated wrapper component.
+ *
+ * @param appId - Encore app ID
+ * @param pageId - Encore page ID
+ * @param appName - Human-readable app name
+ * @param pageName - Human-readable page name
+ * @param componentName - Generated component name
+ * @param sliders - Slider/list metadata
+ * @param standaloneComponents - Component metadata
+ * @param inputGroups - Input group metadata
+ * @param forms - Form metadata
+ * @param selectInputs - Select input metadata
+ * @param actionButtons - Action button metadata
+ * @returns Markdown documentation string
+ */
 export function generateReadme(
   appId: string,
   pageId: string,
@@ -811,6 +869,22 @@ ${controlExample}
 `;
 }
 
+/**
+ * Extracts component metadata for programmatic use
+ *
+ * Generates a simplified metadata object listing all props and events
+ * without the full code generation.
+ *
+ * @param _appName - App name (currently unused)
+ * @param pageName - Page name for component naming
+ * @param sliders - Slider metadata
+ * @param standaloneComponents - Component metadata
+ * @param inputGroups - Input group metadata
+ * @param forms - Form metadata
+ * @param selectInputs - Select input metadata
+ * @param actionButtons - Action button metadata
+ * @returns Component metadata object
+ */
 export function generateComponentMetadata(
   _appName: string,
   pageName: string,