@capawesome/capacitor-live-update 7.2.2 → 7.4.0-dev.f18299f8.1767510052

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/GetConfigResult.java

@@ -0,0 +1,40 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+import org.json.JSONObject;
+
+public class GetConfigResult implements Result {
+
+    @Nullable
+    private final String appId;
+
+    @NonNull
+    private final String autoUpdateStrategy;
+
+    public GetConfigResult(@Nullable String appId, @NonNull String autoUpdateStrategy) {
+        this.appId = appId;
+        this.autoUpdateStrategy = autoUpdateStrategy;
+    }
+
+    @Nullable
+    public String getAppId() {
+        return appId;
+    }
+
+    @NonNull
+    public String getAutoUpdateStrategy() {
+        return autoUpdateStrategy;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("appId", appId == null ? JSONObject.NULL : appId);
+        result.put("autoUpdateStrategy", autoUpdateStrategy);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/GetDownloadedBundlesResult.java

@@ -0,0 +1,27 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class GetDownloadedBundlesResult implements Result {
+
+    @NonNull
+    private String[] bundleIds;
+
+    public GetDownloadedBundlesResult(@NonNull String[] bundleIds) {
+        this.bundleIds = bundleIds;
+    }
+
+    public JSObject toJSObject() {
+        JSArray bundleIdsResult = new JSArray();
+        for (String bundleId : bundleIds) {
+            bundleIdsResult.put(bundleId);
+        }
+
+        JSObject result = new JSObject();
+        result.put("bundleIds", bundleIdsResult);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/IsSyncingResult.java

@@ -0,0 +1,26 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class IsSyncingResult implements Result {
+
+    private final boolean syncing;
+
+    public IsSyncingResult(boolean syncing) {
+        this.syncing = syncing;
+    }
+
+    public boolean getSyncing() {
+        return syncing;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("syncing", syncing);
+        return result;
+    }
+}

package/dist/docs.json

@@ -5,6 +5,21 @@
     "docs": "",
     "tags": [],
     "methods": [
+      {
+        "name": "clearBlockedBundles",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Clear all blocked bundles from the blocked list.\n\nThis removes all bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "clearblockedbundles"
+      },
       {
         "name": "deleteBundle",
         "signature": "(options: DeleteBundleOptions) => Promise<void>",
@@ -75,6 +90,23 @@
         ],
         "slug": "fetchlatestbundle"
       },
+      {
+        "name": "getBlockedBundles",
+        "signature": "() => Promise<GetBlockedBundlesResult>",
+        "parameters": [],
+        "returns": "Promise<GetBlockedBundlesResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Get all blocked bundle identifiers.\n\nReturns the list of bundle identifiers that were automatically blocked\ndue to rollbacks when `autoBlockRolledBackBundles` is enabled.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetBlockedBundlesResult"
+        ],
+        "slug": "getblockedbundles"
+      },
       {
         "name": "getBundles",
         "signature": "() => Promise<GetBundlesResult>",
@@ -84,6 +116,10 @@
           {
             "name": "since",
             "text": "5.0.0"
+          },
+          {
+            "name": "deprecated",
+            "text": "Use `getDownloadedBundles()` instead."
           }
         ],
         "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
@@ -109,6 +145,40 @@
         ],
         "slug": "getchannel"
       },
+      {
+        "name": "getConfig",
+        "signature": "() => Promise<GetConfigResult>",
+        "parameters": [],
+        "returns": "Promise<GetConfigResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Get the runtime configuration.\n\nReturns the current plugin configuration including any runtime\noverrides set via `setConfig()`.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetConfigResult"
+        ],
+        "slug": "getconfig"
+      },
+      {
+        "name": "getDownloadedBundles",
+        "signature": "() => Promise<GetDownloadedBundlesResult>",
+        "parameters": [],
+        "returns": "Promise<GetDownloadedBundlesResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Get all identifiers of bundles that have been downloaded.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetDownloadedBundlesResult"
+        ],
+        "slug": "getdownloadedbundles"
+      },
       {
         "name": "getCurrentBundle",
         "signature": "() => Promise<GetCurrentBundleResult>",
@@ -160,6 +230,23 @@
         ],
         "slug": "getdeviceid"
       },
