mixpanel-react-native 3.2.0-beta.2 → 3.2.0

package/FEATURE_FLAGS_QUICKSTART.md

@@ -1,348 +0,0 @@
-# Feature Flags Quick Start Guide (Beta)
-
-> **Beta Version:** `3.2.0-beta.1`
-> **Native Mode Only:** This beta release supports iOS and Android native implementations. JavaScript mode (Expo/React Native Web) support coming in future release.
-
-## Installation
-
-Install the beta version:
-
-```bash
-npm install mixpanel-react-native@3.2.0-beta.1
-```
-
-For iOS, update native dependencies:
-
-```bash
-cd ios && pod install
-```
-
-## Basic Setup
-
-### 1. Initialize with Feature Flags Enabled
-
-```javascript
-import { Mixpanel } from 'mixpanel-react-native';
-
-const mixpanel = new Mixpanel('YOUR_TOKEN');
-
-// Enable Feature Flags during initialization
-await mixpanel.init(
-  false,                    // optOutTrackingDefault
-  {},                       // superProperties
-  'https://api.mixpanel.com', // serverURL
-  true,                     // useGzipCompression
-  {
-    enabled: true,          // Enable Feature Flags
-    context: {              // Optional: Add targeting context
-      platform: 'mobile',
-      app_version: '2.1.0'
-    }
-  }
-);
-```
-
-### 2. Check Flag Availability
-
-Before accessing flags, verify they're loaded:
-
-```javascript
-if (mixpanel.flags.areFlagsReady()) {
-  // Flags are ready to use
-  console.log('Feature flags loaded!');
-}
-```
-
-## Using Feature Flags
-
-### Synchronous API (Recommended for UI)
-
-Use sync methods when flags are ready (e.g., in render methods):
-
-```javascript
-// Check if feature is enabled
-const showNewUI = mixpanel.flags.isEnabledSync('new-checkout-flow', false);
-
-// Get variant value directly
-const buttonColor = mixpanel.flags.getVariantValueSync('button-color', 'blue');
-
-// Get full variant object with metadata
-const variant = mixpanel.flags.getVariantSync('pricing-tier', {
-  key: 'control',
-  value: 'standard'
-});
-
-console.log(`Variant: ${variant.key}, Value: ${variant.value}`);
-if (variant.experiment_id) {
-  console.log(`Part of experiment: ${variant.experiment_id}`);
-}
-```
-
-### Asynchronous API (Promise Pattern)
-
-Use async methods for event handlers or initialization:
-
-```javascript
-// Promise pattern
-const variant = await mixpanel.flags.getVariant('checkout-flow', {
-  key: 'control',
-  value: 'standard'
-});
-
-const enabled = await mixpanel.flags.isEnabled('dark-mode', false);
-
-const colorValue = await mixpanel.flags.getVariantValue('theme-color', '#0000FF');
-```
-
-### Asynchronous API (Callback Pattern)
-
-Alternative callback style for compatibility:
-
-```javascript
-// Callback pattern
-mixpanel.flags.getVariant('feature-name', { key: 'control', value: 'off' }, (variant) => {
-  console.log(`Feature variant: ${variant.key}`);
-});
-
-mixpanel.flags.isEnabled('new-feature', false, (isEnabled) => {
-  if (isEnabled) {
-    // Show new feature
-  }
-});
-```
-
-## Real-World Examples
-
-### Example 1: Feature Toggle
-
-```javascript
-const NewCheckoutButton = () => {
-  const [showNewCheckout, setShowNewCheckout] = useState(false);
-
-  useEffect(() => {
-    // Load flags on mount
-    if (mixpanel.flags.areFlagsReady()) {
-      const enabled = mixpanel.flags.isEnabledSync('new-checkout', false);
-      setShowNewCheckout(enabled);
-    }
-  }, []);
-
-  return showNewCheckout ? <NewCheckout /> : <LegacyCheckout />;
-};
-```
-
-### Example 2: A/B Test with Variants
-
-```javascript
-const ProductCard = ({ product }) => {
-  // Get button color variant (A/B test)
-  const buttonColor = mixpanel.flags.areFlagsReady()
-    ? mixpanel.flags.getVariantValueSync('button-color', 'blue')
-    : 'blue';
-
-  // Get pricing display variant
-  const pricingVariant = mixpanel.flags.areFlagsReady()
-    ? mixpanel.flags.getVariantSync('pricing-display', {
-        key: 'control',
-        value: 'standard'
-      })
-    : { key: 'control', value: 'standard' };
-
-  return (
-    <View>
-      <Text>{product.name}</Text>
-      {pricingVariant.value === 'bold' ? (
-        <Text style={styles.boldPrice}>${product.price}</Text>
-      ) : (
-        <Text>${product.price}</Text>
-      )}
-      <Button
-        title="Add to Cart"
-        color={buttonColor}
-        onPress={handleAddToCart}
-      />
-    </View>
-  );
-};
-```
-
-### Example 3: Gradual Rollout with Fallback
-
-```javascript
-const App = () => {
-  const [uiVersion, setUiVersion] = useState('v1');
-
-  useEffect(() => {
-    const loadFlags = async () => {
-      try {
-        // Manually trigger flag load
-        await mixpanel.flags.loadFlags();
-
-        // Check which UI version to show
-        const variant = mixpanel.flags.getVariantSync('ui-redesign', {
-          key: 'control',
-          value: 'v1'
-        });
-
-        setUiVersion(variant.value);
-
-        // Track if user is in experiment
-        if (variant.experiment_id) {
-          console.log(`User in experiment: ${variant.experiment_id}`);
-        }
-      } catch (error) {
-        console.error('Failed to load flags:', error);
-        // Fallback to default
-      }
-    };
-
-    loadFlags();
-  }, []);
-
-  return uiVersion === 'v2' ? <NewUI /> : <LegacyUI />;
-};
-```
-
-### Example 4: Targeting with Context
-
-```javascript
-// Set user context for targeting
-await mixpanel.init(
-  false,
-  {},
-  'https://api.mixpanel.com',
-  true,
-  {
-    enabled: true,
-    context: {
-      user_tier: 'premium',
-      device_type: Platform.OS,
-      app_version: '2.1.0',
-      custom_properties: {
-        beta_tester: true,
-        region: 'US'
-      }
-    }
-  }
-);
-
-// Flags will be evaluated based on context
-const hasAccess = mixpanel.flags.isEnabledSync('premium-feature', false);
-```
-
-## API Reference
-
-### Methods
-
-| Method | Type | Description |
-|--------|------|-------------|
-| `areFlagsReady()` | Sync | Returns `true` if flags are loaded |
-| `loadFlags()` | Async | Manually fetch flags from server |
-| `isEnabledSync(name, fallback)` | Sync | Check if feature is enabled |
-| `isEnabled(name, fallback)` | Async | Async version of isEnabledSync |
-| `getVariantValueSync(name, fallback)` | Sync | Get variant value only |
-| `getVariantValue(name, fallback)` | Async | Async version of getVariantValueSync |
-| `getVariantSync(name, fallback)` | Sync | Get full variant object |
-| `getVariant(name, fallback)` | Async | Async version of getVariantSync |
-
-### Snake Case Aliases
-
-All methods have snake_case aliases for consistency with mixpanel-js:
-
-```javascript
-// These are equivalent
-mixpanel.flags.areFlagsReady()
-mixpanel.flags.are_flags_ready()
-
-mixpanel.flags.getVariantSync('feature', fallback)
-mixpanel.flags.get_variant_sync('feature', fallback)
-```
-
-## Automatic Experiment Tracking
-
-When a user is evaluated for a flag that's part of an A/B test, Mixpanel automatically tracks an `$experiment_started` event. No additional code required!
-
-## Important Notes
-
-### Platform Support
-
-- ✅ **iOS**: Full support via native Swift SDK
-- ✅ **Android**: Full support via native Android SDK
-- ❌ **Expo/React Native Web**: Not supported in this beta (coming soon)
-
-### Fallback Values
-
-Always provide fallback values for graceful degradation:
-
-```javascript
-// Good - provides fallback
-const color = mixpanel.flags.getVariantValueSync('color', 'blue');
-
-// Bad - could return undefined if flag not found
-const color = mixpanel.flags.getVariantValueSync('color');
-```
-
-### Performance
-
-- Flags are lazy-loaded on first access
-- Sync methods are preferred for UI rendering (no async overhead)
-- Check `areFlagsReady()` before using sync methods
-
-### Error Handling
-
-Flags fail gracefully and return fallback values:
-
-```javascript
-try {
-  await mixpanel.flags.loadFlags();
-} catch (error) {
-  console.error('Flag loading failed:', error);
-  // App continues with fallback values
-}
-```
-
-## Troubleshooting
-
-### Flags Not Loading
-
-1. Verify Feature Flags are enabled in your Mixpanel project
-2. Check initialization includes `featureFlagsOptions: { enabled: true }`
-3. Enable logging: `mixpanel.setLoggingEnabled(true)`
-4. Verify network connectivity to Mixpanel API
-
-### Native Module Not Found
-
-This beta requires native modules. If you see "Native module not found":
-
-1. Run `cd ios && pod install` (iOS)
-2. Rebuild the app completely
-3. Verify you're not using Expo Go (use dev client or eject)
-
-### Getting Fallback Values
-
-If flags always return fallbacks:
-
-1. Check `mixpanel.flags.areFlagsReady()` returns `true`
-2. Verify flag names match exactly (case-sensitive)
-3. Confirm flags are published in Mixpanel dashboard
-4. Check context targeting rules
-
-## Feedback & Issues
-
-This is a beta release. Please report issues at:
-https://github.com/mixpanel/mixpanel-react-native/issues
-
-Reference PR #331 for technical details:
-https://github.com/mixpanel/mixpanel-react-native/pull/331
-
-## What's Next
-
-Coming in future releases:
-
-- JavaScript mode support (Expo/React Native Web)
-- Runtime context updates via `updateContext()`
-- Performance optimizations
-
----
-
-**Questions?** Visit [Mixpanel Documentation](https://mixpanel.com) or reach out to support.

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +0,0 @@
-#Tue Jul 09 16:50:09 IST 2019
-distributionBase=GRADLE_USER_HOME
-distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1-all.zip

package/android/gradlew

@@ -1,172 +0,0 @@
-#!/usr/bin/env sh
-
-##############################################################################
-##
-##  Gradle start up script for UN*X
-##
-##############################################################################
-
-# Attempt to set APP_HOME
-# Resolve links: $0 may be a link
-PRG="$0"
-# Need this for relative symlinks.
-while [ -h "$PRG" ] ; do
-    ls=`ls -ld "$PRG"`
-    link=`expr "$ls" : '.*-> \(.*\)$'`
-    if expr "$link" : '/.*' > /dev/null; then
-        PRG="$link"
-    else
-        PRG=`dirname "$PRG"`"/$link"
-    fi
-done
-SAVED="`pwd`"
-cd "`dirname \"$PRG\"`/" >/dev/null
-APP_HOME="`pwd -P`"
-cd "$SAVED" >/dev/null
-
-APP_NAME="Gradle"
-APP_BASE_NAME=`basename "$0"`
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
-
-# Use the maximum available, or set MAX_FD != -1 to use that value.
-MAX_FD="maximum"
-
-warn () {
-    echo "$*"
-}
-
-die () {
-    echo
-    echo "$*"
-    echo
-    exit 1
-}
-
-# OS specific support (must be 'true' or 'false').
-cygwin=false
-msys=false
-darwin=false
-nonstop=false
-case "`uname`" in
-  CYGWIN* )
-    cygwin=true
-    ;;
-  Darwin* )
-    darwin=true
-    ;;
-  MINGW* )
-    msys=true
-    ;;
-  NONSTOP* )
-    nonstop=true
-    ;;
-esac
-
-CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
-
-# Determine the Java command to use to start the JVM.
-if [ -n "$JAVA_HOME" ] ; then
-    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
-        # IBM's JDK on AIX uses strange locations for the executables
-        JAVACMD="$JAVA_HOME/jre/sh/java"
-    else
-        JAVACMD="$JAVA_HOME/bin/java"
-    fi
-    if [ ! -x "$JAVACMD" ] ; then
-        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-    fi
-else
-    JAVACMD="java"
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-fi
-
-# Increase the maximum file descriptors if we can.
-if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
-    MAX_FD_LIMIT=`ulimit -H -n`
-    if [ $? -eq 0 ] ; then
-        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
-            MAX_FD="$MAX_FD_LIMIT"
-        fi
-        ulimit -n $MAX_FD
-        if [ $? -ne 0 ] ; then
-            warn "Could not set maximum file descriptor limit: $MAX_FD"
-        fi
-    else
-        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
-    fi
-fi
-
-# For Darwin, add options to specify how the application appears in the dock
-if $darwin; then
-    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
-fi
-
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
-    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
-    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    JAVACMD=`cygpath --unix "$JAVACMD"`
-
-    # We build the pattern for arguments to be converted via cygpath
-    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
-    SEP=""
-    for dir in $ROOTDIRSRAW ; do
-        ROOTDIRS="$ROOTDIRS$SEP$dir"
-        SEP="|"
-    done
-    OURCYGPATTERN="(^($ROOTDIRS))"
-    # Add a user-defined pattern to the cygpath arguments
-    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
-        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
-    fi
-    # Now convert the arguments - kludge to limit ourselves to /bin/sh
-    i=0
-    for arg in "$@" ; do
-        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
-        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
-
-        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
-            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
-        else
-            eval `echo args$i`="\"$arg\""
-        fi
-        i=$((i+1))
-    done
-    case $i in
-        (0) set -- ;;
-        (1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
-    esac
-fi
-
-# Escape application args
-save () {
-    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
-    echo " "
-}
-APP_ARGS=$(save "$@")
-
-# Collect all arguments for the java command, following the shell quoting and substitution rules
-eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
-
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
-exec "$JAVACMD" "$@"

package/android/gradlew.bat

@@ -1,84 +0,0 @@
-@if "%DEBUG%" == "" @echo off
-@rem ##########################################################################
-@rem
-@rem  Gradle startup script for Windows
-@rem
-@rem ##########################################################################
-
-@rem Set local scope for the variables with windows NT shell
-if "%OS%"=="Windows_NT" setlocal
-
-set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
-set APP_BASE_NAME=%~n0
-set APP_HOME=%DIRNAME%
-
-@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
-
-@rem Find java.exe
-if defined JAVA_HOME goto findJavaFromJavaHome
-
-set JAVA_EXE=java.exe
-%JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
-
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto init
-
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
-:execute
-@rem Setup the command line
-
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
-
-@rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
-
-:end
-@rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega