@algocare/react-native-code-push 12.6.3 → 13.0.0-rc.0

package/typings/react-native-code-push.d.ts

@@ -1,565 +1,573 @@
-export type DownloadProgressCallback = (progress: DownloadProgress) => void
-export type SyncStatusChangedCallback = (status: CodePush.SyncStatus) => void
-export type HandleBinaryVersionMismatchCallback = (
-  update: RemotePackage
-) => void
+export type DownloadProgressCallback = (progress: DownloadProgress) => void;
+export type SyncStatusChangedCallback = (status: CodePush.SyncStatus) => void;
+export type HandleBinaryVersionMismatchCallback = (update: RemotePackage) => void;
 
-// from code-push SDK
 export interface UpdateCheckRequest {
-  /** The native version, not in package.json. */
-  app_version: string
-  client_unique_id?: string
-  deployment_key: string
-  is_companion?: boolean
-  label?: string
-  package_hash?: string
+    /** The native version, not in package.json. */
+    app_version: string;
+    client_unique_id?: string;
+    is_companion?: boolean;
+    label?: string;
+    package_hash?: string;
 }
 
 /**
  * Alias for a string representing a released CodePush update version.
  */
-export type ReleaseVersion = string
+export type ReleaseVersion = string;
 
 /**
  * The interface representing the release information that the `releaseHistoryFetcher` function must return.
  */
