openuispec 0.2.10 → 0.2.11

package/examples/social-app/CLAUDE.md

@@ -1,124 +0,0 @@
-<!-- openuispec-rules-start -->
-<!-- openuispec-rules-version: 0.2.4 -->
-# OpenUISpec — AI Assistant Rules
-# ================================
-# This project uses OpenUISpec to define UI as a semantic spec.
-# Spec files are the single source of truth for all UI across platforms.
-# Targets: "ios", "android", "web"
-
-## MANDATORY — UI work requires OpenUISpec tools
-
-When the user's request involves UI — screens, navigation, layout, tokens, flows, localization,
-or any visual/structural change — you MUST use the OpenUISpec tools before writing any code.
-
-### MCP Tools (use these when available)
-
-Call these MCP tools directly. They return structured JSON with everything you need.
-
-**Pre-generation:**
-1. Call `openuispec_prepare` with the target platform — returns spec context, platform config, constraints.
-2. Call `openuispec_read_specs` to load spec file contents. Use these as the AUTHORITATIVE source.
-3. If spec changes are needed, update spec files FIRST, then call `openuispec_check`.
-4. Generate or update the platform UI code based on the spec contents.
-
-**Post-generation (EVERY TIME after writing UI code):**
-5. Call `openuispec_check` to validate spec integrity.
-6. Call `openuispec_read_specs` for the screens/contracts you just generated code for.
-7. Audit your generated code against the spec. For each screen, verify:
-   - Every field/action in the spec has a corresponding UI element
-   - Token values (colors, spacing, radii) match exactly — no approximations
-   - Contract `must_handle` states are all implemented (loading, error, empty, etc.)
-   - Adaptive breakpoints match the spec's `size_classes`
-   - Locale keys match `$t:` references
-   - Navigation targets match flow definitions
-8. Report any real gaps found and fix them before finishing.
-
-**Creating new spec files:**
-- Call `openuispec_spec_types` to discover available spec types.
-- Call `openuispec_spec_schema` with the specific type to get the full JSON schema.
-- Write the spec file following the schema exactly.
-
-**Focused getters (prefer these for incremental edits over `read_specs`):**
-- `openuispec_get_screen(name)` — single screen spec
-- `openuispec_get_contract(name, variant?)` — single contract, optionally one variant
-- `openuispec_get_tokens(category)` — single token category (color, typography, spacing, etc.)
-- `openuispec_get_locale(locale, keys?)` — single locale file, optionally filtered keys
-- `openuispec_check(target, screens?, contracts?)` — scoped audit for specific screens/contracts
-
-Use `read_specs` for full-project generation; use focused getters when editing one screen or contract.
-
-**Other tools:**
-- `openuispec_status` — cross-target summary, good starting point
-- `openuispec_drift` with `explain: true` — property-level spec changes
-- `openuispec_validate` — schema-only validation by group
-
-### CLI fallback (when MCP is not available)
-
-If MCP tools are not available, use these CLI commands with `--json` flag:
-- `openuispec prepare --target <t> --json` — build AI-ready work bundle
-- `openuispec check --target <t> --json` — composite validation
-- `openuispec status --json` — cross-target status
-- `openuispec drift --target <t> --explain --json` — semantic drift
-- `openuispec validate [group...] --json` — schema validation
-- `openuispec read-specs [paths...]` — read spec file contents
-- `openuispec get-screen <name>` — get a single screen spec
-- `openuispec get-contract <name> [--variant v]` — get a contract spec
-- `openuispec get-tokens <category>` — get tokens for a category
-- `openuispec get-locale <locale> [--keys k1,k2]` — get a locale file
-- `openuispec spec-types` — list available spec types
-- `openuispec spec-schema <type>` — get JSON schema for a spec type
-- `openuispec screenshot --route /path` — screenshot the web app
-- `openuispec screenshot-android [--project-dir path]` — screenshot Android app
-- `openuispec screenshot-ios [--project-dir path]` — screenshot iOS app
-
-### Other CLI commands
-- `openuispec init` — scaffold a new spec project
-- `openuispec drift --snapshot --target <t>` — snapshot current state (only after UI code is updated)
-- `openuispec configure-target <t>` — configure target platform stack
-- `openuispec update-rules` — update AI rules to match installed package version
-
-## Spec format reference
-
-The spec format, schemas, and generation rules are in the installed `openuispec` package.
-You MUST read the reference files before creating or editing spec files — do NOT guess the format.
-
-**Find the package:** `node_modules/openuispec/` or run `npm root -g` → `<prefix>/openuispec/`.
-**Online fallback:** `https://openuispec.rsteam.uz/llms-full.txt`
-
-**Reference files (read in order):**
-1. `README.md` — schema tables, file format, root wrapper keys
-2. `spec/openuispec-v0.1.md` — full specification
-3. `examples/taskflow/openuispec/` — complete working example
-4. `schema/` — JSON Schemas for every file type
-
-## Spec location
-- Spec root: `openuispec/` — read `openuispec/openuispec.yaml` first for actual paths.
-- Default dirs: tokens/, screens/, flows/, contracts/, platform/, locales/
-
-## When to start from spec vs platform code
-
-**Spec-first** (use `openuispec_prepare` or `openuispec prepare`):
-- Screen structure, navigation, fields, actions, validation, data binding changes
-- Token, variant, contract, flow, or localization changes
-- Changes affecting multiple platforms
-- Requests in product/UI terms
-
-**Platform-first** (skip spec tools):
-- Platform-specific polish (iOS-only, Android-only, web-only)
-- Local bug fixes that don't alter shared semantic behavior
-
-## If spec directories are empty (first-time setup)
-
-Read `spec/openuispec-v0.1.md` from the package first, then:
-1. Scan codebase for UI screens → create `openuispec/screens/<name>.yaml` as `status: stub`
-2. Extract tokens (colors, fonts, spacing) → `openuispec/tokens/`
-3. Create contract extensions → `openuispec/contracts/`
-4. Create locale files → `openuispec/locales/<locale>.json`
-5. Fill in `data_model`, `api.endpoints` in `openuispec/openuispec.yaml`
-
-## Rules
-- Do not snapshot drift unless the UI code has also been updated.
-- Do not modify generated UI without checking whether the spec must change first.
-- Do not use `configure-target --defaults` as silent approval — ask the user to confirm.
-- Always read spec format from the installed package, not from cached/memorized content.
-<!-- openuispec-rules-end -->

