@pawabase/client 0.1.4 → 0.2.0

package/dist/esm/manage/lifecycle.js

@@ -1,5 +1,4 @@
 import { Service, seg } from "./base.js";
-const iso = (value) => (value instanceof Date ? value.toISOString() : value);
 /** The project's environments (`development`, `production`, previews…). Most calls here are not scoped to the client's environment. */
 export class Environments extends Service {
     list() {
@@ -35,9 +34,9 @@ export class Environments extends Service {
     deletePreview(preview) {
         return this.del(seg("previews", preview));
     }
-    /** Copy this environment's definitions (never secrets or keys) to `to`. `include` limits the kinds (`flows`, `policies`, `resources`…). */
+    /** Copy this environment's definitions (never secrets or keys) to `to`. `include` limits the kinds; `dryRun` only reports what would change. */
     promote(to, options = {}) {
-        return this.post("/promote", { to, include: options.include });
+        return this.post("/promote", { to, include: options.include, dry_run: options.dryRun ?? false });
     }
     /** Export definitions, roles and settings as a document another project can apply. */
     blueprint() {
@@ -52,56 +51,26 @@ export class Environments extends Service {
         return this.project("POST", "/code/reload");
     }
 }
-/** Feature branches of the definitions, immutable revisions, API versions and releases. */
-export class Releases extends Service {
-    branches() {
-        return this.get("/branches");
-    }
-    createBranch(name, options = {}) {
-        return this.post("/branches", { name, from_branch: options.fromBranch, from_revision: options.fromRevision, protected: options.protected ?? false });
-    }
-    /** The branch's definitions as they stand now. */
-    draft(branch) {
-        return this.get(seg("branches", branch, "draft"));
-    }
-    merge(branch, options = {}) {
-        return this.post(seg("branches", branch, "merge"), { target: options.target ?? "main", force: options.force ?? false });
-    }
-    revisions() {
-        return this.get("/revisions");
-    }
-    revision(revisionId) {
-        return this.get(seg("revisions", revisionId));
-    }
-    /** Freeze the branch's draft as a revision. */
-    commit(branch, message = "") {
-        return this.post(seg("branches", branch, "revisions"), { message });
-    }
-    apiVersions() {
-        return this.get("/api-versions");
-    }
-    createApiVersion(name, options = {}) {
-        return this.post("/api-versions", { name, is_default: options.isDefault ?? false });
-    }
-    /** `status`: draft, active, deprecated, sunset, disabled. */
-    updateApiVersion(name, changes) {
-        return this.patch(seg("api-versions", name), { status: changes.status, is_default: changes.isDefault, sunset_at: iso(changes.sunsetAt) });
-    }
-    rollbackApiVersion(name) {
-        return this.post(seg("api-versions", name, "rollback"));
-    }
-    releases() {
-        return this.get("/releases");
+/**
+ * API versions served side by side. `v1` is always the live API; releasing another environment's definitions as `v2` serves them at
+ * `/rest/v2` over this environment's tables, until you retire it.
+ */
+export class Versions extends Service {
+    /** The live API first, then every released version. */
+    list() {
+        return this.get("/versions");
     }
-    /** Make a revision the live definitions of an API version. */
-    release(revisionId, apiVersion, name, options = {}) {
-        return this.post("/releases", { revision_id: revisionId, api_version: apiVersion, name, notes: options.notes ?? "", allow_breaking: options.allowBreaking ?? false });
+    /** Whether `fromEnv`'s definitions can be served here as a version, and what would be added or left out. */
+    check(fromEnv) {
+        return this.post("/versions/check", { from_env: fromEnv });
     }
-    activate(releaseId) {
-        return this.post(seg("releases", releaseId, "activate"));
+    /** Serve `fromEnv`'s definitions as `/rest/<name>` (`v2`, `v3`…). A name is never reused. */
+    release(name, fromEnv, options = {}) {
+        return this.post("/versions", { name, from_env: fromEnv, notes: options.notes ?? "" });
     }
-    deployments() {
-        return this.get("/deployments");
+    /** Stop serving a version. */
+    retire(name) {
+        return this.post(seg("versions", name, "retire"));
     }
 }
 /** Whole-environment backups you download, stored snapshots, and restores. */

package/dist/esm/manage/lifecycle.js.map

@@ -1 +1 @@
-{"version":3,"file":"lifecycle.js","sourceRoot":"","sources":["../../../src/manage/lifecycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAuB,MAAM,WAAW,CAAC;AAG9D,MAAM,GAAG,GAAG,CAAC,KAAY,EAAsB,EAAE,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAExG,uIAAuI;AACvI,MAAM,OAAO,YAAa,SAAQ,OAAO;IACvC,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,0EAA0E;IAC1E,MAAM,CAAC,IAAY,EAAE,UAAiC,EAAE;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,IAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,kBAAkB,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,+FAA+F;IAC/F,MAAM,CAAC,IAAY,EAAE,OAA4E;QAC/F,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE;YAChE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,EAAE;SAC9G,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,4HAA4H;IAC5H,aAAa,CAAC,GAAW,EAAE,UAAkG,EAAE;QAC7H,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAC5B,GAAG;YACH,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,gBAAgB,EAAE,OAAO,CAAC,cAAc,IAAI,EAAE;YAC9C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;YAC1B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,OAAe;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,2IAA2I;IAC3I,OAAO,CAAC,EAAU,EAAE,UAAkC,EAAE;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,sFAAsF;IACtF,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,wEAAwE;IACxE,cAAc,CAAC,SAAe,EAAE,eAAyB,CAAC,aAAa,EAAE,YAAY,CAAC;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,8CAA8C;IAC9C,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC9C,CAAC;CACF;AAED,2FAA2F;AAC3F,MAAM,OAAO,QAAS,SAAQ,OAAO;IACnC,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,UAA+E,EAAE;QAC1G,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,aAAa,EAAE,OAAO,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC,CAAC;IACvJ,CAAC;IAED,kDAAkD;IAClD,KAAK,CAAC,MAAc;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,UAAgD,EAAE;QACtE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,KAAK,EAAE,CAAC,CAAC;IAC1H,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,QAAQ,CAAC,UAAkB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,+CAA+C;IAC/C,MAAM,CAAC,MAAc,EAAE,OAAO,GAAG,EAAE;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC;IAED,gBAAgB,CAAC,IAAY,EAAE,UAAmC,EAAE;QAClE,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,6DAA6D;IAC7D,gBAAgB,CAAC,IAAY,EAAE,OAAkE;QAC/F,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5I,CAAC;IAED,kBAAkB,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,8DAA8D;IAC9D,OAAO,CAAC,UAAkB,EAAE,UAAkB,EAAE,IAAY,EAAE,UAAuD,EAAE;QACrH,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,cAAc,EAAE,OAAO,CAAC,aAAa,IAAI,KAAK,EAAE,CAAC,CAAC;IACxK,CAAC;IAED,QAAQ,CAAC,SAAiB;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;CACF;AAYD,8EAA8E;AAC9E,MAAM,OAAO,OAAQ,SAAQ,OAAO;IAClC,gHAAgH;IAChH,QAAQ,CAAC,UAAoE,EAAE;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1I,CAAC;IAED,oCAAoC;IACpC,OAAO,CAAC,MAAY,EAAE,UAA0B,EAAE;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACxK,CAAC;IAED,iKAAiK;IACjK,WAAW,CAAC,UAAuK,EAAE;QACnL,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAClC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YAChC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,OAAO;YACvC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC;YACvB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,CAAC;YAC7B,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;YAChC,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;YACjC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,uCAAuC;IACvC,QAAQ,CAAC,IAAI,GAAG,EAAE,EAAE,UAAiD,EAAE;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,6DAA6D;IAC7D,cAAc,CAAC,UAAkB,EAAE,OAA2D;QAC5F,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB,CAAC,UAAkB;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,2CAA2C;IAC3C,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,6GAA6G;IAC7G,eAAe,CAAC,UAAkB,EAAE,UAAyD,EAAE;QAC7F,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE;YACxD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,OAAO;YACrC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,eAAe,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"lifecycle.js","sourceRoot":"","sources":["../../../src/manage/lifecycle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAuB,MAAM,WAAW,CAAC;AAE9D,uIAAuI;AACvI,MAAM,OAAO,YAAa,SAAQ,OAAO;IACvC,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,0EAA0E;IAC1E,MAAM,CAAC,IAAY,EAAE,UAAiC,EAAE;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,CAAC,IAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,kBAAkB,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,+FAA+F;IAC/F,MAAM,CAAC,IAAY,EAAE,OAA4E;QAC/F,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE;YAChE,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,EAAE;SAC9G,CAAC,CAAC;IACL,CAAC;IAED,iBAAiB,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,4HAA4H;IAC5H,aAAa,CAAC,GAAW,EAAE,UAAkG,EAAE;QAC7H,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAC5B,GAAG;YACH,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,gBAAgB,EAAE,OAAO,CAAC,cAAc,IAAI,EAAE;YAC9C,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE;YAC1B,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,OAAe;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,gJAAgJ;IAChJ,OAAO,CAAC,EAAU,EAAE,UAAoD,EAAE;QACxE,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;IACnG,CAAC;IAED,sFAAsF;IACtF,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,wEAAwE;IACxE,cAAc,CAAC,SAAe,EAAE,eAAyB,CAAC,aAAa,EAAE,YAAY,CAAC;QACpF,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,mBAAmB,EAAE,EAAE,IAAI,EAAE,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,8CAA8C;IAC9C,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC9C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,QAAS,SAAQ,OAAO;IACnC,uDAAuD;IACvD,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IAC5G,KAAK,CAAC,OAAe;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,6FAA6F;IAC7F,OAAO,CAAC,IAAY,EAAE,OAAe,EAAE,UAA8B,EAAE;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,8BAA8B;IAC9B,MAAM,CAAC,IAAY;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAYD,8EAA8E;AAC9E,MAAM,OAAO,OAAQ,SAAQ,OAAO;IAClC,gHAAgH;IAChH,QAAQ,CAAC,UAAoE,EAAE;QAC7E,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC1I,CAAC;IAED,oCAAoC;IACpC,OAAO,CAAC,MAAY,EAAE,UAA0B,EAAE;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACxK,CAAC;IAED,iKAAiK;IACjK,WAAW,CAAC,UAAuK,EAAE;QACnL,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE;YAClC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YAChC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,OAAO;YACvC,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC;YACvB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,CAAC;YAC7B,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;YAChC,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;YACjC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,uCAAuC;IACvC,QAAQ,CAAC,IAAI,GAAG,EAAE,EAAE,UAAiD,EAAE;QACrE,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED,6DAA6D;IAC7D,cAAc,CAAC,UAAkB,EAAE,OAA2D;QAC5F,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB,CAAC,UAAkB;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,2CAA2C;IAC3C,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,6GAA6G;IAC7G,eAAe,CAAC,UAAkB,EAAE,UAAyD,EAAE;QAC7F,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE;YACxD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,OAAO;YACrC,OAAO,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;YAChC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,eAAe,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/manage/mail.d.ts

@@ -1,9 +1,19 @@
-import { Definitions, Service, type Api } from "./base.js";
+import { Definitions, Service, type Api, type Body } from "./base.js";
 /** Templates (subject, HTML, text) for the mail flows and sign-in send. */
 export declare class MailTemplates extends Definitions {
     protected readonly kind = "mail-templates";
+    /** Rename a template, keeping its versions. */
+    rename(name: string, to: string): Promise<Api>;
 }
 export declare class Mail extends Service {
+    /** The brand kit the template editor uses: brand styles, palettes, reusable blocks and folders. */
+    kit(): Promise<Api>;
+    saveKit(kit: {
+        brand?: Body;
+        palettes?: Body[];
+        blocks?: Body[];
+        folders?: string[];
+    }): Promise<Api>;
     /** The delivery settings in effect (the password is never returned) and whether mail is being delivered. */
     config(): Promise<Api>;
     /** Messages sent or suppressed. `status`: `sent`, `failed`, `suppressed`. */

package/dist/esm/manage/mail.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mail.d.ts","sourceRoot":"","sources":["../../../src/manage/mail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AAE3D,2EAA2E;AAC3E,qBAAa,aAAc,SAAQ,WAAW;IAC5C,mBAA4B,IAAI,oBAAoB;CACrD;AAED,qBAAa,IAAK,SAAQ,OAAO;IAC/B,4GAA4G;IAC5G,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAItB,6EAA6E;IAC7E,GAAG,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGrC"}
+{"version":3,"file":"mail.d.ts","sourceRoot":"","sources":["../../../src/manage/mail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAE3E,2EAA2E;AAC3E,qBAAa,aAAc,SAAQ,WAAW;IAC5C,mBAA4B,IAAI,oBAAoB;IAEpD,+CAA+C;IAC/C,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAG/C;AAED,qBAAa,IAAK,SAAQ,OAAO;IAC/B,mGAAmG;IACnG,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAInB,OAAO,CAAC,GAAG,EAAE;QAAE,KAAK,CAAC,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpG,4GAA4G;IAC5G,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC;IAItB,6EAA6E;IAC7E,GAAG,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpE,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAGrC"}

package/dist/esm/manage/mail.js

@@ -1,9 +1,20 @@
-import { Definitions, Service } from "./base.js";
+import { Definitions, Service, seg } from "./base.js";
 /** Templates (subject, HTML, text) for the mail flows and sign-in send. */
 export class MailTemplates extends Definitions {
     kind = "mail-templates";
+    /** Rename a template, keeping its versions. */
+    rename(name, to) {
+        return this.post(seg(this.kind, name, "rename"), { to });
+    }
 }
 export class Mail extends Service {
+    /** The brand kit the template editor uses: brand styles, palettes, reusable blocks and folders. */
+    kit() {
+        return this.get("/mail/kit");
+    }
+    saveKit(kit) {
+        return this.put("/mail/kit", { brand: kit.brand ?? {}, palettes: kit.palettes ?? [], blocks: kit.blocks ?? [], folders: kit.folders ?? [] });
+    }
     /** The delivery settings in effect (the password is never returned) and whether mail is being delivered. */
     config() {
         return this.get("/mail/config");

package/dist/esm/manage/mail.js.map

@@ -1 +1 @@
-{"version":3,"file":"mail.js","sourceRoot":"","sources":["../../../src/manage/mail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAY,MAAM,WAAW,CAAC;AAE3D,2EAA2E;AAC3E,MAAM,OAAO,aAAc,SAAQ,WAAW;IAChB,IAAI,GAAG,gBAAgB,CAAC;CACrD;AAED,MAAM,OAAO,IAAK,SAAQ,OAAO;IAC/B,4GAA4G;IAC5G,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,6EAA6E;IAC7E,GAAG,CAAC,UAA+C,EAAE;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,QAAQ,CAAC,EAAY;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;CACF"}
+{"version":3,"file":"mail.js","sourceRoot":"","sources":["../../../src/manage/mail.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,EAAuB,MAAM,WAAW,CAAC;AAE3E,2EAA2E;AAC3E,MAAM,OAAO,aAAc,SAAQ,WAAW;IAChB,IAAI,GAAG,gBAAgB,CAAC;IAEpD,+CAA+C;IAC/C,MAAM,CAAC,IAAY,EAAE,EAAU;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,IAAK,SAAQ,OAAO;IAC/B,mGAAmG;IACnG,GAAG;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,CAAC,GAA6E;QACnF,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;IAC/I,CAAC;IAED,4GAA4G;IAC5G,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,6EAA6E;IAC7E,GAAG,CAAC,UAA+C,EAAE;QACnD,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,QAAQ,CAAC,EAAY;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;CACF"}

package/dist/esm/manage/observe.d.ts

@@ -61,10 +61,16 @@ export declare class Observability extends Service {
         period?: number;
         comparePrevious?: boolean;
     }): Promise<Api>;
+    /** The project's background workers (not scoped to one environment). */
     workers(): Promise<Api>;
     /** What the environment is running with. */
     configuration(): Promise<Api>;
+    /** What the project has used against what its plan allows (not scoped to one environment). */
     capacity(): Promise<Api>;
+    /** Bytes received and sent over the last `minutes`, and the endpoints, callers and requests that moved the most. */
+    bandwidth(options?: {
+        minutes?: number;
+    }): Promise<Api>;
 }
 export interface AlarmInput {
     name: string;

package/dist/esm/manage/observe.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observe.d.ts","sourceRoot":"","sources":["../../../src/manage/observe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AAEnD,KAAK,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAG1B,qBAAa,aAAc,SAAQ,OAAO;IACxC,+EAA+E;IAC/E,QAAQ,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,8EAA8E;IAC9E,SAAS,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,EAAE,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF,gGAAgG;IAChG,QAAQ,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAK/H,oFAAoF;IACpF,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC,yFAAyF;IACzF,IAAI,CAAC,OAAO,GAAE;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhG,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,6CAA6C;IAC7C,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAItF,oDAAoD;IACpD,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,iFAAiF;IACjF,OAAO,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzD,2BAA2B;IAC3B,OAAO,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE,6CAA6C;IAC7C,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B,uEAAuE;IACvE,YAAY,CAAC,MAAM,SAAa,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/H,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC;IAIvB,4CAA4C;IAC5C,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;CAGzB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,qHAAqH;AACrH,qBAAa,MAAO,SAAQ,OAAO;IACjC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC;IAevC,+GAA+G;IAC/G,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvE,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,uBAAuB;IACvB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpC,sCAAsC;IACtC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAInC,4DAA4D;IAC5D,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGxC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,gDAAgD;AAChD,qBAAa,UAAW,SAAQ,OAAO;IACrC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,SAAS,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,eAAe,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUvJ,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAIzB,yGAAyG;IACzG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUtI,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/G,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGjD;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,qEAAqE;AACrE,qBAAa,MAAO,SAAQ,OAAO;IACjC,oGAAoG;IACpG,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB,kDAAkD;IAClD,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAIrB,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B,6DAA6D;IAC7D,KAAK,CAAC,MAAM,GAAE,WAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7C,sGAAsG;IACtG,WAAW,CAAC,MAAM,GAAE,WAAW,GAAG;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtF"}
+{"version":3,"file":"observe.d.ts","sourceRoot":"","sources":["../../../src/manage/observe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAO,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AAEnD,KAAK,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAG1B,qBAAa,aAAc,SAAQ,OAAO;IACxC,+EAA+E;IAC/E,QAAQ,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,8EAA8E;IAC9E,SAAS,CAAC,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,EAAE,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIjF,gGAAgG;IAChG,QAAQ,CAAC,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAK/H,oFAAoF;IACpF,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxC,yFAAyF;IACzF,IAAI,CAAC,OAAO,GAAE;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,IAAI,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhG,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,6CAA6C;IAC7C,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAItF,oDAAoD;IACpD,MAAM,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,iFAAiF;IACjF,OAAO,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzD,2BAA2B;IAC3B,OAAO,CAAC,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxE,6CAA6C;IAC7C,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B,uEAAuE;IACvE,YAAY,CAAC,MAAM,SAAa,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/H,wEAAwE;IACxE,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC;IAIvB,4CAA4C;IAC5C,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B,8FAA8F;IAC9F,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB,oHAAoH;IACpH,SAAS,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;CAG5D;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,qHAAqH;AACrH,qBAAa,MAAO,SAAQ,OAAO;IACjC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC;IAevC,+GAA+G;IAC/G,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAIvE,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrC,uBAAuB;IACvB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIpC,sCAAsC;IACtC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAInC,4DAA4D;IAC5D,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGxC;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,gDAAgD;AAChD,qBAAa,UAAW,SAAQ,OAAO;IACrC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,SAAS,CAAC,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,eAAe,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUvJ,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC;IAIzB,yGAAyG;IACzG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUtI,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/G,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGjD;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,qEAAqE;AACrE,qBAAa,MAAO,SAAQ,OAAO;IACjC,oGAAoG;IACpG,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxB,kDAAkD;IAClD,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC;IAIrB,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7B,6DAA6D;IAC7D,KAAK,CAAC,MAAM,GAAE,WAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7C,sGAAsG;IACtG,WAAW,CAAC,MAAM,GAAE,WAAW,GAAG;QAAE,MAAM,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;KAAO,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtF"}

package/dist/esm/manage/observe.js

@@ -52,15 +52,21 @@ export class Observability extends Service {
     metricSeries(metric = "requests", options = {}) {
         return this.get("/metric-series", { metric, minutes: options.minutes ?? 60, period: options.period, compare: options.comparePrevious ? "previous" : undefined });
     }
+    /** The project's background workers (not scoped to one environment). */
     workers() {
-        return this.get("/workers");
+        return this.project("GET", "/workers");
     }
     /** What the environment is running with. */
     configuration() {
         return this.get("/configuration");
     }
+    /** What the project has used against what its plan allows (not scoped to one environment). */
     capacity() {
-        return this.get("/capacity");
+        return this.project("GET", "/capacity");
+    }
+    /** Bytes received and sent over the last `minutes`, and the endpoints, callers and requests that moved the most. */
+    bandwidth(options = {}) {
+        return this.get("/observability/bandwidth", options);
     }
 }
 /** Alarms on a metric: when it crosses `threshold` for `breachesNeeded` checks in a row, `recipients` are mailed. */

package/dist/esm/manage/observe.js.map

@@ -1 +1 @@
-{"version":3,"file":"observe.js","sourceRoot":"","sources":["../../../src/manage/observe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAY,MAAM,WAAW,CAAC;AAGnD,MAAM,GAAG,GAAG,CAAC,KAAY,EAAsB,EAAE,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAExG,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC,+EAA+E;IAC/E,QAAQ,CAAC,UAA8B,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,8EAA8E;IAC9E,SAAS,CAAC,UAAsD,EAAE;QAChE,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACxG,CAAC;IAED,gGAAgG;IAChG,QAAQ,CAAC,UAAqG,EAAE;QAC9G,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,oFAAoF;IACpF,OAAO,CAAC,SAAiB;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,yFAAyF;IACzF,IAAI,CAAC,UAA0E,EAAE;QAC/E,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClJ,CAAC;IAED,MAAM,CAAC,UAAgC,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,6CAA6C;IAC7C,MAAM,CAAC,UAA+D,EAAE;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,KAAa,EAAE,UAAgC,EAAE;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,oDAAoD;IACpD,MAAM,CAAC,UAAgC,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,iFAAiF;IACjF,OAAO,CAAC,UAAgC,EAAE;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,2BAA2B;IAC3B,OAAO,CAAC,UAA+C,EAAE;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,6CAA6C;IAC7C,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,uEAAuE;IACvE,YAAY,CAAC,MAAM,GAAG,UAAU,EAAE,UAA4E,EAAE;QAC9G,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IACnK,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IAED,4CAA4C;IAC5C,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;CACF;AAgBD,qHAAqH;AACrH,MAAM,OAAO,MAAO,SAAQ,OAAO;IACjC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,KAAiB;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YAC1B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,IAAI;YACpC,cAAc,EAAE,KAAK,CAAC,aAAa,IAAI,CAAC;YACxC,eAAe,EAAE,KAAK,CAAC,cAAc,IAAI,CAAC;YAC1C,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,EAAE;YAClC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;YACpC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,gBAAgB,EAAE,KAAK,CAAC,eAAe,IAAI,CAAC;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,+GAA+G;IAC/G,MAAM,CAAC,OAAe,EAAE,OAAgC;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,OAAe;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,uBAAuB;IACvB,KAAK,CAAC,OAAe;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,sCAAsC;IACtC,IAAI,CAAC,OAAe;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,4DAA4D;IAC5D,OAAO,CAAC,OAAgB;QACtB,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC1F,CAAC;CACF;AASD,gDAAgD;AAChD,MAAM,OAAO,UAAW,SAAQ,OAAO;IACrC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,SAAS,CAAC,UAA4H,EAAE;QACtI,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,QAAQ;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE;YACtC,WAAW,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,yGAAyG;IACzG,YAAY,CAAC,KAAa,EAAE,UAAyF,EAAE;QACrH,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC7B,KAAK;YACL,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,eAAe;YACzC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO;YACjC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC,CAAC;IACL,CAAC;IAED,cAAc,CAAC,UAAkB,EAAE,OAAe,EAAE,OAA4C;QAC9F,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACzH,CAAC;IAED,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,CAAC;CACF;AAWD,qEAAqE;AACrE,MAAM,OAAO,MAAO,SAAQ,OAAO;IACjC,oGAAoG;IACpG,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,kDAAkD;IAClD,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAChD,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,SAAsB,EAAE;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,sGAAsG;IACtG,WAAW,CAAC,SAAqD,EAAE;QACjE,OAAO,IAAI,CAAC,OAAO,CAAS,KAAK,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACrL,CAAC;CACF"}
+{"version":3,"file":"observe.js","sourceRoot":"","sources":["../../../src/manage/observe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAY,MAAM,WAAW,CAAC;AAGnD,MAAM,GAAG,GAAG,CAAC,KAAY,EAAsB,EAAE,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAExG,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC,+EAA+E;IAC/E,QAAQ,CAAC,UAA8B,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,8EAA8E;IAC9E,SAAS,CAAC,UAAsD,EAAE;QAChE,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACxG,CAAC;IAED,gGAAgG;IAChG,QAAQ,CAAC,UAAqG,EAAE;QAC9G,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,oFAAoF;IACpF,OAAO,CAAC,SAAiB;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,yFAAyF;IACzF,IAAI,CAAC,UAA0E,EAAE;QAC/E,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClJ,CAAC;IAED,MAAM,CAAC,UAAgC,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,6CAA6C;IAC7C,MAAM,CAAC,UAA+D,EAAE;QACtE,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,KAAa,EAAE,UAAgC,EAAE;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED,oDAAoD;IACpD,MAAM,CAAC,UAAgC,EAAE;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,iFAAiF;IACjF,OAAO,CAAC,UAAgC,EAAE;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,2BAA2B;IAC3B,OAAO,CAAC,UAA+C,EAAE;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,6CAA6C;IAC7C,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,uEAAuE;IACvE,YAAY,CAAC,MAAM,GAAG,UAAU,EAAE,UAA4E,EAAE;QAC9G,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IACnK,CAAC;IAED,wEAAwE;IACxE,OAAO;QACL,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,4CAA4C;IAC5C,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED,8FAA8F;IAC9F,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAC1C,CAAC;IAED,oHAAoH;IACpH,SAAS,CAAC,UAAgC,EAAE;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAgBD,qHAAqH;AACrH,MAAM,OAAO,MAAO,SAAQ,OAAO;IACjC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,KAAiB;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YAC1B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,IAAI;YACpC,cAAc,EAAE,KAAK,CAAC,aAAa,IAAI,CAAC;YACxC,eAAe,EAAE,KAAK,CAAC,cAAc,IAAI,CAAC;YAC1C,UAAU,EAAE,KAAK,CAAC,UAAU,IAAI,EAAE;YAClC,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;YACpC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;YAC9B,gBAAgB,EAAE,KAAK,CAAC,eAAe,IAAI,CAAC;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,+GAA+G;IAC/G,MAAM,CAAC,OAAe,EAAE,OAAgC;QACtD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,OAAe;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,uBAAuB;IACvB,KAAK,CAAC,OAAe;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,sCAAsC;IACtC,IAAI,CAAC,OAAe;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,4DAA4D;IAC5D,OAAO,CAAC,OAAgB;QACtB,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC1F,CAAC;CACF;AASD,gDAAgD;AAChD,MAAM,OAAO,UAAW,SAAQ,OAAO;IACrC,IAAI;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;IAED,SAAS,CAAC,UAA4H,EAAE;QACtI,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,QAAQ;YAChC,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,EAAE;YACtC,WAAW,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;YACrC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAChC,CAAC;IAED,yGAAyG;IACzG,YAAY,CAAC,KAAa,EAAE,UAAyF,EAAE;QACrH,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC7B,KAAK;YACL,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,eAAe;YACzC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,OAAO;YACjC,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,EAAE;SACrC,CAAC,CAAC;IACL,CAAC;IAED,cAAc,CAAC,UAAkB,EAAE,OAAe,EAAE,OAA4C;QAC9F,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACzH,CAAC;IAED,cAAc,CAAC,UAAkB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAChD,CAAC;CACF;AAWD,qEAAqE;AACrE,MAAM,OAAO,MAAO,SAAQ,OAAO;IACjC,oGAAoG;IACpG,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IAED,kDAAkD;IAClD,KAAK;QACH,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACjC,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAChD,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,SAAsB,EAAE;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,sGAAsG;IACtG,WAAW,CAAC,SAAqD,EAAE;QACjE,OAAO,IAAI,CAAC,OAAO,CAAS,KAAK,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;IACrL,CAAC;CACF"}

package/dist/esm/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.4";
+export declare const VERSION = "0.2.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/esm/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "0.1.4";
+export const VERSION = "0.2.0";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pawabase/client",
-  "version": "0.1.4",
-  "description": "Official TypeScript client for Pawabase: data, auth, storage, functions, flows and realtime.",
+  "version": "0.2.0",
+  "description": "Official TypeScript client for Pawabase: data, auth, storage, flows, agents and realtime.",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",

package/src/agents.ts

@@ -0,0 +1,184 @@
+/**
+ * Agents and knowledge bases, run from your app: the signed-in user's access rules decide which agents they may run and which
+ * knowledge bases they may search.
+ *
+ * ```ts
+ * const run = await pawabase.ai.agents.run("support", "How do I reset my password?");
+ * console.log(run.output);
+ * for await (const event of pawabase.ai.agents.stream("support", "Summarise my open tickets")) console.log(event);
+ * const hits = await pawabase.ai.knowledge.search("docs", "reset password");
+ * ```
+ */
+import { ApiError } from "./errors.js";
+import type { HttpClient } from "./http.js";
+
+export type AgentRunStatus = "running" | "waiting" | "finished" | "failed" | "cancelled" | (string & {});
+
+/** One run of an agent. A run that stopped to ask permission has `status: "waiting"` and lists what it is waiting on. */
+export interface AgentRun {
+  id: string;
+  agent: string;
+  status: AgentRunStatus;
+  /** The agent's answer, once it has one. */
+  output?: string;
+  thread?: string;
+  error?: string;
+  [field: string]: unknown;
+}
+
+/** One step of a streamed run (`type` says which: text pieces, tool calls and results, approvals, `error`). */
+export interface AgentEvent {
+  type: string;
+  [field: string]: unknown;
+}
+
+export interface AgentRunOptions {
+  /** Carry on a conversation: the `thread` of an earlier run. */
+  thread?: string;
+  /** Return at once; poll `get()` or start a flow from `agent.run.finished`. */
+  background?: boolean;
+  signal?: AbortSignal | null;
+}
+
+export interface KnowledgeHit {
+  [field: string]: unknown;
+}
+
+export interface KnowledgeDocument {
+  id: string;
+  status: "pending" | "ready" | "failed" | (string & {});
+  title?: string;
+  error?: string;
+  chunks?: number;
+}
+
+const seg = (...parts: string[]) => "/" + parts.map(encodeURIComponent).join("/");
+
+export class AgentsClient {
+  constructor(private readonly http: HttpClient) {}
+
+  /** The agents the caller may run. */
+  async list(): Promise<Array<{ name: string; description: string }>> {
+    const body = await this.http.request<{ data: Array<{ name: string; description: string }> }>({ path: "/ai/v1/agents" });
+    return body.data;
+  }
+
+  /** Send `input` and wait for the run (or, with `background`, only for it to start). */
+  run(name: string, input: string, options: AgentRunOptions = {}): Promise<AgentRun> {
+    return this.http.request<AgentRun>({
+      method: "POST",
+      path: `/ai/v1${seg("agents", name, "runs")}`,
+      body: { input, thread: options.thread, background: options.background ?? false },
+      signal: options.signal ?? undefined,
+    });
+  }
+
+  /** Each step of a run as it happens. */
+  async *stream(name: string, input: string, options: Omit<AgentRunOptions, "background"> = {}): AsyncGenerator<AgentEvent, void, void> {
+    const stream = await this.http.request<ReadableStream<Uint8Array> | null>({
+      method: "POST",
+      path: `/ai/v1${seg("agents", name, "runs")}`,
+      body: { input, thread: options.thread, stream: true },
+      parse: "stream",
+      signal: options.signal ?? undefined,
+    });
+    if (!stream) return;
+    const reader = stream.getReader();
+    const decoder = new TextDecoder();
+    let buffer = "";
+    try {
+      for (;;) {
+        const { value, done } = await reader.read();
+        if (done) break;
+        buffer += decoder.decode(value, { stream: true });
+        let end: number;
+        while ((end = buffer.indexOf("\n\n")) >= 0) {
+          const event = buffer.slice(0, end);
+          buffer = buffer.slice(end + 2);
+          for (const line of event.split("\n")) {
+            if (!line.startsWith("data:")) continue;
+            const data = line.slice(5).trim();
+            if (data === "[DONE]") return;
+            let parsed: AgentEvent;
+            try {
+              parsed = JSON.parse(data);
+            } catch {
+              continue;
+            }
+            if (parsed.type === "error") {
+              throw new ApiError({ status: 502, code: "agent_error", message: String(parsed.message ?? "the run stopped") });
+            }
+            yield parsed;
+          }
+        }
+      }
+    } finally {
+      reader.releaseLock();
+    }
+  }
+
+  /** A run of yours: its status and answer, and what it is waiting on if it stopped to ask. */
+  get(runId: string): Promise<AgentRun> {
+    return this.http.request<AgentRun>({ path: `/ai/v1${seg("agent-runs", runId)}` });
+  }
+
+  /** Approve or decline what a run is waiting on: a decision per call id, and `approve` for any not named. */
+  decide(runId: string, options: { decisions?: Record<string, boolean>; approve?: boolean; background?: boolean } = {}): Promise<AgentRun> {
+    return this.http.request<AgentRun>({
+      method: "POST",
+      path: `/ai/v1${seg("agent-runs", runId, "decide")}`,
+      body: { decisions: options.decisions ?? {}, approve: options.approve, background: options.background ?? false },
+    });
+  }
+
+  /** Poll a background run until it is no longer running (a waiting run is returned too, so you can decide it). */
+  async wait(runId: string, options: { intervalMs?: number; timeoutMs?: number; signal?: AbortSignal | null } = {}): Promise<AgentRun> {
+    const interval = options.intervalMs ?? 1000;
+    const deadline = Date.now() + (options.timeoutMs ?? 5 * 60_000);
+    for (;;) {
+      const run = await this.get(runId);
+      if (run.status !== "running") return run;
+      if (options.signal?.aborted) throw options.signal.reason ?? new Error("aborted");
+      if (Date.now() >= deadline) throw new Error(`run ${runId} was still running after ${options.timeoutMs ?? 5 * 60_000} ms`);
+      await new Promise((resolve) => setTimeout(resolve, interval));
+    }
+  }
+}
+
+export class KnowledgeClient {
+  constructor(private readonly http: HttpClient) {}
+
+  /** Search by meaning and by words together. Documents kept private to someone else are left out. */
+  async search(name: string, query: string, options: { limit?: number; signal?: AbortSignal | null } = {}): Promise<KnowledgeHit[]> {
+    const body = await this.http.request<{ data: KnowledgeHit[] }>({
+      method: "POST",
+      path: `/ai/v1${seg("knowledge", name, "search")}`,
+      body: { query, limit: options.limit ?? 5 },
+      signal: options.signal ?? undefined,
+    });
+    return body.data;
+  }
+
+  /** Add text, or a web page to read (`url`). A signed-in user's documents are found only by them. Adding the same `source` again replaces it. */
+  addDocument(name: string, input: { text?: string; url?: string; title?: string; source?: string }): Promise<KnowledgeDocument> {
+    return this.http.request<KnowledgeDocument>({
+      method: "POST",
+      path: `/ai/v1${seg("knowledge", name, "documents")}`,
+      body: { title: input.title ?? "", source: input.source ?? "", text: input.text, url: input.url },
+    });
+  }
+
+  /** Add a file (PDF, Word, HTML or text). */
+  addFile(name: string, file: Blob, options: { title?: string; source?: string; filename?: string } = {}): Promise<KnowledgeDocument> {
+    const form = new FormData();
+    form.append("file", file, options.filename ?? (file as File).name ?? "document");
+    if (options.title) form.append("title", options.title);
+    if (options.source) form.append("source", options.source);
+    return this.http.request<KnowledgeDocument>({ method: "POST", path: `/ai/v1${seg("knowledge", name, "documents")}`, body: form });
+  }
+
+  /** Whether a document is ready to search, and why not if it failed. */
+  document(name: string, documentId: string): Promise<KnowledgeDocument> {
+    return this.http.request<KnowledgeDocument>({ path: `/ai/v1${seg("knowledge", name, "documents", documentId)}` });
+  }
+}

package/src/ai.ts

@@ -10,6 +10,7 @@
  * Models are called by the name your environment gave them. Who may call each is the model's policy; servers (a secret key) always may.
  */
 import { ApiError } from "./errors.js";
+import { AgentsClient, KnowledgeClient } from "./agents.js";
 import type { HttpClient } from "./http.js";
 
 export interface ChatMessage {
@@ -70,7 +71,15 @@ function bodyOf(model: string, input: string | ChatMessage[], options: ChatOptio
 }
 
 export class AiClient {
-  constructor(private readonly http: HttpClient) {}
+  /** Agents the caller may run: `run`, `stream`, `get`, `decide`, `wait`. */
+  readonly agents: AgentsClient;
+  /** Knowledge bases the caller may search or add documents to. */
+  readonly knowledge: KnowledgeClient;
+
+  constructor(private readonly http: HttpClient) {
+    this.agents = new AgentsClient(http);
+    this.knowledge = new KnowledgeClient(http);
+  }
 
   /** The models the caller may use. */
   async models(): Promise<AiModelInfo[]> {

package/src/index.ts

@@ -2,6 +2,8 @@ export { PawabaseClient, createClient } from "./client.js";
 export type { ClientOptions, DatabaseShape } from "./client.js";
 
 export { AiClient } from "./ai.js";
+export { AgentsClient, KnowledgeClient } from "./agents.js";
+export type { AgentEvent, AgentRun, AgentRunOptions, AgentRunStatus, KnowledgeDocument, KnowledgeHit } from "./agents.js";
 export type { AiModelInfo, ChatCompletion, ChatMessage, ChatOptions } from "./ai.js";
 export { AuthClient } from "./auth.js";
 export type {

package/src/manage/access.ts

@@ -111,96 +111,3 @@ export interface FirewallRule {
   expiresAt?: When;
   note?: string;
 }
-
-/**
- * The firewall at the gateway: ordered rules (allow, block, log, rate limit), managed attack signatures, bans, and what it did.
- *
- * ```ts
- * await m.firewall.addRule({ name: "Burst", action: "rate_limit",
- *   conditions: [{ field: "path", op: "starts_with", value: "/auth/v1/token" }],
- *   rateLimit: { requests: 10, window_seconds: 60, by: "ip", ban_seconds: 900 } });
- * ```
- */
-export class Firewall extends Service {
-  /** Rules in the order they are tried. */
-  rules(): Promise<Api> {
-    return this.get("/firewall");
-  }
-
-  /** Add a rule at the end. */
-  addRule(rule: FirewallRule): Promise<Api> {
-    return this.post("/firewall", {
-      name: rule.name,
-      action: rule.action ?? "block",
-      conditions: rule.conditions ?? [],
-      logic: rule.logic ?? "all",
-      match: rule.match ?? {},
-      rate_limit: rule.rateLimit,
-      mode: rule.mode ?? "enforce",
-      enabled: rule.enabled ?? true,
-      expires_at: iso(rule.expiresAt),
-      note: rule.note ?? "",
-    });
-  }
-
-  /** Change some fields of a rule, using the server's field names (`clear_expiry: true` removes an expiry). */
-  updateRule(ruleId: string, changes: Body): Promise<Api> {
-    return this.patch(seg("firewall", ruleId), changes);
-  }
-
-  removeRule(ruleId: string): Promise<Api> {
-    return this.del(seg("firewall", ruleId));
-  }
-
-  /** Set the order rules are tried in: every rule exactly once. */
-  order(ruleIds: string[]): Promise<Api> {
-    return this.put("/firewall-order", { ids: ruleIds });
-  }
-
-  /** Managed rule sets (`sqli`, `xss`, `traversal`, `scanners`, `sensitive_files`, `no_user_agent`, `methods`) and automatic bans. */
-  config(): Promise<Api> {
-    return this.get("/firewall-config");
-  }
-
-  /** `managed`: `{ sqli: "block", scanners: "log" }` (`off`, `log`, `block`). `autoBan`: `{ enabled, threshold, window_seconds, ban_seconds, statuses, exempt }`. */
-  setConfig(options: { managed?: Record<string, string>; autoBan?: Body }): Promise<Api> {
-    return this.put("/firewall-config", { managed: options.managed, auto_ban: options.autoBan });
-  }
-
-  bans(options: { includeExpired?: boolean } = {}): Promise<Api> {
-    return this.get("/firewall-bans", { all: options.includeExpired ? 1 : undefined });
-  }
-
-  /** Ban an address or CIDR range for `seconds` (`0`: until lifted). */
-  ban(ip: string, options: { seconds?: number; reason?: string } = {}): Promise<Api> {
-    return this.post("/firewall-bans", { ip, seconds: options.seconds ?? 0, reason: options.reason ?? "" });
-  }
-
-  liftBan(banId: string): Promise<Api> {
-    return this.del(seg("firewall-bans", banId));
-  }
-
-  events(options: { action?: string; source?: string; ip?: string; path?: string; ruleId?: string; limit?: number } = {}): Promise<Api> {
-    const { ruleId, ...rest } = options;
-    return this.get("/firewall-events", { limit: 100, ...rest, rule_id: ruleId });
-  }
-
-  /** Totals, a timeline, and the top addresses, paths, rules and countries. */
-  stats(options: { hours?: number } = {}): Promise<Api> {
-    return this.get("/firewall-stats", { hours: options.hours ?? 24 });
-  }
-
-  /** What the firewall would do with a request, step by step. Nothing is sent or counted. */
-  test(ip: string, options: { path?: string; method?: string; userAgent?: string; query?: string; headers?: Record<string, string>; country?: string; role?: string } = {}): Promise<Api> {
-    return this.post("/firewall-test", {
-      ip,
-      path: options.path ?? "/",
-      method: options.method ?? "GET",
-      user_agent: options.userAgent ?? "",
-      query: options.query ?? "",
-      headers: options.headers ?? {},
-      country: options.country ?? "",
-      role: options.role ?? "none",
-    });
-  }
-}