@appzung/react-native-code-push 10.1.1 → 10.2.1

package/src/logLevel.ts

@@ -0,0 +1,9 @@
+import { LogLevel } from './enums/LogLevel.enum';
+
+let logLevel = LogLevel.INFO;
+
+export const setLogLevel = (level: LogLevel) => {
+  logLevel = level;
+};
+
+export const getLogLevel = () => logLevel;

package/src/logger.ts

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

package/src/notifyAppReady.ts

@@ -1,4 +1,5 @@
 import { AppState, type NativeEventSubscription } from 'react-native';
+import { LogLevel } from './enums/LogLevel.enum';
 import { CodePushApiSdk } from './internals/CodePushApiSdk';
 import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
 import { getConfiguration } from './internals/getConfiguration';
@@ -7,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.
@@ -26,9 +29,17 @@ export const notifyAppReady = (() => {
 })();
 
 async function notifyApplicationReadyInternal() {
+  log(LogLevel.DEBUG, 'notifyApplicationReady');
+
   await NativeRNAppZungCodePushModule.notifyApplicationReady();
   const statusReport = await NativeRNAppZungCodePushModule.getNewStatusReport();
-  statusReport && tryReportStatus(statusReport); // Don't wait for this to complete.
+  if (statusReport) {
+    log(LogLevel.DEBUG, `tryReportStatus ${statusReport.status || '(no update)'}`);
+
+    tryReportStatus(statusReport); // Don't wait for this to complete.
+  } else {
+    log(LogLevel.DEBUG, `Nothing to report`);
+  }
 
   return statusReport;
 }
