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

package/dist/telemetry/headless/services/client.d.ts

@@ -0,0 +1,153 @@
+/**
+ * The telemetry API client (issues #537, #558, #567, #578, #680; packaged by
+ * #704).
+ *
+ * Every call goes through the app's transport (`PlatformApiClient`, the
+ * `@marinoscar/platform-web/core` port): the auth header, the token refresh
+ * and the maintenance handling stay in the app. Paths are relative to the API
+ * base. The routes and the permission each one enforces:
+ *
+ *   - `GET  /telemetry/config`                  (any signed-in user)
+ *   - `GET  /admin/telemetry/config`            (`telemetry:read`)
+ *   - `PUT  /admin/telemetry/config`            (`telemetry:write`, If-Match)
+ *   - `GET  /admin/telemetry/status`            (`telemetry:read`)
+ *   - `GET|PUT|DELETE /admin/telemetry/connection`, `POST …/connection/test`
+ *                                               (`telemetry:read` / `telemetry:write`)
+ *   - `GET|PUT /admin/telemetry/store`          (`telemetry:read` / `telemetry:write`)
+ *   - `GET  /admin/telemetry/stack`, `POST …/stack/deploy`
+ *                                               (`system_settings:read` / `system_settings:write`)
+ *   - `POST /admin/telemetry/query`, `GET …/schema`, `POST …/export`
+ *                                               (`telemetry:query`)
+ *   - `POST /admin/telemetry/assistant/stream`  (`telemetry:query` + `ai:use`)
+ *   - `GET  /admin/telemetry/dashboard/*`       (`telemetry:query`)
+ *
+ * The browser only presents and collects. Whether a statement is read-only,
+ * how many rows it may return and how long it may run are decided by the API.
+ */
+import type { PlatformApiClient } from '../../../core/index.js';
+import type { TelemetryAdminConfig, TelemetryAssistantHandlers, TelemetryAssistantRequest, TelemetryConnection, TelemetryConnectionInput, TelemetryConnectionTestResult, TelemetryExportFormat, TelemetryExportResult, TelemetryPublicConfig, TelemetryQueryResult, TelemetrySchema, TelemetrySettingsUpdate, TelemetryStack, TelemetryStatus, TelemetryStoreConfig, TelemetryStoreInput } from './telemetry.js';
+import type { DashboardEvents, DashboardEventsQuery, DashboardFilters, DashboardMetricGroup, DashboardMetricGroupMeta, DashboardMetrics, DashboardMetricsQuery, DashboardPanelData, DashboardPanelMeta, DashboardQuery, DashboardSummary, DashboardTimeseries, DashboardTimeseriesPanel, DashboardTop, DashboardTopKind } from './telemetryDashboard.js';
+/**
+ * Options a dashboard read takes.
+ *
+ * @stability experimental
+ */
+export interface TelemetryRequestOptions {
+    /** Aborts the request (a superseded range, an unmount). */
+    signal?: AbortSignal;
+}
+/**
+ * The telemetry routes as methods. Build one with
+ * {@link createTelemetryClient}; inside a page, {@link useTelemetryClient}
+ * builds it from the platform host.
+ *
+ * @stability experimental
+ */
+export interface TelemetryClient {
+    /** `GET /telemetry/config`: the feature flag every signed-in client reads. */
+    getTelemetryConfig(): Promise<TelemetryPublicConfig>;
+    /** `GET /admin/telemetry/config`: the settings plus provenance. */
+    getTelemetryAdminConfig(): Promise<TelemetryAdminConfig>;
+    /**
+     * `PUT /admin/telemetry/config`. `expectedVersion` travels as `If-Match`; a
+     * stale version answers 409.
+     */
+    updateTelemetryAdminConfig(settings: TelemetrySettingsUpdate, expectedVersion?: number): Promise<TelemetryAdminConfig>;
+    /** `GET /admin/telemetry/status`: a diagnosis, always 200. */
+    getTelemetryStatus(): Promise<TelemetryStatus>;
+    /** `GET /admin/telemetry/connection`. */
+    getTelemetryConnection(): Promise<TelemetryConnection>;
+    /** `PUT /admin/telemetry/connection`, `If-Match` from `expectedVersion`. */
+    updateTelemetryConnection(input: TelemetryConnectionInput, expectedVersion?: number): Promise<TelemetryConnection>;
+    /** `DELETE /admin/telemetry/connection`: the deployment default (or none) is in force again. */
+    resetTelemetryConnection(expectedVersion?: number): Promise<TelemetryConnection>;
+    /** `POST /admin/telemetry/connection/test`: a diagnosis, always 200. */
+    testTelemetryConnection(input: TelemetryConnectionInput): Promise<TelemetryConnectionTestResult>;
+    /** `GET /admin/telemetry/store`: the active store and, for a generated-form store, its descriptor and settings. */
+    getTelemetryStore(): Promise<TelemetryStoreConfig>;
+    /** `PUT /admin/telemetry/store`, `If-Match` from `expectedVersion`: the store's settings and write-only secrets. */
+    updateTelemetryStore(input: TelemetryStoreInput, expectedVersion?: number): Promise<TelemetryStoreConfig>;
+    /** `GET /admin/telemetry/stack`. */
+    getTelemetryStack(): Promise<TelemetryStack>;
+    /** `POST /admin/telemetry/stack/deploy`: enqueue a (re)deploy of the telemetry services. */
+    deployTelemetryStack(): Promise<TelemetryStackDeployAccepted>;
+    /** `POST /admin/telemetry/query`. */
+    runTelemetryQuery(sql: string, options?: {
+        maxRows?: number;
+        signal?: AbortSignal;
+    }): Promise<TelemetryQueryResult>;
+    /** `GET /admin/telemetry/schema`. */
+    getTelemetrySchema(): Promise<TelemetrySchema>;
+    /**
+     * `POST /admin/telemetry/export`: fetched as a Blob through the app's
+     * transport, then handed to the browser as a download named by
+     * `Content-Disposition`. Resolves with the filename and the
+     * row-count/truncation headers. Rejects when the transport has no
+     * `postBlob`.
+     */
+    exportTelemetry(sql: string, format: TelemetryExportFormat): Promise<TelemetryExportResult>;
+    /**
+     * Stream one assistant turn. Resolves when the stream ends (or quietly on
+     * abort). Rejects with a `PlatformApiError` when a gate refused the request
+     * before the first byte (`TELEMETRY_ASSISTANT_DISABLED`, `AI_DISABLED`, ...),
+     * and when the transport has no `postSse`.
+     */
+    streamTelemetryAssistant(request: TelemetryAssistantRequest, handlers?: TelemetryAssistantHandlers): Promise<void>;
+    /** `GET …/dashboard/summary`. */
+    getDashboardSummary(query: DashboardQuery, options?: TelemetryRequestOptions): Promise<DashboardSummary>;
+    /** `GET …/dashboard/timeseries?panel=…`. */
+    getDashboardTimeseries<P extends DashboardTimeseriesPanel>(panel: P, query: DashboardQuery, options?: TelemetryRequestOptions): Promise<DashboardTimeseries<P>>;
+    /** `GET …/dashboard/top?kind=…`. */
+    getDashboardTop<K extends DashboardTopKind>(kind: K, query: DashboardQuery, options?: TelemetryRequestOptions): Promise<DashboardTop<K>>;
+    /** `GET …/dashboard/events`. */
+    getDashboardEvents(query: DashboardEventsQuery, options?: TelemetryRequestOptions): Promise<DashboardEvents>;
+    /** `GET …/dashboard/filters`. */
+    getDashboardFilters(query: DashboardQuery, options?: TelemetryRequestOptions): Promise<DashboardFilters>;
+    /** `GET …/dashboard/metrics?group=…`: one metric group's tiles, series and tables. */
+    getDashboardMetrics(group: DashboardMetricGroup, query: DashboardMetricsQuery, options?: TelemetryRequestOptions): Promise<DashboardMetrics>;
+    /**
+     * `GET …/dashboard/metric-groups`: every registered metric group, in
+     * dashboard order (the platform's and the app's own).
+     */
+    getDashboardMetricGroups(options?: TelemetryRequestOptions): Promise<DashboardMetricGroupMeta[]>;
+    /** `GET …/dashboard/panels`: every registered dashboard panel (the platform's `api` and `logs`, and the app's), in dashboard order. */
+    getDashboardPanels(options?: TelemetryRequestOptions): Promise<DashboardPanelMeta[]>;
+    /** `GET …/dashboard/panels/:id`: one app panel's payload for the dashboard window. */
+    getDashboardPanel(id: string, query: DashboardQuery, options?: TelemetryRequestOptions): Promise<DashboardPanelData>;
+}
+/**
+ * What `POST /admin/telemetry/stack/deploy` answers (202).
+ *
+ * @stability experimental
+ */
+export interface TelemetryStackDeployAccepted {
+    /** The queued `telemetry.stack.deploy` job. */
+    jobId: string;
+}
+/**
+ * The telemetry routes over the app's transport.
+ *
+ * @param api - the app's transport (`usePlatformApi()`, or any `PlatformApiClient`).
+ * @returns a {@link TelemetryClient}.
+ *
+ * @example
+ * ```ts
+ * const telemetry = createTelemetryClient(host.api);
+ * const status = await telemetry.getTelemetryStatus();
+ * ```
+ *
+ * @stability experimental
+ */
+export declare function createTelemetryClient(api: PlatformApiClient): TelemetryClient;
+/**
+ * The telemetry client over the platform host's transport, memoised on it (a
+ * stable transport gives a stable client, so hooks keyed on it never refetch
+ * on a re-render).
+ *
+ * @returns a {@link TelemetryClient}.
+ * @throws Error outside a `PlatformHostProvider`.
+ *
+ * @stability experimental
+ */
+export declare function useTelemetryClient(): TelemetryClient;
+//# sourceMappingURL=client.d.ts.map

