@pawabase/client 0.0.0-stage → 0.1.3

package/dist/esm/manage/lifecycle.js

@@ -0,0 +1,161 @@
+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() {
+        return this.project("GET", "/envs");
+    }
+    /** A new environment, optionally with another's definitions copied in. */
+    create(name, options = {}) {
+        return this.project("POST", "/envs", { body: { name, copy_from: options.copyFrom } });
+    }
+    getOne(name) {
+        return this.project("GET", `/envs/${encodeURIComponent(name ?? this.environment)}`);
+    }
+    /** Change an environment's infrastructure, sign-in settings or settings; each is merged in. */
+    update(name, changes) {
+        return this.project("PATCH", `/envs/${encodeURIComponent(name)}`, {
+            body: { infra: changes.infra, auth: changes.auth, settings: changes.settings, is_default: changes.isDefault },
+        });
+    }
+    deleteEnvironment(name) {
+        return this.project("DELETE", `/envs/${encodeURIComponent(name)}`);
+    }
+    /** A short-lived copy for a branch or pull request (`ref`: lowercase letters, digits and hyphens); it expires by itself. */
+    createPreview(ref, options = {}) {
+        return this.post("/previews", {
+            ref,
+            name: options.name,
+            expires_in_hours: options.expiresInHours ?? 72,
+            infra: options.infra ?? {},
+            auth: options.auth ?? {},
+            settings: options.settings,
+        });
+    }
+    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`…). */
+    promote(to, options = {}) {
+        return this.post("/promote", { to, include: options.include });
+    }
+    /** Export definitions, roles and settings as a document another project can apply. */
+    blueprint() {
+        return this.get("/blueprint");
+    }
+    /** Build new environments from a blueprint; each must not exist yet. */
+    applyBlueprint(blueprint, environments = ["development", "production"]) {
+        return this.project("POST", "/blueprints/apply", { body: { blueprint, environments } });
+    }
+    /** Re-read the deployed function code now. */
+    reloadCode() {
+        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");
+    }
+    /** 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 });
+    }
+    activate(releaseId) {
+        return this.post(seg("releases", releaseId, "activate"));
+    }
+    deployments() {
+        return this.get("/deployments");
+    }
+}
+/** Whole-environment backups you download, stored snapshots, and restores. */
+export class Backups extends Service {
+    /** A backup document: `definitions`, `settings`, `users` and, with `data`, rows (up to `maxRows` per table). */
+    download(options = {}) {
+        return this.get("/backup", { include: options.include?.join(","), data: options.data ? "true" : undefined, max_rows: options.maxRows });
+    }
+    /** Put a downloaded backup back. */
+    restore(backup, options = {}) {
+        return this.post("/restore", { backup, include: options.include, strategy: options.strategy ?? "merge", dry_run: options.dryRun ?? false, confirm: options.confirm });
+    }
+    /** Automatic snapshots: `frequency` hourly, daily (at `hour` UTC) or weekly (on `weekday`, 0 = Monday); older ones are pruned past `keepLast` and `keepDays`. */
+    setSchedule(options = {}) {
+        return this.put("/backup-schedule", {
+            enabled: options.enabled ?? true,
+            frequency: options.frequency ?? "daily",
+            hour: options.hour ?? 3,
+            weekday: options.weekday ?? 0,
+            keep_last: options.keepLast ?? 7,
+            keep_days: options.keepDays ?? 30,
+            include: options.include ?? [],
+        });
+    }
+    snapshots() {
+        return this.get("/snapshots");
+    }
+    /** Take a snapshot now and keep it. */
+    snapshot(name = "", options = {}) {
+        return this.post("/snapshots", { name, note: options.note ?? "", include: options.include });
+    }
+    /** Rename it, annotate it, or pin it so pruning keeps it. */
+    updateSnapshot(snapshotId, changes) {
+        return this.patch(seg("snapshots", snapshotId), changes);
+    }
+    removeSnapshot(snapshotId) {
+        return this.del(seg("snapshots", snapshotId));
+    }
+    downloadSnapshot(snapshotId) {
+        return this.get(seg("snapshots", snapshotId, "download"));
+    }
+    /** Check the stored snapshot is intact. */
+    verifySnapshot(snapshotId) {
+        return this.post(seg("snapshots", snapshotId, "verify"));
+    }
+    /** Restore a snapshot; a snapshot of the current state is taken first unless `safetySnapshot` is `false`. */
+    restoreSnapshot(snapshotId, options = {}) {
+        return this.post(seg("snapshots", snapshotId, "restore"), {
+            include: options.include,
+            strategy: options.strategy ?? "merge",
+            dry_run: options.dryRun ?? false,
+            confirm: options.confirm,
+            safety_snapshot: options.safetySnapshot ?? true,
+        });
+    }
+}
+//# sourceMappingURL=lifecycle.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,16 @@
+import { Definitions, Service, type Api } from "./base.js";
+/** Templates (subject, HTML, text) for the mail flows, functions and sign-in send. */
+export declare class MailTemplates extends Definitions {
+    protected readonly kind = "mail-templates";
+}
+export declare class Mail extends Service {
+    /** 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`. */
+    log(options?: {
+        status?: string;
+        limit?: number;
+    }): Promise<Api>;
+    sendTest(to: string[]): Promise<Api>;
+}
+//# sourceMappingURL=mail.d.ts.map

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

