feat: docs

Author: okwasniewski

apps/AppleApp/Brownfield Apple App/ContentView.swift

@@ -7,7 +7,6 @@ let initialState = BrownfieldStore(
   user: User(name: "Username")
 )
 
-
 struct ContentView: View {
     var body: some View {
         NavigationView {

apps/RNApp/package.json

@@ -9,7 +9,7 @@
     "build:example:ios-rn": "react-native build-ios",
     "brownfield:package:android": "brownfield package:android --module-name :BrownfieldLib --variant release --verbose",
     "brownfield:publish:android": "brownfield publish:android --module-name :BrownfieldLib --verbose",
-    "brownfield:package:ios": "brownfield package:ios --scheme BrownfieldLib",
+    "brownfield:package:ios": "brownfield package:ios --scheme BrownfieldLib --configuration Release --verbose",
     "lint": "eslint .",
     "start": "react-native start",
     "test": "jest",

docs/docs/brownie/codegen.mdx

@@ -19,20 +19,20 @@ Add to your app's `package.json`:
 ```json
 {
   "brownie": {
-    "swift": "./ios/Generated/",
     "kotlin": "./android/app/src/main/java/com/example/",
     "kotlinPackageName": "com.example"
   }
 }
 ```
 
+Note: This config is subject to change as Android support is rolled out. Ideally this will be removed in favor of auto-detection.
+
 | Field               | Required | Description                                                |
 | ------------------- | -------- | ---------------------------------------------------------- |
-| `swift`             | No\*     | Output directory for Swift files                           |
-| `kotlin`            | No\*     | Output directory for Kotlin files                          |
+| `kotlin`            | No       | Output directory for Kotlin files                          |
 | `kotlinPackageName` | No       | Kotlin package name (extracted from path if not specified) |
 
-\*At least one of `swift` or `kotlin` is required.
+**Note:** Swift files are always generated to `node_modules/@callstack/brownie/ios/Generated/`. This path is auto-resolved and not configurable.
 
 ## Generated Output
 
@@ -47,16 +47,18 @@ interface BrownfieldStore extends BrownieStore {
 
 ### Swift Output
 
+Generated to: `node_modules/@callstack/brownie/ios/Generated/BrownfieldStore.swift`
+
 ```swift
 import Brownie
 
-struct BrownfieldStore: Codable {
-    var counter: Double
-    var user: User
+public struct BrownfieldStore: Codable {
+    public var counter: Double
+    public var user: User
 }
 
-struct User: Codable {
-    var name: String
+public struct User: Codable {
+    public var name: String
 }
 
 extension BrownfieldStore: BrownieStoreProtocol {
@@ -66,6 +68,7 @@ extension BrownfieldStore: BrownieStoreProtocol {
 
 The generated struct:
 
+- Uses `public` access level for framework compatibility
 - Conforms to `Codable` for JSON serialization
 - Conforms to `BrownieStoreProtocol` with auto-generated `storeName`
 - Uses mutable `var` properties

docs/docs/brownie/overview.mdx

@@ -98,13 +98,13 @@ function Counter() {
 import Brownie
 
 struct ContentView: View {
-  @UseStore<AppStore> var store
+  @UseStore(\AppStore.counter) var counter
 
   var body: some View {
     VStack {
-      Text("Count: \(Int(store.state.counter))")
+      Text("Count: \(Int(counter))")
       Button("Increment") {
-        store.set { $0.counter += 1 }
+        $counter.set { $0 + 1 }
       }
     }
   }

docs/docs/brownie/store-definition.mdx

@@ -43,17 +43,17 @@ interface BrownfieldStore extends BrownieStore {
 }
 ```
 
-Generated Swift:
+Generated Swift (to `node_modules/@callstack/brownie/ios/Generated/`):
 
 ```swift
-struct BrownfieldStore: Codable {
-    var counter: Double
-    var user: User
+public struct BrownfieldStore: Codable {
+    public var counter: Double
+    public var user: User
 }
 
-struct User: Codable {
-    var name: String
-    var email: String
+public struct User: Codable {
+    public var name: String
+    public var email: String
 }
 ```
 

packages/brownie/ArchitectureOverview.md

@@ -48,7 +48,6 @@ Add to your app's `package.json`:
 ```json
 {
   "brownie": {
-    "swift": "./ios/Generated/",
     "kotlin": "./android/app/src/main/java/com/example/",
     "kotlinPackageName": "com.example"
   }
@@ -57,11 +56,10 @@ Add to your app's `package.json`:
 
 | Field               | Required | Description                               |
 | ------------------- | -------- | ----------------------------------------- |
-| `swift`             | No\*     | Output directory for Swift files          |
-| `kotlin`            | No\*     | Output directory for Kotlin files         |
+| `kotlin`            | No       | Output directory for Kotlin files         |
 | `kotlinPackageName` | No       | Kotlin package name (extracted from path) |
 
-\*At least one of `swift` or `kotlin` is required.
+**Note:** Swift files are always generated to `node_modules/@callstack/brownie/ios/Generated/`. This path is auto-resolved and not configurable.
 
 ### Store Definition
 
@@ -110,16 +108,18 @@ declare module '@callstack/brownie' {
 
 ### Generated Output
 
-**Swift** (`Codable` struct with mutable properties):
+**Swift** (`Codable` struct with public access and mutable properties):
 
 ```swift
-struct BrownfieldStore: Codable {
-    var counter: Double
-    var isLoading: Bool
-    var user: String
+public struct BrownfieldStore: Codable {
+    public var counter: Double
+    public var isLoading: Bool
+    public var user: String
 }
 ```
 
+Generated to: `node_modules/@callstack/brownie/ios/Generated/BrownfieldStore.swift`
+
 **Kotlin** (data class):
 
 ```kotlin
@@ -185,7 +185,9 @@ packages/brownie/
 ├── ios/
 │   ├── BrownieModule.h/.mm        # TurboModule, installs JSI bindings
 │   ├── BrownieStoreBridge.h/.mm   # ObjC++ wrapper for Swift access
-│   └── BrownieStore.swift         # Swift Store<T>, StoreManager, @UseStore
+│   ├── BrownieFollyConvert.h      # FollyConvert import compatibility header
+│   ├── BrownieStore.swift         # Swift Store<T>, StoreManager, @UseStore
+│   └── Generated/                 # Auto-generated Swift store types (codegen output)
 ```
 
 ### C++ Core
@@ -216,6 +218,13 @@ packages/brownie/
 
 ### iOS Bridge
 
+**BrownieFollyConvert.h** - Compatibility header for FollyConvert imports:
+
+- Handles different import paths depending on CocoaPods configuration
+- Supports static libs with header maps (default)
+- Supports `use_frameworks! :linkage => :static` setups
+- Falls back to `RCTFollyConvert.h` when available
+
 **BrownieStoreBridge** (ObjC++) - Exposes C++ to Swift:
 
 - `registerStore(withKey:)` - Create C++ store, set up notification callback

packages/cli/src/brownfield/commands/packageIos.ts

@@ -15,7 +15,7 @@ import {
 
 import { Command } from 'commander';
 
-import { hasBrownieConfig } from '../../brownie/config.js';
+import { isBrownieInstalled } from '../../brownie/config.js';
 import { runCodegen } from '../../brownie/commands/codegen.js';
 import { getProjectInfo } from '../utils/index.js';
 import {
@@ -73,7 +73,7 @@ export const packageIosCommand = curryOptions(
       platformConfig
     );
 
-    if (hasBrownieConfig(projectRoot)) {
+    if (isBrownieInstalled(projectRoot)) {
       await runCodegen({ platform: 'swift' });
 
       const productsPath = path.join(options.buildFolder, 'Build', 'Products');

packages/cli/src/brownie/__tests__/config.test.ts

@@ -5,7 +5,7 @@ import path from 'node:path';
 import { afterEach, describe, expect, it, vi } from 'vitest';
 
 import {
-  hasBrownieConfig,
+  isBrownieInstalled,
   loadConfig,
   getBrowniePackagePath,
   getSwiftOutputPath,
@@ -76,39 +76,14 @@ describe('loadConfig', () => {
   });
 });
 
-describe('hasBrownieConfig', () => {
-  let tempDir: string | null = null;
-
-  afterEach(() => {
-    if (tempDir) {
-      cleanupTempDir(tempDir);
-      tempDir = null;
-    }
-  });
-
-  it('returns false when package.json not found', () => {
-    expect(hasBrownieConfig('/nonexistent/path')).toBe(false);
-  });
-
-  it('returns false when brownie config missing', () => {
-    tempDir = createTempPackageJson({});
-    expect(hasBrownieConfig(tempDir)).toBe(false);
+describe('isBrownieInstalled', () => {
+  it('returns false when brownie is not installed', () => {
+    expect(isBrownieInstalled('/nonexistent/path')).toBe(false);
   });
 
-  it('returns true when brownie config exists', () => {
-    tempDir = createTempPackageJson({
-      brownie: {},
-    });
-    expect(hasBrownieConfig(tempDir)).toBe(true);
-  });
-
-  it('returns true when brownie config has kotlin', () => {
-    tempDir = createTempPackageJson({
-      brownie: {
-        kotlin: './Generated',
-      },
-    });
-    expect(hasBrownieConfig(tempDir)).toBe(true);
+  it('returns true when brownie is installed', () => {
+    const rnAppPath = path.resolve(__dirname, '../../../../../apps/RNApp');
+    expect(isBrownieInstalled(rnAppPath)).toBe(true);
   });
 });
 

packages/cli/src/brownie/config.ts

@@ -11,15 +11,37 @@ interface PackageJson {
   brownie?: BrownieConfig;
 }
 
+/**
+ * Checks if @callstack/brownie package is installed.
+ */
+export function isBrownieInstalled(
+  projectRoot: string = process.cwd()
+): boolean {
+  const require = createRequire(path.join(projectRoot, 'package.json'));
+  try {
+    require.resolve('@callstack/brownie/package.json');
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 /**
  * Resolves the path to the @callstack/brownie package.
  */
 export function getBrowniePackagePath(
   projectRoot: string = process.cwd()
 ): string {
   const require = createRequire(path.join(projectRoot, 'package.json'));
-  const browniePackageJson = require.resolve('@callstack/brownie/package.json');
-  return path.dirname(browniePackageJson);
+  try {
+    const browniePackageJson =
+      require.resolve('@callstack/brownie/package.json');
+    return path.dirname(browniePackageJson);
+  } catch {
+    throw new Error(
+      "@callstack/brownie is not installed. Run 'npm install @callstack/brownie' or 'yarn add @callstack/brownie'"
+    );
+  }
 }
 
 /**
@@ -32,26 +54,6 @@ export function getSwiftOutputPath(
   return path.join(browniePath, 'ios', 'Generated');
 }
 
-/**
- * Checks if brownie config exists in package.json.
- */
-export function hasBrownieConfig(projectRoot: string = process.cwd()): boolean {
-  const packageJsonPath = path.resolve(projectRoot, 'package.json');
-
-  if (!fs.existsSync(packageJsonPath)) {
-    return false;
-  }
-
-  try {
-    const packageJson: PackageJson = JSON.parse(
-      fs.readFileSync(packageJsonPath, 'utf-8')
-    );
-    return packageJson.brownie !== undefined;
-  } catch {
-    return false;
-  }
-}
-
 /**
  * Loads brownie config from package.json in the current working directory.
  */