@appzung/react-native-code-push 11.0.0-rc5 → 11.0.0-rc7

package/src/clearUpdates.ts

@@ -7,4 +7,6 @@ import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePu
  * 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.
  */
-export const clearUpdates: () => void = NativeRNAppZungCodePushModule.clearUpdates;
+export function clearUpdates() {
+  return NativeRNAppZungCodePushModule.clearUpdates();
+}

package/src/dataTransmission.ts

@@ -0,0 +1,21 @@
+import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
+import { reloadCachedConfiguration } from './internals/getConfiguration';
+
+/**
+ * Controls data transmission for CodePush. This may be used for privacy optIn.
+ *
+ * @param enabled - When false, disables all external API calls to CodePush servers. Checking for updates will be disabled.
+ */
+export async function setDataTransmissionEnabled(enabled: boolean): Promise<void> {
+  await NativeRNAppZungCodePushModule.setDataTransmissionEnabled(enabled);
+  await reloadCachedConfiguration();
+}
+
+/**
+ * Gets the current data transmission status.
+ *
+ * When setDataTransmissionEnabled has never been called, returns the default value set in your configuration.
+ */
+export function getDataTransmissionEnabled(): Promise<boolean> {
+  return NativeRNAppZungCodePushModule.getDataTransmissionEnabled();
+}

package/src/disallowRestart.ts

@@ -5,4 +5,6 @@ import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePu
  *
  * 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.
  */
-export const disallowRestart: () => void = NativeRNAppZungCodePushModule.disallow;
+export function disallowRestart() {
+  return NativeRNAppZungCodePushModule.disallow();
+}

package/src/enums/LogLevel.enum.ts