+      {
+        "name": "isSyncing",
+        "signature": "() => Promise<IsSyncingResult>",
+        "parameters": [],
+        "returns": "Promise<IsSyncingResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Check whether a sync operation is currently in progress.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsSyncingResult"
+        ],
+        "slug": "issyncing"
+      },
       {
         "name": "getNextBundle",
         "signature": "() => Promise<GetNextBundleResult>",
@@ -258,6 +345,21 @@
         "complexTypes": [],
         "slug": "reset"
       },
+      {
+        "name": "resetConfig",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Reset the runtime configuration to the values from the Capacitor config file.\n\nThis clears any runtime configuration set via `setConfig()`.\nThe changes take effect immediately.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "resetconfig"
+      },
       {
         "name": "setChannel",
         "signature": "(options: SetChannelOptions) => Promise<void>",
@@ -281,6 +383,29 @@
         ],
         "slug": "setchannel"
       },
+      {
+        "name": "setConfig",
+        "signature": "(options: SetConfigOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetConfigOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Set the runtime configuration.\n\nThis allows updating plugin configuration options at runtime.\nThe changes are persisted across app restarts and take effect immediately.\n\n**Important:** Runtime configuration is automatically reset to default values\nwhenever the native app is updated to a new version. This ensures that\nconfiguration from previous versions doesn't persist after an app update.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "SetConfigOptions"
+        ],
+        "slug": "setconfig"
+      },
       {
         "name": "setCustomId",
         "signature": "(options: SetCustomIdOptions) => Promise<void>",
@@ -380,6 +505,64 @@
         ],
         "slug": "addlistenerdownloadbundleprogress-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'nextBundleSet'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "NextBundleSetListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.3.0"
+          }
+        ],
+        "docs": "Listen for when a bundle is set as the next bundle.\n\nThis event is triggered whenever a bundle is set to be used on the next app restart,\neither through automatic updates or manual calls to `setNextBundle()`.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "NextBundleSetListener"
+        ],
+        "slug": "addlistenernextbundleset-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'reloaded', listenerFunc: ReloadedListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'reloaded'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ReloadedListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.4.0"
+          }
+        ],
+        "docs": "Listen for when the app is reloaded.\n\nThis event is triggered after the `reload()` method is called\nand the app has been reloaded.\n\n**Note:** To verify whether an update was successfully applied after a reload,\nuse the `ready()` method instead. The `ready()` method provides detailed information\nabout the current bundle, previous bundle, and whether a rollback occurred.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ReloadedListener"
+        ],
+        "slug": "addlistenerreloaded-"
+      },
       {
         "name": "removeAllListeners",
         "signature": "() => Promise<void>",
@@ -630,6 +813,32 @@
         }
       ]
     },
+    {
+      "name": "GetBlockedBundlesResult",
+      "slug": "getblockedbundlesresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "7.4.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleIds",
+          "tags": [
+            {
+              "text": "7.4.0",
+              "name": "since"
+            }
+          ],
+          "docs": "An array of unique identifiers of all blocked bundles.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
     {
       "name": "GetBundlesResult",
       "slug": "getbundlesresult",
@@ -686,6 +895,78 @@
         }
       ]
     },
+    {
+      "name": "GetConfigResult",
+      "slug": "getconfigresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "7.4.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "7.4.0",
+              "name": "since"
+            },
+            {
+              "text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
+              "name": "example"
+            }
+          ],
+          "docs": "The app ID used to identify the app.\n\nIf `null`, no app ID is configured.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "autoUpdateStrategy",
+          "tags": [
+            {
+              "text": "7.4.0",
+              "name": "since"
+            },
+            {
+              "text": "'background'",
+              "name": "example"
+            }
+          ],
+          "docs": "The auto-update strategy for live updates.",
+          "complexTypes": [],
+          "type": "'none' | 'background'"
+        }
+      ]
+    },
+    {
+      "name": "GetDownloadedBundlesResult",
+      "slug": "getdownloadedbundlesresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "7.4.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleIds",
+          "tags": [
+            {
+              "text": "7.4.0",
+              "name": "since"
+            }
+          ],
+          "docs": "An array of unique identifiers of all downloaded bundles.",
+          "complexTypes": [],
+          "type": "string[]"
+        }
+      ]
+    },
     {
       "name": "GetCurrentBundleResult",
       "slug": "getcurrentbundleresult",
@@ -772,6 +1053,32 @@
         }
       ]
     },
