@capgo/capacitor-updater 8.46.3 → 8.47.1

package/dist/docs.json

@@ -226,6 +226,37 @@
         ],
         "slug": "set"
       },
+      {
+        "name": "startPreviewSession",
+        "signature": "(options?: StartPreviewSessionOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Optional preview session options.",
+            "type": "StartPreviewSessionOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Optional preview session options."
+          },
+          {
+            "name": "returns",
+            "text": "Resolves when preview session state is prepared."
+          },
+          {
+            "name": "since",
+            "text": "8.47.0"
+          }
+        ],
+        "docs": "Start a temporary preview/testing session.\n\nThis stores the currently active bundle as the pending fallback, enables the\nnative shake menu, and makes the next applied bundle show a native notice\nexplaining that shaking the device can reload or leave the preview.\nRequires {@link PluginsConfig.CapacitorUpdater.allowPreview} to be `true`.\nWhen `appId` is provided, the preview session temporarily uses that app id\nfor update checks until the user leaves the preview. Native updater stats are\nskipped while the preview session is active.\n\nUse this before calling {@link set} for Expo Go-style preview flows.",
+        "complexTypes": [
+          "StartPreviewSessionOptions"
+        ],
+        "slug": "startpreviewsession"
+      },
       {
         "name": "delete",
         "signature": "(options: BundleId) => Promise<void>",
@@ -523,6 +554,78 @@
         ],
         "slug": "getlatest"
       },
+      {
+        "name": "getMissingBundleFiles",
+        "signature": "(options: GetMissingBundleFilesOptions) => Promise<GetMissingBundleFilesResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "A {@link GetMissingBundleFilesOptions} object, or a {@link LatestVersion} response containing `manifest`.",
+            "type": "GetMissingBundleFilesOptions"
+          }
+        ],
+        "returns": "Promise<GetMissingBundleFilesResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options A {@link GetMissingBundleFilesOptions} object, or a {@link LatestVersion} response containing `manifest`."
+          },
+          {
+            "name": "returns",
+            "text": "The manifest entries that require network download."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If the manifest is missing or invalid."
+          },
+          {
+            "name": "since",
+            "text": "8.47.0"
+          }
+        ],
+        "docs": "Return the manifest entries that still need to be downloaded for a partial update.\n\nPass the result from {@link getLatest} directly when it includes a `manifest`.\nThe native plugin compares each manifest entry with the files already available\nin the builtin bundle and the local delta cache. Entries that can be reused are\nomitted from the returned `missing` list.\n\nFor encrypted manifests, pass the `sessionKey` returned by {@link getLatest} so\nencrypted file hashes can be checked against local files.\n\n```typescript\nconst latest = await CapacitorUpdater.getLatest();\nconst missing = await CapacitorUpdater.getMissingBundleFiles(latest);\n```",
+        "complexTypes": [
+          "GetMissingBundleFilesResult",
+          "GetMissingBundleFilesOptions"
+        ],
+        "slug": "getmissingbundlefiles"
+      },
+      {
+        "name": "getBundleDownloadSize",
+        "signature": "(options: GetBundleDownloadSizeOptions) => Promise<GetBundleDownloadSizeResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "A {@link GetBundleDownloadSizeOptions} object containing manifest entries.",
+            "type": "GetBundleDownloadSizeOptions"
+          }
+        ],
+        "returns": "Promise<GetBundleDownloadSizeResult>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options A {@link GetBundleDownloadSizeOptions} object containing manifest entries."
+          },
+          {
+            "name": "returns",
+            "text": "Known byte totals and per-file size results."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If the manifest is missing or invalid."
+          },
+          {
+            "name": "since",
+            "text": "8.47.0"
+          }
+        ],
+        "docs": "Estimate the download size for manifest entries before downloading them.\n\nThis method sends the provided manifest entries to the Capgo update endpoint\nonce and reads the stored manifest `file_size` metadata. It does not perform\nper-file `HEAD` requests from the app.\n\nUse this after {@link getMissingBundleFiles} to estimate only the files this\ndevice still needs:\n\n```typescript\nconst latest = await CapacitorUpdater.getLatest();\nconst missing = await CapacitorUpdater.getMissingBundleFiles(latest);\nconst size = await CapacitorUpdater.getBundleDownloadSize({\n  version: latest.version,\n  manifest: missing.missing,\n});\n```",
+        "complexTypes": [
+          "GetBundleDownloadSizeResult",
+          "GetBundleDownloadSizeOptions"
+        ],
+        "slug": "getbundledownloadsize"
+      },
       {
         "name": "setChannel",
         "signature": "(options: SetChannelOptions) => Promise<ChannelRes>",
@@ -1866,6 +1969,31 @@
         }
       ]
     },
