update to master

Author: geof90

CodePush.h

@@ -12,7 +12,7 @@
  * This method assumes that your JS bundle is named "main.jsbundle"
  * and therefore, if it isn't, you should use either the bundleURLForResource:
  * or bundleURLForResource:withExtension: methods to override that behavior.
-*/
+ */
 + (NSURL *)bundleURL;
 
 + (NSURL *)bundleURLForResource:(NSString *)resourceName;
@@ -22,6 +22,13 @@
 
 + (NSString *)getApplicationSupportDirectory;
 
+/*
+ * This methods allows dynamically setting the app's
+ * deployment key, in addition to setting it via
+ * the Info.plist file's CodePushDeploymentKey setting.
+ */
++ (void)setDeploymentKey:(NSString *)deploymentKey;
+
 // The below methods are only used during tests.
 + (BOOL)isUsingTestConfiguration;
 + (void)setUsingTestConfiguration:(BOOL)shouldUseTestConfiguration;
@@ -62,7 +69,7 @@ failCallback:(void (^)(NSError *err))failCallback;
 @interface CodePushPackage : NSObject
 
 + (void)installPackage:(NSDictionary *)updatePackage
-               error:(NSError **)error;
+                 error:(NSError **)error;
 
 + (NSDictionary *)getCurrentPackage:(NSError **)error;
 + (NSString *)getCurrentPackageFolderPath:(NSError **)error;

CodePush.m

@@ -13,6 +13,8 @@ @implementation CodePush {
 
 RCT_EXPORT_MODULE()
 
+#pragma mark - Private constants
+
 static BOOL needToReportRollback = NO;
 static BOOL isRunningBinaryVersion = NO;
 static BOOL testConfigurationFlag = NO;
@@ -35,9 +37,8 @@ @implementation CodePush {
 static NSString *const PackageHashKey = @"packageHash";
 static NSString *const PackageIsPendingKey = @"isPending";
 
-@synthesize bridge = _bridge;
+#pragma mark - Public Obj-C API
 
-// Public Obj-C API (see header for method comments)
 + (NSURL *)bundleURL
 {
     return [self bundleURLForResource:@"main"];
@@ -88,7 +89,7 @@ + (NSURL *)bundleURLForResource:(NSString *)resourceName
 #ifndef DEBUG
         [CodePush clearUpdates];
 #endif
-
+        
         NSLog(logMessageFormat, binaryJsBundleUrl);
         isRunningBinaryVersion = YES;
         return binaryJsBundleUrl;
@@ -110,7 +111,12 @@ + (BOOL)isUsingTestConfiguration
     return testConfigurationFlag;
 }
 
-/* 
++ (void)setDeploymentKey:(NSString *)deploymentKey
+{
+    [CodePushConfig current].deploymentKey = deploymentKey;
+}
+
+/*
  * This is used to enable an environment in which tests can be run.
  * Specifically, it flips a boolean flag that causes bundles to be
  * saved to a test folder and enables the ability to modify
@@ -131,8 +137,9 @@ + (void)clearUpdates
     [self removeFailedUpdates];
 }
 
+#pragma mark - Private API methods
 
-// Private API methods
+@synthesize bridge = _bridge;
 
 /*
  * This method is used by the React Native bridge to allow
@@ -144,10 +151,10 @@ - (NSDictionary *)constantsToExport
 {
     // Export the values of the CodePushInstallMode enum
     // so that the script-side can easily stay in sync
-    return @{ 
-              @"codePushInstallModeOnNextRestart":@(CodePushInstallModeOnNextRestart),
-              @"codePushInstallModeImmediate": @(CodePushInstallModeImmediate),
-              @"codePushInstallModeOnNextResume": @(CodePushInstallModeOnNextResume)
+    return @{
+             @"codePushInstallModeOnNextRestart":@(CodePushInstallModeOnNextRestart),
+             @"codePushInstallModeImmediate": @(CodePushInstallModeImmediate),
+             @"codePushInstallModeOnNextResume": @(CodePushInstallModeOnNextResume)
             };
 };
 
@@ -234,7 +241,7 @@ - (BOOL)isPendingUpdate:(NSString*)packageHash
 {
     NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
     NSDictionary *pendingUpdate = [preferences objectForKey:PendingUpdateKey];
-
+    
     // If there is a pending update whose "state" isn't loading, then we consider it "pending".
     // Additionally, if a specific hash was provided, we ensure it matches that of the pending update.
     BOOL updateIsPending = pendingUpdate &&
@@ -350,7 +357,7 @@ - (void)savePendingUpdate:(NSString *)packageHash
     [preferences synchronize];
 }
 
-// JavaScript-exported module methods
+#pragma mark - JavaScript-exported module methods
 
 /*
  * This is native-side of the RemotePackage.download method
@@ -419,7 +426,7 @@ - (void)savePendingUpdate:(NSString *)packageHash
         // the script-side doesn't need to immediately call back into native to populate it.
         BOOL isPendingUpdate = [self isPendingUpdate:[package objectForKey:PackageHashKey]];
         [package setObject:@(isPendingUpdate) forKey:PackageIsPendingKey];
-
+        
         resolve(package);
     });
 }
@@ -551,7 +558,7 @@ - (void)savePendingUpdate:(NSString *)packageHash
 /*
  * This method is the native side of the CodePush.downloadAndReplaceCurrentBundle()
  * method, which replaces the current bundle with the one downloaded from
- * removeBundleUrl. It is only to be used during tests and no-ops if the test 
+ * removeBundleUrl. It is only to be used during tests and no-ops if the test
  * configuration flag is not set.
  */
 RCT_EXPORT_METHOD(downloadAndReplaceCurrentBundle:(NSString *)remoteBundleUrl)
@@ -561,4 +568,4 @@ - (void)savePendingUpdate:(NSString *)packageHash
     }
 }
 