@@ -39,13 +50,13 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
   const previousReleaseChannelPublicId = statusReport.previousReleaseChannelPublicId || config.releaseChannelPublicId;
   try {
     if (statusReport.appVersion) {
-      log(`Reporting binary update (${statusReport.appVersion})`);
+      log(LogLevel.INFO, `Reporting binary update (${statusReport.appVersion})`);
 
       if (!config.releaseChannelPublicId) {
         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) {
@@ -54,14 +65,14 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
 
       const label = statusReport.package.label;
       if (statusReport.status === 'DeploymentSucceeded') {
-        log(`Reporting CodePush update success (${label})`);
+        log(LogLevel.INFO, `Reporting CodePush update success (${label})`);
       } else {
-        log(`Reporting CodePush update rollback (${label})`);
+        log(LogLevel.INFO, `Reporting CodePush update rollback (${label})`);
         await NativeRNAppZungCodePushModule.setLatestRollbackInfo(statusReport.package.packageHash);
       }
 
       config.releaseChannelPublicId = statusReport.package.releaseChannelPublicId;
-      const sdk = new CodePushApiSdk(requestFetchAdapter, config);
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
       await sdk.reportStatusDeploy(
         {
           package: statusReport.package,
@@ -75,7 +86,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
     NativeRNAppZungCodePushModule.recordStatusReported(statusReport);
     retryOnAppResume && retryOnAppResume.remove();
   } catch (e) {
-    log(`Report status failed: ${JSON.stringify(statusReport)}`);
+    log(LogLevel.WARN, `Report status failed: ${JSON.stringify(statusReport)}`);
     NativeRNAppZungCodePushModule.saveStatusReportForRetry(statusReport);
     // Try again when the app resumes
     if (!retryOnAppResume) {
@@ -83,6 +94,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
         if (newState !== 'active') return;
         const refreshedStatusReport = await NativeRNAppZungCodePushModule.getNewStatusReport();
         if (refreshedStatusReport) {
+          log(LogLevel.DEBUG, `tryReportStatus on active appState ${statusReport.status || '(no update)'}`);
           tryReportStatus(refreshedStatusReport, resumeListener);
         } else {
           resumeListener && resumeListener.remove();

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

@@ -1,6 +1,7 @@
 import { Alert, type AlertButton, Platform } from 'react-native';
 import { checkForUpdate } from './checkForUpdates';
 import { InstallMode } from './enums/InstallMode.enum';
+import { LogLevel } from './enums/LogLevel.enum';
 import { SyncStatus } from './enums/SyncStatus.enum';
 import { getCurrentPackage } from './internals/getCurrentPackage';
 import { shouldUpdateBeIgnored } from './internals/shouldUpdateBeIgnored';
@@ -62,38 +63,39 @@ async function syncInternal(
       : (syncStatus: SyncStatus) => {
           switch (syncStatus) {
             case SyncStatus.CHECKING_FOR_UPDATE:
-              log('Checking for update.');
+              log(LogLevel.INFO, 'Checking for update.');
               break;
             case SyncStatus.AWAITING_USER_ACTION:
-              log('Awaiting user action.');
+              log(LogLevel.INFO, 'Awaiting user action.');
               break;
             case SyncStatus.DOWNLOADING_PACKAGE:
-              log('Downloading package.');
+              log(LogLevel.INFO, 'Downloading package.');
               break;
             case SyncStatus.INSTALLING_UPDATE:
-              log('Installing update.');
+              log(LogLevel.INFO, 'Installing update.');
               break;
             case SyncStatus.UP_TO_DATE:
-              log('App is up to date.');
+              log(LogLevel.INFO, 'App is up to date.');
               break;
             case SyncStatus.UPDATE_IGNORED:
-              log('User cancelled the update.');
+              log(LogLevel.INFO, 'User cancelled the update.');
               break;
             case SyncStatus.UPDATE_INSTALLED:
-              if (resolvedInstallMode == InstallMode.ON_NEXT_RESTART) {
-                log('Update is installed and will be run on the next app restart.');
-              } else if (resolvedInstallMode == InstallMode.ON_NEXT_RESUME) {
-                if (!!syncOptions.minimumBackgroundDuration) {
+              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) {
                   log(
+                    LogLevel.INFO,
                     `Update is installed and will be run after the app has been in the background for at least ${syncOptions.minimumBackgroundDuration} seconds.`,
                   );
                 } else {
-                  log('Update is installed and will be run when the app next resumes.');
+                  log(LogLevel.INFO, 'Update is installed and will be run when the app next resumes.');
                 }
               }
               break;
             case SyncStatus.UNKNOWN_ERROR:
-              log('An unknown error occurred.');
+              log(LogLevel.ERROR, 'An unknown error occurred.');
               break;
           }
         };
@@ -127,7 +129,10 @@ async function syncInternal(
 
     if (!remotePackage || updateShouldBeIgnored) {
       if (updateShouldBeIgnored) {
-        log('An update is available, but it is being ignored due to having been previously rolled back.');
+        log(
+          LogLevel.INFO,
+          'An update is available, but it is being ignored due to having been previously rolled back.',
+        );
       }
 
       const currentPackage = await getCurrentPackage();
@@ -195,6 +200,7 @@ async function syncInternal(
   } catch (error) {
     syncStatusChangeCallback(SyncStatus.UNKNOWN_ERROR);
     log(
+      LogLevel.ERROR,
       error != null && typeof error === 'object' && 'message' in error && typeof error.message === 'string'
         ? error.message
         : 'Unknown',
@@ -204,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.
@@ -228,25 +236,29 @@ export const sync = (() => {
     downloadProgressCallback?: DownloadProgressCallback,
     handleBinaryVersionMismatchCallback?: HandleBinaryVersionMismatchCallback,
   ): Promise<SyncStatus> => {
-    let syncStatusCallbackWithTryCatch: SyncStatusChangedCallback | undefined;
-    let downloadProgressCallbackWithTryCatch: DownloadProgressCallback | undefined;
+    log(LogLevel.DEBUG, `sync start`);
 
-    if (typeof syncStatusChangedCallback === 'function') {
-      syncStatusCallbackWithTryCatch = (...args) => {
-        try {
-          syncStatusChangedCallback(...args);
-        } catch (error) {
-          log(`An error has occurred : ${error instanceof Error ? error.stack : 'unknown'}`);
-        }
-      };
-    }
+    let syncStatusCallbackWithTryCatch: SyncStatusChangedCallback = (status) => {
+      log(LogLevel.DEBUG, `sync status ${SyncStatus[status]}`);
+
+      if (typeof syncStatusChangedCallback !== 'function') {
+        return;
+      }
 
+      try {
+        syncStatusChangedCallback(status);
+      } catch (error) {
+        log(LogLevel.ERROR, `An error has occurred : ${error instanceof Error ? error.stack : 'unknown'}`);
+      }
+    };
+
+    let downloadProgressCallbackWithTryCatch: DownloadProgressCallback | undefined;
     if (typeof downloadProgressCallback === 'function') {
       downloadProgressCallbackWithTryCatch = (...args) => {
         try {
           downloadProgressCallback(...args);
         } catch (error) {
-          log(`An error has occurred: ${error instanceof Error ? error.stack : 'unknown'}`);
+          log(LogLevel.ERROR, `An error has occurred: ${error instanceof Error ? error.stack : 'unknown'}`);
         }
       };
     }
@@ -254,7 +266,7 @@ export const sync = (() => {
     if (syncInProgress) {
       typeof syncStatusCallbackWithTryCatch === 'function'
         ? syncStatusCallbackWithTryCatch(SyncStatus.SYNC_IN_PROGRESS)
-        : log('Sync already in progress.');
+        : log(LogLevel.WARN, 'Sync already in progress.');
       return Promise.resolve(SyncStatus.SYNC_IN_PROGRESS);
     }
 

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/typedoc.json

@@ -1,9 +0,0 @@
-{
-  "plugin": ["typedoc-plugin-markdown"],
-  "entryPoints": ["./src/index.ts"],
-  "out": "./docs/api-js",
-  "readme": "none",
-  "formatWithPrettier": true,
-  "includeVersion": true,
-  "disableSources": true
-}