ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-08 01:28:26 -05:00
Code Issues Packages Projects Releases Wiki Activity

Promote some proposed APIs to stable (#14788)

Browse Source 
* Promote some proposed APIs to stable

* Fix spelling

(cherry picked from commit b88a9ba33e644f83a2b8deac9d99d86803605a85)
This commit is contained in:
Charles Gagnon
2021-03-18 13:11:43 -07:00
committed by GitHub
parent 5da4690be8
commit 11d4ea3232
2 changed files with 187 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

199
src/sql/azdata.proposed.d.ts vendored
View File

@@ -8,44 +8,6 @@
import * as vscode from 'vscode';
declare module 'azdata' {
/**
* Namespace for connection management
*/
export namespace connection {
/**
* Supported connection event types
*/
export type ConnectionEventType =
| 'onConnect'
| 'onDisconnect'
| 'onConnectionChanged';
/**
* Connection Event Lister
*/
export interface ConnectionEventListener {
/**
* Connection event handler
* @param type Connection event type
* @param ownerUri Connection's owner uri
* @param args Connection profile
*/
onConnectionEvent(type: ConnectionEventType, ownerUri: string, args: IConnectionProfile): void;
}
/**
* Register a connection event listener
* @param listener The connection event listener
*/
export function registerConnectionEventListener(listener: connection.ConnectionEventListener): vscode.Disposable;
/**
* Get connection profile by its owner uri
* @param ownerUri The owner uri of the connection
* @returns Promise to return the connection profile matching the ownerUri
*/
export function getConnection(ownerUri: string): Thenable<ConnectionProfile>;
}
export namespace nb {
export interface NotebookDocument {
@@ -272,17 +234,6 @@ declare module 'azdata' {
title: string;
}
export interface HyperlinkComponent {
/**
* An event called when the hyperlink is clicked
*/
onDidClick: vscode.Event<any>;
}
export interface HyperlinkComponentProperties {
showLinkIcon?: boolean;
}
export interface RadioButtonComponent {
/**
* An event called when the value of radio button changes
@@ -342,9 +293,6 @@ declare module 'azdata' {
radioCardGroup(): ComponentBuilder<RadioCardGroupComponent, RadioCardGroupComponentProperties>;
listView(): ComponentBuilder<ListViewComponent, ListViewComponentProperties>;
tabbedPanel(): TabbedPanelComponentBuilder;
separator(): ComponentBuilder<SeparatorComponent, SeparatorComponentProperties>;
propertiesContainer(): ComponentBuilder<PropertiesContainerComponent, PropertiesContainerComponentProperties>;
infoBox(): ComponentBuilder<InfoBoxComponent, InfoBoxComponentProperties>;
slider(): ComponentBuilder<SliderComponent, SliderComponentProperties>;
}
@@ -352,9 +300,6 @@ declare module 'azdata' {
withProps(properties: TPropertyBag): ComponentBuilder<TComponent, TPropertyBag>;
}
export interface DropDownProperties extends LoadingComponentProperties {
}
export interface RadioCard {
id: string;
descriptions: RadioCardDescription[];
@@ -418,12 +363,6 @@ declare module 'azdata' {
onDidClick: vscode.Event<ListViewClickEvent>;
}
export interface SeparatorComponent extends Component {
}
export interface SeparatorComponentProperties extends ComponentProperties {
}
export interface DeclarativeTableProperties {
/**
* dataValues will only be used if data is an empty array
@@ -442,38 +381,6 @@ declare module 'azdata' {
style?: CssStyles
}
export interface ComponentProperties {
ariaHidden?: boolean;
}
export interface ComponentWithIconProperties extends ComponentProperties {
/**
* The path for the icon with optional dark-theme away alternative
*/
iconPath?: IconPath;
/**
* The height of the icon
*/
iconHeight?: number | string;
/**
* The width of the icon
*/
iconWidth?: number | string;
/**
* The title for the icon. This title will show when hovered over
*/
title?: string;
}
export interface ComponentWithIcon extends ComponentWithIconProperties {
}
export interface ImageComponent extends ComponentWithIcon {
}
export interface ImageComponentProperties extends ComponentProperties, ComponentWithIconProperties {
}
/**
* Panel component with tabs
*/
@@ -576,19 +483,6 @@ declare module 'azdata' {
withTabs(tabs: (Tab | TabGroup)[]): ContainerBuilder<TabbedPanelComponent, TabbedPanelLayout, any, ComponentProperties>;
}
export interface InputBoxProperties extends ComponentProperties {
validationErrorMessage?: string;
readOnly?: boolean;
/**
* This title will show when hovered over
*/
title?: string;
}
export interface CheckBoxProperties {
required?: boolean;
}
export interface SliderComponentProperties extends ComponentProperties {
/**
* The value selected on the slider. Default initial value is the minimum value.
@@ -621,63 +515,6 @@ declare module 'azdata' {
onInput: vscode.Event<number>;
}
/**
* A property to be displayed in the PropertiesContainerComponent
*/
export interface PropertiesContainerItem {
/**
* The name of the property to display
*/
displayName: string;
/**
* The value of the property to display
*/
value: string;
}
/**
* Component to display a list of property values.
*/
export interface PropertiesContainerComponent extends Component, PropertiesContainerComponentProperties {
}
/**
* Properties for configuring a PropertiesContainerComponent
*/
export interface PropertiesContainerComponentProperties extends ComponentProperties {
/**
* The properties to display
*/
propertyItems?: PropertiesContainerItem[];
}
/**
* Component to display text with an icon representing the severity
*/
export interface InfoBoxComponent extends Component, InfoBoxComponentProperties {
}
export type InfoBoxStyle = 'information' | 'warning' | 'error' | 'success';
/**
* Properties for configuring a InfoBoxComponent
*/
export interface InfoBoxComponentProperties extends ComponentProperties {
/**
* The style of the InfoBox
*/
style: InfoBoxStyle;
/**
* The display text of the InfoBox
*/
text: string;
/**
* Controls whether the text should be announced by the screen reader. Default value is false.
*/
announceText?: boolean;
}
export namespace nb {
/**
* An event that is emitted when the active Notebook editor is changed.
@@ -703,7 +540,7 @@ declare module 'azdata' {
export interface Dialog {
/**
* Width of the dialog.
* Default is 'narrrow'.
* Default is 'narrow'.
*/
width?: DialogWidth;
/**
@@ -734,10 +571,6 @@ declare module 'azdata' {
}
export interface Wizard {
/**
* The name used to identify the wizard in telemetry
*/
name?: string;
/**
* Width of the wizard
*/
@@ -754,7 +587,7 @@ declare module 'azdata' {
export type DialogWidth = 'narrow' | 'medium' | 'wide' | number | string;
/**
* These dialog styles affect how the dialog dispalys in the application.
* These dialog styles affect how the dialog displays in the application.
* normal: Positioned top and centered.
* flyout (default): Existing panel appearance - positioned full screen height, opens from the right side of the application.
* callout: Opens below or beside button clicked, contains footer section with buttons.
@@ -788,20 +621,6 @@ declare module 'azdata' {
*/
export function createModelViewDialog(title: string, dialogName?: string, width?: DialogWidth, dialogStyle?: DialogStyle, dialogPosition?: DialogPosition, renderHeader?: boolean, renderFooter?: boolean, dialogProperties?: IDialogProperties): Dialog;
/**
* Create a wizard with the given title and width
* @param title The title of the wizard
* @param name The name used to identify the wizard in telemetry
* @param width The width of the wizard, default value is 'narrow'
*/
export function createWizard(title: string, name?: string, width?: DialogWidth): Wizard;
/**
* Create a wizard page with the given title, for inclusion in a wizard
* @param title The title of the page
* @param pageName The optional page name parameter will be used for telemetry
*/
export function createWizardPage(title: string, pageName?: string): WizardPage;
export interface Button {
/**
@@ -966,13 +785,6 @@ declare module 'azdata' {
Informational = 'Informational'
}
export interface DiffEditorComponent {
/**
* Title of editor
*/
title: string;
}
export namespace workspace {
/**
* Creates and enters a workspace at the specified location
@@ -1082,13 +894,6 @@ declare module 'azdata' {
action: ActionOnCellCheckboxCheck;
}
export enum AzureResource {
/**
* Microsoft Graph
*/
MsGraph = 7
}
export interface ResultSetSummary {
/**
* The visualization options for the result set.