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

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

@@ -1,98 +0,0 @@
-[**@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

@@ -1,169 +0,0 @@
-[**@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

@@ -1,28 +0,0 @@
-[**@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`.

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

@@ -1,47 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / StatusReport
-
-# Interface: StatusReport
-
-## Properties
-
-### appVersion?
-
-> `optional` **appVersion**: `string`
-
-The version of the app that was deployed (for a native app upgrade).
-
----
-
-### package?
-
-> `optional` **package**: [`Package`](Package.md)
-
-Details of the package that was deployed (or attempted to).
-
----
-
-### previousLabelOrAppVersion?
-
-> `optional` **previousLabelOrAppVersion**: `string`
-
-The label (v#) of the package that was upgraded from.
-
----
-
-### previousReleaseChannelPublicId?
-
-> `optional` **previousReleaseChannelPublicId**: `string`
-
-Release channel used when deploying the previous package.
-
----
-
-### status
-
-> **status**: [`DeploymentStatus`](../enumerations/DeploymentStatus.md)
-
-Whether the deployment succeeded or failed.

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

@@ -1,80 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / SyncOptions
-
-# Interface: SyncOptions
-
-## Extended by
-
-- [`CodePushOptions`](CodePushOptions.md)
-
-## Properties
-
-### ignoreFailedUpdates?
-
-> `optional` **ignoreFailedUpdates**: `boolean`
-
----
-
-### 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.
-
----
-
-### mandatoryInstallMode?
-
-> `optional` **mandatoryInstallMode**: [`InstallMode`](../enumerations/InstallMode.md)
-
-Specifies when you would like to install updates which are marked as mandatory.
-
-Defaults to InstallMode.IMMEDIATE.
-
----
-
-### 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.
-
----
-
-### 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.
-
----
-
-### 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.
-
----
-
-### 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.

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

@@ -1,89 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / UpdateDialog
-
-# Interface: UpdateDialog
-
-## Properties
-
-### appendReleaseDescription?
-
-> `optional` **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.
-
----
-
-### descriptionPrefix?
-
-> `optional` **descriptionPrefix**: `string`
-
-Indicates the string you would like to prefix the release description with, if any, when
-displaying the update notification to the end user.
-
-Defaults to " Description: "
-
----
-
-### mandatoryContinueButtonLabel?
-
-> `optional` **mandatoryContinueButtonLabel**: `string`
-
-The text to use for the button the end user must press in order to install a mandatory update.
-
-Defaults to "Continue".
-
----
-
-### mandatoryUpdateMessage?
-
-> `optional` **mandatoryUpdateMessage**: `string`
-
-The text used as the body of an update notification, when the update is specified as mandatory.
-
-Defaults to "An update is available that must be installed.".
-
----
-
-### optionalIgnoreButtonLabel?
-
-> `optional` **optionalIgnoreButtonLabel**: `string`
-
-The text to use for the button the end user can press in order to ignore an optional update that is available.
-
-Defaults to "Ignore".
-
----
-
-### optionalInstallButtonLabel?
-
-> `optional` **optionalInstallButtonLabel**: `string`
-
-The text to use for the button the end user can press in order to install an optional update.
-
-Defaults to "Install".
-
----
-
-### optionalUpdateMessage?
-
-> `optional` **optionalUpdateMessage**: `string`
-
-The text used as the body of an update notification, when the update is optional.
-
-Defaults to "An update is available. Would you like to install it?".
-
----
-
-### title?
-
-> `optional` **title**: `string`
-
-The text used as the header of an update notification that is displayed to the end user.
-
-Defaults to "Update available".

package/docs/api-js/type-aliases/DownloadProgressCallback.md

@@ -1,21 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / DownloadProgressCallback
-
-# Type Alias: DownloadProgressCallback()
-
-> **DownloadProgressCallback**: (`progress`) => `void`
-
-Called periodically when an available update is being downloaded from the CodePush server.
-
-## Parameters
-
-### progress
-
-[`DownloadProgress`](../interfaces/DownloadProgress.md)
-
-## Returns
-
-`void`

package/docs/api-js/type-aliases/HandleBinaryVersionMismatchCallback.md

@@ -1,23 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / HandleBinaryVersionMismatchCallback
-
-# Type Alias: HandleBinaryVersionMismatchCallback()
-
-> **HandleBinaryVersionMismatchCallback**: (`update`) => `void`
-
-Called when there are any binary update available.
-
-## Parameters
-
-### update
-
-#### appVersion
-
-`string`
-
-## Returns
-
-`void`

package/docs/api-js/type-aliases/SyncStatusChangedCallback.md

@@ -1,23 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / SyncStatusChangedCallback
-
-# Type Alias: SyncStatusChangedCallback()
-
-> **SyncStatusChangedCallback**: (`status`) => `void`
-
-Called when the sync process moves from one stage to another in the overall update process.
-
-The method is called with a status code which represents the current state, and can be any of the `SyncStatus` values.
-
-## Parameters
-
-### status
-
-[`SyncStatus`](../enumerations/SyncStatus.md)
-
-## Returns
-
-`void`

package/docs/api-js/variables/DEFAULT_UPDATE_DIALOG.md

@@ -1,12 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc4**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / DEFAULT_UPDATE_DIALOG
-
-# Variable: DEFAULT_UPDATE_DIALOG
-
-> `const` **DEFAULT_UPDATE_DIALOG**: [`UpdateDialog`](../interfaces/UpdateDialog.md)
-
-Represents the default settings that will be used by the sync method if
-an update dialog is configured to be displayed.

package/docs/code-signing.md

@@ -1,64 +0,0 @@
-## Code signing
-
-- [Configure your release process](#configure-your-release-process)
-- [Setup Android](#setup-android)
-- [Setup iOS](#setup-ios)
-
-Code signing is a security feature that helps ensure the integrity and authenticity of your app updates.
-It means no attacker can alter your bundled code sent to AppZung.
-
-### Configure your release process
-
-Generate the key pair:
-
-```shell
-# generate private RSA key
-openssl genrsa -out private_codepush_signing_key.pem
-# export public key
-openssl rsa -pubout -in private_codepush_signing_key.pem -out public_codepush_signing_key.pem
-```
-
-Store the private key securely.
-
-In the `appzung releases deploy-react-native` command that you run during your release process, add the `--private-key-path` flag pointing to the private key path.
-You should see `Code signing: true` in the confirmation text in interactive mode.
-
-After following the setup for your app below, if you previously sent a CodePush release without code-signing (the `--private-key-path` CLI flag), it is expected that when you check for updates CodePush doesn't present you this update, since it now expects a code signed release. Make sure when you test your integration that you sent a code-signed release.
-
-### Setup Android
-
-Add the `CodePushSigningPublicKey` string resource in `/android/app/src/main/res/values/strings.xml`. It may look like this:
-
-```xml
-<resources>
-   <string name="app_name">my_app</string>
-   <string name="CodePushSigningPublicKey">-----BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtPSR9lkGzZ4FR0lxF+ZA
-P6jJ8+Xi5L601BPN4QESoRVSrJM08roOCVrs4qoYqYJy3Of2cQWvNBEh8ti3FhHu
-tiuLFpNdfzM4DjAw0Ti5hOTfTixqVBXTJPYpSjDh7K6tUvp9MV0l5q/Ps3se1vud
-M1/X6g54lIX/QoEXTdMgR+SKXvlUIC13T7GkDHT6Z4RlwxkWkOmf2tGguRcEBL6j
-ww7w/3g0kWILz7nNPtXyDhIB9WLH7MKSJWdVCZm+cAqabUfpCFo7sHiyHLnUxcVY
-OTw3sz9ceaci7z2r8SZdsfjyjiDJrq69eWtvKVUpredy9HtyALtNuLjDITahdh8A
-zwIDAQAB
------END PUBLIC KEY-----</string>
-</resources>
-```
-
-### Setup iOS
-
-Add record in `Info.plist` with name `CodePushSigningPublicKey` and string value of public key content. Example:
-
-```xml
-<plist version="1.0">
-  <dict>
-    <!-- ...other configs... -->
-
-    <key>CodePushSigningPublicKey</key>
-        <string>-----BEGIN PUBLIC KEY-----
-MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANkWYydPuyOumR/sn2agNBVDnzyRpM16NAUpYPGxNgjSEp0etkDNgzzdzyvyl+OsAGBYF3jCxYOXozum+uV5hQECAwEAAQ==
------END PUBLIC KEY-----</string>
-
-    <!-- ...other configs... -->
-  </dict>
-</plist>
-```

package/docs/migrating-to-v10.md

@@ -1,31 +0,0 @@
-## Migration steps to @appzung/react-native-code-push v10+
-
-If you are less in a hurry, you can migrate to `@appzung/react-native-code-push` v10+ where we will add new features in the future and actively support the module.
-
-### Switch to @appzung/react-native-code-push npm package
-
-1. Replace `react-native-code-push` in your package.json with `@appzung/react-native-code-push`: `@appzung/react-native-code-push: "^10.0.0"`
-2. Run `npm install` (or `yarn` depending on your project)
-
-### Change your JS code
-
-1. Replace every `react-native-code-push` imports with `@appzung/react-native-code-push` imports
-2. (optional) As the package is now compatible with ESM, if you call CodePush functions like `CodePush.sync()` or import types/interfaces, you may have to replace your imports `import CodePush from` to selective imports `import withCodePush, { sync, DownloadProgress } from` (or `import * as CodePush from`)
-3. (optional) If you use a jest global mock, move the mock from `__mocks__/react-native-code-push.ts` to `__mocks__/@appzung/react-native-code-push.ts`
-4. (optional) If you use dynamic deployment assignation, rename `deploymentKey` option to `releaseChannelPublicId` (TypeScript should catch that)
-
-### Change your iOS setup
-
-1. Run `bundle exec pod install`
-2. Rename `CodePushDeploymentKey` to `CodePushReleaseChannelPublicId` in your `Info.plist`
-3. (optional) If you already use code signing, rename `CodePushPublicKey` to `CodePushSigningPublicKey` in your `Info.plist`
-
-### Change your Android setup
-
-1. In `android/settings.gradle` remove the lines about CodePush : `include ':react-native-code-push'` and `project(':react-native-code-push').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-code-push/android/app')`
-2. In `android/app/build.gradle` change the line about CodePush: `apply from: "../../node_modules/@appzung/react-native-code-push/android/codepush.gradle"`
-3. In your Android files (eg. `MainApplication.kt`), rename every `com.microsoft.codepush` prefix imports with `com.appzung.codepush`
-4. Rename `CodePushDeploymentKey` to `CodePushReleaseChannelPublicId` in your strings resources (located either at strings.xml or app/build.gradle).
-5. (optional) If you already use code signing, rename `CodePushPublicKey` to `CodePushSigningPublicKey` in your strings resources
-6. (optional) If you used `CodePushBuilder` to instantiate CodePush manually, it has been removed, consider using the standard way or contact us if you really need this
-7. (optional) If you used a custom CodePush `packageInstance` in your `react-native.config.js` file, it is no longer possible, consider using the standard way or contact us if you really need this