package/examples/social-app/backend/.gitkeep

@@ -1 +0,0 @@
-

package/examples/social-app/generated/android/social-app/app/.paparazzi-hashes.json

@@ -1,3 +0,0 @@
-{
-  "/Users/rustam/Projects/openuispec/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/ui/screens/HomeFeedScreen.kt": "5917db1b3b8c8633cd315829f8d2ecaf"
-}

package/examples/social-app/generated/android/social-app/app/build.gradle.kts

@@ -1,94 +0,0 @@
-plugins {
-    id("app.cash.paparazzi")
-    alias(libs.plugins.android.application)
-    alias(libs.plugins.compose.compiler)
-    kotlin("plugin.serialization")
-}
-
-android {
-    namespace = "com.social.app"
-    compileSdk = 36
-
-    defaultConfig {
-        applicationId = "com.social.app"
-        minSdk = 26
-        targetSdk = 36
-        versionCode = 1
-        versionName = "1.0"
-
-        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
-        vectorDrawables {
-            useSupportLibrary = true
-        }
-    }
-
-    buildTypes {
-        release {
-            isMinifyEnabled = false
-            proguardFiles(
-                getDefaultProguardFile("proguard-android-optimize.txt"),
-                "proguard-rules.pro"
-            )
-        }
-    }
-    compileOptions {
-        sourceCompatibility = JavaVersion.VERSION_11
-        targetCompatibility = JavaVersion.VERSION_11
-    }
-    kotlin {
-        compilerOptions {
-            jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_11)
-        }
-    }
-    buildFeatures {
-        compose = true
-    }
-    packaging {
-        resources {
-            excludes += "/META-INF/{AL2.0,LGPL2.1}"
-        }
-    }
-}
-
-dependencies {
-    implementation(libs.androidx.core.ktx)
-    implementation(libs.androidx.lifecycle.runtime.ktx)
-    implementation(libs.androidx.activity.compose)
-    implementation(platform(libs.androidx.compose.bom))
-    implementation(libs.androidx.ui)
-    implementation(libs.androidx.ui.graphics)
-    implementation(libs.androidx.ui.tooling.preview)
-    implementation(libs.androidx.material3)
-    implementation(libs.androidx.material.icons.extended)
-    implementation(libs.google.material)
-    implementation(libs.coil.compose)
-    implementation(libs.coil.network)
-
-    // Decompose
-    implementation(libs.decompose)
-    implementation(libs.decompose.extensions.compose)
-    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3")
-
-    // MVIKotlin
-    implementation(libs.mvikotlin)
-    implementation(libs.mvikotlin.main)
-    implementation(libs.mvikotlin.logging)
-    implementation("com.arkivanov.mvikotlin:mvikotlin-extensions-coroutines:4.3.0")
-
-    // Essenty
-    implementation(libs.essenty.lifecycle)
-    implementation(libs.essenty.instancekeeper)
-
-    // DataStore
-    implementation(libs.androidx.datastore.preferences)
-    implementation(libs.androidx.datastore.core)
-
-    testImplementation("junit:junit:4.13.2")
-    androidTestImplementation("androidx.test.ext:junit:1.2.1")
-    androidTestImplementation("androidx.test.espresso:espresso-core:3.6.1")
-    androidTestImplementation(platform(libs.androidx.compose.bom))
-    androidTestImplementation("androidx.compose.ui:ui-test-junit4")
-    debugImplementation(libs.androidx.ui.tooling)
-    debugImplementation("androidx.compose.ui:ui-test-manifest")
-
-}

