Updating types file with groupName property (#26092)

* updating types file * updating tests to include previously-missed props * bumping STS
microsoft · Dec 10, 2024 · 6b05b9d · 6b05b9d
1 parent 273e7dd
commit 6b05b9d
Show file tree

Hide file tree

Showing 10 changed files with 107 additions and 23 deletions.
diff --git a/extensions/mssql/config.json b/extensions/mssql/config.json
@@ -1,6 +1,6 @@
 {
 	"downloadUrl": "https://github.com/Microsoft/sqltoolsservice/releases/download/{#version#}/microsoft.sqltools.servicelayer-{#fileName#}",
-	"version": "5.0.20241115.1",
+	"version": "5.0.20241206.1",
 	"downloadFileNames": {
 		"Windows_86": "win-x86-net8.0.zip",
 		"Windows_64": "win-x64-net8.0.zip",

diff --git a/src/sql/azdata.d.ts b/src/sql/azdata.d.ts
@@ -671,30 +671,11 @@ declare module 'azdata' {
 		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[];
+
+		/** Mapping from connection option group IDs to translated display names */
+		groupDisplayNames: { [groupId: string]: string };
 	}
 
 	export interface ServiceOption {
@@ -719,6 +700,12 @@ declare module 'azdata' {
 		isArray: boolean;
 	}
 
+	export interface ConnectionOption extends ServiceOption {
+		specialValueType: ConnectionOptionSpecialType;
+
+		isIdentity: boolean;
+	}
+
 	export interface AdminServicesOptions {
 		databaseInfoOptions: ServiceOption[];
 

diff --git a/src/sql/platform/capabilities/test/common/testCapabilitiesService.ts b/src/sql/platform/capabilities/test/common/testCapabilitiesService.ts
@@ -31,6 +31,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.connectionName,
@@ -43,6 +45,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.serverName,
@@ -55,6 +59,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.databaseName,
@@ -67,6 +73,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.userName,
@@ -79,6 +87,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.authType,
@@ -91,6 +101,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.password,
@@ -105,6 +117,8 @@ export class TestCapabilitiesService implements ICapabilitiesService {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: 'false',
+				objectType: undefined!,
+				isArray: false,
 				isIdentity: false,
 				isRequired: false,
 				specialValueType: undefined!,

diff --git a/src/sql/platform/connection/test/common/connectionConfig.test.ts b/src/sql/platform/connection/test/common/connectionConfig.test.ts
@@ -121,6 +121,7 @@ suite('ConnectionConfig', () => {
 		capabilitiesService = TypeMoq.Mock.ofType(TestCapabilitiesService);
 		capabilities = [];
 		let connectionProvider: azdata.ConnectionProviderOptions = {
+			groupDisplayNames: {},
 			options: [
 				{
 					name: 'server',
@@ -129,6 +130,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: undefined!,
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: ConnectionOptionSpecialType.serverName,
@@ -141,6 +144,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: undefined!,
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: ConnectionOptionSpecialType.databaseName,
@@ -153,6 +158,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: undefined!,
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: ConnectionOptionSpecialType.userName,
@@ -165,6 +172,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: undefined!,
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: ConnectionOptionSpecialType.authType,
@@ -177,6 +186,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: undefined!,
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: ConnectionOptionSpecialType.password,
@@ -189,6 +200,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: "default",
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: undefined!,
@@ -201,6 +214,8 @@ suite('ConnectionConfig', () => {
 					groupName: undefined!,
 					categoryValues: undefined!,
 					defaultValue: "10",
+					objectType: undefined,
+					isArray: false,
 					isIdentity: true,
 					isRequired: true,
 					specialValueType: undefined!,

diff --git a/src/sql/platform/connection/test/common/connectionProfile.test.ts b/src/sql/platform/connection/test/common/connectionProfile.test.ts
@@ -78,6 +78,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.connectionName,
@@ -90,6 +92,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.serverName,
@@ -102,6 +106,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.databaseName,
@@ -114,6 +120,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.userName,
@@ -126,6 +134,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.authType,
@@ -138,6 +148,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.password,
@@ -150,6 +162,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: "true",
+				objectType: undefined,
+				isArray: false,
 				isIdentity: false,
 				showOnConnectionDialog: true,
 				isRequired: false,
@@ -163,6 +177,8 @@ suite('SQL ConnectionProfileInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: "false",
+				objectType: undefined,
+				isArray: false,
 				isIdentity: false,
 				showOnConnectionDialog: true,
 				isRequired: false,

diff --git a/src/sql/platform/connection/test/common/connectionStore.test.ts b/src/sql/platform/connection/test/common/connectionStore.test.ts
@@ -58,6 +58,8 @@ suite('ConnectionStore', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.connectionName,
@@ -70,6 +72,8 @@ suite('ConnectionStore', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.serverName,
@@ -82,6 +86,8 @@ suite('ConnectionStore', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.databaseName,
@@ -94,6 +100,8 @@ suite('ConnectionStore', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.userName,
@@ -106,6 +114,8 @@ suite('ConnectionStore', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.authType,
@@ -118,6 +128,8 @@ suite('ConnectionStore', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.password,

diff --git a/src/sql/platform/connection/test/common/providerConnectionInfo.test.ts b/src/sql/platform/connection/test/common/providerConnectionInfo.test.ts
@@ -43,6 +43,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.connectionName,
@@ -55,6 +57,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.serverName,
@@ -67,6 +71,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.databaseName,
@@ -79,6 +85,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.userName,
@@ -91,6 +99,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.authType,
@@ -103,6 +113,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: true,
 				isRequired: true,
 				specialValueType: ConnectionOptionSpecialType.password,
@@ -115,6 +127,8 @@ suite('SQL ProviderConnectionInfo tests', () => {
 				groupName: undefined!,
 				categoryValues: undefined!,
 				defaultValue: undefined!,
+				objectType: undefined,
+				isArray: false,
 				isIdentity: false,
 				isRequired: false,
 				showOnConnectionDialog: true,