@hot-updater/react-native 1.0.0-rc.40 → 1.0.0-rc.42

package/src/init.types.ts

@@ -0,0 +1,24 @@
+import type { HotUpdaterClientPlugin } from "./clientPlugin";
+import type { HotUpdaterError } from "./error";
+import type { NotifyAppReadyResult } from "./native";
+import type { HotUpdaterBaseURL } from "./types";
+
+export interface HotUpdaterInitOptions<
+  TPlugins extends readonly HotUpdaterClientPlugin[] =
+    readonly HotUpdaterClientPlugin[],
+> {
+  /**
+   * Client plugins, such as `insights()` and `remoteConfig()` from
+   * `@hot-updater/react-native`. Each plugin's `setup` runs once for the
+   * instance `init` returns; its hooks observe that instance's launch,
+   * update checks, downloads, and update failures, and its API is on the
+   * instance, under the plugin's id. Plugin ids must be unique.
+   */
+  plugins?: TPlugins;
+  /** Base URL of a server exposing the Hot Updater v1 client HTTP protocol. */
+  baseURL: HotUpdaterBaseURL;
+  requestHeaders?: Record<string, string>;
+  requestTimeout?: number;
+  onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
+  onError?: (error: HotUpdaterError | Error | unknown) => void;
+}

package/src/native.ts

