@capawesome/capacitor-live-update 6.7.2 → 7.1.0

package/dist/docs.json

@@ -75,27 +75,6 @@
         ],
         "slug": "fetchlatestbundle"
       },
-      {
-        "name": "getBundle",
-        "signature": "() => Promise<GetBundleResult>",
-        "parameters": [],
-        "returns": "Promise<GetBundleResult>",
-        "tags": [
-          {
-            "name": "since",
-            "text": "5.0.0"
-          },
-          {
-            "name": "deprecated",
-            "text": "Use `getCurrentBundle()` instead."
-          }
-        ],
-        "docs": "Get the active bundle identifier.\n\nOnly available on Android and iOS.",
-        "complexTypes": [
-          "GetBundleResult"
-        ],
-        "slug": "getbundle"
-      },
       {
         "name": "getBundles",
         "signature": "() => Promise<GetBundlesResult>",
@@ -209,7 +188,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the version code of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the version code of the app.\n\nOn **Android**, this is the `versionCode` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "GetVersionCodeResult"
         ],
@@ -226,7 +205,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the version name of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the version name of the app.\n\nOn **Android**, this is the `versionName` from the `android/app/build.gradle` file.\nOn **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "GetVersionNameResult"
         ],
@@ -234,9 +213,9 @@
       },
       {
         "name": "ready",
-        "signature": "() => Promise<void>",
+        "signature": "() => Promise<ReadyResult>",
         "parameters": [],
-        "returns": "Promise<void>",
+        "returns": "Promise<ReadyResult>",
         "tags": [
           {
             "name": "since",
@@ -244,7 +223,9 @@
           }
         ],
         "docs": "Notify the plugin that the app is ready to use and no rollback is needed.\n\n**Attention**: This method should be called as soon as the app is ready to use\nto prevent the app from being reset to the default bundle.\n\nOnly available on Android and iOS.",
-        "complexTypes": [],
+        "complexTypes": [
+          "ReadyResult"
+        ],
         "slug": "ready"
       },
       {
@@ -277,33 +258,6 @@
         "complexTypes": [],
         "slug": "reset"
       },
-      {
-        "name": "setBundle",
-        "signature": "(options: SetBundleOptions) => Promise<void>",
-        "parameters": [
-          {
-            "name": "options",
-            "docs": "",
-            "type": "SetBundleOptions"
-          }
-        ],
-        "returns": "Promise<void>",
-        "tags": [
-          {
-            "name": "since",
-            "text": "5.0.0"
-          },
-          {
-            "name": "deprecated",
-            "text": "Use `setNextBundle()` instead."
-          }
-        ],
-        "docs": "Set the next bundle to use for the app.\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
-        "complexTypes": [
-          "SetBundleOptions"
-        ],
-        "slug": "setbundle"
-      },
       {
         "name": "setChannel",
         "signature": "(options: SetChannelOptions) => Promise<void>",
@@ -396,6 +350,35 @@
           "SyncOptions"
         ],
         "slug": "sync"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'downloadBundleProgress', listenerFunc: DownloadBundleProgressListener) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'downloadBundleProgress'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "DownloadBundleProgressListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Listen for the download progress of a bundle.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DownloadBundleProgressListener"
+        ],
+        "slug": "addlistenerdownloadbundleprogress-"
       }
     ],
     "properties": []
@@ -470,7 +453,7 @@
               "name": "example"
             }
           ],
-          "docs": "The unique identifier of the bundle.",
+          "docs": "The unique identifier of the bundle.\n\n**Attention**: The value `public` is reserved and cannot be used as a bundle identifier.",
           "complexTypes": [],
           "type": "string"
         },
@@ -478,15 +461,23 @@
           "name": "checksum",
           "tags": [
             {
-              "text": "6.1.0",
+              "text": "7.1.0",
               "name": "since"
-            },
+            }
+          ],
+          "docs": "The checksum of the self-hosted bundle as a SHA-256 hash\nin base64 format to verify the integrity of the bundle.\n\n**Attention**: Only supported for the `zip` artifact type.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "signature",
+          "tags": [
             {
-              "text": "The server should return a `X-Checksum` header instead.",
-              "name": "deprecated"
+              "text": "7.1.0",
+              "name": "since"
             }
           ],
