react-native-ota-hot-update 2.0.3 → 2.0.4

package/lib/typescript/module/src/type.d.ts

@@ -0,0 +1,145 @@
+export interface UpdateOption {
+    /**
+     * Optional headers to include with the update request.
+     * Typically used for authentication or custom metadata.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Callback to track download progress.
+     * @param received - Number of bytes received.
+     * @param total - Total number of bytes to be downloaded.
+     */
+    progress?(received: string, total: string): void;
+    /**
+     * Callback triggered when the update succeeds.
+     */
+    updateSuccess?(): void;
+    /**
+     * Callback triggered when the update fails.
+     * @param message - Optional error message or object describing the failure.
+     */
+    updateFail?(message?: string | Error): void;
+    /**
+     * Indicates whether the app should restart after installing the update.
+     * Default: `false`.
+     */
+    restartAfterInstall?: boolean;
+    /**
+     * Custom extension for the bundle file, if applicable.
+     * For example: '.jsbundle'.
+     */
+    extensionBundle?: string;
+}
+/**
+ * Options for updating a Git repository.
+ */
+export interface UpdateGitOption {
+    /**
+     * The URL of the Git repository to check update.
+     */
+    url: string;
+    /**
+     * Optional callback to monitor the progress of the update.
+     * @param received - The number of bytes received so far.
+     * @param total - The total number of bytes to be received.
+     */
+    onProgress?(received: number, total: number): void;
+    /**
+     * Optional branch name to update or switch to.
+     * If not specified, the default branch will be main.
+     */
+    branch?: string;
+    /**
+     * Optional name of the folder where the repository will be cloned or updated.
+     * If not specified, a default folder name will be git_hot_update.
+     */
+    folderName?: string;
+    /**
+     * Optional callback when pull success, should handle for case update.
+     */
+    onPullSuccess?(): void;
+    /**
+     * Optional callback when pull failed.
+     */
+    onPullFailed?(msg: string): void;
+    /**
+     * Optional callback when clone success, handle it in the first time clone.
+     */
+    onCloneSuccess?(): void;
+    /**
+     * Optional callback when clone failed.
+     */
+    onCloneFailed?(msg: string): void;
+    /**
+     * The bundle path of the Git repository, it should place at root.
+     * Eg: the folder name is git_hot_update, bundle file place at git_hot_update/output/main.jsbundle, so bundlePath should be: "output/main.jsbundle".
+     */
+    bundlePath: string;
+    /**
+     * Optional restart app after clone / pull success for apply the new bundle.
+     */
+    restartAfterInstall?: boolean;
+    /**
+     * Optional when all process success, use for set loading false.
+     */
+    onFinishProgress?(): void;
+}
+export interface CloneOption {
+    /**
+     * The Git repository URL to be cloned.
+     * Example: "https://github.com/user/repo.git".
+     */
+    url: string;
+    /**
+     * Optional name of the folder where the repository will be cloned.
+     * If not provided, the repository name git_hot_update will be used.
+     */
+    folderName?: string;
+    /**
+     * Callback to track the progress of the cloning process.
+     * @param received - Number of bytes received so far.
+     * @param total - Total number of bytes to be downloaded.
+     */
+    onProgress?(received: number, total: number): void;
+    /**
+     * The branch to be checked out after cloning.
+     * Defaults to the repository's default branch if not specified.
+     */
+    branch?: string;
+    /**
+     * The bundle path of the Git repository, it should place at root.
+     * Eg: the folder name is git_hot_update, bundle file place at git_hot_update/output/main.jsbundle, so bundlePath should be: "output/main.jsbundle".
+     */
+    bundlePath: string;
+    /**
+     * Optional username to set up the Git user configuration.
+     * Used for operations like committing or signing, not for authentication.
+     * Example: "John Doe".
+     */
+    userName?: string;
+    /**
+     * Optional email to set up the Git user configuration.
+     * Used for operations like committing or signing, not for authentication.
+     * Example: "john.doe@example.com".
+     */
+    email?: string;
+}
+export interface PullOption {
+    /**
+     * Optional name of the folder containing the Git repository to pull from.
+     * Defaults to the current directory if not specified.
+     */
+    folderName?: string;
+    /**
+     * Callback to track the progress of the pull operation.
+     * @param received - Number of bytes received so far.
+     * @param total - Total number of bytes to be downloaded.
+     */
+    onProgress?(received: number, total: number): void;
+    /**
+     * The name of the branch to pull updates from.
+     * This branch must exist in the remote repository.
+     */
+    branch: string;
+}
+//# sourceMappingURL=type.d.ts.map

