@marinoscar/platform-web 0.0.0-stage → 0.1.0-next.4

package/dist/telemetry/headless/lib/dashboardState.js

@@ -0,0 +1,153 @@
+/**
+ * The Telemetry Dashboard's URL state — issue #578, epic #576.
+ *
+ * Everything a reader might want to share or come back to lives in the query
+ * string, so a link reproduces the view:
+ *
+ *   ?range=15m|1h|6h|24h|7d   relative window (default 1h)
+ *   &from=…&to=…              absolute window (a zoom); wins over `range`
+ *   &service=…&instance=…     filters (values from `/filters`)
+ *   &host=…                   host filter for the infrastructure sections only (#602)
+ *   &sev=error,warn,info      severities for the log panels (default error,warn)
+ *   &q=…                      events search (≤ 200 characters)
+ *   &refresh=30|off           auto-refresh (default 30 s)
+ *
+ * Anything invalid falls back to its default rather than erroring: a mangled
+ * link still opens a working dashboard. Defaults are left OUT of the URL, so
+ * the plain route is the default view. `range` is kept alongside a zoom so
+ * "Reset zoom" returns to the preset the reader zoomed from.
+ */
+import { DASHBOARD_FILTER_VALUE_MAX, DASHBOARD_MAX_SPAN_MS, DASHBOARD_RANGES, DASHBOARD_RANGE_MS, DASHBOARD_SEARCH_MAX_LENGTH, DASHBOARD_SEVERITIES, DEFAULT_DASHBOARD_RANGE, DEFAULT_DASHBOARD_SEVERITIES, } from '../services/telemetryDashboard.js';
+export const DASHBOARD_REFRESH_MS = 30_000;
+export const DEFAULT_DASHBOARD_STATE = {
+    range: DEFAULT_DASHBOARD_RANGE,
+    from: null,
+    to: null,
+    service: null,
+    instance: null,
+    host: null,
+    sev: [...DEFAULT_DASHBOARD_SEVERITIES],
+    q: '',
+    refresh: true,
+};
+function isRange(value) {
+    return value !== null && DASHBOARD_RANGES.includes(value);
+}
+function filterValue(value) {
+    if (value === null)
+        return null;
+    const trimmed = value.trim();
+    return trimmed && trimmed.length <= DASHBOARD_FILTER_VALUE_MAX ? trimmed : null;
+}
+/** Severities in canonical order, deduplicated; `null` when none is valid. */
+export function parseSeverities(value) {
+    if (!value)
+        return null;
+    const wanted = new Set(value.split(',').map((part) => part.trim().toLowerCase()));
+    const picked = DASHBOARD_SEVERITIES.filter((severity) => wanted.has(severity));
+    return picked.length > 0 ? picked : null;
+}
+function parseWindow(from, to) {
+    if (!from || !to)
+        return null;
+    const start = Date.parse(from);
+    const end = Date.parse(to);
+    if (!Number.isFinite(start) || !Number.isFinite(end))
+        return null;
+    if (!(start < end) || end - start > DASHBOARD_MAX_SPAN_MS)
+        return null;
+    return { from: new Date(start).toISOString(), to: new Date(end).toISOString() };
+}
+export function parseDashboardState(params) {
+    const range = params.get('range');
+    const window = parseWindow(params.get('from'), params.get('to'));
+    const q = params.get('q') ?? '';
+    return {
+        range: isRange(range) ? range : DEFAULT_DASHBOARD_STATE.range,
+        from: window?.from ?? null,
+        to: window?.to ?? null,
+        service: filterValue(params.get('service')),
+        instance: filterValue(params.get('instance')),
+        host: filterValue(params.get('host')),
+        sev: parseSeverities(params.get('sev')) ?? [...DEFAULT_DASHBOARD_SEVERITIES],
+        q: q.slice(0, DASHBOARD_SEARCH_MAX_LENGTH),
+        refresh: params.get('refresh') !== 'off',
+    };
+}
+function sameSeverities(a, b) {
+    return a.length === b.length && a.every((severity, index) => severity === b[index]);
+}
+/** The query string for `state`, defaults omitted. */
+export function dashboardStateToParams(state) {
+    const params = new URLSearchParams();
+    if (state.range !== DEFAULT_DASHBOARD_STATE.range)
+        params.set('range', state.range);
+    if (state.from && state.to) {
+        params.set('from', state.from);
+        params.set('to', state.to);
+    }
+    if (state.service)
+        params.set('service', state.service);
+    if (state.instance)
+        params.set('instance', state.instance);
+    if (state.host)
+        params.set('host', state.host);
+    const sev = DASHBOARD_SEVERITIES.filter((severity) => state.sev.includes(severity));
+    if (sev.length > 0 && !sameSeverities(sev, DEFAULT_DASHBOARD_SEVERITIES)) {
+        params.set('sev', sev.join(','));
+    }
+    if (state.q)
+        params.set('q', state.q.slice(0, DASHBOARD_SEARCH_MAX_LENGTH));
+    if (!state.refresh)
+        params.set('refresh', 'off');
+    return params;
+}
+export function isZoomed(state) {
+    return state.from !== null && state.to !== null;
+}
+/** The window + filter half of the API query, shared by every panel. */
+export function dashboardQuery(state) {
+    const query = isZoomed(state)
+        ? { from: state.from, to: state.to }
+        : { range: state.range };
+    if (state.service)
+        query.service = state.service;
+    if (state.instance)
+        query.instance = state.instance;
+    return query;
+}
+/** The `/metrics` query: the shared window and filters plus `host`, which only `/metrics` takes. */
+export function metricsQuery(state) {
+    const query = dashboardQuery(state);
+    if (state.host)
+        query.host = state.host;
+    return query;
+}
+/**
+ * The absolute window covering buckets `startIndex..endIndex` (inclusive, any
+ * order) of a series whose buckets start at `starts` and last `bucketSeconds`.
+ * `to` is clamped to `now`, since the API refuses a window ending more than a
+ * minute ahead. `null` when the selection is empty.
+ */
+export function bucketWindow(starts, bucketSeconds, startIndex, endIndex, now = Date.now()) {
+    if (starts.length === 0)
+        return null;
+    const clamp = (index) => Math.min(Math.max(index, 0), starts.length - 1);
+    const first = clamp(Math.min(startIndex, endIndex));
+    const last = clamp(Math.max(startIndex, endIndex));
+    const from = Date.parse(starts[first]);
+    const bucketEnd = Date.parse(starts[last]) + bucketSeconds * 1000;
+    if (!Number.isFinite(from) || !Number.isFinite(bucketEnd))
+        return null;
+    const to = Math.min(bucketEnd, now);
+    if (!(from < to))
+        return null;
+    return { from: new Date(from).toISOString(), to: new Date(to).toISOString() };
+}
+/** The window's span in ms — for labels and tick formatting. */
+export function windowSpanMs(state) {
+    if (state.from && state.to)
+        return Date.parse(state.to) - Date.parse(state.from);
+    return DASHBOARD_RANGE_MS[state.range];
+}
+//# sourceMappingURL=dashboardState.js.map

