@yugabytedb/perf-advisor-ui 1.0.152 → 1.0.154

package/dist/api.d.ts

@@ -1,3 +1,4 @@
+import { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
 import { Anomaly, AnomalyDetectionStatus, AnomalyGroup, BackgroundTasksResponse, ClusterLoadResponseData, MetadataFields, GraphRequestParams, QueryPlanData, QueryStatsPagedBody, ClusterDetails, IndexPagedResponse, TablePagedResponse } from './helpers/dtos';
 export declare enum QUERY_KEY {
     fetchAnomalies = "fetchAnomalies",
@@ -36,14 +37,36 @@ export declare enum QUERY_KEY {
     fetchIndexesPage = "fetchIndexesPage",
     fetchTableMetadata = "fetchTableMetadata"
 }
+export type { AxiosError, AxiosRequestConfig, AxiosResponse };
+export type PerfAdvisorRequestInterceptor = (config: AxiosRequestConfig) => AxiosRequestConfig | Promise<AxiosRequestConfig>;
+export type PerfAdvisorResponseInterceptor = (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
+export type PerfAdvisorInterceptorErrorHandler = (error: unknown) => unknown;
+export type EjectPerfAdvisorInterceptor = () => void;
+/**
+ * Registers a request interceptor on the internal axios instance used by every
+ * Perf Advisor API call. Returns a function that removes the interceptor.
+ */
+export declare const registerPerfAdvisorRequestInterceptor: (onFulfilled: PerfAdvisorRequestInterceptor, onRejected?: PerfAdvisorInterceptorErrorHandler) => EjectPerfAdvisorInterceptor;
+/**
+ * Registers a response interceptor on the internal axios instance used by every
+ * Perf Advisor API call. Returns a function that removes the interceptor.
+ */
+export declare const registerPerfAdvisorResponseInterceptor: (onFulfilled: PerfAdvisorResponseInterceptor, onRejected?: PerfAdvisorInterceptorErrorHandler) => EjectPerfAdvisorInterceptor;
+/**
+ * Convenience helper for the common case of adding a fixed set of custom
+ * headers to every request. `getHeaders` is evaluated per-request, so returning
+ * a fresh object (or reading from a mutable source) picks up updated values
+ * without re-registering. Values that are `undefined` or `null` are skipped.
+ */
+export declare const setPerfAdvisorCustomHeaders: (getHeaders: () => Record<string, string | number | boolean | undefined | null>) => EjectPerfAdvisorInterceptor;
 declare class ApiService {
     fetchAnomalies: (universeUuid: string, startTime?: Date | null, endTime?: Date | null, apiUrl?: string) => Promise<Anomaly[]>;
-    fetchAnomaliesPage: (universeUuid: string, pageno: number, apiUrl?: string, records_to_fetch?: number, startTime?: Date | null, endTime?: Date | null, category?: any, searchInput?: string) => Promise<import('axios').AxiosResponse<Anomaly[]>>;
-    fetchQueriesPage: (universeUuid: string, payload: any) => Promise<import('axios').AxiosResponse<GraphRequestParams[]>>;
-    fetchLoadDbStatsPage: (universeUuid: string, payload: any, getClusterDetails?: () => ClusterDetails) => Promise<import('axios').AxiosResponse<GraphRequestParams[]>>;
-    fetchTabletStatsPage: (universeUuid: string, payload: any, getClusterDetails: () => ClusterDetails) => Promise<import('axios').AxiosResponse<GraphRequestParams[]>>;
-    fetchNodeLoadStatsPage: (universeUuid: string, payload: any) => Promise<import('axios').AxiosResponse<GraphRequestParams[]>>;
-    fetchQueriesStatsPage: (universeUuid: string, payload: any, getClusterDetails: () => ClusterDetails, filteredLegends: string[], showSystemQueries?: boolean) => Promise<import('axios').AxiosResponse<GraphRequestParams[]>>;
+    fetchAnomaliesPage: (universeUuid: string, pageno: number, apiUrl?: string, records_to_fetch?: number, startTime?: Date | null, endTime?: Date | null, category?: any, searchInput?: string) => Promise<AxiosResponse<Anomaly[]>>;
+    fetchQueriesPage: (universeUuid: string, payload: any) => Promise<AxiosResponse<GraphRequestParams[]>>;
+    fetchLoadDbStatsPage: (universeUuid: string, payload: any, getClusterDetails?: () => ClusterDetails) => Promise<AxiosResponse<GraphRequestParams[]>>;
+    fetchTabletStatsPage: (universeUuid: string, payload: any, getClusterDetails: () => ClusterDetails) => Promise<AxiosResponse<GraphRequestParams[]>>;
+    fetchNodeLoadStatsPage: (universeUuid: string, payload: any) => Promise<AxiosResponse<GraphRequestParams[]>>;
+    fetchQueriesStatsPage: (universeUuid: string, payload: any, getClusterDetails: () => ClusterDetails, filteredLegends: string[], showSystemQueries?: boolean) => Promise<AxiosResponse<GraphRequestParams[]>>;
     fetchNamespaceSchemas: (universeUuid: string, namespaceName: string, apiUrl?: string) => Promise<string[]>;
     fetchQueryStats: (universeUuid: string, payload: {
         queryId: string;
@@ -66,9 +89,9 @@ declare class ApiService {
         excludeTpUser?: boolean | undefined;
         excludeSystemDBs?: boolean | undefined;
     }, apiUrl?: string, signal?: AbortSignal) => Promise<QueryStatsPagedBody>;
-    fetchTablesPage: (universeUuid: string, payload: any) => Promise<import('axios').AxiosResponse<any[]>>;
-    fetchIndexesPage: (universeUuid: string, namespaceName: string, schemaName: string, tableName: string, apiUrl?: string, limit?: number) => Promise<import('axios').AxiosResponse<IndexPagedResponse>>;
-    fetchTableMetadata: (universeUuid: string, namespaceName: string, schemaName: string, tableName: string, apiUrl?: string, limit?: number) => Promise<import('axios').AxiosResponse<TablePagedResponse>>;
+    fetchTablesPage: (universeUuid: string, payload: any) => Promise<AxiosResponse<any[]>>;
+    fetchIndexesPage: (universeUuid: string, namespaceName: string, schemaName: string, tableName: string, apiUrl?: string, limit?: number) => Promise<AxiosResponse<IndexPagedResponse>>;
+    fetchTableMetadata: (universeUuid: string, namespaceName: string, schemaName: string, tableName: string, apiUrl?: string, limit?: number) => Promise<AxiosResponse<TablePagedResponse>>;
     fetchNamespaces: (universeUuid: string, apiUrl?: string) => Promise<string[]>;
     fetchQueriesDatabases: (universeUuid: string, apiUrl?: string) => Promise<string[]>;
     fetchAnomaliesById: (universeUuid: string, anomalyUuid: string, apiUrl?: string) => Promise<Anomaly>;
@@ -97,4 +120,3 @@ declare class ApiService {
     fetchClusterDetails: (universeUuid: string, startTime: string | null, endTime: string | null, apiUrl?: string) => Promise<any>;
 }
 export declare const PerfAdvisorAPI: ApiService;
-export {};