@@ -46,7 +46,7 @@ type ActiveBundleSnapshotCacheValues = {
 type ActiveBundleSnapshotCacheKey = keyof ActiveBundleSnapshotCacheValues;
 
 /**
- * Built-in reload behaviors used by `HotUpdater.reload()`.
+ * Built-in reload behaviors used by `hotUpdater.reload()`.
  *
  * - `reload`: In-process React Native reload.
  * - `processRestart`: Android-only cold restart. On iOS the same call behaves like `reload`.
@@ -578,7 +578,7 @@ export const reload = async () => {
 };
 
 /**
- * Configures how `HotUpdater.reload()` should behave.
+ * Configures how `hotUpdater.reload()` should behave.
  *
  * This API is available on both Android and iOS so app code can stay symmetric.
  * By default, HotUpdater uses `processRestart`.
@@ -959,7 +959,7 @@ export const readNotifyAppReady = (): {
  *
  * @example
  * ```ts
- * const result = HotUpdater.notifyAppReady();
+ * const result = hotUpdater.notifyAppReady();
  *
  * if (result.status === "RECOVERED") {
  *   console.log(result.fromBundleId, result.toBundleId);

package/src/pluginHost.ts

@@ -1,4 +1,8 @@
-import { createPluginHost } from "@hot-updater/protocol";
+import {
+  createPluginHost,
+  type PluginHost,
+  type PluginHostEnvironment,
+} from "@hot-updater/protocol";
 import { Platform } from "react-native";
 
 import {
@@ -14,16 +18,10 @@ import {
 } from "./native";
 import { HOT_UPDATER_SDK_VERSION } from "./sdkVersion";
 
-export type { PluginHostConfig } from "@hot-updater/protocol";
+export type { PluginHost, PluginHostConfig } from "@hot-updater/protocol";
 
-/** The app's plugin host: plugins read the native module and fetch the configured server. */
-export const {
-  configurePlugins,
-  hasPluginHook,
-  buildPluginEvent,
-  dispatchPluginHook,
-  emitPluginHook,
-} = createPluginHost({
+/** The native module and runtime every plugin host reads. */
+const environment: PluginHostEnvironment = {
   fetch: (url, init) => fetch(url, init),
   get platform() {
     return Platform.OS === "android" ? "android" : "ios";
@@ -44,4 +42,11 @@ export const {
   getStorageItem: (key) => getStorageItem(key),
   setStorageItem: (key, value) => setStorageItem(key, value),
   now: () => Date.now(),
-});
+};
+
+/**
+ * Creates an instance's plugin host: its plugins read the native module and
+ * fetch the server the instance was configured with.
+ */
+export const createAppPluginHost = (): PluginHost =>
+  createPluginHost(environment);

package/src/sdkVersion.ts

@@ -1 +1 @@
-export const HOT_UPDATER_SDK_VERSION = "1.0.0-rc.40";
+export const HOT_UPDATER_SDK_VERSION = "1.0.0-rc.42";

package/src/wrap.tsx

@@ -1,31 +1,21 @@
 import React, { useEffect, useState } from "react";
 
-import { handleNotifyAppReady } from "./appReady";
-import { checkForUpdate } from "./checkForUpdate";
 import { useEventCallback } from "./hooks/useEventCallback";
 import { getUpdateId, reload } from "./native";
 import { useHotUpdaterStore } from "./store";
 import type {
   HotUpdaterFallbackComponentProps,
-  InternalInitOptions,
   InternalWrapOptions,
   UpdateStatus,
 } from "./wrap.types";
 
 export type {
-  AutoUpdateOptions,
   HotUpdaterFallbackComponentProps,
-  HotUpdaterInitOptions,
-  HotUpdaterOptions,
-  InternalInitOptions,
+  HotUpdaterWrapOptions,
   InternalWrapOptions,
   RunUpdateProcessResponse,
 } from "./wrap.types";
 
-export function init(options: InternalInitOptions): void {
-  void handleNotifyAppReady(options);
-}
-
 export function wrap(
   options: InternalWrapOptions,
 ): <P extends object>(
@@ -81,16 +71,12 @@ export function wrap(
         try {
           setUpdateStatus("CHECK_FOR_UPDATE");
 
-          const readiness = handleNotifyAppReady(restOptions);
-          const updateInfo = await checkForUpdate({
-            client: restOptions.client,
+          const updateInfo = await restOptions.checkForUpdate({
             updateStrategy: restOptions.updateStrategy,
-            requestHeaders: restOptions.requestHeaders,
-            requestTimeout: restOptions.requestTimeout,
-            onError: restOptions.onError,
           });
 
-          await readiness;
+          // A forced update reloads only after init has read this launch.
+          await restOptions.appReady();
           setMessage(updateInfo?.message ?? null);
 
           if (!updateInfo) {
@@ -106,7 +92,7 @@ export function wrap(
 
           if (updateInfo.shouldForceUpdate === false) {
             void updateInfo.updateBundle().catch((error: unknown) => {
-              restOptions.onError?.(error);
+              restOptions.onError(error);
             });
 
             restOptions.onUpdateProcessCompleted?.({
@@ -143,7 +129,7 @@ export function wrap(
         } catch (error) {
           const normalizedError =
             error instanceof Error ? error : new Error(String(error));
-          restOptions.onError?.(normalizedError);
+          restOptions.onError(normalizedError);
           setUpdateStatus("UPDATE_PROCESS_COMPLETED");
         }
       });

package/src/wrap.types.ts

@@ -1,11 +1,10 @@
 import type React from "react";
 
-import type { HotUpdaterClientPlugin } from "./clientPlugin";
-import type { HotUpdaterError } from "./error";
-import type { HotUpdaterHttpClient } from "./httpClient";
-import type { NotifyAppReadyResult } from "./native";
+import type {
+  CheckForUpdateOptions,
+  CheckForUpdateResult,
+} from "./checkForUpdate";
 import type { HotUpdaterState } from "./store";
-import type { HotUpdaterBaseURL } from "./types";
 
 export interface RunUpdateProcessResponse {
   status: "ROLLBACK" | "UPDATE" | "UP_TO_DATE";
@@ -27,50 +26,24 @@ export type HotUpdaterFallbackComponentProps = {
   details: HotUpdaterState["details"];
 };
 
-interface CommonHotUpdaterOptions {
-  /**
-   * Client plugins, such as `insights()` from `@hot-updater/react-native`.
-   * Each plugin's `setup` runs
-   * once, and its hooks observe launches, update checks, downloads, and
-   * update failures. Plugin ids must be unique.
-   */
-  plugins?: readonly HotUpdaterClientPlugin[];
-  /** Base URL of a server exposing the Hot Updater v1 client HTTP protocol. */
-  baseURL: HotUpdaterBaseURL;
-  requestHeaders?: Record<string, string>;
-  requestTimeout?: number;
-  onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
-  onError?: (error: HotUpdaterError | Error | unknown) => void;
-}
-
-export type AutoUpdateOptions = CommonHotUpdaterOptions & {
+/**
+ * The update flow `hotUpdater.wrap` runs when the wrapped root mounts. The
+ * server, request settings, and plugins come from `HotUpdater.init`.
+ */
+export interface HotUpdaterWrapOptions {
   updateStrategy: "fingerprint" | "appVersion";
   fallbackComponent?: React.FC<HotUpdaterFallbackComponentProps>;
   onProgress?: (progress: number) => void;
   reloadOnForceUpdate?: boolean;
   onUpdateProcessCompleted?: (response: RunUpdateProcessResponse) => void;
-};
-
-export type HotUpdaterInitOptions = CommonHotUpdaterOptions;
-
-export type HotUpdaterOptions = AutoUpdateOptions;
+}
 
-type InternalCommonOptions = {
-  client: HotUpdaterHttpClient;
-  requestHeaders?: Record<string, string>;
-  requestTimeout?: number;
-  onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
-  onError?: (error: HotUpdaterError | Error | unknown) => void;
+export type InternalWrapOptions = HotUpdaterWrapOptions & {
+  /** The instance's check, over the configuration of `HotUpdater.init`. */
+  checkForUpdate: (
+    options: Pick<CheckForUpdateOptions, "updateStrategy">,
+  ) => Promise<CheckForUpdateResult | null>;
+  /** Settles once `HotUpdater.init` has read this launch. */
+  appReady: () => Promise<unknown>;
+  onError: (error: unknown) => void;
 };
-
-type InternalAutoUpdateOptions = InternalCommonOptions & {
-  updateStrategy: "fingerprint" | "appVersion";
-  fallbackComponent?: React.FC<HotUpdaterFallbackComponentProps>;
-  onProgress?: (progress: number) => void;
-  reloadOnForceUpdate?: boolean;
-  onUpdateProcessCompleted?: (response: RunUpdateProcessResponse) => void;
-};
-
-export type InternalInitOptions = InternalCommonOptions;
-
-export type InternalWrapOptions = InternalAutoUpdateOptions;