package/dist/telemetry/headless/lib/dashboardState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dashboardState.js","sourceRoot":"","sources":["../../../../src/telemetry/headless/lib/dashboardState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,gBAAgB,EAChB,kBAAkB,EAClB,2BAA2B,EAC3B,oBAAoB,EACpB,uBAAuB,EACvB,4BAA4B,GAK7B,MAAM,mCAAmC,CAAC;AAE3C,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;AA6B3C,MAAM,CAAC,MAAM,uBAAuB,GAAmB;IACrD,KAAK,EAAE,uBAAuB;IAC9B,IAAI,EAAE,IAAI;IACV,EAAE,EAAE,IAAI;IACR,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,CAAC,GAAG,4BAA4B,CAAC;IACtC,CAAC,EAAE,EAAE;IACL,OAAO,EAAE,IAAI;CACd,CAAC;AAEF,SAAS,OAAO,CAAC,KAAoB;IACnC,OAAO,KAAK,KAAK,IAAI,IAAK,gBAAsC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,WAAW,CAAC,KAAoB;IACvC,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,OAAO,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,0BAA0B,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;AAClF,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,eAAe,CAAC,KAAoB;IAClD,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAClF,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3C,CAAC;AAED,SAAS,WAAW,CAAC,IAAmB,EAAE,EAAiB;IACzD,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC;IAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAClE,IAAI,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,IAAI,GAAG,GAAG,KAAK,GAAG,qBAAqB;QAAE,OAAO,IAAI,CAAC;IACvE,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,MAAuB;IACzD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAChC,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,uBAAuB,CAAC,KAAK;QAC7D,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,IAAI;QAC1B,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,IAAI;QACtB,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC3C,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,4BAA4B,CAAC;QAC5E,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,2BAA2B,CAAC;QAC1C,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,KAAK;KACzC,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,CAAsB,EAAE,CAAsB;IACpE,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACtF,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,sBAAsB,CAAC,KAAqB;IAC1D,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,IAAI,KAAK,CAAC,KAAK,KAAK,uBAAuB,CAAC,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACpF,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;QAC3B,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO;QAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACxD,IAAI,KAAK,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAI,KAAK,CAAC,IAAI;QAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,GAAG,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpF,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,4BAA4B,CAAC,EAAE,CAAC;QACzE,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,KAAK,CAAC,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC,CAAC;IAC5E,IAAI,CAAC,KAAK,CAAC,OAAO;QAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAqB;IAC5C,OAAO,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC;AAClD,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,cAAc,CAAC,KAAqB;IAClD,MAAM,KAAK,GAAmB,QAAQ,CAAC,KAAK,CAAC;QAC3C,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAc,EAAE,EAAE,EAAE,KAAK,CAAC,EAAY,EAAE;QACxD,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;IAC3B,IAAI,KAAK,CAAC,OAAO;QAAE,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IACjD,IAAI,KAAK,CAAC,QAAQ;QAAE,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACpD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,YAAY,CAAC,KAAqB;IAChD,MAAM,KAAK,GAA0B,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3D,IAAI,KAAK,CAAC,IAAI;QAAE,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAgB,EAChB,aAAqB,EACrB,UAAkB,EAClB,QAAgB,EAChB,MAAc,IAAI,CAAC,GAAG,EAAE;IAExB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACrC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACjF,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IACnD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAE,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC,GAAG,aAAa,GAAG,IAAI,CAAC;IACnE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IACvE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IACpC,IAAI,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9B,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;AAChF,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,YAAY,CAAC,KAAqB;IAChD,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACjF,OAAO,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC"}

