@appzung/react-native-code-push 8.3.2 → 10.0.0-rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. package/CodePush.js +22 -19
  2. package/CodePush.podspec +3 -3
  3. package/LICENSE.md +1 -1
  4. package/README.md +159 -296
  5. package/android/app/.gradle/config.properties +2 -0
  6. package/android/app/build.gradle +2 -0
  7. package/android/app/local.properties +8 -0
  8. package/android/app/src/main/AndroidManifest.xml +1 -2
  9. package/android/app/src/main/java/com/microsoft/codepush/react/CodePush.java +27 -21
  10. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushBuilder.java +5 -5
  11. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushConstants.java +1 -1
  12. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushDialog.java +1 -1
  13. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushInstallMode.java +2 -2
  14. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushInvalidPublicKeyException.java +2 -2
  15. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushInvalidUpdateException.java +1 -1
  16. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushMalformedDataException.java +2 -2
  17. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushNativeModule.java +5 -5
  18. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushNotInitializedException.java +2 -2
  19. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushTelemetryManager.java +14 -14
  20. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushUnknownException.java +2 -2
  21. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushUpdateManager.java +1 -1
  22. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushUpdateState.java +2 -2
  23. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushUpdateUtils.java +16 -9
  24. package/android/app/src/main/java/com/microsoft/codepush/react/CodePushUtils.java +1 -1
  25. package/android/app/src/main/java/com/microsoft/codepush/react/DownloadProgress.java +1 -1
  26. package/android/app/src/main/java/com/microsoft/codepush/react/DownloadProgressCallback.java +1 -1
  27. package/android/app/src/main/java/com/microsoft/codepush/react/FileUtils.java +1 -1
  28. package/android/app/src/main/java/com/microsoft/codepush/react/ReactInstanceHolder.java +1 -1
  29. package/android/app/src/main/java/com/microsoft/codepush/react/SettingsManager.java +1 -1
  30. package/android/app/src/main/java/com/microsoft/codepush/react/TLSSocketFactory.java +1 -1
  31. package/android/build.gradle +3 -0
  32. package/android/codepush.gradle +3 -3
  33. package/docs/advanced-usage.md +56 -0
  34. package/docs/api-android.md +12 -75
  35. package/docs/api-ios.md +5 -17
  36. package/docs/api-js.md +18 -55
  37. package/docs/setup-android.md +15 -397
  38. package/docs/setup-ios.md +24 -198
  39. package/docs/setup-windows.md +7 -74
  40. package/ios/CodePush/CodePush.h +4 -4
  41. package/ios/CodePush/CodePush.m +10 -9
  42. package/ios/CodePush/CodePushConfig.m +14 -11
  43. package/ios/CodePush/CodePushPackage.m +60 -60
  44. package/ios/CodePush/CodePushTelemetryManager.m +13 -13
  45. package/ios/CodePush.xcodeproj/project.pbxproj +24 -470
  46. package/ios/PrivacyInfo.xcprivacy +31 -0
  47. package/package.json +27 -24
  48. package/react-native.config.js +1 -1
  49. package/scripts/generateBundledResourcesHash.js +1 -1
  50. package/scripts/getFilesInFolder.js +1 -1
  51. package/scripts/recordFilesBeforeBundleCommand.js +1 -1
  52. package/typings/react-native-code-push.d.ts +22 -22
  53. package/windows/CodePush/CodePushConfig.cpp +3 -3
  54. package/windows/CodePush/CodePushConfig.h +3 -3
  55. package/windows/CodePush/CodePushNativeModule.cpp +27 -27
  56. package/windows/CodePush/CodePushNativeModule.h +4 -4
  57. package/windows/CodePush/CodePushTelemetryManager.cpp +12 -12
  58. package/windows/CodePush/CodePushTelemetryManager.h +1 -1
  59. package/.azurepipelines/build-rn-code-push-1es.yml +0 -104
  60. package/.azurepipelines/test-rn-code-push.yml +0 -94
  61. package/.config/CredScanSuppressions.json +0 -14
  62. package/SECURITY.md +0 -41
  63. package/docs/multi-deployment-testing-android.md +0 -148
  64. package/docs/multi-deployment-testing-ios.md +0 -59
  65. package/ios/CodePush/Base64/Base64/MF_Base64Additions.h +0 -34
  66. package/ios/CodePush/Base64/Base64/MF_Base64Additions.m +0 -252
  67. package/ios/CodePush/Base64/README.md +0 -47
  68. package/ios/CodePush/JWT/Core/Algorithms/Base/JWTAlgorithm.h +0 -69
  69. package/ios/CodePush/JWT/Core/Algorithms/Base/JWTAlgorithmFactory.h +0 -16
  70. package/ios/CodePush/JWT/Core/Algorithms/Base/JWTAlgorithmFactory.m +0 -51
  71. package/ios/CodePush/JWT/Core/Algorithms/Base/JWTAlgorithmNone.h +0 -15
  72. package/ios/CodePush/JWT/Core/Algorithms/Base/JWTAlgorithmNone.m +0 -55
  73. package/ios/CodePush/JWT/Core/Algorithms/ESFamily/JWTAlgorithmESBase.h +0 -24
  74. package/ios/CodePush/JWT/Core/Algorithms/ESFamily/JWTAlgorithmESBase.m +0 -41
  75. package/ios/CodePush/JWT/Core/Algorithms/HSFamily/JWTAlgorithmHSBase.h +0 -28
  76. package/ios/CodePush/JWT/Core/Algorithms/HSFamily/JWTAlgorithmHSBase.m +0 -205
  77. package/ios/CodePush/JWT/Core/Algorithms/Holders/JWTAlgorithmDataHolder.h +0 -103
  78. package/ios/CodePush/JWT/Core/Algorithms/Holders/JWTAlgorithmDataHolder.m +0 -322
  79. package/ios/CodePush/JWT/Core/Algorithms/Holders/JWTAlgorithmDataHolderChain.h +0 -37
  80. package/ios/CodePush/JWT/Core/Algorithms/Holders/JWTAlgorithmDataHolderChain.m +0 -145
  81. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/JWTAlgorithmRSBase.h +0 -35
  82. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/JWTAlgorithmRSBase.m +0 -551
  83. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/JWTRSAlgorithm.h +0 -23
  84. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/RSKeys/JWTCryptoKey.h +0 -43
  85. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/RSKeys/JWTCryptoKey.m +0 -230
  86. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/RSKeys/JWTCryptoKeyExtractor.h +0 -31
  87. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/RSKeys/JWTCryptoKeyExtractor.m +0 -113
  88. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/RSKeys/JWTCryptoSecurity.h +0 -38
  89. package/ios/CodePush/JWT/Core/Algorithms/RSFamily/RSKeys/JWTCryptoSecurity.m +0 -500
  90. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaim.h +0 -18
  91. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaim.m +0 -214
  92. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaimsSet.h +0 -23
  93. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaimsSet.m +0 -29
  94. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaimsSetSerializer.h +0 -19
  95. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaimsSetSerializer.m +0 -68
  96. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaimsSetVerifier.h +0 -18
  97. package/ios/CodePush/JWT/Core/ClaimSet/JWTClaimsSetVerifier.m +0 -72
  98. package/ios/CodePush/JWT/Core/Coding/JWTCoding+ResultTypes.h +0 -67
  99. package/ios/CodePush/JWT/Core/Coding/JWTCoding+ResultTypes.m +0 -111
  100. package/ios/CodePush/JWT/Core/Coding/JWTCoding+VersionOne.h +0 -119
  101. package/ios/CodePush/JWT/Core/Coding/JWTCoding+VersionOne.m +0 -307
  102. package/ios/CodePush/JWT/Core/Coding/JWTCoding+VersionThree.h +0 -94
  103. package/ios/CodePush/JWT/Core/Coding/JWTCoding+VersionThree.m +0 -619
  104. package/ios/CodePush/JWT/Core/Coding/JWTCoding+VersionTwo.h +0 -164
  105. package/ios/CodePush/JWT/Core/Coding/JWTCoding+VersionTwo.m +0 -514
  106. package/ios/CodePush/JWT/Core/Coding/JWTCoding.h +0 -24
  107. package/ios/CodePush/JWT/Core/Coding/JWTCoding.m +0 -11
  108. package/ios/CodePush/JWT/Core/FrameworkSupplement/JWT.h +0 -52
  109. package/ios/CodePush/JWT/Core/FrameworkSupplement/Map.modulemap +0 -5
  110. package/ios/CodePush/JWT/Core/Supplement/JWTBase64Coder.h +0 -28
  111. package/ios/CodePush/JWT/Core/Supplement/JWTBase64Coder.m +0 -70
  112. package/ios/CodePush/JWT/Core/Supplement/JWTDeprecations.h +0 -22
  113. package/ios/CodePush/JWT/Core/Supplement/JWTErrorDescription.h +0 -34
  114. package/ios/CodePush/JWT/Core/Supplement/JWTErrorDescription.m +0 -73
  115. package/ios/CodePush/JWT/LICENSE +0 -19
  116. package/ios/CodePush/JWT/README.md +0 -489
  117. package/ios/CodePush/SSZipArchive/Common.h +0 -81
  118. package/ios/CodePush/SSZipArchive/README.md +0 -1
  119. package/ios/CodePush/SSZipArchive/SSZipArchive.h +0 -76
  120. package/ios/CodePush/SSZipArchive/SSZipArchive.m +0 -691
  121. package/ios/CodePush/SSZipArchive/aes/aes.h +0 -198
  122. package/ios/CodePush/SSZipArchive/aes/aes_via_ace.h +0 -541
  123. package/ios/CodePush/SSZipArchive/aes/aescrypt.c +0 -294
  124. package/ios/CodePush/SSZipArchive/aes/aeskey.c +0 -548
  125. package/ios/CodePush/SSZipArchive/aes/aesopt.h +0 -739
  126. package/ios/CodePush/SSZipArchive/aes/aestab.c +0 -391
  127. package/ios/CodePush/SSZipArchive/aes/aestab.h +0 -173
  128. package/ios/CodePush/SSZipArchive/aes/brg_endian.h +0 -126
  129. package/ios/CodePush/SSZipArchive/aes/brg_types.h +0 -219
  130. package/ios/CodePush/SSZipArchive/aes/entropy.c +0 -54
  131. package/ios/CodePush/SSZipArchive/aes/entropy.h +0 -16
  132. package/ios/CodePush/SSZipArchive/aes/fileenc.c +0 -144
  133. package/ios/CodePush/SSZipArchive/aes/fileenc.h +0 -121
  134. package/ios/CodePush/SSZipArchive/aes/hmac.c +0 -145
  135. package/ios/CodePush/SSZipArchive/aes/hmac.h +0 -103
  136. package/ios/CodePush/SSZipArchive/aes/prng.c +0 -155
  137. package/ios/CodePush/SSZipArchive/aes/prng.h +0 -82
  138. package/ios/CodePush/SSZipArchive/aes/pwd2key.c +0 -103
  139. package/ios/CodePush/SSZipArchive/aes/pwd2key.h +0 -57
  140. package/ios/CodePush/SSZipArchive/aes/sha1.c +0 -258
  141. package/ios/CodePush/SSZipArchive/aes/sha1.h +0 -73
  142. package/ios/CodePush/SSZipArchive/minizip/crypt.h +0 -130
  143. package/ios/CodePush/SSZipArchive/minizip/ioapi.c +0 -369
  144. package/ios/CodePush/SSZipArchive/minizip/ioapi.h +0 -175
  145. package/ios/CodePush/SSZipArchive/minizip/mztools.c +0 -284
  146. package/ios/CodePush/SSZipArchive/minizip/mztools.h +0 -31
  147. package/ios/CodePush/SSZipArchive/minizip/unzip.c +0 -1839
  148. package/ios/CodePush/SSZipArchive/minizip/unzip.h +0 -248
  149. package/ios/CodePush/SSZipArchive/minizip/zip.c +0 -1910
  150. package/ios/CodePush/SSZipArchive/minizip/zip.h +0 -202
  151. package/scripts/postlink/android/postlink.js +0 -87
  152. package/scripts/postlink/ios/postlink.js +0 -116
  153. package/scripts/postlink/run.js +0 -11
  154. package/scripts/postunlink/android/postunlink.js +0 -74
  155. package/scripts/postunlink/ios/postunlink.js +0 -87
  156. package/scripts/postunlink/run.js +0 -11
  157. package/scripts/tools/linkToolsAndroid.js +0 -57
  158. package/scripts/tools/linkToolsIos.js +0 -130
  159. package/windows-legacy/CodePush/CodePush.csproj +0 -128
  160. package/windows-legacy/CodePush/CodePushUtils.cs +0 -47
  161. package/windows-legacy/CodePush/FileUtils.cs +0 -40
  162. package/windows-legacy/CodePush/Properties/AssemblyInfo.cs +0 -29
  163. package/windows-legacy/CodePush/Properties/CodePush.rd.xml +0 -33
  164. package/windows-legacy/CodePush/UpdateManager.cs +0 -305
  165. package/windows-legacy/CodePush/UpdateUtils.cs +0 -46
  166. package/windows-legacy/CodePush.Net46/Adapters/Http/HttpProgress.cs +0 -28
  167. package/windows-legacy/CodePush.Net46/Adapters/Storage/ApplicationDataContainer.cs +0 -106
  168. package/windows-legacy/CodePush.Net46/CodePush.Net46.csproj +0 -103
  169. package/windows-legacy/CodePush.Net46/CodePushUtils.cs +0 -158
  170. package/windows-legacy/CodePush.Net46/FileUtils.cs +0 -55
  171. package/windows-legacy/CodePush.Net46/Properties/AssemblyInfo.cs +0 -36
  172. package/windows-legacy/CodePush.Net46/UpdateManager.cs +0 -330
  173. package/windows-legacy/CodePush.Net46/UpdateUtils.cs +0 -70
  174. package/windows-legacy/CodePush.Net46/packages.config +0 -5
  175. package/windows-legacy/CodePush.Net46.Test/ApplicationDataContainerTest.cs +0 -105
  176. package/windows-legacy/CodePush.Net46.Test/CodePush.Net46.Test.csproj +0 -137
  177. package/windows-legacy/CodePush.Net46.Test/Properties/AssemblyInfo.cs +0 -36
  178. package/windows-legacy/CodePush.Net46.Test/TelemetryManagerTest.cs +0 -117
  179. package/windows-legacy/CodePush.Net46.Test/app.config +0 -11
  180. package/windows-legacy/CodePush.Net46.Test/packages.config +0 -4
  181. package/windows-legacy/CodePush.Shared/CodePush.Shared.projitems +0 -22
  182. package/windows-legacy/CodePush.Shared/CodePush.Shared.shproj +0 -13
  183. package/windows-legacy/CodePush.Shared/CodePushConstants.cs +0 -35
  184. package/windows-legacy/CodePush.Shared/CodePushNativeModule.cs +0 -329
  185. package/windows-legacy/CodePush.Shared/CodePushReactPackage.cs +0 -235
  186. package/windows-legacy/CodePush.Shared/CodePushUtils.cs +0 -70
  187. package/windows-legacy/CodePush.Shared/InstallMode.cs +0 -9
  188. package/windows-legacy/CodePush.Shared/MinimumBackgroundListener.cs +0 -44
  189. package/windows-legacy/CodePush.Shared/SettingsManager.cs +0 -148
  190. package/windows-legacy/CodePush.Shared/TelemetryManager.cs +0 -250
  191. package/windows-legacy/CodePush.Shared/UpdateState.cs +0 -9
