react-native-ota-hot-update 2.3.6 → 2.4.0-rc.1

package/src/index.d.ts

@@ -1,5 +1,8 @@
 import type { DownloadManager } from './download';
-import type { UpdateGitOption, UpdateOption } from './type';
+import type { UpdateGitOption, UpdateOption, BundleInfo } from './type';
+
+// Re-export types for external use
+export type { BundleInfo, UpdateOption, UpdateGitOption } from './type';
 
 export interface GitModule {
   checkForGitUpdate(options: UpdateGitOption): Promise<void>;
@@ -24,8 +27,9 @@ export interface OtaHotUpdate {
    * Set up the path to the downloaded bundle file.
    * @param path - The path to the bundle file.
    * @param extension - Optional extension for the bundle file.
+   * @param version - Optional version number to include in folder name.
    */
-  setupBundlePath(path: string, extension?: string): Promise<boolean>;
+  setupBundlePath(path: string, extension?: string, version?: number): Promise<boolean>;
 
   /**
    * Set up an exact path to the bundle file for the update.
@@ -69,6 +73,25 @@ export interface OtaHotUpdate {
    */
   setCurrentVersion(version: number): Promise<boolean>;
 
+  /**
+   * Get the list of all bundle versions.
+   * @returns Array of bundle information including id, version, date, path, isActive, and metadata.
+   */
+  getBundleList(): Promise<BundleInfo[]>;
+
+  /**
+   * Delete a bundle by its identifier (folder name).
+   * @param id - The bundle identifier (folder name).
+   * @returns True if the bundle was successfully deleted, false otherwise.
+   */
+  deleteBundleById(id: string): Promise<boolean>;
+
+  /**
+   * Clear all bundles from history.
+   * @returns True if all bundles were successfully cleared, false otherwise.
+   */
+  clearAllBundles(): Promise<boolean>;
+
   /**
    * Git-related operations.
    */

package/src/index.tsx

@@ -1,6 +1,6 @@
 import { NativeModules, Platform } from 'react-native';
 import type { DownloadManager } from './download';
-import type { UpdateGitOption, UpdateOption } from './type';
+import type { UpdateGitOption, UpdateOption, BundleInfo } from './type';
 import git from './gits';
 
 const LINKING_ERROR =
@@ -48,8 +48,15 @@ const downloadBundleFile = async (
     });
   return res.path();
 };
-function setupBundlePath(path: string, extension?: string): Promise<boolean> {
-  return RNhotupdate.setupBundlePath(path, extension);
+function setupBundlePath(
+  path: string,
+  extension?: string,
+  version?: number,
+  maxVersions?: number,
+  metadata?: any
+): Promise<boolean> {
+  const metadataString = metadata ? JSON.stringify(metadata) : undefined;
+  return RNhotupdate.setupBundlePath(path, extension, version, maxVersions, metadataString);
 }
 function setupExactBundlePath(path: string): Promise<boolean> {
   return RNhotupdate.setExactBundlePath(path);
@@ -140,8 +147,7 @@ async function downloadBundleUri(
     if (!path) {
       return installFail(option, `Cannot download bundle file: ${path}`);
     }
-
-    const success = await setupBundlePath(path, option?.extensionBundle);
+    const success = await setupBundlePath(path, option?.extensionBundle, version, option?.maxBundleVersions, option?.metadata);
     if (!success) {
       return installFail(option);
     }
@@ -213,6 +219,28 @@ const checkForGitUpdate = async (options: UpdateGitOption) => {
     options?.onFinishProgress?.();
   }
 };
+function getBundleList(): Promise<BundleInfo[]> {
+  return RNhotupdate.getBundleList(0).then((jsonString: string) => {
+    try {
+      const data = JSON.parse(jsonString);
+      return data.map((item: any) => ({
+        ...item,
+        date: new Date(item.date),
+      }));
+    } catch (error) {
+      return Promise.reject(new Error('Error parsing bundle list'));
+    }
+  });
+}
+
+function deleteBundleById(id: string): Promise<boolean> {
+  return RNhotupdate.deleteBundleById(id);
+}
+
+function clearAllBundles(): Promise<boolean> {
+  return RNhotupdate.clearAllBundles(0);
+}
+
 export default {
   setupBundlePath,
   setupExactBundlePath,
@@ -224,6 +252,9 @@ export default {
   getUpdateMetadata,
   setUpdateMetadata,
   rollbackToPreviousBundle,
+  getBundleList,
+  deleteBundleById,
+  clearAllBundles,
   git: {
     checkForGitUpdate,
     ...git,

package/src/type.ts

@@ -45,7 +45,50 @@ export interface UpdateOption {
    * Metadata for the update.
    * Can contain information such as version details, description, etc.
    */
-  metadata?: any
+  metadata?: any;
+
+  /**
+   * Maximum number of bundle versions to keep in history.
+   * Default: 2 (backward compatible).
+   * If the number of bundles exceeds this value, older bundles will be automatically deleted.
+   */
+  maxBundleVersions?: number;
+}
+
+/**
+ * Information about a bundle version.
+ */
+export interface BundleInfo {
+  /**
+   * Bundle identifier (folder name).
+   * Example: "output_v5_2025_01_25_14_30"
+   */
+  id: string;
+
+  /**
+   * Version number of the bundle.
+   */
+  version: number;
+
+  /**
+   * Date when the bundle was created.
+   */
+  date: Date;
+
+  /**
+   * Full path to the bundle file.
+   */
+  path: string;
+
+  /**
+   * Whether this bundle is currently active.
+   */
+  isActive: boolean;
+
+  /**
+   * Optional metadata associated with the bundle.
+   */
+  metadata?: any;
 }
 
 /**