@@ -1,3 +1,6 @@
+/**
+ * Used to categorize log messages by their severity and importance.
+ */
 export enum LogLevel {
   DEBUG,
   INFO,

package/src/index.ts

@@ -11,6 +11,9 @@ export * from './sync';
 export * from './getClientUniqueId';
 export * from './resetClientUniqueId';
 export * from './logLevel';
+export * from './logger';
+export * from './telemetry';
+export * from './dataTransmission';
 
 export * from './types';
 

package/src/internals/CodePushApiSdk.ts

@@ -1,3 +1,4 @@
+import { LogLevel } from '../enums/LogLevel.enum';
 import { CodePushError, CodePushHttpError } from './CodePushApiSdk.errors';
 import {
   type ApiSdkConfiguration,
@@ -22,6 +23,7 @@ export class CodePushApiSdk {
 
   constructor(
     private readonly httpRequester: Http.Requester,
+    private readonly log: (level: LogLevel, message: string) => void,
     configuration: ApiSdkConfiguration,
   ) {
     this.configuration = { ...configuration };
@@ -34,6 +36,11 @@ export class CodePushApiSdk {
   async queryUpdateWithCurrentPackage(
     currentPackageInfo: ApiSdkQueryUpdatePackageInfo,
   ): Promise<ApiSdkRemotePackage | ApiSdkNativeUpdateNotification | null> {
+    if (!this.configuration.dataTransmissionEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped querying for update because data transmission is disabled');
+      return null;
+    }
+
     const query: CheckUpdateRequestInput = {
       deployment_key: this.configuration.releaseChannelPublicId,
       app_version: currentPackageInfo.appVersion,
@@ -86,6 +93,16 @@ export class CodePushApiSdk {
     previousLabelOrAppVersion: string | null,
     previousDeploymentKey: string | null,
   ): Promise<void> {
+    if (!this.configuration.dataTransmissionEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped reporting deploy status because data transmission is disabled');
+      return;
+    }
+
+    if (!this.configuration.telemetryEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped reporting deploy status because telemetry is disabled');
+      return;
+    }
+
     const requestBody: ReportDeployInput = {
       app_version: this.configuration.appVersion,
       deployment_key: this.configuration.releaseChannelPublicId,
@@ -116,6 +133,16 @@ export class CodePushApiSdk {
   }
 
   async reportStatusDownload(downloadedPackage: ApiSdkDownloadReportPackageInfo): Promise<void> {
+    if (!this.configuration.dataTransmissionEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped reporting download because data transmission is disabled');
+      return;
+    }
+
+    if (!this.configuration.telemetryEnabled) {
+      this.log(LogLevel.DEBUG, 'Skipped reporting download because telemetry is disabled');
+      return;
+    }
+
     const requestBody: ReportDownloadInput = {
       client_unique_id: this.configuration.clientUniqueId,
       deployment_key: this.configuration.releaseChannelPublicId,

package/src/internals/CodePushApiSdk.types.ts

@@ -45,6 +45,8 @@ export interface ApiSdkConfiguration {
   clientUniqueId: string;
   releaseChannelPublicId: string;
   serverUrl: string;
+  dataTransmissionEnabled: boolean;
+  telemetryEnabled: boolean;
   ignoreAppVersion?: boolean;
 }
 

package/src/internals/CodePushEventEmitter.ts

@@ -0,0 +1,4 @@
+import { NativeEventEmitter } from 'react-native';
+import { NativeRNAppZungCodePushModule } from './NativeRNAppZungCodePushModule';
+
+export const CodePushEventEmitter = new NativeEventEmitter(NativeRNAppZungCodePushModule);

package/src/internals/RNAppZungCodePushModuleSpec.ts

@@ -52,4 +52,10 @@ export interface Spec extends TurboModule {
 
   isFirstRun(packageHash: string): Promise<boolean>;
   isFailedUpdate(packageHash: string): Promise<boolean>;
+
+  setTelemetryEnabled(enabled: boolean): Promise<void>;
+  getTelemetryEnabled(): Promise<boolean>;
+
+  setDataTransmissionEnabled(enabled: boolean): Promise<void>;
+  getDataTransmissionEnabled(): Promise<boolean>;
 }

package/src/internals/RemotePackageImplementation.ts

@@ -1,7 +1,7 @@
-import { NativeEventEmitter } from 'react-native';
 import { LogLevel } from '../enums/LogLevel.enum';
 import type { DownloadProgressCallback, LocalPackage, RemotePackage } from '../types';
 import type { ApiSdkDownloadReportPackageInfo } from './CodePushApiSdk.types';
+import { CodePushEventEmitter } from './CodePushEventEmitter';
 import { LocalPackageImplementation } from './LocalPackageImplementation';
 import { NativeRNAppZungCodePushModule } from './NativeRNAppZungCodePushModule';
 import { log } from './utils/log';
@@ -21,9 +21,8 @@ export class RemotePackageImpl implements RemotePackage {
       let downloadProgressSubscription;
 
       if (downloadProgressCallback) {
-        const codePushEventEmitter = new NativeEventEmitter(NativeRNAppZungCodePushModule);
         // Use event subscription to obtain download progress.
-        downloadProgressSubscription = codePushEventEmitter.addListener(
+        downloadProgressSubscription = CodePushEventEmitter.addListener(
           'CodePushDownloadProgress',
           downloadProgressCallback,
         );

package/src/internals/logger.ts

@@ -0,0 +1,46 @@
+import type { LogLevel } from '../enums/LogLevel.enum';
+
+export type LoggerFunction = (level: LogLevel, message: string) => void;
+
+const defaultLogger: LoggerFunction = (_level: LogLevel, message: string): void => {
+  console.log(`[CodePush] ${message}`);
+};
+
+let currentLogger: LoggerFunction = defaultLogger;
+
+/**
+ * Set a custom logger function to handle all CodePush logs
+ *
+ * @param logger A function that takes a log level and message and handles the logging
+ * @example
+ * ```
+ * import { setLogger, LogLevel } from '@appzung/react-native-code-push';
+ *
+ * // Custom logger that sends critical logs to a crash reporting service
+ * setLogger((level, message) => {
+ *   // Always log to console
+ *   console.log(`[CodePush] ${message}`);
+ *
+ *   // Send error logs to crash reporting
+ *   if (level === LogLevel.ERROR) {
+ *     MyCrashReportingService.log(`CodePush error: ${message}`);
+ *   }
+ * });
+ * ```
+ */
+export const setLogger = (logger: LoggerFunction): void => {
+  currentLogger = logger;
+};
+
+/**
+ * Get the current logger function
+ * @returns The current logger function
+ */
+export const getLogger = (): LoggerFunction => currentLogger;
+
+/**
+ * Reset the logger to the default implementation
+ */
+export const resetLogger = (): void => {
+  currentLogger = defaultLogger;
+};

package/src/internals/utils/log.ts

@@ -1,12 +1,14 @@
 import type { LogLevel } from '../../enums/LogLevel.enum';
 import { getLogLevel } from '../../logLevel';
+import { getLogger } from '../logger';
 
-/* Logs messages to console with the [CodePush] prefix */
+/* Logs messages using the configured logger */
 export function log(level: LogLevel, message: string): void {
   const currentLogLevel = getLogLevel();
   if (level < currentLogLevel) {
     return;
   }
 
-  console.log(`[CodePush] ${message}`);
+  const logger = getLogger();
+  logger(level, message);
 }

package/src/internals/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '11.0.0-rc5';
+export const version = '11.0.0-rc7';

package/src/logger.ts

@@ -0,0 +1,2 @@
+export { setLogger, resetLogger } from './internals/logger';
+export type { LoggerFunction } from './internals/logger';

package/src/notifyAppReady.ts

@@ -8,6 +8,8 @@ import { requestFetchAdapter } from './internals/utils/requestFetchAdapter';
 import type { StatusReport } from './types';
 
 /**
+ * @function
+ *
  * 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.
@@ -54,7 +56,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
         throw new Error('Release channel is missing');
       }
 
-      const sdk = new CodePushApiSdk(requestFetchAdapter, config);
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
       await sdk.reportStatusDeploy(null, previousLabelOrAppVersion, previousReleaseChannelPublicId);
     } else {
       if (!statusReport.package) {
@@ -70,7 +72,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
       }
 
       config.releaseChannelPublicId = statusReport.package.releaseChannelPublicId;
-      const sdk = new CodePushApiSdk(requestFetchAdapter, config);
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
       await sdk.reportStatusDeploy(
         {
           package: statusReport.package,

package/src/restartApp.ts

@@ -7,6 +7,6 @@ import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePu
  *
  * @param onlyIfUpdateIsPending Indicates whether you want the restart to no-op if there isn't currently a pending update.
  */
-export async function restartApp(onlyIfUpdateIsPending = false) {
-  NativeRNAppZungCodePushModule.restartApp(onlyIfUpdateIsPending);
+export function restartApp(onlyIfUpdateIsPending = false) {
+  return NativeRNAppZungCodePushModule.restartApp(onlyIfUpdateIsPending);
 }

package/src/sync.ts

@@ -81,10 +81,10 @@ async function syncInternal(
               log(LogLevel.INFO, 'User cancelled the update.');
               break;
             case SyncStatus.UPDATE_INSTALLED:
-              if (resolvedInstallMode == InstallMode.ON_NEXT_RESTART) {
+              if (resolvedInstallMode === InstallMode.ON_NEXT_RESTART) {
                 log(LogLevel.INFO, 'Update is installed and will be run on the next app restart.');
-              } else if (resolvedInstallMode == InstallMode.ON_NEXT_RESUME) {
-                if (!!syncOptions.minimumBackgroundDuration) {
+              } else if (resolvedInstallMode === InstallMode.ON_NEXT_RESUME) {
+                if (syncOptions.minimumBackgroundDuration) {
                   log(
                     LogLevel.INFO,
                     `Update is installed and will be run after the app has been in the background for at least ${syncOptions.minimumBackgroundDuration} seconds.`,
@@ -210,6 +210,8 @@ async function syncInternal(
 }
 
 /**
+ * @function
+ *
  * 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.

package/src/telemetry.ts

@@ -0,0 +1,21 @@
+import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
+import { reloadCachedConfiguration } from './internals/getConfiguration';
+
+/**
+ * Controls telemetry reporting.
+ *
+ * @param enabled - When false, updates on this device will stop appearing as failed, pending or succeeded in analytics.
+ */
+export async function setTelemetryEnabled(enabled: boolean): Promise<void> {
+  await NativeRNAppZungCodePushModule.setTelemetryEnabled(enabled);
+  await reloadCachedConfiguration();
+}
+
+/**
+ * Gets the current telemetry enabled status.
+ *
+ * When setTelemetryEnabled has never been enabled, returns the default value set in your configuration.
+ */
+export function getTelemetryEnabled(): Promise<boolean> {
+  return NativeRNAppZungCodePushModule.getTelemetryEnabled();
+}

package/docs/advanced-usage.md

@@ -1,71 +0,0 @@
-## Advanced usage
-
-### Multiple environments
-
-#### Staging / Production
-
-In a real-world scenario you would have `Staging` and `Production` apps that are different binaries, each using specific environment config (different package name, bundle identifier, API, feature flags etc). Create a release channel for each of these environments with `appzung release-channels create` and change the `CodePushReleaseChannelPublicId` on the native side with environment variables. You might want to use a module like [react-native-config](https://github.com/lugg/react-native-config) (or do it manually using build variants and configurations).
-
-```groovy
-// android/app/build.gradle
-android {
-    // ...
-    defaultConfig {
-        // ...
-        resValue 'string', "CodePushReleaseChannelPublicId", project.env.get("CODEPUSH_RELEASE_CHANNEL_PUBLIC_ID_ANDROID")
-    }
-}
-```
-
-```
-// ios/myapp/Info.plist
-
-<key>CodePushReleaseChannelPublicId</key>
-<string>$(CODEPUSH_RELEASE_CHANNEL_PUBLIC_ID_IOS)</string>
-```
-
-#### QA / Production
-
-In the case where you have a `QA` environment that is completely iso-prod (meaning you can swap the JS bundle between those two apps), you may take advantage of the `promote` feature:
-
-1. Release a CodePush update to your `QA` release channel using the `appzung releases deploy-react-native` command (or `appzung releases deploy` if you need more control)
-2. Let QA test the build
-3. Promote the tested release from `QA` to `Production` using the `appzung releases promote` command
-
-_NOTE: If you want to take a more cautious approach, you can even choose to perform a "staged rollout" as part of #3, which allows you to mitigate additional potential risk with the update (like did your testing in #2 touch all possible devices/conditions?) by only making the production update available to a percentage of your users (for example `appzung releases promote -r 20`). Then, after waiting for a reasonable amount of time to see if any crash reports or customer feedback comes in, you can expand it to your entire audience by running `appzung releases edit -r 100`._
-
-### Dynamic release channel assignment
-
-The above section illustrated how you can leverage multiple CodePush release channels in order to effectively test your updates before broadly releasing them to your end users. However, since that workflow statically embeds the release channel assignment into the actual binary, a staging or production build will only ever sync updates from that release channel. In many cases, this is sufficient, since you only want your team, customers, stakeholders, etc. to sync with your pre-production releases, and therefore, only they need a build that knows how to sync with staging. However, if you want to be able to perform A/B tests, or provide early access of your app to certain users, it can prove very useful to be able to dynamically place specific users (or audiences) into specific release channels at runtime.
-
-In order to achieve this kind of workflow, all you need to do is specify the release channel public ID you want the current user to synchronize with when calling the `codePush` method. When specified, this key will override the "default" one that was provided in your app's `Info.plist` (iOS) or strings resources (Android) files. This allows you to produce a build for staging or production, that is also capable of being dynamically "redirected" as needed.
-
-```javascript
-// Imagine that "userProfile" is a prop that this component received
-// which includes the release channel public ID that the current user should use.
-codePush.sync({ releaseChannelPublicId: userProfile.RELEASE_CHANNEL_PUBLIC_ID });
-```
-
-With that change in place, now it's just a matter of choosing how your app determines the right release channel for the current user. In practice, there are typically two solutions for this:
-
-1. Expose a user-visible mechanism for changing release channels at any time. For example, your settings page could have a toggle for enabling "beta" access. This model works well if you're not concerned with the privacy of your pre-production updates, and you have power users that may want to opt-in to earlier (and potentially buggy) updates at their own will (kind of like Chrome channels). However, this solution puts the decision in the hands of your users, which doesn't help you perform A/B tests transparently.
-2. Annotate the server-side profile of your users with an additional piece of metadata that indicates the release channel they should sync with. By default, your app could just use the binary-embedded key, but after a user has authenticated, your server can choose to "redirect" them to a different release channel, which allows you to incrementally place certain users or groups in different release channels as needed. You could even choose to store the server-response in local storage so that it becomes the new default. How you store the key alongside your user's profiles is entirely up to your authentication solution (for example Auth0, Firebase, custom DB + REST API), but is generally pretty trivial to do.
-
-_NOTE: If needed, you could also implement a hybrid solution that allowed your end-users to toggle between different release channels, while also allowing your server to override that decision. This way, you have a hierarchy of "release channel resolution" that ensures your app has the ability to update itself out-of-the-box, your end users can feel rewarded by getting early access to bits, but you also have the ability to run A/B tests on your users as needed._
-
-Are you using dynamic release channel assignments? Contact us at hello@appzung.com so that we may provide better integration.
-
-### Using a custom server URL
-
-This module lets you change the targeted CodePush server URL, this can be used by:
-
-- People who use a self-hosted basic CodePush server like the open source Microsoft's code-push-server. Note that you won't be able to use most features of AppZung with these self-hosted servers. We're committed to keep this module compatible with the basic CodePush features so that our users are not locked in.
-- Enterprise clients with a custom AppZung infrastructure
-
-#### iOS
-
-Add a `CodePushServerURL` in the `Info.plist` targeting your code-push server.
-
-#### Android
-
-Add a `CodePushServerUrl` in your strings resources targeting your code-push server.

package/docs/api-android.md

@@ -1,22 +0,0 @@
-## Java API reference (Android)
-
-You can customize CodePush by placing these values in string resources.
-
-- **Release channel Public ID** - The default release channel's **public ID** that will be used to check updates. For example:
-
-  ```xml
-  <string moduleConfig="true" name="CodePushReleaseChannelPublicId">sU0Eikse9JFCDLZmAT-_lUSwDWACrSGgTKCXyWqcE0</string>
-  ```
-
-- **Public Key** - used for bundle verification in the Code Signing Feature. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
-  To set the public key, you should add the content of the public key to `strings.xml` with name `CodePushSigningPublicKey`. CodePush automatically gets this property and enables the Code Signing feature. For example:
-
-  ```xml
-  <string moduleConfig="true" name="CodePushSigningPublicKey">your-public-key</string>
-  ```
-
-- **Server Url** - used for specifying CodePush Server Url (as an Enterprise customer we may setup a custom infra for your needs).
-  The Default value: "https://codepush.appzung.com/" is overridden by adding your path to `strings.xml` with name `CodePushServerUrl`. CodePush automatically gets this property and will use this path to send requests. For example:
-  ```xml
-  <string moduleConfig="true" name="CodePushServerUrl">https://codepush.yourdomain.com</string>
-  ```

package/docs/api-ios.md

@@ -1,19 +0,0 @@
-## Objective-C API reference (iOS)
-
-The Objective-C API is made available by importing the `CodePush.h` header into your `AppDelegate.m` file, and consists of a single public class named `CodePush`.
-
-### CodePush
-
-Contains static methods for retrieving the `NSURL` that represents the most recent JavaScript bundle file, and can be passed to the `RCTRootView`'s `initWithBundleURL` method when bootstrapping your app in the `AppDelegate.m` file.
-
-#### Methods
-
-- **(NSURL \*)bundleURL** - Returns the most recent JS bundle `NSURL` as described above. This method assumes that the name of the JS bundle contained within your app binary is `main.jsbundle`.
-
-- **(NSURL \*)bundleURLForResource:(NSString \*)resourceName** - Equivalent to the `bundleURL` method, but also allows customizing the name of the JS bundle that is looked for within the app binary. This is useful if you aren't naming this file `main` (which is the default convention). This method assumes that the JS bundle's extension is `*.jsbundle`.
-
-- **(NSURL \*)bundleURLForResource:(NSString \*)resourceName withExtension:(NSString \*)resourceExtension**: Equivalent to the `bundleURLForResource:` method, but also allows customizing the extension used by the JS bundle that is looked for within the app binary. This is useful if you aren't naming this file `*.jsbundle` (which is the default convention).
-
-- **(void)overrideAppVersion:(NSString \*)appVersionOverride** - Sets the version of the application's binary interface, which would otherwise default to the App Store version specified as the `CFBundleShortVersionString` in the `Info.plist`. This should be called a single time, before the bundle URL is loaded.
-
-- **(void)setReleaseChannelPublicId:(NSString \*)releaseChannelPublicId** - Sets the release channel public ID that the app should use when querying for updates. This is a dynamic alternative to setting the release channel in your `Info.plist` and/or specifying a release channel in JS when calling `checkForUpdate` or `sync`.

package/docs/api-js/README.md

@@ -1,58 +0,0 @@
-**@appzung/react-native-code-push v11.0.0-rc5**
-
----
-
-# @appzung/react-native-code-push v11.0.0-rc5
-
-## Enumerations
-
-- [CheckFrequency](enumerations/CheckFrequency.md)
-- [DeploymentStatus](enumerations/DeploymentStatus.md)
-- [InstallMode](enumerations/InstallMode.md)
-- [LogLevel](enumerations/LogLevel.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)
-- [getLogLevel](functions/getLogLevel.md)
-- [getUpdateMetadata](functions/getUpdateMetadata.md)
-- [notifyAppReady](functions/notifyAppReady.md)
-- [resetClientUniqueId](functions/resetClientUniqueId.md)
-- [restartApp](functions/restartApp.md)
-- [setLogLevel](functions/setLogLevel.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

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

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

@@ -1,50 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc5**](../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/LogLevel.md

@@ -1,31 +0,0 @@
-[**@appzung/react-native-code-push v11.0.0-rc5**](../README.md)
-
----
-
-[@appzung/react-native-code-push](../README.md) / LogLevel
-
-# Enumeration: LogLevel
-
-## Enumeration Members
-
-### DEBUG
-
-> **DEBUG**: `0`
-
----
-
-### ERROR
-
-> **ERROR**: `3`
-
----
-
-### INFO
-
-> **INFO**: `1`
-
----
-
-### WARN
-
-> **WARN**: `2`