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

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

@@ -0,0 +1,65 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../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`

package/docs/api-js/interfaces/CodePushOptions.md

@@ -0,0 +1,118 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / CodePushOptions
+
+# Interface: CodePushOptions
+
+## Extends
+
+- [`SyncOptions`](SyncOptions.md)
+
+## Properties
+
+### checkFrequency?
+
+> `optional` **checkFrequency**: [`CheckFrequency`](../enumerations/CheckFrequency.md)
+
+Specifies when you would like to synchronize updates with the CodePush server.
+
+Defaults to CheckFrequency.ON_APP_START.
+
+---
+
+### ignoreFailedUpdates?
+
+> `optional` **ignoreFailedUpdates**: `boolean`
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`ignoreFailedUpdates`](SyncOptions.md#ignorefailedupdates)
+
+---
+
+### installMode?
+
+> `optional` **installMode**: [`InstallMode`](../enumerations/InstallMode.md)
+
+Specifies when you would like to install regular updates (i.e. those that aren't marked as mandatory).
+
+Defaults to InstallMode.ON_NEXT_RESTART.
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`installMode`](SyncOptions.md#installmode)
+
+---
+
+### mandatoryInstallMode?
+
+> `optional` **mandatoryInstallMode**: [`InstallMode`](../enumerations/InstallMode.md)
+
+Specifies when you would like to install updates which are marked as mandatory.
+
+Defaults to InstallMode.IMMEDIATE.
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`mandatoryInstallMode`](SyncOptions.md#mandatoryinstallmode)
+
+---
+
+### minimumBackgroundDuration?
+
+> `optional` **minimumBackgroundDuration**: `number`
+
+Specifies the minimum number of seconds that the app needs to have been in the background before restarting the app. This property
+only applies to updates which are installed using `InstallMode.ON_NEXT_RESUME` or `InstallMode.ON_NEXT_SUSPEND`, and can be useful
+for getting your update in front of end users sooner, without being too obtrusive. Defaults to `0`, which has the effect of applying
+the update immediately after a resume or unless the app suspension is long enough to not matter, regardless how long it was in the background.
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`minimumBackgroundDuration`](SyncOptions.md#minimumbackgroundduration)
+
+---
+
+### releaseChannelPublicId?
+
+> `optional` **releaseChannelPublicId**: `string`
+
+Specifies the release channel you want to query for an update against.
+
+By default, this value is derived from the Info.plist file (iOS) and strings resources (Android), but this option allows you to override it from the JS-side if you need to dynamically use a different release channel for a specific call to sync.
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`releaseChannelPublicId`](SyncOptions.md#releasechannelpublicid)
+
+---
+
+### rollbackRetryOptions?
+
+> `optional` **rollbackRetryOptions**: `true` \| [`RollbackRetryOptions`](RollbackRetryOptions.md)
+
+The rollback retry mechanism allows the application to attempt to reinstall an update that was previously rolled back (with the restrictions specified in the options).
+
+This defaults to null, which has the effect of disabling the retry mechanism.
+Setting this to true will enable the retry mechanism with the default settings, and passing an object to this parameter allows enabling the rollback retry as well as overriding one or more of the default values.
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`rollbackRetryOptions`](SyncOptions.md#rollbackretryoptions)
+
+---
+
+### updateDialog?
+
+> `optional` **updateDialog**: `true` \| [`UpdateDialog`](UpdateDialog.md)
+
+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 true 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.
+
+#### Inherited from
+
+[`SyncOptions`](SyncOptions.md).[`updateDialog`](SyncOptions.md#updatedialog)

package/docs/api-js/interfaces/DownloadProgress.md

@@ -0,0 +1,23 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / DownloadProgress
+
+# Interface: DownloadProgress
+
+## Properties
+
+### receivedBytes
+
+> **receivedBytes**: `number`
+
+The number of bytes downloaded thus far.
+
+---
+
+### totalBytes
+
+> **totalBytes**: `number`
+
+The total number of bytes expected to be received for this update.

package/docs/api-js/interfaces/LocalPackage.md

@@ -0,0 +1,171 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / LocalPackage
+
+# Interface: LocalPackage
+
+Represents a downloaded update that is either already running, or has been installed and is pending an app restart.
+
+## Extends
+
+- [`Package`](Package.md)
+
+## Properties
+
+### appVersion
+
+> **appVersion**: `string`
+
+The app binary version that this update is dependent on. This is the value that was
+specified via the --target-binary-version parameter when calling the CLI's release command.
+
+#### Inherited from
+
+[`Package`](Package.md).[`appVersion`](Package.md#appversion)
+
+---
+
+### description
+
+> **description**: `string`
+
+The description of the update. This is the same value that you specified in the CLI when you released the update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`description`](Package.md#description)
+
+---
+
+### failedInstall
+
+> **failedInstall**: `boolean`
+
+Indicates whether this update has been previously installed but was rolled back.
+
+The `sync` method will automatically ignore updates which have previously failed, so you only need to worry about this property if using `checkForUpdate`.
+
+#### Inherited from
+
+[`Package`](Package.md).[`failedInstall`](Package.md#failedinstall)
+
+---
+
+### isFirstRun
+
+> **isFirstRun**: `boolean`
+
+Indicates whether this is the first time the update has been run after being installed.
+
+This is useful for determining whether you would like to show a "What's New?" UI to the end user after installing an update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`isFirstRun`](Package.md#isfirstrun)
+
+---
+
+### isMandatory
+
+> **isMandatory**: `boolean`
+
+Indicates whether the update is considered mandatory. This is the value that was specified in the CLI when the update was released.
+
+#### Inherited from
+
+[`Package`](Package.md).[`isMandatory`](Package.md#ismandatory)
+
+---
+
+### isPending
+
+> **isPending**: `boolean`
+
+Indicates whether this update is in a "pending" state. When true, that means the update has been downloaded and installed, but the app restart
+needed to apply it hasn't occurred yet, and therefore, its changes aren't currently visible to the end-user.
+
+#### Inherited from
+
+[`Package`](Package.md).[`isPending`](Package.md#ispending)
+
+---
+
+### label
+
+> **label**: `string`
+
+The internal label automatically given to the update by the CodePush server. This value uniquely identifies the update within its release channel.
+
+#### Inherited from
+
+[`Package`](Package.md).[`label`](Package.md#label)
+
+---
+
+### packageHash
+
+> **packageHash**: `string`
+
+The SHA hash value of the update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`packageHash`](Package.md#packagehash)
+
+---
+
+### packageSize
+
+> **packageSize**: `number`
+
+The size of the code contained within the update, in bytes.
+
+#### Inherited from
+
+[`Package`](Package.md).[`packageSize`](Package.md#packagesize)
+
+---
+
+### releaseChannelPublicId
+
+> **releaseChannelPublicId**: `string`
+
+The release channel public ID that was used to originally download this update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`releaseChannelPublicId`](Package.md#releasechannelpublicid)
+
+## Methods
+
+### install()
+
+> **install**(`installMode`?, `minimumBackgroundDuration`?, `onUpdateInstalled`?): `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.
+
+#### Parameters
+
+##### installMode?
+
+[`InstallMode`](../enumerations/InstallMode.md)
+
+Indicates when you would like the update changes to take effect for the end-user.
+
+##### minimumBackgroundDuration?
+
+`number`
+
+For resume-based installs, this specifies the number of seconds the app needs to be in the background before forcing a restart. Defaults to 0 if unspecified.
+
+##### onUpdateInstalled?
+
+() => `void` \| `Promise`\<`void`\>
+
+An optional promise called after app installation
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/api-js/interfaces/Package.md

