@bravemobile/react-native-code-push 9.1.2 → 9.2.0

package/README.md

@@ -161,7 +161,31 @@ Add the following line to the end of the file.
   }
 ```
 
-### 4. "CodePush-ify" Your App
+### 4. Expo Setup
+For Expo projects, you can use the automated config plugin instead of manual setup.
+
+**Add plugin to your Expo configuration:**
+```js
+// app.config.js
+export default {
+  expo: {
+    plugins: ["@bravemobile/react-native-code-push"],
+  },
+};
+```
+
+**Run prebuild to apply changes:**
+```bash
+npx expo prebuild
+```
+
+> [!NOTE]
+> The plugin automatically handles all native iOS and Android code modifications. No manual editing of AppDelegate, MainApplication, or gradle files is required.
+
+**Requirements**
+Expo SDK: 50.0.0 or higher
+
+### 5. "CodePush-ify" Your App
 
 The root component of your app should be wrapped with a higher-order component.
 
@@ -205,7 +229,7 @@ export default CodePush({
 > The URL for fetching the release history should point to the resource location generated by the CLI tool.
 
 
-#### 4-1. Telemetry Callbacks
+#### 5-1. Telemetry Callbacks
 
 Please refer to the [CodePushOptions](https://github.com/Soomgo-Mobile/react-native-code-push/blob/f0d26f7614af41c6dd4daecd9f7146e2383b2b0d/typings/react-native-code-push.d.ts#L76-L95) type for more details.
 - **onUpdateSuccess:** Triggered when the update bundle is executed successfully.
@@ -215,7 +239,7 @@ Please refer to the [CodePushOptions](https://github.com/Soomgo-Mobile/react-nat
 - **onSyncError:** Triggered when an unknown error occurs during the update process. (`CodePush.SyncStatus.UNKNOWN_ERROR` status)
 
 
-### 5. Configure the CLI Tool
+### 6. Configure the CLI Tool
 
 > [!TIP]
 > For a more detailed and practical example, refer to the `CodePushDemoApp` in `example` directory. ([link](https://github.com/Soomgo-Mobile/react-native-code-push/tree/master/Examples/CodePushDemoApp))
@@ -330,7 +354,7 @@ Create a new release history for a specific binary app version.
 **Example:**
 - Create a new release history for the binary app version `1.0.0`. 
 
-```
+```bash
 npx code-push create-history --binary-version 1.0.0 --platform ios --identifier staging
 ```
 
@@ -342,7 +366,7 @@ Display the release history for a specific binary app version.
 **Example:**
 - Show the release history for the binary app version `1.0.0`.
 
-```
+```bash
 npx code-push show-history --binary-version 1.0.0 --platform ios --identifier staging
 ```
 
@@ -354,11 +378,15 @@ Release a CodePush update for a specific binary app version.
 **Example:**
 - Release a CodePush update `1.0.1` targeting the binary app version `1.0.0`.
 
-```
+```bash
 npx code-push release --binary-version 1.0.0 --app-version 1.0.1 \
                       --platform ios --identifier staging --entry-file index.js \
                       --mandatory true
+
+# Expo project
+npx code-push release --framework expo --binary-version 1.0.0 --app-version 1.0.1 --platform ios
 ```
+- `--framework`(`-f`) : Framework type (expo)
 - `--binary-version`: The version of the binary app that the CodePush update is targeting.
 - `--app-version`: The version of the CodePush update itself.
 
@@ -375,7 +403,7 @@ Update the release history for a specific CodePush update.
 **Example:**
 - Rollback the CodePush update `1.0.1` (targeting the binary app version `1.0.0`).
 
-```
+```bash
 npx code-push update-history --binary-version 1.0.0 --app-version 1.0.1 \
                              --platform ios --identifier staging \
                              --enable false
@@ -386,10 +414,17 @@ npx code-push update-history --binary-version 1.0.0 --app-version 1.0.1 \
 Create a CodePush bundle file.
 
 **Example:**
-```
+```bash
 npx code-push bundle --platform android --entry-file index.js
