azure-devops-extension-api 4.247.0 → 4.248.1

package/src/Dashboard/DashboardClient.ts

@@ -1,370 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-
-import * as TfsCore from "../Core/Core";
-import * as Dashboard from "../Dashboard/Dashboard";
-
-export class DashboardRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions) {
-        super(options);
-    }
-
-    public static readonly RESOURCE_AREA_ID = "31c84e0a-3ece-48fd-a29d-100849af99ba";
-
-    /**
-     * Create the supplied dashboard.
-     * 
-     * @param dashboard - The initial state of the dashboard
-     * @param teamContext - The team context for the operation
-     */
-    public async createDashboard(
-        dashboard: Dashboard.Dashboard,
-        teamContext: TfsCore.TeamContext
-        ): Promise<Dashboard.Dashboard> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Dashboard>({
-            apiVersion: "7.2-preview.3",
-            method: "POST",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",
-            routeValues: {
-                project: project,
-                team: team
-            },
-            body: dashboard
-        });
-    }
-
-    /**
-     * Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.
-     * 
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of the dashboard to delete.
-     */
-    public async deleteDashboard(
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string
-        ): Promise<void> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.3",
-            method: "DELETE",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId
-            }
-        });
-    }
-
-    /**
-     * Get a dashboard by its ID.
-     * 
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - 
-     */
-    public async getDashboard(
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string
-        ): Promise<Dashboard.Dashboard> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Dashboard>({
-            apiVersion: "7.2-preview.3",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId
-            }
-        });
-    }
-
-    /**
-     * Get a list of dashboards under a project.
-     * 
-     * @param teamContext - The team context for the operation
-     */
-    public async getDashboardsByProject(
-        teamContext: TfsCore.TeamContext
-        ): Promise<Dashboard.Dashboard[]> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Dashboard[]>({
-            apiVersion: "7.2-preview.3",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",
-            routeValues: {
-                project: project,
-                team: team
-            }
-        });
-    }
-
-    /**
-     * Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.
-     * 
-     * @param dashboard - The Configuration of the dashboard to replace.
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of the dashboard to replace.
-     */
-    public async replaceDashboard(
-        dashboard: Dashboard.Dashboard,
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string
-        ): Promise<Dashboard.Dashboard> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Dashboard>({
-            apiVersion: "7.2-preview.3",
-            method: "PUT",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId
-            },
-            body: dashboard
-        });
-    }
-
-    /**
-     * Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content.
-     * 
-     * @param group - 
-     * @param teamContext - The team context for the operation
-     */
-    public async replaceDashboards(
-        group: Dashboard.DashboardGroup,
-        teamContext: TfsCore.TeamContext
-        ): Promise<Dashboard.DashboardGroup> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.DashboardGroup>({
-            apiVersion: "7.2-preview.3",
-            method: "PUT",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",
-            routeValues: {
-                project: project,
-                team: team
-            },
-            body: group
-        });
-    }
-
-    /**
-     * Create a widget on the specified dashboard.
-     * 
-     * @param widget - State of the widget to add
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of dashboard the widget will be added to.
-     */
-    public async createWidget(
-        widget: Dashboard.Widget,
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string
-        ): Promise<Dashboard.Widget> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Widget>({
-            apiVersion: "7.2-preview.2",
-            method: "POST",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId
-            },
-            body: widget
-        });
-    }
-
-    /**
-     * Delete the specified widget.
-     * 
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of the dashboard containing the widget.
-     * @param widgetId - ID of the widget to update.
-     */
-    public async deleteWidget(
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string,
-        widgetId: string
-        ): Promise<Dashboard.Dashboard> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Dashboard>({
-            apiVersion: "7.2-preview.2",
-            method: "DELETE",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId,
-                widgetId: widgetId
-            }
-        });
-    }
-
-    /**
-     * Get the current state of the specified widget.
-     * 
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of the dashboard containing the widget.
-     * @param widgetId - ID of the widget to read.
-     */
-    public async getWidget(
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string,
-        widgetId: string
-        ): Promise<Dashboard.Widget> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Widget>({
-            apiVersion: "7.2-preview.2",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId,
-                widgetId: widgetId
-            }
-        });
-    }
-
-    /**
-     * Override the  state of the specified widget.
-     * 
-     * @param widget - State to be written for the widget.
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of the dashboard containing the widget.
-     * @param widgetId - ID of the widget to update.
-     */
-    public async replaceWidget(
-        widget: Dashboard.Widget,
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string,
-        widgetId: string
-        ): Promise<Dashboard.Widget> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Widget>({
-            apiVersion: "7.2-preview.2",
-            method: "PUT",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId,
-                widgetId: widgetId
-            },
-            body: widget
-        });
-    }
-
-    /**
-     * Perform a partial update of the specified widget.
-     * 
-     * @param widget - Description of the widget changes to apply. All non-null fields will be replaced.
-     * @param teamContext - The team context for the operation
-     * @param dashboardId - ID of the dashboard containing the widget.
-     * @param widgetId - ID of the widget to update.
-     */
-    public async updateWidget(
-        widget: Dashboard.Widget,
-        teamContext: TfsCore.TeamContext,
-        dashboardId: string,
-        widgetId: string
-        ): Promise<Dashboard.Widget> {
-
-        const project = teamContext.projectId || teamContext.project;
-        const team = teamContext.teamId || teamContext.team;
-
-        return this.beginRequest<Dashboard.Widget>({
-            apiVersion: "7.2-preview.2",
-            method: "PATCH",
-            routeTemplate: "{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",
-            routeValues: {
-                project: project,
-                team: team,
-                dashboardId: dashboardId,
-                widgetId: widgetId
-            },
-            body: widget
-        });
-    }
-
-    /**
-     * Get the widget metadata satisfying the specified contribution ID.
-     * 
-     * @param contributionId - The ID of Contribution for the Widget
-     * @param project - Project ID or project name
-     */
-    public async getWidgetMetadata(
-        contributionId: string,
-        project?: string
-        ): Promise<Dashboard.WidgetMetadataResponse> {
-
-        return this.beginRequest<Dashboard.WidgetMetadataResponse>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "{project}/_apis/Dashboard/WidgetTypes/{contributionId}",
-            routeValues: {
-                project: project,
-                contributionId: contributionId
-            }
-        });
-    }
-
-    /**
-     * Get all available widget metadata in alphabetical order, including widgets marked with isVisibleFromCatalog == false.
-     * 
-     * @param scope - 
-     * @param project - Project ID or project name
-     */
-    public async getWidgetTypes(
-        scope: Dashboard.WidgetScope,
-        project?: string
-        ): Promise<Dashboard.WidgetTypesResponse> {
-
-        const queryValues: any = {
-            '$scope': scope
-        };
-
-        return this.beginRequest<Dashboard.WidgetTypesResponse>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "{project}/_apis/Dashboard/WidgetTypes/{contributionId}",
-            routeValues: {
-                project: project
-            },
-            queryParams: queryValues
-        });
-    }
-
-}