-export type ReleaseHistoryInterface = Record<ReleaseVersion, ReleaseInfo>
+export type ReleaseHistoryInterface = Record<ReleaseVersion, ReleaseInfo>;
 
 /**
  * The interface that represents a single deployment history entry, which the `releaseHistoryFetcher` function should return.
  */
 export interface ReleaseInfo {
-  enabled: boolean
-  mandatory: boolean
-  downloadUrl: string
-  packageHash: string
+    enabled: boolean;
+    mandatory: boolean;
+    downloadUrl: string;
+    packageHash: string;
+    rollout?: number;
+    /** The binary version a PR preview release was built against. (PR preview releases only) */
+    binaryVersion?: string;
+    /** Release creation timestamp recorded by the CLI. (e.g. '2026-07-03 12:34:56') */
+    createdAt?: string;
+    /** Last `update-history` timestamp recorded by the CLI. ('-' if never updated) */
+    updatedAt?: string;
 }
 
 // from code-push SDK
 export interface UpdateCheckResponse {
-  download_url?: string
-  description?: string
-  is_available: boolean
-  is_disabled?: boolean
-  target_binary_range: string
-  /*generated*/ label?: string
-  /*generated*/ package_hash?: string
-  package_size?: number
-  should_run_binary_version?: boolean
-  update_app_version?: boolean
-  is_mandatory?: boolean
+    download_url?: string;
+    description?: string;
+    is_available: boolean;
+    is_disabled?: boolean;
+    target_binary_range: string;
+    /*generated*/ label?: string;
+    /*generated*/ package_hash?: string;
+    package_size?: number;
+    should_run_binary_version?: boolean;
+    update_app_version?: boolean;
+    is_mandatory?: boolean;
 }
 
 export interface CodePushOptions extends SyncOptions {
-  /**
-   * Specifies when you would like to synchronize updates with the CodePush server.
-   * Defaults to codePush.CheckFrequency.ON_APP_START.
-   */
-  checkFrequency: CodePush.CheckFrequency
-  /**
-   * Specifies a function to get the release history.
-   *
-   * If you want to use `updateChecker`, pass no-op function like below.
-   * But it is deprecated and will be removed in the next major version.
-   *
-   * ```ts
-   * const codePushOptions: {
-   *     releaseHistoryFetcher: async () => ({}), // This will not be called
-   * }
-   * ```
-   */
-  releaseHistoryFetcher: (
-    updateRequest: UpdateCheckRequest
-  ) => Promise<ReleaseHistoryInterface>
-  /**
-   * Specify a function to perform the update check.
-   * It can be used for self-hosting.
-   * Defaults to AppCenter update_check REST API request.
-   *
-   * @deprecated It will be removed in the next major version. Please migrate to `releaseHistoryFetcher`.
-   */
-  updateChecker?: (
-    updateRequest: UpdateCheckRequest
-  ) => Promise<{ update_info: UpdateCheckResponse }>
+    /**
+     * The `ignoreFailedUpdates` option is only available as an option for `CodePush.sync()`.
+     */
+    ignoreFailedUpdates?: never;
+    /**
+     * Specifies when you would like to synchronize updates with the CodePush server.
+     * Defaults to codePush.CheckFrequency.ON_APP_START.
+     */
+    checkFrequency: CodePush.CheckFrequency;
+    /**
+     * Specifies a function to get the release history.
+     *
+     * If you want to use `updateChecker`, pass no-op function like below.
+     * But it is deprecated and will be removed in the next major version.
+     *
+     * ```ts
+     * const codePushOptions: {
+     *     releaseHistoryFetcher: async () => ({}), // This will not be called
+     * }
+     * ```
+     */
+    releaseHistoryFetcher: (updateRequest: UpdateCheckRequest) => Promise<ReleaseHistoryInterface>;
+    /**
+     * Specify a function to perform the update check.
+     * It can be used for self-hosting.
+     * Defaults to AppCenter update_check REST API request.
+     *
+     * @deprecated It will be removed in the next major version. Please migrate to `releaseHistoryFetcher`.
+     */
+    updateChecker?: (updateRequest: UpdateCheckRequest) => Promise<{ update_info: UpdateCheckResponse }>;
+    /**
+     * Callback function that is called when the update installation succeeds.
+     */
+    onUpdateSuccess?: (label: string) => void;
+    /**
+     * Callback function that is called when the update rolled back.
+     */
+    onUpdateRollback?: (label: string) => void;
+    /**
+     * Callback function that is called when download starts.
+     */
+    onDownloadStart?: (label: string) => void;
+    /**
+     * Callback function that is called when download finished successfully.
+     */
+    onDownloadSuccess?: (label: string) => void;
+    /**
+     * Callback function that is called when sync process failed.
+     */
+    onSyncError?: (label: string, error: Error) => void;
+    /**
+     * Callback function that is called when rollout is skipped.
+     */
+    onRolloutSkipped?: (label: string, error: Error) => 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
+    /**
+     * 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 affect 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.
-   */
-  install(
-    installMode: CodePush.InstallMode,
-    minimumBackgroundDuration?: number
-  ): 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.
+     *
+     * @param installMode Indicates when you would like the update changes to take affect 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.
+     */
+    install(installMode: CodePush.InstallMode, minimumBackgroundDuration?: number): 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 deployment key that was used to originally download this update.
-   */
-  deploymentKey: 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 deployment.
-   */
-  label: string
-
-  /**
-   * The SHA hash value of the update.
-   */
-  packageHash: string
-
-  /**
-   * The size of the code contained within the update, in bytes.
-   */
-  packageSize: number
+    /**
+     * 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 deployment key that was used to originally download this update.
+     */
+    deploymentKey: 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 deployment.
+     */
+    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.
-   * @param downloadCompleteCallback An optional callback that is called when the HTTP download completes and post-processing begins (iOS only).
-   */
-  download(
-    downloadProgressCallback?: DownloadProgressCallback,
-    downloadCompleteCallback?: () => void
-  ): Promise<LocalPackage>
-
-  /**
-   * The URL at which the package is available for download.
-   */
-  downloadUrl: string
+    /**
+     * 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.
+     * @param downloadCompleteCallback An optional callback that is called when the HTTP download completes and post-processing begins (iOS only).
+     */
+    download(downloadProgressCallback?: DownloadProgressCallback, downloadCompleteCallback?: () => void): Promise<LocalPackage>;
+
+    /**
+     * The URL at which the package is available for download.
+     */
+    downloadUrl: string;
 }
 
 export interface SyncOptions {
-  prNumber?: string
-  packageHash?: string
-  /**
-   * Specifies the deployment key you want to query for an update against. By default, this value is derived from the Info.plist
-   * file (iOS) and MainActivity.java file (Android), but this option allows you to override it from the script-side if you need to
-   * dynamically use a different deployment for a specific call to sync.
-   */
-  deploymentKey?: 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?: CodePush.InstallMode
-
-  /**
-   * Specifies when you would like to install updates which are marked as mandatory.
-   * Defaults to codePush.InstallMode.IMMEDIATE.
-   */
-  mandatoryInstallMode?: CodePush.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 any truthy value 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
-
-  /**
-   * Specifies whether to ignore the update if the installation fails.
-   * If set to false, the update will be retried when the sync method is called, even if the previous installation attempt failed.
-   * However, depending on the deployment strategy, if an update that cannot be successfully installed is deployed, this option could result in an infinite update retry loop.
-   * Defaults to true.
-   */
-  ignoreFailedUpdates?: boolean
-}
+    /**
+     * Specifies the deployment key you want to query for an update against. By default, this value is derived from the Info.plist
+     * file (iOS) and MainActivity.java file (Android), but this option allows you to override it from the script-side if you need to
+     * dynamically use a different deployment for a specific call to sync.
+     */
+    deploymentKey?: string;
 
