@sfdxy/anypoint-connect 0.16.3 → 0.18.0

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.
Files changed (197) hide show
  1. package/README.md +17 -6
  2. package/dist/analysis/audit-actors.d.ts +36 -0
  3. package/dist/analysis/audit-actors.d.ts.map +1 -0
  4. package/dist/analysis/audit-actors.js +93 -0
  5. package/dist/analysis/audit-actors.js.map +1 -0
  6. package/dist/analysis/credentials.d.ts +49 -0
  7. package/dist/analysis/credentials.d.ts.map +1 -0
  8. package/dist/analysis/credentials.js +118 -0
  9. package/dist/analysis/credentials.js.map +1 -0
  10. package/dist/analysis/parser.d.ts +5 -0
  11. package/dist/analysis/parser.d.ts.map +1 -1
  12. package/dist/analysis/parser.js +10 -1
  13. package/dist/analysis/parser.js.map +1 -1
  14. package/dist/api/AlertsApi.d.ts +138 -0
  15. package/dist/api/AlertsApi.d.ts.map +1 -0
  16. package/dist/api/AlertsApi.js +168 -0
  17. package/dist/api/AlertsApi.js.map +1 -0
  18. package/dist/api/LogsApi.d.ts +88 -12
  19. package/dist/api/LogsApi.d.ts.map +1 -1
  20. package/dist/api/LogsApi.js +335 -31
  21. package/dist/api/LogsApi.js.map +1 -1
  22. package/dist/auth/BearerProvider.d.ts +12 -0
  23. package/dist/auth/BearerProvider.d.ts.map +1 -0
  24. package/dist/auth/BearerProvider.js +18 -0
  25. package/dist/auth/BearerProvider.js.map +1 -0
  26. package/dist/auth/ClientCredentialsProvider.d.ts +23 -0
  27. package/dist/auth/ClientCredentialsProvider.d.ts.map +1 -0
  28. package/dist/auth/ClientCredentialsProvider.js +59 -0
  29. package/dist/auth/ClientCredentialsProvider.js.map +1 -0
  30. package/dist/auth/TokenProvider.d.ts +12 -0
  31. package/dist/auth/TokenProvider.d.ts.map +1 -0
  32. package/dist/auth/TokenProvider.js +2 -0
  33. package/dist/auth/TokenProvider.js.map +1 -0
  34. package/dist/auth/index.d.ts +1 -0
  35. package/dist/auth/index.d.ts.map +1 -1
  36. package/dist/cli.js +8 -0
  37. package/dist/cli.js.map +1 -1
  38. package/dist/client/AnypointClient.d.ts +22 -0
  39. package/dist/client/AnypointClient.d.ts.map +1 -1
  40. package/dist/client/AnypointClient.js +82 -12
  41. package/dist/client/AnypointClient.js.map +1 -1
  42. package/dist/client/HttpClient.d.ts +3 -3
  43. package/dist/client/HttpClient.d.ts.map +1 -1
  44. package/dist/client/HttpClient.js +13 -3
  45. package/dist/client/HttpClient.js.map +1 -1
  46. package/dist/commands/alerts.d.ts +16 -0
  47. package/dist/commands/alerts.d.ts.map +1 -0
  48. package/dist/commands/alerts.js +375 -0
  49. package/dist/commands/alerts.js.map +1 -0
  50. package/dist/commands/api.d.ts.map +1 -1
  51. package/dist/commands/api.js +8 -3
  52. package/dist/commands/api.js.map +1 -1
  53. package/dist/commands/app-change-cli.d.ts +5 -2
  54. package/dist/commands/app-change-cli.d.ts.map +1 -1
  55. package/dist/commands/app-change-cli.js +19 -5
  56. package/dist/commands/app-change-cli.js.map +1 -1
  57. package/dist/commands/apps.d.ts.map +1 -1
  58. package/dist/commands/apps.js +69 -22
  59. package/dist/commands/apps.js.map +1 -1
  60. package/dist/commands/auth.d.ts.map +1 -1
  61. package/dist/commands/auth.js +21 -0
  62. package/dist/commands/auth.js.map +1 -1
  63. package/dist/commands/config.d.ts.map +1 -1
  64. package/dist/commands/config.js +20 -1
  65. package/dist/commands/config.js.map +1 -1
  66. package/dist/commands/deploy.d.ts.map +1 -1
  67. package/dist/commands/deploy.js +17 -6
  68. package/dist/commands/deploy.js.map +1 -1
  69. package/dist/commands/index.d.ts +1 -0
  70. package/dist/commands/index.d.ts.map +1 -1
  71. package/dist/commands/index.js +1 -0
  72. package/dist/commands/index.js.map +1 -1
  73. package/dist/commands/logs.d.ts +2 -1
  74. package/dist/commands/logs.d.ts.map +1 -1
  75. package/dist/commands/logs.js +105 -10
  76. package/dist/commands/logs.js.map +1 -1
  77. package/dist/commands/monitor.d.ts.map +1 -1
  78. package/dist/commands/monitor.js +29 -1
  79. package/dist/commands/monitor.js.map +1 -1
  80. package/dist/commands/runtimes.d.ts.map +1 -1
  81. package/dist/commands/runtimes.js +38 -5
  82. package/dist/commands/runtimes.js.map +1 -1
  83. package/dist/commands/shared.d.ts.map +1 -1
  84. package/dist/commands/shared.js +1 -7
  85. package/dist/commands/shared.js.map +1 -1
  86. package/dist/config/auth-modes.d.ts +11 -0
  87. package/dist/config/auth-modes.d.ts.map +1 -0
  88. package/dist/config/auth-modes.js +18 -0
  89. package/dist/config/auth-modes.js.map +1 -0
  90. package/dist/config/profiles.d.ts +19 -2
  91. package/dist/config/profiles.d.ts.map +1 -1
  92. package/dist/config/profiles.js +68 -24
  93. package/dist/config/profiles.js.map +1 -1
  94. package/dist/index.d.ts +12 -1
  95. package/dist/index.d.ts.map +1 -1
  96. package/dist/index.js +10 -0
  97. package/dist/index.js.map +1 -1
  98. package/dist/mcp/server.d.ts.map +1 -1
  99. package/dist/mcp/server.js +4 -9
  100. package/dist/mcp/server.js.map +1 -1
  101. package/dist/mcp/tools/alerts.d.ts +82 -0
  102. package/dist/mcp/tools/alerts.d.ts.map +1 -0
  103. package/dist/mcp/tools/alerts.js +423 -0
  104. package/dist/mcp/tools/alerts.js.map +1 -0
  105. package/dist/mcp/tools/api-manager.d.ts.map +1 -1
  106. package/dist/mcp/tools/api-manager.js +6 -1
  107. package/dist/mcp/tools/api-manager.js.map +1 -1
  108. package/dist/mcp/tools/app-inputs.d.ts +20 -2
  109. package/dist/mcp/tools/app-inputs.d.ts.map +1 -1
  110. package/dist/mcp/tools/app-inputs.js +40 -2
  111. package/dist/mcp/tools/app-inputs.js.map +1 -1
  112. package/dist/mcp/tools/apps-deploy.d.ts.map +1 -1
  113. package/dist/mcp/tools/apps-deploy.js +65 -13
  114. package/dist/mcp/tools/apps-deploy.js.map +1 -1
  115. package/dist/mcp/tools/apps-lifecycle.d.ts.map +1 -1
  116. package/dist/mcp/tools/apps-lifecycle.js +37 -15
  117. package/dist/mcp/tools/apps-lifecycle.js.map +1 -1
  118. package/dist/mcp/tools/apps-read.d.ts.map +1 -1
  119. package/dist/mcp/tools/apps-read.js +11 -5
  120. package/dist/mcp/tools/apps-read.js.map +1 -1
  121. package/dist/mcp/tools/audit.d.ts.map +1 -1
  122. package/dist/mcp/tools/audit.js +17 -4
  123. package/dist/mcp/tools/audit.js.map +1 -1
  124. package/dist/mcp/tools/exchange.d.ts.map +1 -1
  125. package/dist/mcp/tools/exchange.js +38 -18
  126. package/dist/mcp/tools/exchange.js.map +1 -1
  127. package/dist/mcp/tools/identity.d.ts.map +1 -1
  128. package/dist/mcp/tools/identity.js +29 -2
  129. package/dist/mcp/tools/identity.js.map +1 -1
  130. package/dist/mcp/tools/index.d.ts +1 -0
  131. package/dist/mcp/tools/index.d.ts.map +1 -1
  132. package/dist/mcp/tools/index.js +1 -0
  133. package/dist/mcp/tools/index.js.map +1 -1
  134. package/dist/mcp/tools/logs.d.ts +1 -1
  135. package/dist/mcp/tools/logs.d.ts.map +1 -1
  136. package/dist/mcp/tools/logs.js +34 -1
  137. package/dist/mcp/tools/logs.js.map +1 -1
  138. package/dist/mcp/tools/monitoring.d.ts.map +1 -1
  139. package/dist/mcp/tools/monitoring.js +5 -3
  140. package/dist/mcp/tools/monitoring.js.map +1 -1
  141. package/dist/mcp/tools/output-schemas.d.ts +83 -0
  142. package/dist/mcp/tools/output-schemas.d.ts.map +1 -0
  143. package/dist/mcp/tools/output-schemas.js +81 -0
  144. package/dist/mcp/tools/output-schemas.js.map +1 -0
  145. package/dist/mcp/tools/profile.d.ts +17 -3
  146. package/dist/mcp/tools/profile.d.ts.map +1 -1
  147. package/dist/mcp/tools/profile.js +122 -10
  148. package/dist/mcp/tools/profile.js.map +1 -1
  149. package/dist/mcp/tools/shared.d.ts +34 -2
  150. package/dist/mcp/tools/shared.d.ts.map +1 -1
  151. package/dist/mcp/tools/shared.js +37 -4
  152. package/dist/mcp/tools/shared.js.map +1 -1
  153. package/dist/safety/artifact.d.ts +45 -0
  154. package/dist/safety/artifact.d.ts.map +1 -1
  155. package/dist/safety/artifact.js +109 -0
  156. package/dist/safety/artifact.js.map +1 -1
  157. package/dist/safety/guards.d.ts +10 -0
  158. package/dist/safety/guards.d.ts.map +1 -1
  159. package/dist/safety/guards.js +16 -0
  160. package/dist/safety/guards.js.map +1 -1
  161. package/dist/safety/plan-binding.d.ts +21 -0
  162. package/dist/safety/plan-binding.d.ts.map +1 -0
  163. package/dist/safety/plan-binding.js +61 -0
  164. package/dist/safety/plan-binding.js.map +1 -0
  165. package/dist/safety/preapproval.d.ts +102 -0
  166. package/dist/safety/preapproval.d.ts.map +1 -0
  167. package/dist/safety/preapproval.js +251 -0
  168. package/dist/safety/preapproval.js.map +1 -0
  169. package/dist/safety/secrets.d.ts +7 -0
  170. package/dist/safety/secrets.d.ts.map +1 -1
  171. package/dist/safety/secrets.js +16 -0
  172. package/dist/safety/secrets.js.map +1 -1
  173. package/dist/utils/formatter.d.ts +2 -0
  174. package/dist/utils/formatter.d.ts.map +1 -1
  175. package/dist/utils/formatter.js +4 -0
  176. package/dist/utils/formatter.js.map +1 -1
  177. package/dist/utils/logger.d.ts +2 -0
  178. package/dist/utils/logger.d.ts.map +1 -1
  179. package/dist/utils/logger.js +23 -13
  180. package/dist/utils/logger.js.map +1 -1
  181. package/dist/workflows/alerts.d.ts +309 -0
  182. package/dist/workflows/alerts.d.ts.map +1 -0
  183. package/dist/workflows/alerts.js +631 -0
  184. package/dist/workflows/alerts.js.map +1 -0
  185. package/dist/workflows/app-change.d.ts +32 -1
  186. package/dist/workflows/app-change.d.ts.map +1 -1
  187. package/dist/workflows/app-change.js +57 -2
  188. package/dist/workflows/app-change.js.map +1 -1
  189. package/dist/workflows/artifact-verification.d.ts +52 -0
  190. package/dist/workflows/artifact-verification.d.ts.map +1 -0
  191. package/dist/workflows/artifact-verification.js +85 -0
  192. package/dist/workflows/artifact-verification.js.map +1 -0
  193. package/dist/workflows/jar-deployment.d.ts +37 -10
  194. package/dist/workflows/jar-deployment.d.ts.map +1 -1
  195. package/dist/workflows/jar-deployment.js +44 -13
  196. package/dist/workflows/jar-deployment.js.map +1 -1
  197. package/package.json +1 -1
