@capawesome/capacitor-live-update 6.5.0 → 6.7.0

package/dist/docs.json

@@ -51,6 +51,30 @@
         ],
         "slug": "downloadbundle"
       },
+      {
+        "name": "fetchLatestBundle",
+        "signature": "(options?: FetchLatestBundleOptions | undefined) => Promise<FetchLatestBundleResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "FetchLatestBundleOptions | undefined"
+          }
+        ],
+        "returns": "Promise<FetchLatestBundleResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.6.0"
+          }
+        ],
+        "docs": "Fetch the latest bundle using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "FetchLatestBundleResult",
+          "FetchLatestBundleOptions"
+        ],
+        "slug": "fetchlatestbundle"
+      },
       {
         "name": "getBundle",
         "signature": "() => Promise<GetBundleResult>",
@@ -60,6 +84,10 @@
           {
             "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.",
@@ -96,12 +124,29 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the channel of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the channel that is used for the update.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "GetChannelResult"
         ],
         "slug": "getchannel"
       },
+      {
+        "name": "getCurrentBundle",
+        "signature": "() => Promise<GetCurrentBundleResult>",
+        "parameters": [],
+        "returns": "Promise<GetCurrentBundleResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.7.0"
+          }
+        ],
+        "docs": "Get the bundle identifier of the current bundle.\nThe current bundle is the bundle that is currently used by the app.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetCurrentBundleResult"
+        ],
+        "slug": "getcurrentbundle"
+      },
       {
         "name": "getCustomId",
         "signature": "() => Promise<GetCustomIdResult>",
@@ -113,7 +158,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the custom identifier of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the custom identifier of the device.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "GetCustomIdResult"
         ],
@@ -130,12 +175,29 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Get the device identifier of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Get the unique device identifier.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "GetDeviceIdResult"
         ],
         "slug": "getdeviceid"
       },
+      {
+        "name": "getNextBundle",
+        "signature": "() => Promise<GetNextBundleResult>",
+        "parameters": [],
+        "returns": "Promise<GetNextBundleResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.7.0"
+          }
+        ],
+        "docs": "Get the bundle identifier of the next bundle.\nThe next bundle is the bundle that will be used after calling `reload()`\nor restarting the app.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetNextBundleResult"
+        ],
+        "slug": "getnextbundle"
+      },
       {
         "name": "getVersionCode",
         "signature": "() => Promise<GetVersionCodeResult>",
@@ -230,6 +292,10 @@
           {
             "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.",
@@ -255,7 +321,7 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Set the channel of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Set the channel to use for the update.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "SetChannelOptions"
         ],
@@ -278,16 +344,45 @@
             "text": "5.0.0"
           }
         ],
-        "docs": "Set the custom identifier of the app.\n\nOnly available on Android and iOS.",
+        "docs": "Set the custom identifier of the device.\n\nOnly available on Android and iOS.",
         "complexTypes": [
           "SetCustomIdOptions"
         ],
         "slug": "setcustomid"
       },
+      {
+        "name": "setNextBundle",
+        "signature": "(options: SetNextBundleOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetNextBundleOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.7.0"
+          }
+        ],
+        "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": [
+          "SetNextBundleOptions"
+        ],
+        "slug": "setnextbundle"
+      },
       {
         "name": "sync",
-        "signature": "() => Promise<SyncResult>",
-        "parameters": [],
+        "signature": "(options?: SyncOptions | undefined) => Promise<SyncResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SyncOptions | undefined"
+          }
+        ],
         "returns": "Promise<SyncResult>",
         "tags": [
           {
@@ -297,7 +392,8 @@
         ],
         "docs": "Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).\n\nCall `reload()` or restart the app to apply the changes.\n\nOnly available on Android and iOS.",
         "complexTypes": [
-          "SyncResult"
+          "SyncResult",
+          "SyncOptions"
         ],
         "slug": "sync"
       }
