Merge branch 'master' into chore/update-readme

Author: sumeruchat

.github/workflows/validate-release.yml

@@ -0,0 +1,68 @@
+name: Validate Release PR
+
+on:
+  pull_request:
+    types: [labeled, opened, synchronize, edited]
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  validate:
+    if: >-
+      (github.event.action == 'labeled' && github.event.label.name == 'release') ||
+      (github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'release'))
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Validate Release PR
+        env:
+          PR_BODY: ${{ github.event.pull_request.body }}
+        run: |
+          errors=()
+
+          # --- Extract version from source of truth ---
+          version=$(grep -oP 's\.version\s*=\s*"\K[^"]+' Iterable-iOS-SDK.podspec)
+          if [ -z "$version" ]; then
+            echo "::error::Could not extract version from Iterable-iOS-SDK.podspec"
+            exit 1
+          fi
+          echo "Detected version: $version"
+
+          # --- Check: Docs PR linked ---
+          if ! echo "$PR_BODY" | grep -qiP "github\.com/Iterable/iterable-docs/pull/\d+"; then
+            errors+=("No docs PR link found in the PR description. Add a link to the iterable-docs PR (e.g. https://github.com/Iterable/iterable-docs/pull/123).")
+          fi
+
+          # --- Check: CHANGELOG entry ---
+          if ! grep -qF "## [$version]" CHANGELOG.md; then
+            errors+=("CHANGELOG.md is missing an entry for version [$version].")
+          fi
+
+          # --- Check: Version consistency ---
+          podspec_sdk=$(grep -oP "s\.version\s*=\s*\"\K[^\"]+" Iterable-iOS-SDK.podspec)
+          podspec_ext=$(grep -oP "s\.version\s*=\s*\"\K[^\"]+" Iterable-iOS-AppExtensions.podspec)
+          swift_ver=$(grep -oP 'static let sdkVersion\s*=\s*"\K[^"]+' swift-sdk/SDK/IterableAPI.swift)
+
+          if [ "$podspec_sdk" != "$version" ]; then
+            errors+=("Iterable-iOS-SDK.podspec s.version is '$podspec_sdk', expected '$version'.")
+          fi
+          if [ "$podspec_ext" != "$version" ]; then
+            errors+=("Iterable-iOS-AppExtensions.podspec s.version is '$podspec_ext', expected '$version'.")
+          fi
+          if [ "$swift_ver" != "$version" ]; then
+            errors+=("IterableAPI.swift sdkVersion is '$swift_ver', expected '$version'.")
+          fi
+
+          # --- Report ---
+          if [ ${#errors[@]} -gt 0 ]; then
+            echo "::error::Release validation failed with ${#errors[@]} issue(s):"
+            for err in "${errors[@]}"; do
+              echo "::error::  - $err"
+            done
+            exit 1
+          fi
+
+          echo "All release validations passed for version $version."

.gitignore

@@ -39,3 +39,4 @@ CI.swift
 *.mdb
 .build/arm64-apple-macosx/debug/IterableSDK.build/output-file-map.json
 .build
+.mcp.json

CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 
+## [6.6.7]
+### Fixed
+- Fixed module export for CocoaPods, enabling Obj-C/C++ compatibility
+- Added `extern "C"` guards to umbrella headers (`IterableSDK.h`, `IterableAppExtensions.h`) for C++ compatibility
+- Renamed CocoaPods resource bundle from `Resources` to `IterableSDKResources` to avoid naming collisions with other pods, with automatic fallback to the legacy name
+
+## [6.6.6]
+### Fixed 
+- Fixed more Carthage issues
+- Fixed issue that prevented multiple applications using a shared keychain access group.
+- Improves in-app full screen position to display over the entire screen includind the status bar.
+
+### Added
+- Made `isIterableDeepLink` method public
+
 ## [6.6.5]
 ### Fixed
 - Fixed an issue where concurrent API requests failing with JWT-related 401 errors could be dropped instead of retried after a new token was obtained, ensuring all affected calls are executed once authentication succeeds.

CLAUDE.md

@@ -2,6 +2,167 @@
 
 🤖 **AI Agent Instructions**
 
-Please read the `AGENT_README.md` file for comprehensive project information, development workflow, and testing procedures.
+## Project Overview
+This is the **Iterable Swift SDK** for iOS/macOS integration. The SDK provides:
+- Push notification handling
+- In-app messaging
+- Event tracking
+- User management
+- Unknown user tracking
 
-All the information you need to work on this Iterable Swift SDK project is documented there. 
+## Key Architecture
+- **Core SDK**: `swift-sdk/` - Main SDK implementation
+- **Sample Apps**: `sample-apps/` - Example integrations
+- **Tests**: `tests/` - Unit tests, UI tests, and integration tests
+- **Notification Extension**: `notification-extension/` - Rich push support
+
+## Development Workflow
+
+### 🔨 Building the SDK
+```bash
+./agent_build.sh
+```
+- Validates compilation on iOS Simulator
+- Shows build errors with context
+- Requires macOS with Xcode
+
+### Listing All Available Tests
+
+# List all available test suites
+```bash
+./agent_test.sh --list
+```
+
+### 🧪 Running Tests
+```bash
+# Run all tests
+./agent_test.sh
+
+# Run specific test suite
+./agent_test.sh IterableApiCriteriaFetchTests
+
+# Run specific unit test (dot notation - recommended)
+./agent_test.sh "IterableApiCriteriaFetchTests.testForegroundCriteriaFetchWhenConditionsMet"
+
+# Run any specific test with path
+./agent_test.sh "unit-tests/IterableApiCriteriaFetchTests/testForegroundCriteriaFetchWhenConditionsMet"
+```
+- Executes on iOS Simulator with accurate pass/fail reporting
+- Returns exit code 0 for success, 1 for failures
+- Shows detailed test counts and failure information
+- `--list` shows all test suites with test counts
+- Requires password for xcpretty installation (first run)
+
+## Project Structure
+```
+swift-sdk/
+├── swift-sdk/               # Main SDK source
+│   ├── Core/               # Public APIs and models
+│   ├── Internal/           # Internal implementation
+│   ├── SDK/               # Main SDK entry points
+│   └── ui-components/     # SwiftUI/UIKit components
+├── tests/                 # Test suites
+│   ├── unit-tests/        # Unit tests
+│   ├── ui-tests/         # UI automation tests
+│   └── endpoint-tests/   # API endpoint tests
+├── sample-apps/          # Example applications
+└── notification-extension/ # Push notification extension
+```
+
+## Key Classes
+- **IterableAPI**: Main SDK interface
+- **IterableConfig**: Configuration management
+- **InternalIterableAPI**: Core implementation
+- **UnknownUserManager**: Unknown user tracking
+- **LocalStorage**: Data persistence
+
+## Common Tasks
+
+### Adding New Features
+1. Build first: `./agent_build.sh`
+2. Implement in `swift-sdk/Internal/` or `swift-sdk/SDK/`
+3. Add tests in `tests/unit-tests/`
+4. Verify: `./agent_test.sh` (all tests) or `./agent_test.sh YourTestSuite` (specific suite)
+
+### Debugging Build Issues
+- Build script shows compilation errors with file paths
+- Check Xcode project references in `swift-sdk.xcodeproj/project.pbxproj`
+- Verify file renames are reflected in project file
+
+### Test Failures
+- Test script shows specific failures with line numbers and detailed error messages
+- Run failing tests individually: `./agent_test.sh "TestSuite.testMethod"`
+- Mock classes available in `tests/common/`
+- Update parameter names when refactoring APIs
+
+## Requirements
+- **macOS**: Required for Xcode builds
+- **Xcode**: Latest stable version
+- **Ruby**: For xcpretty (auto-installed)
+- **iOS Simulator**: For testing
+
+## Quick Start for AI Agents
+1. Run `./agent_build.sh` to verify project builds
+2. Run `./agent_test.sh` to check test health (or `./agent_test.sh TestSuite` for specific suite)
+3. Make changes to source files
+4. Re-run both scripts to validate
+5. Debug failing tests: `./agent_test.sh "TestSuite.testMethod"`
+6. Commit when both pass ✅
+
+## Test Filtering Examples
+```bash
+# Debug specific failing tests
+./agent_test.sh "IterableApiCriteriaFetchTests.testForegroundCriteriaFetchWhenConditionsMet"
+
+# Run a problematic test suite
+./agent_test.sh ValidateCustomEventUserUpdateAPITest
+
+# Check auth-related tests
+./agent_test.sh AuthTests
+```
+
+## AI Agent Memory System
+
+### 🧠 Update Instructions for AI Agents
+**IMPORTANT**: When you discover something useful while working on this codebase, update this README to help future AI agents. Add learnings to the sections below.
+
+### 📍 Code Location Map
+- **Auth Logic**: `swift-sdk/Internal/AuthManager.swift` (main auth manager), `swift-sdk/Internal/Auth.swift` (auth models)
+- **API Calls**: `swift-sdk/Internal/api-client/ApiClient.swift` (main client), `swift-sdk/Internal/Network/NetworkHelper.swift` (networking)
+- **Models**: `swift-sdk/Core/Models/` (all data structures - CommerceItem, IterableInAppMessage, etc.)
+- **Main Entry**: `swift-sdk/SDK/IterableAPI.swift` (public-facing methods), `swift-sdk/Internal/InternalIterableAPI.swift` (core implementation) — note: public API surface lives in `IterableAPI.swift`, implementation details in `ApiClient.swift`
+- **Request Handling**: `swift-sdk/Internal/api-client/Request/` (online/offline processors)
+
+### 🛠️ Common Task Recipes
+
+**Add New API Endpoint:**
+1. Add path constant to `swift-sdk/Core/Constants.swift` in `Const.Path`
+2. Add method to `ApiClientProtocol.swift` and implement in `ApiClient.swift`
+3. Create request in `swift-sdk/Internal/api-client/Request/RequestCreator.swift`
+4. Add to `RequestHandlerProtocol.swift` and `RequestHandler.swift`
+
+**Modify Auth Logic:**
+- Main logic: `swift-sdk/Internal/AuthManager.swift`
+- Token storage: `swift-sdk/Internal/Utilities/Keychain/IterableKeychain.swift`
+- Auth failures: Handle in `RequestProcessorUtil.swift`
+
+**Add New Model:**
+- Create in `swift-sdk/Core/Models/YourModel.swift`
+- Make it `@objcMembers public class` for Objective-C compatibility
+- Implement `Codable` if it needs JSON serialization
+
+### 🐛 Common Failure Solutions
+
+**"Test X failed"** → Check test file in `tests/unit-tests/` - often parameter name mismatches after refactoring
+
+**"Build failed: file not found"** → Update `swift-sdk.xcodeproj/project.pbxproj` to include new/renamed files
+
+**"Auth token issues"** → Check `AuthManager.swift` and ensure JWT format is correct in tests
+
+**"Network request fails"** → Check endpoint in `Constants.swift` and request creation in `RequestCreator.swift`
+
+## Notes
+- Always test builds after refactoring
+- Parameter name changes require test file updates
+- Project file (`*.pbxproj`) may need manual updates for file renames
+- Sample apps demonstrate SDK usage patterns

Iterable-iOS-AppExtensions.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Iterable-iOS-AppExtensions"
   s.module_name  = "IterableAppExtensions"
-  s.version      = "6.6.5"
+  s.version      = "6.6.7"
   s.summary      = "App Extensions for Iterable SDK"
 
   s.description  = <<-DESC

Iterable-iOS-SDK.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Iterable-iOS-SDK"
   s.module_name  = "IterableSDK"
-  s.version      = "6.6.5"
+  s.version      = "6.6.7"
   s.summary      = "Iterable's official SDK for iOS"
 
   s.description  = <<-DESC
@@ -20,12 +20,13 @@ Pod::Spec.new do |s|
   s.documentation_url = "https://support.iterable.com/hc/en-us/articles/360035018152-Iterable-s-iOS-SDK"
 
   s.pod_target_xcconfig = {
-    'SWIFT_VERSION' => '5.3'
+    'SWIFT_VERSION' => '5.3',
+    'DEFINES_MODULE' => 'YES',
   }
 
   s.swift_version = '5.3'
 
-  s.resource_bundles = {'Resources' => 'swift-sdk/Resources/**/*.{storyboard,xib,xcassets,xcdatamodeld}' }
+  s.resource_bundles = {'IterableSDKResources' => 'swift-sdk/Resources/**/*.{storyboard,xib,xcassets,xcdatamodeld}' }
 
   s.header_dir = 'IterableSDK'
 end

agent_build.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+# This script is to be used by LLMs and AI agents to build the Iterable Swift SDK on macOS.
+# It uses xcpretty to format the build output and only shows errors.
+# It also checks if the build is successful and exits with the correct status.
+
+# Check if running on macOS
+if [[ "$(uname)" != "Darwin" ]]; then
+    echo "❌ This script requires macOS to run Xcode builds"
+    exit 1
+fi
+
+# Make sure xcpretty is installed
+if ! command -v xcpretty &> /dev/null; then
+    echo "xcpretty not found, installing via gem..."
+    sudo gem install xcpretty
+fi
+
+echo "Building Iterable Swift SDK..."
+
+# Create a temporary file for the build output
+TEMP_OUTPUT=$(mktemp)
+
+# Run the build and capture all output
+xcodebuild \
+    -project swift-sdk.xcodeproj \
+    -scheme "swift-sdk" \
+    -configuration Debug \
+    -sdk iphonesimulator \
+    build > $TEMP_OUTPUT 2>&1
+
+# Check the exit status
+BUILD_STATUS=$?
+
+# Show errors and warnings if build failed
+if [ $BUILD_STATUS -eq 0 ]; then
+    echo "✅ Iterable SDK build succeeded!"
+else
+    echo "❌ Iterable SDK build failed with status $BUILD_STATUS"
+    echo ""
+    echo "🔍 Build errors:"
+    grep -E 'error:|fatal:' $TEMP_OUTPUT | head -10
+    echo ""
+    echo "⚠️  Build warnings:"
+    grep -E 'warning:' $TEMP_OUTPUT | head -5
+fi
+
+# Remove the temporary file
+rm $TEMP_OUTPUT
+
+exit $BUILD_STATUS