package/dist/telemetry/headless/lib/explorerHandoff.d.ts

@@ -0,0 +1,62 @@
+/**
+ * The Telemetry Explorer's route (the `Telemetry Explorer` card's path).
+ *
+ * @stability experimental
+ */
+export declare const TELEMETRY_EXPLORER_PATH = "/admin/settings/telemetry/explorer";
+/**
+ * The Telemetry Dashboard's route (the `Telemetry Dashboard` card's path).
+ *
+ * @stability experimental
+ */
+export declare const TELEMETRY_DASHBOARD_PATH = "/admin/settings/telemetry/dashboard";
+/**
+ * The Telemetry settings page's route (the `Telemetry` card's path).
+ *
+ * @stability experimental
+ */
+export declare const TELEMETRY_SETTINGS_PATH = "/admin/settings/telemetry";
+/**
+ * The query parameter the explorer reads a handed statement from.
+ *
+ * @stability experimental
+ */
+export declare const EXPLORER_SQL_PARAM = "sql";
+/**
+ * The router state a page hands the explorer a statement in.
+ *
+ * @stability experimental
+ */
+export interface ExplorerHandoffState {
+    /** The statement to seed the editor with (never run on arrival). */
+    sql: string;
+}
+/**
+ * A statement the explorer would accept from a handoff, or `null`.
+ *
+ * @stability experimental
+ */
+export declare function acceptableHandoffSql(value: unknown): string | null;
+/**
+ * The `navigate()` arguments that open the explorer with `sql` in its editor.
+ *
+ * @stability experimental
+ */
+export declare function explorerHandoff(sql: string): {
+    to: string;
+    state: ExplorerHandoffState;
+};
+/**
+ * An explorer URL carrying `sql` as `?sql=` — for a link rather than a navigation.
+ *
+ * @stability experimental
+ */
+export declare function explorerSqlUrl(sql: string): string;
+/**
+ * The statement handed to the explorer on this navigation: `location.state.sql`
+ * first, then `?sql=`. `null` when there is none or it is not acceptable.
+ *
+ * @stability experimental
+ */
+export declare function readExplorerHandoff(state: unknown, params: URLSearchParams): string | null;
+//# sourceMappingURL=explorerHandoff.d.ts.map