+    {
+      "name": "IsSyncingResult",
+      "slug": "issyncingresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "7.4.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "syncing",
+          "tags": [
+            {
+              "text": "7.4.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether a sync operation is currently in progress.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
     {
       "name": "GetNextBundleResult",
       "slug": "getnextbundleresult",
@@ -934,6 +1241,36 @@
         }
       ]
     },
+    {
+      "name": "SetConfigOptions",
+      "slug": "setconfigoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "7.4.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "7.4.0",
+              "name": "since"
+            },
+            {
+              "text": "'6e351b4f-69a7-415e-a057-4567df7ffe94'",
+              "name": "example"
+            }
+          ],
+          "docs": "The app ID used to identify the app.\n\nSet `null` to reset to the value from the Capacitor config file.",
+          "complexTypes": [],
+          "type": "string | null | undefined"
+        }
+      ]
+    },
     {
       "name": "SetCustomIdOptions",
       "slug": "setcustomidoptions",
@@ -1123,6 +1460,36 @@
           "type": "number"
         }
       ]
+    },
+    {
+      "name": "NextBundleSetEvent",
+      "slug": "nextbundlesetevent",
+      "docs": "Event that is triggered when a bundle is set as the next bundle.",
+      "tags": [
+        {
+          "text": "7.3.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "7.3.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle that is set as the next bundle.\n\nIf `null`, the default bundle will be used.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -1139,6 +1506,30 @@
           ]
         }
       ]
+    },
+    {
+      "name": "NextBundleSetListener",
+      "slug": "nextbundlesetlistener",
+      "docs": "Listener for when a bundle is set as the next bundle.",
+      "types": [
+        {
+          "text": "(event: NextBundleSetEvent): void",
+          "complexTypes": [
+            "NextBundleSetEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "ReloadedListener",
+      "slug": "reloadedlistener",
+      "docs": "Listener for when the app is reloaded.",
+      "types": [
+        {
+          "text": "(): void",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": [
@@ -1162,6 +1553,22 @@
           "complexTypes": [],
           "type": "string | undefined"
         },
+        {
+          "name": "autoBlockRolledBackBundles",
+          "tags": [
+            {
+              "text": "7.3.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether or not to automatically block bundles that have been rolled back.\n\nWhen enabled, the plugin will automatically block bundles that caused a rollback\n(up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked.\nBlocked bundles will be skipped in future sync operations.\n\n**Attention**: This option has no effect if `readyTimeout` is set to `0`.\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "autoDeleteBundles",
           "tags": [
@@ -1178,6 +1585,26 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "autoUpdateStrategy",
+          "tags": [
+            {
+              "text": "7.3.0",
+              "name": "since"
+            },
+            {
+              "text": "'none'",
+              "name": "default"
+            },
+            {
+              "text": "'background'",
+              "name": "example"
+            }
+          ],
+          "docs": "The auto-update strategy for live updates.\n\n- `none`: Live updates will not be applied automatically.\n- `background`: Live updates will be automatically downloaded\nand applied in the background at app startup and when the app resumes\n(if the last check was more than 15 minutes ago).\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "'none' | 'background' | undefined"
+        },
         {
           "name": "defaultChannel",
           "tags": [
@@ -1242,7 +1669,7 @@
               "name": "example"
             }
           ],
-          "docs": "The timeout in milliseconds to wait for the app to be ready\nbefore resetting to the default bundle.\n\nIt is strongly **recommended** to configure this option so that\nthe plugin can roll back to the default bundle in case of problems.\nIf configured, the plugin will wait for the app to call the `ready()`\nmethod before resetting to the default bundle.\n\nSet to `0` to disable the timeout.",
+          "docs": "The timeout in milliseconds to wait for the app to be ready\nbefore resetting to the default bundle.\n\nIt is strongly **recommended** to configure this option (e.g. `10000` ms)\nso that the plugin can roll back to the default bundle in case of problems.\nIf configured, the plugin will wait for the app to call the `ready()`\nmethod before resetting to the default bundle.\n\nSet to `0` to disable the timeout.",
           "complexTypes": [],
           "type": "number | undefined"
         },