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

package/src/appReady.ts

@@ -8,11 +8,7 @@ import {
   type NotifyAppReadyResult,
   readNotifyAppReady,
 } from "./native";
-import {
-  buildPluginEvent,
-  dispatchPluginHook,
-  emitPluginHook,
-} from "./pluginHost";
+import type { PluginHost } from "./pluginHost";
 
 export type NotifyAppReadyOptions = {
   onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
@@ -21,10 +17,6 @@ export type NotifyAppReadyOptions = {
 
 type RequestAnimationFrame = (callback: (timestamp: number) => void) => number;
 
-let didEmitAppReady = false;
-/** Settles once this runtime's launch was read, whether it was reported or failed. */
-let appReadyRead: Promise<unknown> | null = null;
-
 const waitForNextFrame = () =>
   new Promise<void>((resolve) => {
     const requestAnimationFrame = (
@@ -87,6 +79,7 @@ const toAppReadyResult = (
 };
 
 const notifyAppReady = async (
+  host: PluginHost,
   options: NotifyAppReadyOptions,
 ): Promise<NotifyAppReadyResult | undefined> => {
   try {
@@ -97,10 +90,9 @@ const notifyAppReady = async (
     } while (nativeReadResult.pending);
 
     const { result, transition } = nativeReadResult;
-    if (!didEmitAppReady) {
-      didEmitAppReady = true;
-      emitPluginHook("onAppReady", () => toAppReadyResult(result, transition));
-    }
+    host.emitPluginHook("onAppReady", () =>
+      toAppReadyResult(result, transition),
+    );
 
     options.onNotifyAppReady?.(result);
     return result;
@@ -113,29 +105,43 @@ const notifyAppReady = async (
   }
 };
 
-/** Reads this runtime's launch once native finalizes it and reports it to plugins. */
-export const handleNotifyAppReady = (
-  options: NotifyAppReadyOptions,
-): Promise<NotifyAppReadyResult | undefined> => {
-  const readiness = notifyAppReady(options);
-  appReadyRead ??= readiness;
-  return readiness;
-};
+/** An instance's launch: read once, and reported to the instance's plugins. */
+export interface LaunchReporter {
+  /**
+   * Reads this launch once native finalizes it and reports it to the
+   * plugins, once. It rejects only if `onError` throws.
+   */
+  read(
+    options: NotifyAppReadyOptions,
+  ): Promise<NotifyAppReadyResult | undefined>;
+  /** Settles once the launch was read, whether it was reported or failed. */
+  readonly appReady: Promise<unknown>;
+  /**
+   * Calls a plugin hook after the instance's `onAppReady`, so plugins see the
+   * launch before anything that followed it. The event is built now, from the
+   * state it describes, and only when a plugin listens.
+   */
+  emit: PluginHost["emitPluginHook"];
+}
 
-/**
- * Calls a plugin hook after this runtime's `onAppReady`, so plugins see the
- * launch before anything that followed it. The event is built now, from the
- * state it describes, and only when a plugin listens.
- */
-export const emitAfterAppReady: typeof emitPluginHook = (
-  name,
-  createPayload,
-) => {
-  const payload = buildPluginEvent(name, createPayload);
-  if (payload === null) return;
-  if (appReadyRead === null) {
-    dispatchPluginHook(name, payload);
-    return;
-  }
-  void appReadyRead.then(() => dispatchPluginHook(name, payload));
+export const createLaunchReporter = (host: PluginHost): LaunchReporter => {
+  let launchRead: Promise<NotifyAppReadyResult | undefined> | null = null;
+  return {
+    read: (options) => {
+      launchRead ??= notifyAppReady(host, options);
+      return launchRead;
+    },
+    get appReady() {
+      return launchRead ?? Promise.resolve();
+    },
+    emit: (name, createPayload) => {
+      const payload = host.buildPluginEvent(name, createPayload);
+      if (payload === null) return;
+      if (launchRead === null) {
+        host.dispatchPluginHook(name, payload);
+        return;
+      }
+      void launchRead.then(() => host.dispatchPluginHook(name, payload));
+    },
+  };
 };

package/src/checkForUpdate.ts

@@ -11,7 +11,7 @@ import {
 } from "@hot-updater/protocol";
 import { Platform } from "react-native";
 
-import { emitAfterAppReady, getRunningReleaseId } from "./appReady";
+import { getRunningReleaseId, type LaunchReporter } from "./appReady";
 import type {
   ReleaseTransitionKind,
   UpdateErrorResource,
@@ -45,7 +45,6 @@ export interface CheckForUpdateOptions {
    * Update strategy
    * - "fingerprint": Use fingerprint hash to check for updates
    * - "appVersion": Use app version to check for updates
-   * - Can override the strategy set in HotUpdater.wrap()
    */
   updateStrategy: "appVersion" | "fingerprint";
 
@@ -75,13 +74,15 @@ export type CheckForUpdateResult = {
   readonly transitionKind?: ReleaseTransitionKind;
   /**
    * Updates the bundle.
-   * This method is equivalent to `HotUpdater.updateBundle()` but with all required arguments pre-filled.
+   * This method is equivalent to `hotUpdater.updateBundle()` but with all required arguments pre-filled.
    */
   updateBundle: () => Promise<boolean>;
 };
 
 export interface InternalCheckForUpdateOptions extends CheckForUpdateOptions {
   client: HotUpdaterHttpClient;
+  /** Calls the checking instance's plugin hooks. */
+  emit: LaunchReporter["emit"];
 }
 
 const sameReceipt = (
@@ -137,12 +138,13 @@ type UpdateErrorScope = {
  * the SDK's JavaScript raised happened in `stage`, fetching `resource`.
  */
 export const reportUpdateError = (
+  emit: LaunchReporter["emit"],
   error: unknown,
   stage: UpdateErrorStage,
   resource: UpdateErrorResource | undefined,
   scope: UpdateErrorScope,
 ): void => {
-  emitAfterAppReady("onUpdateError", () => {
+  emit("onUpdateError", () => {
     const classification = classifyUpdateError(error, stage, resource);
     if (classification === null) return null;
     return {
@@ -354,7 +356,7 @@ async function checkForReleaseCatalogUpdate(input: {
         selection: receipt,
       });
       if (committed && transitionKind === "ADOPT_RELEASE") {
-        emitAfterAppReady("onUpdateCheck", () => ({
+        options.emit("onUpdateCheck", () => ({
           status: "UNCHANGED",
           channel: receipt.channel,
           bundleId: receipt.bundleId,
@@ -386,7 +388,7 @@ async function checkForReleaseCatalogUpdate(input: {
       status: desired.status,
     });
     if (delivery !== null && desired.bundleId !== input.currentBundleId) {
-      emitAfterAppReady("onBundleDownloaded", () => ({
+      options.emit("onBundleDownloaded", () => ({
         channel: input.targetChannel,
         fromBundleId: input.currentBundleId,
         fromReleaseId,
@@ -402,7 +404,13 @@ async function checkForReleaseCatalogUpdate(input: {
     try {
       return await installSelection();
     } catch (error) {
-      reportUpdateError(error, "download", "artifact", errorScope);
+      reportUpdateError(
+        options.emit,
+        error,
+        "download",
+        "artifact",
+        errorScope,
+      );
       throw error;
     }
   };
@@ -413,7 +421,7 @@ async function checkForReleaseCatalogUpdate(input: {
       : desired.status === "ROLLBACK"
         ? true
         : (release?.shouldForceUpdate ?? false);
-  emitAfterAppReady("onUpdateCheck", () => ({
+  options.emit("onUpdateCheck", () => ({
     status: "UPDATE_AVAILABLE",
     channel: input.targetChannel,
     fromBundleId: input.currentBundleId,
@@ -471,7 +479,7 @@ export async function checkForUpdate(
 
   if (isSwitched && explicitChannel && explicitChannel !== currentChannel) {
     const error = new HotUpdaterError(
-      `Runtime channel is already switched to "${currentChannel}". Call HotUpdater.resetChannel() before checking "${explicitChannel}".`,
+      `Runtime channel is already switched to "${currentChannel}". Call hotUpdater.resetChannel() before checking "${explicitChannel}".`,
     );
     options.onError?.(error);
     throw error;
@@ -495,7 +503,7 @@ export async function checkForUpdate(
       targetChannel,
     });
     if (result === null) {
-      emitAfterAppReady("onUpdateCheck", () => {
+      options.emit("onUpdateCheck", () => {
         const releaseId = getRunningReleaseId(currentBundleId, currentChannel);
         return {
           status: "UNCHANGED",
@@ -508,7 +516,7 @@ export async function checkForUpdate(
     }
     return result;
   } catch (error) {
-    reportUpdateError(error, "check", "catalog", {
+    reportUpdateError(options.emit, error, "check", "catalog", {
       bundleId: currentBundleId,
       channel: targetChannel,
       updateStrategy: options.updateStrategy,

package/src/clientPlugin.ts

@@ -2,9 +2,12 @@ export {
   defineClientPlugin,
   type AppReadyResult,
   type BundleDownloadedInfo,
+  type ClientPluginApi,
+  type ClientPluginApis,
   type HotUpdaterClientContext,
   type HotUpdaterClientHooks,
   type HotUpdaterClientPlugin,
+  type HotUpdaterClientSetup,
   type HotUpdaterClientStorage,
   type ReleaseTransitionKind,
   type UpdateCheckResult,

package/src/error.ts

@@ -92,7 +92,7 @@ export enum HotUpdaterErrorCode {
   /**
    * Bundle is in crashed history and cannot be applied.
    * Thrown when attempting to install a bundle that previously caused a crash.
-   * Use HotUpdater.clearCrashHistory() to allow retrying this bundle.
+   * Use hotUpdater.clearCrashHistory() to allow retrying this bundle.
    * @retryable false - Bundle was marked as crashed for safety
    */
   BUNDLE_IN_CRASHED_HISTORY = "BUNDLE_IN_CRASHED_HISTORY",

package/src/httpClient.ts

@@ -180,7 +180,7 @@ const createSession = (
   },
 });
 
-/** Creates the private HTTP client used by HotUpdater.init and HotUpdater.wrap. */
+/** Creates the private HTTP client HotUpdater.init configures. */
 export const createHttpClient = (
   baseURL: HotUpdaterBaseURL,
   onResponse?: (response: UpdateHttpResponse) => void,