@@ -0,0 +1,98 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / Package
+
+# Interface: Package
+
+## Extended by
+
+- [`LocalPackage`](LocalPackage.md)
+- [`RemotePackage`](RemotePackage.md)
+
+## Properties
+
+### appVersion
+
+> **appVersion**: `string`
+
+The app binary version that this update is dependent on. This is the value that was
+specified via the --target-binary-version parameter when calling the CLI's release command.
+
+---
+
+### description
+
+> **description**: `string`
+
+The description of the update. This is the same value that you specified in the CLI when you released the update.
+
+---
+
+### failedInstall
+
+> **failedInstall**: `boolean`
+
+Indicates whether this update has been previously installed but was rolled back.
+
+The `sync` method will automatically ignore updates which have previously failed, so you only need to worry about this property if using `checkForUpdate`.
+
+---
+
+### isFirstRun
+
+> **isFirstRun**: `boolean`
+
+Indicates whether this is the first time the update has been run after being installed.
+
+This is useful for determining whether you would like to show a "What's New?" UI to the end user after installing an update.
+
+---
+
+### isMandatory
+
+> **isMandatory**: `boolean`
+
+Indicates whether the update is considered mandatory. This is the value that was specified in the CLI when the update was released.
+
+---
+
+### isPending
+
+> **isPending**: `boolean`
+
+Indicates whether this update is in a "pending" state. When true, that means the update has been downloaded and installed, but the app restart
+needed to apply it hasn't occurred yet, and therefore, its changes aren't currently visible to the end-user.
+
+---
+
+### label
+
+> **label**: `string`
+
+The internal label automatically given to the update by the CodePush server. This value uniquely identifies the update within its release channel.
+
+---
+
+### packageHash
+
+> **packageHash**: `string`
+
+The SHA hash value of the update.
+
+---
+
+### packageSize
+
+> **packageSize**: `number`
+
+The size of the code contained within the update, in bytes.
+
+---
+
+### releaseChannelPublicId
+
+> **releaseChannelPublicId**: `string`
+
+The release channel public ID that was used to originally download this update.

