@hot-updater/react-native 0.30.12 → 0.31.1

package/src/wrap.tsx

@@ -9,7 +9,7 @@ import {
   notifyAppReady as nativeNotifyAppReady,
   reload,
 } from "./native";
-import { useHotUpdaterStore } from "./store";
+import { type HotUpdaterState, useHotUpdaterStore } from "./store";
 import type { HotUpdaterBaseURL, HotUpdaterResolver } from "./types";
 
 export interface RunUpdateProcessResponse {
@@ -24,8 +24,18 @@ type UpdateStatus =
   | "UPDATING"
   | "UPDATE_PROCESS_COMPLETED";
 
+export type HotUpdaterFallbackComponentProps = {
+  status: Exclude<UpdateStatus, "UPDATE_PROCESS_COMPLETED">;
+  progress: number;
+  downloadedBytes: HotUpdaterState["downloadedBytes"];
+  totalBytes: HotUpdaterState["totalBytes"];
+  message: string | null;
+  artifactType: HotUpdaterState["artifactType"];
+  details: HotUpdaterState["details"];
+};
+
 /**
- * Common options shared between auto and manual update modes
+ * Common options shared by HotUpdater initialization APIs.
  */
 interface CommonHotUpdaterOptions {
   /**
@@ -51,18 +61,24 @@ interface CommonHotUpdaterOptions {
    *
    * @example
    * ```tsx
-   * HotUpdater.wrap({
+   * HotUpdater.init({
    *   baseURL: "https://api.example.com",
-   *   updateMode: "manual",
    *   onNotifyAppReady: ({ status, crashedBundleId }) => {
    *     if (status === "RECOVERED") {
    *       analytics.track("bundle_rollback", { crashedBundleId });
    *     }
-   *   }
-   * })(App);
+   *   },
+   * });
    * ```
    */
   onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
+
+  /**
+   * Default callback invoked when Hot Updater initialization or update checks
+   * fail. Per-call `HotUpdater.checkForUpdate({ onError })` handlers override
+   * this callback for that check.
+   */
+  onError?: (error: HotUpdaterError | Error | unknown) => void;
 }
 
 /**
@@ -105,6 +121,11 @@ type NetworkConfig = BaseURLConfig | ResolverConfig;
 
 export type AutoUpdateOptions = CommonHotUpdaterOptions &
   NetworkConfig & {
+    /**
+     * Automatic update mode. This is the default and can be omitted.
+     */
+    updateMode?: "auto";
+
     /**
      * Update strategy
      * - "fingerprint": Use fingerprint hash to check for updates
@@ -112,14 +133,6 @@ export type AutoUpdateOptions = CommonHotUpdaterOptions &
      */
     updateStrategy: "fingerprint" | "appVersion";
 
-    /**
-     * Update mode
-     * - "auto": Automatically check and download updates
-     */
-    updateMode: "auto";
-
-    onError?: (error: HotUpdaterError | Error | unknown) => void;
-
     /**
      * Component to show while downloading a new bundle update.
      *
@@ -142,11 +155,7 @@ export type AutoUpdateOptions = CommonHotUpdaterOptions &
      *
      * If not defined, the bundle will download in the background without blocking the screen.
      */
-    fallbackComponent?: React.FC<{
-      status: Exclude<UpdateStatus, "UPDATE_PROCESS_COMPLETED">;
-      progress: number;
-      message: string | null;
-    }>;
+    fallbackComponent?: React.FC<HotUpdaterFallbackComponentProps>;
 
     onProgress?: (progress: number) => void;
 
@@ -169,21 +178,25 @@ export type AutoUpdateOptions = CommonHotUpdaterOptions &
 export type ManualUpdateOptions = CommonHotUpdaterOptions &
   NetworkConfig & {
     /**
-     * Update mode
-     * - "manual": Only notify app ready, user manually calls checkForUpdate()
+     * @deprecated Replace manual `HotUpdater.wrap` with `HotUpdater.init`.
+     *
+     * ```tsx
+     * import { HotUpdater } from "@hot-updater/react-native";
+     *
+     * HotUpdater.init({
+     *   baseURL: "<your-update-server-url>",
+     * });
+     *
+     * export default App;
+     * ```
+     *
+     * Then call `HotUpdater.checkForUpdate(...)` from your manual update flow.
+     * See https://hot-updater.dev/docs/guides/custom-update
      */
     updateMode: "manual";
   };
 
-type ManualBaseURLUpdateOptions = CommonHotUpdaterOptions &
-  BaseURLConfig & {
-    updateMode: "manual";
-  };
-
-export type HotUpdaterInitOptions = Omit<
-  ManualBaseURLUpdateOptions,
-  "updateMode"
->;
+export type HotUpdaterInitOptions = CommonHotUpdaterOptions & NetworkConfig;
 
 export type HotUpdaterOptions = AutoUpdateOptions | ManualUpdateOptions;
 
@@ -196,17 +209,13 @@ type InternalCommonOptions = {
   requestHeaders?: Record<string, string>;
   requestTimeout?: number;
   onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
+  onError?: (error: HotUpdaterError | Error | unknown) => void;
 };
 
 type InternalAutoUpdateOptions = InternalCommonOptions & {
   updateStrategy: "fingerprint" | "appVersion";
   updateMode: "auto";
-  onError?: (error: HotUpdaterError | Error | unknown) => void;
-  fallbackComponent?: React.FC<{
-    status: Exclude<UpdateStatus, "UPDATE_PROCESS_COMPLETED">;
-    progress: number;
-    message: string | null;
-  }>;
+  fallbackComponent?: React.FC<HotUpdaterFallbackComponentProps>;
   onProgress?: (progress: number) => void;
   reloadOnForceUpdate?: boolean;
   onUpdateProcessCompleted?: (response: RunUpdateProcessResponse) => void;
@@ -224,6 +233,23 @@ export type InternalWrapOptions =
 
 type RequestAnimationFrame = (callback: (timestamp: number) => void) => number;
 
+let didWarnManualWrapDeprecation = false;
+
+const warnManualWrapDeprecation = () => {
+  if (didWarnManualWrapDeprecation) {
+    return;
+  }
+
+  didWarnManualWrapDeprecation = true;
+  console.warn(
+    '[HotUpdater] HotUpdater.wrap({ updateMode: "manual" }) is deprecated. ' +
+      "Move the same baseURL/resolver options to HotUpdater.init({ ... }), " +
+      "export your root component directly, and call " +
+      "HotUpdater.checkForUpdate(...) from your manual update flow. " +
+      "See https://hot-updater.dev/docs/guides/custom-update",
+  );
+};
+
 const waitForNextFrame = () =>
   new Promise<void>((resolve) => {
     const requestAnimationFrame = (
@@ -248,6 +274,7 @@ const handleNotifyAppReady = async (options: {
   requestHeaders?: Record<string, string>;
   requestTimeout?: number;
   onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
+  onError?: (error: HotUpdaterError | Error | unknown) => void;
 }): Promise<void> => {
   await waitForNextFrame();
 
@@ -264,12 +291,14 @@ const handleNotifyAppReady = async (options: {
           requestTimeout: options.requestTimeout,
         })
         .catch((e: unknown) => {
+          options.onError?.(e);
           console.warn("[HotUpdater] Resolver notifyAppReady failed:", e);
         });
     }
 
     options.onNotifyAppReady?.(nativeResult);
   } catch (e) {
+    options.onError?.(e);
     console.warn("[HotUpdater] Failed to notify app ready:", e);
   }
 };
@@ -278,11 +307,15 @@ export function init(options: InternalInitOptions): void {
   void handleNotifyAppReady(options);
 }
 
-export function wrap<P extends React.JSX.IntrinsicAttributes = object>(
+export function wrap(
   options: InternalWrapOptions,
-): (WrappedComponent: React.ComponentType<P>) => React.ComponentType<P> {
+): <P extends object>(
+  WrappedComponent: React.ComponentType<P>,
+) => React.ComponentType<P> {
   if (options.updateMode === "manual") {
-    return (WrappedComponent: React.ComponentType<P>) => {
+    warnManualWrapDeprecation();
+
+    return <P extends object>(WrappedComponent: React.ComponentType<P>) => {
       const ManualHOC: React.FC<P> = (props: P) => {
         useEffect(() => {
           void handleNotifyAppReady(options);
@@ -295,12 +328,12 @@ export function wrap<P extends React.JSX.IntrinsicAttributes = object>(
     };
   }
 
-  // updateMode: "auto"
   const { reloadOnForceUpdate = true, ...restOptions } = options;
 
-  return (WrappedComponent: React.ComponentType<P>) => {
+  return <P extends object>(WrappedComponent: React.ComponentType<P>) => {
     const HotUpdaterHOC: React.FC<P> = (props: P) => {
-      const progress = useHotUpdaterStore((state) => state.progress);
+      const progressState = useHotUpdaterStore((state) => state);
+      const progress = progressState.progress;
 
       const [message, setMessage] = useState<string | null>(null);
       const [updateStatus, setUpdateStatus] =
@@ -394,9 +427,13 @@ export function wrap<P extends React.JSX.IntrinsicAttributes = object>(
         const Fallback = restOptions.fallbackComponent;
         return (
           <Fallback
+            artifactType={progressState.artifactType}
+            details={progressState.details}
+            downloadedBytes={progressState.downloadedBytes}
             progress={progress}
             status={updateStatus}
             message={message}
+            totalBytes={progressState.totalBytes}
           />
         );
       }