@@ -0,0 +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,sFAAsF;AACtF,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"}

package/dist/esm/manage/mail.js

@@ -0,0 +1,19 @@
+import { Definitions, Service } from "./base.js";
+/** Templates (subject, HTML, text) for the mail flows, functions and sign-in send. */
+export class MailTemplates extends Definitions {
+    kind = "mail-templates";
+}
+export class Mail extends Service {
+    /** The delivery settings in effect (the password is never returned) and whether mail is being delivered. */
+    config() {
+        return this.get("/mail/config");
+    }
+    /** Messages sent or suppressed. `status`: `sent`, `failed`, `suppressed`. */
+    log(options = {}) {
+        return this.get("/mail/log", options);
+    }
+    sendTest(to) {
+        return this.post("/mail/test", { to });
+    }
+}
+//# sourceMappingURL=mail.js.map

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

@@ -0,0 +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,sFAAsF;AACtF,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"}

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

@@ -0,0 +1,149 @@
+import { Service, type Api } from "./base.js";
+type When = Date | string;
+export declare class Observability extends Service {
+    /** The environment at a glance: traffic, errors, latency, workers, storage. */
+    overview(options?: {
+        range?: string;
+    }): Promise<Api>;
+    /** Traffic over a `range` (`1h`, `24h`, `7d`…) or between `from` and `to`. */
+    analytics(options?: {
+        range?: string;
+        from?: When;
+        to?: When;
+    }): Promise<Api>;
+    /** Recent requests. `status` is an exact code or a class (`5xx`); `search` matches the path. */
+    requests(options?: {
+        status?: string;
+        method?: string;
+        search?: string;
+        requestId?: string;
+        limit?: number;
+    }): Promise<Api>;
+    /** One request: its logs, database calls, spans, and the traceback if it failed. */
+    request(requestId: string): Promise<Api>;
+    /** Search application and access logs. `after` continues from the last entry you saw. */
+    logs(options?: {
+        q?: string;
+        minutes?: number;
+        limit?: number;
+        after?: When;
+    }): Promise<Api>;
+    errors(options?: {
+        minutes?: number;
+    }): Promise<Api>;
+    /** Per-route traffic, latency and errors. */
+    routes(options?: {
+        minutes?: number;
+        limit?: number;
+        sort?: string;
+    }): Promise<Api>;
+    route(method: string, route: string, options?: {
+        minutes?: number;
+    }): Promise<Api>;
+    /** CPU, memory and connection figures over time. */
+    system(options?: {
+        minutes?: number;
+    }): Promise<Api>;
+    /** Findings the platform spotted: slow routes, missing indexes, noisy errors. */
+    advisor(options?: {
+        minutes?: number;
+    }): Promise<Api>;
+    /** Counters per minute. */
+    metrics(options?: {
+        name?: string;
+        minutes?: number;
+    }): Promise<Api>;
+    /** The metrics you can chart or alarm on. */
+    metricCatalog(): Promise<Api>;
+    /** One metric over time; `comparePrevious` adds the span before it. */
+    metricSeries(metric?: string, options?: {
+        minutes?: number;
+        period?: number;
+        comparePrevious?: boolean;
+    }): Promise<Api>;
+    workers(): Promise<Api>;
+    /** What the environment is running with. */
+    configuration(): Promise<Api>;
+    capacity(): Promise<Api>;
+}
+export interface AlarmInput {
+    name: string;
+    /** A name from {@link Observability.metricCatalog}. */
+    metric: string;
+    threshold: number;
+    comparison?: "gt" | "gte" | "lt" | "lte";
+    windowMinutes?: number;
+    breachesNeeded?: number;
+    recipients?: string[];
+    description?: string;
+    enabled?: boolean;
+    renotifyMinutes?: number;
+}
+/** Alarms on a metric: when it crosses `threshold` for `breachesNeeded` checks in a row, `recipients` are mailed. */
+export declare class Alarms extends Service {
+    list(): Promise<Api>;
+    create(alarm: AlarmInput): Promise<Api>;
+    /** Change some fields, using the server's names (`mute_minutes: 60` silences it for an hour, `0` un-mutes). */
+    update(alarmId: string, changes: Record<string, unknown>): Promise<Api>;
+    remove(alarmId: string): Promise<Api>;
+    /** Evaluate it now. */
+    check(alarmId: string): Promise<Api>;
+    /** Send the notification mail now. */
+    test(alarmId: string): Promise<Api>;
+    /** When alarms fired and recovered: one alarm's, or all. */
+    history(alarmId?: string): Promise<Api>;
+}
+export interface StatusComponent {
+    name: string;
+    /** `gateway`, `api`, `auth`, `realtime`, `workers` (measured) or `manual`. */
+    source?: string;
+    description?: string;
+}
+/** The public status page and its incidents. */
+export declare class StatusPage extends Service {
+    page(): Promise<Api>;
+    configure(options?: {
+        enabled?: boolean;
+        title?: string;
+        description?: string;
+        contactUrl?: string;
+        components?: StatusComponent[];
+    }): Promise<Api>;
+    incidents(): Promise<Api>;
+    /** `status`: investigating, identified, monitoring, resolved. `impact`: none, minor, major, critical. */
+    openIncident(title: string, options?: {
+        message?: string;
+        status?: string;
+        impact?: string;
+        components?: string[];
+    }): Promise<Api>;
+    updateIncident(incidentId: string, message: string, options: {
+        status: string;
+        impact?: string;
+    }): Promise<Api>;
+    removeIncident(incidentId: string): Promise<Api>;
+}
+export interface AuditFilter {
+    action?: string;
+    actor?: string;
+    target?: string;
+    since?: When;
+    until?: When;
+    env?: string;
+}
+/** Service health, plan usage and the platform's own audit trail. */
+export declare class Health extends Service {
+    /** Each service (database, cache, queue, storage, mail…) with its state, latency and error rate. */
+    services(): Promise<Api>;
+    /** Each plan limit and how much of it is used. */
+    usage(): Promise<Api>;
+    retryPolicies(): Promise<Api>;
+    /** Management-plane changes: who did what, to what, when. */
+    audit(filter?: AuditFilter): Promise<Api>;
+    /** The audit trail as a file's contents (`jsonl` or `csv`), for the same filters as {@link audit}. */
+    exportAudit(filter?: AuditFilter & {
+        format?: "jsonl" | "csv";
+    }): Promise<string>;
+}
+export {};
+//# sourceMappingURL=observe.d.ts.map

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

