Force Update Plugin

A utility to check for app updates in React Native based on a configuration file or object.

Features

• Supports remote config file or local config object.
• Handles app versions as strings (e.g., "1.2.0") or integers (e.g., 10203).
• Returns mandatory, optional, or null to indicate update status.
• Provides a URL for latest version when applicable in the config file.
• Returns the original fetched config object for reference.

Installation

npm install force-update

Usage

1. Using a Remote Config File

import { checkForUpdatesFromUrl } from 'force-update';

const currentVersion = '1.0.0'; // Current app version
const configUrl = 'https://example.com/force_update_config.json'; // Remote config URL

try {
    const result = await checkForUpdatesFromUrl({ currentVersion, configUrl });
    console.log(result);
    // { result: "mandatory" | "optional" | null, url?: "https://example.com/update", config?: "original fetched config object" }
} catch (error) {
    console.error('Error checking updates from URL:', error);
}

2. Using a Local Config Object

a. Using strings for version codes

import { checkForUpdatesFromFile } from 'force-update';

const currentVersion = '1.0.0'; // Current app version
const configObject = {
    latest: '1.2.0', // Latest app version
    minimum: '1.1.0', // Minimum required app version
    url: 'https://example.com/update', // Latest version URL (optional)
};

try {
    const result = checkForUpdatesFromFile({
        currentVersion,
        config: configObject,
    });
    console.log(result);
    // { result: "mandatory" | "optional" | null, url?: "https://example.com/update", config?: "original fetched config object" }
} catch (error) {
    console.error('Error checking updates from file:', error);
}

b. Using integers for version codes

import { checkForUpdatesFromFile } from 'force-update';

const currentVersion = 100; // Current app version
const configObject = {
    latest: 101, // Latest app version
    minimum: 102, // Minimum required app version
    url: 'https://example.com/update', // Latest version URL (optional)
};

try {
    const result = checkForUpdatesFromFile({
        currentVersion,
        config: configObject,
    });
    console.log(result);
    // { result: "mandatory" | "optional" | null, url?: "https://example.com/update", config?: "original fetched config object" }
} catch (error) {
    console.error('Error checking updates from file:', error);
}

Config Format

For remote or local configuration, the format should be as follows:

// The app supports force updates
{
    "latest": "1.2.0",
    "minimum": "1.1.0",
    "url": "https://example.com/update"
}

or

// The app does not support force updates
{
    "latest": "1.2.0",
    "url": "https://example.com/update"
}

or

// The url is optional
{
    "latest": 10203,
    "minimum": 10102
}

Return Values (result)

• mandatory: Update required (current version < minimum).
• optional: Update available (current version < latest).
• null: App is up-to-date.