-          "docs": "The checksum of the bundle to verify the integrity of the ZIP file.\n\nMust be a SHA-256 hash in base64 format.",
+          "docs": "The signature of the self-hosted bundle as a signed SHA-256 hash\nin base64 format to verify the integrity of the bundle.\n\n**Attention**: Only supported for the `zip` artifact type.",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -502,7 +493,7 @@
               "name": "example"
             }
           ],
-          "docs": "The URL of the bundle to download.\n\nFor the `zip` artifact type, the URL must point to a ZIP file.\nFor the `manifest` artifact type, the URL serves as the base URL\nto download the individual files. For example, if the URL is\n`https://example.com/download`, the plugin will download the file\nwith the href `index.html` from `https://example.com/download?href=index.html`.\n\nTo **verify the integrity** of the file, the server must return\na `X-Checksum` header with the SHA-256 hash in base64 format.\n\nTo **verify the signature** of the file, the server must return\na `X-Signature` header with the signed SHA-256 hash in base64 format.",
+          "docs": "The URL of the bundle to download.\n\nFor the `zip` artifact type, the URL must point to a ZIP file.\nFor the `manifest` artifact type, the URL serves as the base URL\nto download the individual files. For example, if the URL is\n`https://example.com/download`, the plugin will download the file\nwith the href `index.html` from `https://example.com/download?href=index.html`.\n\nTo **verify the integrity** of the file, the server should return\na `X-Checksum` header with the SHA-256 hash in base64 format.\n\nTo **verify the signature** of the file, the server should return\na `X-Signature` header with the signed SHA-256 hash in base64 format.",
           "complexTypes": [],
           "type": "string"
         }
@@ -544,6 +535,34 @@
           "complexTypes": [],
           "type": "string | null"
         },
+        {
+          "name": "checksum",
+          "tags": [
+            {
+              "text": "7.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The checksum of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the checksum will be\nreturned as response header when downloading the bundle.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "customProperties",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "{ \"key\": \"value\" }",
+              "name": "example"
+            }
+          ],
+          "docs": "Custom properties that are associated with the latest bundle.",
+          "complexTypes": [],
+          "type": "{ [key: string]: string; } | undefined"
+        },
         {
           "name": "downloadUrl",
           "tags": [
@@ -555,62 +574,44 @@
           "docs": "The URL of the latest bundle to download.\nPass this URL to the `downloadBundle(...)` method to download the bundle.",
           "complexTypes": [],
           "type": "string | undefined"
-        }
-      ]
-    },
-    {
-      "name": "FetchLatestBundleOptions",
-      "slug": "fetchlatestbundleoptions",
-      "docs": "",
-      "tags": [
-        {
-          "text": "6.7.0",
-          "name": "since"
-        }
-      ],
-      "methods": [],
-      "properties": [
+        },
         {
-          "name": "channel",
+          "name": "signature",
           "tags": [
             {
-              "text": "6.7.0",
+              "text": "7.1.0",
               "name": "since"
             }
           ],
-          "docs": "The name of the channel where the latest bundle is fetched from.",
+          "docs": "The signature of the latest bundle if the bundle is self-hosted.\n\nIf the bundle is hosted on Capawesome Cloud, the signature will be\nreturned as response header when downloading the bundle.",
           "complexTypes": [],
           "type": "string | undefined"
         }
       ]
     },
     {
-      "name": "GetBundleResult",
-      "slug": "getbundleresult",
+      "name": "FetchLatestBundleOptions",
+      "slug": "fetchlatestbundleoptions",
       "docs": "",
       "tags": [
         {
-          "text": "5.0.0",
+          "text": "6.7.0",
           "name": "since"
         }
       ],
       "methods": [],
       "properties": [
         {
-          "name": "bundleId",
+          "name": "channel",
           "tags": [
             {
-              "text": "5.0.0",
+              "text": "6.7.0",
               "name": "since"
-            },
-            {
-              "text": "'1.0.0'",
-              "name": "example"
             }
           ],
-          "docs": "The unique identifier of the active bundle.\n\nIf `null`, the default bundle is being used.",
+          "docs": "The name of the channel where the latest bundle is fetched from.",
           "complexTypes": [],
-          "type": "string | null"
+          "type": "string | undefined"
         }
       ]
     },
