@belvador/api 0.4.0 → 0.5.0

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { OPERATIONS, type OperationId, type OperationMeta, type OperationParams } from "./operations.gen.js";
-export declare const CLIENT_VERSION = "0.4.0";
+export declare const CLIENT_VERSION = "0.5.0";
 export declare const DEFAULT_BASE_URL = "https://api.belvador.dev";
 /** Personal (`blv_pat_`), service (`blv_svc_`) or OAuth access (`blv_oat_`) token. */
 export declare const TOKEN_PATTERN: RegExp;

package/dist/client.js

@@ -1,7 +1,7 @@
 import { BelvadorApiError, errorFrom } from "./errors.js";
 import { nodeErrorWord, nodeReadRequest, nodeRefusal, nodeWindowMissing, NODE_REFUSAL_STATUS, reshapeNodeAnswer, } from "./node-wire.gen.js";
 import { OPERATIONS } from "./operations.gen.js";
-export const CLIENT_VERSION = "0.4.0";
+export const CLIENT_VERSION = "0.5.0";
 export const DEFAULT_BASE_URL = "https://api.belvador.dev";
 /** Personal (`blv_pat_`), service (`blv_svc_`) or OAuth access (`blv_oat_`) token. */
 export const TOKEN_PATTERN = /^blv_(pat|svc|oat)_[A-Za-z0-9_-]{20,200}$/;

package/dist/operations.gen.d.ts

@@ -772,6 +772,56 @@ export declare const OPERATIONS: {
         readonly node: null;
         readonly defaults: {};
     };
+    readonly "metrics.names": {
+        readonly method: "GET";
+        readonly path: "/v1/metrics/names";
+        readonly pathParams: readonly [];
+        readonly scope: "metrics:read";
+        readonly kind: "node";
+        readonly sensitivity: "normal";
+        readonly idempotency: "none";
+        readonly ifMatch: false;
+        readonly paged: false;
+        readonly status: 200;
+        readonly node: {
+            readonly path: "q/metrics/names";
+        };
+        readonly defaults: {};
+    };
+    readonly "metrics.query": {
+        readonly method: "GET";
+        readonly path: "/v1/metrics/query";
+        readonly pathParams: readonly [];
+        readonly scope: "metrics:read";
+        readonly kind: "node";
+        readonly sensitivity: "normal";
+        readonly idempotency: "none";
+        readonly ifMatch: false;
+        readonly paged: false;
+        readonly status: 200;
+        readonly node: {
+            readonly path: "q/metrics/query";
+            readonly window: true;
+        };
+        readonly defaults: {};
+    };
+    readonly "metrics.series": {
+        readonly method: "GET";
+        readonly path: "/v1/metrics/series";
+        readonly pathParams: readonly [];
+        readonly scope: "metrics:read";
+        readonly kind: "node";
+        readonly sensitivity: "normal";
+        readonly idempotency: "none";
+        readonly ifMatch: false;
+        readonly paged: true;
+        readonly status: 200;
+        readonly node: {
+            readonly path: "q/metrics/series";
+            readonly list: "series";
+        };
+        readonly defaults: {};
+    };
     readonly "monitors.backtest": {
         readonly method: "POST";
         readonly path: "/v1/monitors/backtest";
@@ -1920,7 +1970,7 @@ export interface OperationParams {
         is_enabled: boolean;
         notify_all: boolean;
         destination_ids: Array<string>;
-        monitor_kinds?: Array<"missed" | "failed" | "timeout" | "unknown" | "count" | "assertion" | "deadline" | "stalled">;
+        monitor_kinds?: Array<"missed" | "failed" | "timeout" | "unknown" | "count" | "assertion" | "deadline" | "stalled" | "metric">;
         slo_severities?: Array<"page" | "ticket">;
         policy_id?: string | null;
     };
@@ -2067,7 +2117,7 @@ export interface OperationParams {
     "ingest_keys.create": {
         project_id: number;
         name: string;
-        scopes: Array<"traces" | "logs" | "errors" | "monitors">;
+        scopes: Array<"traces" | "logs" | "metrics" | "errors" | "monitors">;
         environments: Array<string>;
         expires_at: string | null;
     };
@@ -2278,6 +2328,32 @@ export interface OperationParams {
     "members.remove": {
         user_id: string;
     };
+    /** The metric catalog of one project (name, type, kind, unit, series count, last seen) and the node's series and name caps with the metrics it is dropping points for. */
+    "metrics.names": {
+        project: number;
+        environment?: string;
+        q?: string;
+    };
+    /** One metric aggregated per step (avg, sum, min, max, count, rate, p50–p99) in a window of at most 7 days, optionally grouped by up to two attributes (≤ 50 groups, ≤ 10,000 points), with exemplar trace ids. */
+    "metrics.query": {
+        project: number;
+        name: string;
+        aggregation: "avg" | "sum" | "min" | "max" | "count" | "rate" | "p50" | "p90" | "p95" | "p99";
+        start?: string;
+        end?: string;
+        step?: number;
+        attrs?: string;
+        group_by?: string;
+        environment?: string;
+    };
+    /** The time series of one metric (attributes, service, environment, first and last seen), 100 per page. */
+    "metrics.series": {
+        project?: number;
+        name?: string;
+        environment?: string;
+        attrs?: string;
+        cursor?: string;
+    };
     /** How often count/assertion settings would have alerted over the last 30 days of stored data (same rule as the live evaluator). */
     "monitors.backtest": {
         project: number;
@@ -2398,6 +2474,26 @@ export interface OperationParams {
             environments: Array<string>;
             severity: "critical" | "high" | "medium" | "low";
             recovery_threshold: number;
+        } | {
+            type: "metric";
+            metric_query: {
+                name: string;
+                aggregation: "avg" | "sum" | "min" | "max" | "count" | "rate" | "p50" | "p90" | "p95" | "p99";
+                filter: Array<{
+                    k: string;
+                    op: "=" | "!=" | "exists";
+                    v?: string;
+                }>;
+                group_by: Array<string>;
+            };
+            window_minutes: number;
+            comparator: "lt" | "gt" | "outside";
+            threshold: number;
+            threshold_high: number | null;
+            missing_data: "alert" | "keep" | "resolve" | "treat_as_zero";
+            environments: Array<string>;
+            severity: "critical" | "high" | "medium" | "low";
+            recovery_threshold: number;
         };
     }));
     /** Delete a monitor; `confirm_slug` must repeat its slug. */
@@ -2418,7 +2514,7 @@ export interface OperationParams {
         limit?: number;
         cursor?: string;
         project_id?: number;
-        type?: "job" | "count" | "assertion" | "deadline" | "progress";
+        type?: "job" | "count" | "assertion" | "deadline" | "progress" | "metric";
     };
     /** Occurrences of a deadline monitor (pending, on time, late, missed, failed, cancelled), newest due first. */
     "monitors.occurrences": {
@@ -2517,6 +2613,26 @@ export interface OperationParams {
             environments: Array<string>;
             severity: "critical" | "high" | "medium" | "low";
             recovery_threshold: number;
+        } | {
+            type: "metric";
+            metric_query: {
+                name: string;
+                aggregation: "avg" | "sum" | "min" | "max" | "count" | "rate" | "p50" | "p90" | "p95" | "p99";
+                filter: Array<{
+                    k: string;
+                    op: "=" | "!=" | "exists";
+                    v?: string;
+                }>;
+                group_by: Array<string>;
+            };
+            window_minutes: number;
+            comparator: "lt" | "gt" | "outside";
+            threshold: number;
+            threshold_high: number | null;
+            missing_data: "alert" | "keep" | "resolve" | "treat_as_zero";
+            environments: Array<string>;
+            severity: "critical" | "high" | "medium" | "low";
+            recovery_threshold: number;
         };
     }));
     /** Start a backup now (at most once per 10 minutes). */

