azuredatastudio/src/sql/parts/dashboard/pages/serverDashboardPage.contribution.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
import { IJSONSchema } from 'vs/base/common/jsonSchema';
import * as nls from 'vs/nls';
import { generateDashboardWidgetSchema, generateDashboardTabSchema } from 'sql/parts/dashboard/pages/dashboardPageContribution';

export interface IPropertiesConfig {
	edition: number | Array<number>;
	provider: string | Array<string>;
	properties: {
		displayName: string;
		value: string
	}[];
}

export const serverDashboardPropertiesSchema: IJSONSchema = {
	description: nls.localize('dashboardServerProperties', 'Enable or disable the properties widget'),
	default: true,
	oneOf: [
		{ type: 'boolean' },
		{
			type: 'string',
			enum: ['collapsed']
		},
		{
			type: 'object',
			properties: {
				provider: {
					type: 'string'
				},
				edition: {
					type: 'number'
				},
				properties: {
					description: nls.localize('dashboard.serverproperties', 'Property values to show'),
					type: 'array',
					items: {
						type: 'object',
						properties: {
							displayName: {
								type: 'string',
								description: nls.localize('dashboard.serverproperties.displayName', 'Display name of the property')
							},
							value: {
								type: 'string',
								description: nls.localize('dashboard.serverproperties.value', 'Value in the Server Info Object')
							}
						}
					},
					default: [
						{
							displayName: nls.localize('version', 'Version'),
							value: 'serverVersion'
						},
						{
							displayName: nls.localize('edition', 'Edition'),
							value: 'serverEdition'
						},
						{
							displayName: nls.localize('computerName', 'Computer Name'),
							value: 'machineName'
						},
						{
							displayName: nls.localize('osVersion', 'OS Version'),
							value: 'osVersion'
						}
					]
				}
			}
		}
	]
};

let defaultVal = [
	{
		name: 'Tasks',
		widget: {
			'tasks-widget': [{ name: 'restore', when: '!mssql:iscloud' }, 'configureDashboard', 'newQuery']
		},
		gridItemConfig: {
			sizex: 1,
			sizey: 1
		}
	},
	{
		gridItemConfig: {
			sizex: 1,
			sizey: 2
		},
		widget: {
			'explorer-widget': {}
		}
	},
	{
		widget: {
			'backup-history-server-insight': {
				cacheId: '0c7cba8b-c87a-4bcc-ae54-2f40a5503a90'
			}
		}
	},
	{
		widget: {
			'all-database-size-server-insight': {
				cacheId: '1d7cba8b-c87a-4bcc-ae54-2f40a5503a90'
			}
		}
	}
];

export const serverDashboardSettingSchema: IJSONSchema = {
	type: ['array'],
	description: nls.localize('dashboardServer', 'Customizes the server dashboard page'),
	items: generateDashboardWidgetSchema('server'),
	default: defaultVal
};

export const serverDashboardTabsSchema: IJSONSchema = {
	type: ['array'],
	description: nls.localize('dashboardServerTabs', 'Customizes the Server dashboard tabs'),
	items: generateDashboardTabSchema('server'),
	default: [
	]
};

export const SERVER_DASHBOARD_SETTING = 'dashboard.server.widgets';
export const SERVER_DASHBOARD_PROPERTIES = 'dashboard.server.properties';
export const SERVER_DASHBOARD_TABS = 'dashboard.server.tabs';