Features

Installation

npm install react-native-manup

Peer Dependencies

npm install react-native-device-info

Optional Firebase Dependencies

npm install @react-native-firebase/app @react-native-firebase/remote-config

Usage

Remote Config Provider

HTTP Configuration Example

importReactfrom'react';import{Alert}from'react-native';import{RemoteConfigProvider,useRemoteConfigManUp}from'react-native-manup';functionApp(){return(<RemoteConfigProviderfetchConfig={async()=>{constresponse=awaitfetch('https://your-api.com/config.json',{cache:'no-store'});if(!response.ok){thrownewError(`HTTP error! status:${response.status}`);}returnresponse.json();}}refetchInterval={3600000}// 1 hour (optional)queryKey="httpConfig"// optional><HomeScreen/></RemoteConfigProvider>);}functionHomeScreen(){const{ status, message}=useRemoteConfigManUp({const onUpdateAvailable=()=>{// - Display update available modal// - Modal can be dismissed};constonUpdateRequired=()=>{// - Display update required modal// - Modal shouldn't be dismissible as user is required to update the app};constonMaintenanceMode=()=>{// - Display maintenance mode modal// - Modal shouldn't be dismissible as the app is in maintenance mode};});return(// Your app content);}

Firebase Remote Config Example

importReactfrom'react';import{Alert}from'react-native';import{RemoteConfigProvider,useRemoteConfigManUp}from'react-native-manup';importremoteConfigfrom'@react-native-firebase/remote-config';functionApp(){return(<RemoteConfigProviderfetchConfig={async()=>{awaitremoteConfig().fetchAndActivate();returnJSON.parse(remoteConfig().getValue('appConfig').asString());}}queryKey="firebaseConfig"><HomeScreen/></RemoteConfigProvider>);}functionHomeScreen(){const{ status, message}=useRemoteConfigManUp({const onUpdateAvailable=()=>{// - Display update available modal// - Modal can be dismissed};constonUpdateRequired=()=>{// - Display update required modal// - Modal shouldn't be dismissible as user is required to update the app};constonMaintenanceMode=()=>{// - Display maintenance mode modal// - Modal shouldn't be dismissible as the app is in maintenance mode};});return(// Your app content);}

Configuration

interfaceConfig{[key:string]:PlatFormData;}interfacePlatFormData{latest:string;// Latest available versionminimum:string;// Minimum supported versionurl:string;// Download URL for the appenabled:boolean;// Whether the app is enabled}

Example Configuration

{"ios": {"latest":"1.2.0","minimum":"1.0.0","url":"https://apps.apple.com/app/yourapp","enabled":true,// Custom platform-specific property - can be any additional data you need"publicApiUrl":"https://api.ios-example.com/v1"  },"android": {"latest":"1.2.0","minimum":"1.0.0","url":"https://play.google.com/store/apps/details?id=com.yourapp","enabled":true,// Custom platform-specific property - can be any additional data you need"publicApiUrl":"https://api.android-example.com/v1"  },// Custom global property - shared across all platforms"publicApiUrl":"https://api.example.com/v1"}

License