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

package/src/native.ts

@@ -215,7 +215,7 @@ const getNativeBundleId = (): string | null => {
 };
 
 const resolveBundleId = (bundleId: string | null): string => {
-  return !bundleId || bundleId === NIL_UUID ? getMinimumReleaseId() : bundleId;
+  return !bundleId || bundleId === NIL_UUID ? getMinBundleId() : bundleId;
 };
 
 const getFreshBundleId = (): string => {
@@ -588,11 +588,13 @@ export function setReloadBehavior(
 }
 
 /**
- * Fetches the build-time minimum Release id.
+ * Fetches the minimum bundle id created from the native app build time.
  *
- * @returns {string} The minimum Release id.
+ * Release Catalog selection uses this value as its minimum Release id.
+ *
+ * @returns {string} The minimum bundle id.
  */
-export const getMinimumReleaseId = (): string => {
+export const getMinBundleId = (): string => {
   const constants = HotUpdaterNative.getConstants();
   return constants.MIN_BUNDLE_ID;
 };
@@ -685,7 +687,7 @@ export const isChannelSwitched = (): boolean => {
  */
 export const getFingerprintHash = (): string | null => {
   const constants = HotUpdaterNative.getConstants();
-  return constants.FINGERPRINT_HASH;
+  return constants.FINGERPRINT_HASH ?? null;
 };
 
 export const getInstallId = (): string => {
@@ -781,7 +783,7 @@ export type NotifyAppReadyResult =
       toReleaseId?: string;
     };
 
-export type NotifyAppReadyAnalyticsEvent = {
+export type NotifyAppReadyInsightsEvent = {
   type: "UPDATE_APPLIED" | "RECOVERED";
   fromBundleId: string;
   toBundleId: string;
@@ -889,9 +891,9 @@ const getNotifyAppReadyTransition = (
   return null;
 };
 
-const getNotifyAppReadyAnalyticsEvent = (
+const getNotifyAppReadyInsightsEvent = (
   result: RawNotifyAppReadyResult,
-): NotifyAppReadyAnalyticsEvent | null => {
+): NotifyAppReadyInsightsEvent | null => {
   const transition = getNotifyAppReadyTransition(result);
 
   if (!transition || !isPersistedUpdateStrategy(result.updateStrategy)) {
@@ -936,14 +938,14 @@ const normalizeNotifyAppReadyResult = (
 
 export const readNotifyAppReady = (): {
   result: NotifyAppReadyResult;
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+  insightsEvent: NotifyAppReadyInsightsEvent | null;
   pending: boolean;
 } => {
   const rawResult = readRawNotifyAppReadyResult();
 
   return {
     result: normalizeNotifyAppReadyResult(rawResult),
-    analyticsEvent: getNotifyAppReadyAnalyticsEvent(rawResult),
+    insightsEvent: getNotifyAppReadyInsightsEvent(rawResult),
     pending: rawResult.status === "PENDING",
   };
 };

package/src/{notifyAppReadyAnalytics.boundary.spec.ts → notifyAppReadyInsights.boundary.spec.ts}

@@ -1,13 +1,13 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 import type {
-  NotifyAppReadyAnalyticsEvent,
+  NotifyAppReadyInsightsEvent,
   NotifyAppReadyResult,
 } from "./native";
 import {
   createNotifyReadResult,
   stubNotifyFrame,
-} from "./notifyAppReadyAnalytics.test-utils";
+} from "./notifyAppReadyInsights.test-utils";
 
 const platformState = vi.hoisted((): { OS: "ios" | "android" } => ({
   OS: "ios",
@@ -48,7 +48,7 @@ const mocks = vi.hoisted(() => ({
   getPersistedUserIdentity: vi.fn(() => ({})),
   readNotifyAppReady: vi.fn<
     () => {
-      analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+      insightsEvent: NotifyAppReadyInsightsEvent | null;
       pending: boolean;
       result: NotifyAppReadyResult;
     }
@@ -78,20 +78,20 @@ vi.mock("./specs/NativeHotUpdater", () => ({
 }));
 
 const createClient = () => {
-  const sendAnalyticsEvent = vi.fn().mockResolvedValue(undefined);
+  const sendInsightsEvent = vi.fn().mockResolvedValue(undefined);
   return {
     client: {
       createSession: vi.fn(async () => ({
         fetchReleaseCatalog: vi.fn(),
         resolveArtifact: vi.fn(),
-        sendAnalyticsEvent,
+        sendInsightsEvent,
       })),
     },
-    sendAnalyticsEvent,
+    sendInsightsEvent,
   };
 };
 
-describe("automatic notifyAppReady analytics boundaries", () => {
+describe("automatic notifyAppReady insights boundaries", () => {
   beforeEach(() => {
     vi.resetModules();
     vi.unstubAllGlobals();
@@ -124,7 +124,7 @@ describe("automatic notifyAppReady analytics boundaries", () => {
     const { init } = await import("./wrap");
 
     init({
-      analytics: true,
+      insights: true,
       client: {
         createSession: vi.fn(async () => {
           throw new Error("baseURL unavailable");
@@ -138,7 +138,7 @@ describe("automatic notifyAppReady analytics boundaries", () => {
     expect(onError).not.toHaveBeenCalled();
     expect(onNotifyAppReady).toHaveBeenCalledWith({ status: "UNCHANGED" });
     expect(warn).toHaveBeenCalledWith(
-      "[HotUpdater] Automatic notifyAppReady analytics failed:",
+      "[HotUpdater] Automatic notifyAppReady insights failed:",
       expect.objectContaining({
         message: "baseURL unavailable",
       }),
@@ -163,17 +163,17 @@ describe("automatic notifyAppReady analytics boundaries", () => {
       } else {
         mocks.getInstallId.mockReturnValue(value);
       }
-      const { client, sendAnalyticsEvent } = createClient();
+      const { client, sendInsightsEvent } = createClient();
       const { init } = await import("./wrap");
 
-      init({ analytics: true, client, onError, onNotifyAppReady });
+      init({ insights: true, client, onError, onNotifyAppReady });
       await vi.runOnlyPendingTimersAsync();
 
-      expect(sendAnalyticsEvent).not.toHaveBeenCalled();
+      expect(sendInsightsEvent).not.toHaveBeenCalled();
       expect(onError).not.toHaveBeenCalled();
       expect(onNotifyAppReady).toHaveBeenCalledWith({ status: "UNCHANGED" });
       expect(warn).toHaveBeenCalledWith(
-        "[HotUpdater] Automatic notifyAppReady analytics failed:",
+        "[HotUpdater] Automatic notifyAppReady insights failed:",
         expect.any(Error),
       );
       warn.mockRestore();
@@ -197,17 +197,17 @@ describe("automatic notifyAppReady analytics boundaries", () => {
       } else {
         mocks.getBundleId.mockReturnValue(value);
       }
-      const { client, sendAnalyticsEvent } = createClient();
+      const { client, sendInsightsEvent } = createClient();
       const { init } = await import("./wrap");
 
-      init({ analytics: true, client, onError, onNotifyAppReady });
+      init({ insights: true, client, onError, onNotifyAppReady });
       await vi.runOnlyPendingTimersAsync();
 
-      expect(sendAnalyticsEvent).not.toHaveBeenCalled();
+      expect(sendInsightsEvent).not.toHaveBeenCalled();
       expect(onError).not.toHaveBeenCalled();
       expect(onNotifyAppReady).toHaveBeenCalledWith({ status: "UNCHANGED" });
       expect(warn).toHaveBeenCalledWith(
-        "[HotUpdater] Automatic notifyAppReady analytics failed:",
+        "[HotUpdater] Automatic notifyAppReady insights failed:",
         expect.any(Error),
       );
       warn.mockRestore();

package/src/{notifyAppReadyAnalytics.spec.ts → notifyAppReadyInsights.spec.ts}

@@ -1,13 +1,13 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 import type {
-  NotifyAppReadyAnalyticsEvent,
+  NotifyAppReadyInsightsEvent,
   NotifyAppReadyResult,
 } from "./native";
 import {
   createNotifyReadResult,
   stubNotifyFrame,
-} from "./notifyAppReadyAnalytics.test-utils";
+} from "./notifyAppReadyInsights.test-utils";
 
 vi.mock("react-native", () => ({
   Platform: { OS: "ios" },
@@ -25,7 +25,7 @@ const mocks = vi.hoisted(() => ({
   getPersistedUserIdentity: vi.fn(() => ({})),
   readNotifyAppReady: vi.fn<
     () => {
-      analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+      insightsEvent: NotifyAppReadyInsightsEvent | null;
       pending: boolean;
       result: NotifyAppReadyResult;
     }
@@ -51,20 +51,20 @@ vi.mock("./native", () => ({
 }));
 
 const createClient = () => {
-  const sendAnalyticsEvent = vi.fn().mockResolvedValue(undefined);
+  const sendInsightsEvent = vi.fn().mockResolvedValue(undefined);
   return {
     client: {
       createSession: vi.fn(async () => ({
         fetchReleaseCatalog: vi.fn(),
         resolveArtifact: vi.fn(),
-        sendAnalyticsEvent,
+        sendInsightsEvent,
       })),
     },
-    sendAnalyticsEvent,
+    sendInsightsEvent,
   };
 };
 
-describe("automatic notifyAppReady analytics", () => {
+describe("automatic notifyAppReady insights", () => {
   beforeEach(() => {
     vi.resetModules();
     vi.unstubAllGlobals();
@@ -107,12 +107,12 @@ describe("automatic notifyAppReady analytics", () => {
       ),
     );
 
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const onNotifyAppReady = vi.fn();
     const { init } = await import("./wrap");
 
     init({
-      analytics: true,
+      insights: true,
       onNotifyAppReady,
       requestHeaders: { Authorization: "Bearer token" },
       requestTimeout: 1000,
@@ -120,7 +120,7 @@ describe("automatic notifyAppReady analytics", () => {
     });
     await vi.runOnlyPendingTimersAsync();
 
-    expect(sendAnalyticsEvent).toHaveBeenCalledWith({
+    expect(sendInsightsEvent).toHaveBeenCalledWith({
       appVersion: "1.0.0",
       channel: "production",
       cohort: "123",
@@ -162,14 +162,14 @@ describe("automatic notifyAppReady analytics", () => {
         },
       ),
     );
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const onNotifyAppReady = vi.fn();
     const { init } = await import("./wrap");
 
-    init({ analytics: true, client, onNotifyAppReady });
+    init({ insights: true, client, onNotifyAppReady });
     await vi.runOnlyPendingTimersAsync();
 
-    expect(sendAnalyticsEvent).toHaveBeenCalledWith({
+    expect(sendInsightsEvent).toHaveBeenCalledWith({
       appVersion: "1.0.0",
       channel: "production",
       cohort: "123",
@@ -194,16 +194,16 @@ describe("automatic notifyAppReady analytics", () => {
 
   it("sends one UNCHANGED event for repeated init calls", async () => {
     stubNotifyFrame();
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const onNotifyAppReady = vi.fn();
     const { init } = await import("./wrap");
 
-    init({ analytics: true, client, onNotifyAppReady });
-    init({ analytics: true, client, onNotifyAppReady });
+    init({ insights: true, client, onNotifyAppReady });
+    init({ insights: true, client, onNotifyAppReady });
     await vi.runOnlyPendingTimersAsync();
 
-    expect(sendAnalyticsEvent).toHaveBeenCalledTimes(1);
-    expect(sendAnalyticsEvent).toHaveBeenCalledWith({
+    expect(sendInsightsEvent).toHaveBeenCalledTimes(1);
+    expect(sendInsightsEvent).toHaveBeenCalledWith({
       appVersion: "1.0.0",
       channel: "production",
       cohort: "123",
@@ -228,16 +228,16 @@ describe("automatic notifyAppReady analytics", () => {
     });
   });
 
-  it("skips automatic analytics when disabled while preserving readiness", async () => {
+  it("skips automatic insights when disabled while preserving readiness", async () => {
     stubNotifyFrame();
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const onNotifyAppReady = vi.fn();
     const { init } = await import("./wrap");
 
-    init({ analytics: false, client, onNotifyAppReady });
+    init({ insights: false, client, onNotifyAppReady });
     await vi.runOnlyPendingTimersAsync();
 
-    expect(sendAnalyticsEvent).not.toHaveBeenCalled();
+    expect(sendInsightsEvent).not.toHaveBeenCalled();
     expect(onNotifyAppReady).toHaveBeenCalledWith({ status: "UNCHANGED" });
   });
 });

package/src/{notifyAppReadyAnalytics.test-utils.ts → notifyAppReadyInsights.test-utils.ts}

@@ -1,20 +1,20 @@
 import { vi } from "vitest";
 
 import type {
-  NotifyAppReadyAnalyticsEvent,
+  NotifyAppReadyInsightsEvent,
   NotifyAppReadyResult,
 } from "./native";
 
 export const createNotifyReadResult = (
   result: NotifyAppReadyResult = { status: "UNCHANGED" },
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null = null,
+  insightsEvent: NotifyAppReadyInsightsEvent | null = null,
   pending = false,
 ): {
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+  insightsEvent: NotifyAppReadyInsightsEvent | null;
   pending: boolean;
   result: NotifyAppReadyResult;
 } => ({
-  analyticsEvent,
+  insightsEvent,
   pending,
   result,
 });

package/src/{notifyAppReadyAnalytics.transport.spec.ts → notifyAppReadyInsights.transport.spec.ts}

@@ -1,13 +1,13 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 
 import type {
-  NotifyAppReadyAnalyticsEvent,
+  NotifyAppReadyInsightsEvent,
   NotifyAppReadyResult,
 } from "./native";
 import {
   createNotifyReadResult,
   stubNotifyFrame,
-} from "./notifyAppReadyAnalytics.test-utils";
+} from "./notifyAppReadyInsights.test-utils";
 
 vi.mock("react-native", () => ({
   Platform: { OS: "ios" },
@@ -36,7 +36,7 @@ const mocks = vi.hoisted(() => ({
   getPersistedUserIdentity: vi.fn(() => ({})),
   readNotifyAppReady: vi.fn<
     () => {
-      analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+      insightsEvent: NotifyAppReadyInsightsEvent | null;
       pending: boolean;
       result: NotifyAppReadyResult;
     }
@@ -110,7 +110,7 @@ describe("automatic notifyAppReady transport failures", () => {
           "https://updates.example.test/hot-updater",
         );
 
-        init({ analytics: true, client, onError, onNotifyAppReady });
+        init({ insights: true, client, onError, onNotifyAppReady });
         await vi.runOnlyPendingTimersAsync();
 
         expect(fetchMock).toHaveBeenCalledTimes(1);
@@ -119,7 +119,7 @@ describe("automatic notifyAppReady transport failures", () => {
           status: "UNCHANGED",
         });
         expect(warn).toHaveBeenCalledWith(
-          "[HotUpdater] Automatic notifyAppReady analytics failed:",
+          "[HotUpdater] Automatic notifyAppReady insights failed:",
           expect.any(Error),
         );
       } finally {

package/src/{notifyAppReadyAnalytics.ts → notifyAppReadyInsights.ts}

@@ -1,7 +1,7 @@
 import { Platform } from "react-native";
 
 import type { HotUpdaterError } from "./error";
-import type { AnalyticsEventParams, HotUpdaterHttpClient } from "./httpClient";
+import type { InsightsEventParams, HotUpdaterHttpClient } from "./httpClient";
 import {
   getAppVersion,
   getBundleId,
@@ -10,13 +10,13 @@ import {
   getFingerprintHash,
   getInstallId,
   getPersistedUserIdentity,
-  type NotifyAppReadyAnalyticsEvent,
+  type NotifyAppReadyInsightsEvent,
   type NotifyAppReadyResult,
   readNotifyAppReady,
 } from "./native";
 
 export type NotifyAppReadyOptions = {
-  analytics?: boolean;
+  insights?: boolean;
   client: HotUpdaterHttpClient;
   requestHeaders?: Record<string, string>;
   requestTimeout?: number;
@@ -26,7 +26,7 @@ export type NotifyAppReadyOptions = {
 
 type RequestAnimationFrame = (callback: (timestamp: number) => void) => number;
 
-let didAttemptAutomaticAnalytics = false;
+let didAttemptAutomaticInsights = false;
 
 const waitForNextFrame = () =>
   new Promise<void>((resolve) => {
@@ -48,16 +48,16 @@ const assertNever = (value: never): never => {
   throw new Error(`[HotUpdater] Unexpected notifyAppReady status: ${value}`);
 };
 
-const buildNotifyAppReadyAnalyticsParams = (
+const buildNotifyAppReadyInsightsParams = (
   nativeResult: NotifyAppReadyResult,
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null,
+  insightsEvent: NotifyAppReadyInsightsEvent | null,
   options: Pick<NotifyAppReadyOptions, "requestHeaders" | "requestTimeout">,
-): AnalyticsEventParams => {
+): InsightsEventParams => {
   const appVersion = getAppVersion();
 
   if (!appVersion) {
     throw new Error(
-      "[HotUpdater] Automatic analytics requires a non-null native app version.",
+      "[HotUpdater] Automatic insights requires a non-null native app version.",
     );
   }
 
@@ -66,7 +66,7 @@ const buildNotifyAppReadyAnalyticsParams = (
 
   if (!installId) {
     throw new Error(
-      "[HotUpdater] Automatic analytics requires a non-null native install id.",
+      "[HotUpdater] Automatic insights requires a non-null native install id.",
     );
   }
 
@@ -78,12 +78,12 @@ const buildNotifyAppReadyAnalyticsParams = (
     channel: getChannel(),
     cohort: getCohort(),
     fingerprintHash: getFingerprintHash(),
-    fromReleaseId: analyticsEvent?.fromReleaseId ?? null,
+    fromReleaseId: insightsEvent?.fromReleaseId ?? null,
     installId,
     platform,
     requestHeaders: options.requestHeaders,
     requestTimeout: options.requestTimeout,
-    toReleaseId: analyticsEvent?.toReleaseId ?? null,
+    toReleaseId: insightsEvent?.toReleaseId ?? null,
     ...(userId != null ? { userId } : {}),
     ...(username != null ? { username } : {}),
   };
@@ -94,7 +94,7 @@ const buildNotifyAppReadyAnalyticsParams = (
 
       if (!bundleId) {
         throw new Error(
-          "[HotUpdater] Automatic analytics requires a non-null current bundle id.",
+          "[HotUpdater] Automatic insights requires a non-null current bundle id.",
         );
       }
 
@@ -108,57 +108,57 @@ const buildNotifyAppReadyAnalyticsParams = (
     }
     case "UPDATE_APPLIED":
     case "RECOVERED":
-      if (!analyticsEvent) {
+      if (!insightsEvent) {
         throw new Error(
-          "[HotUpdater] Native launch report is missing persisted metadata required for automatic analytics.",
+          "[HotUpdater] Native launch report is missing persisted metadata required for automatic insights.",
         );
       }
 
-      switch (analyticsEvent.type) {
+      switch (insightsEvent.type) {
         case "UPDATE_APPLIED":
           return {
             ...commonParams,
-            fromBundleId: analyticsEvent.fromBundleId,
-            toBundleId: analyticsEvent.toBundleId,
+            fromBundleId: insightsEvent.fromBundleId,
+            toBundleId: insightsEvent.toBundleId,
             type: "UPDATE_APPLIED",
-            updateStrategy: analyticsEvent.updateStrategy,
+            updateStrategy: insightsEvent.updateStrategy,
           };
         case "RECOVERED":
           return {
             ...commonParams,
-            fromBundleId: analyticsEvent.fromBundleId,
-            toBundleId: analyticsEvent.toBundleId,
+            fromBundleId: insightsEvent.fromBundleId,
+            toBundleId: insightsEvent.toBundleId,
             type: "RECOVERED",
-            updateStrategy: analyticsEvent.updateStrategy,
+            updateStrategy: insightsEvent.updateStrategy,
           };
         default:
-          return assertNever(analyticsEvent.type);
+          return assertNever(insightsEvent.type);
       }
     default:
       return assertNever(nativeResult);
   }
 };
 
-const maybeSendAutomaticAnalytics = async (
+const maybeSendAutomaticInsights = async (
   options: NotifyAppReadyOptions,
   nativeResult: NotifyAppReadyResult,
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null,
+  insightsEvent: NotifyAppReadyInsightsEvent | null,
 ): Promise<void> => {
-  if (!options.analytics || didAttemptAutomaticAnalytics) {
+  if (!options.insights || didAttemptAutomaticInsights) {
     return;
   }
 
-  didAttemptAutomaticAnalytics = true;
+  didAttemptAutomaticInsights = true;
 
-  if (nativeResult.status !== "UNCHANGED" && !analyticsEvent) {
+  if (nativeResult.status !== "UNCHANGED" && !insightsEvent) {
     throw new Error(
-      "[HotUpdater] Native launch report is missing persisted metadata required for automatic analytics.",
+      "[HotUpdater] Native launch report is missing persisted metadata required for automatic insights.",
     );
   }
 
   const session = await options.client.createSession();
-  await session.sendAnalyticsEvent(
-    buildNotifyAppReadyAnalyticsParams(nativeResult, analyticsEvent, options),
+  await session.sendInsightsEvent(
+    buildNotifyAppReadyInsightsParams(nativeResult, insightsEvent, options),
   );
 };
 
@@ -172,14 +172,14 @@ export const handleNotifyAppReady = async (
       nativeReadResult = readNotifyAppReady();
     } while (nativeReadResult.pending);
 
-    const { analyticsEvent, result: nativeResult } = nativeReadResult;
+    const { insightsEvent, result: nativeResult } = nativeReadResult;
 
     try {
-      await maybeSendAutomaticAnalytics(options, nativeResult, analyticsEvent);
+      await maybeSendAutomaticInsights(options, nativeResult, insightsEvent);
     } catch (error) {
       const warning = error instanceof Error ? error : new Error(String(error));
       console.warn(
-        "[HotUpdater] Automatic notifyAppReady analytics failed:",
+        "[HotUpdater] Automatic notifyAppReady insights failed:",
         warning,
       );
     }

package/src/sdkVersion.ts

@@ -1 +1 @@
-export const HOT_UPDATER_SDK_VERSION = "1.0.0-rc.0";
+export const HOT_UPDATER_SDK_VERSION = "1.0.0-rc.2";