-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
-}
+    /**
+     * 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?: CodePush.InstallMode;
 
-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
-}
+    /**
+     * Specifies when you would like to install updates which are marked as mandatory.
+     * Defaults to codePush.InstallMode.IMMEDIATE.
+     */
+    mandatoryInstallMode?: CodePush.InstallMode;
 
-export interface StatusReport {
-  /**
-   * Whether the deployment succeeded or failed.
-   */
-  status: CodePush.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
-
-  /**
-   * Deployment key used when deploying the previous package.
-   */
-  previousDeploymentKey?: string
-
-  /**
-   * The label (v#) of the package that was upgraded from.
-   */
-  previousLabelOrAppVersion?: string
-}
+    /**
+     * 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;
 
-/**
- * Decorates a React Component configuring it to sync for updates with the CodePush server.
- *
- * @param options Options used to configure the end-user sync and update experience (e.g. when to check for updates?, show an prompt?, install the update immediately?).
- */
-declare function CodePush(options?: CodePushOptions): (x: any) => any
+    /**
+     * 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;
 
-/**
- * Decorates a React Component configuring it to sync for updates with the CodePush server.
- *
- * @param x the React Component that will decorated
- */
-declare function CodePush(x: any): any
+    /**
+     * 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 any truthy value 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;
 
-declare namespace CodePush {
-  /**
-   * Represents the default settings that will be used by the sync method if
-   * an update dialog is configured to be displayed.
-   */
-  var DEFAULT_UPDATE_DIALOG: UpdateDialog
-
-  /**
-   * Asks the CodePush service whether the configured app deployment has an update available.
-   *
-   * @param prNumber The pull request number to use to query the CodePush server for an update.
-   * @param packageHash The package hash to use to query the CodePush server for an update.
-   * @param handleBinaryVersionMismatchCallback An optional callback for handling target binary version mismatch
-   */
-  function checkForUpdate(
-    prNumber?: string,
-    packageHash?: string,
-    handleBinaryVersionMismatchCallback?: HandleBinaryVersionMismatchCallback
-  ): Promise<RemotePackage | null>
-
-  /**
-   * Retrieves the metadata for an installed update (e.g. description, mandatory).
-   *
-   * @param updateState The state of the update you want to retrieve the metadata for. Defaults to UpdateState.RUNNING.
-   */
-  function getUpdateMetadata(
-    updateState?: UpdateState
-  ): Promise<LocalPackage | null>
+    /**
+     * Specifies whether to ignore the update if the installation fails.
+     * If set to false, the update will be retried when the sync method is called, even if the previous installation attempt failed.
+     * However, depending on the deployment strategy, if an update that cannot be successfully installed is deployed, this option could result in an infinite update retry loop.
+     * Defaults to true.
+     */
+    ignoreFailedUpdates?: boolean;
 
-  /**
-   * Notifies the CodePush runtime that an installed update is considered successful.
-   */
-  function notifyAppReady(): Promise<StatusReport | void>
+    /**
+     * (algocare PR preview release extension)
+     * When given, only PR preview releases (`{prNumber}-{semver}` keys in the release history)
+     * are considered during the update check. Normal releases are ignored.
+     */
+    prNumber?: string;
+}
 
