{
+ const webviewExampleHtml = fs.readFileSync(path.join(__dirname, 'webviewExample.html')).toString();
+ const buttonHtml = fs.readFileSync(path.join(__dirname, 'button.html')).toString();
+ const counterHtml = fs.readFileSync(path.join(__dirname, 'counter.html')).toString();
+
+ let countWidget: sqlops.DashboardWebview;
+ let buttonWidget: sqlops.DashboardWebview;
+ let count = 0;
+
+ let dialog: sqlops.ModalDialog = sqlops.window.createDialog('Flyout extension');
+ dialog.html = 'This is a flyout extension.
';
+
+ sqlops.dashboard.registerWebviewProvider('webview-count', e => {
+ e.html = counterHtml;
+ countWidget = e;
+ });
+ sqlops.dashboard.registerWebviewProvider('webview-button', e => {
+ e.html = buttonHtml;
+ buttonWidget = e;
+ e.onMessage(event => {
+ if (event === 'openFlyout') {
+ dialog.open();
+ } else {
+ count++;
+ countWidget.postMessage(count);
+ }
+ });
+ });
+ sqlops.dashboard.registerWebviewProvider('webviewExample', e => {
+ e.html = webviewExampleHtml;
+ });
+
+ return Promise.resolve(true);
+ }
+}
+
diff --git a/samples/extensionSamples/src/controllers/webviewExample.html b/samples/extensionSamples/src/controllers/webviewExample.html
new file mode 100644
index 0000000000..5448a0f555
--- /dev/null
+++ b/samples/extensionSamples/src/controllers/webviewExample.html
@@ -0,0 +1,19 @@
+
+
+
+ Hello :)
+
+
diff --git a/samples/extensionSamples/src/extension.ts b/samples/extensionSamples/src/extension.ts
new file mode 100644
index 0000000000..466d5ab85c
--- /dev/null
+++ b/samples/extensionSamples/src/extension.ts
@@ -0,0 +1,39 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+'use strict';
+
+import * as vscode from 'vscode';
+
+import ControllerBase from './controllers/controllerBase';
+import MainController from './controllers/mainController';
+
+let controllers: ControllerBase[] = [];
+
+export function activate(context: vscode.ExtensionContext): Promise {
+ let activations: Promise[] = [];
+
+ // Start the main controller
+ let mainController = new MainController(context);
+ controllers.push(mainController);
+ context.subscriptions.push(mainController);
+ activations.push(mainController.activate());
+
+ return Promise.all(activations)
+ .then((results: boolean[]) => {
+ for (let result of results) {
+ if (!result) {
+ return false;
+ }
+ }
+ return true;
+ });
+}
+
+export function deactivate(): void {
+ for (let controller of controllers) {
+ controller.deactivate();
+ }
+}
diff --git a/samples/extensionSamples/src/localizedConstants.ts b/samples/extensionSamples/src/localizedConstants.ts
new file mode 100644
index 0000000000..3ebaf8e0a5
--- /dev/null
+++ b/samples/extensionSamples/src/localizedConstants.ts
@@ -0,0 +1,5 @@
+'use strict';
+
+// TODO: localize!
+
+export const msgErrorLoadingTab = 'An error occurred while loading the tab.';
diff --git a/samples/extensionSamples/src/media/file.svg b/samples/extensionSamples/src/media/file.svg
new file mode 100644
index 0000000000..69412f5c61
--- /dev/null
+++ b/samples/extensionSamples/src/media/file.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/samples/extensionSamples/src/media/file_inverse.svg b/samples/extensionSamples/src/media/file_inverse.svg
new file mode 100644
index 0000000000..8276c545aa
--- /dev/null
+++ b/samples/extensionSamples/src/media/file_inverse.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/samples/extensionSamples/src/sql/qds.sql b/samples/extensionSamples/src/sql/qds.sql
new file mode 100644
index 0000000000..049ec9a9bf
--- /dev/null
+++ b/samples/extensionSamples/src/sql/qds.sql
@@ -0,0 +1,39 @@
+declare @qds_status int = (SELECT actual_state
+FROM sys.database_query_store_options)
+if @qds_status > 0
+Begin
+WITH SlowestQry AS(
+ SELECT TOP 5
+ q.query_id,
+ MAX(rs.max_duration ) max_duration
+ FROM sys.query_store_query_text AS qt
+ JOIN sys.query_store_query AS q
+ ON qt.query_text_id = q.query_text_id
+ JOIN sys.query_store_plan AS p
+ ON q.query_id = p.query_id
+ JOIN sys.query_store_runtime_stats AS rs
+ ON p.plan_id = rs.plan_id
+ WHERE rs.last_execution_time > DATEADD(week, -1, GETUTCDATE())
+ AND is_internal_query = 0
+ GROUP BY q.query_id
+ ORDER BY MAX(rs.max_duration ) DESC)
+SELECT
+ q.query_id,
+ format(rs.last_execution_time,'yyyy-MM-dd hh:mm:ss') as [last_execution_time],
+ rs.max_duration,
+ p.plan_id
+FROM sys.query_store_query_text AS qt
+ JOIN sys.query_store_query AS q
+ ON qt.query_text_id = q.query_text_id
+ JOIN sys.query_store_plan AS p
+ ON q.query_id = p.query_id
+ JOIN sys.query_store_runtime_stats AS rs
+ ON p.plan_id = rs.plan_id
+ JOIN SlowestQry tq
+ ON tq.query_id = q.query_id
+WHERE rs.last_execution_time > DATEADD(week, -1, GETUTCDATE())
+AND is_internal_query = 0
+order by format(rs.last_execution_time,'yyyy-MM-dd hh:mm:ss')
+END
+else
+select 0 as [query_id], getdate() as [QDS is not enabled], 0 as [max_duration]
\ No newline at end of file
diff --git a/samples/extensionSamples/src/utils.ts b/samples/extensionSamples/src/utils.ts
new file mode 100644
index 0000000000..0ecb143c95
--- /dev/null
+++ b/samples/extensionSamples/src/utils.ts
@@ -0,0 +1,45 @@
+'use strict';
+
+import * as fs from 'fs-extra';
+import * as handlebars from 'handlebars';
+import * as path from 'path';
+import * as vscode from 'vscode';
+
+import * as Constants from './constants';
+import * as LocalizedConstants from './localizedConstants';
+
+/**
+ * Helper to log messages to the developer console if enabled
+ * @param msg Message to log to the console
+ */
+export function logDebug(msg: any): void {
+ let config = vscode.workspace.getConfiguration(Constants.extensionConfigSectionName);
+ let logDebugInfo = config[Constants.configLogDebugInfo];
+ if (logDebugInfo === true) {
+ let currentTime = new Date().toLocaleTimeString();
+ let outputMsg = '[' + currentTime + ']: ' + msg ? msg.toString() : '';
+ console.log(outputMsg);
+ }
+}
+
+export function renderTemplateHtml(extensionPath: string, templateName: string, templateValues: object): Thenable {
+ let templatePath = path.join(extensionPath, 'resources', templateName);
+
+ // 1) Read the template from the disk
+ // 2) Compile it as a handlebars template and render the HTML
+ // 3) On failure, return a simple string as an error
+ return fs.readFile(templatePath, 'utf-8')
+ .then(templateText => {
+ let template = handlebars.compile(templateText);
+ return template(templateValues);
+ })
+ .then(
+ undefined,
+ error => {
+ logDebug(error);
+ return LocalizedConstants.msgErrorLoadingTab;
+ }
+ );
+}
+
+
diff --git a/samples/extensionSamples/tasks/buildtasks.js b/samples/extensionSamples/tasks/buildtasks.js
new file mode 100644
index 0000000000..f84a4cba20
--- /dev/null
+++ b/samples/extensionSamples/tasks/buildtasks.js
@@ -0,0 +1,118 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+"use strict";
+
+let del = require('del');
+let gulp = require('gulp');
+let srcmap = require('gulp-sourcemaps');
+let tslint = require('gulp-tslint');
+let ts = require('gulp-typescript');
+let cproc = require('child_process');
+let os = require('os');
+
+let config = require('./config');
+let tsProject = ts.createProject('tsconfig.json');
+
+
+// GULP TASKS //////////////////////////////////////////////////////////////
+gulp.task('clean', function(done) {
+ return del('out', done);
+});
+
+gulp.task('lint', () => {
+ return gulp.src([
+ config.paths.project.root + '/src/**/*.ts',
+ config.paths.project.root + '/test/**/*.ts'
+ ])
+ .pipe((tslint({
+ formatter: "verbose"
+ })))
+ .pipe(tslint.report());
+});
+
+gulp.task('compile:src', function(done) {
+ gulp.src([
+ config.paths.project.root + '/src/**/*.sql',
+ config.paths.project.root + '/src/**/*.svg',
+ config.paths.project.root + '/src/**/*.html'
+ ]).pipe(gulp.dest('out/src/'));
+
+ let srcFiles = [
+ config.paths.project.root + '/src/**/*.ts',
+ config.paths.project.root + '/src/**/*.js',
+ config.paths.project.root + '/typings/**/*.ts'
+ ];
+
+ return gulp.src(srcFiles)
+ .pipe(srcmap.init())
+ .pipe(tsProject())
+ .on('error', function() {
+ if(process.env.BUILDMACHINE) {
+ done('Failed to compile extension source, see above.');
+ process.exit(1);
+ }
+ })
+ // TODO: Reinstate localization code
+ // .pipe(nls.rewriteLocalizeCalls())
+ // .pipe(nls.createAdditionalLanguageFiles(nls.coreLanguages, config.paths.project.root + '/localization/i18n', undefined, false))
+ .pipe(srcmap.write('.', { sourceRoot: function(file) { return file.cwd + '/src'; }}))
+ .pipe(gulp.dest('out/src/'));
+});
+
+gulp.task('compile:test', function(done) {
+ let srcFiles = [
+ config.paths.project.root + '/test/**/*.ts',
+ config.paths.project.root + '/typings/**/*.ts'
+ ];
+
+ return gulp.src(srcFiles)
+ .pipe(srcmap.init())
+ .pipe(tsProject())
+ .on('error', function() {
+ if(process.env.BUILDMACHINE) {
+ done('Failed to compile test source, see above.');
+ process.exit(1);
+ }
+ })
+ .pipe(srcmap.write('.', {sourceRoot: function(file) { return file.cwd + '/test'; }}))
+ .pipe(gulp.dest('out/test/'));
+});
+
+// COMPOSED GULP TASKS /////////////////////////////////////////////////////
+gulp.task("compile", gulp.series("compile:src", "compile:test"));
+
+gulp.task("build", gulp.series("clean", "lint", "compile"));
+
+gulp.task("watch", function() {
+ gulp.watch([config.paths.project.root + '/src/**/*',
+ config.paths.project.root + '/test/**/*.ts'],
+ gulp.series('build'))
+});
+
+gulp.task('test', (done) => {
+ let workspace = process.env['WORKSPACE'];
+ if (!workspace) {
+ workspace = process.cwd();
+ }
+ process.env.JUNIT_REPORT_PATH = workspace + '/test-reports/ext_xunit.xml';
+
+ let sqlopsPath = 'sqlops';
+ if (process.env['SQLOPS_DEV']) {
+ let suffix = os.platform === 'win32' ? 'bat' : 'sh';
+ sqlopsPath = `${process.env['SQLOPS_DEV']}/scripts/sql-cli.${suffix}`;
+ }
+ console.log(`Using SQLOPS Path of ${sqlopsPath}`);
+
+ cproc.exec(`${sqlopsPath} --extensionDevelopmentPath="${workspace}" --extensionTestsPath="${workspace}/out/test" --verbose`, (error, stdout, stderr) => {
+ if (error) {
+ console.error(`exec error: ${error}`);
+ process.exit(1);
+ }
+ console.log(`stdout: ${stdout}`);
+ console.log(`stderr: ${stderr}`);
+ done();
+ });
+});
diff --git a/samples/extensionSamples/tasks/config.js b/samples/extensionSamples/tasks/config.js
new file mode 100644
index 0000000000..df94d9f6e1
--- /dev/null
+++ b/samples/extensionSamples/tasks/config.js
@@ -0,0 +1,27 @@
+var path = require('path');
+
+var projectRoot = path.resolve(path.dirname(__dirname));
+var srcRoot = path.resolve(projectRoot, 'src');
+var viewsRoot = path.resolve(srcRoot, 'views');
+var htmlcontentRoot = path.resolve(viewsRoot, 'htmlcontent');
+var outRoot = path.resolve(projectRoot, 'out');
+var htmloutroot = path.resolve(outRoot, 'src/views/htmlcontent');
+var localization = path.resolve(projectRoot, 'localization');
+
+var config = {
+ paths: {
+ project: {
+ root: projectRoot,
+ localization: localization
+ },
+ extension: {
+ root: srcRoot
+ },
+ html: {
+ root: htmlcontentRoot,
+ out: htmloutroot
+ }
+ }
+};
+
+module.exports = config;
diff --git a/samples/extensionSamples/tasks/packagetasks.js b/samples/extensionSamples/tasks/packagetasks.js
new file mode 100644
index 0000000000..dda03fb708
--- /dev/null
+++ b/samples/extensionSamples/tasks/packagetasks.js
@@ -0,0 +1,148 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+'use strict';
+
+let gulp = require('gulp');
+let exec = require('child-process-promise').exec;
+let color = require('gulp-color');
+
+// CONSTANTS ///////////////////////////////////////////////////////////////
+let packageVals = require('../package');
+
+// HELPER FUNCTIONS ////////////////////////////////////////////////////////
+
+let buildPackage = function(packageName) {
+ // Make sure there are
+ if (!packageVals.repository) {
+ return Promise.reject("Repository field is not defined in package.json");
+ }
+
+ // Initialize the package command with program and command
+ let vsceArgs = [];
+ vsceArgs.push('./node_modules/vsce/out/vsce');
+ vsceArgs.push('package'); // package command
+
+ // Add the package name
+ vsceArgs.push('-o');
+ vsceArgs.push(packageName);
+
+ // Put it all together and execute the command
+ let command = vsceArgs.join(' ');
+ console.log(command);
+ return exec(command);
+};
+
+
+// function getServiceInstaller() {
+// let Constants = require('../out/src/models/constants').Constants;
+// let ServiceInstaller = require('../out/src/languageservice/serviceInstallerUtil').ServiceInstaller;
+// return new ServiceInstaller(new Constants())
+// }
+//
+// function installToolsService(platform) {
+// let installer = getServiceInstaller();
+// return installer.installService(platform);
+// }
+
+// function cleanServiceInstallFolder() {
+// let installer = getServiceInstaller();
+// return new Promise(function(resolve, reject) {
+// installer.getServiceInstallDirectoryRoot().then(function (serviceInstallFolder) {
+// console.log('Deleting Service Install folder: ' + serviceInstallFolder);
+// del(serviceInstallFolder + '/*').then(function () {
+// resolve();
+// }).catch(function (error) {
+// reject(error)
+// });
+// });
+// });
+// }
+
+// function doOfflinePackage(runtimeId, platform, packageName) {
+// return installSqlToolsService(platform).then(function() {
+// return doPackageSync(packageName + '-' + runtimeId + '.vsix');
+// });
+// }
+
+// ORIGINAL GULP TASKS /////////////////////////////////////////////////////
+// TODO: Reinstate when we have code for loading a tools service
+
+// gulp.task('ext:install-service', function() {
+// return installSqlToolsService();
+// });
+
+// Install vsce to be able to run this task: npm install -g vsce
+// gulp.task('package:online', function() {
+// return cleanServiceInstallFolder()
+// .then(function() { return doPackageSync(); });
+// });
+
+// Install vsce to be able to run this task: npm install -g vsce
+// gulp.task('package:offline', function() {
+// const platform = require('../out/src/models/platform');
+// const Runtime = platform.Runtime;
+// let json = JSON.parse(fs.readFileSync('package.json').toString());
+// let name = json.name;
+// let version = json.version;
+// let packageName = name + '-' + version;
+//
+// let packages = [];
+// packages.push({rid: 'win-x64', runtime: Runtime.Windows_64});
+// packages.push({rid: 'win-x86', runtime: Runtime.Windows_86});
+// packages.push({rid: 'osx', runtime: Runtime.OSX});
+// packages.push({rid: 'linux-x64', runtime: Runtime.Linux_64});
+//
+// let promise = Promise.resolve();
+// cleanServiceInstallFolder().then(function () {
+// packages.forEach(function (data) {
+// promise = promise.then(function () {
+// return doOfflinePackage(data.rid, data.runtime, packageName).then(function () {
+// return cleanServiceInstallFolder();
+// });
+// });
+// });
+// });
+//
+// return promise;
+// });
+
+function getOnlinePackageName() {
+ return packageVals.name + "-" + packageVals.version + ".vsix";
+}
+
+function getOnlinePackagePath() {
+ return './' + getOnlinePackageName();
+}
+
+// TEMPORARY GULP TASKS ////////////////////////////////////////////////////
+gulp.task('package:online', gulp.series("build", function() {
+ return buildPackage(getOnlinePackageName());
+}));
+
+gulp.task('package:offline', gulp.series("build", function(done) {
+ // TODO: Get list of platforms
+ // TODO: For each platform: clean the package service folder, download the service, build the package
+ console.error("This mode is not yet supported");
+ done("This mode is not yet supported");
+}));
+
+gulp.task('install:sqlops', gulp.series("package:online", function() {
+ let command = 'sqlops --install-extension ' + getOnlinePackagePath();
+ console.log(command);
+ return exec(command);
+}));
+
+gulp.task("help:debug", function(done) {
+ let command = '$SQLOPS_DEV/scripts/sql.sh --extensionDevelopmentPath='+process.cwd();
+ console.log('Launch sqlops + your extension (from a sqlops dev enlistment after setting $SQLOPS_DEV to your enlistment root):\n')
+ console.log(color(command, 'GREEN'));
+
+ command = 'sqlops --extensionDevelopmentPath='+process.cwd();
+ console.log('\nLaunch sqlops + your extension (full SQLOPS - requires setting PATH variable)\n');
+ console.log(color(command, 'GREEN'));
+ done();
+})
+
diff --git a/samples/extensionSamples/tsconfig.json b/samples/extensionSamples/tsconfig.json
new file mode 100644
index 0000000000..11282c9adb
--- /dev/null
+++ b/samples/extensionSamples/tsconfig.json
@@ -0,0 +1,16 @@
+{
+ "compilerOptions": {
+ "module": "commonjs",
+ "target": "es6",
+ "outDir": "out",
+ "lib": [
+ "es6"
+ ],
+ "sourceMap": true,
+ "rootDir": "."
+ },
+ "exclude": [
+ "node_modules",
+ ".vscode-test"
+ ]
+}
\ No newline at end of file
diff --git a/samples/extensionSamples/tslint.json b/samples/extensionSamples/tslint.json
new file mode 100644
index 0000000000..39a9a3ec2a
--- /dev/null
+++ b/samples/extensionSamples/tslint.json
@@ -0,0 +1,123 @@
+{
+ "rules": {
+ "align": [
+ true,
+ "parameters",
+ "statements"
+ ],
+ "ban": false,
+ "class-name": true,
+ "comment-format": [
+ true,
+ "check-space"
+ ],
+ "curly": true,
+ "eofline": true,
+ "forin": true,
+ "indent": [
+ true,
+ "spaces"
+ ],
+ "interface-name": true,
+ "jsdoc-format": true,
+ "label-position": true,
+ "label-undefined": true,
+ "max-line-length": [
+ true,
+ 160
+ ],
+ "member-access": false,
+ "member-ordering": false,
+ "no-any": false,
+ "no-arg": true,
+ "no-bitwise": true,
+ "no-conditional-assignment": true,
+ "no-consecutive-blank-lines": false,
+ "no-console": [
+ true,
+ "debug",
+ "info",
+ "time",
+ "timeEnd",
+ "trace"
+ ],
+ "no-construct": true,
+ "no-constructor-vars": false,
+ "no-debugger": true,
+ "no-duplicate-key": true,
+ "no-duplicate-variable": true,
+ "no-empty": true,
+ "no-eval": true,
+ "no-inferrable-types": false,
+ "no-internal-module": true,
+ "no-null-keyword": true,
+ "no-require-imports": false,
+ "no-shadowed-variable": true,
+ "no-string-literal": false,
+ "no-switch-case-fall-through": false,
+ "no-trailing-whitespace": true,
+ "no-unreachable": true,
+ "no-unused-expression": false,
+ "no-unused-variable": true,
+ "no-use-before-declare": true,
+ "no-var-keyword": true,
+ "no-var-requires": false,
+ "object-literal-sort-keys": false,
+ "one-line": [
+ true,
+ "check-open-brace",
+ "check-catch",
+ "check-else",
+ "check-finally",
+ "check-whitespace"
+ ],
+ "quotemark": [
+ true,
+ "single",
+ "avoid-escape"
+ ],
+ "radix": true,
+ "semicolon": true,
+ "switch-default": true,
+ "trailing-comma": [
+ true,
+ {
+ "multiline": "never",
+ "singleline": "never"
+ }
+ ],
+ "triple-equals": [
+ true,
+ "allow-null-check"
+ ],
+ "typedef": [
+ true,
+ "call-signature",
+ "property-declaration"
+ ],
+ "typedef-whitespace": [
+ true,
+ {
+ "call-signature": "nospace",
+ "index-signature": "nospace",
+ "parameter": "nospace",
+ "property-declaration": "nospace",
+ "variable-declaration": "nospace"
+ }
+ ],
+ "use-strict": false,
+ "variable-name": [
+ true,
+ "allow-leading-underscore",
+ "ban-keywords"
+ ],
+ "whitespace": [
+ true,
+ "check-branch",
+ "check-decl",
+ "check-operator",
+ "check-separator",
+ "check-type"
+ ]
+ }
+}
\ No newline at end of file
diff --git a/samples/extensionSamples/typings/sqlops.d.ts b/samples/extensionSamples/typings/sqlops.d.ts
new file mode 100644
index 0000000000..fe4eccc480
--- /dev/null
+++ b/samples/extensionSamples/typings/sqlops.d.ts
@@ -0,0 +1,1530 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'sqlops' {
+ import * as vscode from 'vscode';
+
+ // EXPORTED NAMESPACES /////////////////////////////////////////////////
+ /**
+ * Namespace for Data Management Protocol global methods
+ */
+ export namespace dataprotocol {
+ export function registerConnectionProvider(provider: ConnectionProvider): vscode.Disposable;
+
+ export function registerBackupProvider(provider: BackupProvider): vscode.Disposable;
+
+ export function registerRestoreProvider(provider: RestoreProvider): vscode.Disposable;
+
+ export function registerScriptingProvider(provider: ScriptingProvider): vscode.Disposable;
+
+ export function registerObjectExplorerProvider(provider: ObjectExplorerProvider): vscode.Disposable;
+
+ export function registerTaskServicesProvider(provider: TaskServicesProvider): vscode.Disposable;
+
+ export function registerFileBrowserProvider(provider: FileBrowserProvider): vscode.Disposable;
+
+ export function registerProfilerProvider(provider: ProfilerProvider): vscode.Disposable;
+
+ export function registerMetadataProvider(provider: MetadataProvider): vscode.Disposable;
+
+ export function registerQueryProvider(provider: QueryProvider): vscode.Disposable;
+
+ export function registerAdminServicesProvider(provider: AdminServicesProvider): vscode.Disposable;
+
+ export function registerCapabilitiesServiceProvider(provider: CapabilitiesProvider): vscode.Disposable;
+
+ /**
+ * An [event](#Event) which fires when the specific flavor of a language used in DMP
+ * connections has changed. And example is for a SQL connection, the flavor changes
+ * to MSSQL
+ */
+ export const onDidChangeLanguageFlavor: vscode.Event;
+ }
+
+ /**
+ * Namespace for credentials management global methods, available to all extensions
+ */
+ export namespace credentials {
+ /**
+ * Register a credential provider to handle credential requests.
+ * @param {CredentialProvider} provider The provider to register
+ * @return {Disposable} Handle to the provider for disposal
+ */
+ export function registerProvider(provider: CredentialProvider): vscode.Disposable;
+
+ /**
+ * Retrieves a provider from the extension host if one has been registered. Any credentials
+ * accessed with the returned provider will have the namespaceId appended to credential ID
+ * to prevent extensions from trampling over each others' credentials.
+ * @param {string} namespaceId ID that will be appended to credential IDs.
+ * @return {Thenable} Promise that returns the namespaced provider
+ */
+ export function getProvider(namespaceId: string): Thenable;
+ }
+
+ /**
+ * Namespace for serialization management global methods
+ */
+ export namespace serialization {
+ export function registerProvider(provider: SerializationProvider): vscode.Disposable;
+ }
+
+ /**
+ * Namespace for connection management
+ */
+ export namespace connection {
+ /**
+ * Get the current connection based on the active editor or Object Explorer selection
+ */
+ export function getCurrentConnection(): Thenable;
+
+ /**
+ * Get all active connections
+ */
+ export function getActiveConnections(): Thenable;
+
+ /**
+ * Get the credentials for an active connection
+ * @param {string} connectionId The id of the connection
+ * @returns {{ [name: string]: string}} A dictionary containing the credentials as they would be included in the connection's options dictionary
+ */
+ export function getCredentials(connectionId: string): Thenable<{ [name: string]: string }>;
+
+ /**
+ * Interface for representing a connection when working with connection APIs
+ */
+ export interface Connection extends ConnectionInfo {
+ /**
+ * The name of the provider managing the connection (e.g. MSSQL)
+ */
+ providerName: string;
+
+ /**
+ * A unique identifier for the connection
+ */
+ connectionId: string;
+ }
+ }
+
+ // EXPORTED INTERFACES /////////////////////////////////////////////////
+ export interface ConnectionInfo {
+
+ options: { [name: string]: any };
+ }
+
+ export interface IConnectionProfile extends ConnectionInfo {
+ serverName: string;
+ databaseName: string;
+ userName: string;
+ password: string;
+ authenticationType: string;
+ savePassword: boolean;
+ groupFullName: string;
+ groupId: string;
+ providerName: string;
+ saveProfile: boolean;
+ id: string;
+ }
+
+ export interface ConnectionInfoSummary {
+
+ /**
+ * URI identifying the owner of the connection
+ */
+ ownerUri: string;
+
+ /**
+ * connection id returned from service host.
+ */
+ connectionId: string;
+
+ /**
+ * any diagnostic messages return from the service host.
+ */
+ messages: string;
+
+ /**
+ * Error message returned from the engine, if any.
+ */
+ errorMessage: string;
+
+ /**
+ * Error number returned from the engine, if any.
+ */
+ errorNumber: number;
+ /**
+ * Information about the connected server.
+ */
+ serverInfo: ServerInfo;
+ /**
+ * information about the actual connection established
+ */
+ connectionSummary: ConnectionSummary;
+ }
+
+ /**
+ * Summary that identifies a unique database connection.
+ */
+ export interface ConnectionSummary {
+ /**
+ * server name
+ */
+ serverName: string;
+ /**
+ * database name
+ */
+ databaseName: string;
+ /**
+ * user name
+ */
+ userName: string;
+ }
+
+ /**
+ * Information about a Server instance.
+ */
+ export interface ServerInfo {
+ /**
+ * The major version of the instance.
+ */
+ serverMajorVersion: number;
+ /**
+ * The minor version of the instance.
+ */
+ serverMinorVersion: number;
+ /**
+ * The build of the instance.
+ */
+ serverReleaseVersion: number;
+ /**
+ * The ID of the engine edition of the instance.
+ */
+ engineEditionId: number;
+ /**
+ * String containing the full server version text.
+ */
+ serverVersion: string;
+ /**
+ * String describing the product level of the server.
+ */
+ serverLevel: string;
+ /**
+ * The edition of the instance.
+ */
+ serverEdition: string;
+ /**
+ * Whether the instance is running in the cloud (Azure) or not.
+ */
+ isCloud: boolean;
+ /**
+ * The version of Azure that the instance is running on, if applicable.
+ */
+ azureVersion: number;
+ /**
+ * The Operating System version string of the machine running the instance.
+ */
+ osVersion: string;
+ }
+
+ export interface DataProvider {
+ handle?: number;
+ readonly providerId: string;
+ }
+
+ export interface ConnectionProvider extends DataProvider {
+
+ connect(connectionUri: string, connectionInfo: ConnectionInfo): Thenable;
+
+ disconnect(connectionUri: string): Thenable;
+
+ cancelConnect(connectionUri: string): Thenable;
+
+ listDatabases(connectionUri: string): Thenable;
+
+ changeDatabase(connectionUri: string, newDatabase: string): Thenable;
+
+ rebuildIntelliSenseCache(connectionUri: string): Thenable;
+
+ registerOnConnectionComplete(handler: (connSummary: ConnectionInfoSummary) => any): void;
+
+ registerOnIntelliSenseCacheComplete(handler: (connectionUri: string) => any): void;
+
+ registerOnConnectionChanged(handler: (changedConnInfo: ChangedConnectionInfo) => any): void;
+ }
+
+ export enum ServiceOptionType {
+ string = 0,
+ multistring = 1,
+ password = 2,
+ number = 3,
+ category = 4,
+ boolean = 5,
+ object = 6
+ }
+
+ export enum ConnectionOptionSpecialType {
+ serverName = 'serverName',
+ databaseName = 'databaseName',
+ authType = 'authType',
+ userName = 'userName',
+ password = 'password',
+ appName = 'appName'
+ }
+
+ export interface CategoryValue {
+ displayName: string;
+ name: string;
+ }
+
+ export interface ConnectionOption {
+ name: string;
+
+ displayName: string;
+
+ description: string;
+
+ groupName: string;
+
+ valueType: ServiceOptionType;
+
+ specialValueType: ConnectionOptionSpecialType;
+
+ defaultValue: string;
+
+ categoryValues: CategoryValue[];
+
+ isIdentity: boolean;
+
+ isRequired: boolean;
+ }
+
+ export interface ConnectionProviderOptions {
+ options: ConnectionOption[];
+ }
+
+ export interface ServiceOption {
+ name: string;
+
+ displayName: string;
+
+ description: string;
+
+ groupName: string;
+
+ valueType: ServiceOptionType;
+
+ defaultValue: string;
+
+ objectType: string;
+
+ categoryValues: CategoryValue[];
+
+ isRequired: boolean;
+
+ isArray: boolean;
+ }
+
+ export interface AdminServicesOptions {
+ databaseInfoOptions: ServiceOption[];
+
+ databaseFileInfoOptions: ServiceOption[];
+
+ fileGroupInfoOptions: ServiceOption[];
+ }
+
+
+ // List Databases Request ----------------------------------------------------------------------
+ export interface ListDatabasesResult {
+ databaseNames: Array;
+ }
+
+ /**
+ * Information about a connection changed event for a resource represented by a URI
+ */
+ export interface ChangedConnectionInfo {
+ /**
+ * Owner URI of the connection that changed.
+ */
+ connectionUri: string;
+
+ /**
+ * Summary of details containing any connection changes.
+ */
+ connection: ConnectionSummary;
+ }
+
+ export interface FeatureMetadataProvider {
+ enabled: boolean;
+
+ featureName: string;
+
+ optionsMetadata: ServiceOption[];
+ }
+
+ export interface DataProtocolServerCapabilities {
+ protocolVersion: string;
+
+ providerName: string;
+
+ providerDisplayName: string;
+
+ connectionProvider: ConnectionProviderOptions;
+
+ adminServicesProvider: AdminServicesOptions;
+
+ features: FeatureMetadataProvider[];
+ }
+
+ export interface DataProtocolClientCapabilities {
+ hostName: string;
+
+ hostVersion: string;
+ }
+
+ export interface CapabilitiesProvider extends DataProvider {
+ getServerCapabilities(client: DataProtocolClientCapabilities): Thenable;
+ }
+
+ export enum MetadataType {
+ Table = 0,
+ View = 1,
+ SProc = 2,
+ Function = 3
+ }
+
+ export interface ObjectMetadata {
+ metadataType: MetadataType;
+
+ metadataTypeName: string;
+
+ urn: string;
+
+ name: string;
+
+ schema: string;
+ }
+
+ export interface ColumnMetadata {
+
+ hasExtendedProperties: boolean;
+
+ defaultValue: string;
+
+ ///
+ /// Escaped identifier for the name of the column
+ ///
+ escapedName: string;
+
+ ///
+ /// Whether or not the column is computed
+ ///
+ isComputed: boolean;
+
+ ///
+ /// Whether or not the column is deterministically computed
+ ///
+ isDeterministic: boolean;
+
+ ///
+ /// Whether or not the column is an identity column
+ ///
+ isIdentity: boolean;
+
+ ///
+ /// The ordinal ID of the column
+ ///
+ ordinal: number;
+
+ ///
+ /// Whether or not the column is calculated on the server side. This could be a computed
+ /// column or a identity column.
+ ///
+ isCalculated: boolean;
+
+ ///
+ /// Whether or not the column is used in a key to uniquely identify a row
+ ///
+ isKey: boolean;
+
+ ///
+ /// Whether or not the column can be trusted for uniqueness
+ ///
+ isTrustworthyForUniqueness: boolean;
+ }
+
+ export interface TableMetadata {
+
+ columns: ColumnMetadata;
+
+ }
+
+ export interface ProviderMetadata {
+ objectMetadata: ObjectMetadata[];
+ }
+
+ export interface MetadataProvider extends DataProvider {
+ getMetadata(connectionUri: string): Thenable;
+
+ getDatabases(connectionUri: string): Thenable;
+
+ getTableInfo(connectionUri: string, metadata: ObjectMetadata): Thenable;
+
+ getViewInfo(connectionUri: string, metadata: ObjectMetadata): Thenable;
+ }
+
+ export enum ScriptOperation {
+ Select = 0,
+ Create = 1,
+ Insert = 2,
+ Update = 3,
+ Delete = 4,
+ Execute = 5,
+ Alter = 6
+ }
+
+ export interface ScriptingResult {
+ operationId: string;
+ script: string;
+ }
+
+ export interface ScriptingParamDetails {
+ filePath: string;
+ scriptCompatibilityOption: string;
+ targetDatabaseEngineEdition: string;
+ targetDatabaseEngineType: string;
+ }
+
+ export interface ScriptingProvider extends DataProvider {
+
+ scriptAsOperation(connectionUri: string, operation: ScriptOperation, metadata: ObjectMetadata, paramDetails: ScriptingParamDetails): Thenable;
+
+ registerOnScriptingComplete(handler: (scriptingCompleteResult: ScriptingCompleteResult) => any);
+ }
+
+ export interface ScriptingCompleteResult {
+ errorDetails: string;
+
+ errorMessage: string;
+
+ hasError: boolean;
+
+ canceled: boolean;
+
+ success: boolean;
+
+ operationId: string;
+ }
+
+ /**
+ * Parameters to initialize a connection to a database
+ */
+ export interface Credential {
+ /**
+ * Unique ID identifying the credential
+ */
+ credentialId: string;
+
+ /**
+ * password
+ */
+ password: string;
+ }
+
+ export interface CredentialProvider {
+ handle: number;
+
+ saveCredential(credentialId: string, password: string): Thenable;
+
+ readCredential(credentialId: string): Thenable;
+
+ deleteCredential(credentialId: string): Thenable;
+ }
+
+ export interface SerializationProvider {
+ handle: number;
+ saveAs(saveFormat: string, savePath: string, results: string, appendToFile: boolean): Thenable;
+ }
+
+
+ export interface DidChangeLanguageFlavorParams {
+ uri: string;
+ language: string;
+ flavor: string;
+ }
+
+ export interface QueryProvider extends DataProvider {
+ cancelQuery(ownerUri: string): Thenable;
+ runQuery(ownerUri: string, selection: ISelectionData, runOptions?: ExecutionPlanOptions): Thenable;
+ runQueryStatement(ownerUri: string, line: number, column: number): Thenable;
+ runQueryString(ownerUri: string, queryString: string): Thenable;
+ runQueryAndReturn(ownerUri: string, queryString: string): Thenable;
+ getQueryRows(rowData: QueryExecuteSubsetParams): Thenable;
+ disposeQuery(ownerUri: string): Thenable;
+ saveResults(requestParams: SaveResultsRequestParams): Thenable;
+
+ // Notifications
+ registerOnQueryComplete(handler: (result: QueryExecuteCompleteNotificationResult) => any): void;
+ registerOnBatchStart(handler: (batchInfo: QueryExecuteBatchNotificationParams) => any): void;
+ registerOnBatchComplete(handler: (batchInfo: QueryExecuteBatchNotificationParams) => any): void;
+ registerOnResultSetComplete(handler: (resultSetInfo: QueryExecuteResultSetCompleteNotificationParams) => any): void;
+ registerOnMessage(handler: (message: QueryExecuteMessageParams) => any): void;
+
+ // Edit Data Requests
+ commitEdit(ownerUri: string): Thenable;
+ createRow(ownerUri: string): Thenable;
+ deleteRow(ownerUri: string, rowId: number): Thenable;
+ disposeEdit(ownerUri: string): Thenable;
+ initializeEdit(ownerUri: string, schemaName: string, objectName: string, objectType: string, rowLimit: number): Thenable;
+ revertCell(ownerUri: string, rowId: number, columnId: number): Thenable;
+ revertRow(ownerUri: string, rowId: number): Thenable;
+ updateCell(ownerUri: string, rowId: number, columnId: number, newValue: string): Thenable;
+ getEditRows(rowData: EditSubsetParams): Thenable;
+
+ // Edit Data Notifications
+ registerOnEditSessionReady(handler: (ownerUri: string, success: boolean, message: string) => any): void;
+ }
+
+ export interface IDbColumn {
+ allowDBNull?: boolean;
+ baseCatalogName: string;
+ baseColumnName: string;
+ baseSchemaName: string;
+ baseServerName: string;
+ baseTableName: string;
+ columnName: string;
+ columnOrdinal?: number;
+ columnSize?: number;
+ isAliased?: boolean;
+ isAutoIncrement?: boolean;
+ isExpression?: boolean;
+ isHidden?: boolean;
+ isIdentity?: boolean;
+ isKey?: boolean;
+ isBytes?: boolean;
+ isChars?: boolean;
+ isSqlVariant?: boolean;
+ isUdt?: boolean;
+ dataType: string;
+ isXml?: boolean;
+ isJson?: boolean;
+ isLong?: boolean;
+ isReadOnly?: boolean;
+ isUnique?: boolean;
+ numericPrecision?: number;
+ numericScale?: number;
+ udtAssemblyQualifiedName: string;
+ dataTypeName: string;
+ }
+
+ export interface IGridResultSet {
+ columns: IDbColumn[];
+ rowsUri: string;
+ numberOfRows: number;
+ }
+
+ export interface IResultMessage {
+ batchId?: number;
+ isError: boolean;
+ time: string;
+ message: string;
+ }
+
+ export interface ISelectionData {
+ startLine: number;
+ startColumn: number;
+ endLine: number;
+ endColumn: number;
+ }
+
+ export interface ResultSetSummary {
+ id: number;
+ batchId: number;
+ rowCount: number;
+ columnInfo: IDbColumn[];
+ }
+
+ export interface BatchSummary {
+ hasError: boolean;
+ id: number;
+ selection: ISelectionData;
+ resultSetSummaries: ResultSetSummary[];
+ executionElapsed: string;
+ executionEnd: string;
+ executionStart: string;
+ }
+
+ export enum EditRowState {
+ clean = 0,
+ dirtyInsert = 1,
+ dirtyDelete = 2,
+ dirtyUpdate = 3
+ }
+
+ export interface EditRow {
+ cells: DbCellValue[];
+ id: number;
+ isDirty: boolean;
+ state: EditRowState;
+ }
+
+ export interface EditCell extends DbCellValue {
+ isDirty: boolean;
+ }
+
+ export interface QueryExecuteCompleteNotificationResult {
+ ownerUri: string;
+ batchSummaries: BatchSummary[];
+ }
+
+ export interface ExecutionPlanOptions {
+ displayEstimatedQueryPlan?: boolean;
+ displayActualQueryPlan?: boolean;
+ }
+
+ export interface SimpleExecuteParams {
+ queryString: string;
+ ownerUri: string;
+ }
+
+ export interface SimpleExecuteResult {
+ rowCount: number;
+ columnInfo: IDbColumn[];
+ rows: DbCellValue[][];
+ }
+
+ // Query Batch Notification -----------------------------------------------------------------------
+ export interface QueryExecuteBatchNotificationParams {
+ batchSummary: BatchSummary;
+ ownerUri: string;
+ }
+
+
+ export interface QueryExecuteResultSetCompleteNotificationParams {
+ resultSetSummary: ResultSetSummary;
+ ownerUri: string;
+ }
+
+
+ export interface QueryExecuteMessageParams {
+ message: IResultMessage;
+ ownerUri: string;
+ }
+
+ export interface QueryExecuteSubsetParams {
+ ownerUri: string;
+ batchIndex: number;
+ resultSetIndex: number;
+ rowsStartIndex: number;
+ rowsCount: number;
+ }
+
+ export interface DbCellValue {
+ displayValue: string;
+ isNull: boolean;
+ }
+
+ export interface ResultSetSubset {
+ rowCount: number;
+ rows: DbCellValue[][];
+ }
+
+ export interface QueryExecuteSubsetResult {
+ message: string;
+ resultSubset: ResultSetSubset;
+ }
+
+ export interface QueryCancelResult {
+ messages: string;
+ }
+
+ // Save Results ===============================================================================
+ export interface SaveResultsRequestParams {
+ /**
+ * 'csv', 'json', 'excel'
+ */
+ resultFormat: string;
+ ownerUri: string;
+ filePath: string;
+ batchIndex: number;
+ resultSetIndex: number;
+ rowStartIndex: number;
+ rowEndIndex: number;
+ columnStartIndex: number;
+ columnEndIndex: number;
+ includeHeaders?: boolean;
+ }
+
+ export interface SaveResultRequestResult {
+ messages: string;
+ }
+
+ // Edit Data ==================================================================================
+ // Shared Interfaces --------------------------------------------------------------------------
+ export interface IEditSessionOperationParams {
+ ownerUri: string;
+ }
+
+ export interface IEditRowOperationParams extends IEditSessionOperationParams {
+ rowId: number;
+ }
+
+ export interface EditCellResult {
+ cell: EditCell;
+ isRowDirty: boolean;
+ }
+
+ // edit/commit --------------------------------------------------------------------------------
+ export interface EditCommitParams extends IEditSessionOperationParams { }
+ export interface EditCommitResult { }
+
+ // edit/createRow -----------------------------------------------------------------------------
+ export interface EditCreateRowParams extends IEditSessionOperationParams { }
+ export interface EditCreateRowResult {
+ defaultValues: string[];
+ newRowId: number;
+ }
+
+ // edit/deleteRow -----------------------------------------------------------------------------
+ export interface EditDeleteRowParams extends IEditRowOperationParams { }
+ export interface EditDeleteRowResult { }
+
+ // edit/dispose -------------------------------------------------------------------------------
+ export interface EditDisposeParams extends IEditSessionOperationParams { }
+ export interface EditDisposeResult { }
+
+ // edit/initialize ----------------------------------------------------------------------------
+ export interface EditInitializeFiltering {
+ LimitResults?: number;
+ }
+
+ export interface EditInitializeParams extends IEditSessionOperationParams {
+ filters: EditInitializeFiltering;
+ objectName: string;
+ schemaName: string;
+ objectType: string;
+ }
+
+
+ export interface EditInitializeResult { }
+
+ // edit/revertCell ----------------------------------------------------------------------------
+ export interface EditRevertCellParams extends IEditRowOperationParams {
+ columnId: number;
+ }
+ export interface EditRevertCellResult extends EditCellResult {
+ }
+
+ // edit/revertRow -----------------------------------------------------------------------------
+ export interface EditRevertRowParams extends IEditRowOperationParams { }
+ export interface EditRevertRowResult { }
+
+ // edit/sessionReady Event --------------------------------------------------------------------
+ export interface EditSessionReadyParams {
+ ownerUri: string;
+ success: boolean;
+ message: string;
+ }
+
+ // edit/updateCell ----------------------------------------------------------------------------
+ export interface EditUpdateCellParams extends IEditRowOperationParams {
+ columnId: number;
+ newValue: string;
+ }
+
+ export interface EditUpdateCellResult extends EditCellResult {
+ }
+
+ // edit/subset --------------------------------------------------------------------------------
+ export interface EditSubsetParams extends IEditSessionOperationParams {
+ rowStartIndex: number;
+ rowCount: number;
+ }
+ export interface EditSubsetResult {
+ rowCount: number;
+ subset: EditRow[];
+ }
+
+ export interface NodeInfo {
+ nodePath: string;
+ nodeType: string;
+ nodeSubType: string;
+ nodeStatus: string;
+ label: string;
+ isLeaf: boolean;
+ metadata: ObjectMetadata;
+ errorMessage: string;
+ }
+
+ // Object Explorer interfaces -----------------------------------------------------------------------
+ export interface ObjectExplorerSession {
+ success: boolean;
+ sessionId: string;
+ rootNode: NodeInfo;
+ errorMessage: string;
+ }
+
+ export interface ObjectExplorerSessionResponse {
+ sessionId: string;
+ }
+
+ export interface ObjectExplorerExpandInfo {
+ sessionId: string;
+ nodePath: string;
+ nodes: NodeInfo[];
+ errorMessage: string;
+ }
+
+ export interface ExpandNodeInfo {
+ sessionId: string;
+ nodePath: string;
+ }
+
+ export interface ObjectExplorerCloseSessionInfo {
+ sessionId: string;
+ }
+
+ export interface ObjectExplorerCloseSessionResponse {
+ sessionId: string;
+ success: boolean;
+ }
+
+ export interface ObjectExplorerProvider extends DataProvider {
+ createNewSession(connInfo: ConnectionInfo): Thenable;
+
+ expandNode(nodeInfo: ExpandNodeInfo): Thenable;
+
+ refreshNode(nodeInfo: ExpandNodeInfo): Thenable;
+
+ closeSession(closeSessionInfo: ObjectExplorerCloseSessionInfo): Thenable;
+
+ registerOnSessionCreated(handler: (response: ObjectExplorerSession) => any);
+
+ registerOnExpandCompleted(handler: (response: ObjectExplorerExpandInfo) => any);
+
+ }
+
+ // Admin Services interfaces -----------------------------------------------------------------------
+ export interface DatabaseInfo {
+ options: {};
+ }
+
+ export interface LoginInfo {
+ name: string;
+ }
+
+ export interface CreateDatabaseResponse {
+ result: boolean;
+ taskId: number;
+ }
+
+ export interface CreateLoginResponse {
+ result: boolean;
+ taskId: number;
+ }
+
+ export interface AdminServicesProvider extends DataProvider {
+ createDatabase(connectionUri: string, database: DatabaseInfo): Thenable;
+
+ createLogin(connectionUri: string, login: LoginInfo): Thenable;
+
+ getDefaultDatabaseInfo(connectionUri: string): Thenable;
+
+ getDatabaseInfo(connectionUri: string): Thenable;
+ }
+
+ // Task service interfaces ----------------------------------------------------------------------------
+ export enum TaskStatus {
+ notStarted = 0,
+ inProgress = 1,
+ succeeded = 2,
+ succeededWithWarning = 3,
+ failed = 4,
+ canceled = 5
+ }
+
+ export enum TaskExecutionMode {
+ execute = 0,
+ script = 1,
+ executeAndScript = 2,
+ }
+
+ export interface ListTasksParams {
+ listActiveTasksOnly: boolean;
+ }
+
+ export interface TaskInfo {
+ taskId: string;
+ status: TaskStatus;
+ taskExecutionMode: TaskExecutionMode;
+ serverName: string;
+ databaseName: string;
+ name: string;
+ description: string;
+ providerName: string;
+ isCancelable: boolean;
+ }
+
+ export interface ListTasksResponse {
+ tasks: TaskInfo[];
+ }
+
+ export interface CancelTaskParams {
+ taskId: string;
+ }
+
+ export interface TaskProgressInfo {
+ taskId: string;
+ status: TaskStatus;
+ message: string;
+ script: string;
+ duration: number;
+ }
+
+ export interface TaskServicesProvider extends DataProvider {
+ getAllTasks(listTasksParams: ListTasksParams): Thenable;
+
+ cancelTask(cancelTaskParams: CancelTaskParams): Thenable;
+
+ registerOnTaskCreated(handler: (response: TaskInfo) => any);
+
+ registerOnTaskStatusChanged(handler: (response: TaskProgressInfo) => any);
+ }
+
+ // Disaster Recovery interfaces -----------------------------------------------------------------------
+
+ export interface BackupConfigInfo {
+ recoveryModel: string;
+ defaultBackupFolder: string;
+ backupEncryptors: {};
+ }
+
+ export interface BackupResponse {
+ result: boolean;
+ taskId: number;
+ }
+
+ export interface BackupProvider extends DataProvider {
+ backup(connectionUri: string, backupInfo: { [key: string]: any }, taskExecutionMode: TaskExecutionMode): Thenable;
+ getBackupConfigInfo(connectionUri: string): Thenable;
+ }
+
+ export interface RestoreProvider extends DataProvider {
+ getRestorePlan(connectionUri: string, restoreInfo: RestoreInfo): Thenable;
+ cancelRestorePlan(connectionUri: string, restoreInfo: RestoreInfo): Thenable;
+ restore(connectionUri: string, restoreInfo: RestoreInfo): Thenable;
+ getRestoreConfigInfo(connectionUri: string): Thenable;
+ }
+
+ export interface RestoreInfo {
+ options: { [key: string]: any };
+ taskExecutionMode: TaskExecutionMode;
+ }
+
+ export interface RestoreDatabaseFileInfo {
+ fileType: string;
+
+ logicalFileName: string;
+
+ originalFileName: string;
+
+ restoreAsFileName: string;
+ }
+
+ export interface DatabaseFileInfo {
+ properties: LocalizedPropertyInfo[];
+ id: string;
+ isSelected: boolean;
+ }
+
+ export interface LocalizedPropertyInfo {
+ propertyName: string;
+ propertyValue: string;
+ propertyDisplayName: string;
+ propertyValueDisplayName: string;
+ }
+
+ export interface RestorePlanDetailInfo {
+ name: string;
+ currentValue: any;
+ isReadOnly: boolean;
+ isVisible: boolean;
+ defaultValue: any;
+ }
+
+ export interface RestorePlanResponse {
+ sessionId: string;
+ backupSetsToRestore: DatabaseFileInfo[];
+ canRestore: boolean;
+ errorMessage: string;
+ dbFiles: RestoreDatabaseFileInfo[];
+ databaseNamesFromBackupSets: string[];
+ planDetails: { [key: string]: RestorePlanDetailInfo };
+ }
+
+ export interface RestoreConfigInfo {
+ configInfo: { [key: string]: any };
+ }
+
+ export interface RestoreResponse {
+ result: boolean;
+ taskId: string;
+ errorMessage: string;
+ }
+
+ export interface ProfilerProvider extends DataProvider {
+ startSession(sessionId: string): Thenable;
+ stopSession(sessionId: string): Thenable;
+ pauseSession(sessionId: string): Thenable;
+ connectSession(sessionId: string): Thenable;
+ disconnectSession(sessionId: string): Thenable;
+
+ registerOnSessionEventsAvailable(handler: (response: ProfilerSessionEvents) => any);
+ }
+
+ export interface IProfilerTableRow {
+ /**
+ * Name of the event; known issue this is not camel case, need to figure
+ * out a better way to determine column id's from rendered column names
+ */
+ EventClass: string;
+ }
+
+ export interface IProfilerMoreRowsNotificationParams {
+ uri: string;
+ rowCount: number;
+ data: IProfilerTableRow;
+ }
+
+ /**
+ * Profiler Event
+ */
+ export interface ProfilerEvent {
+ /**
+ * Event class name
+ */
+ name: string;
+
+ /**
+ * Event timestamp
+ */
+ timestamp: string;
+
+ /**
+ * Event values
+ */
+ values: {};
+ }
+
+ export interface ProfilerSessionEvents {
+ sessionId: string;
+
+ events: ProfilerEvent[];
+ }
+
+ // File browser interfaces -----------------------------------------------------------------------
+
+ export interface FileBrowserProvider extends DataProvider {
+ openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable;
+ registerOnFileBrowserOpened(handler: (response: FileBrowserOpenedParams) => any);
+ expandFolderNode(ownerUri: string, expandPath: string): Thenable;
+ registerOnFolderNodeExpanded(handler: (response: FileBrowserExpandedParams) => any);
+ validateFilePaths(ownerUri: string, serviceType: string, selectedFiles: string[]): Thenable;
+ registerOnFilePathsValidated(handler: (response: FileBrowserValidatedParams) => any);
+ closeFileBrowser(ownerUri: string): Thenable;
+ }
+
+ export interface FileTreeNode {
+ children: FileTreeNode[];
+ isExpanded: boolean;
+ isFile: boolean;
+ name: string;
+ fullPath: string;
+ }
+
+ export interface FileTree {
+ rootNode: FileTreeNode;
+ selectedNode: FileTreeNode;
+ }
+
+ export interface FileBrowserOpenedParams {
+ ownerUri: string;
+ fileTree: FileTree;
+ succeeded: boolean;
+ message: string;
+ }
+
+ export interface FileBrowserExpandedParams {
+ ownerUri: string;
+ expandPath: string;
+ children: FileTreeNode[];
+ succeeded: boolean;
+ message: string;
+ }
+
+ export interface FileBrowserValidatedParams {
+ succeeded: boolean;
+ message: string;
+ }
+
+ export interface FileBrowserCloseResponse {
+ succeeded: boolean;
+ message: string;
+ }
+
+ // ACCOUNT MANAGEMENT //////////////////////////////////////////////////
+ export namespace accounts {
+ export function registerAccountProvider(providerMetadata: AccountProviderMetadata, provider: AccountProvider): vscode.Disposable;
+
+ /**
+ * Launches a flyout dialog that will display the information on how to complete device
+ * code OAuth login to the user. Only one flyout can be opened at once and each must be closed
+ * by calling {@link endAutoOAuthDeviceCode}.
+ * @param {string} providerId ID of the provider that's requesting the flyout be opened
+ * @param {string} title
+ * @param {string} message
+ * @param {string} userCode
+ * @param {string} uri
+ */
+ export function beginAutoOAuthDeviceCode(providerId: string, title: string, message: string, userCode: string, uri: string): Thenable;
+
+ /**
+ * Closes the flyout dialog opened by {@link beginAutoOAuthDeviceCode}
+ */
+ export function endAutoOAuthDeviceCode(): void;
+
+ /**
+ * Notifies the account management service that an account has updated (usually due to the
+ * account going stale).
+ * @param {Account} updatedAccount Account object with updated properties
+ */
+ export function accountUpdated(updatedAccount: Account): void;
+ }
+
+ /**
+ * Represents display information for an account.
+ */
+ export interface AccountDisplayInfo {
+ /**
+ * A display name that offers context for the account, such as "Contoso".
+ */
+ contextualDisplayName: string;
+
+ /**
+ * account provider (eg, Work/School vs Microsoft Account)
+ */
+ accountType: string;
+
+ /**
+ * A display name that identifies the account, such as "user@contoso.com".
+ */
+ displayName: string;
+ }
+
+ /**
+ * Represents a key that identifies an account.
+ */
+ export interface AccountKey {
+ /**
+ * Identifier of the provider
+ */
+ providerId: string;
+
+ /**
+ * Any arguments that identify an instantiation of the provider
+ */
+ providerArgs?: any;
+
+ /**
+ * Identifier for the account, unique to the provider
+ */
+ accountId: string;
+ }
+
+ /**
+ * Represents an account.
+ */
+ export interface Account {
+ /**
+ * The key that identifies the account
+ */
+ key: AccountKey;
+
+ /**
+ * Display information for the account
+ */
+ displayInfo: AccountDisplayInfo;
+
+ /**
+ * Custom properties stored with the account
+ */
+ properties: any;
+
+ /**
+ * Indicates if the account needs refreshing
+ */
+ isStale: boolean;
+ }
+
+ // - ACCOUNT PROVIDER //////////////////////////////////////////////////
+ /**
+ * Error to be used when the user has cancelled the prompt or refresh methods. When
+ * AccountProvider.refresh or AccountProvider.prompt are rejected with this error, the error
+ * will not be reported to the user.
+ */
+ export interface UserCancelledSignInError extends Error {
+ /**
+ * Type guard for differentiating user cancelled sign in errors from other errors
+ */
+ userCancelledSignIn: boolean;
+ }
+
+ /**
+ * Represents a provider of accounts.
+ */
+ export interface AccountProviderMetadata {
+ /**
+ * The identifier of the provider
+ */
+ id: string;
+
+ /**
+ * Display name of the provider
+ */
+ displayName: string;
+
+ /**
+ * Any arguments that identify an instantiation of the provider
+ */
+ args?: any;
+
+ /**
+ * Optional settings that identify an instantiation of a provider
+ */
+ settings?: {};
+ }
+
+ /**
+ * Represents a provider of accounts for use with the account management service
+ */
+ export interface AccountProvider {
+ /**
+ * Initializes the account provider with the accounts restored from the memento,
+ * @param {Account[]} storedAccounts Accounts restored from the memento
+ * @return {Thenable} Account objects after being rehydrated (if necessary)
+ */
+ initialize(storedAccounts: Account[]): Thenable;
+
+ /**
+ * Generates a security token for the provided account
+ * @param {Account} account The account to generate a security token for
+ * @return {Thenable<{}>} Promise to return a security token object
+ */
+ getSecurityToken(account: Account): Thenable<{}>;
+
+ /**
+ * Prompts the user to enter account information.
+ * Returns an error if the user canceled the operation.
+ */
+ prompt(): Thenable;
+
+ /**
+ * Refreshes a stale account.
+ * Returns an error if the user canceled the operation.
+ * Otherwise, returns a new updated account instance.
+ * @param account - An account.
+ */
+ refresh(account: Account): Thenable;
+
+ /**
+ * Clears sensitive information for an account. To be called when account is removed
+ * @param accountKey - Key that uniquely identifies the account to clear
+ */
+ clear(accountKey: AccountKey): Thenable;
+
+ /**
+ * Called from the account management service when the user has cancelled an auto OAuth
+ * authorization process. Implementations should use this to cancel any polling process
+ * and call the end OAuth method.
+ */
+ autoOAuthCancelled(): Thenable;
+ }
+
+ // Resource provider interfaces -----------------------------------------------------------------------
+
+ // - ACCOUNT PROVIDER //////////////////////////////////////////////////
+ /**
+ * Represents a provider of accounts.
+ */
+ export interface ResourceProviderMetadata {
+ /**
+ * The identifier of the provider
+ */
+ id: string;
+
+ /**
+ * Display name of the provider
+ */
+ displayName: string;
+
+ /**
+ * Optional settings that identify an instantiation of a provider
+ */
+ settings?: {};
+ }
+
+ export namespace resources {
+ /**
+ * Registers a resource provider that can suport
+ */
+ export function registerResourceProvider(providerMetadata: ResourceProviderMetadata, provider: ResourceProvider): vscode.Disposable;
+ }
+
+ /**
+ * Represents a provider of resource
+ */
+ export interface ResourceProvider {
+ createFirewallRule(account: Account, firewallruleInfo: FirewallRuleInfo): Thenable;
+ handleFirewallRule(errorCode: number, errorMessage: string, connectionTypeId: string): Thenable;
+ }
+
+ export interface FirewallRuleInfo {
+ startIpAddress: string;
+ endIpAddress: string;
+ serverName: string;
+ securityTokenMappings: {};
+ }
+
+ export interface CreateFirewallRuleResponse {
+ result: boolean;
+ errorMessage: string;
+ }
+
+ export interface HandleFirewallRuleResponse {
+ result: boolean;
+ ipAddress: string;
+ }
+
+ export interface ModalDialog {
+ /**
+ * Title of the webview.
+ */
+ title: string;
+
+ /**
+ * Contents of the dialog body.
+ */
+ html: string;
+
+ /**
+ * The caption of the OK button.
+ */
+ okTitle: string;
+
+ /**
+ * The caption of the Close button.
+ */
+ closeTitle: string;
+
+ /**
+ * Opens the dialog.
+ */
+ open(): void;
+
+ /**
+ * Closes the dialog.
+ */
+ close(): void;
+
+ /**
+ * Raised when the webview posts a message.
+ */
+ readonly onMessage: vscode.Event;
+
+ /**
+ * Raised when dialog closed.
+ */
+ readonly onClosed: vscode.Event;
+
+ /**
+ * Post a message to the dialog.
+ *
+ * @param message Body of the message.
+ */
+ postMessage(message: any): Thenable;
+ }
+
+ export interface DashboardWebview {
+
+ /**
+ * Raised when the webview posts a message.
+ */
+ readonly onMessage: vscode.Event;
+
+ /**
+ * Raised when the webview closed.
+ */
+ readonly onClosed: vscode.Event;
+
+ /**
+ * Post a message to the webview.
+ *
+ * @param message Body of the message.
+ */
+ postMessage(message: any): Thenable;
+
+ /**
+ * The connection info for the dashboard the webview exists on
+ */
+ readonly connection: connection.Connection;
+
+ /**
+ * The info on the server for the webview dashboard
+ */
+ readonly serverInfo: ServerInfo;
+
+ /**
+ * Contents of the dialog body.
+ */
+ html: string;
+ }
+
+ export namespace dashboard {
+ /**
+ * Register a provider for a webview widget
+ */
+ export function registerWebviewProvider(widgetId: string, handler: (webview: DashboardWebview) => void): void;
+ }
+
+ export namespace window {
+ /**
+ * creates a dialog
+ * @param title
+ */
+ export function createDialog(
+ title: string
+ ): ModalDialog;
+ }
+
+ export namespace tasks {
+
+ export interface ITaskHandler {
+ (profile: IConnectionProfile, ...args: any[]): any;
+ }
+
+ /**
+ * Registers a task that can be invoked via a keyboard shortcut,
+ * a menu item, an action, or directly.
+ *
+ * Registering a task with an existing task identifier twice
+ * will cause an error.
+ *
+ * @param task A unique identifier for the task.
+ * @param callback A task handler function.
+ * @param thisArg The `this` context used when invoking the handler function.
+ * @return Disposable which unregisters this task on disposal.
+ */
+ export function registerTask(task: string, callback: ITaskHandler, thisArg?: any): vscode.Disposable;
+ }
+}