package/lib/typescript/module/src/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../../../src/type.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,aAAa,CAAC,IAAI,IAAI,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,UAAU,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,IAAI,IAAI,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC;;OAEG;IACH,cAAc,CAAC,IAAI,IAAI,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,gBAAgB,CAAC,IAAI,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-ota-hot-update",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Hot update for react native",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
@@ -69,6 +69,10 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "dependencies": {
+    "buffer": "^6.0.3",
+    "isomorphic-git": "git+https://github.com/vantuan88291/isomorphic-git.git"
+  },
   "devDependencies": {
     "@commitlint/config-conventional": "^17.0.2",
     "@evilmartians/lefthook": "^1.5.0",
@@ -87,6 +91,7 @@
     "react": "18.3.1",
     "react-native": "0.76.3",
     "react-native-builder-bob": "^0.33.1",
+    "react-native-fs": "2.20.0",
     "release-it": "^17.10.0",
     "turbo": "^1.10.7",
     "typescript": "^5.2.2"
@@ -96,7 +101,8 @@
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": "*"
+    "react-native": "*",
+    "react-native-fs": "*"
   },
   "workspaces": [
     "example"

package/src/NativeOtaHotUpdate.ts

@@ -3,6 +3,7 @@ import { TurboModuleRegistry } from 'react-native';
 
 export interface Spec extends TurboModule {
   setupBundlePath(path: string, extension: string): Promise<boolean>;
+  setExactBundlePath(path: string): Promise<boolean>;
   deleteBundle(i: number): Promise<boolean>;
   restart(): void;
   getCurrentVersion(a: number): Promise<string>;

package/src/gits/helper/fileReader.js

@@ -0,0 +1,44 @@
+/**
+ * @format
+ */
+FileReader.prototype.readAsArrayBuffer = function (blob) {
+  if (this.readyState === this.LOADING) throw new Error('InvalidStateError');
+  this._setReadyState(this.LOADING);
+  this._result = null;
+  this._error = null;
+  const fr = new FileReader();
+  fr.onloadend = () => {
+    const content = atob(fr.result.replace(/data:[^;]+;base64,/, ''));
+    const buffer = new ArrayBuffer(content.length);
+    const view = new Uint8Array(buffer);
+    view.set(Array.from(content).map((c) => c.charCodeAt(0)));
+    this._result = buffer;
+    this._setReadyState(this.DONE);
+  };
+  fr.readAsDataURL(blob);
+};
+
+// from: https://stackoverflow.com/questions/42829838/react-native-atob-btoa-not-working-without-remote-js-debugging
+const chars =
+  'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+const atob = (input = '') => {
+  let str = input.replace(/[=]+$/, '');
+  let output = '';
+
+  if (str.length % 4 == 1) {
+    throw new Error(
+      "'atob' failed: The string to be decoded is not correctly encoded."
+    );
+  }
+  for (
+    let bc = 0, bs = 0, buffer, i = 0;
+    (buffer = str.charAt(i++));
+    ~buffer && ((bs = bc % 4 ? bs * 64 + buffer : buffer), bc++ % 4)
+      ? (output += String.fromCharCode(255 & (bs >> ((-2 * bc) & 6))))
+      : 0
+  ) {
+    buffer = chars.indexOf(buffer);
+  }
+
+  return output;
+};

package/src/gits/helper/fs.ts

@@ -0,0 +1,154 @@
+import { Buffer } from 'buffer';
+
+let RNFS = {
+  unlink: console.log,
+  readdir: console.log,
+  mkdir: console.log,
+  readFile: console.log,
+  writeFile: console.log,
+  stat: console.log,
+};
+try {
+  RNFS = require('react-native-fs');
+} catch {}
+
+function Err(name: string) {
+  return class extends Error {
+    public code = name;
+    constructor(...args: any) {
+      super(...args);
+      if (this.message) {
+        this.message = name + ': ' + this.message;
+      } else {
+        this.message = name;
+      }
+    }
+  };
+}
+
+// const EEXIST = Err('EEXIST'); // <-- Unused because RNFS's mkdir never throws
+const ENOENT = Err('ENOENT');
+const ENOTDIR = Err('ENOTDIR');
+// const ENOTEMPTY = Err('ENOTEMPTY'); // <-- Unused because RNFS's unlink is recursive by default
+
+export const readdir = async (path: string) => {
+  try {
+    return await RNFS.readdir(path);
+  } catch (err: any) {
+    switch (err.message) {
+      case 'Attempt to get length of null array': {
+        throw new ENOTDIR(path);
+      }
+      case 'Folder does not exist': {
+        throw new ENOENT(path);
+      }
+      default:
+        throw err;
+    }
+  }
+};
+
+export const mkdir = async (path: string) => {
+  return RNFS.mkdir(path);
+};
+
+export const readFile = async (
+  path: string,
+  opts?: string | { [key: string]: string }
+) => {
+  let encoding;
+
+  if (typeof opts === 'string') {
+    encoding = opts;
+  } else if (typeof opts === 'object') {
+    encoding = opts.encoding;
+  }
+
+  // @ts-ignore
+  let result: string | Uint8Array = await RNFS.readFile(
+    path,
+    encoding || 'base64'
+  );
+
+  if (!encoding) {
+    // @ts-ignore
+    result = Buffer.from(result, 'base64');
+  }
+
+  return result;
+};
+export const writeFile = async (
+  path: string,
+  content: string | Uint8Array,
+  opts?: string | { [key: string]: string }
+) => {
+  let encoding;
+
+  if (typeof opts === 'string') {
+    encoding = opts;
+  } else if (typeof opts === 'object') {
+    encoding = opts.encoding;
+  }
+
+  if (typeof content === 'string') {
+    encoding = encoding || 'utf8';
+  } else {
+    encoding = 'base64';
+    content = Buffer.from(content).toString('base64');
+  }
+
+  await RNFS.writeFile(path, content as string, encoding);
+};
+
+export const stat = async (path: string) => {
+  try {
+    const r = await RNFS.stat(path);
+    // we monkeypatch the result with a `isSymbolicLink` method because isomorphic-git needs it.
+    // Since RNFS doesn't appear to support symlinks at all, we'll just always return false.
+    // @ts-ignore
+    r.isSymbolicLink = () => false;
+    return r;
+  } catch (err: any) {
+    switch (err.message) {
+      case 'File does not exist': {
+        throw new ENOENT(path);
+      }
+      default:
+        throw err;
+    }
+  }
+};
+
+// Since there are no symbolic links, lstat and stat are equivalent
+export const lstat = stat;
+
+export const unlink = async (path: string) => {
+  try {
+    await RNFS.unlink(path);
+  } catch (err: any) {
+    switch (err.message) {
+      case 'File does not exist': {
+        throw new ENOENT(path);
+      }
+      default:
+        throw err;
+    }
+  }
+};
+
+// RNFS doesn't have a separate rmdir method, so we can use unlink for deleting directories too
+export const rmdir = unlink;
+
+// These are optional, which is good because there is no equivalent in RNFS
+export const readlink = async () => {
+  throw new Error('not implemented');
+};
+export const symlink = async () => {
+  throw new Error('not implemented');
+};
+
+// Technically we could pull this off by using `readFile` + `writeFile` with the `mode` option
+// However, it's optional, because isomorphic-git will do exactly that (a readFile and a writeFile with the new mode)
+export const chmod = async () => {
+  throw new Error('not implemented');
+};

package/src/gits/index.ts

@@ -0,0 +1,118 @@
+import './helper/fileReader.js';
+
+// @ts-ignore
+import git, { PromiseFsClient } from 'isomorphic-git/index.umd.min.js';
+import http from 'isomorphic-git/http/web/index.js';
+import * as promises from './helper/fs';
+import type { CloneOption, PullOption } from '../type';
+
+const fs: PromiseFsClient = { promises };
+const getFolder = (folderName?: string) => {
+  try {
+    const { DocumentDirectoryPath } = require('react-native-fs');
+    return DocumentDirectoryPath + (folderName || '/git_hot_update');
+  } catch (e) {}
+  return '';
+};
+/**
+ * Should set config after clone success, otherwise cannot pull
+ */
+const setConfig = async (
+  folderName?: string,
+  options?: {
+    userName?: string;
+    email?: string;
+  }
+) => {
+  await git.setConfig({
+    fs,
+    dir: getFolder(folderName),
+    path: options?.userName || 'user.name',
+    value: options?.email || 'hotupdate',
+  });
+};
+const cloneRepo = async (options: CloneOption) => {
+  try {
+    await git.clone({
+      fs,
+      http,
+      dir: getFolder(options?.folderName),
+      url: options?.url,
+      singleBranch: true,
+      depth: 1,
+      ref: options?.branch,
+      onProgress({ loaded, total }: { loaded: number; total: number }) {
+        if (options?.onProgress && total > 0) {
+          options?.onProgress(loaded, total);
+        }
+      },
+    });
+    await setConfig(options?.folderName, {
+      email: options?.email,
+      userName: options?.userName,
+    });
+    return {
+      success: true,
+      msg: null,
+      bundle: `${getFolder(options?.folderName)}/${options.bundlePath}`,
+    };
+  } catch (e: any) {
+    return {
+      success: false,
+      msg: e.toString(),
+      bundle: null,
+    };
+  }
+};
+const pullUpdate = async (options: PullOption) => {
+  try {
+    let count = 0;
+    await git.pull({
+      fs,
+      http,
+      dir: getFolder(options?.folderName),
+      ref: options?.branch,
+      singleBranch: true,
+      onProgress({ loaded, total }: { loaded: number; total: number }) {
+        if (total > 0) {
+          count = total;
+          if (options?.onProgress) {
+            options?.onProgress(loaded, total);
+          }
+        }
+      },
+    });
+    return {
+      success: count > 0,
+      msg: count > 0 ? 'Pull success' : 'No updated',
+    };
+  } catch (e: any) {
+    console.log(e.toString());
+    return {
+      success: false,
+      msg: e.toString(),
+    };
+  }
+};
+const getBranchName = async (folderName?: string) => {
+  try {
+    return await git.currentBranch({
+      fs,
+      dir: getFolder(folderName),
+      fullname: false,
+    });
+  } catch (e: any) {
+    console.log(e.toString());
+    return null;
+  }
+};
+const removeGitUpdate = (folderName?: string) => {
+  fs.promises.unlink(getFolder(folderName));
+};
+export default {
+  cloneRepo,
+  pullUpdate,
+  getBranchName,
+  setConfig,
+  removeGitUpdate,
+};

package/src/index.d.ts

@@ -0,0 +1,80 @@
+import type { DownloadManager } from './download';
+import type { UpdateGitOption, UpdateOption } from './type';
+
+export interface GitModule {
+  checkForGitUpdate(options: UpdateGitOption): Promise<void>;
+  removeGitUpdate(folder?: string): void;
+  getBranchName(): Promise<string | null>;
+  pullUpdate(options: {
+    branch: string;
+    folderName?: string;
+    onProgress?: (received: number, total: number) => void;
+  }): Promise<{ success: boolean; msg?: string }>;
+  cloneRepo(options: {
+    url: string;
+    branch?: string;
+    folderName?: string;
+    bundlePath: string;
+    onProgress?: (received: number, total: number) => void;
+  }): Promise<{ success: boolean; bundle?: string; msg?: string }>;
+}
+
+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.
+   */
+  setupBundlePath(path: string, extension?: string): Promise<boolean>;
+
+  /**
+   * Set up an exact path to the bundle file for the update.
+   * @param path - The exact path to the bundle file.
+   */
+  setupExactBundlePath(path: string): Promise<boolean>;
+
+  /**
+   * Remove the current update and optionally restart the app.
+   * @param restartAfterRemoved - Whether to restart the app after removing the update.
+   */
+  removeUpdate(restartAfterRemoved?: boolean): void;
+
+  /**
+   * Download a bundle file from a specified URI.
+   * @param downloadManager - The download manager instance.
+   * @param uri - The URI of the bundle file.
+   * @param version - The version of the bundle file.
+   * @param option - Additional update options.
+   */
+  downloadBundleUri(
+    downloadManager: DownloadManager,
+    uri: string,
+    version: number,
+    option?: UpdateOption
+  ): Promise<void>;
+
+  /**
+   * Reset the app by restarting it.
+   */
+  resetApp(): Promise<void>;
+
+  /**
+   * Get the current version of the app.
+   */
+  getCurrentVersion(): Promise<number>;
+
+  /**
+   * Set the current version of the app.
+   * @param version - The version to set.
+   */
+  setCurrentVersion(version: number): Promise<boolean>;
+
+  /**
+   * Git-related operations.
+   */
+  git: GitModule;
+}
+
+declare const OtaHotUpdate: OtaHotUpdate;
+
+export default OtaHotUpdate;