@@ -0,0 +1,309 @@
1
+ /**
2
+ * Alert workflows
3
+ * Shared by the alert MCP tools and `anc alerts`: normalizing alerts for display (recipients masked by
4
+ * default), turning human inputs (percent thresholds, minutes, explicit notifications) into the
5
+ * platform's payload, resolving the target from CloudHub 2.0 or API Manager, duplicate detection,
6
+ * and the get-merge-replace update the platform requires.
7
+ */
8
+ import type { AnypointClient } from '../client/AnypointClient.js';
9
+ import type { Environment } from '../api/AccessManagementApi.js';
10
+ import { type AlertEntity, type AlertMetricId, type AlertNotification, type AlertOperator, type AlertWriteBody, type MonitoringAlert, type RuntimeManagerAlert } from '../api/AlertsApi.js';
11
+ export type MetricUnit = 'percent' | 'count' | 'ms';
12
+ export interface MetricInfo {
13
+ unit: MetricUnit;
14
+ entityType: 'application' | 'api';
15
+ aggregation: 'AVG' | 'SUM';
16
+ /** An API filter this metric needs. */
17
+ requires?: 'RESPONSE_CODE' | 'POLICY';
18
+ }
19
+ /** Every metric an alert can watch, in one table. */
20
+ export declare const ALERT_METRICS: Record<AlertMetricId, MetricInfo>;
21
+ export declare const MAX_DURATION_MINUTES = 60;
22
+ export interface RecipientSummary {
23
+ recipientCount: number;
24
+ /** Email domains only, never addresses. */
25
+ recipientDomains: string[];
26
+ slackChannels: number;
27
+ }
28
+ export declare function summarizeRecipients(notifications?: AlertNotification[]): RecipientSummary;
29
+ /**
30
+ * Notifications as written back: the read side (`notificationTemplates`) under the write name, with
31
+ * every field the platform returned kept, including ones this tool does not know.
32
+ */
33
+ export declare function notificationsOf(alert: MonitoringAlert): AlertNotification[];
34
+ /** Which aspects of the notifications differ, by name only, so a masked diff still says what changed. */
35
+ export declare function notificationDifferences(before: AlertNotification[], after: AlertNotification[]): string[];
36
+ /**
37
+ * A recipient summary for display. Domains can identify clients, so they are shown only with `reveal`;
38
+ * otherwise only the counts.
39
+ */
40
+ export declare function displayRecipients(notifications: AlertNotification[], reveal?: boolean): {
41
+ recipientCount: number;
42
+ slackChannels: number;
43
+ } | {
44
+ recipientDomains: string[];
45
+ recipientCount: number;
46
+ slackChannels: number;
47
+ };
48
+ /** Notifications for display: masked to counts unless `reveal`. */
49
+ export declare function describeNotifications(notifications: AlertNotification[], reveal?: boolean): AlertNotification[];
50
+ /** The Monitoring UI's levels: the stored number is the index. */
51
+ export declare const SEVERITY_LABELS: readonly ["LOW", "MEDIUM", "HIGH", "CRITICAL"];
52
+ export type SeverityLabel = (typeof SEVERITY_LABELS)[number];
53
+ /** A severity given as 0-3 or a label (LOW, MEDIUM, HIGH, CRITICAL), as the stored number. */
54
+ export declare function parseSeverity(input: number | string): number;
55
+ /** One label for any family's severity: a Monitoring number, or a word such as INFO or warning. */
56
+ export declare function severityLabel(value: unknown): string | undefined;
57
+ export declare function windowMinutes(interval: string | undefined): number | undefined;
58
+ export declare function metricInfo(metric: string): MetricInfo | undefined;
59
+ /** A stored threshold in the unit people use: percent metrics are stored as fractions. */
60
+ export declare function displayThreshold(metric: string, stored: number): number;
61
+ export type AlertSource = 'monitoring' | 'runtime-manager';
62
+ export declare function normalizeAlert(alert: MonitoringAlert, options?: {
63
+ reveal?: boolean;
64
+ }): {
65
+ notifications?: AlertNotification[] | undefined;
66
+ recipientCount: number;
67
+ slackChannels: number;
68
+ id: string;
69
+ source: AlertSource;
70
+ name: string;
71
+ enabled: boolean;
72
+ severity: string | undefined;
73
+ severityLevel: number;
74
+ status: import("../api/AlertsApi.js").AlertStatus | undefined;
75
+ state: string | undefined;
76
+ entity: {
77
+ deploymentType: import("../api/AlertsApi.js").AlertDeploymentType | undefined;
78
+ environment: string;
79
+ environmentId: string;
80
+ apiInstanceId?: string | undefined;
81
+ type: import("../api/AlertsApi.js").AlertEntityType;
82
+ name: string | undefined;
83
+ };
84
+ condition: {
85
+ metric: string;
86
+ operator: "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_EQUAL_TO" | "LESS_THAN_EQUAL_TO" | "EQUALS";
87
+ threshold: number | undefined;
88
+ unit: MetricUnit | undefined;
89
+ windowMinutes: number | undefined;
90
+ };
91
+ } | {
92
+ notifications?: AlertNotification[] | undefined;
93
+ recipientDomains: string[];
94
+ recipientCount: number;
95
+ slackChannels: number;
96
+ id: string;
97
+ source: AlertSource;
98
+ name: string;
99
+ enabled: boolean;
100
+ severity: string | undefined;
101
+ severityLevel: number;
102
+ status: import("../api/AlertsApi.js").AlertStatus | undefined;
103
+ state: string | undefined;
104
+ entity: {
105
+ deploymentType: import("../api/AlertsApi.js").AlertDeploymentType | undefined;
106
+ environment: string;
107
+ environmentId: string;
108
+ apiInstanceId?: string | undefined;
109
+ type: import("../api/AlertsApi.js").AlertEntityType;
110
+ name: string | undefined;
111
+ };
112
+ condition: {
113
+ metric: string;
114
+ operator: "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_EQUAL_TO" | "LESS_THAN_EQUAL_TO" | "EQUALS";
115
+ threshold: number | undefined;
116
+ unit: MetricUnit | undefined;
117
+ windowMinutes: number | undefined;
118
+ };
119
+ };
120
+ /** Whether a Runtime Manager alert targets an app: membership in its resources, case-insensitive. */
121
+ export declare function targetsApp(resources: readonly string[] | undefined, app: string): boolean;
122
+ /**
123
+ * View of a Runtime Manager event alert (deployment failed and similar). Observed shape:
124
+ * condition{type, resourceType, resources[]}, actions[]{type, userIds[], emails[], subject, content},
125
+ * plus conditionType, isSystem and productName.
126
+ */
127
+ export declare function normalizeRuntimeManagerAlert(alert: RuntimeManagerAlert, options?: {
128
+ reveal?: boolean;
129
+ }): {
130
+ recipientDomains?: string[] | undefined;
131
+ actions?: {
132
+ type: unknown;
133
+ emails: string[];
134
+ userIds: string[];
135
+ }[] | undefined;
136
+ recipientCount: number;
137
+ productName?: string | number | undefined;
138
+ isSystem?: boolean | undefined;
139
+ conditionType?: string | number | undefined;
140
+ id: string | number | undefined;
141
+ source: AlertSource;
142
+ name: string | number | undefined;
143
+ enabled: boolean | undefined;
144
+ severity: string | undefined;
145
+ status: string | number | undefined;
146
+ state: string | number | undefined;
147
+ entity: {
148
+ type: string | number | undefined;
149
+ name: string | undefined;
150
+ /** Every target, for filtering by membership. */
151
+ resources: string[];
152
+ };
153
+ condition: {
154
+ event: string | number | undefined;
155
+ };
156
+ };
157
+ export type NotificationInput = {
158
+ type: 'EMAIL';
159
+ recipients: string[];
160
+ subject: string;
161
+ message: string;
162
+ } | {
163
+ type: 'SLACK';
164
+ channelId: string;
165
+ carrierId?: string;
166
+ message: string;
167
+ };
168
+ /** Turn explicit notification inputs into the platform shape. At least one is required; there are no defaults. */
169
+ export declare function buildNotifications(inputs: NotificationInput[] | undefined): AlertNotification[];
170
+ /** Convert and validate a threshold given in the metric's unit (percent for % metrics). */
171
+ export declare function storedThreshold(metric: AlertMetricId, value: number): number;
172
+ export declare function evaluationInterval(durationMinutes: number): string;
173
+ export declare const checkSeverity: typeof parseSeverity;
174
+ export interface ApiFilterInput {
175
+ responseCodes?: string[];
176
+ policies?: string[];
177
+ }
178
+ export type AlertTarget = {
179
+ app: string;
180
+ } | {
181
+ apiInstanceId: string;
182
+ };
183
+ export interface CreateAlertInput {
184
+ environment: string;
185
+ name: string;
186
+ target: AlertTarget;
187
+ metric: AlertMetricId;
188
+ operator: AlertOperator;
189
+ /** In the metric's unit: percent (0-100] for cpu and memory, a count, or milliseconds. */
190
+ threshold: number;
191
+ durationMinutes: number;
192
+ /** 0-3, or LOW, MEDIUM, HIGH, CRITICAL. */
193
+ severity: number | string;
194
+ enabled?: boolean;
195
+ notifications: NotificationInput[];
196
+ apiFilters?: ApiFilterInput;
197
+ allowDuplicate?: boolean;
198
+ }
199
+ /** Resolve the alert entity from CloudHub 2.0 (an app) or API Manager (an API instance). */
200
+ export declare function resolveAlertEntity(client: AnypointClient, orgId: string, env: Pick<Environment, 'id' | 'name'>, target: AlertTarget, metric: AlertMetricId, filters?: ApiFilterInput): Promise<AlertEntity>;
201
+ export declare function sameEntity(a: AlertEntity | undefined, b: AlertEntity): boolean;
202
+ /** Recipients outside the user's own email domain, as domains. The user's address is never returned. */
203
+ export declare function outsideDomains(notifications: AlertNotification[], userEmail: string | undefined): string[];
204
+ export interface CreateAlertPlan {
205
+ orgId: string;
206
+ env: Environment;
207
+ body: AlertWriteBody;
208
+ warnings: string[];
209
+ /** An existing alert with the same name on the same entity. */
210
+ duplicate?: {
211
+ id: string;
212
+ name: string;
213
+ status?: string;
214
+ };
215
+ }
216
+ /**
217
+ * The create payload for a preview. For an API target only the instance ID the caller passed is shown;
218
+ * the API name and endpoint resolved from API Manager are sent but not printed.
219
+ */
220
+ export declare function previewPayload(body: AlertWriteBody): AlertWriteBody;
221
+ export declare function planCreateAlert(client: AnypointClient, input: CreateAlertInput, options?: {
222
+ enableHint?: string;
223
+ }): Promise<CreateAlertPlan>;
224
+ export interface AlertPatch {
225
+ name?: string;
226
+ /** 0-3, or LOW, MEDIUM, HIGH, CRITICAL. */
227
+ severity?: number | string;
228
+ enabled?: boolean;
229
+ operator?: AlertOperator;
230
+ /** In the metric's unit, as for create. */
231
+ threshold?: number;
232
+ durationMinutes?: number;
233
+ /** Replaces every notification. */
234
+ notifications?: NotificationInput[];
235
+ }
236
+ export interface AlertChange {
237
+ field: string;
238
+ from: unknown;
239
+ to: unknown;
240
+ /** For notifications: which parts differ (recipients, subject, messageTemplate, channelId, ...). */
241
+ differs?: string[];
242
+ }
243
+ export interface UpdateAlertPlan {
244
+ orgId: string;
245
+ env: Environment;
246
+ existing: MonitoringAlert;
247
+ body: AlertWriteBody;
248
+ changes: AlertChange[];
249
+ noop: boolean;
250
+ }
251
+ export declare function loadAlert(client: AnypointClient, orgId: string, id: string): Promise<MonitoringAlert>;
252
+ /** The environment an alert belongs to, for production checks. */
253
+ export declare function alertEnvironment(client: AnypointClient, orgId: string, alert: MonitoringAlert): Promise<Environment>;
254
+ /** Read the alert, merge the patch, and build the full replacement body the platform needs. */
255
+ export declare function planUpdateAlert(client: AnypointClient, id: string, patch: AlertPatch): Promise<UpdateAlertPlan>;
256
+ /**
257
+ * Find an alert in the list, narrowed by environment and name so the listing stays small. `complete`
258
+ * is false when the listing hit its page cap; absence from an incomplete listing proves nothing.
259
+ */
260
+ export declare function findListedAlert(client: AnypointClient, orgId: string, alert: {
261
+ id: string;
262
+ name?: string;
263
+ environmentId?: string;
264
+ }): Promise<{
265
+ alert?: MonitoringAlert;
266
+ complete: boolean;
267
+ }>;
268
+ export interface UpdateAlertResult {
269
+ accepted: true;
270
+ /** True only when the listed alert is ACTIVE and carries the new values. */
271
+ verified: boolean;
272
+ status: 'ACTIVE' | 'PENDING' | 'UNVERIFIED';
273
+ message: string;
274
+ }
275
+ /** Bounded completion polling. The write is never resent; only the list is read again. */
276
+ export interface AlertWaitOptions {
277
+ /** How long to keep checking after the first read; 0 or unset reads once. */
278
+ waitMs?: number;
279
+ pollIntervalMs?: number;
280
+ signal?: AbortSignal;
281
+ }
282
+ export declare const MAX_ALERT_WAIT_SECONDS = 300;
283
+ /** Wait options from a caller's seconds; rejects values outside 0 to MAX_ALERT_WAIT_SECONDS. */
284
+ export declare function alertWait(seconds: number | undefined, signal?: AbortSignal): AlertWaitOptions;
285
+ /**
286
+ * Send the full replacement, then re-read the alert from the list once. The platform answers 202 and
287
+ * applies the change asynchronously, so "updated" is claimed only when the list shows it applied.
288
+ */
289
+ export declare function executeUpdateAlert(client: AnypointClient, plan: Pick<UpdateAlertPlan, 'orgId' | 'existing' | 'body'>, wait?: AlertWaitOptions): Promise<UpdateAlertResult>;
290
+ export interface DeleteAlertResult {
291
+ accepted: boolean;
292
+ /** PENDING while the platform deletes it; GONE once the complete list no longer shows it. */
293
+ status: 'PENDING' | 'ACTIVE' | 'DELETED' | 'GONE' | 'UNVERIFIED';
294
+ verifiedAbsent: boolean;
295
+ message: string;
296
+ }
297
+ export declare const CHANGE_IN_PROGRESS = "A change to this alert is in progress (PENDING); the platform refuses changes and deletion until it finishes. Retry later.";
298
+ /**
299
+ * Read an alert for deletion. The list is fresher than GET right after a change (GET can keep
300
+ * answering ACTIVE, or 404 while the list still shows PENDING), so the listed entry wins.
301
+ */
302
+ export declare function readAlertForDelete(client: AnypointClient, orgId: string, id: string): Promise<MonitoringAlert | null>;
303
+ /**
304
+ * Request deletion, then verify it from the list. Never claims deleted while the list still shows the
305
+ * alert, or when the listing was cut off. A 404 on DELETE with the alert absent from a complete
306
+ * listing means it is already gone.
307
+ */
308
+ export declare function executeDeleteAlert(client: AnypointClient, orgId: string, alert: Pick<MonitoringAlert, 'id' | 'name' | 'entity'>, wait?: AlertWaitOptions): Promise<DeleteAlertResult>;
309
+ //# sourceMappingURL=alerts.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../src/workflows/alerts.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAEH,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EAC3B,MAAM,qBAAqB,CAAC;AAE7B,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAC;AAEpD,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,aAAa,GAAG,KAAK,CAAC;IAClC,WAAW,EAAE,KAAK,GAAG,KAAK,CAAC;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,EAAE,eAAe,GAAG,QAAQ,CAAC;CACzC;AAED,qDAAqD;AACrD,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,UAAU,CAW3D,CAAC;AAEF,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAIvC,MAAM,WAAW,gBAAgB;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;CACzB;AAOD,wBAAgB,mBAAmB,CAAC,aAAa,GAAE,iBAAiB,EAAO,GAAG,gBAAgB,CAO7F;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,eAAe,GAAG,iBAAiB,EAAE,CAK3E;AAcD,yGAAyG;AACzG,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,GAAG,MAAM,EAAE,CAczG;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,iBAAiB,EAAE,EAAE,MAAM,UAAQ;oBAhEhE,MAAM;mBAGP,MAAM;;;oBAHL,MAAM;mBAGP,MAAM;EAgExB;AAED,mEAAmE;AACnE,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,iBAAiB,EAAE,EAAE,MAAM,UAAQ,uBAUvF;AAID,kEAAkE;AAClE,eAAO,MAAM,eAAe,gDAAiD,CAAC;AAC9E,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAc7D,8FAA8F;AAC9F,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAU5D;AAED,mGAAmG;AACnG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAIhE;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAI9E;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAEjE;AAED,0FAA0F;AAC1F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvE;AAED,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,iBAAiB,CAAC;AAE3D,wBAAgB,cAAc,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO;;oBAzIrE,MAAM;mBAGP,MAAM;;YA4IO,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;oBA/IvB,MAAM;mBAGP,MAAM;;YA4IO,WAAW;;;;;;;;;;;;;;;;;;;;;;EAyB1C;AAID,qGAAqG;AACrG,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO;;;;;;;;;;;;YAYtE,WAAW;;;;;;;;;QASpC,iDAAiD;;;;;;EAmB5D;AAID,MAAM,MAAM,iBAAiB,GACvB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACzE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAIhF,kHAAkH;AAClH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,SAAS,GAAG,iBAAiB,EAAE,CAoB/F;AAED,2FAA2F;AAC3F,wBAAgB,eAAe,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAc5E;AAED,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAKlE;AAED,eAAO,MAAM,aAAa,sBAAgB,CAAC;AAE3C,MAAM,WAAW,cAAc;IAC3B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,WAAW,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtE,MAAM,WAAW,gBAAgB;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,aAAa,CAAC;IACxB,0FAA0F;IAC1F,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,4FAA4F;AAC5F,wBAAsB,kBAAkB,CACpC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,GAAG,MAAM,CAAC,EACrC,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,aAAa,EACrB,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC,CA+CtB;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,WAAW,GAAG,SAAS,EAAE,CAAC,EAAE,WAAW,GAAG,OAAO,CAG9E;AAED,wGAAwG;AACxG,wBAAgB,cAAc,CAAC,aAAa,EAAE,iBAAiB,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,CAI1G;AAED,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,WAAW,CAAC;IACjB,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,+DAA+D;IAC/D,SAAS,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7D;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,cAAc,CAInE;AAED,wBAAsB,eAAe,CACjC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,gBAAgB,EACvB,OAAO,GAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAO,GACtC,OAAO,CAAC,eAAe,CAAC,CAmD1B;AAID,MAAM,WAAW,UAAU;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,aAAa,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,oGAAoG;IACpG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAcD,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,WAAW,CAAC;IACjB,QAAQ,EAAE,eAAe,CAAC;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,wBAAsB,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAI3G;AAED,kEAAkE;AAClE,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,wBAEnG;AAED,+FAA+F;AAC/F,wBAAsB,eAAe,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC,CA2DrH;AAID;;;GAGG;AACH,wBAAsB,eAAe,CACjC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7D,OAAO,CAAC;IAAE,KAAK,CAAC,EAAE,eAAe,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC,CAMzD;AAID,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,EAAE,IAAI,CAAC;IACf,4EAA4E;IAC5E,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,YAAY,CAAC;IAC5C,OAAO,EAAE,MAAM,CAAC;CACnB;AAeD,0FAA0F;AAC1F,MAAM,WAAW,gBAAgB;IAC7B,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB;AAGD,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAE1C,gGAAgG;AAChG,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,gBAAgB,CAM7F;AAuBD;;;GAGG;AACH,wBAAsB,kBAAkB,CACpC,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,IAAI,CAAC,eAAe,EAAE,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC,EAC1D,IAAI,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,CAO5B;AA0CD,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,EAAE,OAAO,CAAC;IAClB,6FAA6F;IAC7F,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,YAAY,CAAC;IACjE,cAAc,EAAE,OAAO,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,kBAAkB,+HACiG,CAAC;AAEjI;;;GAGG;AACH,wBAAsB,kBAAkB,CACpC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,MAAM,EACb,EAAE,EAAE,MAAM,GACX,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAQjC;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACpC,MAAM,EAAE,cAAc,EACtB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,GAAG,MAAM,GAAG,QAAQ,CAAC,EACtD,IAAI,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,CAO5B"}