@calimero-network/mero-js 29.1.0 → 29.2.0

package/dist/index.cjs

@@ -2341,6 +2341,12 @@ var CalimeroClient = class _CalimeroClient {
    * Create an API key for an agent or server, approved with the account's
    * `passkey` (`412 CONFIRM_REQUIRED`); needs a passkey session (an API key
    * is refused `403`). The key is returned once.
+   *
+   * `upgrades: { app, package? }` makes an upgrade key, for CI: it upgrades
+   * that one app to signed releases of its package (default: the one the app
+   * runs, by that package's pinned signer) with {@link upgradeApp} and no
+   * passkey, and every other request with it is refused
+   * `403 UPGRADE_KEY_ONLY`. It takes no other scope field.
    */
   createApiKey(options, passkey) {
     return this.postConfirmed("auth/apikeys", { ...options }, passkey);
@@ -2480,6 +2486,8 @@ var CalimeroClient = class _CalimeroClient {
    * `passkey` gives. Refused (`403`) to a session opened on an app's
    * frontend: an app asks its user with {@link requestConsent} instead. Past
    * a release deadline its approver has not met: {@link ReleaseDeadlineError}.
+   * With an upgrade key ({@link createApiKey} `upgrades`) pass no passkey and
+   * a `version` of the key's package: the key's own proof stands in for it.
    */
   upgradeApp(app, target, passkey) {
     const path = `apps/${seg(app)}/upgrade`;