@ssa-ui-kit/infra-dash 0.0.2 → 0.2.0

package/dist/panels/TimeseriesPanel/TimeseriesPanel.d.ts

@@ -4,6 +4,8 @@ export type TimeseriesPanelProps = {
     panelData: PanelData;
     /** Optional title for the panel, defaults to panel.title */
     title?: string;
+    /** Optional hover format for the x axis */
+    xAxisHoverFormat?: string;
 };
-export declare const TimeseriesPanel: ({ panel, panelData, title: providedTitle, }: TimeseriesPanelProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const TimeseriesPanel: ({ panel, panelData, title: providedTitle, xAxisHoverFormat, }: TimeseriesPanelProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const panelConfig: PanelConfig<TimeseriesPanelProps>;

package/dist/shared/context/index.d.ts

@@ -0,0 +1,2 @@
+export * from './root';
+export * from './panelDataPeriod';

package/dist/shared/context/panelDataPeriod.d.ts

@@ -0,0 +1,24 @@
+import { PanelDataPeriod } from '../panel';
+export interface UseInfraDashPanelDataPeriodOptions {
+    defaultPeriod?: PanelDataPeriod;
+    period?: PanelDataPeriod;
+    onPeriodChange?: (period: PanelDataPeriod) => void;
+}
+export declare const useInfraDashPanelDataPeriod: ({ defaultPeriod, period: providedPeriod, onPeriodChange, }?: UseInfraDashPanelDataPeriodOptions) => {
+    period: 0 | 2 | 1 | 3 | 4;
+    changePeriod: (value: 0 | 2 | 1 | 3 | 4) => void;
+};
+export type InfraDashPanelDataPeriodStore = ReturnType<typeof useInfraDashPanelDataPeriod>;
+export declare const InfraDashPanelDataPeriodProvider: ({ children, value, }: {
+    value: {
+        period: 0 | 2 | 1 | 3 | 4;
+        changePeriod: (value: 0 | 2 | 1 | 3 | 4) => void;
+    };
+    children: React.ReactNode;
+}) => import("react").FunctionComponentElement<import("react").ProviderProps<{
+    period: 0 | 2 | 1 | 3 | 4;
+    changePeriod: (value: 0 | 2 | 1 | 3 | 4) => void;
+} | null>>, useInfraDashPanelDataPeriodContext: () => {
+    period: 0 | 2 | 1 | 3 | 4;
+    changePeriod: (value: 0 | 2 | 1 | 3 | 4) => void;
+};

package/dist/shared/{context.d.ts → context/root.d.ts}

@@ -1,6 +1,6 @@
-import { InfraDashTransport } from './transport';
-import { MutationClient, QueryClient } from './query';
-import { PanelRegistry } from './panelRegistry';
+import { PanelRegistry } from '../panelRegistry';
+import { MutationClient, QueryClient } from '../query';
+import { InfraDashTransport } from '../transport';
 export interface InfraDashContextValue {
     transport: InfraDashTransport;
     queryClient: QueryClient;

package/dist/shared/dashboard.d.ts

@@ -15,6 +15,8 @@ export type Dashboard = {
     id: number;
     /** Display title of the dashboard shown in the UI */
     title: string;
+    /** Indicates if the dashboard is published and available to users */
+    published: boolean;
     /** Dashboard-specific configuration and settings */
     dashboardDefinition: DashboardDefinition;
     /** Array of panels that belong to this dashboard */

package/dist/shared/panel.d.ts

@@ -5,13 +5,6 @@ import { GrafanaPanelData, GrafanaPanelSchema } from './grafana';
  * Contains both the component configuration and grid layout positioning.
  */
 export type PanelDefinition = {
-    source: {
-        type: typeof PANEL_DATA_SOURCE.GRAFANA;
-        /** Unique identifier for the Grafana dashboard */
-        dashboardUid: string;
-        /** Unique identifier for the Grafana panel within the dashboard */
-        panelId: number;
-    };
     component: {
         /** Unique identifier for the component type */
         id: string;
@@ -36,6 +29,11 @@ export type Panel = {
     panelSchema: GrafanaPanelSchema;
     /** Component and layout definition for the panel */
     panelDefinition: PanelDefinition;
+    source: {
+        type: typeof PANEL_DATA_SOURCE.GRAFANA;
+        dashboardUid: string;
+        panelId: number;
+    };
 };
 /**
  * Optional schema defining the structure of props this component expects.
@@ -93,4 +91,12 @@ export type PanelData = {
     /** The actual panel data from Grafana */
     data: GrafanaPanelData;
 };
+export declare const PANEL_DATA_PERIOD: {
+    readonly LAST_HOUR: 0;
+    readonly LAST_6_HOURS: 1;
+    readonly LAST_24_HOURS: 2;
+    readonly LAST_7_DAYS: 3;
+    readonly LAST_30_DAYS: 4;
+};
+export type PanelDataPeriod = (typeof PANEL_DATA_PERIOD)[keyof typeof PANEL_DATA_PERIOD];
 export {};

package/dist/shared/query/query.d.ts

@@ -30,6 +30,7 @@ export declare class QueryEntry<T> {
     private controller;
     constructor(key: QueryKey, fetcher: Fetcher<T>, options?: QueryOptions);
     private notify;
+    isActive(): boolean | 0 | undefined;
     updateEntity(fetcher: Fetcher<T>, options?: QueryOptions): QueryEntry<T>;
     fetch(): Promise<T | undefined>;
     subscribe(sub: Subscriber<T>): () => void;
@@ -41,10 +42,11 @@ export declare class QueryClient {
     private cache;
     get<T>(key: QueryKey): QueryEntry<T> | undefined;
     fetchQuery<T>(key: QueryKey, fetcher: Fetcher<T>, options?: QueryOptions): QueryEntry<T>;
-    invalidateQueries({ key, exact, reset, }: {
+    invalidateQueries({ key, exact, reset, type, }: {
         key: QueryKey;
         exact?: boolean;
         reset?: boolean;
+        type?: 'active' | 'inactive' | 'all';
     }): void;
     setQueryData<T>(key: QueryKey, data: T): void;
 }

package/dist/shared/transport/baseTransport.d.ts

@@ -1,33 +1,32 @@
 import { Dashboard, DashboardDefinition } from '../dashboard';
 import { GrafanaDashboard, GrafanaPanel, GrafanaPanelData } from '../grafana';
-import { PanelDefinition } from '../panel';
+import { PANEL_DATA_SOURCE, PanelDefinition } from '../panel';
 export type CreateDashboardPayload = {
     title: string;
-    dashboardUid: string;
     dashboardDefinition: DashboardDefinition;
+    published: boolean;
     panels: {
-        id: number;
+        source: {
+            type: typeof PANEL_DATA_SOURCE.GRAFANA;
+            dashboardUid: string;
+            panelId: number;
+        };
         panelDefinition: PanelDefinition;
     }[];
 };
 export type UpdateDashboardPayload = {
     dashboardId: number;
-    title: string;
-    dashboardDefinition: DashboardDefinition;
-    panels: {
-        id: number;
-        panelDefinition: PanelDefinition;
-    }[];
-};
+} & CreateDashboardPayload;
 export interface InfraDashTransport {
     getGrafanaDashboards: (signal?: AbortSignal) => Promise<GrafanaDashboard[]>;
     getGrafanaPanels: (grafanaDashboardUid: string, signal?: AbortSignal) => Promise<GrafanaPanel[]>;
-    getGrafanaPanelData: ({ dashboardUid, panelId, }: {
+    getGrafanaPanelData: ({ dashboardUid, panelId, period, }: {
         dashboardUid: string;
         panelId: number;
+        period?: number;
     }, signal?: AbortSignal) => Promise<GrafanaPanelData>;
-    getPanelData: (panelId: number, signal?: AbortSignal) => Promise<GrafanaPanelData>;
     getDashboards: (signal?: AbortSignal) => Promise<Pick<Dashboard, 'id' | 'title'>[]>;
+    getPublishedDashboards: (signal?: AbortSignal) => Promise<Pick<Dashboard, 'id' | 'title'>[]>;
     getDashboard: (dashboardUid: number, signal?: AbortSignal) => Promise<Dashboard>;
     createDashboard: (payload: CreateDashboardPayload, signal?: AbortSignal) => Promise<unknown>;
     updateDashboard: (payload: UpdateDashboardPayload, signal?: AbortSignal) => Promise<unknown>;

package/dist/shared/transport/restTransport.d.ts

@@ -16,12 +16,13 @@ export declare class RestInfraDashTransport implements InfraDashTransport {
     protected makeRequest<T = unknown>(request: Request, parseResponse?: boolean): Promise<T>;
     getGrafanaDashboards(signal?: AbortSignal): Promise<GrafanaDashboard[]>;
     getGrafanaPanels(grafanaDashboardUid: string, signal?: AbortSignal): Promise<GrafanaPanel[]>;
-    getGrafanaPanelData({ dashboardUid, panelId, }: {
+    getGrafanaPanelData({ dashboardUid, panelId, period, }: {
         dashboardUid: string;
         panelId: number;
+        period?: number;
     }, signal?: AbortSignal): Promise<GrafanaPanelData>;
-    getPanelData(panelId: number, signal?: AbortSignal): Promise<GrafanaPanelData>;
     getDashboards(signal?: AbortSignal): Promise<Pick<Dashboard, "title" | "id">[]>;
+    getPublishedDashboards(signal?: AbortSignal): Promise<Pick<Dashboard, "title" | "id">[]>;
     getDashboard(dashboardUid: number, signal?: AbortSignal): Promise<Dashboard>;
     createDashboard(payload: CreateDashboardPayload, signal?: AbortSignal): Promise<unknown>;
     updateDashboard(payload: UpdateDashboardPayload, signal?: AbortSignal): Promise<unknown>;

package/dist/widgets/DashboardEditor/DashboardEditor.d.ts

@@ -1,5 +1,6 @@
 import { DashboardPanelGridProps } from '../../features/DashboardPanelGrid';
 import { Dashboard } from '../../shared/dashboard';
+import { UseInfraDashPanelDataPeriodOptions } from '../../shared/context';
 export type DashboardEditorProps = {
     dashboard?: Dashboard;
     defaultDashboard?: Dashboard;
@@ -12,4 +13,4 @@ export type DashboardEditorProps = {
 export declare const DashboardEditorInternal: ({ dashboard: controlledDashboard, defaultDashboard, gridProps, onChange, onSaved, onCreate, onError, ...divProps }: DashboardEditorProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const DashboardEditor: ({ dashboardId, ...props }: DashboardEditorProps & {
     dashboardId?: number;
-}) => import("@emotion/react/jsx-runtime").JSX.Element;
+} & UseInfraDashPanelDataPeriodOptions) => import("@emotion/react/jsx-runtime").JSX.Element;

package/dist/widgets/DashboardEditor/helpers.d.ts

@@ -20,6 +20,7 @@ export declare const updatePanel: ({ dashboard, panel }: UpdatePanelParams) => {
     panels: Panel[];
     id: number;
     title: string;
+    published: boolean;
     dashboardDefinition: import("../../shared/dashboard").DashboardDefinition;
 };
 export type RemovePanelParams = {
@@ -30,10 +31,39 @@ export declare const removePanel: ({ dashboard, panel }: RemovePanelParams) => {
     panels: Panel[];
     id: number;
     title: string;
+    published: boolean;
     dashboardDefinition: import("../../shared/dashboard").DashboardDefinition;
 };
 export type ApplyNewLayoutParams = {
     dashboard: Dashboard;
     newLayout: ReactGridLayout.Layout[];
 };
-export declare const applyNewLayout: ({ dashboard, newLayout, }: ApplyNewLayoutParams) => Dashboard;
+export declare const applyNewLayout: ({ dashboard, newLayout, }: ApplyNewLayoutParams) => {
+    panels: {
+        panelDefinition: {
+            gridPos: Omit<import("react-grid-layout").Layout, "i"> | {
+                x: number;
+                y: number;
+                w: number;
+                h: number;
+            };
+            component: {
+                id: string;
+                props: Record<string, unknown>;
+            };
+            version: 1;
+        };
+        id: number;
+        title: string;
+        panelSchema: import("../../shared/grafana").GrafanaPanelSchema;
+        source: {
+            type: "grafana";
+            dashboardUid: string;
+            panelId: number;
+        };
+    }[];
+    id: number;
+    title: string;
+    published: boolean;
+    dashboardDefinition: import("../../shared/dashboard").DashboardDefinition;
+};

package/dist/widgets/DashboardViewer/DashboardViewer.d.ts

@@ -1,7 +1,8 @@
 import { Dashboard } from '../../shared/dashboard';
+import { UseInfraDashPanelDataPeriodOptions } from '../../shared/context';
 import { DashboardPanelGridProps } from '../../features/DashboardPanelGrid';
 export type DashboardViewerProps = {
     dashboardId?: number;
     dashboard?: Dashboard;
-} & Omit<DashboardPanelGridProps, 'dashboard'>;
+} & Omit<DashboardPanelGridProps, 'dashboard'> & UseInfraDashPanelDataPeriodOptions;
 export declare const DashboardViewer: ({ dashboard, dashboardId, ...props }: DashboardViewerProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ssa-ui-kit/infra-dash",
-  "version": "0.0.2",
+  "version": "0.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "private": false,
@@ -34,8 +34,8 @@
     "react-resizable": "^3.0.5",
     "@rjsf/validator-ajv8": "^5.24.11",
     "@rjsf/utils": "^5.24.11",
-    "@ssa-ui-kit/core": "^2.23.2",
-    "@ssa-ui-kit/hooks": "^2.23.2"
+    "@ssa-ui-kit/core": "^2.27.0",
+    "@ssa-ui-kit/hooks": "^2.27.0"
   },
   "devDependencies": {
     "@emotion/css": "^11.13.5",