@marinoscar/platform-web 0.1.0-next.19 → 0.1.0-next.21

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @marinoscar/platform-web
 
+## 0.1.0-next.21
+
+### Patch Changes
+
+- @marinoscar/platform-contract@0.1.0-next.21
+
+## 0.1.0-next.20
+
+### Minor Changes
+
+- 64fc8fc: Add the alerts web slice (#1047): `@marinoscar/platform-web/alerts/headless` (`createAlertsApi`, `useAlertRules`, `useAlertRule`, `useAlertKinds`, `useAlertIncidents`, `useAlertIncident`, `useAlertSummary` polled every 30 seconds, `useAlertMetricCatalog`, `useAlertMutations`, the rule editor's draft model and alerts in words) and `@marinoscar/platform-web/alerts/ui` (`AlertsPage` with Rules and Incidents tabs, `AlertRuleDialog` with a form per built-in kind and a dry-run Test, `AlertRuleTestResult`, `AlertIncidentDrawer`, `FiringAlertsBanner` for the telemetry dashboard's `BeforeContent` slot, and the `alertsAdminCards` Observability card, `alerts:read`). Starter rules show "Built-in" and cannot be deleted from the UI.
+- c9b5944: Worker Nodes page: a power badge per node (AC or battery with percent and charging state), a "Host machine" section in the vitals dialog (host CPU, memory, load, OS, power) and a paginated node events timeline backed by `useNodeEvents` / `NodesApi.listNodeEvents`. The telemetry metric table now renders 0/1 status gauges. Apps with their own `NodesApi` implementation must add `listNodeEvents`.
+- 5016783: Add the `webhooks` slice (issue #1046): `@marinoscar/platform-web/webhooks/headless` (`createWebhooksApi` for the `user`, `org` and `system` scopes, the endpoint, delivery and event catalog hooks, `useWebhookMutations`, the event picker's wildcard model and status helpers) and `@marinoscar/platform-web/webhooks/ui` (`WebhooksPage` with its create and edit dialog, grouped event picker, one-time secret dialog, deliveries table, delivery drawer with Redeliver and the "Verifying signatures" panel, plus the settings cards as data `webhooksUserSettingsSections` and `webhooksAdminSections`).
+
+### Patch Changes
+
+- Updated dependencies [7b5796f]
+- Updated dependencies [6949b6b]
+- Updated dependencies [f3b9700]
+  - @marinoscar/platform-contract@0.1.0-next.20
+
 ## 0.1.0-next.19
 
 ### Minor Changes

package/README.md

@@ -31,6 +31,8 @@ Status: pre-release (the current channel and how to install it: the [release run
 - `@marinoscar/platform-web/host/headless` and `@marinoscar/platform-web/host/ui`: the About page, the admin Maintenance page and the public maintenance screen, with the maintenance recogniser and block store, `createHostApi` and the `useAbout`, `useMaintenance` and `useMaintenanceBlock` hooks (#891). [README](src/host/README.md).
 - `@marinoscar/platform-web/datatable/headless`, `@marinoscar/platform-web/datatable/ui` and `@marinoscar/platform-web/datatable/testing`: the responsive `DataTable` (desktop grid, tablet expander, phone cards) with its filters, view bar, CSV export and bulk actions, the layout-preference port `DataTablePreferencesPort`, and the jsdom layout stubs and conformance suite (#897). [README](src/datatable/README.md).
 - `@marinoscar/platform-web/timezone/headless` and `@marinoscar/platform-web/timezone/ui`: the display time zone (the user's `profile.timezone`, else the device's) with its store, `useDisplayTimeZone` and `UserTimeZoneSync`, the formatters that render in it (`formatDateTime`, `formatDate`, `formatTime`, `zonedDateKey`), the zone catalog, and the world-map picker (`TimeZoneMap`, `TimeZonePickerDialog`, `TimeZoneField`). [README](src/timezone/README.md).
+- `@marinoscar/platform-web/webhooks/headless` and `@marinoscar/platform-web/webhooks/ui`: outbound webhooks for the `user`, `org` and `system` scopes: `createWebhooksApi`, the endpoint, delivery and event catalog hooks, the event picker's wildcard model, and `WebhooksPage` with its create and edit dialog, one-time secret dialog, deliveries table and delivery drawer, plus the settings cards as data (`webhooksUserSettingsSections`, `webhooksAdminSections`) (#1046). [README](src/webhooks/README.md).
+- `@marinoscar/platform-web/alerts/headless` and `@marinoscar/platform-web/alerts/ui`: alert rules and incidents: `createAlertsApi`, the rule, kind, incident, summary and metric-catalog hooks, the rule editor's draft model, and `AlertsPage` (Rules and Incidents tabs) with the rule editor, the dry-run result and the incident drawer, `FiringAlertsBanner` for the telemetry dashboard, plus the admin card as data (`alertsAdminCards`) (#1047). [README](src/alerts/README.md).
 
 ## Install and peer dependencies
 
@@ -54,10 +56,10 @@ Optional peers, installed for the slices that need them:
 
 | Package | Range | Needed by |
 |---|---|---|
-| `@mui/icons-material` | `^9.1.0` | every slice with a `/ui` entry (`doctor`, `identity`, `settings`, `sharing`, `onboarding`, `email`, `nodes`, `jobs`, `storage`, `notifications`, `exports`, `ai`, `db-backup`, `android-app`, `user-data`, `shell`, `host`, `datatable`, `telemetry`, `timezone`) |
-| `react-router-dom` | `^7.17.0` | the same slices, except `exports`, `datatable` and `timezone` |
+| `@mui/icons-material` | `^9.1.0` | every slice with a `/ui` entry (`doctor`, `identity`, `settings`, `sharing`, `onboarding`, `email`, `nodes`, `jobs`, `storage`, `notifications`, `exports`, `ai`, `db-backup`, `android-app`, `user-data`, `shell`, `host`, `datatable`, `telemetry`, `timezone`, `webhooks`, `alerts`) |
+| `react-router-dom` | `^7.17.0` | the same slices, except `exports`, `datatable`, `timezone` and `webhooks` |
 | `zod` | `^4.4.3` | `nodes`, `jobs` (and the app's own use of `@marinoscar/platform-contract`) |
-| `@mui/x-data-grid` | `^9.10.1` | `datatable/ui` and, since the AI lists use it, `ai/ui`; `telemetry/ui` |
+| `@mui/x-data-grid` | `^9.10.1` | `datatable/ui` and, since the AI lists use it, `ai/ui`; `telemetry/ui`; `webhooks/ui`; `alerts/ui` |
 | `@mui/x-charts` | `^9.14.0` | `telemetry/ui` (#704) |
 | `@uiw/react-codemirror` | `^4.25.12` | `telemetry/ui` |
 | `@codemirror/lang-sql` | `^6.10.0` | `telemetry/ui` |

package/dist/alerts/headless/client.d.ts

@@ -0,0 +1,134 @@
+import type { AlertIncident, AlertIncidentState, AlertKind, AlertRule, AlertRuleTestResponse, AlertSeverity, AlertSummary, CreateAlertRule, UpdateAlertRule } from '@marinoscar/platform-contract/alerts';
+import type { TelemetrySchema } from '@marinoscar/platform-contract/telemetry';
+import type { PlatformApiClient } from '../../core/index.js';
+/**
+ * The route base of the alerts slice, relative to the API root (`/api`).
+ *
+ * @stability experimental
+ */
+export declare const ALERTS_BASE_PATH = "/admin/alerts";
+/**
+ * The telemetry route the metric picker reads (relative to `/api`).
+ *
+ * @stability experimental
+ */
+export declare const ALERTS_METRIC_CATALOG_PATH = "/admin/telemetry/schema";
+/**
+ * The filters of a rule list request.
+ *
+ * @stability experimental
+ */
+export interface AlertRulesQuery {
+    /** Only rules of this kind. */
+    kind?: string;
+    /** Only rules of this severity. */
+    severity?: AlertSeverity;
+    /** Only enabled (`true`) or disabled (`false`) rules. */
+    enabled?: boolean;
+}
+/**
+ * The filters and page of an incident list request. `page` is one-based, as
+ * on the wire.
+ *
+ * @stability experimental
+ */
+export interface AlertIncidentsQuery {
+    /** Only incidents in this state. */
+    state?: AlertIncidentState;
+    /** Only incidents of this severity. */
+    severity?: AlertSeverity;
+    /** Only incidents of this rule. */
+    ruleId?: string;
+    /** One-based page; default 1. */
+    page?: number;
+    /** Rows per page; default the API's (20). */
+    pageSize?: number;
+}
+/**
+ * One page of incidents as `GET /admin/alerts/incidents` returns it.
+ *
+ * @stability experimental
+ */
+export interface AlertIncidentPage {
+    /** The incidents of the page. */
+    items: AlertIncident[];
+    /** Incidents matching the filters, across every page. */
+    total: number;
+    /** The one-based page. */
+    page: number;
+    /** Rows per page. */
+    pageSize: number;
+    /** Pages at this page size. */
+    totalPages: number;
+}
+/**
+ * One metric the rule editor can pick: a telemetry store table and its
+ * attribute columns (the `groupBy` and filter candidates).
+ *
+ * @stability experimental
+ */
+export interface AlertMetricCatalogEntry {
+    /** The table name, accepted as `metric` by `metric_threshold` (`app_jobs_settled`). */
+    name: string;
+    /** The columns other than the value and the timestamp. */
+    attributes: string[];
+}
+/**
+ * The alerts API calls.
+ *
+ * @stability experimental
+ */
+export interface AlertsApi {
+    /** `GET /admin/alerts/rules`. */
+    listRules(query?: AlertRulesQuery): Promise<AlertRule[]>;
+    /** `GET /admin/alerts/rules/:id`. */
+    getRule(id: string): Promise<AlertRule>;
+    /** `POST /admin/alerts/rules`. */
+    createRule(input: CreateAlertRule): Promise<AlertRule>;
+    /** `PATCH /admin/alerts/rules/:id` (the kind cannot change). */
+    updateRule(id: string, patch: UpdateAlertRule): Promise<AlertRule>;
+    /** `DELETE /admin/alerts/rules/:id` (a starter rule answers 409). */
+    deleteRule(id: string): Promise<void>;
+    /** `POST /admin/alerts/rules/:id/test`: a dry run, nothing stored or sent. */
+    testRule(id: string): Promise<AlertRuleTestResponse>;
+    /** `GET /admin/alerts/kinds`. */
+    listKinds(): Promise<AlertKind[]>;
+    /** `GET /admin/alerts/incidents?state&severity&ruleId&page&pageSize`. */
+    listIncidents(query?: AlertIncidentsQuery): Promise<AlertIncidentPage>;
+    /** `GET /admin/alerts/incidents/:id`. */
+    getIncident(id: string): Promise<AlertIncident>;
+    /** `POST /admin/alerts/incidents/:id/acknowledge`. */
+    acknowledge(id: string): Promise<AlertIncident>;
+    /** `GET /admin/alerts/summary`: firing counts by severity. */
+    summary(): Promise<AlertSummary>;
+    /** `GET /admin/telemetry/schema`, reduced to the metric tables and their attributes. */
+    metricCatalog(): Promise<AlertMetricCatalogEntry[]>;
+}
+/**
+ * The store's table list as the metric picker's entries: the metric tables
+ * (not the trace and log tables), each with its attribute columns, sorted by
+ * name.
+ *
+ * @param schema - what `GET /admin/telemetry/schema` returned.
+ * @returns the entries.
+ *
+ * @stability experimental
+ */
+export declare function metricCatalogFromSchema(schema: Pick<TelemetrySchema, 'tables'>): AlertMetricCatalogEntry[];
+/**
+ * The alerts client over the app's transport.
+ *
+ * @param api - the app's transport (`usePlatformApi()`).
+ * @returns the client.
+ *
+ * @example
+ * ```ts
+ * const alerts = createAlertsApi(usePlatformApi());
+ * const { firing } = await alerts.summary();
+ * ```
+ *
+ * @extensionPoint hook
+ * @stability experimental
+ */
+export declare function createAlertsApi(api: PlatformApiClient): AlertsApi;
+//# sourceMappingURL=client.d.ts.map

package/dist/alerts/headless/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/alerts/headless/client.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,SAAS,EACT,qBAAqB,EACrB,aAAa,EACb,YAAY,EACZ,eAAe,EACf,eAAe,EAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,4BAA4B,CAAC;AAEpE;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,yDAAyD;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,oCAAoC;IACpC,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,uCAAuC;IACvC,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,SAAS,CAAC,KAAK,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACzD,qCAAqC;IACrC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACxC,kCAAkC;IAClC,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACvD,gEAAgE;IAChE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnE,qEAAqE;IACrE,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACrD,iCAAiC;IACjC,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IAClC,yEAAyE;IACzE,aAAa,CAAC,KAAK,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACvE,yCAAyC;IACzC,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAChD,sDAAsD;IACtD,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAChD,8DAA8D;IAC9D,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC;IACjC,wFAAwF;IACxF,aAAa,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC;CACrD;AAUD;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,uBAAuB,EAAE,CAQ1G;AAYD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,iBAAiB,GAAG,SAAS,CA+BjE"}

package/dist/alerts/headless/client.js

@@ -0,0 +1,105 @@
+// =============================================================================
+// The alerts client (issue #1047): the `/api/admin/alerts` routes
+// =============================================================================
+//
+// Every route is a SYSTEM route: reads need `alerts:read`, writes (create,
+// edit, delete, test, acknowledge) need `alerts:write` (`ALERT_PERMISSIONS` of
+// `@marinoscar/platform-contract/alerts`). The transport (`PlatformApiClient`)
+// prefixes `/api` and unwraps the `{ data }` envelope. The API decides who may
+// do what; the client only builds paths.
+//
+// One route here is not the alerts slice's: the metric picker of the rule
+// editor reads the telemetry store's table list (`GET /admin/telemetry/schema`,
+// `telemetry:query`), the same list the telemetry explorer's schema panel
+// reads. It is read through the contract's wire type only, so the alerts web
+// slice does not depend on the telemetry web slice.
+// =============================================================================
+/**
+ * The route base of the alerts slice, relative to the API root (`/api`).
+ *
+ * @stability experimental
+ */
+export const ALERTS_BASE_PATH = '/admin/alerts';
+/**
+ * The telemetry route the metric picker reads (relative to `/api`).
+ *
+ * @stability experimental
+ */
+export const ALERTS_METRIC_CATALOG_PATH = '/admin/telemetry/schema';
+/** Columns of a metric table that are never a `groupBy` or filter candidate. */
+const NON_ATTRIBUTE_COLUMNS = new Set(['greptime_value', 'greptime_timestamp', 'val', 'ts', 'timestamp']);
+/** Tables of the store that are traces or logs, not metrics. */
+function isMetricTable(name) {
+    return !name.startsWith('opentelemetry_') && !name.startsWith('information_schema');
+}
+/**
+ * The store's table list as the metric picker's entries: the metric tables
+ * (not the trace and log tables), each with its attribute columns, sorted by
+ * name.
+ *
+ * @param schema - what `GET /admin/telemetry/schema` returned.
+ * @returns the entries.
+ *
+ * @stability experimental
+ */
+export function metricCatalogFromSchema(schema) {
+    return schema.tables
+        .filter((table) => isMetricTable(table.name))
+        .map((table) => ({
+        name: table.name,
+        attributes: table.columns.map((column) => column.name).filter((name) => !NON_ATTRIBUTE_COLUMNS.has(name)),
+    }))
+        .sort((a, b) => a.name.localeCompare(b.name));
+}
+function queryString(params) {
+    const search = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        if (value === undefined || value === '')
+            continue;
+        search.set(key, String(value));
+    }
+    const text = search.toString();
+    return text === '' ? '' : `?${text}`;
+}
+/**
+ * The alerts client over the app's transport.
+ *
+ * @param api - the app's transport (`usePlatformApi()`).
+ * @returns the client.
+ *
+ * @example
+ * ```ts
+ * const alerts = createAlertsApi(usePlatformApi());
+ * const { firing } = await alerts.summary();
+ * ```
+ *
+ * @extensionPoint hook
+ * @stability experimental
+ */
+export function createAlertsApi(api) {
+    const rule = (id) => `${ALERTS_BASE_PATH}/rules/${encodeURIComponent(id)}`;
+    const incident = (id) => `${ALERTS_BASE_PATH}/incidents/${encodeURIComponent(id)}`;
+    return {
+        listRules: (query = {}) => api.get(`${ALERTS_BASE_PATH}/rules${queryString({ kind: query.kind, severity: query.severity, enabled: query.enabled })}`),
+        getRule: (id) => api.get(rule(id)),
+        createRule: (input) => api.post(`${ALERTS_BASE_PATH}/rules`, input),
+        updateRule: (id, patch) => api.patch(rule(id), patch),
+        deleteRule: async (id) => {
+            await api.delete(rule(id));
+        },
+        testRule: (id) => api.post(`${rule(id)}/test`),
+        listKinds: () => api.get(`${ALERTS_BASE_PATH}/kinds`),
+        listIncidents: (query = {}) => api.get(`${ALERTS_BASE_PATH}/incidents${queryString({
+            state: query.state,
+            severity: query.severity,
+            ruleId: query.ruleId,
+            page: query.page,
+            pageSize: query.pageSize,
+        })}`),
+        getIncident: (id) => api.get(incident(id)),
+        acknowledge: (id) => api.post(`${incident(id)}/acknowledge`),
+        summary: () => api.get(`${ALERTS_BASE_PATH}/summary`),
+        metricCatalog: async () => metricCatalogFromSchema(await api.get(ALERTS_METRIC_CATALOG_PATH)),
+    };
+}
+//# sourceMappingURL=client.js.map

package/dist/alerts/headless/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/alerts/headless/client.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,kEAAkE;AAClE,gFAAgF;AAChF,EAAE;AACF,2EAA2E;AAC3E,+EAA+E;AAC/E,+EAA+E;AAC/E,+EAA+E;AAC/E,yCAAyC;AACzC,EAAE;AACF,0EAA0E;AAC1E,gFAAgF;AAChF,0EAA0E;AAC1E,6EAA6E;AAC7E,oDAAoD;AACpD,gFAAgF;AAiBhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAEhD;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAkGpE,gFAAgF;AAChF,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;AAE1G,gEAAgE;AAChE,SAAS,aAAa,CAAC,IAAY;IACjC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;AACtF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAuC;IAC7E,OAAO,MAAM,CAAC,MAAM;SACjB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC5C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;KAC1G,CAAC,CAAC;SACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,WAAW,CAAC,MAA6D;IAChF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE;YAAE,SAAS;QAClD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC/B,OAAO,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAAC,GAAsB;IACpD,MAAM,IAAI,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,GAAG,gBAAgB,UAAU,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;IACnF,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,GAAG,gBAAgB,cAAc,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;IAC3F,OAAO;QACL,SAAS,EAAE,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CACxB,GAAG,CAAC,GAAG,CACL,GAAG,gBAAgB,SAAS,WAAW,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,CAClH;QACH,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAY,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAY,GAAG,gBAAgB,QAAQ,EAAE,KAAK,CAAC;QAC9E,UAAU,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAY,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;QAChE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YACvB,MAAM,GAAG,CAAC,MAAM,CAAU,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC;QACD,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAwB,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC;QACrE,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAc,GAAG,gBAAgB,QAAQ,CAAC;QAClE,aAAa,EAAE,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAC5B,GAAG,CAAC,GAAG,CACL,GAAG,gBAAgB,aAAa,WAAW,CAAC;YAC1C,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,EAAE,CACL;QACH,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAgB,QAAQ,CAAC,EAAE,CAAC,CAAC;QACzD,WAAW,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAgB,GAAG,QAAQ,CAAC,EAAE,CAAC,cAAc,CAAC;QAC3E,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAe,GAAG,gBAAgB,UAAU,CAAC;QACnE,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,GAAG,CAAkB,0BAA0B,CAAC,CAAC;KAC/G,CAAC;AACJ,CAAC"}

package/dist/alerts/headless/format.d.ts

@@ -0,0 +1,95 @@
+import type { AlertAggregation, AlertComparator, AlertIncidentState, AlertSeverity, AlertSummary } from '@marinoscar/platform-contract/alerts';
+/**
+ * A status tone, mapped to an MUI colour by the UI. The words carry the
+ * meaning; the tone only reinforces it.
+ *
+ * @stability experimental
+ */
+export type AlertTone = 'error' | 'warning' | 'info' | 'success' | 'default';
+/**
+ * Each severity in words.
+ *
+ * @stability experimental
+ */
+export declare const ALERT_SEVERITY_LABELS: Readonly<Record<AlertSeverity, string>>;
+/**
+ * The tone of each severity.
+ *
+ * @stability experimental
+ */
+export declare const ALERT_SEVERITY_TONES: Readonly<Record<AlertSeverity, AlertTone>>;
+/**
+ * Each incident state in words.
+ *
+ * @stability experimental
+ */
+export declare const ALERT_STATE_LABELS: Readonly<Record<AlertIncidentState, string>>;
+/**
+ * The tone of each incident state.
+ *
+ * @stability experimental
+ */
+export declare const ALERT_STATE_TONES: Readonly<Record<AlertIncidentState, AlertTone>>;
+/**
+ * Each comparator in words and as a symbol.
+ *
+ * @stability experimental
+ */
+export declare const ALERT_COMPARATOR_LABELS: Readonly<Record<AlertComparator, string>>;
+/**
+ * Each aggregation in words.
+ *
+ * @stability experimental
+ */
+export declare const ALERT_AGGREGATION_LABELS: Readonly<Record<AlertAggregation, string>>;
+/**
+ * A kind id in words: the label `GET /kinds` gave, else the built-in label,
+ * else the id itself.
+ *
+ * @param kind - the kind id.
+ * @param kinds - the registered kinds, when loaded.
+ * @returns the label.
+ *
+ * @stability experimental
+ */
+export declare function alertKindLabel(kind: string, kinds?: ReadonlyArray<{
+    id: string;
+    label: string;
+}>): string;
+/**
+ * The firing count of a summary, in total.
+ *
+ * @param summary - `GET /admin/alerts/summary`.
+ * @returns critical + warning + info.
+ *
+ * @stability experimental
+ */
+export declare function alertFiringTotal(summary: Pick<AlertSummary, 'firing'> | null | undefined): number;
+/**
+ * The most serious severity that has a firing incident, or `null`.
+ *
+ * @param summary - `GET /admin/alerts/summary`.
+ * @returns the severity.
+ *
+ * @stability experimental
+ */
+export declare function alertTopSeverity(summary: Pick<AlertSummary, 'firing'> | null | undefined): AlertSeverity | null;
+/**
+ * An incident's labels as `key=value` text, in key order; `''` for none.
+ *
+ * @param labels - the labels.
+ * @returns the text.
+ *
+ * @stability experimental
+ */
+export declare function formatAlertLabels(labels: Readonly<Record<string, string>>): string;
+/**
+ * A duration in seconds as short words (`90` is `1 min 30 s`, `3600` is `1 h`).
+ *
+ * @param seconds - whole seconds.
+ * @returns the text.
+ *
+ * @stability experimental
+ */
+export declare function formatAlertSeconds(seconds: number): string;
+//# sourceMappingURL=format.d.ts.map

package/dist/alerts/headless/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../src/alerts/headless/format.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,YAAY,EACb,MAAM,sCAAsC,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAIxE,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,SAAS,CAAC,CAI1E,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAI1E,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAI5E,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,CAO5E,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAO9E,CAAC;AAUH;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,aAAa,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAM,GAAG,MAAM,CAE7G;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,CAGjG;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,aAAa,GAAG,IAAI,CAM/G;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAKlF;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAY1D"}

package/dist/alerts/headless/format.js

@@ -0,0 +1,164 @@
+// =============================================================================
+// Alerts in words (issue #1047): labels for severities, states, comparators,
+// aggregations and kinds, and the summary's totals. Pure; no React.
+// =============================================================================
+import { ALERT_KIND_IDS } from '@marinoscar/platform-contract/alerts';
+/**
+ * Each severity in words.
+ *
+ * @stability experimental
+ */
+export const ALERT_SEVERITY_LABELS = Object.freeze({
+    critical: 'Critical',
+    warning: 'Warning',
+    info: 'Info',
+});
+/**
+ * The tone of each severity.
+ *
+ * @stability experimental
+ */
+export const ALERT_SEVERITY_TONES = Object.freeze({
+    critical: 'error',
+    warning: 'warning',
+    info: 'info',
+});
+/**
+ * Each incident state in words.
+ *
+ * @stability experimental
+ */
+export const ALERT_STATE_LABELS = Object.freeze({
+    pending: 'Pending',
+    firing: 'Firing',
+    resolved: 'Resolved',
+});
+/**
+ * The tone of each incident state.
+ *
+ * @stability experimental
+ */
+export const ALERT_STATE_TONES = Object.freeze({
+    pending: 'warning',
+    firing: 'error',
+    resolved: 'success',
+});
+/**
+ * Each comparator in words and as a symbol.
+ *
+ * @stability experimental
+ */
+export const ALERT_COMPARATOR_LABELS = Object.freeze({
+    gt: 'greater than (>)',
+    gte: 'at least (≥)',
+    lt: 'less than (<)',
+    lte: 'at most (≤)',
+    eq: 'equal to (=)',
+    neq: 'not equal to (≠)',
+});
+/**
+ * Each aggregation in words.
+ *
+ * @stability experimental
+ */
+export const ALERT_AGGREGATION_LABELS = Object.freeze({
+    avg: 'Average',
+    max: 'Maximum',
+    min: 'Minimum',
+    sum: 'Sum',
+    last: 'Last value',
+    rate: 'Rate per minute',
+});
+const BUILTIN_KIND_LABELS = Object.freeze({
+    [ALERT_KIND_IDS.METRIC_THRESHOLD]: 'Metric threshold',
+    [ALERT_KIND_IDS.NODE_EVENT]: 'Node event',
+    [ALERT_KIND_IDS.VERDICT]: 'Dashboard verdict',
+    [ALERT_KIND_IDS.NODE_OFFLINE]: 'Node offline',
+    [ALERT_KIND_IDS.TELEMETRY_UNAVAILABLE]: 'Telemetry unavailable',
+});
+/**
+ * A kind id in words: the label `GET /kinds` gave, else the built-in label,
+ * else the id itself.
+ *
+ * @param kind - the kind id.
+ * @param kinds - the registered kinds, when loaded.
+ * @returns the label.
+ *
+ * @stability experimental
+ */
+export function alertKindLabel(kind, kinds = []) {
+    return kinds.find((entry) => entry.id === kind)?.label ?? BUILTIN_KIND_LABELS[kind] ?? kind;
+}
+/**
+ * The firing count of a summary, in total.
+ *
+ * @param summary - `GET /admin/alerts/summary`.
+ * @returns critical + warning + info.
+ *
+ * @stability experimental
+ */
+export function alertFiringTotal(summary) {
+    if (!summary)
+        return 0;
+    return summary.firing.critical + summary.firing.warning + summary.firing.info;
+}
+/**
+ * The most serious severity that has a firing incident, or `null`.
+ *
+ * @param summary - `GET /admin/alerts/summary`.
+ * @returns the severity.
+ *
+ * @stability experimental
+ */
+export function alertTopSeverity(summary) {
+    if (!summary)
+        return null;
+    if (summary.firing.critical > 0)
+        return 'critical';
+    if (summary.firing.warning > 0)
+        return 'warning';
+    if (summary.firing.info > 0)
+        return 'info';
+    return null;
+}
+/**
+ * An incident's labels as `key=value` text, in key order; `''` for none.
+ *
+ * @param labels - the labels.
+ * @returns the text.
+ *
+ * @stability experimental
+ */
+export function formatAlertLabels(labels) {
+    return Object.keys(labels)
+        .sort()
+        .map((key) => `${key}=${labels[key]}`)
+        .join(', ');
+}
+/**
+ * A duration in seconds as short words (`90` is `1 min 30 s`, `3600` is `1 h`).
+ *
+ * @param seconds - whole seconds.
+ * @returns the text.
+ *
+ * @stability experimental
+ */
+export function formatAlertSeconds(seconds) {
+    if (seconds <= 0)
+        return '0 s';
+    const parts = [];
+    const days = Math.floor(seconds / 86_400);
+    const hours = Math.floor((seconds % 86_400) / 3600);
+    const minutes = Math.floor((seconds % 3600) / 60);
+    const rest = seconds % 60;
+    if (days)
+        parts.push(`${days} d`);
+    if (hours)
+        parts.push(`${hours} h`);
+    if (minutes)
+        parts.push(`${minutes} min`);
+    if (rest)
+        parts.push(`${rest} s`);
+    return parts.join(' ');
+}
+//# sourceMappingURL=format.js.map

package/dist/alerts/headless/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/alerts/headless/format.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,6EAA6E;AAC7E,oEAAoE;AACpE,gFAAgF;AAEhF,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AAiBtE;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA4C,MAAM,CAAC,MAAM,CAAC;IAC1F,QAAQ,EAAE,UAAU;IACpB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;CACb,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAA+C,MAAM,CAAC,MAAM,CAAC;IAC5F,QAAQ,EAAE,OAAO;IACjB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;CACb,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAiD,MAAM,CAAC,MAAM,CAAC;IAC5F,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACrB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAoD,MAAM,CAAC,MAAM,CAAC;IAC9F,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,OAAO;IACf,QAAQ,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAA8C,MAAM,CAAC,MAAM,CAAC;IAC9F,EAAE,EAAE,kBAAkB;IACtB,GAAG,EAAE,cAAc;IACnB,EAAE,EAAE,eAAe;IACnB,GAAG,EAAE,aAAa;IAClB,EAAE,EAAE,cAAc;IAClB,GAAG,EAAE,kBAAkB;CACxB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAA+C,MAAM,CAAC,MAAM,CAAC;IAChG,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,iBAAiB;CACxB,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAqC,MAAM,CAAC,MAAM,CAAC;IAC1E,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;IACrD,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,YAAY;IACzC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,mBAAmB;IAC7C,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,cAAc;IAC7C,CAAC,cAAc,CAAC,qBAAqB,CAAC,EAAE,uBAAuB;CAChE,CAAC,CAAC;AAEH;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,QAAsD,EAAE;IACnG,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AAC9F,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAwD;IACvF,IAAI,CAAC,OAAO;QAAE,OAAO,CAAC,CAAC;IACvB,OAAO,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;AAChF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAwD;IACvF,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC;QAAE,OAAO,UAAU,CAAC;IACnD,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACjD,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC;QAAE,OAAO,MAAM,CAAC;IAC3C,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAwC;IACxE,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACvB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;SACrC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAChD,IAAI,OAAO,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,OAAO,GAAG,EAAE,CAAC;IAC1B,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IAClC,IAAI,KAAK;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;IACpC,IAAI,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;IAC1C,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;IAClC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC"}