@@ -342,6 +438,26 @@
       "tags": [],
       "methods": [],
       "properties": [
+        {
+          "name": "artifactType",
+          "tags": [
+            {
+              "text": "6.6.0",
+              "name": "since"
+            },
+            {
+              "text": "'zip'",
+              "name": "default"
+            },
+            {
+              "text": "'manifest'",
+              "name": "example"
+            }
+          ],
+          "docs": "The artifact type of the bundle.",
+          "complexTypes": [],
+          "type": "'manifest' | 'zip' | undefined"
+        },
         {
           "name": "bundleId",
           "tags": [
@@ -366,11 +482,11 @@
               "name": "since"
             },
             {
-              "text": "'aab8e0a312e807c8eaeb923e2bdccd7731c5508869c62ad8e6e43ee881414c84'",
-              "name": "example"
+              "text": "The server should return a `X-Checksum` header instead.",
+              "name": "deprecated"
             }
           ],
-          "docs": "The checksum of the bundle to verify the integrity of the ZIP file.\n\nMust be a SHA-256 hash in hexadecimal format.",
+          "docs": "The checksum of the bundle to verify the integrity of the ZIP file.\n\nMust be a SHA-256 hash in base64 format.",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -386,12 +502,88 @@
               "name": "example"
             }
           ],
-          "docs": "The URL of the bundle to download.\n\nThe bundle must be a ZIP file containing at least a `index.html` file.",
+          "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.",
           "complexTypes": [],
           "type": "string"
         }
       ]
     },
+    {
+      "name": "FetchLatestBundleResult",
+      "slug": "fetchlatestbundleresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.6.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "artifactType",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The artifact type of the bundle.",
+          "complexTypes": [],
+          "type": "'manifest' | 'zip' | undefined"
+        },
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "6.6.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the latest bundle.\n\nIf `null`, no bundle is available.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "downloadUrl",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            }
+          ],
+          "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",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the channel where the latest bundle is fetched from.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
     {
       "name": "GetBundleResult",
       "slug": "getbundleresult",
@@ -472,7 +664,33 @@
               "name": "example"
             }
           ],
-          "docs": "The channel of the app.\n\nIf `null`, the app is using the default channel.",
+          "docs": "The channel name.\n\nIf `null`, the app is using the default channel.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "GetCurrentBundleResult",
+      "slug": "getcurrentbundleresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.7.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the current bundle.\n\nIf `null`, the default bundle is being used.",
           "complexTypes": [],
           "type": "string | null"
         }
@@ -502,7 +720,7 @@
               "name": "example"
             }
           ],
-          "docs": "The custom identifier of the app.\n\nIf `null`, no custom identifier is set.",
+          "docs": "The custom identifier of the device.\n\nIf `null`, no custom identifier is set.",
           "complexTypes": [],
           "type": "string | null"
         }
@@ -538,6 +756,32 @@
         }
       ]
     },
+    {
+      "name": "GetNextBundleResult",
+      "slug": "getnextbundleresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.7.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the next bundle.\n\nIf `null`, the default bundle is being used.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
     {
       "name": "GetVersionCodeResult",
       "slug": "getversioncoderesult",
@@ -648,7 +892,7 @@
               "name": "since"
             }
           ],
-          "docs": "The channel of the app.\n\nSet `null` to remove the channel.",
+          "docs": "The channel name.\n\nSet `null` to remove the channel.",
           "complexTypes": [],
           "type": "string | null"
         }
@@ -674,7 +918,37 @@
               "name": "since"
             }
           ],
-          "docs": "The custom identifier of the app.\n\nSet `null` to remove the custom identifier.",
+          "docs": "The custom identifier of the device.\n\nSet `null` to remove the custom identifier.",
+          "complexTypes": [],
+          "type": "string | null"
+        }
+      ]
+    },
+    {
+      "name": "SetNextBundleOptions",
+      "slug": "setnextbundleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.7.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "bundleId",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            },
+            {
+              "text": "'1.0.0'",
+              "name": "example"
+            }
+          ],
+          "docs": "The unique identifier of the bundle to use.\n\nSet `null` to use the default bundle (same as calling `reset()`).",
           "complexTypes": [],
           "type": "string | null"
         }
@@ -705,6 +979,32 @@
           "type": "string | null"
         }
       ]
+    },
+    {
+      "name": "SyncOptions",
+      "slug": "syncoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "6.7.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channel",
+          "tags": [
+            {
+              "text": "6.7.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the channel where the latest bundle is fetched from.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -810,8 +1110,8 @@
               "name": "example"
             },
             {
-              "text": "https ://capawesome.io/cloud/live-updates/advanced/privacy/",
-              "name": "see"
+              "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).",