package/examples/social-app/generated/android/social-app/app/src/main/AndroidManifest.xml

@@ -1,26 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
-
-    <uses-permission android:name="android.permission.INTERNET" />
-
-    <application
-        android:name=".SocialAppApplication"
-        android:allowBackup="true"
-        android:icon="@mipmap/ic_launcher"
-        android:label="@string/nav_home"
-        android:roundIcon="@mipmap/ic_launcher_round"
-        android:supportsRtl="true"
-        android:theme="@style/Theme.SocialApp">
-        <activity
-            android:name=".MainActivity"
-            android:exported="true"
-            android:label="@string/nav_home"
-            android:theme="@style/Theme.SocialApp">
-            <intent-filter>
-                <action android:name="android.intent.action.MAIN" />
-                <category android:name="android.intent.category.LAUNCHER" />
-            </intent-filter>
-        </activity>
-    </application>
-
-</manifest>

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/AppContainer.kt

@@ -1,20 +0,0 @@
-package com.social.app
-
-import android.content.Context
-import com.arkivanov.decompose.ComponentContext
-import com.arkivanov.mvikotlin.core.store.StoreFactory
-import com.social.app.data.preferences.DataStorePreferencesRepository
-import com.social.app.data.preferences.PreferencesRepository
-import com.social.app.ui.navigation.DefaultRootComponent
-import com.social.app.ui.navigation.RootComponent
-import com.arkivanov.mvikotlin.main.store.DefaultStoreFactory
-import com.arkivanov.mvikotlin.logging.store.LoggingStoreFactory
-
-class AppContainer(
-    context: Context,
-) {
-    val preferencesRepository: PreferencesRepository = DataStorePreferencesRepository(context.applicationContext)
-    val storeFactory: StoreFactory = LoggingStoreFactory(DefaultStoreFactory())
-
-    fun createRootComponent(componentContext: ComponentContext): RootComponent = DefaultRootComponent(componentContext)
-}

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/MainActivity.kt

