@hot-updater/react-native 0.1.6-0 → 0.3.0

package/dist/index.mjs.LICENSE.txt

@@ -0,0 +1,19 @@
+/**
+ * @license React
+ * react.development.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * react.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

package/dist/native.d.ts

@@ -0,0 +1,29 @@
+export type HotUpdaterEvent = {
+    onProgress: {
+        progress: number;
+    };
+};
+export declare const addListener: <T extends keyof HotUpdaterEvent>(eventName: T, listener: (event: HotUpdaterEvent[T]) => void) => void;
+/**
+ * Downloads files from given URLs.
+ *
+ * @param {string} bundleId - identifier for the bundle version.
+ * @param {string | null} zipUrl - zip file URL.
+ * @returns {Promise<boolean>} Resolves with true if download was successful, otherwise rejects with an error.
+ */
+export declare const updateBundle: (bundleId: string, zipUrl: string | null) => Promise<boolean>;
+/**
+ * Fetches the current app version.
+ */
+export declare const getAppVersion: () => Promise<string | null>;
+/**
+ * Reloads the app.
+ */
+export declare const reload: () => void;
+/**
+ * Fetches the current bundle version id.
+ *
+ * @async
+ * @returns {Promise<string>} Resolves with the current version id or null if not available.
+ */
+export declare const getBundleId: () => string;

package/dist/store.d.ts

@@ -0,0 +1,9 @@
+export type HotUpdaterState = {
+    progress: number;
+};
+export declare const hotUpdaterStore: {
+    getState: () => HotUpdaterState;
+    setState: (newState: Partial<HotUpdaterState>) => void;
+    subscribe: (listener: () => void) => () => boolean;
+};
+export declare const useHotUpdaterStore: () => HotUpdaterState;

package/dist/wrap.d.ts

@@ -0,0 +1,20 @@
+import type { BundleArg, UpdateInfo } from "@hot-updater/core";
+import type React from "react";
+import { HotUpdaterError } from "./error";
+export type HotUpdaterStatus = "INSTALLING_UPDATE" | "UP_TO_DATE" | "UPDATING";
+export interface CheckUpdateConfig {
+    source: BundleArg;
+    requestHeaders?: Record<string, string>;
+}
+export interface HotUpdaterConfig extends CheckUpdateConfig {
+    fallbackComponent?: React.FC<HotUpdaterFallbackProps>;
+}
+export interface HotUpdaterFallbackProps {
+    progress: number;
+}
+export interface WithHotUpdaterProps {
+    updateStatus: HotUpdaterStatus | null;
+    updateError: HotUpdaterError | null;
+}
+export declare function checkUpdate(config: CheckUpdateConfig): Promise<UpdateInfo | null>;
+export declare function wrap<P>(config: HotUpdaterConfig): (WrappedComponent: React.ComponentType<P & WithHotUpdaterProps>) => React.ComponentType<P>;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@hot-updater/react-native",
-  "version": "0.1.6-0",
+  "version": "0.3.0",
   "description": "React Native OTA solution for self-hosted",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "source": "src/index.ts",
   "react-native": "src/index.ts",
   "types": "dist/index.d.ts",
@@ -73,13 +73,13 @@
     "react": "18.3.1",
     "react-native": "0.76.2",
     "react-native-builder-bob": "^0.33.1",