package/dist/telemetry/headless/lib/explorerHandoff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explorerHandoff.d.ts","sourceRoot":"","sources":["../../../../src/telemetry/headless/lib/explorerHandoff.ts"],"names":[],"mappings":"AAeA;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,uCAAuC,CAAC;AAC5E;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,wCAAwC,CAAC;AAC9E;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,QAAQ,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAIlE;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,oBAAoB,CAAA;CAAE,CAExF;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,GAAG,MAAM,GAAG,IAAI,CAI1F"}

package/dist/telemetry/headless/lib/explorerHandoff.js

@@ -0,0 +1,77 @@
+/**
+ * Handing a SQL statement to the Telemetry Explorer — issue #579, epic #576.
+ *
+ * The Telemetry Dashboard's "Open in Explorer" and "View trace" navigate to the
+ * explorer with the statement in the router's `location.state` (`{ sql }`).
+ * A plain link can carry it instead as `?sql=<URL-encoded>` — the fallback for
+ * a bookmark or a link pasted from elsewhere; `state` wins when both are set.
+ *
+ * The explorer puts a handed statement in its editor and NEVER runs it: the
+ * reader reviews it and presses Run. Anything empty, not a string, or longer
+ * than {@link TELEMETRY_SQL_MAX_LENGTH} (what the API would refuse anyway) is
+ * ignored, and the explorer opens as usual.
+ */
+import { TELEMETRY_SQL_MAX_LENGTH } from '../services/telemetry.js';
+/**
+ * The Telemetry Explorer's route (the `Telemetry Explorer` card's path).
+ *
+ * @stability experimental
+ */
+export const TELEMETRY_EXPLORER_PATH = '/admin/settings/telemetry/explorer';
+/**
+ * The Telemetry Dashboard's route (the `Telemetry Dashboard` card's path).
+ *
+ * @stability experimental
+ */
+export const TELEMETRY_DASHBOARD_PATH = '/admin/settings/telemetry/dashboard';
+/**
+ * The Telemetry settings page's route (the `Telemetry` card's path).
+ *
+ * @stability experimental
+ */
+export const TELEMETRY_SETTINGS_PATH = '/admin/settings/telemetry';
+/**
+ * The query parameter the explorer reads a handed statement from.
+ *
+ * @stability experimental
+ */
+export const EXPLORER_SQL_PARAM = 'sql';
+/**
+ * A statement the explorer would accept from a handoff, or `null`.
+ *
+ * @stability experimental
+ */
+export function acceptableHandoffSql(value) {
+    if (typeof value !== 'string')
+        return null;
+    if (value.trim() === '' || value.length > TELEMETRY_SQL_MAX_LENGTH)
+        return null;
+    return value;
+}
+/**
+ * The `navigate()` arguments that open the explorer with `sql` in its editor.
+ *
+ * @stability experimental
+ */
+export function explorerHandoff(sql) {
+    return { to: TELEMETRY_EXPLORER_PATH, state: { sql } };
+}
+/**
+ * An explorer URL carrying `sql` as `?sql=` — for a link rather than a navigation.
+ *
+ * @stability experimental
+ */
+export function explorerSqlUrl(sql) {
+    return `${TELEMETRY_EXPLORER_PATH}?${new URLSearchParams({ [EXPLORER_SQL_PARAM]: sql })}`;
+}
+/**
+ * The statement handed to the explorer on this navigation: `location.state.sql`
+ * first, then `?sql=`. `null` when there is none or it is not acceptable.
+ *
+ * @stability experimental
+ */
+export function readExplorerHandoff(state, params) {
+    const fromState = typeof state === 'object' && state !== null ? acceptableHandoffSql(state.sql) : null;
+    return fromState ?? acceptableHandoffSql(params.get(EXPLORER_SQL_PARAM));
+}
+//# sourceMappingURL=explorerHandoff.js.map