@@ -1,35 +0,0 @@
-package com.social.app
-
-import android.os.Bundle
-import androidx.activity.ComponentActivity
-import androidx.activity.compose.setContent
-import androidx.activity.enableEdgeToEdge
-import androidx.compose.runtime.collectAsState
-import androidx.compose.runtime.getValue
-import com.arkivanov.decompose.defaultComponentContext
-import com.social.app.data.preferences.AppPreferences
-import com.social.app.ui.MainShell
-import com.social.app.ui.theme.SocialAppTheme
-
-class MainActivity : ComponentActivity() {
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-        val appContainer = (application as SocialAppApplication).appContainer
-        val root = appContainer.createRootComponent(defaultComponentContext())
-
-        enableEdgeToEdge()
-        setContent {
-            val preferences by appContainer.preferencesRepository.preferences.collectAsState(initial = AppPreferences())
-
-            SocialAppTheme(
-                themeMode = preferences.themeMode,
-            ) {
-                MainShell(
-                    root = root,
-                    preferencesRepository = appContainer.preferencesRepository,
-                    storeFactory = appContainer.storeFactory,
-                )
-            }
-        }
-    }
-}

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/SocialAppApplication.kt

@@ -1,13 +0,0 @@
-package com.social.app
-
-import android.app.Application
-
-class SocialAppApplication : Application() {
-    lateinit var appContainer: AppContainer
-        private set
-
-    override fun onCreate() {
-        super.onCreate()
-        appContainer = AppContainer(this)
-    }
-}

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/data/MockData.kt