@@ -0,0 +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"}

package/dist/esm/manage/observe.js

@@ -0,0 +1,161 @@
+import { Service, seg } from "./base.js";
+const iso = (value) => (value instanceof Date ? value.toISOString() : value);
+export class Observability extends Service {
+    /** The environment at a glance: traffic, errors, latency, workers, storage. */
+    overview(options = {}) {
+        return this.get("/overview", options);
+    }
+    /** Traffic over a `range` (`1h`, `24h`, `7d`…) or between `from` and `to`. */
+    analytics(options = {}) {
+        return this.get("/analytics", { range: options.range, from: iso(options.from), to: iso(options.to) });
+    }
+    /** Recent requests. `status` is an exact code or a class (`5xx`); `search` matches the path. */
+    requests(options = {}) {
+        const { requestId, ...rest } = options;
+        return this.get("/requests", { ...rest, request_id: requestId });
+    }
+    /** One request: its logs, database calls, spans, and the traceback if it failed. */
+    request(requestId) {
+        return this.get(seg("requests", requestId));
+    }
+    /** Search application and access logs. `after` continues from the last entry you saw. */
+    logs(options = {}) {
+        return this.get("/logs", { q: options.q || undefined, minutes: options.minutes ?? 60, limit: options.limit ?? 200, after: iso(options.after) });
+    }
+    errors(options = {}) {
+        return this.get("/observability/errors", options);
+    }
+    /** Per-route traffic, latency and errors. */
+    routes(options = {}) {
+        return this.get("/observability/routes", options);
+    }
+    route(method, route, options = {}) {
+        return this.get("/observability/routes/detail", { method, route, ...options });
+    }
+    /** CPU, memory and connection figures over time. */
+    system(options = {}) {
+        return this.get("/observability/system", options);
+    }
+    /** Findings the platform spotted: slow routes, missing indexes, noisy errors. */
+    advisor(options = {}) {
+        return this.get("/advisor", options);
+    }
+    /** Counters per minute. */
+    metrics(options = {}) {
+        return this.get("/metrics", options);
+    }
+    /** The metrics you can chart or alarm on. */
+    metricCatalog() {
+        return this.get("/metric-catalog");
+    }
+    /** One metric over time; `comparePrevious` adds the span before it. */
+    metricSeries(metric = "requests", options = {}) {
+        return this.get("/metric-series", { metric, minutes: options.minutes ?? 60, period: options.period, compare: options.comparePrevious ? "previous" : undefined });
+    }
+    workers() {
+        return this.get("/workers");
+    }
+    /** What the environment is running with. */
+    configuration() {
+        return this.get("/configuration");
+    }
+    capacity() {
+        return this.get("/capacity");
+    }
+}
+/** Alarms on a metric: when it crosses `threshold` for `breachesNeeded` checks in a row, `recipients` are mailed. */
+export class Alarms extends Service {
+    list() {
+        return this.get("/alarms");
+    }
+    create(alarm) {
+        return this.post("/alarms", {
+            name: alarm.name,
+            metric: alarm.metric,
+            threshold: alarm.threshold,
+            comparison: alarm.comparison ?? "gt",
+            window_minutes: alarm.windowMinutes ?? 5,
+            breaches_needed: alarm.breachesNeeded ?? 1,
+            recipients: alarm.recipients ?? [],
+            description: alarm.description ?? "",
+            enabled: alarm.enabled ?? true,
+            renotify_minutes: alarm.renotifyMinutes ?? 0,
+        });
+    }
+    /** Change some fields, using the server's names (`mute_minutes: 60` silences it for an hour, `0` un-mutes). */
+    update(alarmId, changes) {
+        return this.patch(seg("alarms", alarmId), changes);
+    }
+    remove(alarmId) {
+        return this.del(seg("alarms", alarmId));
+    }
+    /** Evaluate it now. */
+    check(alarmId) {
+        return this.post(seg("alarms", alarmId, "check"));
+    }
+    /** Send the notification mail now. */
+    test(alarmId) {
+        return this.post(seg("alarms", alarmId, "test"));
+    }
+    /** When alarms fired and recovered: one alarm's, or all. */
+    history(alarmId) {
+        return alarmId ? this.get(seg("alarms", alarmId, "events")) : this.get("/alarm-events");
+    }
+}
+/** The public status page and its incidents. */
+export class StatusPage extends Service {
+    page() {
+        return this.get("/status-page");
+    }
+    configure(options = {}) {
+        return this.put("/status-page", {
+            enabled: options.enabled ?? true,
+            title: options.title ?? "Status",
+            description: options.description ?? "",
+            contact_url: options.contactUrl ?? "",
+            components: options.components ?? [],
+        });
+    }
+    incidents() {
+        return this.get("/incidents");
+    }
+    /** `status`: investigating, identified, monitoring, resolved. `impact`: none, minor, major, critical. */
+    openIncident(title, options = {}) {
+        return this.post("/incidents", {
+            title,
+            message: options.message ?? "",
+            status: options.status ?? "investigating",
+            impact: options.impact ?? "minor",
+            components: options.components ?? [],
+        });
+    }
+    updateIncident(incidentId, message, options) {
+        return this.post(seg("incidents", incidentId, "updates"), { status: options.status, message, impact: options.impact });
+    }
+    removeIncident(incidentId) {
+        return this.del(seg("incidents", incidentId));
+    }
+}
+/** Service health, plan usage and the platform's own audit trail. */
+export class Health extends Service {
+    /** Each service (database, cache, queue, storage, mail…) with its state, latency and error rate. */
+    services() {
+        return this.get("/service-health");
+    }
+    /** Each plan limit and how much of it is used. */
+    usage() {
+        return this.get("/plan-usage");
+    }
+    retryPolicies() {
+        return this.project("GET", "/retry-policies");
+    }
+    /** Management-plane changes: who did what, to what, when. */
+    audit(filter = {}) {
+        return this.project("GET", "/audit", { query: { ...filter, since: iso(filter.since), until: iso(filter.until) } });
+    }
+    /** The audit trail as a file's contents (`jsonl` or `csv`), for the same filters as {@link audit}. */
+    exportAudit(filter = {}) {
+        return this.project("GET", "/audit/export", { query: { ...filter, format: filter.format ?? "jsonl", since: iso(filter.since), until: iso(filter.until) }, parse: "text" });
+    }
+}
+//# sourceMappingURL=observe.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,52 @@
+import { type Api, Service } from "./base.js";
+export type ChannelKind = "public" | "private" | "presence" | "protected" | "ephemeral" | "durable";
+export interface ChannelRule {
+    kind?: ChannelKind;
+    /** The policy that decides who may subscribe. Default `authenticated`. */
+    subscribe?: string;
+    /** The policy that decides who may publish. Default `authenticated`. */
+    publish?: string;
+    presence?: boolean;
+    /** How many recent messages are kept (0 to 1000). */
+    history?: number;
+    /** A limit of `0` means none. */
+    messageSizeLimit?: number;
+    publishRateLimit?: number;
+    subscriptionLimit?: number;
+    retentionSeconds?: number;
+    description?: string;
+}
+/** Durable channel rules: a channel name pattern (`chat:*`), its kind, who may subscribe and publish, presence, history and limits. */
+export declare class RealtimeChannels extends Service {
+    list(): Promise<Api>;
+    /** Add a rule for channels matching `pattern`. */
+    create(pattern: string, rule?: ChannelRule): Promise<Api>;
+    update(channelId: string, changes: ChannelRule): Promise<Api>;
+    remove(channelId: string): Promise<Api>;
+}
+/** Dashboards: read-only boards over your data, defined as JSON, optionally published at a public address. */
+export declare class Dashboards extends Service {
+    list(): Promise<Api>;
+    /** One dashboard with its full definition. */
+    getOne(dashboardId: string): Promise<Api>;
+    /** Make a dashboard (`name`: lowercase letters, digits and dashes). The definition is checked; a problem comes back as a 422 with the list. */
+    create(name: string, options?: {
+        definition?: Record<string, unknown>;
+        title?: string;
+        description?: string;
+        enabled?: boolean;
+    }): Promise<Api>;
+    update(dashboardId: string, changes: {
+        title?: string;
+        description?: string;
+        definition?: Record<string, unknown>;
+        enabled?: boolean;
+    }): Promise<Api>;
+    remove(dashboardId: string): Promise<Api>;
+    /** Turn the public page on or off. Turning it on needs the environment's publishable key once (it is sealed and never returned). */
+    publish(dashboardId: string, options: {
+        public: boolean;
+        publishableKey?: string;
+    }): Promise<Api>;
+}
+//# sourceMappingURL=realtime.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"realtime.d.ts","sourceRoot":"","sources":["../../../src/manage/realtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,OAAO,EAAO,MAAM,WAAW,CAAC;AAEnD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC;AAEpG,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAkBD,uIAAuI;AACvI,qBAAa,gBAAiB,SAAQ,OAAO;IAC3C,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,kDAAkD;IAClD,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,WAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7D,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAI7D,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;CAGxC;AAED,8GAA8G;AAC9G,qBAAa,UAAW,SAAQ,OAAO;IACrC,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIpB,8CAA8C;IAC9C,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzC,+IAA+I;IAC/I,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUnJ,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrJ,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzC,oIAAoI;IACpI,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAMlG"}