package/dist/operations.gen.js

@@ -716,6 +716,48 @@ export const OPERATIONS = {
         node: null,
         defaults: {},
     },
+    "metrics.names": {
+        method: "GET",
+        path: "/v1/metrics/names",
+        pathParams: [],
+        scope: "metrics:read",
+        kind: "node",
+        sensitivity: "normal",
+        idempotency: "none",
+        ifMatch: false,
+        paged: false,
+        status: 200,
+        node: { path: "q/metrics/names" },
+        defaults: {},
+    },
+    "metrics.query": {
+        method: "GET",
+        path: "/v1/metrics/query",
+        pathParams: [],
+        scope: "metrics:read",
+        kind: "node",
+        sensitivity: "normal",
+        idempotency: "none",
+        ifMatch: false,
+        paged: false,
+        status: 200,
+        node: { path: "q/metrics/query", window: true },
+        defaults: {},
+    },
+    "metrics.series": {
+        method: "GET",
+        path: "/v1/metrics/series",
+        pathParams: [],
+        scope: "metrics:read",
+        kind: "node",
+        sensitivity: "normal",
+        idempotency: "none",
+        ifMatch: false,
+        paged: true,
+        status: 200,
+        node: { path: "q/metrics/series", list: "series" },
+        defaults: {},
+    },
     "monitors.backtest": {
         method: "POST",
         path: "/v1/monitors/backtest",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@belvador/api",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Typed client for the Belvador API (api.belvador.dev, OpenAPI 3.1): every operation by operationId, problem+json errors, retries, and node reads straight from the edge with short-lived tickets.",
   "license": "MIT",
   "author": "Belvador (https://belvador.dev)",