package/src/index.tsx

@@ -1,5 +1,7 @@
 import { NativeModules, Platform } from 'react-native';
 import type { DownloadManager } from './download';
+import type { UpdateGitOption, UpdateOption } from './type';
+import git from './gits';
 
 const LINKING_ERROR =
   `The package 'react-native-ota-hot-update' doesn't seem to be linked. Make sure: \n\n` +
@@ -10,14 +12,6 @@ const LINKING_ERROR =
 // @ts-expect-error
 const isTurboModuleEnabled = global.__turboModuleProxy != null;
 
-export interface UpdateOption {
-  headers?: object;
-  progress?(received: string, total: string): void;
-  updateSuccess?(): void;
-  updateFail?(message?: string): void;
-  restartAfterInstall?: boolean;
-  extensionBundle?: string;
-}
 const OtaHotUpdateModule = isTurboModuleEnabled
   ? require('./NativeOtaHotUpdate').default
   : NativeModules.OtaHotUpdate;
@@ -56,6 +50,9 @@ const downloadBundleFile = async (
 function setupBundlePath(path: string, extension?: string): Promise<boolean> {
   return RNhotupdate.setupBundlePath(path, extension);
 }
+function setupExactBundlePath(path: string): Promise<boolean> {
+  return RNhotupdate.setExactBundlePath(path);
+}
 function deleteBundlePath(): Promise<boolean> {
   return RNhotupdate.deleteBundle(1);
 }
@@ -139,12 +136,68 @@ async function downloadBundleUri(
     installFail(option, e);
   }
 }