@@ -843,32 +844,52 @@
       ]
     },
     {
-      "name": "SetBundleOptions",
-      "slug": "setbundleoptions",
+      "name": "ReadyResult",
+      "slug": "readyresult",
       "docs": "",
       "tags": [
         {
-          "text": "5.0.0",
+          "text": "7.0.0",
           "name": "since"
         }
       ],
       "methods": [],
       "properties": [
         {
-          "name": "bundleId",
+          "name": "previousBundleId",
           "tags": [
             {
-              "text": "5.0.0",
+              "text": "7.0.0",
               "name": "since"
-            },
+            }
+          ],
+          "docs": "The identifier of the previous bundle used.\n\nIf `null`, the default bundle was used.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "currentBundleId",
+          "tags": [
             {
-              "text": "'1.0.0'",
-              "name": "example"
+              "text": "7.0.0",
+              "name": "since"
             }
           ],
-          "docs": "The unique identifier of the bundle to use.",
+          "docs": "The identifier of the current bundle used.\n\nIf `null`, the default bundle is being used.",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | null"
+        },
+        {
+          "name": "rollback",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether or not the app was reset to the default bundle.",
+          "complexTypes": [],
+          "type": "boolean"
         }
       ]
     },
@@ -1005,10 +1026,106 @@
           "type": "string | undefined"
         }
       ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "DownloadBundleProgressEvent",
+      "slug": "downloadbundleprogressevent",
+      "docs": "Event that is triggered when the download progress of a bundle changes.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the bundle that is being downloaded.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "downloadedBytes",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The number of bytes that have been downloaded.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "progress",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The progress of the download in percent as a value between `0` and `1`.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "totalBytes",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The total number of bytes to download.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
     }
   ],
   "enums": [],
-  "typeAliases": [],
+  "typeAliases": [
+    {
+      "name": "DownloadBundleProgressListener",
+      "slug": "downloadbundleprogresslistener",
+      "docs": "Listener for the download progress of a bundle.",
+      "types": [
+        {
+          "text": "(event: DownloadBundleProgressEvent): void",
+          "complexTypes": [
+            "DownloadBundleProgressEvent"
+          ]
+        }
+      ]
+    }
+  ],
   "pluginConfigs": [
     {
       "name": "LiveUpdate",
@@ -1062,22 +1179,6 @@
           "complexTypes": [],
           "type": "string | undefined"
         },
-        {
-          "name": "enabled",
-          "tags": [
-            {
-              "text": "5.0.0",
-              "name": "since"
-            },
-            {
-              "text": "true",
-              "name": "default"
-            }
-          ],
-          "docs": "Whether or not the plugin is enabled.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
-        },
         {
           "name": "httpTimeout",
           "tags": [
@@ -1094,30 +1195,6 @@
           "complexTypes": [],
           "type": "number | undefined"
         },
-        {
-          "name": "location",
-          "tags": [
-            {
-              "text": "6.2.0",
-              "name": "since"
-            },
-            {
-              "text": "'us'",
-              "name": "default"
-            },
-            {
-              "text": "'eu'",
-              "name": "example"
-            },
-            {
-              "text": "This option will be removed in the future.",
-              "name": "deprecated"
-            }
-          ],
-          "docs": "The location of the server to use when using [Capawesome Cloud](https://capawesome.io/cloud).",
-          "complexTypes": [],
-          "type": "'us' | 'eu' | undefined"
-        },
         {
           "name": "publicKey",
           "tags": [
@@ -1142,29 +1219,33 @@
               "name": "since"
             },
             {
-              "text": "10000",
+              "text": "0",
               "name": "default"
+            },
+            {
+              "text": "10000",
+              "name": "example"
             }
           ],
-          "docs": "The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.",
+          "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.",
           "complexTypes": [],
           "type": "number | undefined"
         },
         {
-          "name": "resetOnUpdate",
+          "name": "serverDomain",
           "tags": [
             {
-              "text": "5.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
-              "text": "true",
+              "text": "'api.cloud.capawesome.io'",
               "name": "default"
             }
           ],
-          "docs": "Whether or not the app should be reset to the default bundle during an update.",
+          "docs": "The API domain of the [Capawesome Cloud](https://cloud.capawesome.io) server.",
           "complexTypes": [],
-          "type": "boolean | undefined"
+          "type": "string | undefined"
         }
       ],
       "docs": ""