package/src/Dashboard/WidgetConfigHelpers.ts

@@ -1,43 +0,0 @@
-/**
- * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetConfigHelpers.ts
- */
-
-import { EventArgs } from "./WidgetContracts";
-
-export class ConfigurationEvent {
-    /**
-    * Configuration has changed. When this event is notified, the preview is updated and Save button is enabled.
-    *
-    * The payload expected when notifying this event: { data: customSettings }
-    *
-    * {customSettings} is the serialized custom config settings pertaining to the widget.
-    */
-    public static ConfigurationChange: string = "ms.vss-dashboards-web.configurationChange";
-
-    /**
-     * Configuration tries to execute API calls and fails. When this event is notified, the config does not render a view and we pass an error message to the configuration host.
-     *
-     * The payload expected when notifying this event: { data: string }
-     *
-     * {string} is the error message that is displayed at the top of the configuration.
-     */
-    public static ConfigurationError: string = "ms.vss-dashboards-web.configurationError";
-
-    /**
-     * Widget configuration general settings changed. When this event is notified, the widget name or widget size is updated.
-     *
-     * The payload expected when notifying this event: { data: { IGeneralSettings } }
-     *
-     * {generalSettings} is the serialized object containing WidgetName and WidgetSize
-     */
-    public static GeneralSettingsChanged: string = "ms.vss-dashboards-web.generalSettingsChanged";
-
-    /**
-     * @param payload the event arguments we pass when we want to notify the configuration.
-     */
-    public static Args<T>(payload: T): EventArgs<T> {
-        return {
-            data: payload
-        };
-    }
-}