-@end
+@end

README.md

@@ -266,13 +266,13 @@ The simplest way to do this is to perform the following in your app's root compo
 1. Import the JavaScript module for CodePush:
 
     ```javascript
-    import CodePush from "react-native-code-push";
+    import codePush from "react-native-code-push";
     ```
 
 2. Call the `sync` method from within the `componentDidMount` lifecycle event, to initiate a background update on each app start:
 
     ```javascript
-    CodePush.sync();
+    codePush.sync();
     ```
 
 If an update is available, it will be silently downloaded, and installed the next time the app is restarted (either explicitly by the end user or by the OS), which ensures the least invasive experience for your end users. If you would like to display a confirmation dialog (an "active install"), or customize the update experience in any way, refer to the `sync` method's [API reference](#codepushsync) for information on how to tweak this default behavior.
@@ -467,7 +467,7 @@ While the `sync` method tries to make it easy to perform silent and active updat
 
 * __deploymentKey__ *(String)* - Specifies the deployment key you want to query for an update against. By default, this value is derived from the `Info.plist` file (iOS) and `MainActivity.java` file (Android), but this option allows you to override it from the script-side if you need to dynamically use a different deployment for a specific call to `sync`.
 
-* __installMode__ *(CodePush.InstallMode)* - Indicates when you would like to "install" the update after downloading it, which includes reloading the JS bundle in order for any changes to take affect. Defaults to `CodePush.InstallMode.ON_NEXT_RESTART`. Refer to the [`InstallMode`](#installmode) enum reference for a description of the available options and what they do.
+* __installMode__ *(codePush.InstallMode)* - Indicates when you would like to "install" the update after downloading it, which includes reloading the JS bundle in order for any changes to take affect. Defaults to `codePush.InstallMode.ON_NEXT_RESTART`. Refer to the [`InstallMode`](#installmode) enum reference for a description of the available options and what they do.
 
 * __updateDialog__ *(UpdateDialogOptions)* - An "options" object used to determine whether a confirmation dialog should be displayed to the end user when an update is available, and if so, what strings to use. Defaults to `null`, which has the effect of disabling the dialog completely. Setting this to any truthy value will enable the dialog with the default strings, and passing an object to this parameter allows enabling the dialog as well as overriding one or more of the default strings. The following list represents the available options and their defaults:
     * __appendReleaseDescription__ *(Boolean)* - Indicates whether you would like to append the description of an available release to the notification message which is displayed to the end user. Defaults to `false`.
@@ -529,10 +529,10 @@ Example Usage:
 // and then display a "downloading" modal 
 codePush.sync({ updateDialog: true }, (status) => {
     switch (status) {
-        case CodePush.SyncStatus.DOWNLOADING_PACKAGE:
+        case codePush.SyncStatus.DOWNLOADING_PACKAGE:
             // Show "downloading" modal
             break;
-        case CodePush.SyncStatus.INSTALLING_UPDATE:
+        case codePush.SyncStatus.INSTALLING_UPDATE:
             // Hide "downloading" modal
             break;
     }
@@ -541,11 +541,11 @@ codePush.sync({ updateDialog: true }, (status) => {
 
 This method returns a `Promise` which is resolved to a `SyncStatus` code that indicates why the `sync` call succeeded. This code can be one of the following `SyncStatus` values:
 
-* __CodePush.SyncStatus.UP_TO_DATE__ *(4)* - The app is up-to-date with the CodePush server.
+* __codePush.SyncStatus.UP_TO_DATE__ *(4)* - The app is up-to-date with the CodePush server.
 
-* __CodePush.SyncStatus.UPDATE_IGNORED__ *(5)* - The app had an optional update which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
+* __codePush.SyncStatus.UPDATE_IGNORED__ *(5)* - The app had an optional update which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
 
-* __CodePush.SyncStatus.UPDATE_INSTALLED__ *(6)* - The update has been installed and will be run either immediately after the `syncStatusChangedCallback` function returns or the next time the app resumes/restarts, depending on the `InstallMode` specified in `SyncOptions`.
+* __codePush.SyncStatus.UPDATE_INSTALLED__ *(6)* - The update has been installed and will be run either immediately after the `syncStatusChangedCallback` function returns or the next time the app resumes/restarts, depending on the `InstallMode` specified in `SyncOptions`.
 
 If the update check and/or the subsequent download fails for any reason, the `Promise` object returned by `sync` will be rejected with the reason.
 
@@ -576,7 +576,7 @@ Contains details about an update that has been downloaded locally or already ins
 - __packageSize__: The size of the code contained within the update, in bytes. *(Number)*
 
 ###### Methods
-- __install(installMode: CodePush.InstallMode = CodePush.InstallMode.ON_NEXT_RESTART): Promise<void>__: Installs the update by saving it to the location on disk where the runtime expects to find the latest version of the app. The `installMode` parameter controls when the changes are actually presented to the end user. The default value is to wait until the next app restart to display the changes, but you can refer to the [`InstallMode`](#installmode) enum reference for a description of the available options and what they do.
+- __install(installMode: codePush.InstallMode = codePush.InstallMode.ON_NEXT_RESTART): Promise<void>__: Installs the update by saving it to the location on disk where the runtime expects to find the latest version of the app. The `installMode` parameter controls when the changes are actually presented to the end user. The default value is to wait until the next app restart to display the changes, but you can refer to the [`InstallMode`](#installmode) enum reference for a description of the available options and what they do.
 
 ##### RemotePackage
 
@@ -598,24 +598,24 @@ The CodePush API includes the following enums which can be used to customize the
 ##### InstallMode
 
 This enum specified when you would like an installed update to actually be applied, and can be passed to either the `sync` or `LocalPackage.install` methods. It includes the following values:
-* __CodePush.InstallMode.IMMEDIATE__ *(0)* - Indicates that you want to install the update and restart the app immediately. This value is appropriate for debugging scenarios as well as when displaying an update prompt to the user, since they would expect to see the changes immediately after accepting the installation.
+* __codePush.InstallMode.IMMEDIATE__ *(0)* - Indicates that you want to install the update and restart the app immediately. This value is appropriate for debugging scenarios as well as when displaying an update prompt to the user, since they would expect to see the changes immediately after accepting the installation.
 
-* __CodePush.InstallMode.ON_NEXT_RESTART__ *(1)* - Indicates that you want to install the update, but not forcibly restart the app. When the app is "naturally" restarted (due the OS or end user killing it), the update will be seamlessly picked up. This value is appropriate when performing silent updates, since it would likely be disruptive to the end user if the app suddenly restarted out of nowhere, since they wouldn't have realized an update was even downloaded. This is the default mode used for both the `sync` and `LocalPackage.install` methods.
+* __codePush.InstallMode.ON_NEXT_RESTART__ *(1)* - Indicates that you want to install the update, but not forcibly restart the app. When the app is "naturally" restarted (due the OS or end user killing it), the update will be seamlessly picked up. This value is appropriate when performing silent updates, since it would likely be disruptive to the end user if the app suddenly restarted out of nowhere, since they wouldn't have realized an update was even downloaded. This is the default mode used for both the `sync` and `LocalPackage.install` methods.
  
-* __CodePush.InstallMode.ON_NEXT_RESUME__ *(2)* - Indicates that you want to install the update, but don't want to restart the app until the next time the end user resumes it from the background. This way, you don't disrupt their current session, but you can get the update in front of them sooner then having to wait for the next natural restart. This value is appropriate for silent installs that can be applied on resume in a non-invasive way.
+* __codePush.InstallMode.ON_NEXT_RESUME__ *(2)* - Indicates that you want to install the update, but don't want to restart the app until the next time the end user resumes it from the background. This way, you don't disrupt their current session, but you can get the update in front of them sooner then having to wait for the next natural restart. This value is appropriate for silent installs that can be applied on resume in a non-invasive way.
 
 ##### SyncStatus
 
 This enum is provided to the `syncStatusChangedCallback` function that can be passed to the `sync` method, in order to hook into the overall update process. It includes the following values:
 
-* __CodePush.SyncStatus.CHECKING_FOR_UPDATE__ *(0)* - The CodePush server is being queried for an update.
-* __CodePush.SyncStatus.AWAITING_USER_ACTION__ *(1)* - An update is available, and a confirmation dialog was shown to the end user. (This is only applicable when the `updateDialog` is used)
-* __CodePush.SyncStatus.DOWNLOADING_PACKAGE__ *(2)* - An available update is being downloaded from the CodePush server.
-* __CodePush.SyncStatus.INSTALLING_UPDATE__ *(3)* - An available update was downloaded and is about to be installed.
-* __CodePush.SyncStatus.UP_TO_DATE__ *(4)* - The app is fully up-to-date with the configured deployment.
-* __CodePush.SyncStatus.UPDATE_IGNORED__ *(5)* - The app has an optional update, which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
-* __CodePush.SyncStatus.UPDATE_INSTALLED__ *(6)* - An available update has been installed and will be run either immediately after the `syncStatusChangedCallback` function returns or the next time the app resumes/restarts, depending on the `InstallMode` specified in `SyncOptions`.
-* __CodePush.SyncStatus.UNKNOWN_ERROR__ *(-1)* - The sync operation encountered an unknown error. 
+* __codePush.SyncStatus.CHECKING_FOR_UPDATE__ *(0)* - The CodePush server is being queried for an update.
+* __codePush.SyncStatus.AWAITING_USER_ACTION__ *(1)* - An update is available, and a confirmation dialog was shown to the end user. (This is only applicable when the `updateDialog` is used)
+* __codePush.SyncStatus.DOWNLOADING_PACKAGE__ *(2)* - An available update is being downloaded from the CodePush server.
+* __codePush.SyncStatus.INSTALLING_UPDATE__ *(3)* - An available update was downloaded and is about to be installed.
+* __codePush.SyncStatus.UP_TO_DATE__ *(4)* - The app is fully up-to-date with the configured deployment.
+* __codePush.SyncStatus.UPDATE_IGNORED__ *(5)* - The app has an optional update, which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
+* __codePush.SyncStatus.UPDATE_INSTALLED__ *(6)* - An available update has been installed and will be run either immediately after the `syncStatusChangedCallback` function returns or the next time the app resumes/restarts, depending on the `InstallMode` specified in `SyncOptions`.
+* __codePush.SyncStatus.UNKNOWN_ERROR__ *(-1)* - The sync operation encountered an unknown error. 
 
 ### Objective-C API Reference (iOS)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-code-push",
-  "version": "1.5.3-beta",
+  "version": "1.6.0-beta",
   "description": "React Native plugin for the CodePush service",
   "main": "CodePush.js",
   "homepage": "https://microsoft.github.io/code-push",