-
+const checkForGitUpdate = async (options: UpdateGitOption) => {
+  try {
+    if (!options.url || !options.bundlePath) {
+      throw new Error(`url or bundlePath should not be null`);
+    }
+    const branch = await git.getBranchName();
+    if (branch) {
+      const pull = await git.pullUpdate({
+        branch,
+        onProgress: options?.onProgress,
+        folderName: options?.folderName,
+      });
+      if (pull.success) {
+        options?.onPullSuccess?.();
+        if (options?.restartAfterInstall) {
+          setTimeout(() => {
+            resetApp();
+          }, 300);
+        }
+      } else {
+        options?.onPullFailed?.(pull.msg);
+      }
+    } else {
+      const clone = await git.cloneRepo({
+        onProgress: options?.onProgress,
+        folderName: options?.folderName,
+        url: options.url,
+        branch: options?.branch,
+        bundlePath: options.bundlePath,
+      });
+      if (clone.success && clone.bundle) {
+        await setupExactBundlePath(clone.bundle);
+        options?.onCloneSuccess?.();
+        if (options?.restartAfterInstall) {
+          setTimeout(() => {
+            resetApp();
+          }, 300);
+        }
+      } else {
+        options?.onCloneFailed?.(clone.msg);
+      }
+    }
+  } catch (e: any) {
+    options?.onCloneFailed?.(e.toString());
+  } finally {
+    options?.onFinishProgress?.();
+  }
+};
 export default {
   setupBundlePath,
+  setupExactBundlePath,
   removeUpdate: removeBundle,
   downloadBundleUri,
   resetApp,
   getCurrentVersion: getVersionAsNumber,
   setCurrentVersion,
+  git: {
+    checkForGitUpdate,
+    ...git,
+    removeGitUpdate: (folder?: string) => {
+      RNhotupdate.setExactBundlePath('');
+      git.removeGitUpdate(folder);
+    },
+  },
 };