grafana/public/app/features/dashboard/components/ShareModal/SharePublicDashboard/SharePublicDashboardUtils.ts

61 lines
1.8 KiB
TypeScript
Raw Normal View History

import { getConfig } from 'app/core/config';
import { VariableModel } from 'app/features/variables/types';
import { DashboardDataDTO, DashboardMeta } from 'app/types/dashboard';
import { PanelModel } from '../../../state';
import { supportedDatasources } from './SupportedPubdashDatasources';
export interface PublicDashboard {
accessToken?: string;
annotationsEnabled: boolean;
isEnabled: boolean;
uid: string;
dashboardUid: string;
timeSettings?: object;
}
export interface DashboardResponse {
dashboard: DashboardDataDTO;
meta: DashboardMeta;
}
// Instance methods
export const dashboardHasTemplateVariables = (variables: VariableModel[]): boolean => {
return variables.length > 0;
};
export const publicDashboardPersisted = (publicDashboard?: PublicDashboard): boolean => {
return publicDashboard?.uid !== '' && publicDashboard?.uid !== undefined;
};
/**
* Get unique datasource names from all panels that are not currently supported by public dashboards.
*/
export const getUnsupportedDashboardDatasources = (panels: PanelModel[]): string[] => {
let unsupportedDS = new Set<string>();
for (const panel of panels) {
for (const target of panel.targets) {
let ds = target?.datasource?.type;
if (ds && !supportedDatasources.has(ds)) {
unsupportedDS.add(ds);
}
}
}
return Array.from(unsupportedDS).sort();
};
/**
* Generate the public dashboard url. Uses the appUrl from the Grafana boot config, so urls will also be correct
* when Grafana is hosted on a subpath.
*
* All app urls from the Grafana boot config end with a slash.
*
* @param publicDashboard
*/
export const generatePublicDashboardUrl = (publicDashboard: PublicDashboard): string => {
return `${getConfig().appUrl}public-dashboards/${publicDashboard.accessToken}`;
};