@capawesome/capacitor-live-update 7.3.0 → 7.4.0

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>",
@@ -409,6 +534,35 @@
         ],
         "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>",
@@ -659,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",
@@ -715,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",
@@ -801,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",
@@ -963,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",
@@ -1211,6 +1519,17 @@
           ]
         }
       ]
+    },
+    {
+      "name": "ReloadedListener",
+      "slug": "reloadedlistener",
+      "docs": "Listener for when the app is reloaded.",
+      "types": [
+        {
+          "text": "(): void",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": [

package/dist/esm/definitions.d.ts

@@ -102,6 +102,17 @@ declare module '@capacitor/cli' {
     }
 }
 export interface LiveUpdatePlugin {
+    /**
+     * Clear all blocked bundles from the blocked list.
+     *
+     * This removes all bundle identifiers that were automatically blocked
+     * due to rollbacks when `autoBlockRolledBackBundles` is enabled.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    clearBlockedBundles(): Promise<void>;
     /**
      * Delete a bundle from the app.
      *
@@ -126,12 +137,24 @@ export interface LiveUpdatePlugin {
      * @since 6.6.0
      */
     fetchLatestBundle(options?: FetchLatestBundleOptions): Promise<FetchLatestBundleResult>;
+    /**
+     * Get all blocked bundle identifiers.
+     *
+     * Returns the list of bundle identifiers that were automatically blocked
+     * due to rollbacks when `autoBlockRolledBackBundles` is enabled.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    getBlockedBundles(): Promise<GetBlockedBundlesResult>;
     /**
      * Get all identifiers of bundles that have been downloaded.
      *
      * Only available on Android and iOS.
      *
      * @since 5.0.0
+     * @deprecated Use `getDownloadedBundles()` instead.
      */
     getBundles(): Promise<GetBundlesResult>;
     /**
@@ -142,6 +165,25 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     getChannel(): Promise<GetChannelResult>;
+    /**
+     * Get the runtime configuration.
+     *
+     * Returns the current plugin configuration including any runtime
+     * overrides set via `setConfig()`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    getConfig(): Promise<GetConfigResult>;
+    /**
+     * Get all identifiers of bundles that have been downloaded.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    getDownloadedBundles(): Promise<GetDownloadedBundlesResult>;
     /**
      * Get the bundle identifier of the current bundle.
      * The current bundle is the bundle that is currently used by the app.
@@ -167,6 +209,14 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     getDeviceId(): Promise<GetDeviceIdResult>;
+    /**
+     * Check whether a sync operation is currently in progress.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    isSyncing(): Promise<IsSyncingResult>;
     /**
      * Get the bundle identifier of the next bundle.
      * The next bundle is the bundle that will be used after calling `reload()`
@@ -228,6 +278,17 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     reset(): Promise<void>;
+    /**
+     * Reset the runtime configuration to the values from the Capacitor config file.
+     *
+     * This clears any runtime configuration set via `setConfig()`.
+     * The changes take effect immediately.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    resetConfig(): Promise<void>;
     /**
      * Set the channel to use for the update.
      *
@@ -236,6 +297,21 @@ export interface LiveUpdatePlugin {
      * @since 5.0.0
      */
     setChannel(options: SetChannelOptions): Promise<void>;
+    /**
+     * Set the runtime configuration.
+     *
+     * This allows updating plugin configuration options at runtime.
+     * The changes are persisted across app restarts and take effect immediately.
+     *
+     * **Important:** Runtime configuration is automatically reset to default values
+     * whenever the native app is updated to a new version. This ensures that
+     * configuration from previous versions doesn't persist after an app update.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    setConfig(options: SetConfigOptions): Promise<void>;
     /**
      * Set the custom identifier of the device.
      *
@@ -283,6 +359,21 @@ export interface LiveUpdatePlugin {
      * @since 7.3.0
      */
     addListener(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener): Promise<PluginListenerHandle>;
+    /**
+     * Listen for when the app is reloaded.
+     *
+     * This event is triggered after the `reload()` method is called
+     * and the app has been reloaded.
+     *
+     * **Note:** To verify whether an update was successfully applied after a reload,
+     * use the `ready()` method instead. The `ready()` method provides detailed information
+     * about the current bundle, previous bundle, and whether a rollback occurred.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 7.4.0
+     */
+    addListener(eventName: 'reloaded', listenerFunc: ReloadedListener): Promise<PluginListenerHandle>;
     /**
      * Remove all listeners for this plugin.
      *
@@ -436,6 +527,17 @@ export interface GetBundleResult {
      */
     bundleId: string | null;
 }
+/**
+ * @since 7.4.0
+ */
+export interface GetBlockedBundlesResult {
+    /**
+     * An array of unique identifiers of all blocked bundles.
+     *
+     * @since 7.4.0
+     */
+    bundleIds: string[];
+}
 /**
  * @since 5.0.0
  */
@@ -447,6 +549,17 @@ export interface GetBundlesResult {
      */
     bundleIds: string[];
 }
+/**
+ * @since 7.4.0
+ */
+export interface GetDownloadedBundlesResult {
+    /**
+     * An array of unique identifiers of all downloaded bundles.
+     *
+     * @since 7.4.0
+     */
+    bundleIds: string[];
+}
 /**
  * @since 5.0.0
  */
@@ -461,6 +574,27 @@ export interface GetChannelResult {
      */
     channel: string | null;
 }
+/**
+ * @since 7.4.0
+ */
+export interface GetConfigResult {
+    /**
+     * The app ID used to identify the app.
+     *
+     * If `null`, no app ID is configured.
+     *
+     * @since 7.4.0
+     * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'
+     */
+    appId: string | null;
+    /**
+     * The auto-update strategy for live updates.
+     *
+     * @since 7.4.0
+     * @example 'background'
+     */
+    autoUpdateStrategy: 'none' | 'background';
+}
 /**
  * @since 6.7.0
  */
@@ -490,6 +624,17 @@ export interface GetDeviceIdResult {
      */
     deviceId: string;
 }
+/**
+ * @since 7.4.0
+ */
+export interface IsSyncingResult {
+    /**
+     * Whether a sync operation is currently in progress.
+     *
+     * @since 7.4.0
+     */
+    syncing: boolean;
+}
 /**
  * @since 6.7.0
  */
@@ -599,6 +744,20 @@ export interface SetChannelOptions {
      */
     channel: string | null;
 }
+/**
+ * @since 7.4.0
+ */
+export interface SetConfigOptions {
+    /**
+     * The app ID used to identify the app.
+     *
+     * Set `null` to reset to the value from the Capacitor config file.
+     *
+     * @since 7.4.0
+     * @example '6e351b4f-69a7-415e-a057-4567df7ffe94'
+     */
+    appId?: string | null;
+}
 /**
  * @since 5.0.0
  */
@@ -710,3 +869,9 @@ export interface NextBundleSetEvent {
      */
     bundleId: string | null;
 }
+/**
+ * Listener for when the app is reloaded.
+ *
+ * @since 7.4.0
+ */
+export declare type ReloadedListener = () => void;