@swyng/react-native-code-push 1.0.0

package/docs/multi-deployment-testing-android.md

@@ -0,0 +1,55 @@
+### Android
+
+> NOTE
+>
+> Complete demo configured with "multi-deployment testing" feature is [here](https://github.com/swyngpush/react-native/files/1314118/rncp1004.zip).
+
+The [Android Gradle plugin](https://google.github.io/android-gradle-dsl/current/index.html) allows you to define custom config settings for each "build type" (like debug, release). This mechanism allows you to easily configure your debug builds to use your CodePush staging deployment key and your release builds to use your CodePush production deployment key.
+
+*NOTE: As a reminder, you can retrieve these keys by running `npx @swyng/cli app ls_deployment -n <AppName> -k (Show deployment key)` from your terminal.*
+
+To set this up, perform the following steps:
+
+**For React Native >= v0.76**
+
+1. Open the project's app level `build.gradle` file (for example `android/app/build.gradle` in standard React Native projects)
+
+2. Find the `android { buildTypes {} }` section and define `resValue` entries for both your `debug` and `release` build types, which reference your `Staging` and `Production` deployment keys respectively.
+
+    ```groovy
+    android {
+        ...
+        buildTypes {
+            debug {
+                ...
+                // Note: CodePush updates should not be tested in Debug mode as they are overriden by the RN packager. However, because CodePush checks for updates in all modes, we must supply a key.
+                resValue "string", "CodePushDeploymentKey", '""'
+                ...
+            }
+
+            releaseStaging {
+                ...
+                resValue "string", "CodePushDeploymentKey", '"<INSERT_STAGING_KEY>"'
+
+                // Note: It is a good idea to provide matchingFallbacks for the new buildType you create to prevent build issues
+                // Add the following line if not already there
+                matchingFallbacks = ['release']
+                ...
+            }
+
+            release {
+                ...
+                resValue "string", "CodePushDeploymentKey", '"<INSERT_PRODUCTION_KEY>"'
+                ...
+            }
+        }
+        ...
+    }
+    ```
+    
+    *NOTE: Remember to remove the key from `strings.xml` if you are configuring the deployment key in the build process*
+
+    *NOTE: The naming convention for `releaseStaging` is significant due to [this line](https://github.com/facebook/react-native/blob/e083f9a139b3f8c5552528f8f8018529ef3193b9/react.gradle#L79).*
+
+
+And that's it! View [here](http://tools.android.com/tech-docs/new-build-system/resource-merging) for more details on how resource merging works in Android.

package/docs/multi-deployment-testing-ios.md

@@ -0,0 +1,59 @@
+### iOS
+
+> NOTE
+>
+> Complete demos configured with "multi-deployment testing" feature are [here]:
+> *  **without using cocoa pods**: [link](https://github.com/swyngpush/react-native/files/1259957/rncp976.copy.zip)
+> *  **using cocoa pods**: [link](https://github.com/swyngpush/react-native/files/1172217/rncp893.copy.zip)
+
+Xcode allows you to define custom build settings for each "configuration" (like debug, release), which can then be referenced as the value of keys within the `Info.plist` file (like the `CodePushDeploymentKey` setting). This mechanism allows you to easily configure your builds to produce binaries, which are configured to synchronize with different CodePush deployments.
+
+To set this up, perform the following steps:
+
+1. Open up your Xcode project and select your project in the `Project navigator` window
+
+2. Ensure the project node is selected, as opposed to one of your targets
+
+3. Select the `Info` tab
+
+4. Click the `+` button within the `Configurations` section and select `Duplicate "Release" Configuration`
+
+   ![Configuration](https://cloud.githubusercontent.com/assets/116461/16101597/088714c0-331c-11e6-9504-5469d9a59d74.png)
+
+5. Name the new configuration `Staging` (or whatever you prefer)
+
+6. Select the `Build Settings` tab
+
+7. Click the `+` button on the toolbar and select `Add User-Defined Setting`
+
+   ![Setting](https://cloud.githubusercontent.com/assets/116461/15764165/a16dbe30-28dd-11e6-94f2-fa3b7eb0c7de.png)
+
+   Name this new setting something like `Multi_Deployment_Config`. Go to the setting and add value `$(BUILD_DIR)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)` for Release. After that add value `$(BUILD_DIR)/Release$(EFFECTIVE_PLATFORM_NAME)` for Staging
+
+   ![MultiDeploymentConfig](https://user-images.githubusercontent.com/48414875/87178636-1d6a6500-c2e6-11ea-890d-b7773f07e503.png)
+
+   *NOTE: For Xcode 10 and lower version: Go to Build Location -> Per-configuration Build Products Path -> Staging and change Staging value from $(BUILD_DIR)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME) to $(BUILD_DIR)/Release$(EFFECTIVE_PLATFORM_NAME)*
+
+   ![BuildFilesPath1](https://cloud.githubusercontent.com/assets/4928157/22645377/b1d7df0e-ec77-11e6-83c6-291a27bcdb17.png)
+
+   *NOTE: Due to https://github.com/facebook/react-native/issues/11813, we have to do this step to make it possible to use other configurations than Debug or Release on RN 0.40.0 or higher.*
+
+8. Click the `+` button again on the toolbar and select `Add User-Defined Setting`
+
+   Name this new setting something like `CODEPUSH_KEY`, expand it, and specify your `Staging` deployment key for the `Staging` config and your `Production` deployment key for the `Release` config.
+
+    ![Setting Keys](https://cloud.githubusercontent.com/assets/8598682/16821919/fc1eac4a-490d-11e6-9b11-128129c24b80.png)
+
+    *NOTE: As a reminder, you can retrieve these keys by running `npx @swyng/cli app ls_deployment -n <AppName> -k (Show deployment key)` from your terminal.*
+
+9. Open your project's `Info.plist` file and change the value of your `CodePushDeploymentKey` entry to `$(CODEPUSH_KEY)`
+
+    ![Infoplist](https://cloud.githubusercontent.com/assets/116461/15764252/3ac8aed2-28de-11e6-8c19-2270ae9857a7.png)
+
+And that's it! Now when you run or build your app, your staging builds will automatically be configured to sync with your `Staging` deployment, and your release builds will be configured to sync with your `Production` deployment.
+
+*NOTE: CocoaPods users may need to run `pod install` before building with their new release configuration.*
+
+*Note: If you encounter the error message `ld: library not found for ...`, please consult [this issue](https://github.com/swyngpush/react-native/issues/426) for a possible solution.*
+
+Additionally, if you want to give them seperate names and/or icons, you can modify the `Product Bundle Identifier`, `Product Name` and `Asset Catalog App Icon Set Name` build settings, which will allow your staging builds to be distinguishable from release builds when installed on the same device.

package/docs/setup-android.md

@@ -0,0 +1,121 @@
+## Android Setup
+
+- [Android Setup](#android-setup)
+  - [Plugin Installation and Configuration for React Native 0.76 version and above (Android)](#plugin-installation-and-configuration-for-react-native-076-version-and-above-android)
+  - [Expo Integration](#expo-integration)
+
+In order to integrate CodePush into your Android project, please perform the following steps:
+
+### Plugin Installation and Configuration for React Native 0.76 version and above (Android)
+
+
+1. 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/@swyng/react-native-code-push/android/codepush.gradle"
+    ...
+    ```
+
+2. Update the `MainApplication` file to use CodePush via the following changes:
+
+    For React Native 0.76 to 0.81: update the `MainApplication.kt`
+
+    **Important! : PackageList must be instantiated only one in application lifetime.** 
+
+    ```kotlin
+    ...
+    // 1. Import the plugin class.
+    import com.microsoft.codepush.react.CodePush
+
+    class MainApplication : Application(), ReactApplication {
+       override val reactNativeHost: ReactNativeHost =
+           object : DefaultReactNativeHost(this) {
+               override fun getPackages(): List<ReactPackage> = PackageList(this).packages.apply {
+                 // Packages that cannot be autolinked yet can be added manually here, for example:
+                 // add(MyReactNativePackage())
+                }
+
+               // 2. Override the getJSBundleFile method in order to let
+               // the CodePush runtime determine where to get the JS
+               // bundle location from on each app start
+               override fun getJSBundleFile(): String {
+                 return CodePush.getJSBundleFile() 
+               }
+        };
+    }
+
+    For React Native 0.82 and above: update the `MainApplication.kt` as follows:
+
+    ```kotlin
+    ...
+    // 1. Import the plugin class.
+    import com.microsoft.codepush.react.CodePush
+
+    class MainApplication : Application(), ReactApplication {
+
+        override val reactHost: ReactHost by lazy {
+            getDefaultReactHost(
+            context = applicationContext,
+            packageList =
+                PackageList(this).packages.apply {
+                // Packages that cannot be autolinked yet can be added manually here, for example:
+                // add(MyReactNativePackage())
+                },
+            // 2. RN 0.82+ uses ReactHost config instead of overriding getJSBundleFile().
+            // Set jsBundleFilePath to CodePush so CodePush resolves the JS bundle path
+            // at startup (OTA update if available, fallback to bundled JS otherwise).
+            jsBundleFilePath = CodePush.getJSBundleFile(),
+            )
+        }
+    }
+    ```
+
+
+3. Add the Deployment key to `strings.xml`:
+
+   To let the CodePush runtime know which deployment it should query for updates, open your app's `strings.xml` file and add a new string named `CodePushDeploymentKey`, whose value is the key of the deployment you want to configure this app against (like the key for the `Staging` deployment for the `FooBar` app). You can retrieve this value by running `npx @swyng/cli app ls_deployment -n <AppName> -k (Show deployment key)` in the CodePush CLI (the `-k` flag is necessary since keys aren't displayed by default) and copying the value of the `Key` column which corresponds to the deployment you want to use (see below). Note that using the deployment's name (like Staging) will not work. The "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
+
+   In order to effectively make use of the `Staging` and `Production` deployments that were created along with your CodePush app, refer to the [multi-deployment testing](../README.md#multi-deployment-testing) docs below before actually moving your app's usage of CodePush into production.
+
+   Your `strings.xml` should looks like this:
+
+   ```xml
+    <resources>
+        <string name="app_name">AppName</string>
+        <string moduleConfig="true" name="CodePushDeploymentKey">DeploymentKey</string>
+    </resources>
+    ```
+
+    *Note: If you need to dynamically use a different deployment, you can also override your deployment key in JS code using [Code-Push options](./api-js.md#CodePushOptions)*
+
+
+In order to effectively make use of the `Staging` and `Production` deployments that were created along with your CodePush app, refer to the [multi-deployment testing](../README.md#multi-deployment-testing) docs below before actually moving your app's usage of CodePush into production.
+
+
+
+### Code Signing setup
+
+Starting with CLI version **2.1.0** you can self sign bundles during release and verify its signature before installation of update. For more info about Code Signing please refer to [relevant code-push documentation section](https://github.com/swyngpush/code-push/tree/v3.0.1/cli#code-signing). In order to use Public Key for Code Signing you need to do following steps:
+
+   Add `CodePushPublicKey` string item to `/path_to_your_app/android/app/src/main/res/values/strings.xml`. It may looks like this:
+
+ ```xml
+ <resources>
+    <string name="app_name">my_app</string>
+    <string name="CodePushPublicKey">-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtPSR9lkGzZ4FR0lxF+ZA
+P6jJ8+Xi5L601BPN4QESoRVSrJM08roOCVrs4qoYqYJy3Of2cQWvNBEh8ti3FhHu
+tiuLFpNdfzM4DjAw0Ti5hOTfTixqVBXTJPYpSjDh7K6tUvp9MV0l5q/Ps3se1vud
+M1/X6g54lIX/QoEXTdMgR+SKXvlUIC13T7GkDHT6Z4RlwxkWkOmf2tGguRcEBL6j
+ww7w/3g0kWILz7nNPtXyDhIB9WLH7MKSJWdVCZm+cAqabUfpCFo7sHiyHLnUxcVY
+OTw3sz9ceaci7z2r8SZdsfjyjiDJrq69eWtvKVUpredy9HtyALtNuLjDITahdh8A
+zwIDAQAB
+-----END PUBLIC KEY-----</string>
+</resources>
+ ```
+
+### Expo Integration 
+1. A pure expo react-native is not supported yet. We are planning to look into this after a while. See https://github.com/CodePushNext/react-native-code-push/issues/5
+2. A bare react-native app with expo sdk is supported, but you have to initialize rn app without `ReactNativeHostWrapper` of expo. It seems `ReactNativeHostWrapper` overrides `getJsBundleFile` internally, which prevents `CodePush` from being configured correctly.     
+   https://github.com/expo/expo/issues/25865

package/docs/setup-ios.md

@@ -0,0 +1,141 @@
+## 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 and Configuration for React Native 0.76 version and above (iOS)
+
+1. Run `cd ios && pod install && cd ..` to install all the necessary CocoaPods dependencies.
+​
+2. Change bundleUrl on AppDelegate file.
+
+   **If you're using objective-c:**  
+   1. Open up the `AppDelegate.m` file, and add an import statement for the CodePush headers:
+
+            ```objective-c
+            #import <CodePush/CodePush.h>
+            ```
+
+   2. Find the following line of code, which sets the source URL for bridge for production releases:
+
+      ```objective-c
+      return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
+      ```
+
+   3. Replace it with this line:
+   
+      ```objective-c
+      return [CodePush bundleURL];
+      ```
+      This change configures your app to always load the most recent version of your app's JS bundle. On the first launch, this will correspond to the file that was compiled with the app. However, after an update has been pushed via CodePush, this will return the location of the most recently installed update.
+   
+      *NOTE: The `bundleURL` method assumes your app's JS bundle is named `main.jsbundle`. If you have configured your app to use a different file name, simply call the `bundleURLForResource:` method (which assumes you're using the `.jsbundle` extension) or `bundleURLForResource:withExtension:` method instead, in order to overwrite that default behavior*
+   
+      Typically, you're only going to want to use CodePush to resolve your JS bundle location within release builds, and therefore, we recommend using the `DEBUG` pre-processor macro to dynamically switch between using the packager server and CodePush, depending on whether you are debugging or not. This will make it much simpler to ensure you get the right behavior you want in production, while still being able to use the Chrome Dev Tools, live reload, etc. at debug-time.
+   
+      Your `sourceURLForBridge` method should look like this:
+   
+      ```objective-c
+      - (NSURL *)sourceURLForBridge:(RCTBridge *)bridge
+      {
+        #if DEBUG
+          return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
+        #else
+          return [CodePush bundleURL];
+        #endif
+      }
+      ```
+   
+   **If you're using Swift:** 
+   1. Open up the `AppDelegate.swift` file, and add an import statement for the CodePush headers: 
+      ```swift
+      import CodePush
+      ```
+      
+   2. Find the following line of code, which sets the source URL for bridge for production release: 
+      ```swift
+      Bundle.main.url(forResource: "main", withExtension: "jsbundle")
+      ```
+   3. Replace it with this line: 
+      ```swift
+      CodePush.bundleURL()
+      ```
+      
+      Your `bundleUrl` method should look like this: 
+      ```swift
+      override func bundleURL() -> URL? {
+      #if DEBUG
+         RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index")
+      #else
+         CodePush.bundleURL()
+      #endif
+      }
+      ```
+
+4. Add the Deployment key to `Info.plist`:
+
+   To let the CodePush runtime know which deployment it should query for updates against, open your app's `Info.plist` file and add a new entry named `CodePushDeploymentKey`, whose value is the key of the deployment you want to configure this app against (like the key for the `Staging` deployment for the `FooBar` app). You can retrieve this value by running `npx @swyng/cli app ls_deployment -n <AppName> -k (Show deployment key)`  (the `-k` flag is necessary since keys aren't displayed by default) and copying the value of the `Key` column which corresponds to the deployment you want to use (see below). Note that using the deployment's name (like Staging) will not work. That "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
+
+   ![Deployment list](https://cloud.githubusercontent.com/assets/116461/11601733/13011d5e-9a8a-11e5-9ce2-b100498ffb34.png)
+
+   In order to effectively make use of the `Staging` and `Production` deployments that were created along with your CodePush app, refer to the [multi-deployment testing](../README.md#multi-deployment-testing) docs below before actually moving your app's usage of CodePush into production.
+
+   *Note: If you need to dynamically use a different deployment, you can also override your deployment key in JS code using [Code-Push options](./api-js.md#CodePushOptions)*
+
+    ```powershell
+    <key>CodePushDeploymentKey</key>
+    <string>deployment-key-here</string>
+    ```
+
+
+### HTTP exception domains configuration (iOS)
+
+CodePush plugin makes HTTPS requests to the following domains:
+
+- api.swyngpush.site
+
+If you want to change the default HTTP security configuration for any of these domains, you have to define the [`NSAppTransportSecurity` (ATS)][ats] configuration inside your __Info.plist__ file:
+
+```xml
+<plist version="1.0">
+  <dict>
+    <!-- ...other configs... -->
+
+    <key>NSAppTransportSecurity</key>
+    <dict>
+      <key>NSExceptionDomains</key>
+      <dict>
+        <key>api.swyngpush.site</key>
+        <dict><!-- read the ATS Apple Docs for available options --></dict>
+      </dict>
+    </dict>
+
+    <!-- ...other configs... -->
+  </dict>
+</plist>
+```
+
+Before doing anything, please [read the docs][ats] first.
+
+[ats]: https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW33
+
+### Code Signing setup
+
+Starting with CLI version **2.1.0** you can self sign bundles during release and verify its signature before installation of update. For more info about Code Signing please refer to [relevant code-push documentation section](https://github.com/swyngpush/code-push/tree/v3.0.1/cli#code-signing).
+
+In order to configure Public Key for bundle verification you need to add record in `Info.plist` with name `CodePushPublicKey` and string value of public key content. Example:
+
+```xml
+<plist version="1.0">
+  <dict>
+    <!-- ...other configs... -->
+
+    <key>CodePushPublicKey</key>
+        <string>-----BEGIN PUBLIC KEY-----
+MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANkWYydPuyOumR/sn2agNBVDnzyRpM16NAUpYPGxNgjSEp0etkDNgzzdzyvyl+OsAGBYF3jCxYOXozum+uV5hQECAwEAAQ==
+-----END PUBLIC KEY-----</string>
+
+    <!-- ...other configs... -->
+  </dict>
+</plist>
+```
+

package/docs/setup-windows.md

@@ -0,0 +1,121 @@
+## Windows Setup
+
+Once you've acquired the CodePush plugin, you need to integrate it into the Visual Studio project of your React Native app and configure it correctly. To do this, take the following steps:
+
+### Plugin Installation and Configuration for React Native Windows 0.63.6 version and above
+
+#### Plugin Installation (Windows-npx)
+
+Once the plugin has been downloaded, run `npx react-native autolink-windows` in your application's root directory to automatically add the CodePush c++ project to your application's windows solution file.
+
+#### Plugin Configuration (Windows)
+
+1. Replace the following files located at `windows/<app name>` with those in the CodePushDemoAppCpp example app in this repo found at `Examples/CodePushDemoAppCpp/windows/CodePushDemoAppCpp`:
+   1. app.h
+   2. app.cpp
+   3. app.xaml
+
+2. In the above files, replace any occurance of `CodePushDemoAppCpp` with the name of your application
+
+3. Enter your application's app version and deployment key to the `configMap` object at the top of your app's `OnLaunched` method in `App.cpp`:
+
+```c++
+...
+void App::OnLaunched(activation::LaunchActivatedEventArgs const& e)
+{
+    winrt::Microsoft::CodePush::ReactNative::CodePushConfig::SetHost(Host());
+    auto configMap{ winrt::single_threaded_map<hstring, hstring>() };
+    configMap.Insert(L"appVersion", L"1.0.0");
+    configMap.Insert(L"deploymentKey", L"<app deployment key>");
+    winrt::Microsoft::CodePush::ReactNative::CodePushConfig::Init(configMap);
+...
+}
+...
+```
+
+#### Plugin Configuration (Windows) C#
+
+1. add name space `Microsoft.CodePush` to `App.xaml.cs`
+
+2. add app version and deployment key to `configMap` at the start of your app's `OnLaunched` method in `App.xaml.cs`.
+
+```c#
+using Microsoft.CodePush;
+
+...
+protected override void OnLaunched(LaunchActivatedEventArgs e)
+{
+    Microsoft.CodePush.ReactNative.CodePushConfig.SetHost(Host);
+    IDictionary<string, string> configMap = new Dictionary<string, string>();
+    configMap.Add("appVersion", "1.0.0");
+    configMap.Add("deploymentKey", "deployment key");
+    Microsoft.CodePush.ReactNative.CodePushConfig.Init(configMap);
+...
+}
+...
+```
+
+
+### Plugin Installation and Configuration for React Native Windows lower than 0.60
+
+#### Plugin Installation (Windows)
+
+1. Open the Visual Studio solution located at `windows-legacy\<AppName>\<AppName>.sln` within your app
+
+2. Right-click the solution node in the `Solution Explorer` window and select the `Add -> Existing Project...` menu item
+
+   ![Add Project](https://cloud.githubusercontent.com/assets/116461/14467164/ddf6312e-008e-11e6-8a10-44a8b44b5dfc.PNG)
+
+3. Browse to the `node_modules\react-native-code-push\windows` directory, select the `CodePush.csproj` file and click `OK`
+
+4. Back in the `Solution Explorer`, right-click the project node that is named after your app, and select the `Add -> Reference...` menu item
+
+   ![Add Reference](https://cloud.githubusercontent.com/assets/116461/14467154/d833bc98-008e-11e6-8e95-09864b1f05ef.PNG)
+
+5. Select the `Projects` tab on the left hand side, check the `CodePush` item and then click `OK`
+
+   ![Add Reference Dialog](https://cloud.githubusercontent.com/assets/116461/14467147/cb805b6e-008e-11e6-964f-f856c59b65af.PNG)
+
+#### Plugin Configuration (Windows)
+
+After installing the plugin, you need to configure your app to consult CodePush for the location of your JS bundle, since it will "take control" of managing the current and all future versions. To do this, update the `MainReactNativeHost.cs` file to use CodePush via the following changes:
+
+```c#
+...
+// 1. Import the CodePush namespace
+using CodePush.ReactNative;
+...
+class MainReactNativeHost : ReactNativeHost
+{
+    // 2. Declare a private instance variable for the CodePushModule instance.
+    private CodePushReactPackage codePushReactPackage;
+
+    // 3. Update the JavaScriptBundleFile property to initalize the CodePush runtime,
+    // specifying the right deployment key, then use it to return the bundle URL from
+    // CodePush instead of statically from the binary. If you don't already have your
+    // deployment key, you can run "npx @swyng/cli app ls_deployment -n <AppName> -k (Show deployment key)" to retrieve it.
+    protected override string JavaScriptBundleFile
+    {
+        get
+        {
+            codePushReactPackage = new CodePushReactPackage("deployment-key-here", this);
+            return codePushReactPackage.GetJavaScriptBundleFile();
+        }
+    }
+
+    // 4. Add the codePushReactPackage instance to the list of existing packages.
+    protected override List<IReactPackage> Packages
+    {
+        get
+        {
+            return new List<IReactPackage>
+            {
+                new MainReactPackage(),
+                ...
+                codePushReactPackage
+            };
+        }
+    }
+    ...
+}
+```