@hot-updater/react-native 0.17.0 → 0.18.1

package/src/checkForUpdate.ts

@@ -1,11 +1,14 @@
+import type { AppUpdateInfo, GetBundlesArgs } from "@hot-updater/core";
 import { Platform } from "react-native";
 import { HotUpdaterError } from "./error";
 import { type UpdateSource, fetchUpdateInfo } from "./fetchUpdateInfo";
 import {
+  HotUpdaterConstants,
   getAppVersion,
   getBundleId,
   getChannel,
   getMinBundleId,
+  updateBundle,
 } from "./native";
 
 export interface CheckForUpdateOptions {
@@ -19,7 +22,17 @@ export interface CheckForUpdateOptions {
   requestTimeout?: number;
 }
 
-export async function checkForUpdate(options: CheckForUpdateOptions) {
+export type CheckForUpdateResult = AppUpdateInfo & {
+  /**
+   * Updates the bundle.
+   * This method is equivalent to `HotUpdater.updateBundle()` but with all required arguments pre-filled.
+   */
+  updateBundle: () => Promise<boolean>;
+};
+
+export async function checkForUpdate(
+  options: CheckForUpdateOptions,
+): Promise<CheckForUpdateResult | null> {
   if (__DEV__) {
     return null;
   }
@@ -42,17 +55,54 @@ export async function checkForUpdate(options: CheckForUpdateOptions) {
     return null;
   }
 
+  const baseArgs = {
+    bundleId: currentBundleId,
+    platform,
+    minBundleId,
+    channel: channel ?? undefined,
+  };
+
   return fetchUpdateInfo(
     options.source,
-    {
-      appVersion: currentAppVersion,
-      bundleId: currentBundleId,
-      platform,
-      minBundleId,
-      channel: channel ?? undefined,
-    },
+    HotUpdaterConstants.UPDATE_STRATEGY === "appVersion"
+      ? {
+          _updateStrategy: HotUpdaterConstants.UPDATE_STRATEGY,
+          appVersion: currentAppVersion,
+          ...baseArgs,
+        }
+      : {
+          _updateStrategy: HotUpdaterConstants.UPDATE_STRATEGY,
+          fingerprintHash: HotUpdaterConstants.FINGERPRINT_HASH!,
+          ...baseArgs,
+        },
     options.requestHeaders,
     options.onError,
     options.requestTimeout,
-  );
+  ).then((updateInfo) => {
+    if (!updateInfo) {
+      return null;
+    }
+
+    return {
+      ...updateInfo,
+      updateBundle: async () => {
+        return updateBundle({
+          bundleId: updateInfo.id,
+          fileUrl: updateInfo.fileUrl,
+          status: updateInfo.status,
+        });
+      },
+    };
+  });
 }
+
+export const getUpdateSource = (baseUrl: string) => (args: GetBundlesArgs) => {
+  switch (args._updateStrategy) {
+    case "appVersion":
+      return `${baseUrl}/app-version/${args.platform}/${args.appVersion}/${args.channel}/${args.minBundleId}/${args.bundleId}`;
+    case "fingerprint":
+      return `${baseUrl}/fingerprint/${args.platform}/${args.fingerprintHash}/${args.channel}/${args.minBundleId}/${args.bundleId}`;
+    default:
+      return baseUrl;
+  }
+};

package/src/fetchUpdateInfo.ts

@@ -1,16 +1,23 @@
 import type { AppUpdateInfo, GetBundlesArgs } from "@hot-updater/core";
 
-export type UpdateSource = string | (() => Promise<AppUpdateInfo | null>);
+export type UpdateSource =
+  | string
+  | ((args: GetBundlesArgs) => Promise<AppUpdateInfo | null>)
+  | ((args: GetBundlesArgs) => string);
 
 export const fetchUpdateInfo = async (
   source: UpdateSource,
-  { appVersion, bundleId, platform, minBundleId, channel }: GetBundlesArgs,
+  args: GetBundlesArgs,
   requestHeaders?: Record<string, string>,
   onError?: (error: Error) => void,
   requestTimeout = 5000,
 ): Promise<AppUpdateInfo | null> => {
   if (typeof source === "function") {
-    return source();
+    const url = source(args);
+    if (typeof url !== "string") {
+      return null;
+    }
+    source = url;
   }
 
   const controller = new AbortController();
@@ -19,17 +26,38 @@ export const fetchUpdateInfo = async (
   }, requestTimeout);
 
   try {
+    let headers: Record<string, string> = {};
+
+    switch (args._updateStrategy) {
+      case "fingerprint":
+        headers = {
+          "Content-Type": "application/json",
+          "x-app-platform": args.platform,
+          "x-bundle-id": args.bundleId,
+          "x-fingerprint-hash": args.fingerprintHash,
+          ...(args.minBundleId ? { "x-min-bundle-id": args.minBundleId } : {}),
+          ...(args.channel ? { "x-channel": args.channel } : {}),
+          ...requestHeaders,
+        };
+        break;
+      case "appVersion":
+        headers = {
+          "Content-Type": "application/json",
+          "x-app-platform": args.platform,
+          "x-bundle-id": args.bundleId,
+          "x-app-version": args.appVersion,
+          ...(args.minBundleId ? { "x-min-bundle-id": args.minBundleId } : {}),
+          ...(args.channel ? { "x-channel": args.channel } : {}),
+          ...requestHeaders,
+        };
+        break;
+      default:
+        throw new Error("Invalid update strategy");
+    }
+
     const response = await fetch(source, {
       signal: controller.signal,
-      headers: {
-        "Content-Type": "application/json",
-        "x-app-platform": platform,
-        "x-app-version": appVersion,
-        "x-bundle-id": bundleId,
-        ...(minBundleId ? { "x-min-bundle-id": minBundleId } : {}),
-        ...(channel ? { "x-channel": channel } : {}),
-        ...requestHeaders,
-      },
+      headers,
     });
 
     clearTimeout(timeoutId);

package/src/index.ts

@@ -4,9 +4,10 @@ import {
   getAppVersion,
   getBundleId,
   getChannel,
+  getFingerprintHash,
   getMinBundleId,
+  getReleaseChannel,
   reload,
-  setChannel,
   updateBundle,
 } from "./native";
 import { runUpdateProcess } from "./runUpdateProcess";
@@ -65,13 +66,12 @@ export const HotUpdater = {
    */
   getMinBundleId,
   /**
-   * Fetches the current release channel of the app.
+   * Fetches the current channel of the app.
    *
-   * By default, if no channel is specified, the app is assigned to the 'production' channel.
-   * If the app is running in development mode, the channel will be `null`.
-   *
-   * @returns {string | null} The current release channel of the app
+   * If no channel is specified, the app is assigned to the 'production' channel.
    *
+   * @returns {string} The current release channel of the app
+   * @default "production"
    * @example
    * ```ts
    * const channel = HotUpdater.getChannel();
@@ -80,9 +80,17 @@ export const HotUpdater = {
    */
   getChannel,
   /**
-   * Sets the channel for the app.
+   * The initial channel of the native app.
+   *
+   * @returns {string} The current release channel of the app
+   * @default "production"
+   * @example
+   * ```ts
+   * const channel = HotUpdater.getReleaseChannel();
+   * console.log(`Current release channel: ${channel}`);
+   * ```
    */
-  setChannel,
+  getReleaseChannel,
   /**
    * Adds a listener to HotUpdater events.
    *
@@ -167,8 +175,9 @@ export const HotUpdater = {
   /**
    * Updates the bundle of the app.
    *
-   * @param {string} bundleId - The bundle ID of the app
-   * @param {string} zipUrl - The URL of the zip file
+   * @param {UpdateBundleParams} params - Parameters object required for bundle update
+   * @param {string} params.bundleId - The bundle ID of the app
+   * @param {string|null} params.fileUrl - The URL of the zip file
    *
    * @returns {Promise<boolean>} Whether the update was successful
    *
@@ -187,11 +196,28 @@ export const HotUpdater = {
    *   };
    * }
    *
-   * await HotUpdater.updateBundle(updateInfo.id, updateInfo.fileUrl);
+   * await HotUpdater.updateBundle({
+   *   bundleId: updateInfo.id,
+   *   fileUrl: updateInfo.fileUrl
+   * });
    * if (updateInfo.shouldForceUpdate) {
    *   HotUpdater.reload();
    * }
    * ```
    */
   updateBundle,
+  /**
+   * Fetches the fingerprint of the app.
+   *
+   * @returns {string} The fingerprint of the app
+   *
+   * @example
+   * ```ts
+   * const fingerprint = HotUpdater.getFingerprintHash();
+   * console.log(`Fingerprint: ${fingerprint}`);
+   * ```
+   */
+  getFingerprintHash,
 };
+
+export { getUpdateSource } from "./checkForUpdate";

package/src/native.ts

@@ -1,37 +1,28 @@
+import type { UpdateStatus, UpdateStrategy } from "@hot-updater/core";
 import { NativeEventEmitter, Platform } from "react-native";
-import type { Spec } from "./specs/NativeHotUpdater";
+import HotUpdaterNative, {
+  type UpdateBundleParams,
+} from "./specs/NativeHotUpdater";
+
 const NIL_UUID = "00000000-0000-0000-0000-000000000000";
 
 declare const __HOT_UPDATER_BUNDLE_ID: string | undefined;
-declare const __HOT_UPDATER_CHANNEL: string | undefined;
+declare const __HOT_UPDATER_FINGERPRINT_HASH_IOS: string | null;
+declare const __HOT_UPDATER_FINGERPRINT_HASH_ANDROID: string | null;
+declare const __HOT_UPDATER_UPDATE_STRATEGY: UpdateStrategy;
+declare const __HOT_UPDATER_CHANNEL: string | null;
 
-const HotUpdater = {
+export const HotUpdaterConstants = {
+  OVER_THE_AIR_CHANNEL: __HOT_UPDATER_CHANNEL,
   HOT_UPDATER_BUNDLE_ID: __HOT_UPDATER_BUNDLE_ID || NIL_UUID,
-  CHANNEL: __HOT_UPDATER_CHANNEL || (!__DEV__ ? "production" : null),
+  FINGERPRINT_HASH: Platform.select({
+    ios: __HOT_UPDATER_FINGERPRINT_HASH_IOS,
+    android: __HOT_UPDATER_FINGERPRINT_HASH_ANDROID,
+    default: null,
+  }),
+  UPDATE_STRATEGY: __HOT_UPDATER_UPDATE_STRATEGY,
 };
 
-const RCTNativeHotUpdater = require("./specs/NativeHotUpdater").default;
-
-const LINKING_ERROR =
-  // biome-ignore lint/style/useTemplate: <explanation>
-  `The package '@hot-updater/react-native' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: "" }) +
-  "- You rebuilt the app after installing the package\n" +
-  "- You are not using Expo Go\n";
-
-const HotUpdaterNative = (
-  RCTNativeHotUpdater
-    ? RCTNativeHotUpdater
-    : new Proxy(
-        {},
-        {
-          get() {
-            throw new Error(LINKING_ERROR);
-          },
-        },
-      )
-) as Spec;
-
 export type HotUpdaterEvent = {
   onProgress: {
     progress: number;
@@ -50,19 +41,59 @@ export const addListener = <T extends keyof HotUpdaterEvent>(
   };
 };
 
+export type UpdateParams = UpdateBundleParams & {
+  status: UpdateStatus;
+};
+
 /**
- * Downloads files from given URLs.
+ * Downloads files and applies them to the app.
  *
- * @param {string} bundleId - identifier for the bundle id.
- * @param {string | null} zipUrl - zip file URL. If null, it means rolling back to the built-in bundle
+ * @param {UpdateParams} params - Parameters object required for bundle update
  * @returns {Promise<boolean>} Resolves with true if download was successful, otherwise rejects with an error.
  */
-export const updateBundle = (
+export async function updateBundle(params: UpdateParams): Promise<boolean>;
+/**
+ * @deprecated Use updateBundle(params: UpdateBundleParamsWithStatus) instead
+ */
+export async function updateBundle(
   bundleId: string,
-  zipUrl: string | null,
-): Promise<boolean> => {
-  return HotUpdaterNative.updateBundle(bundleId, zipUrl);
-};
+  fileUrl: string | null,
+): Promise<boolean>;
+export async function updateBundle(
+  paramsOrBundleId: UpdateParams | string,
+  fileUrl?: string | null,
+): Promise<boolean> {
+  const updateBundleId =
+    typeof paramsOrBundleId === "string"
+      ? paramsOrBundleId
+      : paramsOrBundleId.bundleId;
+
+  const status =
+    typeof paramsOrBundleId === "string" ? "UPDATE" : paramsOrBundleId.status;
+
+  const currentBundleId = getBundleId();
+
+  // updateBundleId <= currentBundleId
+  if (
+    status === "UPDATE" &&
+    updateBundleId.localeCompare(currentBundleId) <= 0
+  ) {
+    throw new Error(
+      "Update bundle id is the same as the current bundle id. Preventing infinite update loop.",
+    );
+  }
+
+  if (typeof paramsOrBundleId === "string") {
+    return HotUpdaterNative.updateBundle({
+      bundleId: updateBundleId,
+      fileUrl: fileUrl || null,
+    });
+  }
+  return HotUpdaterNative.updateBundle({
+    bundleId: updateBundleId,
+    fileUrl: paramsOrBundleId.fileUrl,
+  });
+}
 
 /**
  * Fetches the current app version.
@@ -99,19 +130,34 @@ export const getMinBundleId = (): string => {
  * @returns {Promise<string>} Resolves with the current version id or null if not available.
  */
 export const getBundleId = (): string => {
-  return HotUpdater.HOT_UPDATER_BUNDLE_ID === NIL_UUID
+  return HotUpdaterConstants.HOT_UPDATER_BUNDLE_ID === NIL_UUID
     ? getMinBundleId()
-    : HotUpdater.HOT_UPDATER_BUNDLE_ID;
+    : HotUpdaterConstants.HOT_UPDATER_BUNDLE_ID;
 };
 
 /**
- * Sets the channel for the app.
+ * Fetches the channel for the app.
+ *
+ * @returns {string} Resolves with the channel or null if not available.
  */
-export const setChannel = async (channel: string) => {
-  return HotUpdaterNative.setChannel(channel);
+export const getChannel = (): string => {
+  if (HotUpdaterConstants.OVER_THE_AIR_CHANNEL) {
+    return HotUpdaterConstants.OVER_THE_AIR_CHANNEL;
+  }
+  const constants = HotUpdaterNative.getConstants();
+  return constants.CHANNEL;
 };
 
-export const getChannel = (): string | null => {
+export const getReleaseChannel = (): string => {
   const constants = HotUpdaterNative.getConstants();
-  return constants?.CHANNEL ?? HotUpdater.CHANNEL ?? null;
+  return constants.CHANNEL;
+};
+
+/**
+ * Fetches the fingerprint for the app.
+ *
+ * @returns {string | null} Resolves with the fingerprint hash
+ */
+export const getFingerprintHash = (): string | null => {
+  return HotUpdaterConstants.FINGERPRINT_HASH;
 };

package/src/runUpdateProcess.ts

@@ -1,5 +1,5 @@
 import { type CheckForUpdateOptions, checkForUpdate } from "./checkForUpdate";
-import { getBundleId, reload, updateBundle } from "./native";
+import { getBundleId, reload } from "./native";
 
 export interface RunUpdateProcessResponse {
   status: "ROLLBACK" | "UPDATE" | "UP_TO_DATE";
@@ -63,7 +63,7 @@ export const runUpdateProcess = async ({
     };
   }
 
-  const isUpdated = await updateBundle(updateInfo.id, updateInfo.fileUrl);
+  const isUpdated = await updateInfo.updateBundle();
   if (isUpdated && updateInfo.shouldForceUpdate && reloadOnForceUpdate) {
     reload();
   }

package/src/specs/NativeHotUpdater.ts

@@ -1,17 +1,15 @@
 import type { TurboModule } from "react-native";
 import { TurboModuleRegistry } from "react-native";
 
+export interface UpdateBundleParams {
+  bundleId: string;
+  fileUrl: string | null;
+}
+
 export interface Spec extends TurboModule {
   // Methods
   reload(): void;
-  updateBundle(bundleId: string, zipUrl: string | null): Promise<boolean>;
-  /**
-   * @deprecated
-   * use getConstants().APP_VERSION instead
-   */
-  getAppVersion(): Promise<string | null>;
-
-  setChannel(channel: string): Promise<void>;
+  updateBundle(params: UpdateBundleParams): Promise<boolean>;
 
   // EventEmitter
   addListener(eventName: string): void;
@@ -19,8 +17,8 @@ export interface Spec extends TurboModule {
   readonly getConstants: () => {
     MIN_BUNDLE_ID: string;
     APP_VERSION: string | null;
-    CHANNEL: string | null;
+    CHANNEL: string;
   };
 }
 
-export default TurboModuleRegistry.get<Spec>("HotUpdater");
+export default TurboModuleRegistry.getEnforcing<Spec>("HotUpdater");

package/src/wrap.tsx

@@ -1,9 +1,9 @@
 import React from "react";
 import { useEffect, useLayoutEffect, useState } from "react";
 import { type CheckForUpdateOptions, checkForUpdate } from "./checkForUpdate";
-import { HotUpdaterError } from "./error";
+import type { HotUpdaterError } from "./error";
 import { useEventCallback } from "./hooks/useEventCallback";
-import { getBundleId, reload, updateBundle } from "./native";
+import { getBundleId, reload } from "./native";
 import type { RunUpdateProcessResponse } from "./runUpdateProcess";
 import { useHotUpdaterStore } from "./store";
 
@@ -39,7 +39,7 @@ export interface HotUpdaterOptions extends CheckForUpdateOptions {
     progress: number;
     message: string | null;
   }>;
-  onError?: (error: HotUpdaterError) => void;
+  onError?: (error: HotUpdaterError | Error | unknown) => void;
   onProgress?: (progress: number) => void;
   /**
    * When a force update exists, the app will automatically reload.
@@ -93,7 +93,10 @@ export function wrap<P extends React.JSX.IntrinsicAttributes = object>(
           }
 
           if (updateInfo.shouldForceUpdate === false) {
-            void updateBundle(updateInfo.id, updateInfo.fileUrl);
+            void updateInfo.updateBundle().catch((error) => {
+              restOptions.onError?.(error);
+            });
+
             restOptions.onUpdateProcessCompleted?.({
               id: updateInfo.id,
               status: updateInfo.status,
@@ -103,13 +106,9 @@ export function wrap<P extends React.JSX.IntrinsicAttributes = object>(
             setUpdateStatus("UPDATE_PROCESS_COMPLETED");
             return;
           }
-
           // Force Update Scenario
           setUpdateStatus("UPDATING");
-          const isSuccess = await updateBundle(
-            updateInfo.id,
-            updateInfo.fileUrl,
-          );
+          const isSuccess = await updateInfo.updateBundle();
 
           if (!isSuccess) {
             throw new Error(
@@ -130,11 +129,8 @@ export function wrap<P extends React.JSX.IntrinsicAttributes = object>(
 
           setUpdateStatus("UPDATE_PROCESS_COMPLETED");
         } catch (error) {
-          if (error instanceof HotUpdaterError) {
-            restOptions.onError?.(error);
-          }
+          restOptions.onError?.(error);
           setUpdateStatus("UPDATE_PROCESS_COMPLETED");
-          throw error;
         }
       });
 

package/android/generated/java/com/hotupdater/NativeHotUpdaterSpec.java

@@ -1,93 +0,0 @@
-
-/**
- * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
- *
- * Do not edit this file as changes may cause incorrect behavior and will be lost
- * once the code is regenerated.
- *
- * @generated by codegen project: GenerateModuleJavaSpec.js
- *
- * @nolint
- */
-
-package com.hotupdater;
-
-import com.facebook.proguard.annotations.DoNotStrip;
-import com.facebook.react.bridge.Promise;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
-import com.facebook.react.bridge.ReactMethod;
-import com.facebook.react.common.build.ReactBuildConfig;
-import com.facebook.react.turbomodule.core.interfaces.TurboModule;
-import java.util.Arrays;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Set;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
-
-public abstract class NativeHotUpdaterSpec extends ReactContextBaseJavaModule implements TurboModule {
-  public static final String NAME = "HotUpdater";
-
-  public NativeHotUpdaterSpec(ReactApplicationContext reactContext) {
-    super(reactContext);
-  }
-
-  @Override
-  public @Nonnull String getName() {
-    return NAME;
-  }
-
-  @ReactMethod
-  @DoNotStrip
-  public abstract void reload();
-
-  @ReactMethod
-  @DoNotStrip
-  public abstract void updateBundle(String bundleId, @Nullable String zipUrl, Promise promise);
-
-  @ReactMethod
-  @DoNotStrip
-  public abstract void getAppVersion(Promise promise);
-
-  @ReactMethod
-  @DoNotStrip
-  public abstract void setChannel(String channel, Promise promise);
-
-  @ReactMethod
-  @DoNotStrip
-  public abstract void addListener(String eventName);
-
-  @ReactMethod
-  @DoNotStrip
-  public abstract void removeListeners(double count);
-
-  protected abstract Map<String, Object> getTypedExportedConstants();
-
-  @Override
-  @DoNotStrip
-  public final @Nullable Map<String, Object> getConstants() {
-    Map<String, Object> constants = getTypedExportedConstants();
-    if (ReactBuildConfig.DEBUG || ReactBuildConfig.IS_INTERNAL_BUILD) {
-      Set<String> obligatoryFlowConstants = new HashSet<>(Arrays.asList(
-          "MIN_BUNDLE_ID"
-      ));
-      Set<String> optionalFlowConstants = new HashSet<>(Arrays.asList(
-          "APP_VERSION",
-          "CHANNEL"
-      ));
-      Set<String> undeclaredConstants = new HashSet<>(constants.keySet());
-      undeclaredConstants.removeAll(obligatoryFlowConstants);
-      undeclaredConstants.removeAll(optionalFlowConstants);
-      if (!undeclaredConstants.isEmpty()) {
-        throw new IllegalStateException(String.format("Native Module Flow doesn't declare constants: %s", undeclaredConstants));
-      }
-      undeclaredConstants = obligatoryFlowConstants;
-      undeclaredConstants.removeAll(constants.keySet());
-      if (!undeclaredConstants.isEmpty()) {
-        throw new IllegalStateException(String.format("Native Module doesn't fill in constants: %s", undeclaredConstants));
-      }
-    }
-    return constants;
-  }
-}

package/android/generated/jni/CMakeLists.txt

@@ -1,36 +0,0 @@
-# Copyright (c) Meta Platforms, Inc. and affiliates.
-#
-# This source code is licensed under the MIT license found in the
-# LICENSE file in the root directory of this source tree.
-
-cmake_minimum_required(VERSION 3.13)
-set(CMAKE_VERBOSE_MAKEFILE on)
-
-file(GLOB react_codegen_SRCS CONFIGURE_DEPENDS *.cpp react/renderer/components/HotUpdaterSpec/*.cpp)
-
-add_library(
-  react_codegen_HotUpdaterSpec
-  OBJECT
-  ${react_codegen_SRCS}
-)
-
-target_include_directories(react_codegen_HotUpdaterSpec PUBLIC . react/renderer/components/HotUpdaterSpec)
-
-target_link_libraries(
-  react_codegen_HotUpdaterSpec
-  fbjni
-  jsi
-  # We need to link different libraries based on whether we are building rncore or not, that's necessary
-  # because we want to break a circular dependency between react_codegen_rncore and reactnative
-  reactnative
-)
-
-target_compile_options(
-  react_codegen_HotUpdaterSpec
-  PRIVATE
-  -DLOG_TAG=\"ReactNative\"
-  -fexceptions
-  -frtti
-  -std=c++20
-  -Wall
-)