package/docs/api-js/interfaces/RemotePackage.md

@@ -0,0 +1,169 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / RemotePackage
+
+# Interface: RemotePackage
+
+Represents an available update on the CodePush server that hasn't been downloaded yet.
+
+## Extends
+
+- [`Package`](Package.md)
+
+## Properties
+
+### appVersion
+
+> **appVersion**: `string`
+
+The app binary version that this update is dependent on. This is the value that was
+specified via the --target-binary-version parameter when calling the CLI's release command.
+
+#### Inherited from
+
+[`Package`](Package.md).[`appVersion`](Package.md#appversion)
+
+---
+
+### description
+
+> **description**: `string`
+
+The description of the update. This is the same value that you specified in the CLI when you released the update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`description`](Package.md#description)
+
+---
+
+### downloadUrl
+
+> **downloadUrl**: `string`
+
+The URL at which the package is available for download.
+
+This property is only needed for advanced usage, since the `download` method will automatically handle the acquisition of updates for you.
+
+---
+
+### failedInstall
+
+> **failedInstall**: `boolean`
+
+Indicates whether this update has been previously installed but was rolled back.
+
+The `sync` method will automatically ignore updates which have previously failed, so you only need to worry about this property if using `checkForUpdate`.
+
+#### Inherited from
+
+[`Package`](Package.md).[`failedInstall`](Package.md#failedinstall)
+
+---
+
+### isFirstRun
+
+> **isFirstRun**: `boolean`
+
+Indicates whether this is the first time the update has been run after being installed.
+
+This is useful for determining whether you would like to show a "What's New?" UI to the end user after installing an update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`isFirstRun`](Package.md#isfirstrun)
+
+---
+
+### isMandatory
+
+> **isMandatory**: `boolean`
+
+Indicates whether the update is considered mandatory. This is the value that was specified in the CLI when the update was released.
+
+#### Inherited from
+
+[`Package`](Package.md).[`isMandatory`](Package.md#ismandatory)
+
+---
+
+### isPending
+
+> **isPending**: `boolean`
+
+Indicates whether this update is in a "pending" state. When true, that means the update has been downloaded and installed, but the app restart
+needed to apply it hasn't occurred yet, and therefore, its changes aren't currently visible to the end-user.
+
+#### Inherited from
+
+[`Package`](Package.md).[`isPending`](Package.md#ispending)
+
+---
+
+### label
+
+> **label**: `string`
+
+The internal label automatically given to the update by the CodePush server. This value uniquely identifies the update within its release channel.
+
+#### Inherited from
+
+[`Package`](Package.md).[`label`](Package.md#label)
+
+---
+
+### packageHash
+
+> **packageHash**: `string`
+
+The SHA hash value of the update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`packageHash`](Package.md#packagehash)
+
+---
+
+### packageSize
+
+> **packageSize**: `number`
+
+The size of the code contained within the update, in bytes.
+
+#### Inherited from
+
+[`Package`](Package.md).[`packageSize`](Package.md#packagesize)
+
+---
+
+### releaseChannelPublicId
+
+> **releaseChannelPublicId**: `string`
+
+The release channel public ID that was used to originally download this update.
+
+#### Inherited from
+
+[`Package`](Package.md).[`releaseChannelPublicId`](Package.md#releasechannelpublicid)
+
+## Methods
+
+### download()
+
+> **download**(`downloadProgressCallback`?): `Promise`\<[`LocalPackage`](LocalPackage.md)\>
+
+Downloads the available update from the CodePush service.
+
+#### Parameters
+
+##### downloadProgressCallback?
+
+[`DownloadProgressCallback`](../type-aliases/DownloadProgressCallback.md)
+
+An optional callback that allows tracking the progress of the update while it is being downloaded.
+
+#### Returns
+
+`Promise`\<[`LocalPackage`](LocalPackage.md)\>

package/docs/api-js/interfaces/RollbackRetryOptions.md

@@ -0,0 +1,28 @@
+[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
+
+---
+
+[@appzung/react-native-code-push](../README.md) / RollbackRetryOptions
+
+# Interface: RollbackRetryOptions
+
+## Properties
+
+### delayInHours?
+
+> `optional` **delayInHours**: `number`
+
+Specifies the minimum time in hours that the app will wait after the latest rollback before attempting to reinstall same rolled-back package.
+
+Defaults to `24`.
+
+---
+
+### maxRetryAttempts?
+
+> `optional` **maxRetryAttempts**: `number`
+
+Specifies the maximum number of retry attempts that the app can make before it stops trying.
+Cannot be less than `1`.
+
+Defaults to `1`.