-  /**
-   * Allow CodePush to restart the app.
-   */
-  function allowRestart(): void
+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;
 
-  /**
-   * Forbid CodePush to restart the app.
-   */
-  function disallowRestart(): void
+    /**
+     * 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;
 
-  /**
-   * Clear all downloaded CodePush updates.
-   * This is useful when switching to a different deployment which may have an older release than the current package.
-   * Note: we don’t recommend to use 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.
-   */
-  function clearUpdates(): void
+    /**
+     * The text to use for the button the end user must press in order to install a mandatory update. Defaults to "Continue".
+     */
+    mandatoryContinueButtonLabel?: string;
 
-  /**
-   * Immediately restarts the app.
-   *
-   * @param onlyIfUpdateIsPending Indicates whether you want the restart to no-op if there isn't currently a pending update.
-   */
-  function restartApp(onlyIfUpdateIsPending?: boolean): void
+    /**
+     * 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;
 
-  /**
-   * Allows checking for an update, downloading it and installing it, all with a single call.
-   *
-   * @param options Options used to configure the end-user update experience (e.g. show an prompt?, install the update immediately?).
-   * @param syncStatusChangedCallback An optional callback that allows tracking the status of the sync operation, as opposed to simply checking the resolved state via the returned Promise.
-   * @param downloadProgressCallback An optional callback that allows tracking the progress of an update while it is being downloaded.
-   * @param handleBinaryVersionMismatchCallback An optional callback for handling target binary version mismatch
-   */
-  function sync(
-    options?: SyncOptions,
-    syncStatusChangedCallback?: SyncStatusChangedCallback,
-    downloadProgressCallback?: DownloadProgressCallback,
-    handleBinaryVersionMismatchCallback?: HandleBinaryVersionMismatchCallback
-  ): Promise<SyncStatus>
+    /**
+     * 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;
 
-  /**
-   * Indicates when you would like an installed update to actually be applied.
-   */
-  enum InstallMode {
     /**
-     * Indicates that you want to install the update and restart the app immediately.
+     * The text to use for the button the end user can press in order to install an optional update. Defaults to "Install".
      */
-    IMMEDIATE,
+    optionalInstallButtonLabel?: string;
 
     /**
-     * Indicates that you want to install the update, but not forcibly restart the app.
+     * 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?".
      */
-    ON_NEXT_RESTART,
+    optionalUpdateMessage?: string;
 
     /**
-     * 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 then 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.
+     * The text used as the header of an update notification that is displayed to the end user. Defaults to "Update available".
      */
-    ON_NEXT_RESUME,
+    title?: string;
+}
+
+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 {
     /**
-     * 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.
+     * Whether the deployment succeeded or failed.
      */
-    ON_NEXT_SUSPEND,
-  }
+    status: CodePush.DeploymentStatus;
 
-  /**
-   * Indicates the current status of a sync operation.
-   */
-  enum SyncStatus {
     /**
-     * The app is up-to-date with the CodePush server.
+     * The version of the app that was deployed (for a native app upgrade).
      */
-    UP_TO_DATE,
+    appVersion?: string;
 
     /**
-     * An available update has been installed and will be run either immediately after the
-     * syncStatusChangedCallback function returns or the next time the app resumes/restarts,
-     * depending on the InstallMode specified in SyncOptions
+     * Details of the package that was deployed (or attempted to).
      */
-    UPDATE_INSTALLED,
+    package?: Package;
 
     /**
-     * The app had an optional update which the end user chose to ignore.
-     * (This is only applicable when the updateDialog is used)
+     * Deployment key used when deploying the previous package.
      */
-    UPDATE_IGNORED,
+    previousDeploymentKey?: string;
 
     /**
-     * The sync operation encountered an unknown error.
+     * The label (v#) of the package that was upgraded from.
      */
-    UNKNOWN_ERROR,
+    previousLabelOrAppVersion?: string;
+}
 
