refactor(app-update)!: remove currentVersion and availableVersion…

… properties (#150)
capawesome-team · Feb 27, 2024 · a8e0940 · a8e0940
1 parent de6bcf8
commit a8e0940
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 22 deletions.
diff --git a/.changeset/gold-buckets-joke.md b/.changeset/gold-buckets-joke.md
@@ -0,0 +1,5 @@
+---
+'@capawesome/capacitor-app-update': major
+---
+
+refactor: remove `currentVersion` and `availableVersion` properties
diff --git a/packages/app-update/BREAKING.md b/packages/app-update/BREAKING.md
@@ -4,8 +4,19 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 ## Versions
 
+- [Version 6.x.x](#version-6xx)
 - [Version 5.x.x](#version-5xx)
 
+## Version 6.x.x
+
+### `currentVersion` property
+
+The `currentVersion` property has been replaced by the `currentVersionCode` and `currentVersionName` properties in the `AppUpdateInfo` interface.
+
+### `availableVersion` property
+
+The `availableVersion` property has been replaced by the `availableVersionCode` and `availableVersionName` properties in the `AppUpdateInfo` interface.
+
 ## Version 5.x.x
 
 ### Capacitor 5

diff --git a/...te/android/src/main/java/io/capawesome/capacitorjs/plugins/appupdate/AppUpdatePlugin.java b/...te/android/src/main/java/io/capawesome/capacitorjs/plugins/appupdate/AppUpdatePlugin.java
@@ -80,9 +80,7 @@ public void getAppUpdateInfo(PluginCall call) {
                     }
                     JSObject ret = new JSObject();
                     ret.put("currentVersionName", pInfo.versionName);
-                    ret.put("currentVersion", String.valueOf(pInfo.versionCode));
                     ret.put("currentVersionCode", String.valueOf(pInfo.versionCode));
-                    ret.put("availableVersion", String.valueOf(appUpdateInfo.availableVersionCode()));
                     ret.put("availableVersionCode", String.valueOf(appUpdateInfo.availableVersionCode()));
                     ret.put("updateAvailability", appUpdateInfo.updateAvailability());
                     ret.put("updatePriority", appUpdateInfo.updatePriority());

diff --git a/packages/app-update/ios/Plugin/AppUpdatePlugin.swift b/packages/app-update/ios/Plugin/AppUpdatePlugin.swift
@@ -46,9 +46,7 @@ public class AppUpdatePlugin: CAPPlugin {
                 call.resolve([
                     "currentVersionName": currentVersionName,
                     "availableVersionName": availableVersionName,
-                    "currentVersion": currentVersionName,
                     "currentVersionCode": currentVersionCode,
-                    "availableVersion": availableVersionName,
                     "availableVersionReleaseDate": availableVersionReleaseDate,
                     "updateAvailability": updateAvailability,
                     "minimumOsVersion": minimumOsVersion

diff --git a/packages/app-update/src/definitions.ts b/packages/app-update/src/definitions.ts
@@ -80,14 +80,6 @@ export interface AppUpdateInfo {
    * @example "1.1.0"
    */
   availableVersionName?: string;
-  /**
-   * Version code (Android) or CFBundleShortVersionString (iOS) of the currently installed app version.
-   *
-   * Only available on Android and iOS.
-   *
-   * @deprecated On **Android**, use `currentVersionCode` instead. On **iOS**, use `currentVersionName` instead.
-   */
-  currentVersion: string;
   /**
    * The current version code of the app.
    *
@@ -100,14 +92,6 @@ export interface AppUpdateInfo {
    * @example "1"
    */
   currentVersionCode: string;
-  /**
-   * Version code (Android) or CFBundleShortVersionString (iOS) of the update.
-   *
-   * Only available on Android and iOS.
-   *
-   * @deprecated On **Android**, use `availableVersionCode` instead. On **iOS**, use `availableVersionName` instead.
-   */
-  availableVersion: string;
   /**
    * The available version code of the update.
    *

diff --git a/packages/file-picker/BREAKING.md b/packages/file-picker/BREAKING.md
@@ -4,13 +4,14 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 ## Versions
 
+- [Version 6.x.x](#version-6xx)
 - [Version 5.x.x](#version-5xx)
 
 ## Version 6.x.x
 
-### Replace the `multiple` option
+### `multiple` property
 
-The `multiple` option has been replaced by a new `limit` option in the `pickFiles(...)`, `pickImages(...)`, `pickMedia(...)` and `pickVideos(...)` methods.
+The `multiple` property has been replaced by a new `limit` property in the `PickFilesOptions` and `PickMediaOptions` interfaces.
 
 ## Version 5.x.x