package/dist/telemetry/headless/services/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/telemetry/headless/services/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAMhE,OAAO,KAAK,EACV,oBAAoB,EAEpB,0BAA0B,EAC1B,yBAAyB,EAGzB,mBAAmB,EACnB,wBAAwB,EACxB,6BAA6B,EAC7B,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EACV,eAAe,EACf,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,wBAAwB,EACxB,gBAAgB,EAChB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,wBAAwB,EACxB,YAAY,EACZ,gBAAgB,EACjB,MAAM,yBAAyB,CAAC;AAEjC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,2DAA2D;IAC3D,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,8EAA8E;IAC9E,kBAAkB,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACrD,mEAAmE;IACnE,uBAAuB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACzD;;;OAGG;IACH,0BAA0B,CAAC,QAAQ,EAAE,uBAAuB,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACvH,8DAA8D;IAC9D,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/C,yCAAyC;IACzC,sBAAsB,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACvD,4EAA4E;IAC5E,yBAAyB,CAAC,KAAK,EAAE,wBAAwB,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACnH,gGAAgG;IAChG,wBAAwB,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACjF,wEAAwE;IACxE,uBAAuB,CAAC,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAC;IACjG,mHAAmH;IACnH,iBAAiB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACnD,oHAAoH;IACpH,oBAAoB,CAAC,KAAK,EAAE,mBAAmB,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC1G,oCAAoC;IACpC,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAC7C,4FAA4F;IAC5F,oBAAoB,IAAI,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAC9D,qCAAqC;IACrC,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACpH,qCAAqC;IACrC,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/C;;;;;;OAMG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5F;;;;;OAKG;IACH,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,EAAE,QAAQ,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnH,iCAAiC;IACjC,mBAAmB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACzG,4CAA4C;IAC5C,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,EACvD,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC,oCAAoC;IACpC,eAAe,CAAC,CAAC,SAAS,gBAAgB,EACxC,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5B,gCAAgC;IAChC,kBAAkB,CAAC,KAAK,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC7G,iCAAiC;IACjC,mBAAmB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACzG,sFAAsF;IACtF,mBAAmB,CACjB,KAAK,EAAE,oBAAoB,EAC3B,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;OAGG;IACH,wBAAwB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IACjG,uIAAuI;IACvI,kBAAkB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACrF,sFAAsF;IACtF,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACtH;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;CACf;AAsBD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,iBAAiB,GAAG,eAAe,CA6F7E;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,eAAe,CAGpD"}