+/**
+ * Decorates a React Component configuring it to sync for updates with the CodePush server.
+ *
+ * @param options Options used to configure the end-user sync and update experience (e.g. when to check for updates?, show an prompt?, install the update immediately?).
+ */
+declare function CodePush(options?: CodePushOptions): (x: any) => any;
+
+declare namespace CodePush {
     /**
-     * There is an ongoing sync operation running which prevents the current call from being executed.
+     * Represents the default settings that will be used by the sync method if
+     * an update dialog is configured to be displayed.
      */
-    SYNC_IN_PROGRESS,
+    var DEFAULT_UPDATE_DIALOG: UpdateDialog;
 
     /**
-     * The CodePush server is being queried for an update.
+     * Asks the CodePush service whether the configured app deployment has an update available.
+     *
+     * @param handleBinaryVersionMismatchCallback An optional callback for handling target binary version mismatch
+     * @param prNumber (algocare PR preview release extension) When given, only PR preview releases
+     *                 (`{prNumber}-{semver}` keys in the release history) are considered.
      */
-    CHECKING_FOR_UPDATE,
+    function checkForUpdate(handleBinaryVersionMismatchCallback?: HandleBinaryVersionMismatchCallback, prNumber?: string): Promise<RemotePackage | null>;
 
     /**
-     * An update is available, and a confirmation dialog was shown
-     * to the end user. (This is only applicable when the updateDialog is used)
+     * Retrieves the metadata for an installed update (e.g. description, mandatory).
+     *
+     * @param updateState The state of the update you want to retrieve the metadata for. Defaults to UpdateState.RUNNING.
      */
-    AWAITING_USER_ACTION,
+    function getUpdateMetadata(updateState?: UpdateState): Promise<LocalPackage|null>;
 
     /**
-     * An available update is being downloaded from the CodePush server.
+     * Notifies the CodePush runtime that an installed update is considered successful.
      */
-    DOWNLOADING_PACKAGE,
+    function notifyAppReady(): Promise<StatusReport|void>;
 
     /**
-     * An available update was downloaded and is about to be installed.
+     * Allow CodePush to restart the app.
      */
-    INSTALLING_UPDATE,
+    function allowRestart(): void;
 
     /**
-     * The update has been downloaded and post-processing (unzip/file copy) is in progress.
-     * This status is only reported on iOS when the native module supports it.
+     * Forbid CodePush to restart the app.
      */
-    PREPARING_UPDATE,
-  }
+    function disallowRestart(): void;
 
-  /**
-   * Indicates the state that an update is currently in.
-   */
-  enum UpdateState {
     /**
-     * Indicates that an update represents the
-     * version of the app that is currently running.
+     * Clear all downloaded CodePush updates.
+     * This is useful when switching to a different deployment which may have an older release than the current package.
+     * Note: we don’t recommend to use 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.
      */
-    RUNNING,
+    function clearUpdates(): void;
 
     /**
-     * Indicates than an update has been installed, but the
-     * app hasn't been restarted yet in order to apply it.
+     * Immediately restarts the app.
+     *
+     * @param onlyIfUpdateIsPending Indicates whether you want the restart to no-op if there isn't currently a pending update.
      */
-    PENDING,
+    function restartApp(onlyIfUpdateIsPending?: boolean): void;
 
     /**
-     * Indicates than an update represents the latest available
-     * release, and can be either currently running or pending.
+     * Allows checking for an update, downloading it and installing it, all with a single call.
+     *
+     * @param options Options used to configure the end-user update experience (e.g. show an prompt?, install the update immediately?).
+     * @param syncStatusChangedCallback An optional callback that allows tracking the status of the sync operation, as opposed to simply checking the resolved state via the returned Promise.
+     * @param downloadProgressCallback An optional callback that allows tracking the progress of an update while it is being downloaded.
+     * @param handleBinaryVersionMismatchCallback An optional callback for handling target binary version mismatch
      */
-    LATEST,
-  }
+    function sync(options?: SyncOptions, syncStatusChangedCallback?: SyncStatusChangedCallback, downloadProgressCallback?: DownloadProgressCallback, handleBinaryVersionMismatchCallback?: HandleBinaryVersionMismatchCallback): Promise<SyncStatus>;
 