-    "@hot-updater/js": "0.1.6-0"
+    "@hot-updater/js": "0.3.0"
   },
   "dependencies": {
-    "@hot-updater/core": "0.1.6-0"
+    "@hot-updater/core": "0.3.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "build": "rslib build",
     "test:type": "tsc --noEmit",
     "test": "vitest",
     "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib"

package/src/ensureUpdateInfo.ts

@@ -0,0 +1,36 @@
+import type {
+  Bundle,
+  BundleArg,
+  GetBundlesArgs,
+  UpdateInfo,
+} from "@hot-updater/core";
+
+export const ensureUpdateInfo = async (
+  source: BundleArg,
+  { appVersion, bundleId, platform }: GetBundlesArgs,
+  requestHeaders?: Record<string, string>,
+): Promise<Bundle[] | UpdateInfo> => {
+  try {
+    let bundles: Bundle[] | null = null;
+    if (typeof source === "string") {
+      if (source.startsWith("http")) {
+        return await fetch(source, {
+          headers: {
+            "x-app-platform": platform,
+            "x-app-version": appVersion,
+            "x-bundle-id": bundleId,
+            ...requestHeaders,
+          },
+        }).then((res) => res.json());
+      }
+    } else if (typeof source === "function") {
+      bundles = await source();
+    } else {
+      bundles = source;
+    }
+
+    return bundles ?? [];
+  } catch {
+    return [];
+  }
+};

package/src/index.ts

@@ -1,7 +1,5 @@
-import { NIL_UUID } from "@hot-updater/core";
 import { getUpdateInfo } from "@hot-updater/js";
-import { ensureBundles } from "./ensureBundles";
-import { init } from "./init";
+import { ensureUpdateInfo } from "./ensureUpdateInfo";
 import {
   addListener,
   getAppVersion,
@@ -10,8 +8,9 @@ import {
   updateBundle,
 } from "./native";
 import { hotUpdaterStore } from "./store";
+import { wrap } from "./wrap";
 
-export type * from "./init";
+export type * from "./wrap";
 export type * from "./native";
 
 export * from "./store";
@@ -21,17 +20,14 @@ addListener("onProgress", ({ progress }) => {
 });
 
 export const HotUpdater = {
-  init,
+  wrap,
+
   reload,
   getAppVersion,
   getBundleId,
   addListener,
 
-  ensureBundles,
+  ensureUpdateInfo,
   updateBundle,
   getUpdateInfo,
-  /**
-   * In production environment, this value will be replaced with a uuidv7.
-   */
-  HOT_UPDATER_BUNDLE_ID: NIL_UUID,
 };

package/src/native.ts

@@ -1,6 +1,10 @@
 import { NIL_UUID } from "@hot-updater/core";
 import { NativeEventEmitter, NativeModules, Platform } from "react-native";
 
+const HotUpdater = {
+  HOT_UPDATER_BUNDLE_ID: NIL_UUID,
+};
+
 const LINKING_ERROR =
   // biome-ignore lint/style/useTemplate: <explanation>
   `The package '@hot-updater/react-native' doesn't seem to be linked. Make sure: \n\n` +
@@ -41,16 +45,6 @@ export const addListener = <T extends keyof HotUpdaterEvent>(
   eventEmitter?.addListener(eventName, listener);
 };
 
-/**
- * Fetches the current bundle version id.
- *
- * @async
- * @returns {Promise<string>} Resolves with the current version id or null if not available.
- */
-export const getBundleId = (): string => {
-  return HotUpdater.HOT_UPDATER_BUNDLE_ID ?? NIL_UUID;
-};
-
 /**
  * Downloads files from given URLs.
  *
@@ -78,3 +72,13 @@ export const getAppVersion = (): Promise<string | null> => {
 export const reload = () => {
   HotUpdaterNative.reload();
 };
+
+/**
+ * Fetches the current bundle version id.
+ *
+ * @async
+ * @returns {Promise<string>} Resolves with the current version id or null if not available.
+ */
+export const getBundleId = (): string => {
+  return HotUpdater.HOT_UPDATER_BUNDLE_ID;
+};

package/src/wrap.tsx

@@ -0,0 +1,148 @@
+import type { Bundle, BundleArg, UpdateInfo } from "@hot-updater/core";
+import { getUpdateInfo } from "@hot-updater/js";
+import type React from "react";
+import { useEffect, useState } from "react";
+import { Platform } from "react-native";
+import { ensureUpdateInfo } from "./ensureUpdateInfo";
+import { HotUpdaterError } from "./error";
+import { getAppVersion, getBundleId, reload, updateBundle } from "./native";
+import { useHotUpdaterStore } from "./store";
+
+export type HotUpdaterStatus = "INSTALLING_UPDATE" | "UP_TO_DATE" | "UPDATING";
+
+export interface CheckUpdateConfig {
+  source: BundleArg;
+  requestHeaders?: Record<string, string>;
+}
+
+export interface HotUpdaterConfig extends CheckUpdateConfig {
+  fallbackComponent?: React.FC<HotUpdaterFallbackProps>;
+}
+
+export interface HotUpdaterFallbackProps {
+  progress: number;
+}
+
+export interface WithHotUpdaterProps {
+  updateStatus: HotUpdaterStatus | null;
+  updateError: HotUpdaterError | null;
+}
+
+export async function checkUpdate(config: CheckUpdateConfig) {
+  if (__DEV__) {
+    console.warn(
+      "[HotUpdater] __DEV__ is true, HotUpdater is only supported in production",
+    );
+    return null;
+  }
+
+  if (!["ios", "android"].includes(Platform.OS)) {
+    throw new HotUpdaterError(
+      "HotUpdater is only supported on iOS and Android",
+    );
+  }
+
+  const currentAppVersion = await getAppVersion();
+  const platform = Platform.OS as "ios" | "android";
+  const currentBundleId = await getBundleId();
+
+  if (!currentAppVersion) {
+    throw new HotUpdaterError("Failed to get app version");
+  }
+
+  const ensuredUpdateInfo = await ensureUpdateInfo(
+    config.source,
+    {
+      appVersion: currentAppVersion,
+      bundleId: currentBundleId,
+      platform,
+    },
+    config.requestHeaders,
+  );
+
+  let updateInfo: UpdateInfo | null = null;
+  if (Array.isArray(ensuredUpdateInfo)) {
+    const bundles: Bundle[] = ensuredUpdateInfo;
+
+    updateInfo = await getUpdateInfo(bundles, {
+      appVersion: currentAppVersion,
+      bundleId: currentBundleId,
+      platform,
+    });
+  } else {
+    updateInfo = ensuredUpdateInfo;
+  }
+
+  return updateInfo;
+}
+
+async function installUpdate(updateInfo: UpdateInfo) {
+  const isSuccess = await updateBundle(updateInfo.id, updateInfo.fileUrl || "");
+
+  if (isSuccess && updateInfo.forceUpdate) {
+    reload();
+    return true;
+  }
+
+  return isSuccess;
+}
+
+export function wrap<P>(
+  config: HotUpdaterConfig,
+): (
+  WrappedComponent: React.ComponentType<P & WithHotUpdaterProps>,
+) => React.ComponentType<P> {
+  return (WrappedComponent) => {
+    const HotUpdaterHOC: React.FC<P> = (props) => {
+      const [updateStatus, setUpdateStatus] = useState<HotUpdaterStatus | null>(
+        null,
+      );
+      const [updateError, setUpdateError] = useState<HotUpdaterError | null>(
+        null,
+      );
+
+      const { progress } = useHotUpdaterStore();
+
+      useEffect(() => {
+        const initHotUpdater = async () => {
+          try {
+            const updateInfo = await checkUpdate(config);
+
+            if (!updateInfo) {
+              setUpdateStatus("UP_TO_DATE");
+              return;
+            }
+
+            setUpdateStatus("UPDATING");
+            const isSuccess = await installUpdate(updateInfo);
+            if (isSuccess) {
+              setUpdateStatus("INSTALLING_UPDATE");
+            }
+          } catch (error) {
+            if (error instanceof HotUpdaterError) {
+              setUpdateError(error);
+            }
+            throw error;
+          }
+        };
+
+        initHotUpdater();
+      }, [config.source, config.requestHeaders]);
+
+      if (updateStatus === "UPDATING" && config.fallbackComponent) {
+        const Fallback = config.fallbackComponent;
+        return <Fallback progress={progress} />;
+      }
+
+      return (
+        <WrappedComponent
+          {...props}
+          updateStatus={updateStatus}
+          updateError={updateError}
+        />
+      );
+    };
+
+    return HotUpdaterHOC;
+  };
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Sungyu Kang 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/index.d.mts

@@ -1,71 +0,0 @@
-import * as _hot_updater_core from '@hot-updater/core';
-import { BundleArg } from '@hot-updater/core';
-
-type HotUpdaterEvent = {
-    onProgress: {
-        progress: number;
-    };
-};
-declare const addListener: <T extends keyof HotUpdaterEvent>(eventName: T, listener: (event: HotUpdaterEvent[T]) => void) => void;
-/**
- * Fetches the current bundle version id.
- *
- * @async
- * @returns {Promise<string>} Resolves with the current version id or null if not available.
- */
-declare const getBundleId: () => string;
-/**
- * Downloads files from given URLs.
- *
- * @param {string} bundleId - identifier for the bundle version.
- * @param {string | null} zipUrl - zip file URL.
- * @returns {Promise<boolean>} Resolves with true if download was successful, otherwise rejects with an error.
- */
-declare const updateBundle: (bundleId: string, zipUrl: string | null) => Promise<boolean>;
-/**
- * Fetches the current app version.
- */
-declare const getAppVersion: () => Promise<string | null>;
-/**
- * Reloads the app.
- */
-declare const reload: () => void;
-
-declare class HotUpdaterError extends Error {
-    constructor(message: string);
-}
-
-type HotUpdaterStatus = "INSTALLING_UPDATE" | "UP_TO_DATE";
-interface HotUpdaterInitConfig {
-    source: BundleArg;
-    onSuccess?: (status: HotUpdaterStatus) => void;
-    onError?: (error: HotUpdaterError) => void;
-}
-declare const init: (config: HotUpdaterInitConfig) => Promise<void>;
-
-type HotUpdaterState = {
-    progress: number;
-};
-declare const hotUpdaterStore: {
-    getState: () => HotUpdaterState;
-    setState: (newState: Partial<HotUpdaterState>) => void;
-    subscribe: (listener: () => void) => () => boolean;
-};
-declare const useHotUpdaterStore: () => HotUpdaterState;
-
-declare const HotUpdater: {
-    init: (config: HotUpdaterInitConfig) => Promise<void>;
-    reload: () => void;
-    getAppVersion: () => Promise<string | null>;
-    getBundleId: () => string;
-    addListener: <T extends keyof HotUpdaterEvent>(eventName: T, listener: (event: HotUpdaterEvent[T]) => void) => void;
-    ensureBundles: (bundle: _hot_updater_core.BundleArg) => Promise<_hot_updater_core.Bundle[]>;
-    updateBundle: (bundleId: string, zipUrl: string | null) => Promise<boolean>;
-    getUpdateInfo: (bundles: _hot_updater_core.Bundle[], { platform, bundleId, appVersion }: _hot_updater_core.GetBundlesArgs) => Promise<_hot_updater_core.UpdateInfo | null>;
-    /**
-     * In production environment, this value will be replaced with a uuidv7.
-     */
-    HOT_UPDATER_BUNDLE_ID: string;
-};
-
-export { HotUpdater, type HotUpdaterEvent, type HotUpdaterInitConfig, type HotUpdaterState, type HotUpdaterStatus, addListener, getAppVersion, getBundleId, hotUpdaterStore, init, reload, updateBundle, useHotUpdaterStore };

package/src/ensureBundles.ts

@@ -1,21 +0,0 @@
-import type { Bundle, BundleArg } from "@hot-updater/core";
-
-export const ensureBundles = async (bundle: BundleArg) => {
-  try {
-    let bundles: Bundle[] | null = null;
-    if (typeof bundle === "string") {
-      if (bundle.startsWith("http")) {
-        const response = await fetch(bundle);
-        bundles = (await response.json()) as Bundle[];
-      }
-    } else if (typeof bundle === "function") {
-      bundles = await bundle();
-    } else {
-      bundles = bundle;
-    }
-
-    return bundles ?? [];
-  } catch {
-    return [];
-  }
-};

package/src/init.tsx

@@ -1,69 +0,0 @@
-import type { BundleArg } from "@hot-updater/core";
-import { getUpdateInfo } from "@hot-updater/js";
-import { Platform } from "react-native";
-import { ensureBundles } from "./ensureBundles";
-import { HotUpdaterError } from "./error";
-import { getAppVersion, getBundleId, reload, updateBundle } from "./native";
-
-export type HotUpdaterStatus = "INSTALLING_UPDATE" | "UP_TO_DATE";
-
-export interface HotUpdaterInitConfig {
-  source: BundleArg;
-  onSuccess?: (status: HotUpdaterStatus) => void;
-  onError?: (error: HotUpdaterError) => void;
-}
-
-export const init = async (config: HotUpdaterInitConfig) => {
-  if (__DEV__) {
-    console.warn(
-      "[HotUpdater] __DEV__ is true, HotUpdater is only supported in production",
-    );
-    return;
-  }
-
-  if (!["ios", "android"].includes(Platform.OS)) {
-    const error = new HotUpdaterError(
-      "HotUpdater is only supported on iOS and Android",
-    );
-
-    config?.onError?.(error);
-    throw error;
-  }
-
-  const currentAppVersion = await getAppVersion();
-  const platform = Platform.OS as "ios" | "android";
-  const currentBundleId = await getBundleId();
-
-  if (!currentAppVersion) {
-    const error = new HotUpdaterError("Failed to get app version");
-    config?.onError?.(error);
-    throw error;
-  }
-
-  const bundles = await ensureBundles(config.source);
-
-  const update = await getUpdateInfo(bundles, {
-    appVersion: currentAppVersion,
-    bundleId: currentBundleId,
-    platform,
-  });
-
-  if (!update) {
-    config?.onSuccess?.("UP_TO_DATE");
-    return;
-  }
-
-  try {
-    const isSuccess = await updateBundle(update.id, update.fileUrl || "");
-    if (isSuccess && update.forceUpdate) {
-      reload();
-
-      config?.onSuccess?.("INSTALLING_UPDATE");
-    }
-  } catch (error) {
-    if (error instanceof HotUpdaterError) {
-      config?.onError?.(error);
-    }
-    throw error;
-  }
-};