@hot-updater/react-native/src/runUpdateProcess.ts

React Native OTA solution for self-hosted

import { type CheckForUpdateOptions, checkForUpdate } from "./checkForUpdate";
import { getBundleId, reload } from "./native";

export interface RunUpdateProcessResponse {
  status: "ROLLBACK" | "UPDATE" | "UP_TO_DATE";
  shouldForceUpdate: boolean;
  message: string | null;
  id: string;
}

export interface RunUpdateProcessOptions extends CheckForUpdateOptions {
  /**
   * If `true`, the app will be reloaded when the downloaded bundle is a force update.
   * If `false`, shouldForceUpdate will be returned as true but the app won't reload.
   * @default true
   */
  reloadOnForceUpdate?: boolean;
}

/**
 * Manually checks and applies updates for the application.
 *
 * @param {RunUpdateProcessConfig} config - Update process configuration
 * @param {string} config.source - Update server URL
 * @param {Record<string, string>} [config.requestHeaders] - Request headers
 * @param {boolean} [config.reloadOnForceUpdate=true] - Whether to automatically reload on force update
 *
 * @example
 * ```ts
 * // Auto reload on force update
 * const result = await HotUpdater.runUpdateProcess({
 *   source: "<your-update-server-url>",
 *   requestHeaders: {
 *     // Add necessary headers
 *   },
 *   reloadOnForceUpdate: true
 * });
 *
 * // Manually handle reload on force update
 * const result = await HotUpdater.runUpdateProcess({
 *   source: "<your-update-server-url>",
 *   reloadOnForceUpdate: false
 * });
 *
 * if(result.status !== "UP_TO_DATE" && result.shouldForceUpdate) {
 *   await HotUpdater.reload();
 * }
 * ```
 *
 * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
 */
export const runUpdateProcess = async ({
  reloadOnForceUpdate = true,
  ...checkForUpdateOptions
}: RunUpdateProcessOptions): Promise<RunUpdateProcessResponse> => {
  const updateInfo = await checkForUpdate(checkForUpdateOptions);
  if (!updateInfo) {
    return {
      status: "UP_TO_DATE",
      shouldForceUpdate: false,
      message: null,
      id: getBundleId(),
    };
  }

  const isUpdated = await updateInfo.updateBundle();
  if (isUpdated && updateInfo.shouldForceUpdate && reloadOnForceUpdate) {
    await reload();
  }

  if (!isUpdated) {
    throw new Error("New update was found but failed to download the bundle.");
  }
  return {
    status: updateInfo.status,
    shouldForceUpdate: updateInfo.shouldForceUpdate,
    id: updateInfo.id,
    message: updateInfo.message,
  };
};