+    {
+      "name": "StartPreviewSessionOptions",
+      "slug": "startpreviewsessionoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "App id to use while the preview session is active.\nThe previous app id is restored when leaving the preview session.\nRequires {@link PluginsConfig.CapacitorUpdater.allowPreview} to be `true`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
     {
       "name": "BundleListResult",
       "slug": "bundlelistresult",
@@ -2181,6 +2309,34 @@
           ],
           "type": "ManifestEntry[] | undefined"
         },
+        {
+          "name": "missing",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Missing manifest entries for this device when {@link GetLatestOptions.includeBundleSize}\nis enabled.",
+          "complexTypes": [
+            "GetMissingBundleFilesResult"
+          ],
+          "type": "GetMissingBundleFilesResult"
+        },
+        {
+          "name": "downloadSize",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Estimated download size for missing manifest entries when\n{@link GetLatestOptions.includeBundleSize} is enabled.",
+          "complexTypes": [
+            "GetBundleDownloadSizeResult"
+          ],
+          "type": "GetBundleDownloadSizeResult"
+        },
         {
           "name": "link",
           "tags": [
@@ -2207,6 +2363,193 @@
         }
       ]
     },
+    {
+      "name": "GetMissingBundleFilesResult",
+      "slug": "getmissingbundlefilesresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "missing",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Entries that are not available locally and need to be downloaded.",
+          "complexTypes": [
+            "ManifestEntry"
+          ],
+          "type": "ManifestEntry[]"
+        },
+        {
+          "name": "total",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Total entries in the provided manifest.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "missingCount",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Number of entries that need to be downloaded.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "reusableCount",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Number of entries that can be reused from builtin files or local cache.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "GetBundleDownloadSizeResult",
+      "slug": "getbundledownloadsizeresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "totalSize",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sum of all known file sizes in bytes.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "knownFiles",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Number of files with a known size.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "unknownFiles",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Number of files whose size could not be determined.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "files",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Per-file size results.",
+          "complexTypes": [
+            "BundleFileSize"
+          ],
+          "type": "BundleFileSize[]"
+        }
+      ]
+    },
+    {
+      "name": "BundleFileSize",
+      "slug": "bundlefilesize",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "file_name",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "File name from the manifest entry.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "file_hash",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "File hash from the manifest entry.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "download_url",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Download URL from the manifest entry.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "size",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Estimated bytes to download when the server exposes a size.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "error",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Error for this entry when the size could not be determined.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
     {
       "name": "GetLatestOptions",
       "slug": "getlatestoptions",
@@ -2229,6 +2572,120 @@
           "docs": "The channel to get the latest version for\nThe channel must allow 'self_assign' for this to work",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "Temporarily use another app id for this update check while using a trusted preview container.\nThis only changes the app id sent by this request; it does not persist a preview session.\nRequires {@link PluginsConfig.CapacitorUpdater.allowPreview} to be `true`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "includeBundleSize",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "When true, the native plugin computes which manifest files are missing on\nthis device and asks the Capgo update endpoint for their stored sizes before\nresolving {@link getLatest}.\n\nThis adds one backend request only when the update response contains a\nmanifest. It does not perform per-file network checks.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetMissingBundleFilesOptions",
+      "slug": "getmissingbundlefilesoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "manifest",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Manifest returned by {@link getLatest}. Passing the full {@link LatestVersion}\nresponse is supported because it contains this field.",
+          "complexTypes": [
+            "ManifestEntry"
+          ],
+          "type": "ManifestEntry[] | undefined"
+        },
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Target bundle version. Passing the full {@link LatestVersion} response is\nsupported because it contains this field.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "sessionKey",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Session key returned by {@link getLatest}, required only when file hashes are encrypted.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetBundleDownloadSizeOptions",
+      "slug": "getbundledownloadsizeoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "manifest",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Manifest entries to estimate. Pass `missing.missing` from {@link getMissingBundleFiles}\nto estimate only the bytes this device still needs to download.",
+          "complexTypes": [
+            "ManifestEntry"
+          ],
+          "type": "ManifestEntry[] | undefined"
+        },
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Target bundle version. Pass `latest.version` when estimating files returned\nby {@link getLatest}.",
+          "complexTypes": [],
+          "type": "string | undefined"
         }
       ]
     },
@@ -3940,6 +4397,22 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "allowPreview",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "8.47.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow JavaScript to start a native preview session and temporarily request updates for another app id.\nThis is intended for trusted container apps that implement Expo Go-style preview flows.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "persistCustomId",
           "tags": [