@appzung/react-native-code-push 11.0.0-rc4 → 11.0.0-rc6

package/docs/setup-android.md

@@ -1,80 +0,0 @@
-## Android Setup
-
-- [Plugin Installation and Configuration](#plugin-installation-and-configuration)
-
-### Plugin Installation and Configuration
-
-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/@appzung/react-native-code-push/android/codepush.gradle"
-   ...
-   ```
-
-2. Update the `MainApplication` file to use CodePush via the following changes:
-
-   If your MainApplication is a Kotlin file, update the `MainApplication.kt`
-
-   ```kotlin
-   ...
-   // 1. Import the plugin class.
-   import com.appzung.codepush.react.CodePush
-
-   class MainApplication : Application(), ReactApplication {
-
-   override val reactNativeHost: ReactNativeHost =
-       object : DefaultReactNativeHost(this) {
-           ...
-
-           // 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()
-           }
-       };
-   }
-   ```
-
-   If your MainApplication is a Java file: update the `MainApplication.java`
-
-   ```java
-   ...
-   // 1. Import the plugin class.
-   import com.appzung.codepush.react.CodePush;
-
-   public class MainApplication extends Application implements ReactApplication {
-
-       private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
-           ...
-
-           // 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
-           protected String getJSBundleFile() {
-               return CodePush.getJSBundleFile();
-           }
-       };
-   }
-   ```
-
-3. Add the release channel public ID to `strings.xml`:
-
-   To let the CodePush runtime know which release channel it should query for updates, open your app's `strings.xml` file and add a new string named `CodePushReleaseChannelPublicId`, whose value is the public ID of the release channel you want to configure this app against. You can retrieve this value by running `appzung release-channels list` in the AppZung CLI and copying the value of the `Public ID` column.
-
-   You may want to refer to the [multiple environments](./advanced-usage.md#multiple-environments) docs before actually moving your app's usage of CodePush into production.
-
-   Your `strings.xml` should look like this:
-
-   ```xml
-    <resources>
-        <string name="app_name">AppName</string>
-        <string moduleConfig="true" name="CodePushReleaseChannelPublicId">ReleaseChannelPublicId</string>
-    </resources>
-   ```
-
-   _Note: If you need to dynamically use a different release channel, you can also override your release channel public ID in JS code using [Code-Push options](./api-js/interfaces/CodePushOptions.md)_
-
-4. [Configure code signing](./code-signing.md), this is optional but recommended for security

package/docs/setup-ios.md

@@ -1,108 +0,0 @@
-## iOS Setup
-
-- [Plugin Installation and Configuration](#plugin-installation-and-configuration)
-
-### Plugin Installation and Configuration
-
-1. Run `cd ios && pod install && cd ..` to install all the necessary CocoaPods dependencies.
-
-2. Open up the `AppDelegate.m`/`AppDelegate.swift` file, and add an import statement for the CodePush headers:
-
-   ```objective-c
-   #import <CodePush/CodePush.h>
-   ```
-
-   ```swift
-   import CodePush
-   ```
-
-3. 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"];
-   ```
-
-   ```swift
-   Bundle.main.url(forResource: "main", withExtension: "jsbundle")
-   ```
-
-4. Replace it with this line:
-
-   ```objective-c
-   return [CodePush bundleURL];
-   ```
-
-   ```swift
-   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
-   }
-   ```
-
-   ```swift
-     override func bundleURL() -> URL? {
-   #if DEBUG
-       RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index")
-   #else
-       CodePush.bundleURL()
-   #endif
-     }
-   ```
-
-5. Add the Release channel public ID to `Info.plist`:
-
-   To let the CodePush runtime know which release channel it should query for updates against, open your app's `Info.plist` file and add a new entry named `CodePushReleaseChannelPublicId`, whose value is the public ID of the release channel you want to configure this app against. You can retrieve this value by running `appzung release-channels list` in the AppZung CLI and copying the value of the `Public ID` column.
-
-   You may want to refer to the [multiple environments](./advanced-usage.md#multiple-environments) docs before actually moving your app's usage of CodePush into production.
-
-   _Note: If you need to dynamically use a different release channel, you can also override your release channel public ID in JS code using [Code-Push options](./api-js/interfaces/CodePushOptions.mds)_
-
-6. [Configure code signing](./code-signing.md), this is optional but recommended for security
-
-### (optional) HTTP exception domains configuration
-
-CodePush plugin makes HTTPS requests to the following domains:
-
-- codepush.appzung.com
-- release-package-files-eu.appzung.com
-
-If you want to change the default HTTP security configuration for any of these domains (most of the time you don't), 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>codepush.appzung.com</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

package/docs/setup-windows.md

@@ -1,55 +0,0 @@
-## 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 (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 release channel public ID 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"releaseChannelPublicId", L"<app release channel public id>");
-    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 release channel public ID 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("releaseChannelPublicId", "release channel public id");
-    Microsoft.CodePush.ReactNative.CodePushConfig.Init(configMap);
-...
-}
-...
-```

package/typedoc.json

@@ -1,9 +0,0 @@
-{
-  "plugin": ["typedoc-plugin-markdown"],
-  "entryPoints": ["./src/index.ts"],
-  "out": "./docs/api-js",
-  "readme": "none",
-  "formatWithPrettier": true,
-  "includeVersion": true,
-  "disableSources": true
-}