@hot-updater/react-native 0.6.4 → 0.6.6

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { checkForUpdate } from "./checkUpdate";
 import { wrap } from "./wrap";
-export type * from "./wrap";
-export type * from "./native";
+export type { HotUpdaterConfig } from "./wrap";
+export type { HotUpdaterEvent } from "./native";
 export * from "./store";
 export declare const HotUpdater: {
     wrap: typeof wrap;
@@ -10,6 +10,38 @@ export declare const HotUpdater: {
     getBundleId: () => string;
     addListener: <T extends keyof import("./native").HotUpdaterEvent>(eventName: T, listener: (event: import("./native").HotUpdaterEvent[T]) => void) => () => void;
     checkForUpdate: typeof checkForUpdate;
+    /**
+     * Manually checks and applies updates for the application.
+     *
+     * @param {RunUpdateProcessConfig} config - Update process configuration
+     * @param {string} config.source - Update server URL
+     * @param {Record<string, string>} [config.requestHeaders] - Request headers
+     * @param {boolean} [config.reloadOnForceUpdate=false] - Whether to automatically reload on force update
+     *
+     * @example
+     * ```ts
+     * // Auto reload on force update
+     * const result = await HotUpdater.runUpdateProcess({
+     *   source: "<your-update-server-url>",
+     *   requestHeaders: {
+     *     // Add necessary headers
+     *   },
+     *   reloadOnForceUpdate: true
+     * });
+     *
+     * // Manually handle reload on force update
+     * const result = await HotUpdater.runUpdateProcess({
+     *   source: "<your-update-server-url>",
+     *   reloadOnForceUpdate: false
+     * });
+     *
+     * if(result.status !== "UP_TO_DATE" && result.shouldForceUpdate) {
+     *   HotUpdater.reload();
+     * }
+     * ```
+     *
+     * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
+     */
     runUpdateProcess: ({ reloadOnForceUpdate, ...checkForUpdateConfig }: import("./runUpdateProcess").RunUpdateProcessConfig) => Promise<import("./runUpdateProcess").RunUpdateProcessResponse>;
     updateBundle: (bundleId: string, zipUrl: string | null) => Promise<boolean>;
 };

package/dist/index.js

@@ -1664,9 +1664,9 @@ var __webpack_exports__ = {};
             this.name = "HotUpdaterError";
         }
     }