package/src/Dashboard/WidgetContracts.ts

@@ -1,226 +0,0 @@
-/**
- * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetContracts.ts
- */
-
-import { LightboxOptions, SemanticVersion, WidgetSize } from "./Dashboard";
-
-/**
- * settings of the widget that encapsulate their serialized data and version support.
- */
-export interface CustomSettings {
-    /**
-     * the settings data serialized as a string.
-     */
-    data: string;
-    /**
-     * (Optional) version for the settings represented as a semantic version object.
-     * If none is available, the version defaults to {major:1, minor:0, patch:0} or "1.0.0"
-     */
-    version?: SemanticVersion;
-}
-
-/**
- * A description of widget state, satisfying requirements for rendering a widget (Does not contain grid centric information, or contribution metadata).
- */
-export interface WidgetSettings {
-    /**
-     * size of the widget (in case of configuration, this maps to the size sub section in the general section of the configuration panel)
-     */
-    size: WidgetSize;
-    /**
-     * name of the widget (in case of configuration, this maps to the name sub section in the general section of the configuration panel)
-     */
-    name: string;
-    /**
-     * settings of the widget
-     */
-    customSettings: CustomSettings;
-    /**
-     * Lightbox options
-     */
-    lightboxOptions?: LightboxOptions;
-}
-
-/**
- * Used to differentiate between widget status helpers
- */
-export enum WidgetStatusType {
-    /**
-     * The widget loaded successfully
-     */
-    Success = 0,
-    /**
-     * The widget failed to load
-     */
-    Failure = 1,
-    /**
-     * The widget needs to be configured
-     */
-    Unconfigured = 2
-}
-
-/**
- * The object encapsulating the result for an IWidget/IConfigurableWidget method call. This object is created using the WidgetStatusHelper library.
- */
-export interface WidgetStatus {
-    /**
-     * the rendered state of the widget serialized to a string.
-     */
-    state?: string;
-    /**
-     * Used to determine which widget status helper was called
-     */
-    statusType?: WidgetStatusType;
-}
-
-/**
- * All widgets implement this interface
- */
-export interface IWidget {
-    /** widgets use the settings provided along with the any cached data they may have to paint an interactive state. No network calls should be made by the widget.
-     *  @param {WidgetSettings} settings of the widget as available when the widget render is called by the host.
-     *  @returns object wrapped in a promise that encapsulates the success of this operation.
-     *          when this calls are completed and the experience is done loading.
-     */
-    preload: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>;
-    /**
-     *  Widgets use the settings provided as well as server side calls to complete their rendering experience.
-     *  In the future, widgets are expected to provide a loading experience while the calls are being waited to be completed.
-     *  Until then, the widget host will provide the loading experience
-     *  @param {WidgetSettings} settings of the widget as available when the widget render is called by the host.
-     *  @returns object wrapped in a promise that encapsulates the success of this operation.
-     *          when this calls are completed and the experience is done loading.
-     */
-    load: (widgetSettings: WidgetSettings) => Promise<WidgetStatus>;
-    /**
-     * Widgets manage any operations that are not necessary for initial load but are required for the full widget experience.
-     */
-    onDashboardLoaded?: () => void;
-    /**
-     * The framework calls this method to determine if the widget should be disabled for users with stakeholder license
-     * @param {WidgetSettings} settings of the widget as available when the widget render is called by the host.
-     * @returns A boolean wrapped in a promise that determines if the widget should be disabled for users with stakeholder license
-     */
-    disableWidgetForStakeholders?: (widgetSettings: WidgetSettings) => Promise<boolean>;
-    /**
-     *  Run widget in lightboxed mode
-     *  @param {WidgetSettings} settings of the widget as available when the widget render is called by the host.
-     *  @param {LightboxSize} size of the lightbox
-     *  @returns object wrapped in a promise that encapsulates the success of this operation.
-     *          when this calls are completed and the experience is done loading.
-     */
-    lightbox?: (widgetSettings: WidgetSettings, lightboxSize: Size) => Promise<WidgetStatus>;
-    /**
-     *  Listen to message from host
-     * @param {string} type of event
-     * @param {eventArgs} arguments associated with the event.
-     */
-    listen?: <T>(event: string, eventArgs: EventArgs<T>) => void;
-}
-
-/**
- * Configurable widgets implement this interface
- */
-export interface IConfigurableWidget extends IWidget {
-    /**
-     *  When the configuration view is changed, the widget is expected to update its view.
-     *  @param {WidgetSettings} the latest widget settings as available from the configuration view for the widget.
-     *  @returns object wrapped in a promise that encapsulates the success of this operation.
-     */
-    reload: (newWidgetSettings: WidgetSettings) => Promise<WidgetStatus>;
-}
-
-/**
- * Widget authors implement this interface for their configuration.
- */
-export interface IWidgetConfiguration {
-    /**
-     *  Called by the host to setup the widget configuration, which uses the settings shared with the widget to complete its rendering experience.
-     *  @param {WidgetSettings} settings of the widget as shared with the configuration.
-     *  @param {IWidgetConfigurationContext} widgetConfigurationContext provided by the host of the widget configuration to allow for communication.
-     *  @returns object wrapped in a promise that encapsulates the success of this operation.
-     *           If load fails, returns error message via WidgetStatusHelper.Failure(errorMessage).
-     */
-    load: (widgetSettings: WidgetSettings, widgetConfigurationContext: IWidgetConfigurationContext) => Promise<WidgetStatus>;
-    /**
-     * Called by the host when the user clicks on the Save button.
-     * Widget author is expected to run validations if needed.
-     * If ready to save, then use WidgetHelpers.WidgetConfigurationSave.Valid() to return the serialized custom settings of the widget from the configuraton.
-     * If custom settings are not valid and so not ready to save, then  use WidgetHelpers.WidgetConfigurationSave.Invalid() to notify the host to stop save.
-     * @returns object of type SaveStatus wrapped in a promise.
-     */
-    onSave: () => Promise<SaveStatus>;
-    /**
-     * (Optional) Called by the host when the configuration is ready to be saved (when the user clicks the save button on the configuration panel)
-     */
-    onSaveComplete?: () => void;
-    /**
-     *  Listen to message from host
-     * @param {string} type of event
-     * @param {eventArgs} arguments associated with the event.
-     */
-    listen?: <T>(event: string, eventArgs: EventArgs<T>) => void;
-}
-
-/**
- * The result of a notification being made by a widget configuration.
- */
-export interface NotifyResult {
-    /**
-     * Gets a response from the subscriber of the notification, if they provide one as part of the schema for the event.
-     * @returns A promise with the data representing the return payload serialized as a string.
-     */
-    getResponse(): Promise<string>;
-}
-
-/**
- * Arguments associated with an event being passed by a widget or configurations.
- */
-export interface EventArgs<T> {
-    /**
-     * Data relevant to the event.
-     */
-    data: T;
-}
-
-/**
- * Interface for the object passed to the widget configuration to communicate with its host.
- */
-export interface IWidgetConfigurationContext {
-    /**
-     * The widget configuration calls this method when it wants to notify any of the WidgetEvents to the host
-     * @param {string} type of event
-     * @param {eventArgs} arguments associated with the event which comes from the widget configuration.
-     * @returns a promise with the result of the notification. If arguments are malformed, the promise will be rejected. If multiple notifications are made for the same event
-     * only the promise for the latest notification is resolved and the rest are treated as stale. The subscriber of the notification can send back information in a serialized form.
-     */
-    notify: <T>(event: string, eventArgs: EventArgs<T>) => Promise<NotifyResult>;
-}
-
-/**
- * Interface for the object passed to the host when user clicks on the Save button in the configuration pane
- */
-export interface SaveStatus {
-    /**
-     * The custom settings to save
-     */
-    customSettings?: CustomSettings;
-    /**
-     * Indicates validity of the customSettings. If false, then user will be shown a generic error message and settings will not be saved.
-     */
-    isValid: boolean;
-}
-
-/**
- * Size of lightbox to draw widget in
- */
-export interface Size {
-    /**
-     * width in pixels
-     */
-    width: number;
-    /**
-     * height in pixels
-     */
-    height: number;
-}