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

package/src/types.ts

@@ -0,0 +1,237 @@
+import type { NativeUpdateNotification } from 'code-push/script/acquisition-sdk';
+import type { DeploymentStatus } from './enums/DeploymentStatus.enum';
+import type { InstallMode } from './enums/InstallMode.enum';
+import type { SyncStatus } from './enums/SyncStatus.enum';
+
+export interface UpdateDialog {
+  /**
+   * 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.
+   */
+  appendReleaseDescription?: boolean;
+
+  /**
+   * 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: "
+   */
+  descriptionPrefix?: string;
+
+  /**
+   * The text to use for the button the end user must press in order to install a mandatory update. Defaults to "Continue".
+   */
+  mandatoryContinueButtonLabel?: 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.".
+   */
+  mandatoryUpdateMessage?: 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".
+   */
+  optionalIgnoreButtonLabel?: string;
+
+  /**
+   * The text to use for the button the end user can press in order to install an optional update. Defaults to "Install".
+   */
+  optionalInstallButtonLabel?: 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?".
+   */
+  optionalUpdateMessage?: string;
+
+  /**
+   * The text used as the header of an update notification that is displayed to the end user. Defaults to "Update available".
+   */
+  title?: string;
+}
+
+export type DownloadProgressCallback = (progress: DownloadProgress) => void;
+export type SyncStatusChangedCallback = (status: SyncStatus) => void;
+export type HandleBinaryVersionMismatchCallback = (update: NativeUpdateNotification) => void;
+
+export interface DownloadProgress {
+  /**
+   * The total number of bytes expected to be received for this update.
+   */
+  totalBytes: number;
+
+  /**
+   * The number of bytes downloaded thus far.
+   */
+  receivedBytes: number;
+}
+
+export interface LocalPackage extends Package {
+  /**
+   * Installs the update by saving it to the location on disk where the runtime expects to find the latest version of the app.
+   *
+   * @param installMode Indicates when you would like the update changes to take effect for the end-user.
+   * @param minimumBackgroundDuration 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.
+   * @param onUpdateInstalled An optional promise called after app installation
+   */
+  install(
+    installMode?: InstallMode,
+    minimumBackgroundDuration?: number,
+    onUpdateInstalled?: () => Promise<void> | void,
+  ): Promise<void>;
+}
+
+export interface Package {
+  /**
+   * The app binary version that this update is dependent on. This is the value that was
+   * specified via the appStoreVersion parameter when calling the CLI's release command.
+   */
+  appVersion: string;
+
+  /**
+   * The release channel public ID that was used to originally download this update.
+   */
+  releaseChannelPublicId: string;
+
+  /**
+   * The description of the update. This is the same value that you specified in the CLI when you released the update.
+   */
+  description: string;
+
+  /**
+   * Indicates whether this update has been previously installed but was rolled back.
+   */
+  failedInstall: boolean;
+
+  /**
+   * Indicates whether this is the first time the update has been run after being installed.
+   */
+  isFirstRun: boolean;
+
+  /**
+   * Indicates whether the update is considered mandatory. This is the value that was specified in the CLI when the update was released.
+   */
+  isMandatory: 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.
+   */
+  isPending: boolean;
+
+  /**
+   * The internal label automatically given to the update by the CodePush server. This value uniquely identifies the update within its release channel.
+   */
+  label: string;
+
+  /**
+   * The SHA hash value of the update.
+   */
+  packageHash: string;
+
+  /**
+   * The size of the code contained within the update, in bytes.
+   */
+  packageSize: number;
+}
+
+export interface RemotePackage extends Package {
+  /**
+   * Downloads the available update from the CodePush service.
+   *
+   * @param downloadProgressCallback An optional callback that allows tracking the progress of the update while it is being downloaded.
+   */
+  download(downloadProgressCallback?: DownloadProgressCallback): Promise<LocalPackage>;
+
+  /**
+   * The URL at which the package is available for download.
+   */
+  downloadUrl: string;
+}
+
+export interface SyncOptions {
+  /**
+   * 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 script-side if you need to
+   * dynamically use a different release channel for a specific call to sync.
+   */
+  releaseChannelPublicId?: string;
+
+  /**
+   * Specifies when you would like to install optional updates (i.e. those that aren't marked as mandatory).
+   * Defaults to codePush.InstallMode.ON_NEXT_RESTART.
+   */
+  installMode?: InstallMode;
+
+  /**
+   * Specifies when you would like to install updates which are marked as mandatory.
+   * Defaults to codePush.InstallMode.IMMEDIATE.
+   */
+  mandatoryInstallMode?: InstallMode;
+
+  /**
+   * 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.
+   */
+  minimumBackgroundDuration?: number;
+
+  /**
+   * 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.
+   */
+  updateDialog?: UpdateDialog | true;
+
+  /**
+   * 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). It is an "options" object used to determine whether a rollback retry should occur, and if so, what settings to use
+   * for the rollback retry. 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.
+   */
+  rollbackRetryOptions?: RollbackRetryOptions | true;
+
+  ignoreFailedUpdates?: boolean;
+}
+
+export interface RollbackRetryOptions {
+  /**
+   * 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`.
+   */
+  delayInHours?: 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`.
+   */
+  maxRetryAttempts?: number;
+}
+
+export interface StatusReport {
+  /**
+   * Whether the deployment succeeded or failed.
+   */
+  status: DeploymentStatus;
+
+  /**
+   * The version of the app that was deployed (for a native app upgrade).
+   */
+  appVersion?: string;
+
+  /**
+   * Details of the package that was deployed (or attempted to).
+   */
+  package?: Package;
+
+  /**
+   * Release channel used when deploying the previous package.
+   */
+  previousReleaseChannelPublicId?: string;
+
+  /**
+   * The label (v#) of the package that was upgraded from.
+   */
+  previousLabelOrAppVersion?: string;
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig",
+  "exclude": ["Examples", "lib", "test"]
+}

package/tsconfig.json

@@ -1,14 +1,31 @@
 {
-    "compilerOptions": {
-        "target": "ES5",
-        "module": "commonjs",
-        "lib": ["es6"],
-        "noImplicitAny": true,
-        "noEmitOnError": true,
-        "moduleResolution": "node",
-        "sourceMap": true,
-        "rootDir": "test",
-        "outDir": "bin",
-        "removeComments": true
-    }
+  "exclude": ["test"],
+  "compilerOptions": {
+    "rootDir": ".",
+    "paths": {
+      "@appzung/react-native-code-push": ["./src/index"]
+    },
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react-jsx",
+    "lib": ["ESNext"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "noEmit": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitReturns": true,
+    "noImplicitUseStrict": false,
+    "noStrictGenericChecks": false,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "resolvePackageJsonImports": false,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ESNext",
+    "verbatimModuleSyntax": true
+  }
 }

package/AlertAdapter.js

@@ -1,24 +0,0 @@
-import React, { Platform } from "react-native";
-let { Alert } = React;
-
-if (Platform.OS === "android") {
-  const { NativeModules: { CodePushDialog } } = React;
-    
-  Alert = {
-    alert(title, message, buttons) {
-      if (buttons.length > 2) {
-        throw "Can only show 2 buttons for Android dialog.";
-      }
-      
-      const button1Text = buttons[0] ? buttons[0].text : null,
-            button2Text = buttons[1] ? buttons[1].text : null;
-      
-      CodePushDialog.showDialog(
-        title, message, button1Text, button2Text,
-        (buttonId) => { buttons[buttonId].onPress && buttons[buttonId].onPress(); }, 
-        (error) => { throw error; });
-    }
-  };
-}
-
-module.exports = { Alert };

package/CONTRIBUTING.md

@@ -1,134 +0,0 @@
-# Contributing
-
-## Using the plugin
-
-### Environment setup
-
-`node.js` and `npm` are needed for using this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: https://nodejs.org/download/.
-
-Once you have installed `node.js` and `npm`, install the dev dependencies for the project.
-
-```
-npm install
-```
-
-### Using the plugin manually
-
-Follow these steps to test your modifications to the plugin manually:
-- clone this repository
-- install the dependencies
-
-	Navigate to the root folder from your command line console and run:
-	```
-	npm install
-	```
-- install the plugin in a React-Native project
-
-	Navigate to the root folder of your React-Native project from your command line console and run:
-	```
-	npm install local_path_to_your_clone_of_this_repo
-	```
-- configure the plugin using the steps in the README.md
-- build and run your app on an emulator or device
-
-## Test
-
-### Environment setup
-
-First, make sure you have installed the dependencies for the plugin by following the steps above.
-
-Then, make sure you have installed `react-native`.
-
-```
-npm install -g react-native
-```
-
-To run Android tests, make sure you have `sdk\tools`, `sdk\emulator` and  `sdk\platform-tools` in your PATH.
-
-To run iOS tests, make sure you've installed CocoaPods and have `.gem/bin` in your PATH.
-
-### Supported platforms
-
-The plugin has end to end tests for Android and iOS. Depending on your development machine OS, you can run some or all the tests.
-
-OS            | Supported tests
-------------- | -------------
-OS X          | Android, iOS
-Windows       | Android
-
-### Test descriptions
-
-The tests first build the app.
-
-They then check if the required emulators are currently running.
-
-If an Android emulator is not running, it attempts to boot the latest Android emulator. You can specify an emulator by adding env variable `ANDROID_EMU=yourEmulatorNameHere` to the npm command. For example: `ANDROID_EMU=yourEmulatorNameHere npm run test:android`.
-
-If an iOS simulator is not running, it attempts to boot the latest iOS iPhone simulator. You can specify a simulator by adding env variable `IOS_EMU=yourSimulatorNameHere` to the npm command. For example: `IOS_EMU="iPhone 8 (0567DFF8-329E-41A3-BD6D-E48E9DD5EF39)" npm run test:ios`.
-
-If all the required emulators are not running and the tests fail to boot them, the tests will fail.
-
-If you would like the tests to always restart the necessary emulators (killing them if they are currently running), setup a env variable `CLEAN=true` to the command. For example: `CLEAN=true npm run test`.
-
-The desired unit tests are then run.
-
-If you would like to skip building, add a `:fast` in the command you'd like to run. For example, `npm run test:ios` becomes `npm run test:fast:ios` or `npm run test:android` becomes `npm run test:fast:android`.
-
-There is a both a full unit test suite and a "core" set of unit tests that you may run. If you would like to run only the core tests, setup a env variable `CORE=true` to the command. For example: `CORE=true npm run test:android`.
-
-If you would like to pull the plugin from NPM rather than running the tests on the local version, setup a env variable `NPM=true` to the command. For example: `NPM=true npm run test:ios`.
-
-#### Default
-
-To run all of the unit tests on Android and iOS:
-```
-npm run test
-```
-
-#### iOS
-
-To run all of the unit tests on iOS:
-```
-npm run test:ios
-```
-
-#### Android
-
-To run all of the unit tests on Android:
-```
-npm run test:android
-```
-
-#### More examples
-
-All possible testing configurations have tasks!
-
-The platforms are ordered as follows, and ran in that order:
-android, ios
-
-To run the core unit tests on Android:
-```
-CORE=true npm run test:android
-```
-
-To run all of the unit tests on iOS and pull the plugin from NPM:
-```
-NPM=true npm run test:ios
-```
-
-To run all of the unit tests on Android and iOS without building first:
-```
-npm run test:fast
-```
-
-To run all of the unit tests on iOS and restart the emulators:
-```
-CLEAN=true npm run test:ios
-```
-
-To run the core unit tests on Android and pull the plugin from NPM:
-```
-NPM=true CORE=true npm run test:android
-```
-
-...and so on!