@hot-updater/react-native 0.13.0 → 0.13.2

package/dist/index.d.ts

@@ -4,13 +4,106 @@ export type { HotUpdaterConfig } from "./wrap";
 export type { HotUpdaterEvent } from "./native";
 export * from "./store";
 export declare const HotUpdater: {
+    /**
+     * `HotUpdater.wrap` checks for updates at the entry point, and if there is a bundle to update, it downloads the bundle and applies the update strategy.
+     *
+     * @param {object} options - Configuration options
+     * @param {string} options.source - Update server URL
+     * @param {object} [options.requestHeaders] - Request headers
+     * @param {React.ComponentType} [options.fallbackComponent] - Component to display during updates
+     * @param {boolean} [options.reloadOnForceUpdate=true] - Whether to automatically reload the app on force updates
+     * @param {Function} [options.onUpdateProcessCompleted] - Callback after update process completes
+     * @param {Function} [options.onProgress] - Callback to track bundle download progress
+     * @returns {Function} Higher-order component that wraps the app component
+     *
+     * @example
+     * ```tsx
+     * export default HotUpdater.wrap({
+     *   source: "<your-update-server-url>",
+     *   requestHeaders: {
+     *     "Authorization": "Bearer <your-access-token>",
+     *   },
+     * })(App);
+     * ```
+     */
     wrap: typeof wrap;
+    /**
+     * Reloads the app.
+     */
     reload: () => void;
+    /**
+     * Fetches the current app version.
+     */
     getAppVersion: () => Promise<string | null>;
+    /**
+     * Fetches the current bundle ID of the app.
+     */
     getBundleId: () => string;
+    /**
+     * Retrieves the initial bundle ID based on the build time of the native app.
+     */
     getMinBundleId: () => string;
+    /**
+     * Fetches the current release channel of the app.
+     *
+     * By default, if no channel is specified, the app is assigned to the 'production' channel.
+     *
+     * @returns {string} The current release channel of the app
+     *
+     * @example
+     * ```ts
+     * const channel = HotUpdater.getChannel();
+     * console.log(`Current channel: ${channel}`);
+     * ```
+     */
     getChannel: () => string;
+    /**
+     * Adds a listener to HotUpdater events.
+     *
+     * @param {keyof HotUpdaterEvent} eventName - The name of the event to listen for
+     * @param {(event: HotUpdaterEvent[T]) => void} listener - The callback function to handle the event
+     * @returns {() => void} A cleanup function that removes the event listener
+     *
+     * @example
+     * ```ts
+     * const unsubscribe = HotUpdater.addListener("onProgress", ({ progress }) => {
+     *   console.log(`Update progress: ${progress * 100}%`);
+     * });
+     *
+     * // Unsubscribe when no longer needed
+     * unsubscribe();
+     * ```
+     */
     addListener: <T extends keyof import("./native").HotUpdaterEvent>(eventName: T, listener: (event: import("./native").HotUpdaterEvent[T]) => void) => () => void;
+    /**
+     * Manually checks for updates.
+     *
+     * @param {Object} config - Update check configuration
+     * @param {string} config.source - Update server URL
+     * @param {Record<string, string>} [config.requestHeaders] - Request headers
+     *
+     * @returns {Promise<UpdateInfo | null>} Update information or null if up to date
+     *
+     * @example
+     * ```ts
+     * const updateInfo = await HotUpdater.checkForUpdate({
+     *   source: "<your-update-server-url>",
+     *   requestHeaders: {
+     *     Authorization: "Bearer <your-access-token>",
+     *   },
+     * });
+     *
+     * if (!updateInfo) {
+     *   console.log("App is up to date");
+     *   return;
+     * }
+     *
+     * await HotUpdater.updateBundle(updateInfo.id, updateInfo.fileUrl);
+     * if (updateInfo.shouldForceUpdate) {
+     *   HotUpdater.reload();
+     * }
+     * ```
+     */
     checkForUpdate: typeof checkForUpdate;
     /**
      * Manually checks and applies updates for the application.
@@ -45,5 +138,34 @@ export declare const HotUpdater: {
      * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
      */
     runUpdateProcess: ({ reloadOnForceUpdate, ...checkForUpdateConfig }: import("./runUpdateProcess").RunUpdateProcessConfig) => Promise<import("./runUpdateProcess").RunUpdateProcessResponse>;
+    /**
+     * Updates the bundle of the app.
+     *
+     * @param {string} bundleId - The bundle ID of the app
+     * @param {string} zipUrl - The URL of the zip file
+     *
+     * @returns {Promise<boolean>} Whether the update was successful
+     *
+     * @example
+     * ```ts
+     * const updateInfo = await HotUpdater.checkForUpdate({
+     *   source: "<your-update-server-url>",
+     *   requestHeaders: {
+     *     Authorization: "Bearer <your-access-token>",
+     *   },
+     * });
+     *
+     * if (!updateInfo) {
+     *   return {
+     *     status: "UP_TO_DATE",
+     *   };
+     * }
+     *
+     * await HotUpdater.updateBundle(updateInfo.id, updateInfo.fileUrl);
+     * if (updateInfo.shouldForceUpdate) {
+     *   HotUpdater.reload();
+     * }
+     * ```
+     */
     updateBundle: (bundleId: string, zipUrl: string | null) => Promise<boolean>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hot-updater/react-native",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "description": "React Native OTA solution for self-hosted",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -81,8 +81,8 @@
   },
   "dependencies": {
     "use-sync-external-store": "1.4.0",
-    "@hot-updater/js": "0.13.0",
-    "@hot-updater/core": "0.13.0"
+    "@hot-updater/js": "0.13.2",
+    "@hot-updater/core": "0.13.2"
   },
   "scripts": {
     "build": "rslib build",

package/src/index.ts

@@ -24,15 +24,106 @@ addListener("onProgress", ({ progress }) => {
 });
 
 export const HotUpdater = {
+  /**
+   * `HotUpdater.wrap` checks for updates at the entry point, and if there is a bundle to update, it downloads the bundle and applies the update strategy.
+   *
+   * @param {object} options - Configuration options
+   * @param {string} options.source - Update server URL
+   * @param {object} [options.requestHeaders] - Request headers
+   * @param {React.ComponentType} [options.fallbackComponent] - Component to display during updates
+   * @param {boolean} [options.reloadOnForceUpdate=true] - Whether to automatically reload the app on force updates
+   * @param {Function} [options.onUpdateProcessCompleted] - Callback after update process completes
+   * @param {Function} [options.onProgress] - Callback to track bundle download progress
+   * @returns {Function} Higher-order component that wraps the app component
+   *
+   * @example
+   * ```tsx
+   * export default HotUpdater.wrap({
+   *   source: "<your-update-server-url>",
+   *   requestHeaders: {
+   *     "Authorization": "Bearer <your-access-token>",
+   *   },
+   * })(App);
+   * ```
+   */
   wrap,
-
+  /**
+   * Reloads the app.
+   */
   reload,
+  /**
+   * Fetches the current app version.
+   */
   getAppVersion,
+  /**
+   * Fetches the current bundle ID of the app.
+   */
   getBundleId,
+  /**
+   * Retrieves the initial bundle ID based on the build time of the native app.
+   */
   getMinBundleId,
+  /**
+   * Fetches the current release channel of the app.
+   *
+   * By default, if no channel is specified, the app is assigned to the 'production' channel.
+   *
+   * @returns {string} The current release channel of the app
+   *
+   * @example
+   * ```ts
+   * const channel = HotUpdater.getChannel();
+   * console.log(`Current channel: ${channel}`);
+   * ```
+   */
   getChannel,
+  /**
+   * Adds a listener to HotUpdater events.
+   *
+   * @param {keyof HotUpdaterEvent} eventName - The name of the event to listen for
+   * @param {(event: HotUpdaterEvent[T]) => void} listener - The callback function to handle the event
+   * @returns {() => void} A cleanup function that removes the event listener
+   *
+   * @example
+   * ```ts
+   * const unsubscribe = HotUpdater.addListener("onProgress", ({ progress }) => {
+   *   console.log(`Update progress: ${progress * 100}%`);
+   * });
+   *
+   * // Unsubscribe when no longer needed
+   * unsubscribe();
+   * ```
+   */
   addListener,
-
+  /**
+   * Manually checks for updates.
+   *
+   * @param {Object} config - Update check configuration
+   * @param {string} config.source - Update server URL
+   * @param {Record<string, string>} [config.requestHeaders] - Request headers
+   *
+   * @returns {Promise<UpdateInfo | null>} Update information or null if up to date
+   *
+   * @example
+   * ```ts
+   * const updateInfo = await HotUpdater.checkForUpdate({
+   *   source: "<your-update-server-url>",
+   *   requestHeaders: {
+   *     Authorization: "Bearer <your-access-token>",
+   *   },
+   * });
+   *
+   * if (!updateInfo) {
+   *   console.log("App is up to date");
+   *   return;
+   * }
+   *
+   * await HotUpdater.updateBundle(updateInfo.id, updateInfo.fileUrl);
+   * if (updateInfo.shouldForceUpdate) {
+   *   HotUpdater.reload();
+   * }
+   * ```
+   */
   checkForUpdate,
   /**
    * Manually checks and applies updates for the application.
@@ -67,5 +158,34 @@ export const HotUpdater = {
    * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
    */
   runUpdateProcess,
+  /**
+   * Updates the bundle of the app.
+   *
+   * @param {string} bundleId - The bundle ID of the app
+   * @param {string} zipUrl - The URL of the zip file
+   *
+   * @returns {Promise<boolean>} Whether the update was successful
+   *
+   * @example
+   * ```ts
+   * const updateInfo = await HotUpdater.checkForUpdate({
+   *   source: "<your-update-server-url>",
+   *   requestHeaders: {
+   *     Authorization: "Bearer <your-access-token>",
+   *   },
+   * });
+   *
+   * if (!updateInfo) {
+   *   return {
+   *     status: "UP_TO_DATE",
+   *   };
+   * }
+   *
+   * await HotUpdater.updateBundle(updateInfo.id, updateInfo.fileUrl);
+   * if (updateInfo.shouldForceUpdate) {
+   *   HotUpdater.reload();
+   * }
+   * ```
+   */
   updateBundle,
 };