@@ -1,98 +0,0 @@
-package com.social.app.data
-
-import com.social.app.model.*
-
-object MockData {
-    val users = listOf(
-        User(
-            id = "user_me",
-            handle = "rustam",
-            displayName = "Rustam Abdurahmonov",
-            avatarUrl = "https://images.unsplash.com/photo-1500648767791-00dcc994a43e?auto=format&fit=crop&w=320&q=80",
-            bio = "Designing interface systems that feel editorial, human, and alive.",
-            followers = 1240,
-            following = 184
-        ),
-        User(
-            id = "u_9921",
-            handle = "elara_vox",
-            displayName = "Elara Vance",
-            avatarUrl = "https://images.unsplash.com/photo-1534528741775-53994a69daeb?auto=format&fit=crop&w=256&q=80",
-            bio = "Digital Architect | Exploring the intersection of AR and urban spaces 🏙️",
-            followers = 12400,
-            following = 842,
-            isFollowed = true
-        ),
-        User(
-            id = "u_4432",
-            handle = "kai_zen",
-            displayName = "Kai Nakamura",
-            avatarUrl = "https://images.unsplash.com/photo-1507003211169-0a1dd7228f2d?auto=format&fit=crop&w=256&q=80",
-            bio = "Sustainable tech & minimalist living. 🌿 Tokyo -> Berlin",
-            followers = 3100,
-            following = 1100
-        )
-    )
-
-    val posts = listOf(
-        Post(
-            id = "p_77102",
-            authorId = "u_9921",
-            authorName = "Elara Vance",
-            authorHandle = "elara_vox",
-            authorAvatar = "https://images.unsplash.com/photo-1534528741775-53994a69daeb?auto=format&fit=crop&w=256&q=80",
-            body = "The new Neo-Tokyo district looks incredible in the morning light. The AR overlays are finally syncing perfectly with the physical architecture. #FutureCity #DigitalTwin #2026",
-            mediaUrl = "https://images.unsplash.com/photo-1618005182384-a83a8bd57fbe?auto=format&fit=crop&w=1080&q=80",
-            likeCount = 1432,
-            commentCount = 42,
-            timestamp = "4 hours ago",
-            liked = true
-        ),
-        Post(
-            id = "p_77103",
-            authorId = "u_4432",
-            authorName = "Kai Nakamura",
-            authorHandle = "kai_zen",
-            authorAvatar = "https://images.unsplash.com/photo-1507003211169-0a1dd7228f2d?auto=format&fit=crop&w=256&q=80",
-            body = "Workspace evolution. Keeping it clean and focused this year.",
-            mediaUrl = "https://images.unsplash.com/photo-1497366216548-37526070297c?auto=format&fit=crop&w=1080&q=80",
-            likeCount = 890,
-            commentCount = 15,
-            timestamp = "9 hours ago"
-        ),
-        Post(
-            id = "p_1",
-            authorId = "user_me",
-            authorName = "Rustam Abdurahmonov",
-            authorHandle = "rustam",
-            authorAvatar = "https://images.unsplash.com/photo-1500648767791-00dcc994a43e?auto=format&fit=crop&w=320&q=80",
-            body = "Spent the morning photographing a cafe before it opened. The cups were already warm, the chairs still slightly crooked. Those in-between moments always feel the most honest.",
-            mediaUrl = "https://images.unsplash.com/photo-1495474472287-4d71bcdd2085?auto=format&fit=crop&w=1200&q=80",
-            likeCount = 243,
-            commentCount = 12,
-            timestamp = "1 day ago"
-        )
-    )
-
-    val stories = listOf(
-        Story(id = "s_1", authorId = "u_9921", authorName = "Elara Vance", previewUrl = "https://images.unsplash.com/photo-1550745165-9bc0b252726f?auto=format&fit=crop&w=720&q=80"),
-        Story(id = "s_2", authorId = "u_4432", authorName = "Kai Nakamura", previewUrl = "https://images.unsplash.com/photo-1511467687858-23d96c32e4ae?auto=format&fit=crop&w=720&q=80"),
-        Story(id = "s_3", authorId = "user_me", authorName = "Rustam", previewUrl = "https://images.unsplash.com/photo-1500648767791-00dcc994a43e?auto=format&fit=crop&w=320&q=80")
-    )
-
-    val trends = listOf(
-        Trend(id = "t_1", label = "Editorial UI", postCount = 8420),
-        Trend(id = "t_2", label = "Warm Brutalism", postCount = 4135),
-        Trend(id = "t_3", label = "Motion Details", postCount = 2940),
-        Trend(id = "t_4", label = "Design Systems", postCount = 8677)
-    )
-
-    val notifications = listOf(
-        Notification(id = "n_1", type = "like", actorName = "Elara Vance", actorAvatar = "https://images.unsplash.com/photo-1534528741775-53994a69daeb?auto=format&fit=crop&w=256&q=80", message = "liked your post", timestamp = "34m ago"),
-        Notification(id = "n_2", type = "comment", actorName = "Kai Nakamura", actorAvatar = "https://images.unsplash.com/photo-1507003211169-0a1dd7228f2d?auto=format&fit=crop&w=256&q=80", message = "commented on your post", timestamp = "7h ago"),
-        Notification(id = "n_3", type = "follow", actorName = "Elara Vance", actorAvatar = "https://images.unsplash.com/photo-1534528741775-53994a69daeb?auto=format&fit=crop&w=256&q=80", message = "started following you", timestamp = "1d ago")
-    )
-}
-
-data class Trend(val id: String, val label: String, val postCount: Int)
-data class Notification(val id: String, val type: String, val actorName: String, val actorAvatar: String?, val message: String, val timestamp: String)

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/data/preferences/AppPreferences.kt

@@ -1,19 +0,0 @@
-package com.social.app.data.preferences
-
-enum class ThemeMode(val storageValue: String) {
-    System("system"),
-    Light("light"),
-    Dark("dark");
-
-    companion object {
-        fun fromStorageValue(value: String?): ThemeMode =
-            entries.firstOrNull { it.storageValue == value } ?: System
-    }
-}
-
-data class AppPreferences(
-    val themeMode: ThemeMode = ThemeMode.System,
-    val pushNotifications: Boolean = true,
-    val messagePreviews: Boolean = true,
-    val autoTranslate: Boolean = false,
-)

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/data/preferences/DataStorePreferencesRepository.kt

