import { UrlQueryMap } from '@grafana/data'; import { Status } from '@grafana/schema/src/schema/dashboard/v2'; import { ListOptions, Resource, ResourceList } from 'app/features/apiserver/types'; import { DeleteDashboardResponse } from 'app/features/manage-dashboards/types'; import { AnnotationsPermissions, SaveDashboardResponseDTO } from 'app/types/dashboard'; import { SaveDashboardCommand } from '../components/SaveDashboard/types'; export type ListDeletedDashboardsOptions = Omit<ListOptions, 'labelSelector'>; export interface DashboardAPI<G, T> { /** Get a dashboard with the access control metadata */ getDashboardDTO(uid: string, params?: UrlQueryMap): Promise<G>; /** Save dashboard */ saveDashboard(options: SaveDashboardCommand<T>): Promise<SaveDashboardResponseDTO>; /** Delete a dashboard */ deleteDashboard(uid: string, showSuccessAlert: boolean): Promise<DeleteDashboardResponse>; /** List all deleted dashboards */ listDeletedDashboards(options: ListDeletedDashboardsOptions): Promise<ResourceList<T>>; /** Restore a deleted dashboard by re-creating it */ restoreDashboard(dashboard: Resource<T>): Promise<Resource<T>>; } // Implemented using /api/dashboards/* export interface DashboardWithAccessInfo<T> extends Resource<T, Status, 'DashboardWithAccessInfo'> { access: { url?: string; slug?: string; canSave?: boolean; canEdit?: boolean; canDelete?: boolean; canShare?: boolean; canStar?: boolean; canAdmin?: boolean; annotationsPermissions?: AnnotationsPermissions; }; // TODO... } export interface DashboardVersionError extends Error { status: number; data: { // The version which was stored when the dashboard was created / updated. // Currently known versions are: 'v2beta1' | 'v1beta1' | 'v0alpha1' storedVersion: string; message: string; }; } export class DashboardVersionError extends Error { constructor(storedVersion: string | undefined, message = 'Dashboard version mismatch') { super(message); this.name = 'DashboardVersionError'; this.status = 200; this.data = { storedVersion: storedVersion ?? 'unknown', message, }; } }