-    const core_namespaceObject = require("@hot-updater/core");
+    const NIL_UUID = "00000000-0000-0000-0000-000000000000";
     const HotUpdater = {
-        HOT_UPDATER_BUNDLE_ID: core_namespaceObject.NIL_UUID
+        HOT_UPDATER_BUNDLE_ID: NIL_UUID
     };
     const LINKING_ERROR = `The package '@hot-updater/react-native' doesn't seem to be linked. Make sure: \n\n` + external_react_native_.Platform.select({
         ios: "- You have run 'pod install'\n",

package/dist/index.mjs

@@ -1,7 +1,6 @@
 /*! For license information please see index.mjs.LICENSE.txt */
 import * as __WEBPACK_EXTERNAL_MODULE_react_native_4af9217e__ from "react-native";
 import * as __WEBPACK_EXTERNAL_MODULE__hot_updater_js_db235456__ from "@hot-updater/js";
-import * as __WEBPACK_EXTERNAL_MODULE__hot_updater_core_132f924c__ from "@hot-updater/core";
 var __webpack_modules__ = {
     "../../node_modules/.pnpm/react@18.3.1/node_modules/react/cjs/react.development.js": function(module, exports, __webpack_require__) {
         module = __webpack_require__.nmd(module);
@@ -1634,8 +1633,9 @@ class HotUpdaterError extends Error {
         this.name = "HotUpdaterError";
     }
 }
+const NIL_UUID = "00000000-0000-0000-0000-000000000000";
 const HotUpdater = {
-    HOT_UPDATER_BUNDLE_ID: __WEBPACK_EXTERNAL_MODULE__hot_updater_core_132f924c__.NIL_UUID
+    HOT_UPDATER_BUNDLE_ID: NIL_UUID
 };
 const LINKING_ERROR = `The package '@hot-updater/react-native' doesn't seem to be linked. Make sure: \n\n` + external_react_native_.Platform.select({
     ios: "- You have run 'pod install'\n",

package/dist/runUpdateProcess.d.ts

@@ -14,4 +14,36 @@ export interface RunUpdateProcessConfig extends CheckForUpdateConfig {
      */
     reloadOnForceUpdate?: boolean;
 }
+/**
+ * Manually checks and applies updates for the application.
+ *
+ * @param {RunUpdateProcessConfig} config - Update process configuration
+ * @param {string} config.source - Update server URL
+ * @param {Record<string, string>} [config.requestHeaders] - Request headers
+ * @param {boolean} [config.reloadOnForceUpdate=false] - Whether to automatically reload on force update
+ *
+ * @example
+ * ```ts
+ * // Auto reload on force update
+ * const result = await HotUpdater.runUpdateProcess({
+ *   source: "<your-update-server-url>",
+ *   requestHeaders: {
+ *     // Add necessary headers
+ *   },
+ *   reloadOnForceUpdate: true
+ * });
+ *
+ * // Manually handle reload on force update
+ * const result = await HotUpdater.runUpdateProcess({
+ *   source: "<your-update-server-url>",
+ *   reloadOnForceUpdate: false
+ * });
+ *
+ * if(result.status !== "UP_TO_DATE" && result.shouldForceUpdate) {
+ *   HotUpdater.reload();
+ * }
+ * ```
+ *
+ * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
+ */
 export declare const runUpdateProcess: ({ reloadOnForceUpdate, ...checkForUpdateConfig }: RunUpdateProcessConfig) => Promise<RunUpdateProcessResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hot-updater/react-native",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "description": "React Native OTA solution for self-hosted",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -78,8 +78,8 @@
     "react-native-builder-bob": "^0.33.1"
   },
   "dependencies": {
-    "@hot-updater/js": "0.6.4",
-    "@hot-updater/core": "0.6.4"
+    "@hot-updater/js": "0.6.6",
+    "@hot-updater/core": "0.6.6"
   },
   "scripts": {
     "build": "rslib build",

package/src/index.ts

@@ -10,8 +10,8 @@ import { runUpdateProcess } from "./runUpdateProcess";
 import { hotUpdaterStore } from "./store";
 import { wrap } from "./wrap";
 
-export type * from "./wrap";
-export type * from "./native";
+export type { HotUpdaterConfig } from "./wrap";
+export type { HotUpdaterEvent } from "./native";
 
 export * from "./store";
 
@@ -28,6 +28,38 @@ export const HotUpdater = {
   addListener,
 
   checkForUpdate,
+  /**
+   * Manually checks and applies updates for the application.
+   *
+   * @param {RunUpdateProcessConfig} config - Update process configuration
+   * @param {string} config.source - Update server URL
+   * @param {Record<string, string>} [config.requestHeaders] - Request headers
+   * @param {boolean} [config.reloadOnForceUpdate=false] - Whether to automatically reload on force update
+   *
+   * @example
+   * ```ts
+   * // Auto reload on force update
+   * const result = await HotUpdater.runUpdateProcess({
+   *   source: "<your-update-server-url>",
+   *   requestHeaders: {
+   *     // Add necessary headers
+   *   },
+   *   reloadOnForceUpdate: true
+   * });
+   *
+   * // Manually handle reload on force update
+   * const result = await HotUpdater.runUpdateProcess({
+   *   source: "<your-update-server-url>",
+   *   reloadOnForceUpdate: false
+   * });
+   *
+   * if(result.status !== "UP_TO_DATE" && result.shouldForceUpdate) {
+   *   HotUpdater.reload();
+   * }
+   * ```
+   *
+   * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
+   */
   runUpdateProcess,
   updateBundle,
 };

package/src/native.ts

@@ -1,6 +1,7 @@
-import { NIL_UUID } from "@hot-updater/core";
 import { NativeEventEmitter, NativeModules, Platform } from "react-native";
 
+const NIL_UUID = "00000000-0000-0000-0000-000000000000";
+
 const HotUpdater = {
   HOT_UPDATER_BUNDLE_ID: NIL_UUID,
 };

package/src/runUpdateProcess.ts

@@ -20,6 +20,38 @@ export interface RunUpdateProcessConfig extends CheckForUpdateConfig {
   reloadOnForceUpdate?: boolean;
 }
 
+/**
+ * Manually checks and applies updates for the application.
+ *
+ * @param {RunUpdateProcessConfig} config - Update process configuration
+ * @param {string} config.source - Update server URL
+ * @param {Record<string, string>} [config.requestHeaders] - Request headers
+ * @param {boolean} [config.reloadOnForceUpdate=false] - Whether to automatically reload on force update
+ *
+ * @example
+ * ```ts
+ * // Auto reload on force update
+ * const result = await HotUpdater.runUpdateProcess({
+ *   source: "<your-update-server-url>",
+ *   requestHeaders: {
+ *     // Add necessary headers
+ *   },
+ *   reloadOnForceUpdate: true
+ * });
+ *
+ * // Manually handle reload on force update
+ * const result = await HotUpdater.runUpdateProcess({
+ *   source: "<your-update-server-url>",
+ *   reloadOnForceUpdate: false
+ * });
+ *
+ * if(result.status !== "UP_TO_DATE" && result.shouldForceUpdate) {
+ *   HotUpdater.reload();
+ * }
+ * ```
+ *
+ * @returns {Promise<RunUpdateProcessResponse>} The result of the update process
+ */
 export const runUpdateProcess = async ({
   reloadOnForceUpdate = false,
   ...checkForUpdateConfig