package/docs/setup-ios.md CHANGED
@@ -1,11 +1,12 @@
1
1
  ## iOS Setup
2
2
 
3
- 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:
4
-
5
- ### Plugin Installation and Configuration for React Native 0.60 version and above (iOS)
3
+ * [Plugin Installation and Configuration](#plugin-installation-and-configuration)
4
+ * [Code Signing setup](#code-signing-setup)
5
+
6
+ ### Plugin Installation and Configuration
6
7
 
7
8
  1. Run `cd ios && pod install && cd ..` to install all the necessary CocoaPods dependencies.
8
-
9
+
9
10
  2. Open up the `AppDelegate.m` file, and add an import statement for the CodePush headers:
10
11
 
11
12
  ```objective-c
@@ -42,189 +43,36 @@ Once you've acquired the CodePush plugin, you need to integrate it into the Xcod
42
43
  }
43
44
  ```
44
45
 
45
- 5. Add the Deployment key to `Info.plist`:
46
-
47
- 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 `appcenter codepush deployment list -a <ownerName>/<appName> -k` in the AppCenter 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. That "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
48
-
49
- ![Deployment list](https://cloud.githubusercontent.com/assets/116461/11601733/13011d5e-9a8a-11e5-9ce2-b100498ffb34.png)
50
-
51
- 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.
52
-
53
- *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)*
54
-
55
- ### Plugin Installation for React Native lower than 0.60 (iOS)
56
-
57
- In order to accommodate as many developer preferences as possible, the CodePush plugin supports iOS installation via three mechanisms:
58
-
59
- 1. [**RNPM**](#plugin-installation-ios---rnpm) - [React Native Package Manager (RNPM)](https://github.com/rnpm/rnpm) is an awesome tool that provides the simplest installation experience possible for React Native plugins. If you're already using it, or you want to use it, then we recommend this approach.
60
-
61
- 2. [**CocoaPods**](#plugin-installation-ios---cocoapods) - If you're building a native iOS app that is embedding React Native into it, or you simply prefer using [CocoaPods](https://cocoapods.org), then we recommend using the Podspec file that we ship as part of our plugin.
62
-
63
- 3. [**"Manual"**](#plugin-installation-ios---manual) - If you don't want to depend on any additional tools or are fine with a few extra installation steps (it's a one-time thing), then go with this approach.
64
-
65
- #### Plugin Installation (iOS - RNPM)
66
-
67
- 1. As of v0.27 of React Native, `rnpm link` has already been merged into the React Native CLI. Simply run:
68
- ```
69
- react-native link react-native-code-push
70
- ```
71
-
72
- If your app uses a version of React Native that is lower than v0.27, run the following:
73
- ```
74
- rnpm link react-native-code-push
75
- ```
76
-
77
- *Note: If you don't already have RNPM installed, you can do so by simply running `npm i -g rnpm` and then executing the above command. If you already have RNPM installed, make sure you have v1.9.0+ in order to benefit from this one step install.*
78
-
79
- 2. You will be prompted for the deployment key you'd like to use. If you don't already have it, you can retrieve this value by running `appcenter codepush deployment list -a <ownerName>/<appName> -k`, or you can choose to ignore it (by simply hitting `<ENTER>`) and add it in later. To get started, we would recommend just using your `Staging` deployment key, so that you can test out the CodePush end-to-end.
80
-
81
- And that's it! Isn't RNPM awesome? :)
82
-
83
- #### Plugin Installation (iOS - CocoaPods)
84
-
85
- 1. Add the ReactNative and CodePush plugin dependencies to your `Podfile`, pointing at the path where NPM installed it
86
-
87
- ```
88
- # React Native requirements
89
- pod 'React', :path => '../node_modules/react-native', :subspecs => [
90
- 'Core',
91
- 'CxxBridge', # Include this for RN >= 0.47
92
- 'DevSupport', # Include this to enable In-App Devmenu if RN >= 0.43
93
- 'RCTText',
94
- 'RCTNetwork',
95
- 'RCTWebSocket', # Needed for debugging
96
- 'RCTAnimation', # Needed for FlatList and animations running on native UI thread
97
- # Add any other subspecs you want to use in your project
98
- ]
99
- # Explicitly include Yoga if you are using RN >= 0.42.0
100
- pod 'yoga', :path => '../node_modules/react-native/ReactCommon/yoga'
101
- pod 'DoubleConversion', :podspec => '../node_modules/react-native/third-party-podspecs/DoubleConversion.podspec'
102
- pod 'glog', :podspec => '../node_modules/react-native/third-party-podspecs/glog.podspec'
103
- pod 'Folly', :podspec => '../node_modules/react-native/third-party-podspecs/Folly.podspec'
104
-
105
- # CodePush plugin dependency
106
- pod 'CodePush', :path => '../node_modules/react-native-code-push'
107
- ```
108
-
109
- *NOTE: The above path needs to be relative to your app's `Podfile`, so adjust it as necessary.*
110
-
111
- *NOTE: `JWT` library should be >= version 3.0.x*
112
-
113
- 2. Run `pod install`
114
-
115
- *NOTE: The CodePush `.podspec` depends on the `React` pod, and so in order to ensure that it can correctly use the version of React Native that your app is built with, please make sure to define the `React` dependency in your app's `Podfile` as explained [here](https://facebook.github.io/react-native/docs/integration-with-existing-apps.html#podfile).*
116
-
117
- #### Plugin Installation (iOS - Manual)
118
-
119
- 1. Open your app's Xcode project
120
-
121
- 2. Find the `CodePush.xcodeproj` file within the `node_modules/react-native-code-push/ios` directory (or `node_modules/react-native-code-push` for <=`1.7.3-beta` installations) and drag it into the `Libraries` node in Xcode
122
-
123
- ![Add CodePush to project](https://cloud.githubusercontent.com/assets/8598682/13368613/c5c21422-dca0-11e5-8594-c0ec5bde9d81.png)
124
-
125
- 3. Select the project node in Xcode and select the "Build Phases" tab of your project configuration.
126
-
127
- 4. Drag `libCodePush.a` from `Libraries/CodePush.xcodeproj/Products` into the "Link Binary With Libraries" section of your project's "Build Phases" configuration.
128
-
129
- ![Link CodePush during build](https://cloud.githubusercontent.com/assets/516559/10322221/a75ea066-6c31-11e5-9d88-ff6f6a4d6968.png)
130
-
131
- 5. Click the plus sign underneath the "Link Binary With Libraries" list and select the `libz.tbd` library underneath the `iOS 9.1` node.
132
-
133
- ![Libz reference](https://cloud.githubusercontent.com/assets/116461/11605042/6f786e64-9aaa-11e5-8ca7-14b852f808b1.png)
134
-
135
- *Note: Alternatively, if you prefer, you can add the `-lz` flag to the `Other Linker Flags` field in the `Linking` section of the `Build Settings`.*
136
-
137
-
138
- ### Plugin Configuration for React Native lower than 0.60 (iOS)
139
-
140
- *NOTE: If you used RNPM or `react-native link` to automatically link the plugin, these steps have already been done for you so you may skip this section.*
141
-
142
- Once your Xcode project has been setup to build/link the CodePush plugin, you need to configure your app to consult CodePush for the location of your JS bundle, since it is responsible for synchronizing it with updates that are released to the CodePush server. To do this, perform the following steps:
143
-
144
- 1. Open up the `AppDelegate.m` file, and add an import statement for the CodePush headers:
145
-
146
- ```objective-c
147
- #import <CodePush/CodePush.h>
148
- ```
149
-
150
- For React Native 0.59 - 0.59.10:
151
-
152
- 2. Find the following line of code, which sets the source URL for bridge for production releases:
153
-
154
- ```objective-c
155
- return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"];
156
- ```
157
-
158
- 3. Replace it with this line:
46
+ 5. Add the Release channel public ID to `Info.plist`:
159
47
 
160
- ```objective-c
161
- return [CodePush bundleURL];
162
- ```
48
+ 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.
163
49
 
164
- For React Native 0.58 and below:
50
+ 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.
165
51
 
166
- 2. Find the following line of code, which loads your JS Bundle from the app binary for production releases:
52
+ *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.md#CodePushOptions)*
167
53
 
168
- ```objective-c
169
- jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index" fallbackResource:nil];
170
- ```
171
-
172
- 3. Replace it with this line:
173
-
174
- ```objective-c
175
- jsCodeLocation = [CodePush bundleURL];
176
- ```
177
-
178
- 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.
179
-
180
- *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*
181
-
182
- 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.
183
-
184
- For React Native 0.59 - 0.59.10:
185
-
186
- ```objective-c
187
- - (NSURL *)sourceURLForBridge:(RCTBridge *)bridge
188
- {
189
- #if DEBUG
190
- return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index" fallbackResource:nil];
191
- #else
192
- return [CodePush bundleURL];
193
- #endif
194
- }
195
- ```
196
-
197
- For React Native 0.49 - 0.58:
54
+ ### Code Signing setup
198
55
 
199
- ```objective-c
200
- NSURL *jsCodeLocation;
56
+ You can self sign bundles during release and verify its signature before installation of update.
201
57
 
202
- #ifdef DEBUG
203
- jsCodeLocation = [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index" fallbackResource:nil];
204
- #else
205
- jsCodeLocation = [CodePush bundleURL];
206
- #endif
207
- ```
58
+ In order to configure Public Key for bundle verification you need to add record in `Info.plist` with name `CodePushSigningPublicKey` and string value of public key content. Example:
208
59
 
209
- For React Native 0.48 and below:
60
+ ```xml
61
+ <plist version="1.0">
62
+ <dict>
63
+ <!-- ...other configs... -->
210
64
 
211
- ```objective-c
212
- NSURL *jsCodeLocation;
65
+ <key>CodePushSigningPublicKey</key>
66
+ <string>-----BEGIN PUBLIC KEY-----
67
+ MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANkWYydPuyOumR/sn2agNBVDnzyRpM16NAUpYPGxNgjSEp0etkDNgzzdzyvyl+OsAGBYF3jCxYOXozum+uV5hQECAwEAAQ==
68
+ -----END PUBLIC KEY-----</string>
213
69
 
214
- #ifdef DEBUG
215
- jsCodeLocation = [NSURL URLWithString:@"http://localhost:8081/index.ios.bundle?platform=ios&dev=true"];
216
- #else
217
- jsCodeLocation = [CodePush bundleURL];
218
- #endif
70
+ <!-- ...other configs... -->
71
+ </dict>
72
+ </plist>
219
73
  ```
220
74
 
221
- 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 `appcenter codepush deployment list -a <ownerName>/<appName> -k` in the AppCenter 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. That "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
222
-
223
- ![Deployment list](https://cloud.githubusercontent.com/assets/116461/11601733/13011d5e-9a8a-11e5-9ce2-b100498ffb34.png)
224
-
225
- 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.
226
-
227
- ### HTTP exception domains configuration (iOS)
75
+ ### (optional) HTTP exception domains configuration
228
76
 
229
77
  CodePush plugin makes HTTPS requests to the following domains:
230
78
 
@@ -255,25 +103,3 @@ If you want to change the default HTTP security configuration for any of these d
255
103
  Before doing anything, please [read the docs][ats] first.
256
104
 
257
105
  [ats]: https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW33
258
-
259
- ### Code Signing setup
260
-
261
- 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/microsoft/code-push/tree/v3.0.1/cli#code-signing).
262
-
263
- 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:
264
-
265
- ```xml
266
- <plist version="1.0">
267
- <dict>
268
- <!-- ...other configs... -->
269
-
270
- <key>CodePushPublicKey</key>
271
- <string>-----BEGIN PUBLIC KEY-----
272
- MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANkWYydPuyOumR/sn2agNBVDnzyRpM16NAUpYPGxNgjSEp0etkDNgzzdzyvyl+OsAGBYF3jCxYOXozum+uV5hQECAwEAAQ==
273
- -----END PUBLIC KEY-----</string>
274
-
275
- <!-- ...other configs... -->
276
- </dict>
277
- </plist>
278
- ```
279
-
@@ -2,13 +2,11 @@
2
2
 
3
3
  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:
4
4
 
5
- ### Plugin Installation and Configuration for React Native Windows 0.63.6 version and above
6
-
7
- #### Plugin Installation (Windows-npx)
5
+ ### Plugin Installation (Windows-npx)
8
6
 
9
7
  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.
10
8
 
11
- #### Plugin Configuration (Windows)
9
+ ### Plugin Configuration (Windows)
12
10
 
13
11
  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`:
14
12
  1. app.h
@@ -17,7 +15,7 @@ Once the plugin has been downloaded, run `npx react-native autolink-windows` in
17
15
 
18
16
  2. In the above files, replace any occurance of `CodePushDemoAppCpp` with the name of your application
19
17
 
20
- 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`:
18
+ 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`:
21
19
 
22
20
  ```c++
23
21
  ...
@@ -26,18 +24,18 @@ void App::OnLaunched(activation::LaunchActivatedEventArgs const& e)
26
24
  winrt::Microsoft::CodePush::ReactNative::CodePushConfig::SetHost(Host());
27
25
  auto configMap{ winrt::single_threaded_map<hstring, hstring>() };
28
26
  configMap.Insert(L"appVersion", L"1.0.0");
29
- configMap.Insert(L"deploymentKey", L"<app deployment key>");
27
+ configMap.Insert(L"releaseChannelPublicId", L"<app release channel public id>");
30
28
  winrt::Microsoft::CodePush::ReactNative::CodePushConfig::Init(configMap);
31
29
  ...
32
30
  }
33
31
  ...
34
32
  ```
35
33
 
36
- #### Plugin Configuration (Windows) C#
34
+ ### Plugin Configuration (Windows) C#
37
35
 
38
36
  1. add name space `Microsoft.CodePush` to `App.xaml.cs`
39
37
 
40
- 2. add app version and deployment key to `configMap` at the start of your app's `OnLaunched` method in `App.xaml.cs`.
38
+ 2. add app version and release channel public ID to `configMap` at the start of your app's `OnLaunched` method in `App.xaml.cs`.
41
39
 
42
40
  ```c#
43
41
  using Microsoft.CodePush;
@@ -48,74 +46,9 @@ protected override void OnLaunched(LaunchActivatedEventArgs e)
48
46
  Microsoft.CodePush.ReactNative.CodePushConfig.SetHost(Host);
49
47
  IDictionary<string, string> configMap = new Dictionary<string, string>();
50
48
  configMap.Add("appVersion", "1.0.0");
51
- configMap.Add("deploymentKey", "deployment key");
49
+ configMap.Add("releaseChannelPublicId", "release channel public id");
52
50
  Microsoft.CodePush.ReactNative.CodePushConfig.Init(configMap);
53
51
  ...
54
52
  }
55
53
  ...
56
54
  ```
57
-
58
-
59
- ### Plugin Installation and Configuration for React Native Windows lower than 0.60
60
-
61
- #### Plugin Installation (Windows)
62
-
63
- 1. Open the Visual Studio solution located at `windows-legacy\<AppName>\<AppName>.sln` within your app
64
-
65
- 2. Right-click the solution node in the `Solution Explorer` window and select the `Add -> Existing Project...` menu item
66
-
67
- ![Add Project](https://cloud.githubusercontent.com/assets/116461/14467164/ddf6312e-008e-11e6-8a10-44a8b44b5dfc.PNG)
68
-
69
- 3. Browse to the `node_modules\react-native-code-push\windows` directory, select the `CodePush.csproj` file and click `OK`
70
-
71
- 4. Back in the `Solution Explorer`, right-click the project node that is named after your app, and select the `Add -> Reference...` menu item
72
-
73
- ![Add Reference](https://cloud.githubusercontent.com/assets/116461/14467154/d833bc98-008e-11e6-8e95-09864b1f05ef.PNG)
74
-
75
- 5. Select the `Projects` tab on the left hand side, check the `CodePush` item and then click `OK`
76
-
77
- ![Add Reference Dialog](https://cloud.githubusercontent.com/assets/116461/14467147/cb805b6e-008e-11e6-964f-f856c59b65af.PNG)
78
-
79
- #### Plugin Configuration (Windows)
80
-
81
- 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:
82
-
83
- ```c#
84
- ...
85
- // 1. Import the CodePush namespace
86
- using CodePush.ReactNative;
87
- ...
88
- class MainReactNativeHost : ReactNativeHost
89
- {
90
- // 2. Declare a private instance variable for the CodePushModule instance.
91
- private CodePushReactPackage codePushReactPackage;
92
-
93
- // 3. Update the JavaScriptBundleFile property to initalize the CodePush runtime,
94
- // specifying the right deployment key, then use it to return the bundle URL from
95
- // CodePush instead of statically from the binary. If you don't already have your
96
- // deployment key, you can run "appcenter codepush deployment list -a <ownerName>/<appName> -k" to retrieve it.
97
- protected override string JavaScriptBundleFile
98
- {
99
- get
100
- {
101
- codePushReactPackage = new CodePushReactPackage("deployment-key-here", this);
102
- return codePushReactPackage.GetJavaScriptBundleFile();
103
- }
104
- }
105
-
106
- // 4. Add the codePushReactPackage instance to the list of existing packages.
107
- protected override List<IReactPackage> Packages
108
- {
109
- get
110
- {
111
- return new List<IReactPackage>
112
- {
113
- new MainReactPackage(),
114
- ...
115
- codePushReactPackage
116
- };
117
- }
118
- }
119
- ...
120
- }
121
- ```
@@ -51,10 +51,10 @@
51
51
 
52
52
  /*
53
53
  * This method allows dynamically setting the app's
54
- * deployment key, in addition to setting it via
55
- * the Info.plist file's CodePushDeploymentKey setting.
54
+ * release channel public ID, in addition to setting it via
55
+ * the Info.plist file's CodePushReleaseChannelPublicId setting.
56
56
  */
57
- + (void)setDeploymentKey:(NSString *)deploymentKey;
57
+ + (void)setReleaseChannelPublicId:(NSString *)releaseChannelPublicId;
58
58
 
59
59
  /*
60
60
  * This method checks to see whether a specific package hash
@@ -100,7 +100,7 @@
100
100
  @property (copy) NSString *appVersion;
101
101
  @property (readonly) NSString *buildVersion;
102
102
  @property (readonly) NSDictionary *configuration;
103
- @property (copy) NSString *deploymentKey;
103
+ @property (copy) NSString *releaseChannelPublicId;
104
104
  @property (copy) NSString *serverURL;
105
105
  @property (copy) NSString *publicKey;
106
106
 
@@ -5,6 +5,7 @@
5
5
  #import <React/RCTEventDispatcher.h>
6
6
  #import <React/RCTRootView.h>
7
7
  #import <React/RCTUtils.h>
8
+ #import <React/RCTReloadCommand.h>
8
9
  #else // back compatibility for RN version < 0.40
9
10
  #import "RCTAssert.h"
10
11
  #import "RCTBridgeModule.h"
@@ -31,7 +32,7 @@
31
32
  long long _latestExpectedContentLength;
32
33
  long long _latestReceivedConentLength;
33
34
  BOOL _didUpdateProgress;
34
-
35
+
35
36
  BOOL _allowed;
36
37
  BOOL _restartInProgress;
37
38
  NSMutableArray *_restartQueue;
@@ -214,9 +215,9 @@ static NSString *const LatestRollbackCountKey = @"count";
214
215
  [CodePushConfig current].appVersion = appVersion;
215
216
  }
216
217
 
217
- + (void)setDeploymentKey:(NSString *)deploymentKey
218
+ + (void)setReleaseChannelPublicId:(NSString *)releaseChannelPublicId
218
219
  {
219
- [CodePushConfig current].deploymentKey = deploymentKey;
220
+ [CodePushConfig current].releaseChannelPublicId = releaseChannelPublicId;
220
221
  }
221
222
 
222
223
  /*
@@ -376,7 +377,7 @@ static NSString *const LatestRollbackCountKey = @"count";
376
377
  _allowed = YES;
377
378
  _restartInProgress = NO;
378
379
  _restartQueue = [NSMutableArray arrayWithCapacity:1];
379
-
380
+
380
381
  self = [super init];
381
382
  if (self) {
382
383
  [self initializeUpdateAfterRestart];
@@ -540,7 +541,7 @@ static NSString *const LatestRollbackCountKey = @"count";
540
541
  [super.bridge setValue:[CodePush bundleURL] forKey:@"bundleURL"];
541
542
  }
542
543
 
543
- [super.bridge reload];
544
+ RCTTriggerReloadCommandListeners(@"react-native-code-push: Restart");
544
545
  });
545
546
  }
546
547
 
@@ -582,7 +583,7 @@ static NSString *const LatestRollbackCountKey = @"count";
582
583
  if ([[self class] isFailedHash:[failedPackage objectForKey:PackageHashKey]]) {
583
584
  return;
584
585
  }
585
-
586
+
586
587
  NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
587
588
  NSMutableArray *failedUpdates = [preferences objectForKey:FailedUpdatesKey];
588
589
  if (failedUpdates == nil) {
@@ -800,7 +801,7 @@ RCT_EXPORT_METHOD(downloadUpdate:(NSDictionary*)updatePackage
800
801
  * This is the native side of the CodePush.getConfiguration method. It isn't
801
802
  * currently exposed via the "react-native-code-push" module, and is used
802
803
  * internally only by the CodePush.checkForUpdate method in order to get the
803
- * app version, as well as the deployment key that was configured in the Info.plist file.
804
+ * app version, as well as the release channel public ID that was configured in the Info.plist file.
804
805
  */
805
806
  RCT_EXPORT_METHOD(getConfiguration:(RCTPromiseResolveBlock)resolve
806
807
  rejecter:(RCTPromiseRejectBlock)reject)
@@ -913,7 +914,7 @@ RCT_EXPORT_METHOD(installUpdate:(NSDictionary*)updatePackage
913
914
  selector:@selector(applicationDidBecomeActive)
914
915
  name:UIApplicationDidBecomeActiveNotification
915
916
  object:RCTSharedApplication()];
916
-
917
+
917
918
  [[NSNotificationCenter defaultCenter] addObserver:self
918
919
  selector:@selector(applicationWillEnterForeground)
919
920
  name:UIApplicationWillEnterForegroundNotification
@@ -1032,7 +1033,7 @@ RCT_EXPORT_METHOD(restartApp:(BOOL)onlyIfUpdateIsPending
1032
1033
 
1033
1034
  /*
1034
1035
  * This method clears CodePush's downloaded updates.
1035
- * It is needed to switch to a different deployment if the current deployment is more recent.
1036
+ * It is needed to switch to a different release channel if the current release channel is more recent.
1036
1037
  * Note: we don’t recommend to use this method in scenarios other than that (CodePush will call this method
1037
1038
  * automatically when needed in other cases) as it could lead to unpredictable behavior.
1038
1039
  */
@@ -10,7 +10,7 @@ static CodePushConfig *_currentConfig;
10
10
  static NSString * const AppVersionConfigKey = @"appVersion";
11
11
  static NSString * const BuildVersionConfigKey = @"buildVersion";
12
12
  static NSString * const ClientUniqueIDConfigKey = @"clientUniqueId";
13
- static NSString * const DeploymentKeyConfigKey = @"deploymentKey";
13
+ static NSString * const ReleaseChannelPublicIDConfigKey = @"releaseChannelPublicId";
14
14
  static NSString * const ServerURLConfigKey = @"serverUrl";
15
15
  static NSString * const PublicKeyKey = @"publicKey";
16
16
 
@@ -33,10 +33,10 @@ static NSString * const PublicKeyKey = @"publicKey";
33
33
 
34
34
  NSString *appVersion = [infoDictionary objectForKey:@"CFBundleShortVersionString"];
35
35
  NSString *buildVersion = [infoDictionary objectForKey:(NSString *)kCFBundleVersionKey];
36
- NSString *deploymentKey = [infoDictionary objectForKey:@"CodePushDeploymentKey"];
36
+ NSString *releaseChannelPublicId = [infoDictionary objectForKey:@"CodePushReleaseChannelPublicId"];
37
37
  NSString *serverURL = [infoDictionary objectForKey:@"CodePushServerURL"];
38
- NSString *publicKey = [infoDictionary objectForKey:@"CodePushPublicKey"];
39
-
38
+ NSString *publicKey = [infoDictionary objectForKey:@"CodePushSigningPublicKey"];
39
+
40
40
  NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
41
41
  NSString *clientUniqueId = [userDefaults stringForKey:ClientUniqueIDConfigKey];
42
42
  if (clientUniqueId == nil) {
@@ -55,8 +55,11 @@ static NSString * const PublicKeyKey = @"publicKey";
55
55
  if (buildVersion) [_configDictionary setObject:buildVersion forKey:BuildVersionConfigKey];
56
56
  if (serverURL) [_configDictionary setObject:serverURL forKey:ServerURLConfigKey];
57
57
  if (clientUniqueId) [_configDictionary setObject:clientUniqueId forKey:ClientUniqueIDConfigKey];
58
- if (deploymentKey) [_configDictionary setObject:deploymentKey forKey:DeploymentKeyConfigKey];
59
- if (publicKey) [_configDictionary setObject:publicKey forKey:PublicKeyKey];
58
+ if (releaseChannelPublicId) [_configDictionary setObject:releaseChannelPublicId forKey:ReleaseChannelPublicIDConfigKey];
59
+ if (publicKey) {
60
+ CPLog(@"Executing CodePush with a signing public key.");
61
+ [_configDictionary setObject:publicKey forKey:PublicKeyKey];
62
+ }
60
63
 
61
64
  return self;
62
65
  }
@@ -76,9 +79,9 @@ static NSString * const PublicKeyKey = @"publicKey";
76
79
  return _configDictionary;
77
80
  }
78
81
 
79
- - (NSString *)deploymentKey
82
+ - (NSString *)releaseChannelPublicId
80
83
  {
81
- return [_configDictionary objectForKey:DeploymentKeyConfigKey];
84
+ return [_configDictionary objectForKey:ReleaseChannelPublicIDConfigKey];
82
85
  }
83
86
 
84
87
  - (NSString *)serverURL
@@ -101,9 +104,9 @@ static NSString * const PublicKeyKey = @"publicKey";
101
104
  [_configDictionary setValue:appVersion forKey:AppVersionConfigKey];
102
105
  }
103
106
 
104
- - (void)setDeploymentKey:(NSString *)deploymentKey
107
+ - (void)setReleaseChannelPublicId:(NSString *)releaseChannelPublicId
105
108
  {
106
- [_configDictionary setValue:deploymentKey forKey:DeploymentKeyConfigKey];
109
+ [_configDictionary setValue:releaseChannelPublicId forKey:ReleaseChannelPublicIDConfigKey];
107
110
  }
108
111
 
109
112
  - (void)setServerURL:(NSString *)serverURL
@@ -111,6 +114,6 @@ static NSString * const PublicKeyKey = @"publicKey";
111
114
  [_configDictionary setValue:serverURL forKey:ServerURLConfigKey];
112
115
  }
113
116
 
114
- //no setter for PublicKey, because it's need to be hard coded within Info.plist for safety
117
+ //no setter for SigningPublicKey, because it's need to be hard coded within Info.plist for safety
115
118
 
116
119
  @end