package/dist/telemetry/headless/services/client.js

@@ -0,0 +1,149 @@
+/**
+ * The telemetry API client (issues #537, #558, #567, #578, #680; packaged by
+ * #704).
+ *
+ * Every call goes through the app's transport (`PlatformApiClient`, the
+ * `@marinoscar/platform-web/core` port): the auth header, the token refresh
+ * and the maintenance handling stay in the app. Paths are relative to the API
+ * base. The routes and the permission each one enforces:
+ *
+ *   - `GET  /telemetry/config`                  (any signed-in user)
+ *   - `GET  /admin/telemetry/config`            (`telemetry:read`)
+ *   - `PUT  /admin/telemetry/config`            (`telemetry:write`, If-Match)
+ *   - `GET  /admin/telemetry/status`            (`telemetry:read`)
+ *   - `GET|PUT|DELETE /admin/telemetry/connection`, `POST …/connection/test`
+ *                                               (`telemetry:read` / `telemetry:write`)
+ *   - `GET|PUT /admin/telemetry/store`          (`telemetry:read` / `telemetry:write`)
+ *   - `GET  /admin/telemetry/stack`, `POST …/stack/deploy`
+ *                                               (`system_settings:read` / `system_settings:write`)
+ *   - `POST /admin/telemetry/query`, `GET …/schema`, `POST …/export`
+ *                                               (`telemetry:query`)
+ *   - `POST /admin/telemetry/assistant/stream`  (`telemetry:query` + `ai:use`)
+ *   - `GET  /admin/telemetry/dashboard/*`       (`telemetry:query`)
+ *
+ * The browser only presents and collects. Whether a statement is read-only,
+ * how many rows it may return and how long it may run are decided by the API.
+ */
+import { useMemo } from 'react';
+import { usePlatformApi } from '../../../core/index.js';
+import { downloadBlob, filenameFromContentDisposition, telemetryExportFilename, } from './telemetry.js';
+import { dashboardSearchParams } from './telemetryDashboard.js';
+const DASHBOARD = '/admin/telemetry/dashboard';
+function ifMatch(expectedVersion) {
+    return expectedVersion === undefined ? {} : { ifMatch: String(expectedVersion) };
+}
+function signalOf(options) {
+    return options?.signal === undefined ? {} : { signal: options.signal };
+}
+/** An older API sends no `report`; a newer one may send `null`. Both read as `null`. */
+function normalizeAssistantAnswer(payload) {
+    const answer = payload;
+    const report = answer.report;
+    return {
+        ...answer,
+        report: report && typeof report === 'object' ? report : null,
+    };
+}
+/**
+ * The telemetry routes over the app's transport.
+ *
+ * @param api - the app's transport (`usePlatformApi()`, or any `PlatformApiClient`).
+ * @returns a {@link TelemetryClient}.
+ *
+ * @example
+ * ```ts
+ * const telemetry = createTelemetryClient(host.api);
+ * const status = await telemetry.getTelemetryStatus();
+ * ```
+ *
+ * @stability experimental
+ */
+export function createTelemetryClient(api) {
+    return {
+        getTelemetryConfig: () => api.get('/telemetry/config'),
+        getTelemetryAdminConfig: () => api.get('/admin/telemetry/config'),
+        updateTelemetryAdminConfig: (settings, expectedVersion) => api.put('/admin/telemetry/config', settings, ifMatch(expectedVersion)),
+        getTelemetryStatus: () => api.get('/admin/telemetry/status'),
+        getTelemetryConnection: () => api.get('/admin/telemetry/connection'),
+        updateTelemetryConnection: (input, expectedVersion) => api.put('/admin/telemetry/connection', input, ifMatch(expectedVersion)),
+        resetTelemetryConnection: (expectedVersion) => api.delete('/admin/telemetry/connection', ifMatch(expectedVersion)),
+        testTelemetryConnection: (input) => api.post('/admin/telemetry/connection/test', input),
+        getTelemetryStore: () => api.get('/admin/telemetry/store'),
+        updateTelemetryStore: (input, expectedVersion) => api.put('/admin/telemetry/store', input, ifMatch(expectedVersion)),
+        getTelemetryStack: () => api.get('/admin/telemetry/stack'),
+        deployTelemetryStack: () => api.post('/admin/telemetry/stack/deploy'),
+        runTelemetryQuery: (sql, options = {}) => {
+            const body = { sql };
+            if (options.maxRows !== undefined)
+                body.maxRows = options.maxRows;
+            return api.post('/admin/telemetry/query', body, signalOf(options));
+        },
+        getTelemetrySchema: () => api.get('/admin/telemetry/schema'),
+        exportTelemetry: async (sql, format) => {
+            if (!api.postBlob) {
+                throw new Error('The platform host transport has no postBlob, so the telemetry export cannot download.');
+            }
+            const { blob, headers } = await api.postBlob('/admin/telemetry/export', { sql, format });
+            const filename = filenameFromContentDisposition(headers.get('Content-Disposition')) ?? telemetryExportFilename(format);
+            downloadBlob(blob, filename);
+            const rawCount = headers.get('X-Telemetry-Row-Count');
+            const rowCount = rawCount !== null && rawCount.trim() !== '' ? Number(rawCount) : null;
+            return {
+                filename,
+                rowCount: rowCount !== null && Number.isFinite(rowCount) ? rowCount : null,
+                truncated: (headers.get('X-Telemetry-Truncated') ?? '').toLowerCase() === 'true',
+            };
+        },
+        streamTelemetryAssistant: async (request, handlers = {}) => {
+            if (!api.postSse) {
+                throw new Error('The platform host transport has no postSse, so the telemetry assistant cannot stream.');
+            }
+            await api.postSse('/admin/telemetry/assistant/stream', request, {
+                ...signalOf(handlers),
+                onFrame: (eventName, data) => {
+                    const payload = (typeof data === 'object' && data !== null ? data : {});
+                    switch (eventName) {
+                        case 'step':
+                            handlers.onStep?.(payload);
+                            break;
+                        case 'answer':
+                            handlers.onAnswer?.(normalizeAssistantAnswer(payload));
+                            break;
+                        case 'error':
+                            handlers.onError?.({
+                                code: String(payload.code ?? 'ERROR'),
+                                message: String(payload.message ?? 'The assistant failed'),
+                            });
+                            break;
+                        default:
+                            break;
+                    }
+                },
+            });
+        },
+        getDashboardSummary: (query, options) => api.get(`${DASHBOARD}/summary?${dashboardSearchParams(query)}`, signalOf(options)),
+        getDashboardTimeseries: (panel, query, options) => api.get(`${DASHBOARD}/timeseries?${dashboardSearchParams(query, { panel })}`, signalOf(options)),
+        getDashboardTop: (kind, query, options) => api.get(`${DASHBOARD}/top?${dashboardSearchParams(query, { kind })}`, signalOf(options)),
+        getDashboardEvents: (query, options) => api.get(`${DASHBOARD}/events?${dashboardSearchParams(query)}`, signalOf(options)),
+        getDashboardFilters: (query, options) => api.get(`${DASHBOARD}/filters?${dashboardSearchParams(query)}`, signalOf(options)),
+        getDashboardMetrics: (group, query, options) => api.get(`${DASHBOARD}/metrics?${dashboardSearchParams(query, { group })}`, signalOf(options)),
+        getDashboardMetricGroups: (options) => api.get(`${DASHBOARD}/metric-groups`, signalOf(options)),
+        getDashboardPanels: (options) => api.get(`${DASHBOARD}/panels`, signalOf(options)),
+        getDashboardPanel: (id, query, options) => api.get(`${DASHBOARD}/panels/${encodeURIComponent(id)}?${dashboardSearchParams(query)}`, signalOf(options)),
+    };
+}
+/**
+ * The telemetry client over the platform host's transport, memoised on it (a
+ * stable transport gives a stable client, so hooks keyed on it never refetch
+ * on a re-render).
+ *
+ * @returns a {@link TelemetryClient}.
+ * @throws Error outside a `PlatformHostProvider`.
+ *
+ * @stability experimental
+ */
+export function useTelemetryClient() {
+    const api = usePlatformApi();
+    return useMemo(() => createTelemetryClient(api), [api]);
+}
+//# sourceMappingURL=client.js.map