-  /**
-   * Indicates the status of a deployment (after installing and restarting).
-   */
-  enum DeploymentStatus {
     /**
-     * The deployment failed (and was rolled back).
+     * Indicates when you would like an installed update to actually be applied.
      */
-    FAILED,
+    enum InstallMode {
+        /**
+         * Indicates that you want to install the update and restart the app immediately.
+         */
+        IMMEDIATE,
+
+        /**
+         * Indicates that you want to install the update, but not forcibly restart the app.
+         */
+        ON_NEXT_RESTART,
+
+        /**
+         * 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 then 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_RESUME,
+
+        /**
+         * 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.
+         */
+        ON_NEXT_SUSPEND
+    }
 
     /**
-     * The deployment succeeded.
+     * Indicates the current status of a sync operation.
      */
-    SUCCEEDED,
-  }
+    enum SyncStatus {
+        /**
+         * The app is up-to-date with the CodePush server.
+         */
+        UP_TO_DATE,
+
+        /**
+         * An available update has been installed and will be run either immediately after the
+         * syncStatusChangedCallback function returns or the next time the app resumes/restarts,
+         * depending on the InstallMode specified in SyncOptions
+         */
+        UPDATE_INSTALLED,
+
+        /**
+         * The app had an optional update which the end user chose to ignore.
+         * (This is only applicable when the updateDialog is used)
+         */
+        UPDATE_IGNORED,
+
+        /**
+         * The sync operation encountered an unknown error.
+         */
+        UNKNOWN_ERROR,
+
+        /**
+         * There is an ongoing sync operation running which prevents the current call from being executed.
+         */
+        SYNC_IN_PROGRESS,
+
+        /**
+         * The CodePush server is being queried for an update.
+         */
+        CHECKING_FOR_UPDATE,
+
+        /**
+         * An update is available, and a confirmation dialog was shown
+         * to the end user. (This is only applicable when the updateDialog is used)
+         */
+        AWAITING_USER_ACTION,
+
+        /**
+         * An available update is being downloaded from the CodePush server.
+         */
+        DOWNLOADING_PACKAGE,
+
+        /**
+         * An available update was downloaded and is about to be installed.
+         */
+        INSTALLING_UPDATE,
+
+        /**
+         * The update has been downloaded and post-processing (unzip/file copy) is in progress.
+         * This status is only reported on iOS when the native module supports it.
+         */
+        PREPARING_UPDATE
+    }
 
-  /**
-   * Indicates when you would like to check for (and install) updates from the CodePush server.
-   */
-  enum CheckFrequency {
     /**
-     * When the app is fully initialized (or more specifically, when the root component is mounted).
+     * Indicates the state that an update is currently in.
      */
-    ON_APP_START,
+    enum UpdateState {
+        /**
+         * Indicates that an update represents the
+         * version of the app that is currently running.
+         */
+        RUNNING,
+
+        /**
+         * Indicates than an update has been installed, but the
+         * app hasn't been restarted yet in order to apply it.
+         */
+        PENDING,
+
+        /**
+         * Indicates than an update represents the latest available
+         * release, and can be either currently running or pending.
+         */
+        LATEST
+    }
 
     /**
-     * When the app re-enters the foreground.
+     * Indicates the status of a deployment (after installing and restarting).
      */
-    ON_APP_RESUME,
+    enum DeploymentStatus {
+        /**
+         * The deployment failed (and was rolled back).
+         */
+        FAILED,
+
+        /**
+         * The deployment succeeded.
+         */
+        SUCCEEDED
+    }
 
     /**
-     * Don't automatically check for updates, but only do it when codePush.sync() is manully called inside app code.
+     * Indicates when you would like to check for (and install) updates from the CodePush server.
      */
-    MANUAL,
-  }
+    enum CheckFrequency {
+        /**
+         * When the app is fully initialized (or more specifically, when the root component is mounted).
+         */
+        ON_APP_START,
+
+        /**
+         * When the app re-enters the foreground.
+         */
+        ON_APP_RESUME,
+
+        /**
+         * Don't automatically check for updates, but only do it when codePush.sync() is manully called inside app code.
+         */
+        MANUAL
+    }
 }
 