@@ -1,68 +0,0 @@
-package com.social.app.data.preferences
-
-import android.content.Context
-import androidx.datastore.core.DataStore
-import androidx.datastore.preferences.core.Preferences
-import androidx.datastore.preferences.core.booleanPreferencesKey
-import androidx.datastore.preferences.core.edit
-import androidx.datastore.preferences.core.emptyPreferences
-import androidx.datastore.preferences.core.stringPreferencesKey
-import androidx.datastore.preferences.preferencesDataStore
-import java.io.IOException
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.catch
-import kotlinx.coroutines.flow.map
-
-private val Context.socialAppDataStore: DataStore<Preferences> by preferencesDataStore(name = "social_app_preferences")
-
-class DataStorePreferencesRepository(
-    private val context: Context,
-) : PreferencesRepository {
-    override val preferences: Flow<AppPreferences> =
-        context.socialAppDataStore.data
-            .catch { exception ->
-                if (exception is IOException) {
-                    emit(emptyPreferences())
-                } else {
-                    throw exception
-                }
-            }.map { storedPreferences ->
-                AppPreferences(
-                    themeMode = ThemeMode.fromStorageValue(storedPreferences[Keys.ThemeMode]),
-                    pushNotifications = storedPreferences[Keys.PushNotifications] ?: true,
-                    messagePreviews = storedPreferences[Keys.MessagePreviews] ?: true,
-                    autoTranslate = storedPreferences[Keys.AutoTranslate] ?: false,
-                )
-            }
-
-    override suspend fun updateThemeMode(themeMode: ThemeMode) {
-        context.socialAppDataStore.edit { storedPreferences ->
-            storedPreferences[Keys.ThemeMode] = themeMode.storageValue
-        }
-    }
-
-    override suspend fun updatePushNotifications(enabled: Boolean) {
-        context.socialAppDataStore.edit { storedPreferences ->
-            storedPreferences[Keys.PushNotifications] = enabled
-        }
-    }
-
-    override suspend fun updateMessagePreviews(enabled: Boolean) {
-        context.socialAppDataStore.edit { storedPreferences ->
-            storedPreferences[Keys.MessagePreviews] = enabled
-        }
-    }
-
-    override suspend fun updateAutoTranslate(enabled: Boolean) {
-        context.socialAppDataStore.edit { storedPreferences ->
-            storedPreferences[Keys.AutoTranslate] = enabled
-        }
-    }
-
-    private object Keys {
-        val ThemeMode = stringPreferencesKey("theme_mode")
-        val PushNotifications = booleanPreferencesKey("push_notifications")
-        val MessagePreviews = booleanPreferencesKey("message_previews")
-        val AutoTranslate = booleanPreferencesKey("auto_translate")
-    }
-}

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/data/preferences/PreferencesRepository.kt

@@ -1,15 +0,0 @@
-package com.social.app.data.preferences
-
-import kotlinx.coroutines.flow.Flow
-
-interface PreferencesRepository {
-    val preferences: Flow<AppPreferences>
-
-    suspend fun updateThemeMode(themeMode: ThemeMode)
-
-    suspend fun updatePushNotifications(enabled: Boolean)
-
-    suspend fun updateMessagePreviews(enabled: Boolean)
-
-    suspend fun updateAutoTranslate(enabled: Boolean)
-}

package/examples/social-app/generated/android/social-app/app/src/main/java/com/social/app/model/Models.kt

@@ -1,34 +0,0 @@
-package com.social.app.model
-
-data class User(
-    val id: String,
-    val handle: String,
-    val displayName: String,
-    val avatarUrl: String? = null,
-    val bio: String? = null,
-    val followers: Int = 0,
-    val following: Int = 0,
-    val isFollowed: Boolean = false
-)
-
-data class Post(
-    val id: String,
-    val authorId: String,
-    val authorName: String,
-    val authorHandle: String,
-    val authorAvatar: String? = null,
-    val body: String,
-    val mediaUrl: String? = null,
-    val likeCount: Int = 0,
-    val commentCount: Int = 0,
-    val timestamp: String,
-    val liked: Boolean = false
-)
-
-data class Story(
-    val id: String,
-    val authorId: String,
-    val authorName: String,
-    val authorAvatar: String? = null,
-    val previewUrl: String? = null
-)