package/dist/telemetry/headless/services/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/telemetry/headless/services/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EACL,YAAY,EACZ,8BAA8B,EAC9B,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AAsBxB,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAgIhE,MAAM,SAAS,GAAG,4BAA4B,CAAC;AAE/C,SAAS,OAAO,CAAC,eAAmC;IAClD,OAAO,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;AACnF,CAAC;AAED,SAAS,QAAQ,CAAC,OAA4C;IAC5D,OAAO,OAAO,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;AACzE,CAAC;AAED,wFAAwF;AACxF,SAAS,wBAAwB,CAAC,OAAgC;IAChE,MAAM,MAAM,GAAG,OAA8C,CAAC;IAC9D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,OAAO;QACL,GAAG,MAAM;QACT,MAAM,EAAE,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAE,MAAmC,CAAC,CAAC,CAAC,IAAI;KAC3F,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAsB;IAC1D,OAAO;QACL,kBAAkB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAwB,mBAAmB,CAAC;QAC7E,uBAAuB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAuB,yBAAyB,CAAC;QACvF,0BAA0B,EAAE,CAAC,QAAQ,EAAE,eAAe,EAAE,EAAE,CACxD,GAAG,CAAC,GAAG,CAAuB,yBAAyB,EAAE,QAAQ,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAC9F,kBAAkB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAkB,yBAAyB,CAAC;QAE7E,sBAAsB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAsB,6BAA6B,CAAC;QACzF,yBAAyB,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,CACpD,GAAG,CAAC,GAAG,CAAsB,6BAA6B,EAAE,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAC9F,wBAAwB,EAAE,CAAC,eAAe,EAAE,EAAE,CAC5C,GAAG,CAAC,MAAM,CAAsB,6BAA6B,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAC1F,uBAAuB,EAAE,CAAC,KAAK,EAAE,EAAE,CACjC,GAAG,CAAC,IAAI,CAAgC,kCAAkC,EAAE,KAAK,CAAC;QAEpF,iBAAiB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAuB,wBAAwB,CAAC;QAChF,oBAAoB,EAAE,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,CAC/C,GAAG,CAAC,GAAG,CAAuB,wBAAwB,EAAE,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;QAE1F,iBAAiB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAiB,wBAAwB,CAAC;QAC1E,oBAAoB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAA+B,+BAA+B,CAAC;QAEnG,iBAAiB,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;YACvC,MAAM,IAAI,GAAsC,EAAE,GAAG,EAAE,CAAC;YACxD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;gBAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;YAClE,OAAO,GAAG,CAAC,IAAI,CAAuB,wBAAwB,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3F,CAAC;QACD,kBAAkB,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAkB,yBAAyB,CAAC;QAE7E,eAAe,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAC;YAC3G,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,yBAAyB,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;YACzF,MAAM,QAAQ,GACZ,8BAA8B,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,CAAC;YACxG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACtD,MAAM,QAAQ,GAAG,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACvF,OAAO;gBACL,QAAQ;gBACR,QAAQ,EAAE,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;gBAC1E,SAAS,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM;aACjF,CAAC;QACJ,CAAC;QAED,wBAAwB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,GAAG,EAAE,EAAE,EAAE;YACzD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAC;YAC3G,CAAC;YACD,MAAM,GAAG,CAAC,OAAO,CAAC,mCAAmC,EAAE,OAAO,EAAE;gBAC9D,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACrB,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE;oBAC3B,MAAM,OAAO,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAA4B,CAAC;oBACnG,QAAQ,SAAS,EAAE,CAAC;wBAClB,KAAK,MAAM;4BACT,QAAQ,CAAC,MAAM,EAAE,CAAC,OAA4C,CAAC,CAAC;4BAChE,MAAM;wBACR,KAAK,QAAQ;4BACX,QAAQ,CAAC,QAAQ,EAAE,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;4BACvD,MAAM;wBACR,KAAK,OAAO;4BACV,QAAQ,CAAC,OAAO,EAAE,CAAC;gCACjB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC;gCACrC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,sBAAsB,CAAC;6BAC3D,CAAC,CAAC;4BACH,MAAM;wBACR;4BACE,MAAM;oBACV,CAAC;gBACH,CAAC;aACF,CAAC,CAAC;QACL,CAAC;QAED,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACtC,GAAG,CAAC,GAAG,CAAmB,GAAG,SAAS,YAAY,qBAAqB,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACtG,sBAAsB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAChD,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,eAAe,qBAAqB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QAClG,eAAe,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CACxC,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,QAAQ,qBAAqB,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC1F,kBAAkB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACrC,GAAG,CAAC,GAAG,CAAkB,GAAG,SAAS,WAAW,qBAAqB,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpG,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CACtC,GAAG,CAAC,GAAG,CAAmB,GAAG,SAAS,YAAY,qBAAqB,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACtG,mBAAmB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CAC7C,GAAG,CAAC,GAAG,CAAmB,GAAG,SAAS,YAAY,qBAAqB,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACjH,wBAAwB,EAAE,CAAC,OAAO,EAAE,EAAE,CACpC,GAAG,CAAC,GAAG,CAA6B,GAAG,SAAS,gBAAgB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACtF,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAuB,GAAG,SAAS,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACxG,iBAAiB,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,CACxC,GAAG,CAAC,GAAG,CAAqB,GAAG,SAAS,WAAW,kBAAkB,CAAC,EAAE,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;KAClI,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB;IAChC,MAAM,GAAG,GAAG,cAAc,EAAE,CAAC;IAC7B,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1D,CAAC"}