-export default CodePush
+export default CodePush;
 
 /**
  * Interface for the config file required for `npx code-push` CLI operation.
@@ -567,55 +575,111 @@ export default CodePush
  * Please refer to the example code for implementation guidance.
  */
 export interface CliConfigInterface {
-  /**
-   * Interface that must be implemented to upload CodePush bundle files to an arbitrary infrastructure.
-   *
-   * Used in the `release` command, and must return a URL that allows downloading the file after the upload is completed.
-   * The URL is recorded in the ReleaseHistory, and the CodePush runtime library downloads the bundle file from this address.
-   *
-   * @param source The relative path of the generated bundle file. (e.g. build/bundleOutput/1087bc338fc45a961c...)
-   * @param platform The target platform of the bundle file. This is the string passed when executing the CLI command. ('ios'/'android')
-   * @param identifier An additional identifier string. This can be used to distinguish execution environments by incorporating it into the upload path or file name. This string is passed when executing the CLI command.
-   */
-  bundleUploader: (
-    source: string,
-    platform: 'ios' | 'android',
-    identifier?: string
-  ) => Promise<{ downloadUrl: string }>
-
-  /**
-   * Interface that must be implemented to retrieve ReleaseHistory information.
-   *
-   * Use `fetch`, `axios`, or similar methods to fetch the data and return it.
-   *
-   * @param targetBinaryVersion The target binary app version for which ReleaseHistory information is retrieved. This string is passed when executing the CLI command. (e.g., '1.0.0')
-   * @param platform The target platform for which the information is retrieved. This string is passed when executing the CLI command. ('ios'/'android')
-   * @param identifier An additional identifier string. This string is passed when executing the CLI command.
-   */
-  getReleaseHistory: (
-    targetBinaryVersion: string,
-    platform: 'ios' | 'android',
-    identifier?: string
-  ) => Promise<ReleaseHistoryInterface>
-
-  /**
-   * Interface that must be implemented to create or update ReleaseHistory information.
-   *
-   * Used in the `create-history`, `release`, and `update-history` commands.
-   * The created or modified object and the JSON file path containing the result of the command execution are provided.
-   * Implement this function to upload the file or call a REST API to update the release history.
-   *
-   * @param targetBinaryVersion The target binary app version for the ReleaseHistory. This string is passed when executing the CLI command. (e.g., '1.0.0')
-   * @param jsonFilePath The absolute path to a JSON file following the `ReleaseHistoryInterface` structure. The file is created in the project's root directory and deleted when the command execution completes.
-   * @param releaseInfo A plain object following the `ReleaseHistoryInterface` structure.
-   * @param platform The target platform. This string is passed when executing the CLI command. ('ios'/'android')
-   * @param identifier An additional identifier string. This string is passed when executing the CLI command.
-   */
-  setReleaseHistory: (
-    targetBinaryVersion: string,
-    jsonFilePath: string,
-    releaseInfo: ReleaseHistoryInterface,
-    platform: 'ios' | 'android',
-    identifier?: string
-  ) => Promise<void>
+    /**
+     * Interface that must be implemented to upload CodePush bundle files to an arbitrary infrastructure.
+     *
+     * Used in the `release` command, and must return a URL that allows downloading the file after the upload is completed.
+     * The URL is recorded in the ReleaseHistory, and the CodePush runtime library downloads the bundle file from this address.
+     *
+     * @param source The relative path of the generated bundle file. (e.g. build/bundleOutput/1087bc338fc45a961c...)
+     * @param platform The target platform of the bundle file. This is the string passed when executing the CLI command. ('ios'/'android')
+     * @return {Promise<{downloadUrl: string}>} An object containing the `downloadUrl` property, which is the URL from which the uploaded bundle file can be downloaded. This URL will be recorded in the release history.
+     */
+    bundleUploader: (
+        source: string,
+        platform: "ios" | "android",
+        identifier?: string,
+        app?: string,
+    ) => Promise<{downloadUrl: string}>;
+
+    /**
+     * Interface that must be implemented to retrieve ReleaseHistory information.
+     *
+     * Use `fetch`, `axios`, or similar methods to fetch the data and return it.
+     *
+     * @param targetBinaryVersion The target binary app version for which ReleaseHistory information is retrieved. This string is passed when executing the CLI command. (e.g., '1.0.0')
+     * @param platform The target platform for which the information is retrieved. This string is passed when executing the CLI command. ('ios'/'android')
+     * @param identifier An additional identifier string. This string is passed when executing the CLI command.
+     */
+    getReleaseHistory: (
+        targetBinaryVersion: string,
+        platform: "ios" | "android",
+        identifier?: string,
+        app?: string,
+    ) => Promise<ReleaseHistoryInterface>;
+
+    /**
+     * Interface that must be implemented to create or update ReleaseHistory information.
+     *
+     * Used in the `create-history`, `release`, and `update-history` commands.
+     * The created or modified object and the JSON file path containing the result of the command execution are provided.
+     * Implement this function to upload the file or call a REST API to update the release history.
+     *
+     * @param targetBinaryVersion The target binary app version for the ReleaseHistory. This string is passed when executing the CLI command. (e.g., '1.0.0')
+     * @param jsonFilePath The absolute path to a JSON file following the `ReleaseHistoryInterface` structure. The file is created in the project's root directory and deleted when the command execution completes.
+     * @param releaseInfo A plain object following the `ReleaseHistoryInterface` structure.
+     * @param platform The target platform. This string is passed when executing the CLI command. ('ios'/'android')
+     * @param identifier An additional identifier string. This string is passed when executing the CLI command.
+     */
+    setReleaseHistory: (
+        targetBinaryVersion: string,
+        jsonFilePath: string,
+        releaseInfo: ReleaseHistoryInterface,
+        platform: "ios" | "android",
+        identifier?: string,
+        app?: string,
+    ) => Promise<void>;
+
+    /**
+     * (Optional / algocare extension) Retrieves the binary version list file (`list.json`) that indexes
+     * all binary versions for which a release history exists.
+     *
+     * Used in the `create-history` command. If not implemented, the `list.json` update step is skipped.
+     *
+     * @param platform The target platform. ('ios'/'android')
+     * @param identifier An additional identifier string. (e.g. 'stg'/'prd')
+     * @param app The target app name. (e.g. 'home-mobile')
+     * @return An object mapping binary versions to their release history URLs. (e.g. { "1.0.0": "https://cdn/histories/home-mobile/ios/1.0.0.json" })
+     */
+    getBinaryVersionList?: (
+        platform: "ios" | "android",
+        identifier?: string,
+        app?: string,
+    ) => Promise<Record<string, string>>;
+
+    /**
+     * (Optional / algocare extension) Adds a binary version entry to the binary version list file (`list.json`).
+     *
+     * Used in the `create-history` command. If not implemented, the `list.json` update step is skipped.
+     *
+     * @param targetBinaryVersion The binary version to add to the list.
+     * @param jsonFilePath The absolute path to a JSON file containing the current list content (before adding the new version).
+     * @param platform The target platform. ('ios'/'android')
+     * @param identifier An additional identifier string. (e.g. 'stg'/'prd')
+     * @param app The target app name. (e.g. 'home-mobile')
+     */
+    setBinaryVersionList?: (
+        targetBinaryVersion: string,
+        jsonFilePath: string,
+        platform: "ios" | "android",
+        identifier?: string,
+        app?: string,
+    ) => Promise<void>;
+
+    /**
+     * (Optional / algocare extension) Removes a release history file.
+     *
+     * Used in the `remove-pr-history` command to clean up PR preview release histories.
+     *
+     * @param targetBinaryVersion The binary version (or PR number for PR preview histories) whose history should be removed.
+     * @param platform The target platform. ('ios'/'android')
+     * @param identifier An additional identifier string. (e.g. 'stg'/'prd')
+     * @param app The target app name. (e.g. 'home-mobile')
+     */
+    removeReleaseHistory?: (
+        targetBinaryVersion: string,
+        platform: "ios" | "android",
+        identifier?: string,
+        app?: string,
+    ) => Promise<void>;
 }