Expo plugin to simplify installation with expo

app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./plugin/build');

docs/setup-android.md

@@ -1,5 +1,6 @@
 ## Android Setup
 
+* [Plugin Installation for Expo (Android)](#plugin-installation-for-expo-android)
 * [Plugin Installation and Configuration for React Native 0.60 version and above](#plugin-installation-and-configuration-for-react-native-060-version-and-above-android)
 * [Plugin Installation for React Native lower than 0.60 (Android)](#plugin-installation-for-react-native-lower-than-060-android)
   * [Plugin Installation (Android - RNPM)](#plugin-installation-android---rnpm)
@@ -17,21 +18,48 @@
 
 In order to integrate CodePush into your Android project, please perform the following steps:
 
+### Plugin Installation for Expo (Android)
+
+React Native Code Push comes packaged with a plugin to automate some of the setup process:
+
+1. Open your Expo app config file (app.config.json or app.config.js instead of app.json).
+
+2. Insert the following into the plugins section of your config (Don't duplicate configuration, if the 'react-native-code-push' item already exists, simply add the android portion.). Create the plugins section if it doesn't already exist. CodePushPublicKey is optional, see Code Signing setup for more information.
+
+    ```javascript
+    "plugins": [
+      [
+        'react-native-code-push',
+        {
+          android: {
+            CodePushDeploymentKey: 'YOUR_ANDROID_CODE_PUSH_KEY',
+            CodePushPublicKey: 'YOUR_ANDROID_PUBLIC_KEY',
+          }
+        }
+      ]
+    ]
+    ```
+
+3. Replace `YOUR_ANDROID_CODE_PUSH_KEY` with the Deployment key.
+
+4. Run `npx expo prebuild` to regenerate your native code with the codepush dependencies.
+
 ### Plugin Installation and Configuration for React Native 0.60 version and above (Android)
 
 1. In your `android/settings.gradle` file, make the following additions at the end of the file:
 
     ```gradle
     ...
     include ':app', ':react-native-code-push'
-    project(':react-native-code-push').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-code-push/android/app')
+    project(':react-native-code-push').projectDir = new File(["node", "--print", "require.resolve('react-native-code-push/package.json')"].execute(null, rootDir).text.trim(), "../android/app")
     ```
 
 2. In your `android/app/build.gradle` file, add the `codepush.gradle` file as an additional build task definition to the end of the file:
 
     ```gradle
     ...
-    apply from: "../../node_modules/react-native-code-push/android/codepush.gradle"
+    apply from: new File(reactNativeRoot, "react.gradle")
+    apply from: new File(["node", "--print", "require.resolve('react-native-code-push/package.json')"].execute(null, rootDir).text.trim()).getParentFile().getAbsolutePath() + "/android/codepush.gradle"
     ...
     ```
 

docs/setup-ios.md

@@ -1,6 +1,31 @@
 ## iOS Setup
 
 Once you've acquired the CodePush plugin, you need to integrate it into the Xcode project of your React Native app and configure it correctly. To do this, take the following steps:
+
+### Plugin Installation for Expo (iOS)
+
+React Native Code Push comes packaged with a plugin to automate some of the setup process:
+
+1. Open your Expo app config file (app.config.json or app.config.js instead of app.json).
+
+2. Insert the following into the plugins section of your config (Don't duplicate configuration, if the 'react-native-code-push' item already exists, simply add the ios portion.). Create the plugins section if it doesn't already exist.
+
+    ```javascript
+    "plugins": [
+      [
+        'react-native-code-push',
+        {
+          ios: {
+            CodePushDeploymentKey: 'YOUR_IOS_CODE_PUSH_KEY',
+          },
+        }
+      ]
+    ]
+    ```
+
+3. Replace `YOUR_IOS_CODE_PUSH_KEY` with the Deployment key.
+
+4. Run `npx expo prebuild` to regenerate your native code with the codepush dependencies.
 ​
 ### Plugin Installation and Configuration for React Native 0.60 version and above (iOS)
 

package.json

@@ -44,6 +44,7 @@
     "xcode": "3.0.1"
   },
   "devDependencies": {
+    "@expo/config-plugins": "^5.0.4",
     "@types/assert": "^1.5.2",
     "@types/mkdirp": "^1.0.1",
     "@types/mocha": "^9.0.0",

plugin/src/android/buildscriptDependency.ts

@@ -0,0 +1,44 @@
+import { ConfigPlugin, withAppBuildGradle } from 'expo/config-plugins'
+
+import { PluginConfigType } from '../pluginConfig'
+
+/**
+ * Update `<project>/build.gradle` by adding the codepush.gradle file
+ * as an additional build task definition underneath react.gradle
+ */
+
+function applyImplementation(appBuildGradle: string) {
+  const codePushImplementation = `apply from: new File(["node", "--print", "require.resolve('react-native-code-push/package.json')"].execute(null, rootDir).text.trim()).getParentFile().getAbsolutePath() + "/android/codepush.gradle"`;
+
+  // Make sure the project does not have the dependency already
+  if (!appBuildGradle.includes(codePushImplementation)) {
+    const reactNativeFileClassGradleInclude = `'apply from: new File(reactNativeRoot, "react.gradle")`;
+    if (appBuildGradle.includes(reactNativeFileClassGradleInclude)) {
+      return appBuildGradle.replace(
+        reactNativeFileClassGradleInclude,
+        `${reactNativeFileClassGradleInclude}\n${codePushImplementation}`
+      );
+    }
+    const reactNativeRawGradleInclude = `apply from: "../../node_modules/react-native/react.gradle"`;
+    if (appBuildGradle.includes(reactNativeRawGradleInclude)) {
+      return appBuildGradle.replace(
+        reactNativeRawGradleInclude,
+        `${reactNativeRawGradleInclude}\n${codePushImplementation}`
+      );
+    }
+    const reactNative71Include = `apply from: new File(["node", "--print", "require.resolve('@react-native-community/cli-platform-android/package.json')"].execute(null, rootDir).text.trim(), "../native_modules.gradle");`;
+    if (appBuildGradle.includes(reactNative71Include)) {
+      return appBuildGradle.replace(
+        reactNative71Include,
+        `${reactNative71Include}\n${codePushImplementation}`
+      );
+    }
+  }
+  return appBuildGradle;
+}
+export const withAndroidBuildscriptDependency: ConfigPlugin<PluginConfigType> = (config) => {
+  return withAppBuildGradle(config, (config) => {
+    config.modResults.contents = applyImplementation(config.modResults.contents)
+    return config
+  })
+}

plugin/src/android/index.ts

@@ -0,0 +1,11 @@
+import { withAndroidBuildscriptDependency } from './buildscriptDependency'
+import { withAndroidMainApplicationDependency } from './mainApplicationDependency'
+import { withAndroidSettingsDependency } from './settingsDependency'
+import { withAndroidStringsDependency } from './stringsDependency'
+
+export {
+  withAndroidBuildscriptDependency,
+  withAndroidSettingsDependency,
+  withAndroidStringsDependency,
+  withAndroidMainApplicationDependency,
+}

plugin/src/android/mainApplicationDependency.ts

@@ -0,0 +1,59 @@
+import { ConfigPlugin, withMainApplication } from 'expo/config-plugins'
+
+import { PluginConfigType } from '../pluginConfig'
+
+/**
+ * Update `<project>/build.gradle` by adding the codepush.gradle file
+ * as an additional build task definition underneath react.gradle
+ */
+
+function applyImplementation(
+  mainApplication: string,
+  find: string,
+  add: string,
+  replace?: boolean
+) {
+  // Make sure the project does not have the settings already
+  if (!mainApplication.includes(add)) {
+    if (replace) return mainApplication.replace(find, add)
+    else return mainApplication.replace(find, `${find}\n${add}`)
+  }
+
+  return mainApplication
+}
+
+export const withAndroidMainApplicationDependency: ConfigPlugin<PluginConfigType> = (config) => {
+  return withMainApplication(config, (config) => {
+    config.modResults.contents = applyImplementation(
+      config.modResults.contents,
+      'import expo.modules.ReactNativeHostWrapper;',
+      `\nimport com.microsoft.codepush.react.CodePush;`
+    )
+    if (
+      config.modResults.contents.includes("new DefaultReactNativeHost(this) {")
+    ) {
+      config.modResults.contents = applyImplementation(
+        config.modResults.contents,
+        `new DefaultReactNativeHost(this) {`,
+        `
+          @Override
+          protected String getJSBundleFile() {
+            return CodePush.getJSBundleFile();
+          }\n`
+      );
+    } else if (
+      config.modResults.contents.includes(" new ReactNativeHost(this) {")
+    ) {
+      config.modResults.contents = applyImplementation(
+        config.modResults.contents,
+        `new ReactNativeHost(this) {`,
+        `
+    @Override
+    protected String getJSBundleFile() {
+      return CodePush.getJSBundleFile();
+    }\n`
+      );
+    }
+    return config;
+  })
+}

plugin/src/android/settingsDependency.ts

@@ -0,0 +1,25 @@
+import { ConfigPlugin, withSettingsGradle } from 'expo/config-plugins'
+
+import { PluginConfigType } from '../pluginConfig'
+
+/**
+ * Update `<project>/settings.gradle` by adding react-native-code-push
+ */
+
+function applySettings(gradleSettings: string) {
+  const codePushSettings = `\ninclude ':react-native-code-push'\nproject(':react-native-code-push').projectDir = new File(["node", "--print", "require.resolve('react-native-code-push/package.json')"].execute(null, rootDir).text.trim(), "../android/app")`
+
+  // Make sure the project does not have the settings already
+  if (!gradleSettings.includes(`include ':react-native-code-push'`)) {
+    return gradleSettings + codePushSettings
+  }
+
+  return gradleSettings
+}
+
+export const withAndroidSettingsDependency: ConfigPlugin<PluginConfigType> = (config) => {
+  return withSettingsGradle(config, (config) => {
+    config.modResults.contents = applySettings(config.modResults.contents)
+    return config
+  })
+}

plugin/src/android/stringsDependency.ts

@@ -0,0 +1,28 @@
+import { AndroidConfig, ConfigPlugin, withStringsXml } from 'expo/config-plugins'
+import { ResourceXML } from 'expo/config-plugins/build/android/Resources'
+
+import { PluginConfigType } from '../pluginConfig'
+
+/**
+ * Update `<project>/app/src/main/res/values/strings.xml` by adding react-native-code-push deployment key
+ */
+
+function setStrings(strings: ResourceXML, name: string, value: string) {
+  // Helper to add string.xml JSON items or overwrite existing items with the same name.
+  return AndroidConfig.Strings.setStringItem(
+    [
+      // XML represented as JSON
+      // <string moduleConfig="true" name="">value</string>
+      { $: { name }, _: value },
+    ],
+    strings
+  )
+}
+
+export const withAndroidStringsDependency: ConfigPlugin<PluginConfigType> = (config, props) => {
+  return withStringsXml(config, (config) => {
+    config.modResults = setStrings(config.modResults, 'CodePushDeploymentKey', props.android.CodePushDeploymentKey)
+    if (props.android.CodePushPublicKey) config.modResults = setStrings(config.modResults, 'CodePushPublicKey', props.android.CodePushPublicKey)
+    return config
+  })
+}

plugin/src/index.ts

@@ -0,0 +1,36 @@
+import { ConfigPlugin, createRunOncePlugin } from 'expo/config-plugins'
+
+import {
+  withAndroidBuildscriptDependency,
+  withAndroidMainApplicationDependency,
+  withAndroidSettingsDependency,
+  withAndroidStringsDependency,
+} from './android'
+import { withIosAppDelegateDependency, withIosBuildscriptDependency } from './ios'
+import { PluginConfigType } from './pluginConfig'
+
+/**
+ * A config plugin for configuring `react-native-code-push`
+ */
+const withRnCodepush: ConfigPlugin<PluginConfigType> = (config, props) => {
+  config = withAndroidBuildscriptDependency(config, props)
+  config = withAndroidSettingsDependency(config, props)
+  config = withAndroidStringsDependency(config, props)
+  config = withAndroidMainApplicationDependency(config, props)
+  // plugins order matter: the later one would run first
+  config = withIosBuildscriptDependency(config, props)
+  config = withIosAppDelegateDependency(config, props)
+
+  return config
+}
+
+let pkg: { name: string; version?: string } = {
+  name: "react-native-code-push",
+  // UNVERSIONED...
+};
+try {
+  const codePushPkg = require("react-native-code-push/package.json");
+  pkg = codePushPkg;
+} catch {}
+
+export default createRunOncePlugin(withRnCodepush, pkg.name, pkg.version);

plugin/src/ios/appDelegateDependency.ts

@@ -0,0 +1,34 @@
+import { ConfigPlugin, withAppDelegate } from 'expo/config-plugins'
+
+import { PluginConfigType } from '../pluginConfig'
+
+// Use these imports in SDK 46 and lower
+// import { ConfigPlugin, InfoPlist, withInfoPlist } from '@expo/config-plugins';
+// import { ExpoConfig } from '@expo/config-types';
+
+function applyImplementation(appDelegate: string, find: string, add: string, replace?: boolean) {
+  // Make sure the project does not have the settings already
+  if (!appDelegate.includes(add)) {
+    if (replace) return appDelegate.replace(find, add)
+    else return appDelegate.replace(find, `${find}\n${add}`)
+  }
+
+  return appDelegate
+}
+
+export const withIosAppDelegateDependency: ConfigPlugin<PluginConfigType> = (config, props) => {
+  return withAppDelegate(config, (config) => {
+    config.modResults.contents = applyImplementation(
+      config.modResults.contents,
+      `#import "AppDelegate.h"`,
+      `#import <CodePush/CodePush.h>`
+    )
+    config.modResults.contents = applyImplementation(
+      config.modResults.contents,
+      `return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];`,
+      `return [CodePush bundleURL];`,
+      true
+    )
+    return config
+  })
+}

plugin/src/ios/buildscriptDependency.ts

@@ -0,0 +1,12 @@
+import { ConfigPlugin, withInfoPlist } from 'expo/config-plugins'
+
+import { PluginConfigType } from '../pluginConfig'
+
+// Pass `<string>` to specify that this plugin requires a string property.
+export const withIosBuildscriptDependency: ConfigPlugin<PluginConfigType> = (config, props) => {
+  if (!props.ios.CodePushDeploymentKey) return config
+  return withInfoPlist(config, (config) => {
+    config.modResults.CodePushDeploymentKey = props.ios.CodePushDeploymentKey
+    return config
+  })
+}

plugin/src/ios/index.ts

@@ -0,0 +1,4 @@
+import { withIosAppDelegateDependency } from './appDelegateDependency'
+import { withIosBuildscriptDependency } from './buildscriptDependency'
+
+export { withIosBuildscriptDependency, withIosAppDelegateDependency }

plugin/src/pluginConfig.ts

@@ -0,0 +1,12 @@
+/**
+ * Configuration for `react-native-code-push`
+ */
+export interface PluginConfigType {
+  ios: {
+    CodePushDeploymentKey: string
+  }
+  android: {
+    CodePushDeploymentKey: string
+    CodePushPublicKey?: string
+  }
+}

plugin/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "expo-module-scripts/tsconfig.plugin",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src"
+  },
+  "include": ["./src"],
+}