@marinoscar/platform-contract 0.1.0-next.18 → 0.1.0-next.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +5 -0
- package/dist/cjs/alerts/constants.d.ts +195 -0
- package/dist/cjs/alerts/constants.d.ts.map +1 -0
- package/dist/cjs/alerts/constants.js +165 -0
- package/dist/cjs/alerts/constants.js.map +1 -0
- package/dist/cjs/alerts/enum.d.ts +5 -0
- package/dist/cjs/alerts/enum.d.ts.map +1 -0
- package/dist/cjs/alerts/enum.js +9 -0
- package/dist/cjs/alerts/enum.js.map +1 -0
- package/dist/cjs/alerts/index.d.ts +5 -0
- package/dist/cjs/alerts/index.d.ts.map +1 -0
- package/dist/cjs/alerts/index.js +68 -0
- package/dist/cjs/alerts/index.js.map +1 -0
- package/dist/cjs/alerts/schemas.d.ts +351 -0
- package/dist/cjs/alerts/schemas.d.ts.map +1 -0
- package/dist/cjs/alerts/schemas.js +432 -0
- package/dist/cjs/alerts/schemas.js.map +1 -0
- package/dist/cjs/nodes/admin-schemas.d.ts +85 -1
- package/dist/cjs/nodes/admin-schemas.d.ts.map +1 -1
- package/dist/cjs/nodes/admin-schemas.js +55 -1
- package/dist/cjs/nodes/admin-schemas.js.map +1 -1
- package/dist/cjs/nodes/constants.d.ts +12 -0
- package/dist/cjs/nodes/constants.d.ts.map +1 -1
- package/dist/cjs/nodes/constants.js +13 -1
- package/dist/cjs/nodes/constants.js.map +1 -1
- package/dist/cjs/nodes/index.d.ts +5 -5
- package/dist/cjs/nodes/index.d.ts.map +1 -1
- package/dist/cjs/nodes/index.js +14 -1
- package/dist/cjs/nodes/index.js.map +1 -1
- package/dist/cjs/nodes/schemas.d.ts +178 -0
- package/dist/cjs/nodes/schemas.d.ts.map +1 -1
- package/dist/cjs/nodes/schemas.js +149 -1
- package/dist/cjs/nodes/schemas.js.map +1 -1
- package/dist/cjs/settings/index.d.ts +1 -1
- package/dist/cjs/settings/index.d.ts.map +1 -1
- package/dist/cjs/settings/index.js +3 -2
- package/dist/cjs/settings/index.js.map +1 -1
- package/dist/cjs/settings/schemas.d.ts +11 -0
- package/dist/cjs/settings/schemas.d.ts.map +1 -1
- package/dist/cjs/settings/schemas.js +20 -0
- package/dist/cjs/settings/schemas.js.map +1 -1
- package/dist/cjs/telemetry/constants.d.ts.map +1 -1
- package/dist/cjs/telemetry/constants.js +6 -0
- package/dist/cjs/telemetry/constants.js.map +1 -1
- package/dist/cjs/telemetry/dashboard.d.ts +5 -5
- package/dist/cjs/telemetry/presentation.d.ts +5 -5
- package/dist/cjs/telemetry/stack.d.ts +2 -2
- package/dist/cjs/timezone/constants.d.ts +16 -0
- package/dist/cjs/timezone/constants.d.ts.map +1 -0
- package/dist/cjs/timezone/constants.js +19 -0
- package/dist/cjs/timezone/constants.js.map +1 -0
- package/dist/cjs/timezone/index.d.ts +15 -0
- package/dist/cjs/timezone/index.d.ts.map +1 -0
- package/dist/cjs/timezone/index.js +34 -0
- package/dist/cjs/timezone/index.js.map +1 -0
- package/dist/cjs/timezone/schemas.d.ts +111 -0
- package/dist/cjs/timezone/schemas.d.ts.map +1 -0
- package/dist/cjs/timezone/schemas.js +194 -0
- package/dist/cjs/timezone/schemas.js.map +1 -0
- package/dist/cjs/webhooks/constants.d.ts +154 -0
- package/dist/cjs/webhooks/constants.d.ts.map +1 -0
- package/dist/cjs/webhooks/constants.js +136 -0
- package/dist/cjs/webhooks/constants.js.map +1 -0
- package/dist/cjs/webhooks/enum.d.ts +5 -0
- package/dist/cjs/webhooks/enum.d.ts.map +1 -0
- package/dist/cjs/webhooks/enum.js +9 -0
- package/dist/cjs/webhooks/enum.js.map +1 -0
- package/dist/cjs/webhooks/index.d.ts +7 -0
- package/dist/cjs/webhooks/index.d.ts.map +1 -0
- package/dist/cjs/webhooks/index.js +48 -0
- package/dist/cjs/webhooks/index.js.map +1 -0
- package/dist/cjs/webhooks/schemas.d.ts +288 -0
- package/dist/cjs/webhooks/schemas.d.ts.map +1 -0
- package/dist/cjs/webhooks/schemas.js +295 -0
- package/dist/cjs/webhooks/schemas.js.map +1 -0
- package/dist/cjs/webhooks/signature.d.ts +54 -0
- package/dist/cjs/webhooks/signature.d.ts.map +1 -0
- package/dist/cjs/webhooks/signature.js +97 -0
- package/dist/cjs/webhooks/signature.js.map +1 -0
- package/dist/esm/alerts/constants.d.ts +195 -0
- package/dist/esm/alerts/constants.d.ts.map +1 -0
- package/dist/esm/alerts/constants.js +162 -0
- package/dist/esm/alerts/constants.js.map +1 -0
- package/dist/esm/alerts/enum.d.ts +5 -0
- package/dist/esm/alerts/enum.d.ts.map +1 -0
- package/dist/esm/alerts/enum.js +6 -0
- package/dist/esm/alerts/enum.js.map +1 -0
- package/dist/esm/alerts/index.d.ts +5 -0
- package/dist/esm/alerts/index.d.ts.map +1 -0
- package/dist/esm/alerts/index.js +8 -0
- package/dist/esm/alerts/index.js.map +1 -0
- package/dist/esm/alerts/schemas.d.ts +351 -0
- package/dist/esm/alerts/schemas.d.ts.map +1 -0
- package/dist/esm/alerts/schemas.js +429 -0
- package/dist/esm/alerts/schemas.js.map +1 -0
- package/dist/esm/nodes/admin-schemas.d.ts +85 -1
- package/dist/esm/nodes/admin-schemas.d.ts.map +1 -1
- package/dist/esm/nodes/admin-schemas.js +55 -1
- package/dist/esm/nodes/admin-schemas.js.map +1 -1
- package/dist/esm/nodes/constants.d.ts +12 -0
- package/dist/esm/nodes/constants.d.ts.map +1 -1
- package/dist/esm/nodes/constants.js +12 -0
- package/dist/esm/nodes/constants.js.map +1 -1
- package/dist/esm/nodes/index.d.ts +5 -5
- package/dist/esm/nodes/index.d.ts.map +1 -1
- package/dist/esm/nodes/index.js +3 -3
- package/dist/esm/nodes/index.js.map +1 -1
- package/dist/esm/nodes/schemas.d.ts +178 -0
- package/dist/esm/nodes/schemas.d.ts.map +1 -1
- package/dist/esm/nodes/schemas.js +149 -1
- package/dist/esm/nodes/schemas.js.map +1 -1
- package/dist/esm/settings/index.d.ts +1 -1
- package/dist/esm/settings/index.d.ts.map +1 -1
- package/dist/esm/settings/index.js +1 -1
- package/dist/esm/settings/index.js.map +1 -1
- package/dist/esm/settings/schemas.d.ts +11 -0
- package/dist/esm/settings/schemas.d.ts.map +1 -1
- package/dist/esm/settings/schemas.js +19 -0
- package/dist/esm/settings/schemas.js.map +1 -1
- package/dist/esm/telemetry/constants.d.ts.map +1 -1
- package/dist/esm/telemetry/constants.js +6 -0
- package/dist/esm/telemetry/constants.js.map +1 -1
- package/dist/esm/telemetry/dashboard.d.ts +5 -5
- package/dist/esm/telemetry/presentation.d.ts +5 -5
- package/dist/esm/telemetry/stack.d.ts +2 -2
- package/dist/esm/timezone/constants.d.ts +16 -0
- package/dist/esm/timezone/constants.d.ts.map +1 -0
- package/dist/esm/timezone/constants.js +16 -0
- package/dist/esm/timezone/constants.js.map +1 -0
- package/dist/esm/timezone/index.d.ts +15 -0
- package/dist/esm/timezone/index.d.ts.map +1 -0
- package/dist/esm/timezone/index.js +15 -0
- package/dist/esm/timezone/index.js.map +1 -0
- package/dist/esm/timezone/schemas.d.ts +111 -0
- package/dist/esm/timezone/schemas.d.ts.map +1 -0
- package/dist/esm/timezone/schemas.js +185 -0
- package/dist/esm/timezone/schemas.js.map +1 -0
- package/dist/esm/webhooks/constants.d.ts +154 -0
- package/dist/esm/webhooks/constants.d.ts.map +1 -0
- package/dist/esm/webhooks/constants.js +133 -0
- package/dist/esm/webhooks/constants.js.map +1 -0
- package/dist/esm/webhooks/enum.d.ts +5 -0
- package/dist/esm/webhooks/enum.d.ts.map +1 -0
- package/dist/esm/webhooks/enum.js +6 -0
- package/dist/esm/webhooks/enum.js.map +1 -0
- package/dist/esm/webhooks/index.d.ts +7 -0
- package/dist/esm/webhooks/index.d.ts.map +1 -0
- package/dist/esm/webhooks/index.js +8 -0
- package/dist/esm/webhooks/index.js.map +1 -0
- package/dist/esm/webhooks/schemas.d.ts +288 -0
- package/dist/esm/webhooks/schemas.d.ts.map +1 -0
- package/dist/esm/webhooks/schemas.js +292 -0
- package/dist/esm/webhooks/schemas.js.map +1 -0
- package/dist/esm/webhooks/signature.d.ts +54 -0
- package/dist/esm/webhooks/signature.d.ts.map +1 -0
- package/dist/esm/webhooks/signature.js +93 -0
- package/dist/esm/webhooks/signature.js.map +1 -0
- package/package.json +31 -1
|
@@ -0,0 +1,351 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/** One of `info`, `warning`, `critical`. @stability experimental */
|
|
3
|
+
export declare const alertSeveritySchema: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
4
|
+
/** One of `pending`, `firing`, `resolved`. @stability experimental */
|
|
5
|
+
export declare const alertIncidentStateSchema: z.ZodEnum<import("./constants.js").AlertEnumEntries<"pending" | "firing" | "resolved">>;
|
|
6
|
+
/** One comparator. @stability experimental */
|
|
7
|
+
export declare const alertComparatorSchema: z.ZodEnum<import("./constants.js").AlertEnumEntries<"gt" | "gte" | "lt" | "lte" | "eq" | "neq">>;
|
|
8
|
+
/** One aggregation. @stability experimental */
|
|
9
|
+
export declare const alertAggregationSchema: z.ZodEnum<import("./constants.js").AlertEnumEntries<"avg" | "max" | "min" | "sum" | "last" | "rate">>;
|
|
10
|
+
/** A rule kind id: an open vocabulary, lower snake case. @stability experimental */
|
|
11
|
+
export declare const alertKindIdSchema: z.ZodString;
|
|
12
|
+
/**
|
|
13
|
+
* One attribute filter of a `metric_threshold` rule.
|
|
14
|
+
*
|
|
15
|
+
* @stability experimental
|
|
16
|
+
*/
|
|
17
|
+
export declare const alertMetricFilterSchema: z.ZodObject<{
|
|
18
|
+
attr: z.ZodString;
|
|
19
|
+
op: z.ZodEnum<import("./constants.js").AlertEnumEntries<"eq" | "neq">>;
|
|
20
|
+
value: z.ZodString;
|
|
21
|
+
}, z.core.$strict>;
|
|
22
|
+
/**
|
|
23
|
+
* `metric_threshold`: an aggregate of one metric over a window compared to a
|
|
24
|
+
* threshold, per group. `metric` is the dotted metric name (`app.nodes.host.cpu.utilization`)
|
|
25
|
+
* or its table name; the API resolves it against the store's schema.
|
|
26
|
+
*
|
|
27
|
+
* @stability experimental
|
|
28
|
+
*/
|
|
29
|
+
export declare const metricThresholdConfigSchema: z.ZodObject<{
|
|
30
|
+
metric: z.ZodString;
|
|
31
|
+
aggregation: z.ZodEnum<import("./constants.js").AlertEnumEntries<"avg" | "max" | "min" | "sum" | "last" | "rate">>;
|
|
32
|
+
windowSeconds: z.ZodNumber;
|
|
33
|
+
comparator: z.ZodEnum<import("./constants.js").AlertEnumEntries<"gt" | "gte" | "lt" | "lte" | "eq" | "neq">>;
|
|
34
|
+
threshold: z.ZodNumber;
|
|
35
|
+
groupBy: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
36
|
+
filters: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
37
|
+
attr: z.ZodString;
|
|
38
|
+
op: z.ZodEnum<import("./constants.js").AlertEnumEntries<"eq" | "neq">>;
|
|
39
|
+
value: z.ZodString;
|
|
40
|
+
}, z.core.$strict>>>;
|
|
41
|
+
}, z.core.$strict>;
|
|
42
|
+
/** The parsed config of a `metric_threshold` rule. @stability experimental */
|
|
43
|
+
export type MetricThresholdConfig = z.infer<typeof metricThresholdConfigSchema>;
|
|
44
|
+
/**
|
|
45
|
+
* An attribute match of a `node_event` rule: every entry must equal the
|
|
46
|
+
* event's attribute (compared as text).
|
|
47
|
+
*
|
|
48
|
+
* @stability experimental
|
|
49
|
+
*/
|
|
50
|
+
export declare const alertEventAttrsSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
|
|
51
|
+
/**
|
|
52
|
+
* `node_event`: a worker node reported a matching event. `eventTypes` are node
|
|
53
|
+
* event types or a prefix such as `power.*`. The incident resolves when a
|
|
54
|
+
* `recovery` event arrives for the same node, or after `resolveAfterSeconds`.
|
|
55
|
+
*
|
|
56
|
+
* @stability experimental
|
|
57
|
+
*/
|
|
58
|
+
export declare const nodeEventConfigSchema: z.ZodObject<{
|
|
59
|
+
eventTypes: z.ZodArray<z.ZodString>;
|
|
60
|
+
minSeverity: z.ZodOptional<z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>>;
|
|
61
|
+
nodeIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
62
|
+
attrs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
|
|
63
|
+
recovery: z.ZodOptional<z.ZodObject<{
|
|
64
|
+
eventTypes: z.ZodArray<z.ZodString>;
|
|
65
|
+
attrs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>>;
|
|
66
|
+
}, z.core.$strict>>;
|
|
67
|
+
resolveAfterSeconds: z.ZodDefault<z.ZodNumber>;
|
|
68
|
+
}, z.core.$strict>;
|
|
69
|
+
/** The parsed config of a `node_event` rule. @stability experimental */
|
|
70
|
+
export type NodeEventConfig = z.infer<typeof nodeEventConfigSchema>;
|
|
71
|
+
/**
|
|
72
|
+
* `verdict`: the telemetry dashboard verdict is at or past `minLevel`.
|
|
73
|
+
*
|
|
74
|
+
* @stability experimental
|
|
75
|
+
*/
|
|
76
|
+
export declare const verdictConfigSchema: z.ZodObject<{
|
|
77
|
+
minLevel: z.ZodEnum<import("./constants.js").AlertEnumEntries<"critical" | "degraded">>;
|
|
78
|
+
}, z.core.$strict>;
|
|
79
|
+
/** The parsed config of a `verdict` rule. @stability experimental */
|
|
80
|
+
export type VerdictConfig = z.infer<typeof verdictConfigSchema>;
|
|
81
|
+
/**
|
|
82
|
+
* `node_offline` and `telemetry_unavailable` take no configuration.
|
|
83
|
+
*
|
|
84
|
+
* @stability experimental
|
|
85
|
+
*/
|
|
86
|
+
export declare const emptyAlertConfigSchema: z.ZodObject<{}, z.core.$strict>;
|
|
87
|
+
/**
|
|
88
|
+
* An alert rule as the API returns it.
|
|
89
|
+
*
|
|
90
|
+
* @stability experimental
|
|
91
|
+
*/
|
|
92
|
+
export declare const alertRuleSchema: z.ZodObject<{
|
|
93
|
+
id: z.ZodString;
|
|
94
|
+
key: z.ZodNullable<z.ZodString>;
|
|
95
|
+
starter: z.ZodBoolean;
|
|
96
|
+
name: z.ZodString;
|
|
97
|
+
description: z.ZodNullable<z.ZodString>;
|
|
98
|
+
enabled: z.ZodBoolean;
|
|
99
|
+
kind: z.ZodString;
|
|
100
|
+
severity: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
101
|
+
config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
102
|
+
forSeconds: z.ZodNumber;
|
|
103
|
+
cooldownSeconds: z.ZodNumber;
|
|
104
|
+
notifyChannels: z.ZodArray<z.ZodString>;
|
|
105
|
+
webhook: z.ZodBoolean;
|
|
106
|
+
createdById: z.ZodNullable<z.ZodString>;
|
|
107
|
+
createdAt: z.ZodString;
|
|
108
|
+
updatedAt: z.ZodString;
|
|
109
|
+
lastEvaluatedAt: z.ZodNullable<z.ZodString>;
|
|
110
|
+
lastError: z.ZodNullable<z.ZodString>;
|
|
111
|
+
openIncidents: z.ZodNumber;
|
|
112
|
+
}, z.core.$strip>;
|
|
113
|
+
/** One rule. @stability experimental */
|
|
114
|
+
export type AlertRule = z.infer<typeof alertRuleSchema>;
|
|
115
|
+
/**
|
|
116
|
+
* `POST /api/admin/alerts/rules` body. `config` is validated against the
|
|
117
|
+
* kind's schema; a rule is created disabled unless `enabled` says otherwise.
|
|
118
|
+
*
|
|
119
|
+
* @stability experimental
|
|
120
|
+
*/
|
|
121
|
+
export declare const createAlertRuleSchema: z.ZodObject<{
|
|
122
|
+
name: z.ZodString;
|
|
123
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
124
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
125
|
+
kind: z.ZodString;
|
|
126
|
+
severity: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
127
|
+
config: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
128
|
+
forSeconds: z.ZodDefault<z.ZodNumber>;
|
|
129
|
+
cooldownSeconds: z.ZodDefault<z.ZodNumber>;
|
|
130
|
+
notifyChannels: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
131
|
+
webhook: z.ZodDefault<z.ZodBoolean>;
|
|
132
|
+
}, z.core.$strip>;
|
|
133
|
+
/** The parsed create body. @stability experimental */
|
|
134
|
+
export type CreateAlertRule = z.infer<typeof createAlertRuleSchema>;
|
|
135
|
+
/**
|
|
136
|
+
* `PATCH /api/admin/alerts/rules/:id` body. The kind cannot change; a new
|
|
137
|
+
* `config` is validated against the rule's kind.
|
|
138
|
+
*
|
|
139
|
+
* @stability experimental
|
|
140
|
+
*/
|
|
141
|
+
export declare const updateAlertRuleSchema: z.ZodObject<{
|
|
142
|
+
name: z.ZodOptional<z.ZodString>;
|
|
143
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
144
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
145
|
+
severity: z.ZodOptional<z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>>;
|
|
146
|
+
config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
147
|
+
forSeconds: z.ZodOptional<z.ZodNumber>;
|
|
148
|
+
cooldownSeconds: z.ZodOptional<z.ZodNumber>;
|
|
149
|
+
notifyChannels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
150
|
+
webhook: z.ZodOptional<z.ZodBoolean>;
|
|
151
|
+
}, z.core.$strict>;
|
|
152
|
+
/** The parsed update body. @stability experimental */
|
|
153
|
+
export type UpdateAlertRule = z.infer<typeof updateAlertRuleSchema>;
|
|
154
|
+
/** A rule key, for a seeded starter rule. @stability experimental */
|
|
155
|
+
export declare const alertRuleKeySchema: z.ZodString;
|
|
156
|
+
/**
|
|
157
|
+
* `GET /api/admin/alerts/rules` query.
|
|
158
|
+
*
|
|
159
|
+
* @stability experimental
|
|
160
|
+
*/
|
|
161
|
+
export declare const alertRuleListQuerySchema: z.ZodObject<{
|
|
162
|
+
kind: z.ZodOptional<z.ZodString>;
|
|
163
|
+
severity: z.ZodOptional<z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>>;
|
|
164
|
+
enabled: z.ZodOptional<z.ZodPipe<z.ZodEnum<import("./constants.js").AlertEnumEntries<"true" | "false">>, z.ZodTransform<boolean, "true" | "false">>>;
|
|
165
|
+
}, z.core.$strip>;
|
|
166
|
+
/** The parsed rule list query. @stability experimental */
|
|
167
|
+
export type AlertRuleListQuery = z.output<typeof alertRuleListQuerySchema>;
|
|
168
|
+
/** `GET /api/admin/alerts/rules` response data. @stability experimental */
|
|
169
|
+
export declare const alertRuleListSchema: z.ZodArray<z.ZodObject<{
|
|
170
|
+
id: z.ZodString;
|
|
171
|
+
key: z.ZodNullable<z.ZodString>;
|
|
172
|
+
starter: z.ZodBoolean;
|
|
173
|
+
name: z.ZodString;
|
|
174
|
+
description: z.ZodNullable<z.ZodString>;
|
|
175
|
+
enabled: z.ZodBoolean;
|
|
176
|
+
kind: z.ZodString;
|
|
177
|
+
severity: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
178
|
+
config: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
179
|
+
forSeconds: z.ZodNumber;
|
|
180
|
+
cooldownSeconds: z.ZodNumber;
|
|
181
|
+
notifyChannels: z.ZodArray<z.ZodString>;
|
|
182
|
+
webhook: z.ZodBoolean;
|
|
183
|
+
createdById: z.ZodNullable<z.ZodString>;
|
|
184
|
+
createdAt: z.ZodString;
|
|
185
|
+
updatedAt: z.ZodString;
|
|
186
|
+
lastEvaluatedAt: z.ZodNullable<z.ZodString>;
|
|
187
|
+
lastError: z.ZodNullable<z.ZodString>;
|
|
188
|
+
openIncidents: z.ZodNumber;
|
|
189
|
+
}, z.core.$strip>>;
|
|
190
|
+
/**
|
|
191
|
+
* One incident: one rule breached for one label set.
|
|
192
|
+
*
|
|
193
|
+
* @stability experimental
|
|
194
|
+
*/
|
|
195
|
+
export declare const alertIncidentSchema: z.ZodObject<{
|
|
196
|
+
id: z.ZodString;
|
|
197
|
+
ruleId: z.ZodString;
|
|
198
|
+
ruleName: z.ZodString;
|
|
199
|
+
ruleKind: z.ZodString;
|
|
200
|
+
labels: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
201
|
+
state: z.ZodEnum<import("./constants.js").AlertEnumEntries<"pending" | "firing" | "resolved">>;
|
|
202
|
+
severity: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
203
|
+
pendingSince: z.ZodNullable<z.ZodString>;
|
|
204
|
+
firedAt: z.ZodNullable<z.ZodString>;
|
|
205
|
+
resolvedAt: z.ZodNullable<z.ZodString>;
|
|
206
|
+
lastValue: z.ZodNullable<z.ZodNumber>;
|
|
207
|
+
lastSeenAt: z.ZodString;
|
|
208
|
+
summary: z.ZodString;
|
|
209
|
+
acknowledgedAt: z.ZodNullable<z.ZodString>;
|
|
210
|
+
acknowledgedById: z.ZodNullable<z.ZodString>;
|
|
211
|
+
createdAt: z.ZodString;
|
|
212
|
+
}, z.core.$strip>;
|
|
213
|
+
/** One incident. @stability experimental */
|
|
214
|
+
export type AlertIncident = z.infer<typeof alertIncidentSchema>;
|
|
215
|
+
/**
|
|
216
|
+
* `GET /api/admin/alerts/incidents` query.
|
|
217
|
+
*
|
|
218
|
+
* @stability experimental
|
|
219
|
+
*/
|
|
220
|
+
export declare const alertIncidentListQuerySchema: z.ZodObject<{
|
|
221
|
+
state: z.ZodOptional<z.ZodEnum<import("./constants.js").AlertEnumEntries<"pending" | "firing" | "resolved">>>;
|
|
222
|
+
severity: z.ZodOptional<z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>>;
|
|
223
|
+
ruleId: z.ZodOptional<z.ZodUUID>;
|
|
224
|
+
page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
225
|
+
pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
226
|
+
}, z.core.$strip>;
|
|
227
|
+
/** The parsed incident list query. @stability experimental */
|
|
228
|
+
export type AlertIncidentListQuery = z.output<typeof alertIncidentListQuerySchema>;
|
|
229
|
+
/** `GET /api/admin/alerts/incidents` response data. @stability experimental */
|
|
230
|
+
export declare const alertIncidentListSchema: z.ZodObject<{
|
|
231
|
+
items: z.ZodArray<z.ZodObject<{
|
|
232
|
+
id: z.ZodString;
|
|
233
|
+
ruleId: z.ZodString;
|
|
234
|
+
ruleName: z.ZodString;
|
|
235
|
+
ruleKind: z.ZodString;
|
|
236
|
+
labels: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
237
|
+
state: z.ZodEnum<import("./constants.js").AlertEnumEntries<"pending" | "firing" | "resolved">>;
|
|
238
|
+
severity: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
239
|
+
pendingSince: z.ZodNullable<z.ZodString>;
|
|
240
|
+
firedAt: z.ZodNullable<z.ZodString>;
|
|
241
|
+
resolvedAt: z.ZodNullable<z.ZodString>;
|
|
242
|
+
lastValue: z.ZodNullable<z.ZodNumber>;
|
|
243
|
+
lastSeenAt: z.ZodString;
|
|
244
|
+
summary: z.ZodString;
|
|
245
|
+
acknowledgedAt: z.ZodNullable<z.ZodString>;
|
|
246
|
+
acknowledgedById: z.ZodNullable<z.ZodString>;
|
|
247
|
+
createdAt: z.ZodString;
|
|
248
|
+
}, z.core.$strip>>;
|
|
249
|
+
total: z.ZodNumber;
|
|
250
|
+
page: z.ZodNumber;
|
|
251
|
+
pageSize: z.ZodNumber;
|
|
252
|
+
totalPages: z.ZodNumber;
|
|
253
|
+
}, z.core.$strip>;
|
|
254
|
+
/**
|
|
255
|
+
* One observation a kind produced: a label set, its value and whether it
|
|
256
|
+
* breaches the rule.
|
|
257
|
+
*
|
|
258
|
+
* @stability experimental
|
|
259
|
+
*/
|
|
260
|
+
export declare const alertObservationSchema: z.ZodObject<{
|
|
261
|
+
labels: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
262
|
+
value: z.ZodNullable<z.ZodNumber>;
|
|
263
|
+
breached: z.ZodBoolean;
|
|
264
|
+
summary: z.ZodString;
|
|
265
|
+
}, z.core.$strip>;
|
|
266
|
+
/** One observation. @stability experimental */
|
|
267
|
+
export type AlertObservation = z.infer<typeof alertObservationSchema>;
|
|
268
|
+
/**
|
|
269
|
+
* `POST /api/admin/alerts/rules/:id/test` response: the rule evaluated now.
|
|
270
|
+
* Nothing is stored and nothing is dispatched.
|
|
271
|
+
*
|
|
272
|
+
* @stability experimental
|
|
273
|
+
*/
|
|
274
|
+
export declare const alertRuleTestResponseSchema: z.ZodObject<{
|
|
275
|
+
ruleId: z.ZodString;
|
|
276
|
+
kind: z.ZodString;
|
|
277
|
+
evaluatedAt: z.ZodString;
|
|
278
|
+
durationMs: z.ZodNumber;
|
|
279
|
+
observations: z.ZodArray<z.ZodObject<{
|
|
280
|
+
labels: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
281
|
+
value: z.ZodNullable<z.ZodNumber>;
|
|
282
|
+
breached: z.ZodBoolean;
|
|
283
|
+
summary: z.ZodString;
|
|
284
|
+
}, z.core.$strip>>;
|
|
285
|
+
error: z.ZodNullable<z.ZodString>;
|
|
286
|
+
}, z.core.$strip>;
|
|
287
|
+
/** The dry-run response. @stability experimental */
|
|
288
|
+
export type AlertRuleTestResponse = z.infer<typeof alertRuleTestResponseSchema>;
|
|
289
|
+
/**
|
|
290
|
+
* One registered rule kind and the JSON Schema of its config.
|
|
291
|
+
*
|
|
292
|
+
* @stability experimental
|
|
293
|
+
*/
|
|
294
|
+
export declare const alertKindSchema: z.ZodObject<{
|
|
295
|
+
id: z.ZodString;
|
|
296
|
+
label: z.ZodString;
|
|
297
|
+
description: z.ZodString;
|
|
298
|
+
eventDriven: z.ZodBoolean;
|
|
299
|
+
builtin: z.ZodBoolean;
|
|
300
|
+
configSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
301
|
+
}, z.core.$strip>;
|
|
302
|
+
/** One kind. @stability experimental */
|
|
303
|
+
export type AlertKind = z.infer<typeof alertKindSchema>;
|
|
304
|
+
/** `GET /api/admin/alerts/kinds` response data. @stability experimental */
|
|
305
|
+
export declare const alertKindListSchema: z.ZodArray<z.ZodObject<{
|
|
306
|
+
id: z.ZodString;
|
|
307
|
+
label: z.ZodString;
|
|
308
|
+
description: z.ZodString;
|
|
309
|
+
eventDriven: z.ZodBoolean;
|
|
310
|
+
builtin: z.ZodBoolean;
|
|
311
|
+
configSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
312
|
+
}, z.core.$strip>>;
|
|
313
|
+
/**
|
|
314
|
+
* `GET /api/admin/alerts/summary` response: what the dashboard banner shows.
|
|
315
|
+
*
|
|
316
|
+
* @stability experimental
|
|
317
|
+
*/
|
|
318
|
+
export declare const alertSummarySchema: z.ZodObject<{
|
|
319
|
+
firing: z.ZodObject<{
|
|
320
|
+
critical: z.ZodNumber;
|
|
321
|
+
warning: z.ZodNumber;
|
|
322
|
+
info: z.ZodNumber;
|
|
323
|
+
}, z.core.$strip>;
|
|
324
|
+
lastEvaluatedAt: z.ZodNullable<z.ZodString>;
|
|
325
|
+
}, z.core.$strip>;
|
|
326
|
+
/** The summary. @stability experimental */
|
|
327
|
+
export type AlertSummary = z.infer<typeof alertSummarySchema>;
|
|
328
|
+
/**
|
|
329
|
+
* The `data` of the `alerts.alert.fired` and `alerts.alert.resolved` webhook
|
|
330
|
+
* events.
|
|
331
|
+
*
|
|
332
|
+
* @stability experimental
|
|
333
|
+
*/
|
|
334
|
+
export declare const alertWebhookDataSchema: z.ZodObject<{
|
|
335
|
+
incidentId: z.ZodString;
|
|
336
|
+
rule: z.ZodObject<{
|
|
337
|
+
id: z.ZodString;
|
|
338
|
+
key: z.ZodNullable<z.ZodString>;
|
|
339
|
+
name: z.ZodString;
|
|
340
|
+
kind: z.ZodString;
|
|
341
|
+
severity: z.ZodEnum<import("./constants.js").AlertEnumEntries<"info" | "warning" | "critical">>;
|
|
342
|
+
}, z.core.$strip>;
|
|
343
|
+
labels: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
344
|
+
value: z.ZodNullable<z.ZodNumber>;
|
|
345
|
+
summary: z.ZodString;
|
|
346
|
+
firedAt: z.ZodNullable<z.ZodString>;
|
|
347
|
+
resolvedAt: z.ZodNullable<z.ZodString>;
|
|
348
|
+
}, z.core.$strip>;
|
|
349
|
+
/** The webhook event data. @stability experimental */
|
|
350
|
+
export type AlertWebhookData = z.infer<typeof alertWebhookDataSchema>;
|
|
351
|
+
//# sourceMappingURL=schemas.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/alerts/schemas.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiCxB,oEAAoE;AACpE,eAAO,MAAM,mBAAmB,uFAA6B,CAAC;AAE9D,sEAAsE;AACtE,eAAO,MAAM,wBAAwB,yFAAkC,CAAC;AAExE,8CAA8C;AAC9C,eAAO,MAAM,qBAAqB,kGAA8B,CAAC;AAEjE,+CAA+C;AAC/C,eAAO,MAAM,sBAAsB,uGAA+B,CAAC;AAEnE,oFAAoF;AACpF,eAAO,MAAM,iBAAiB,aAA2D,CAAC;AAI1F;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;kBASzB,CAAC;AAEZ;;;;;;GAMG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;kBAiB7B,CAAC;AAEZ,8EAA8E;AAC9E,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,yFAE0C,CAAC;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;kBAuBvB,CAAC;AAEZ,wEAAwE;AACxE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;kBAKrB,CAAC;AAEZ,qEAAqE;AACrE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,iCAAwB,CAAC;AAS5D;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;iBAuC1B,CAAC;AAEH,wCAAwC;AACxC,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;iBAqBhC,CAAC;AAEH,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;kBAuB0C,CAAC;AAE7E,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,qEAAqE;AACrE,eAAO,MAAM,kBAAkB,aAAyD,CAAC;AAEzF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB;;;;iBASnC,CAAC;AAEH,0DAA0D;AAC1D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE3E,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;kBAA2B,CAAC;AAI5D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;iBAiC9B,CAAC;AAEH,4CAA4C;AAC5C,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;iBAWvC,CAAC;AAEH,8DAA8D;AAC9D,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAEnF,+EAA+E;AAC/E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;iBAWlC,CAAC;AAIH;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;iBASjC,CAAC;AAEH,+CAA+C;AAC/C,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;iBAatC,CAAC;AAEH,oDAAoD;AACpD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;iBAa1B,CAAC;AAEH,wCAAwC;AACxC,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD,2EAA2E;AAC3E,eAAO,MAAM,mBAAmB;;;;;;;kBAA2B,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB;;;;;;;iBAY7B,CAAC;AAEH,2CAA2C;AAC3C,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;iBA0BjC,CAAC;AAEH,sDAAsD;AACtD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC"}
|