@appzung/react-native-code-push 11.0.0-rc2 → 11.0.0-rc3

package/README.md

@@ -142,7 +142,7 @@ If you would like your app to discover updates more quickly, you can also choose
 withCodePush({ checkFrequency: CheckFrequency.ON_APP_RESUME })(MyApp);
 ```
 
-Alternatively, if you want fine-grained control over when the check happens (like a button press or timer interval), eg. in a staging environment, you can call [`CodePush.sync()`](docs/api-js.md#codepushsync) at any time with your desired `SyncOptions`, and turn off CodePush's automatic checking by specifying a manual `checkFrequency`:
+Alternatively, if you want fine-grained control over when the check happens (like a button press or timer interval), eg. in a staging environment, you can call [`CodePush.sync()`](docs/api-js/functions/sync.md) at any time with your desired `SyncOptions`, and turn off CodePush's automatic checking by specifying a manual `checkFrequency`:
 
 ```javascript
 import withCodePush, { CheckFrequency, InstallMode } from '@appzung/react-native-code-push';
@@ -169,7 +169,7 @@ class MyApp extends Component {
 export default withCodePush({ checkFrequency: CheckFrequency.MANUAL })(MyApp);
 ```
 
-If you would like to display an update confirmation dialog (an "active install"), configure when an available update is installed (like force an immediate restart) or customize the update experience in any other way, refer to the [`codePush()`](docs/api-js.md#codepush) API reference for information on how to tweak this default behavior.
+If you would like to display an update confirmation dialog (an "active install"), configure when an available update is installed (like force an immediate restart) or customize the update experience in any other way, refer to the [`withCodePush()`](docs/api-js/functions/withCodePush.md) API reference for information on how to tweak this default behavior.
 
 ## Releasing updates
 
@@ -252,7 +252,7 @@ This is not necessarily the case for `updateDialog`, since it won't force the us
 
 ## API Reference
 
-- [JavaScript API](docs/api-js.md)
+- [JavaScript API](docs/api-js/README.md)
 - [Objective-C API Reference (iOS)](docs/api-ios.md)
 - [Java API Reference (Android)](docs/api-android.md)
 

package/android/app/src/main/java/com/appzung/codepush/react/CodePushNativeModule.java

@@ -820,6 +820,20 @@ public class CodePushNativeModule extends BaseJavaModule {
         mCodePush.clearUpdates();
     }
 
+    @ReactMethod
+    public void resetClientUniqueId(Promise promise) {
+        try {
+            String newClientUniqueId = UUID.randomUUID().toString();
+            SharedPreferences preferences = mCodePush.getContext().getSharedPreferences(CodePushConstants.CODE_PUSH_PREFERENCES, 0);
+            preferences.edit().putString(CodePushConstants.CLIENT_UNIQUE_ID_KEY, newClientUniqueId).apply();
+            mClientUniqueId = newClientUniqueId;
+            promise.resolve(mClientUniqueId);
+        } catch (Exception e) {
+            CodePushUtils.log(e);
+            promise.reject(e);
+        }
+    }
+
     @ReactMethod
     public void addListener(String eventName) {
         // Set up any upstream listeners or background tasks as necessary

package/docs/api-js/README.md

@@ -0,0 +1,55 @@
+**@appzung/react-native-code-push v11.0.0-rc3**
+
+---
+
+# @appzung/react-native-code-push v11.0.0-rc3
+
+## Enumerations
+
+- [CheckFrequency](enumerations/CheckFrequency.md)
+- [DeploymentStatus](enumerations/DeploymentStatus.md)
+- [InstallMode](enumerations/InstallMode.md)
+- [SyncStatus](enumerations/SyncStatus.md)
+- [UpdateState](enumerations/UpdateState.md)
+
+## Interfaces
+
+- [CodePushOptions](interfaces/CodePushOptions.md)
+- [DownloadProgress](interfaces/DownloadProgress.md)
+- [LocalPackage](interfaces/LocalPackage.md)
+- [Package](interfaces/Package.md)
+- [RemotePackage](interfaces/RemotePackage.md)
+- [RollbackRetryOptions](interfaces/RollbackRetryOptions.md)
+- [StatusReport](interfaces/StatusReport.md)
+- [SyncOptions](interfaces/SyncOptions.md)
+- [UpdateDialog](interfaces/UpdateDialog.md)
+
+## Type Aliases
+
+- [DownloadProgressCallback](type-aliases/DownloadProgressCallback.md)
+- [HandleBinaryVersionMismatchCallback](type-aliases/HandleBinaryVersionMismatchCallback.md)
+- [SyncStatusChangedCallback](type-aliases/SyncStatusChangedCallback.md)
+
+## Variables
+
+- [DEFAULT_UPDATE_DIALOG](variables/DEFAULT_UPDATE_DIALOG.md)
+
+## Functions
+
+- [allowRestart](functions/allowRestart.md)
+- [checkForUpdate](functions/checkForUpdate.md)
+- [clearUpdates](functions/clearUpdates.md)
+- [disallowRestart](functions/disallowRestart.md)
+- [getClientUniqueId](functions/getClientUniqueId.md)
+- [getUpdateMetadata](functions/getUpdateMetadata.md)
+- [notifyAppReady](functions/notifyAppReady.md)
+- [resetClientUniqueId](functions/resetClientUniqueId.md)
+- [restartApp](functions/restartApp.md)
+- [sync](functions/sync.md)
+- [withCodePush](functions/withCodePush.md)
+
+## References
+
+### default
+
+Renames and re-exports [withCodePush](functions/withCodePush.md)

package/docs/api-js/enumerations/CheckFrequency.md

@@ -0,0 +1,33 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / CheckFrequency
+
+# Enumeration: CheckFrequency
+
+Indicates when you would like to check for (and install) updates from the CodePush server.
+
+## Enumeration Members
+
+### MANUAL
+
+> **MANUAL**: `2`
+
+Don't automatically check for updates, but only do it when `sync()` is manually called in app code.
+
+---
+
+### ON_APP_RESUME
+
+> **ON_APP_RESUME**: `1`
+
+When the app re-enters the foreground after being "backgrounded" (user pressed the home button, app launches a separate payment process, etc.)
+
+---
+
+### ON_APP_START
+
+> **ON_APP_START**: `0`
+
+When the app is fully initialized (or more specifically, when the root component is mounted).

package/docs/api-js/enumerations/DeploymentStatus.md

@@ -0,0 +1,25 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / DeploymentStatus
+
+# Enumeration: DeploymentStatus
+
+Indicates the status of a deployment (after installing and restarting).
+
+## Enumeration Members
+
+### FAILED
+
+> **FAILED**: `"DeploymentFailed"`
+
+The deployment failed (and was rolled back).
+
+---
+
+### SUCCEEDED
+
+> **SUCCEEDED**: `"DeploymentSucceeded"`
+
+The deployment succeeded.

package/docs/api-js/enumerations/InstallMode.md

@@ -0,0 +1,50 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / InstallMode
+
+# Enumeration: InstallMode
+
+Indicates when you would like an installed update to actually be applied.
+
+## Enumeration Members
+
+### IMMEDIATE
+
+> **IMMEDIATE**: `number`
+
+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. Additionally, this mode can be used to enforce mandatory updates, since it removes the potentially undesired latency between the update installation and the next time the end user restarts or resumes the app.
+
+---
+
+### ON_NEXT_RESTART
+
+> **ON_NEXT_RESTART**: `number`
+
+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.
+
+---
+
+### ON_NEXT_RESUME
+
+> **ON_NEXT_RESUME**: `number`
+
+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 than 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.
+
+---
+
+### ON_NEXT_SUSPEND
+
+> **ON_NEXT_SUSPEND**: `number`
+
+Indicates that you want to install the update when the app is in the background,
+but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),
+so that user context isn't lost unless the app suspension is long enough to not matter.

package/docs/api-js/enumerations/SyncStatus.md

@@ -0,0 +1,85 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / SyncStatus
+
+# Enumeration: SyncStatus
+
+Indicates the current status of a sync operation.
+
+## Enumeration Members
+
+### AWAITING_USER_ACTION
+
+> **AWAITING_USER_ACTION**: `6`
+
+An update is available, and a confirmation dialog was shown
+to the end user. (This is only applicable when the `updateDialog` is used)
+
+---
+
+### CHECKING_FOR_UPDATE
+
+> **CHECKING_FOR_UPDATE**: `5`
+
+The CodePush server is being queried for an update.
+
+---
+
+### DOWNLOADING_PACKAGE
+
+> **DOWNLOADING_PACKAGE**: `7`
+
+An available update is being downloaded from the CodePush server.
+
+---
+
+### INSTALLING_UPDATE
+
+> **INSTALLING_UPDATE**: `8`
+
+An available update was downloaded and is about to be installed.
+
+---
+
+### SYNC_IN_PROGRESS
+
+> **SYNC_IN_PROGRESS**: `4`
+
+There is an ongoing `sync` operation running which prevents the current call from being executed.
+
+---
+
+### UNKNOWN_ERROR
+
+> **UNKNOWN_ERROR**: `3`
+
+The `sync` operation encountered an unknown error.
+
+---
+
+### UP_TO_DATE
+
+> **UP_TO_DATE**: `0`
+
+The app is fully up-to-date with the configured release channel.
+
+---
+
+### UPDATE_IGNORED
+
+> **UPDATE_IGNORED**: `2`
+
+The app had an optional update which the end user chose to ignore.
+(This is only applicable when the `updateDialog` is used)
+
+---
+
+### UPDATE_INSTALLED
+
+> **UPDATE_INSTALLED**: `1`
+
+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`

package/docs/api-js/enumerations/UpdateState.md

@@ -0,0 +1,37 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / UpdateState
+
+# Enumeration: UpdateState
+
+Indicates the state that an update is currently in.
+
+## Enumeration Members
+
+### LATEST
+
+> **LATEST**: `number`
+
+Indicates than an update represents the latest available release, and can be either currently running or pending.
+
+---
+
+### PENDING
+
+> **PENDING**: `number`
+
+Indicates than an update has been installed, but the app hasn't been restarted yet in order to apply it.
+
+This can be useful for determining whether there is a pending update, which you may want to force a programmatic restart (via `restartApp`) in order to apply.
+
+---
+
+### RUNNING
+
+> **RUNNING**: `number`
+
+Indicates that an update represents the version of the app that is currently running.
+
+This can be useful for identifying attributes about the app, for scenarios such as displaying the release description in a "what's new?" dialog or reporting the latest version to an analytics and/or crash reporting service.

package/docs/api-js/functions/allowRestart.md

@@ -0,0 +1,17 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / allowRestart
+
+# Function: allowRestart()
+
+> **allowRestart**(): `void`
+
+Allow CodePush to restart the app.
+
+This is an advanced API and is only necessary if your app explicitly disallowed restarts via the `disallowRestart` method.
+
+## Returns
+
+`void`

package/docs/api-js/functions/checkForUpdate.md

@@ -0,0 +1,29 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / checkForUpdate
+
+# Function: checkForUpdate()
+
+> **checkForUpdate**(`releaseChannelPublicId`?, `handleBinaryVersionMismatchCallback`?): `Promise`\<`null` \| [`RemotePackage`](../interfaces/RemotePackage.md)\>
+
+Asks the CodePush service whether the configured app release channel has an update available.
+
+## Parameters
+
+### releaseChannelPublicId?
+
+`string`
+
+The release channel public ID to use to query the CodePush server for an update.
+
+### handleBinaryVersionMismatchCallback?
+
+[`HandleBinaryVersionMismatchCallback`](../type-aliases/HandleBinaryVersionMismatchCallback.md)
+
+An optional callback for handling target binary version mismatch
+
+## Returns
+
+`Promise`\<`null` \| [`RemotePackage`](../interfaces/RemotePackage.md)\>

package/docs/api-js/functions/clearUpdates.md

@@ -0,0 +1,19 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / clearUpdates
+
+# Function: clearUpdates()
+
+> **clearUpdates**(): `void`
+
+Clears all downloaded CodePush updates.
+
+This is useful when switching to a different release channel which may have an older release than the current package.
+Note: we don’t recommend using this method in scenarios other than that (CodePush will call
+this method automatically when needed in other cases) as it could lead to unpredictable behavior.
+
+## Returns
+
+`void`

package/docs/api-js/functions/disallowRestart.md

@@ -0,0 +1,17 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / disallowRestart
+
+# Function: disallowRestart()
+
+> **disallowRestart**(): `void`
+
+Forbid CodePush to restart the app.
+
+This is an advanced API, and is useful when a component within your app (for example an onboarding process) needs to ensure that no end-user interruptions can occur during its lifetime.
+
+## Returns
+
+`void`

package/docs/api-js/functions/getClientUniqueId.md

@@ -0,0 +1,15 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / getClientUniqueId
+
+# Function: getClientUniqueId()
+
+> **getClientUniqueId**(): `Promise`\<`string`\>
+
+Gets the client's unique ID set by the module. You may also see `resetClientUniqueId`.
+
+## Returns
+
+`Promise`\<`string`\>

package/docs/api-js/functions/getUpdateMetadata.md

@@ -0,0 +1,23 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / getUpdateMetadata
+
+# Function: getUpdateMetadata()
+
+> **getUpdateMetadata**(`updateState`?): `Promise`\<`null` \| [`LocalPackage`](../interfaces/LocalPackage.md)\>
+
+Retrieves the metadata for an installed update (e.g. description, mandatory).
+
+## Parameters
+
+### updateState?
+
+[`UpdateState`](../enumerations/UpdateState.md)
+
+The state of the update you want to retrieve the metadata for. Defaults to UpdateState.RUNNING.
+
+## Returns
+
+`Promise`\<`null` \| [`LocalPackage`](../interfaces/LocalPackage.md)\>

package/docs/api-js/functions/notifyAppReady.md

@@ -0,0 +1,17 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / notifyAppReady
+
+# Function: notifyAppReady()
+
+> **notifyAppReady**(): `Promise`\<`void` \| [`StatusReport`](../interfaces/StatusReport.md)\>
+
+Notifies the CodePush runtime that an installed update is considered successful.
+
+If you are manually checking for and installing updates (i.e. not using the `sync` method to handle it all for you), then this method **MUST** be called; otherwise CodePush will treat the update as failed and rollback to the previous version when the app next restarts.
+
+## Returns
+
+`Promise`\<`void` \| [`StatusReport`](../interfaces/StatusReport.md)\>

package/docs/api-js/functions/resetClientUniqueId.md

@@ -0,0 +1,15 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / resetClientUniqueId
+
+# Function: resetClientUniqueId()
+
+> **resetClientUniqueId**(): `Promise`\<`string`\>
+
+Resets the client's unique ID. You may use this in some GDPR compliance scenarios. Note that this will create a new MAU if a new request is sent later.
+
+## Returns
+
+`Promise`\<`string`\>

package/docs/api-js/functions/restartApp.md

@@ -0,0 +1,25 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / restartApp
+
+# Function: restartApp()
+
+> **restartApp**(`onlyIfUpdateIsPending`): `Promise`\<`void`\>
+
+Immediately restarts the app.
+
+If there is an update pending, it will be immediately displayed to the end user. Otherwise, calling this method simply has the same behavior as the end user killing and restarting the process.
+
+## Parameters
+
+### onlyIfUpdateIsPending
+
+`boolean` = `false`
+
+Indicates whether you want the restart to no-op if there isn't currently a pending update.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/api-js/functions/sync.md

@@ -0,0 +1,43 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / sync
+
+# Function: sync()
+
+> **sync**(`options`?, `syncStatusChangedCallback`?, `downloadProgressCallback`?, `handleBinaryVersionMismatchCallback`?): `Promise`\<[`SyncStatus`](../enumerations/SyncStatus.md)\>
+
+Allows checking for an update, downloading it and installing it, all with a single call.
+
+Unless you need custom UI and/or behavior, we recommend most developers to use this method when integrating CodePush into their apps, if they are not using the `withCodePush` HOC.
+
+## Parameters
+
+### options?
+
+[`SyncOptions`](../interfaces/SyncOptions.md)
+
+Options used to configure the end-user update experience (e.g. show a prompt?, install the update immediately?).
+
+### syncStatusChangedCallback?
+
+[`SyncStatusChangedCallback`](../type-aliases/SyncStatusChangedCallback.md)
+
+An optional callback that allows tracking the status of the sync operation, as opposed to simply checking the resolved state via the returned Promise.
+
+### downloadProgressCallback?
+
+[`DownloadProgressCallback`](../type-aliases/DownloadProgressCallback.md)
+
+An optional callback that allows tracking the progress of an update while it is being downloaded.
+
+### handleBinaryVersionMismatchCallback?
+
+[`HandleBinaryVersionMismatchCallback`](../type-aliases/HandleBinaryVersionMismatchCallback.md)
+
+An optional callback for handling target binary version mismatch
+
+## Returns
+
+`Promise`\<[`SyncStatus`](../enumerations/SyncStatus.md)\>

package/docs/api-js/functions/withCodePush.md

@@ -0,0 +1,65 @@
+[**@appzung/react-native-code-push v11.0.0-rc3**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / withCodePush
+
+# Function: withCodePush()
+
+## Call Signature
+
+> **withCodePush**\<`P`\>(`component`): `ComponentType`
+
+Wraps a React component inside a "higher order" React component that knows how to synchronize your app's JavaScript bundle and image assets when it is mounted.
+
+Internally, the higher-order component calls `sync` inside its `componentDidMount` lifecycle handle, which in turns performs an update check, downloads the update if it exists and installs the update for you.
+
+### Type Parameters
+
+• **P** _extends_ `object`
+
+### Parameters
+
+#### component
+
+`ComponentType`\<`P`\>
+
+the React Component that will be decorated
+
+### Returns
+
+`ComponentType`
+
+## Call Signature
+
+> **withCodePush**\<`P`\>(`options`): (`component`) => `ComponentType`
+
+Wraps a React component inside a "higher order" React component that knows how to synchronize your app's JavaScript bundle and image assets when it is mounted.
+
+Internally, the higher-order component calls `sync` inside its `componentDidMount` lifecycle handle, which in turns performs an update check, downloads the update if it exists and installs the update for you.
+
+### Type Parameters
+
+• **P** _extends_ `object`
+
+### Parameters
+
+#### options
+
+[`CodePushOptions`](../interfaces/CodePushOptions.md)
+
+Options used to configure the end-user sync and update experience (e.g. when to check for updates?, show a prompt?, install the update immediately?).
+
+### Returns
+
+`Function`
+
+#### Parameters
+
+##### component
+
+`ComponentType`\<`P`\>
+
+#### Returns
+
+`ComponentType`