package/dist/telemetry/headless/lib/explorerHandoff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explorerHandoff.js","sourceRoot":"","sources":["../../../../src/telemetry/headless/lib/explorerHandoff.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEpE;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,oCAAoC,CAAC;AAC5E;;;;GAIG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,qCAAqC,CAAC;AAC9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,2BAA2B,CAAC;AAEnE;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAYxC;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC3C,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,GAAG,wBAAwB;QAAE,OAAO,IAAI,CAAC;IAChF,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,OAAO,EAAE,EAAE,EAAE,uBAAuB,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW;IACxC,OAAO,GAAG,uBAAuB,IAAI,IAAI,eAAe,CAAC,EAAE,CAAC,kBAAkB,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;AAC5F,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAc,EAAE,MAAuB;IACzE,MAAM,SAAS,GACb,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAE,KAA2B,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9G,OAAO,SAAS,IAAI,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAC3E,CAAC"}

package/dist/telemetry/headless/lib/format.d.ts

@@ -0,0 +1,144 @@
+import type { MetricUnitDescriptor } from '@marinoscar/platform-contract/telemetry';
+/**
+ * A tile value as a number, or `null` (`int8` may arrive as a string).
+ *
+ * @stability experimental
+ */
+export declare function toNumber(value: number | string | null | undefined): number | null;
+/**
+ * A duration in milliseconds at a readable scale: `8.5 ms`, `120 ms`, `1.25 s`.
+ *
+ * @param ms - the duration in milliseconds.
+ * @returns the value and its unit, separated by a space.
+ *
+ * @stability experimental
+ */
+export declare function formatDuration(ms: number): string;
+/**
+ * A byte count in binary units: `512 B`, `1.5 KB`, `3.2 GB`.
+ *
+ * @param bytes - the count.
+ * @returns the value and its unit, separated by a space.
+ *
+ * @stability experimental
+ */
+export declare function formatBytes(bytes: number): string;
+/**
+ * A duration in seconds at a readable scale: `42 s`, `12.5 min`, `3.2 h`,
+ * `4.1 d` — a queue age of 5400 s reads better as 1.5 h.
+ *
+ * @stability experimental
+ */
+export declare function formatSeconds(seconds: number): string;
+/**
+ * How to format the units an app registered, by unit id: what
+ * `GET …/metric-groups` serves with each group (`units`). Built-in unit ids are
+ * never in it (the formatter below knows them), so a platform section formats
+ * exactly as it always did.
+ *
+ * @stability experimental
+ */
+export type MetricUnitFormats = ReadonlyMap<string, MetricUnitDescriptor>;
+/**
+ * The platform's own unit ids. A descriptor never overrides one of them.
+ *
+ * @stability experimental
+ */
+export declare const BUILTIN_UNIT_IDS: ReadonlySet<string>;
+/**
+ * `value` in an app's unit, split as `formatTileValue` splits: `number`
+ * (grouped digits, `decimals`, `suffix`), `percent`, `bytes`, `duration-ms`,
+ * `duration-s`, `currency` (the browser's `Intl` currency format; the whole
+ * amount is in `value`), and `text`, `boolean`, `timestamp` as the built-ins.
+ *
+ * @param value - the cell or tile value.
+ * @param unit - the descriptor of the unit.
+ * @param now - the clock, for `timestamp`.
+ * @returns the value and its unit text.
+ *
+ * @stability experimental
+ */
+export declare function formatWithDescriptor(value: number | string | null, unit: MetricUnitDescriptor, now?: number): {
+    /** The number or text, formatted. */
+    value: string;
+    /** The unit text shown beside it (empty when the format carries it). */
+    unit: string;
+};
+/**
+ * `value` and its unit, split so a tile can style them apart. Covers the
+ * summary's units (`req/min`, `%`, `ms`, `count`, `bytes`, `timestamp`) and
+ * every metric unit of `/metrics` (#601): `bytes/s`, `per_s`, `per_min`,
+ * `seconds`, `hours`, `days`, `cores`, `load`, `text` and `boolean`. An
+ * unknown unit is shown as given.
+ *
+ * @stability experimental
+ */
+export declare function formatTileValue(value: number | string | null, unit: string, now?: number, formats?: MetricUnitFormats): {
+    value: string;
+    unit: string;
+};
+/**
+ * A tile value or table cell as one string (`—` for nothing), e.g. `35.6%`, `1.2 GB`, `Yes`.
+ *
+ * @stability experimental
+ */
+export declare function formatMetricValue(value: number | string | boolean | null | undefined, unit: string, now?: number, formats?: MetricUnitFormats): string;
+/**
+ * "5s ago", "3m ago", "2h ago", "4d ago"; "just now" under a second.
+ *
+ * @stability experimental
+ */
+export declare function formatRelative(iso: string, now?: number): string;
+/**
+ * A readable absolute timestamp (local time, to the second).
+ *
+ * @stability experimental
+ */
+export declare function formatTimestamp(iso: string | null): string;
+/**
+ * A bucket's x-axis label: time of day, plus the date for multi-day spans.
+ *
+ * @stability experimental
+ */
+export declare function formatBucketLabel(iso: string, spanMs: number): string;
+/**
+ * Which direction is bad for a tile: up for errors and latency, none for
+ * traffic (more requests is neither good nor bad on its own).
+ *
+ * @stability experimental
+ */
+export type ChangeDirection = 'up-is-bad' | 'down-is-bad' | 'neutral';
+/**
+ * Whether a rising value is bad, good or neither for the tile `key`.
+ *
+ * @param key - the tile's key.
+ * @returns the tile's direction (`neutral` for an unknown key).
+ *
+ * @stability experimental
+ */
+export declare function tileDirection(key: string): ChangeDirection;
+/**
+ * A tile's change against the previous window of equal length.
+ *
+ * @stability experimental
+ */
+export interface TileChange {
+    /** Percent change, rounded; `null` when there is no comparable previous value. */
+    pct: number | null;
+    /** Which way the value moved. */
+    trend: 'up' | 'down' | 'flat';
+    /** How to colour it. */
+    tone: 'good' | 'bad' | 'neutral';
+}
+/**
+ * A tile's change against its previous value, toned by `direction`.
+ *
+ * @param value - the current value.
+ * @param previous - the previous window's value.
+ * @param direction - from {@link tileDirection}.
+ * @returns the change, its trend and its tone.
+ *
+ * @stability experimental
+ */
+export declare function tileChange(value: number | string | null, previous: number | string | null, direction: ChangeDirection): TileChange;
+//# sourceMappingURL=format.d.ts.map

package/dist/telemetry/headless/lib/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../../src/telemetry/headless/lib/format.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAEpF;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAIjF;AAKD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAGjD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CASjD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAOrD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAyC,CAAC;AAE3F;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAC7B,IAAI,EAAE,oBAAoB,EAC1B,GAAG,GAAE,MAAmB,GACvB;IACD,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;CACd,CA6CA;AAOD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAC7B,IAAI,EAAE,MAAM,EACZ,GAAG,GAAE,MAAmB,EACxB,OAAO,CAAC,EAAE,iBAAiB,GAC1B;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAmDjC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,EACnD,IAAI,EAAE,MAAM,EACZ,GAAG,GAAE,MAAmB,EACxB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,MAAM,CAQR;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,GAAE,MAAmB,GAAG,MAAM,CAW5E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAY1D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAQrE;AAED;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,aAAa,GAAG,SAAS,CAAC;AAuCtE;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAE1D;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,kFAAkF;IAClF,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,iCAAiC;IACjC,KAAK,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC;IAC9B,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;CAClC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAC7B,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAChC,SAAS,EAAE,eAAe,GACzB,UAAU,CAeZ"}