@hot-updater/react-native 0.36.6 → 1.0.0-rc.0

package/src/index.ts

@@ -3,9 +3,10 @@ import {
   checkForUpdate,
   type InternalCheckForUpdateOptions,
 } from "./checkForUpdate";
-import { createDefaultResolver } from "./DefaultResolver";
+import { createHttpClient, type HotUpdaterHttpClient } from "./httpClient";
 import {
   addListener,
+  getPublicActiveUpdateState,
   clearCrashHistory,
   getAppVersion,
   getBaseURL,
@@ -15,18 +16,21 @@ import {
   getCrashHistory,
   getDefaultChannel,
   getFingerprintHash,
+  getInstallId,
   getManifest,
-  getMinBundleId,
+  getMinimumReleaseId,
+  getReleaseId,
   isChannelSwitched,
+  notifyAppReady,
   reload,
   resetChannel,
   setCohort,
   setReloadBehavior,
+  setUser,
   type UpdateParams,
   updateBundle,
 } from "./native";
 import { hotUpdaterStore } from "./store";
-import type { HotUpdaterResolver } from "./types";
 import {
   type AutoUpdateOptions,
   type HotUpdaterInitOptions,
@@ -34,7 +38,6 @@ import {
   init,
   type InternalInitOptions,
   type InternalWrapOptions,
-  type ManualUpdateOptions,
   wrap,
 } from "./wrap";
 
@@ -46,25 +49,22 @@ export type {
   Manifest,
   ManifestAsset,
   NotifyAppReadyResult,
+  ActiveUpdateState,
   ReloadBehavior,
   ReloadBehaviorSetting,
+  SetUserParams,
 } from "./native";
 export * from "./store";
-export { createDefaultResolver } from "./DefaultResolver";
 export {
   extractSignatureFailure,
   type HotUpdaterBaseURL,
-  type HotUpdaterResolver,
   isSignatureVerificationError,
-  type ResolverCheckUpdateParams,
-  type ResolverNotifyAppReadyParams,
   type SignatureVerificationFailure,
 } from "./types";
 export type {
   HotUpdaterFallbackComponentProps,
   HotUpdaterInitOptions,
   HotUpdaterOptions,
-  ManualUpdateOptions,
   RunUpdateProcessResponse,
 } from "./wrap";
 
@@ -88,31 +88,9 @@ registerGlobalGetBaseURL();
 
 type HotUpdaterWrap = {
   (options: AutoUpdateOptions): ReturnType<typeof wrap>;
-  /**
-   * @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
-   */
-  (options: ManualUpdateOptions): ReturnType<typeof wrap>;
   (options: HotUpdaterOptions): ReturnType<typeof wrap>;
 };
 
-const isManualWrapOptions = (
-  options: HotUpdaterOptions,
-): options is ManualUpdateOptions =>
-  "updateMode" in options && options.updateMode === "manual";
-
 /**
  * Creates a HotUpdater client instance with all update management methods.
  * This function is called once on module initialization to create a singleton instance.
@@ -123,18 +101,19 @@ function createHotUpdaterClient() {
 
   // Global configuration stored from wrap
   const globalConfig: {
-    resolver: HotUpdaterResolver | null;
+    analytics?: boolean;
+    client: HotUpdaterHttpClient | null;
     requestHeaders?: Record<string, string>;
     requestTimeout?: number;
     onError?: (error: unknown) => void;
   } = {
-    resolver: null,
+    client: null,
   };
 
   const createMissingNetworkConfigError = (apiName: "init" | "wrap") => {
     if (apiName === "init") {
       return new Error(
-        `[HotUpdater] Either baseURL or resolver must be provided.\n\n` +
+        `[HotUpdater] baseURL must be provided.\n\n` +
           `Configure HotUpdater before calling update APIs with the standard baseURL setup:\n\n` +
           `  HotUpdater.init({\n` +
           `    baseURL: "<your-update-server-url>",\n` +
@@ -150,7 +129,7 @@ function createHotUpdaterClient() {
       `  })(App);\n\n`;
 
     return new Error(
-      `[HotUpdater] Either baseURL or resolver must be provided.\n\n` +
+      `[HotUpdater] baseURL must be provided.\n\n` +
         `Configure HotUpdater.wrap with the standard baseURL setup:\n\n` +
         baseURLExample +
         `For manual update flows, use HotUpdater.init() and visit: ` +
@@ -161,39 +140,25 @@ function createHotUpdaterClient() {
   const normalizeOptions = (
     options: HotUpdaterOptions,
   ): InternalWrapOptions => {
-    if (isManualWrapOptions(options)) {
-      if ("baseURL" in options && options.baseURL) {
-        const { baseURL, ...rest } = options;
-        return {
-          ...rest,
-          resolver: createDefaultResolver(baseURL),
-          updateMode: "manual",
-        };
-      }
-
-      if ("resolver" in options && options.resolver) {
-        return {
-          ...options,
-          updateMode: "manual",
-        };
-      }
+    const incoming = options as HotUpdaterOptions & {
+      updateMode?: unknown;
+    };
+    if (incoming.updateMode === "manual") {
+      throw new Error(
+        '[HotUpdater] HotUpdater.wrap({ updateMode: "manual" }) was removed. ' +
+          "Call HotUpdater.init({ ... }) instead, export your root component " +
+          "directly, and use HotUpdater.checkForUpdate(...) for the manual " +
+          "update flow. See https://hot-updater.dev/docs/guides/custom-update",
+      );
     }
 
-    const autoOptions = options as AutoUpdateOptions;
+    const autoOptions = incoming as AutoUpdateOptions;
 
-    if ("baseURL" in autoOptions && autoOptions.baseURL) {
+    if (autoOptions.baseURL) {
       const { baseURL, ...rest } = autoOptions;
       return {
         ...rest,
-        resolver: createDefaultResolver(baseURL),
-        updateMode: "auto",
-      };
-    }
-
-    if ("resolver" in autoOptions && autoOptions.resolver) {
-      return {
-        ...autoOptions,
-        updateMode: "auto",
+        client: createHttpClient(baseURL),
       };
     }
 
@@ -208,18 +173,14 @@ function createHotUpdaterClient() {
         updateMode?: unknown;
       };
 
-    if ("baseURL" in rest && rest.baseURL) {
+    if (rest.baseURL) {
       const { baseURL, ...baseURLRest } = rest;
       return {
         ...baseURLRest,
-        resolver: createDefaultResolver(baseURL),
+        client: createHttpClient(baseURL),
       };
     }
 
-    if ("resolver" in rest && rest.resolver) {
-      return rest;
-    }
-
     throw createMissingNetworkConfigError("init");
   };
 
@@ -227,7 +188,8 @@ function createHotUpdaterClient() {
     normalizedOptions: InternalInitOptions | InternalWrapOptions,
     options: HotUpdaterOptions | HotUpdaterInitOptions,
   ) => {
-    globalConfig.resolver = normalizedOptions.resolver;
+    globalConfig.analytics = normalizedOptions.analytics;
+    globalConfig.client = normalizedOptions.client;
     globalConfig.requestHeaders = options.requestHeaders;
     globalConfig.requestTimeout = options.requestTimeout;
     globalConfig.onError = options.onError;
@@ -250,8 +212,8 @@ function createHotUpdaterClient() {
     configurationAPI ??= nextAPI;
   };
 
-  const ensureGlobalResolver = (methodName: string) => {
-    if (!globalConfig.resolver) {
+  const ensureGlobalClient = (methodName: string) => {
+    if (!globalConfig.client) {
       throw new Error(
         `[HotUpdater] ${methodName} requires HotUpdater.wrap() or HotUpdater.init() to be used.\n\n` +
           `To fix this issue, configure HotUpdater before calling ${methodName}:\n\n` +
@@ -267,7 +229,7 @@ function createHotUpdaterClient() {
           `For manual update flows, visit: https://hot-updater.dev/docs/guides/custom-update`,
       );
     }
-    return globalConfig.resolver;
+    return globalConfig.client;
   };
 
   return {
@@ -289,7 +251,7 @@ function createHotUpdaterClient() {
      *   baseURL: "<your-update-server-url>",
      *   updateStrategy: "appVersion",
      *   requestHeaders: {
-     *     "Authorization": "Bearer <your-access-token>",
+     *     "x-api-key": "<your-api-key>",
      *   },
      * })(App);
      * ```
@@ -306,8 +268,7 @@ function createHotUpdaterClient() {
      * Initializes HotUpdater without wrapping a React component.
      *
      * Use this for manual update flows in runtimes where a root component HOC
-     * is not convenient. Replace deprecated manual
-     * `HotUpdater.wrap({ updateMode: "manual" })(App)` usage with this API.
+     * is not convenient. Use this instead of wrapping the root component.
      *
      * @example
      * ```tsx
@@ -368,15 +329,19 @@ function createHotUpdaterClient() {
      */
     getAppVersion,
 
+    /** Reads the active and stable Release/Bundle state. */
+    getActiveUpdateState: async () => getPublicActiveUpdateState(),
+
     /**
      * Fetches the current bundle ID of the app.
      */
     getBundleId,
 
-    /**
-     * Retrieves the initial bundle ID based on the build time of the native app.
-     */
-    getMinBundleId,
+    /** Preferred Release-catalog name for the build-time UUIDv7 floor. */
+    getMinimumReleaseId,
+
+    /** Returns the active Release identity, or null for BUILTIN/legacy state. */
+    getReleaseId,
 
     /**
      * Fetches the current manifest for the active bundle.
@@ -453,18 +418,17 @@ function createHotUpdaterClient() {
      * Manually checks for updates.
      *
      * @param {Object} config - Update check configuration
-     * @param {string} config.source - Update server URL
      * @param {string} [config.channel] - Optional channel override for this update check
      * @param {Record<string, string>} [config.requestHeaders] - Request headers
      *
-     * @returns {Promise<UpdateInfo | null>} Update information or null if up to date
+     * @returns {Promise<CheckForUpdateResult | null>} Update information or null if up to date
      *
      * @example
      * ```ts
      * const updateInfo = await HotUpdater.checkForUpdate({
-     *   source: "<your-update-server-url>",
+     *   updateStrategy: "appVersion",
      *   requestHeaders: {
-     *     Authorization: "Bearer <your-access-token>",
+     *     "x-api-key": "<your-api-key>",
      *   },
      * });
      *
@@ -473,18 +437,19 @@ function createHotUpdaterClient() {
      *   return;
      * }
      *
-     * await HotUpdater.updateBundle(updateInfo.id, updateInfo.fileUrl);
+     * await updateInfo.updateBundle();
      * if (updateInfo.shouldForceUpdate) {
      *   await HotUpdater.reload();
      * }
      * ```
      */
     checkForUpdate: (config: CheckForUpdateOptions) => {
-      const resolver = ensureGlobalResolver("checkForUpdate");
+      const client = ensureGlobalClient("checkForUpdate");
 
       const mergedConfig: InternalCheckForUpdateOptions = {
         ...config,
-        resolver,
+        analytics: globalConfig.analytics,
+        client,
         requestHeaders: {
           ...globalConfig.requestHeaders,
           ...config.requestHeaders,
@@ -508,9 +473,9 @@ function createHotUpdaterClient() {
      * @example
      * ```ts
      * const updateInfo = await HotUpdater.checkForUpdate({
-     *   source: "<your-update-server-url>",
+     *   updateStrategy: "appVersion",
      *   requestHeaders: {
-     *     Authorization: "Bearer <your-access-token>",
+     *     "x-api-key": "<your-api-key>",
      *   },
      * });
      *
@@ -520,17 +485,14 @@ function createHotUpdaterClient() {
      *   };
      * }
      *
-     * await HotUpdater.updateBundle({
-     *   bundleId: updateInfo.id,
-     *   fileUrl: updateInfo.fileUrl
-     * });
+     * await updateInfo.updateBundle();
      * if (updateInfo.shouldForceUpdate) {
      *   await HotUpdater.reload();
      * }
      * ```
      */
     updateBundle: (params: UpdateParams) => {
-      ensureGlobalResolver("updateBundle");
+      ensureGlobalClient("updateBundle");
       return updateBundle(params);
     },
 
@@ -567,6 +529,21 @@ function createHotUpdaterClient() {
      */
     getFingerprintHash,
 
+    /**
+     * Fetches the persisted install id for this app installation.
+     */
+    getInstallId,
+
+    /**
+     * Persists nullable user identity fields associated with this installation.
+     */
+    setUser,
+
+    /**
+     * Reads the native launch report for the current process.
+     */
+    notifyAppReady,
+
     /**
      * Gets the list of bundle IDs that have been marked as crashed.
      * These bundles will be rejected if attempted to install again.

package/src/iosInterop.spec.ts

@@ -0,0 +1,30 @@
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+import { describe, expect, it } from "vitest";
+
+const iosInternalDirectory = resolve(
+  import.meta.dirname,
+  "../ios/HotUpdater/Internal",
+);
+
+const readIOSSource = (filename: string) =>
+  readFileSync(resolve(iosInternalDirectory, filename), "utf8");
+
+describe("iOS Objective-C interoperability", () => {
+  it("does not call an autoreleased NSString through raw Swift ABI", () => {
+    const implementation = readIOSSource("HotUpdaterImpl.swift");
+    const objectiveCImplementation = readIOSSource("HotUpdater.mm");
+
+    expect(implementation).not.toContain(
+      '@_silgen_name("HotUpdaterGetMinBundleId")',
+    );
+    expect(implementation).toContain(
+      '@_silgen_name("HotUpdaterCopyMinBundleId")',
+    );
+    expect(implementation).toContain(".takeRetainedValue() as String");
+    expect(objectiveCImplementation).toContain(
+      "return (__bridge_retained void *)HotUpdaterGetMinBundleId();",
+    );
+  });
+});