+
+# Expo project
+npx code-push bundle --framework expo --platform android --entry-file index.js
 ```
+- `--framework`(`-f`): Framework type (expo)
 
 By default, the bundle file is created in the `/build/bundleOutput` directory.
 
+> [!NOTE]
+> For Expo projects, the CLI uses `expo export:embed` command for bundling instead of React Native's bundle command.
+
 (The file name represents a hash value of the bundle content.)

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require("./expo/plugin/withCodePush");

package/cli/commands/bundleCommand/bundleCodePush.js

@@ -1,12 +1,14 @@
 const fs = require('fs');
 const { prepareToBundleJS } = require('../../functions/prepareToBundleJS');
 const { runReactNativeBundleCommand } = require('../../functions/runReactNativeBundleCommand');
+const { runExpoBundleCommand } = require('../../functions/runExpoBundleCommand');
 const { getReactTempDir } = require('../../functions/getReactTempDir');
 const { runHermesEmitBinaryCommand } = require('../../functions/runHermesEmitBinaryCommand');
 const { makeCodePushBundle } = require('../../functions/makeCodePushBundle');
 const { ROOT_OUTPUT_DIR, ENTRY_FILE } = require('../../constant');
 
 /**
+ * @param framework {string|undefined} 'expo'
  * @param platform {string} 'ios' | 'android'
  * @param outputRootPath {string}
  * @param entryFile {string}
@@ -15,6 +17,7 @@ const { ROOT_OUTPUT_DIR, ENTRY_FILE } = require('../../constant');
  * @return {Promise<string>} CodePush bundle file name (equals to packageHash)
  */
 async function bundleCodePush(
+  framework,
   platform = 'ios',
   outputRootPath = ROOT_OUTPUT_DIR,
   entryFile = ENTRY_FILE,
@@ -32,13 +35,24 @@ async function bundleCodePush(
 
     prepareToBundleJS({ deleteDirs: [outputRootPath, getReactTempDir()], makeDir: OUTPUT_CONTENT_PATH });
 
-    runReactNativeBundleCommand(
-      _jsBundleName,
-      OUTPUT_CONTENT_PATH,
-      platform,
-      SOURCEMAP_OUTPUT,
-      entryFile,
-    );
+    if (framework === 'expo') {
+      runExpoBundleCommand(
+        _jsBundleName,
+        OUTPUT_CONTENT_PATH,
+        platform,
+        SOURCEMAP_OUTPUT,
+        entryFile,
+      );
+    } else {
+      runReactNativeBundleCommand(
+        _jsBundleName,
+        OUTPUT_CONTENT_PATH,
+        platform,
+        SOURCEMAP_OUTPUT,
+        entryFile,
+      );
+    }
+
     console.log('log: JS bundling complete');
 
     await runHermesEmitBinaryCommand(

package/cli/commands/bundleCommand/index.js

@@ -4,6 +4,7 @@ const { OUTPUT_BUNDLE_DIR, ROOT_OUTPUT_DIR, ENTRY_FILE } = require('../../consta
 
 program.command('bundle')
     .description('Creates a CodePush bundle file (assumes Hermes is enabled).')
+    .addOption(new Option('-f, --framework <type>', 'framework type (expo)').choices(['expo']))
     .addOption(new Option('-p, --platform <type>', 'platform').choices(['ios', 'android']).default('ios'))
     .option('-o, --output-path <string>', 'path to output root directory', ROOT_OUTPUT_DIR)
     .option('-e, --entry-file <string>', 'path to JS/TS entry file', ENTRY_FILE)
@@ -11,6 +12,7 @@ program.command('bundle')
     .option('--output-bundle-dir <string>', 'name of directory containing the bundle file created by the "bundle" command', OUTPUT_BUNDLE_DIR)
     /**
      * @param {Object} options
+     * @param {string} options.framework
      * @param {string} options.platform
      * @param {string} options.outputPath
      * @param {string} options.entryFile
@@ -20,6 +22,7 @@ program.command('bundle')
      */
     .action((options) => {
         bundleCodePush(
+            options.framework,
             options.platform,
             options.outputPath,
             options.entryFile,

package/cli/commands/releaseCommand/index.js

@@ -7,6 +7,7 @@ program.command('release')
     .description('Deploys a new CodePush update for a target binary app.\nAfter creating the CodePush bundle, it uploads the file and updates the ReleaseHistory information.\n`bundleUploader`, `getReleaseHistory`, and `setReleaseHistory` functions should be implemented in the config file.')
     .requiredOption('-b, --binary-version <string>', '(Required) The target binary version')
     .requiredOption('-v, --app-version <string>', '(Required) The app version to be released. It must be greater than the binary version.')
+    .addOption(new Option('-f, --framework <type>', 'framework type (expo)').choices(['expo']))
     .addOption(new Option('-p, --platform <type>', 'platform').choices(['ios', 'android']).default('ios'))
     .option('-i, --identifier <string>', 'reserved characters to distinguish the release.')
     .option('-c, --config <path>', 'set config file name (JS/TS)', CONFIG_FILE_NAME)
@@ -22,6 +23,7 @@ program.command('release')
      * @param {Object} options
      * @param {string} options.binaryVersion
      * @param {string} options.appVersion
+     * @param {string} options.framework
      * @param {string} options.platform
      * @param {string} options.identifier
      * @param {string} options.config
@@ -44,6 +46,7 @@ program.command('release')
             config.setReleaseHistory,
             options.binaryVersion,
             options.appVersion,
+            options.framework,
             options.platform,
             options.identifier,
             options.outputPath,

package/cli/commands/releaseCommand/release.js

@@ -25,6 +25,7 @@ const { addToReleaseHistory } = require("./addToReleaseHistory");
  *   ): Promise<void>}
  * @param binaryVersion {string}
  * @param appVersion {string}
+ * @param framework {string|undefined} 'expo'
  * @param platform {"ios" | "android"}
  * @param identifier {string?}
  * @param outputPath {string}
@@ -43,6 +44,7 @@ async function release(
     setReleaseHistory,
     binaryVersion,
     appVersion,
+    framework,
     platform,
     identifier,
     outputPath,
@@ -56,7 +58,7 @@ async function release(
 ) {
     const bundleFileName = skipBundle
         ? readBundleFileNameFrom(bundleDirectory)
-        : await bundleCodePush(platform, outputPath, entryFile, jsBundleName, bundleDirectory);
+        : await bundleCodePush(framework, platform, outputPath, entryFile, jsBundleName, bundleDirectory);
     const bundleFilePath = `${bundleDirectory}/${bundleFileName}`;
 
     const downloadUrl = await (async () => {

package/cli/functions/runExpoBundleCommand.js

@@ -0,0 +1,53 @@
+const path = require('path');
+const shell = require('shelljs');
+
+/**
+ * Run `expo bundle` CLI command
+ *
+ * @param bundleName {string} JS bundle file name
+ * @param entryFile {string} App code entry file name (default: index.ts)
+ * @param outputPath {string} Path to output JS bundle file and assets
+ * @param platform {string} Platform (ios | android)
+ * @param sourcemapOutput {string} Path to output sourcemap file (Warning: if sourcemapOutput points to the outputPath, the sourcemap will be included in the CodePush bundle and increase the deployment size)
+ * @return {void}
+ */
+function runExpoBundleCommand(
+    bundleName,
+    outputPath,
+    platform,
+    sourcemapOutput,
+    entryFile,
+) {
+    /**
+     * @return {string}
+     */
+    function getCliPath() {
+        return path.join('node_modules', '.bin', 'expo');
+    }
+
+    /**
+     * @type {string[]}
+     */
+    const expoBundleArgs = [
+        'export:embed',
+        '--assets-dest',
+        outputPath,
+        '--bundle-output',
+        path.join(outputPath, bundleName),
+        '--dev',
+        'false',
+        '--entry-file',
+        entryFile,
+        '--platform',
+        platform,
+        '--sourcemap-output',
+        sourcemapOutput,
+        '--reset-cache',
+    ];
+
+    console.log('Running "expo export:embed" command:\n');
+
+    shell.exec(`${getCliPath()} ${expoBundleArgs.join(' ')}`);
+}
+
+module.exports = { runExpoBundleCommand };

package/expo/plugin/withCodePush.js

@@ -0,0 +1,15 @@
+const { createRunOncePlugin } = require('expo/config-plugins');
+const { withAndroidBuildScriptDependency, withAndroidMainApplicationDependency } = require('./withCodePushAndroid');
+const { withIosBridgingHeader, withIosAppDelegateDependency } = require('./withCodePushIos');
+const pkg = require('../../package.json');
+
+const withCodePush = (config) => {
+  config = withAndroidBuildScriptDependency(config);
+  config = withAndroidMainApplicationDependency(config);
+  config = withIosBridgingHeader(config);
+  config = withIosAppDelegateDependency(config);
+
+  return config;
+};
+
+module.exports = createRunOncePlugin(withCodePush, pkg.name, pkg.version);

package/expo/plugin/withCodePushAndroid.js

@@ -0,0 +1,72 @@
+const { withAppBuildGradle, withMainApplication, WarningAggregator } = require('expo/config-plugins');
+
+function androidApplyImplementation(appBuildGradle) {
+  const codePushImplementation = `apply from: "../../node_modules/@bravemobile/react-native-code-push/android/codepush.gradle"`;
+
+  if (!appBuildGradle.includes(codePushImplementation)) {
+    return `${appBuildGradle.trimEnd()}\n${codePushImplementation}\n`;
+  }
+
+  return appBuildGradle;
+}
+
+function androidMainApplicationApplyImplementation(
+  mainApplication,
+  find,
+  add,
+  reverse = false,
+) {
+  if (mainApplication.includes(add)) {
+    return mainApplication;
+  }
+
+  if (mainApplication.includes(find)) {
+    return mainApplication.replace(find, reverse ? `${add}\n${find}` : `${find}\n${add}`);
+  }
+
+  WarningAggregator.addWarningAndroid(
+    'withCodePushAndroid',
+    `
+    Failed to detect "${find.replace(/\n/g, '').trim()}" in the MainApplication.kt.
+    Please add "${add.replace(/\n/g, '').trim()}" to the MainApplication.kt.
+    Supported format: Expo SDK default template.
+
+    Android manual setup: https://github.com/Soomgo-Mobile/react-native-code-push#3-android-setup
+    `,
+  );
+
+  return mainApplication;
+}
+
+const withAndroidBuildScriptDependency = (config) => {
+  return withAppBuildGradle(config, (action) => {
+    action.modResults.contents = androidApplyImplementation(
+      action.modResults.contents,
+    );
+
+    return action;
+  });
+};
+
+const withAndroidMainApplicationDependency = (config) => {
+  return withMainApplication(config, (action) => {
+    action.modResults.contents = androidMainApplicationApplyImplementation(
+      action.modResults.contents,
+      'class MainApplication : Application(), ReactApplication {',
+      'import com.microsoft.codepush.react.CodePush\n',
+      true,
+    );
+
+    action.modResults.contents = androidMainApplicationApplyImplementation(
+      action.modResults.contents,
+      'object : DefaultReactNativeHost(this) {',
+      '          override fun getJSBundleFile(): String = CodePush.getJSBundleFile()\n',
+    );
+    return action;
+  });
+};
+
+module.exports = {
+  withAndroidBuildScriptDependency,
+  withAndroidMainApplicationDependency,
+};

package/expo/plugin/withCodePushIos.js

@@ -0,0 +1,143 @@
+const { withAppDelegate, withXcodeProject, WarningAggregator } = require('expo/config-plugins');
+const { getAppDelegate } = require('@expo/config-plugins/build/ios/Paths');
+const path = require('path');
+const fs = require('fs');
+
+function iosApplyImplementation(
+  appDelegate,
+  find,
+  add,
+  replace,
+) {
+  if (appDelegate.includes(add)) {
+    return appDelegate;
+  }
+
+  if (appDelegate.includes(find)) {
+    return appDelegate.replace(find, replace ? add : `${find}\n${add}`);
+  }
+
+  WarningAggregator.addWarningIOS(
+    'withCodePushIos',
+    `
+    Failed to detect "${find.replace(/\n/g, '').trim()}" in the AppDelegate.(m|swift).
+    Please ${replace ? 'replace' : 'add'} "${add.replace(/\n/g, '').trim()}" to the AppDelegate.(m|swift).
+    Supported format: Expo SDK default template.
+
+    iOS manual setup: https://github.com/Soomgo-Mobile/react-native-code-push#2-ios-setup
+    `,
+  );
+
+  return appDelegate;
+}
+
+function getBridgingHeaderFileFromXcode(project) {
+  const buildConfigs = project.pbxXCBuildConfigurationSection();
+
+  for (const key in buildConfigs) {
+    const config = buildConfigs[key];
+    if (
+      typeof config === 'object' &&
+      config.buildSettings &&
+      config.buildSettings['SWIFT_OBJC_BRIDGING_HEADER']
+    ) {
+      const bridgingHeaderFile = config.buildSettings[
+        'SWIFT_OBJC_BRIDGING_HEADER'
+      ].replace(/"/g, '');
+
+      return bridgingHeaderFile;
+    }
+  }
+  return null;
+}
+
+const withIosAppDelegateDependency = (config) => {
+  return withAppDelegate(config, (action) => {
+    const language = action.modResults.language;
+
+    if (['objc', 'objcpp'].includes(language)) {
+      action.modResults.contents = iosApplyImplementation(
+        action.modResults.contents,
+        `#import "AppDelegate.h"`,
+        `#import <CodePush/CodePush.h>`,
+      );
+      action.modResults.contents = iosApplyImplementation(
+        action.modResults.contents,
+        `return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];`,
+        `return [CodePush bundleURL];`,
+        true,
+      );
+
+      return action;
+    }
+
+    if (language === 'swift') {
+      action.modResults.contents = iosApplyImplementation(
+        action.modResults.contents,
+        `return Bundle.main.url(forResource: "main", withExtension: "jsbundle")`,
+        `return CodePush.bundleURL()`,
+        true,
+      );
+
+      return action;
+    }
+
+    WarningAggregator.addWarningIOS(
+      'withIosAppDelegate',
+      `${language} AppDelegate file is not supported yet.`,
+    );
+
+    return action;
+  });
+};
+
+const withIosBridgingHeader = (config) => {
+  return withXcodeProject(config, (action) => {
+    const projectRoot = action.modRequest.projectRoot;
+    const appDelegate = getAppDelegate(projectRoot);
+
+    if (appDelegate.language === 'swift') {
+      const bridgingHeaderFile = getBridgingHeaderFileFromXcode(
+        action.modResults,
+      );
+
+      const bridgingHeaderPath = path.join(
+        action.modRequest.platformProjectRoot,
+        bridgingHeaderFile,
+      );
+
+      if (fs.existsSync(bridgingHeaderPath)) {
+        let content = fs.readFileSync(bridgingHeaderPath, 'utf8');
+        const codePushImport = '#import <CodePush/CodePush.h>';
+
+        if (!content.includes(codePushImport)) {
+          content += `${codePushImport}\n`;
+          fs.writeFileSync(bridgingHeaderPath, content);
+        }
+
+        return action;
+      }
+
+      WarningAggregator.addWarningIOS(
+        'withIosBridgingHeader',
+        `
+        Failed to detect ${bridgingHeaderPath} file.
+        Please add CodePush integration manually:
+        #import <CodePush/CodePush.h>
+
+        Supported format: Expo SDK default template.
+        iOS manual setup: https://github.com/Soomgo-Mobile/react-native-code-push#2-edit-appdelegate-code
+        `
+      );
+
+      return action;
+    }
+
+    return action;
+  });
+};
+
+module.exports = {
+  withIosAppDelegateDependency,
+  withIosBridgingHeader,
+};

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@bravemobile/react-native-code-push",
-  "version": "9.1.2",
+  "version": "9.2.0",
   "description": "React Native plugin for the CodePush service",
   "main": "CodePush.js",
   "typings": "typings/react-native-code-push.d.ts",
   "homepage": "https://microsoft.github.io/code-push",
   "keywords": [
     "react-native",
+    "expo",
     "code",
-    "push"
+    "push",
+    "code-push",
+    "react-native-code-push",
+    "expo-code-push"
   ],
   "author": "Soomgo Mobile Team (originally Microsoft Corporation)",
   "license": "MIT",
@@ -48,8 +52,14 @@
     "yazl": "^3.3.1"
   },
   "peerDependencies": {
+    "expo": ">=50.0.0",
     "react-native": "*"
   },
+  "peerDependenciesMeta": {
+    "expo": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@babel/core": "^7.26.0",
     "@babel/preset-env": "^7.26.0",