azure-devops-extension-api 4.270.0 → 5.271.0

package/Dashboard/Dashboard.js

@@ -1,57 +1,56 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-define(["require", "exports"], function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    /**
-     * identifies the scope of dashboard storage and permissions.
-     */
-    var DashboardScope;
-    (function (DashboardScope) {
-        /**
-         * [DEPRECATED] Dashboard is scoped to the collection user.
-         */
-        DashboardScope[DashboardScope["Collection_User"] = 0] = "Collection_User";
-        /**
-         * Dashboard is scoped to the team.
-         */
-        DashboardScope[DashboardScope["Project_Team"] = 1] = "Project_Team";
-        /**
-         * Dashboard is scoped to the project.
-         */
-        DashboardScope[DashboardScope["Project"] = 2] = "Project";
-    })(DashboardScope = exports.DashboardScope || (exports.DashboardScope = {}));
-    /**
-     * None - Team member cannot edit dashboard Edit - Team member can add, configure and delete widgets Manage - Team member can add, reorder, delete dashboards Manage Permissions - Team member can manage membership of other members to perform group operations.
-     */
-    var GroupMemberPermission;
-    (function (GroupMemberPermission) {
-        GroupMemberPermission[GroupMemberPermission["None"] = 0] = "None";
-        GroupMemberPermission[GroupMemberPermission["Edit"] = 1] = "Edit";
-        GroupMemberPermission[GroupMemberPermission["Manage"] = 2] = "Manage";
-        GroupMemberPermission[GroupMemberPermission["ManagePermissions"] = 3] = "ManagePermissions";
-    })(GroupMemberPermission = exports.GroupMemberPermission || (exports.GroupMemberPermission = {}));
-    /**
-     * Read - User can see dashboards Create - User can create dashboards Edit - User can add, configure and delete widgets, and edit dashboard settings. Delete - User can delete dashboards Manage Permissions - Team member can manage membership of other members to perform group operations.
-     */
-    var TeamDashboardPermission;
-    (function (TeamDashboardPermission) {
-        TeamDashboardPermission[TeamDashboardPermission["None"] = 0] = "None";
-        TeamDashboardPermission[TeamDashboardPermission["Read"] = 1] = "Read";
-        TeamDashboardPermission[TeamDashboardPermission["Create"] = 2] = "Create";
-        TeamDashboardPermission[TeamDashboardPermission["Edit"] = 4] = "Edit";
-        TeamDashboardPermission[TeamDashboardPermission["Delete"] = 8] = "Delete";
-        TeamDashboardPermission[TeamDashboardPermission["ManagePermissions"] = 16] = "ManagePermissions";
-    })(TeamDashboardPermission = exports.TeamDashboardPermission || (exports.TeamDashboardPermission = {}));
-    /**
-     * data contract required for the widget to function in a webaccess area or page.
-     */
-    var WidgetScope;
-    (function (WidgetScope) {
-        WidgetScope[WidgetScope["Collection_User"] = 0] = "Collection_User";
-        WidgetScope[WidgetScope["Project_Team"] = 1] = "Project_Team";
-    })(WidgetScope = exports.WidgetScope || (exports.WidgetScope = {}));
-});
+"use strict";
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WidgetScope = exports.TeamDashboardPermission = exports.GroupMemberPermission = exports.DashboardScope = void 0;
+/**
+ * identifies the scope of dashboard storage and permissions.
+ */
+var DashboardScope;
+(function (DashboardScope) {
+    /**
+     * [DEPRECATED] Dashboard is scoped to the collection user.
+     */
+    DashboardScope[DashboardScope["Collection_User"] = 0] = "Collection_User";
+    /**
+     * Dashboard is scoped to the team.
+     */
+    DashboardScope[DashboardScope["Project_Team"] = 1] = "Project_Team";
+    /**
+     * Dashboard is scoped to the project.
+     */
+    DashboardScope[DashboardScope["Project"] = 2] = "Project";
+})(DashboardScope || (exports.DashboardScope = DashboardScope = {}));
+/**
+ * None - Team member cannot edit dashboard Edit - Team member can add, configure and delete widgets Manage - Team member can add, reorder, delete dashboards Manage Permissions - Team member can manage membership of other members to perform group operations.
+ */
+var GroupMemberPermission;
+(function (GroupMemberPermission) {
+    GroupMemberPermission[GroupMemberPermission["None"] = 0] = "None";
+    GroupMemberPermission[GroupMemberPermission["Edit"] = 1] = "Edit";
+    GroupMemberPermission[GroupMemberPermission["Manage"] = 2] = "Manage";
+    GroupMemberPermission[GroupMemberPermission["ManagePermissions"] = 3] = "ManagePermissions";
+})(GroupMemberPermission || (exports.GroupMemberPermission = GroupMemberPermission = {}));
+/**
+ * Read - User can see dashboards Create - User can create dashboards Edit - User can add, configure and delete widgets, and edit dashboard settings. Delete - User can delete dashboards Manage Permissions - Team member can manage membership of other members to perform group operations.
+ */
+var TeamDashboardPermission;
+(function (TeamDashboardPermission) {
+    TeamDashboardPermission[TeamDashboardPermission["None"] = 0] = "None";
+    TeamDashboardPermission[TeamDashboardPermission["Read"] = 1] = "Read";
+    TeamDashboardPermission[TeamDashboardPermission["Create"] = 2] = "Create";
+    TeamDashboardPermission[TeamDashboardPermission["Edit"] = 4] = "Edit";
+    TeamDashboardPermission[TeamDashboardPermission["Delete"] = 8] = "Delete";
+    TeamDashboardPermission[TeamDashboardPermission["ManagePermissions"] = 16] = "ManagePermissions";
+})(TeamDashboardPermission || (exports.TeamDashboardPermission = TeamDashboardPermission = {}));
+/**
+ * data contract required for the widget to function in a webaccess area or page.
+ */
+var WidgetScope;
+(function (WidgetScope) {
+    WidgetScope[WidgetScope["Collection_User"] = 0] = "Collection_User";
+    WidgetScope[WidgetScope["Project_Team"] = 1] = "Project_Team";
+})(WidgetScope || (exports.WidgetScope = WidgetScope = {}));

package/Dashboard/Dashboard.min.js

@@ -1 +1 @@
-define(["require","exports"],function(e,o){"use strict";Object.defineProperty(o,"__esModule",{value:!0});!function(e){e[e.Collection_User=0]="Collection_User",e[e.Project_Team=1]="Project_Team",e[e.Project=2]="Project"}(o.DashboardScope||(o.DashboardScope={}));!function(e){e[e.None=0]="None",e[e.Edit=1]="Edit",e[e.Manage=2]="Manage",e[e.ManagePermissions=3]="ManagePermissions"}(o.GroupMemberPermission||(o.GroupMemberPermission={}));!function(e){e[e.None=0]="None",e[e.Read=1]="Read",e[e.Create=2]="Create",e[e.Edit=4]="Edit",e[e.Delete=8]="Delete",e[e.ManagePermissions=16]="ManagePermissions"}(o.TeamDashboardPermission||(o.TeamDashboardPermission={}));!function(e){e[e.Collection_User=0]="Collection_User",e[e.Project_Team=1]="Project_Team"}(o.WidgetScope||(o.WidgetScope={}))});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.WidgetScope=exports.TeamDashboardPermission=exports.GroupMemberPermission=exports.DashboardScope=void 0;var DashboardScope;!function(e){e[e.Collection_User=0]="Collection_User",e[e.Project_Team=1]="Project_Team",e[e.Project=2]="Project"}(DashboardScope||(exports.DashboardScope=DashboardScope={}));var GroupMemberPermission;!function(e){e[e.None=0]="None",e[e.Edit=1]="Edit",e[e.Manage=2]="Manage",e[e.ManagePermissions=3]="ManagePermissions"}(GroupMemberPermission||(exports.GroupMemberPermission=GroupMemberPermission={}));var TeamDashboardPermission;!function(e){e[e.None=0]="None",e[e.Read=1]="Read",e[e.Create=2]="Create",e[e.Edit=4]="Edit",e[e.Delete=8]="Delete",e[e.ManagePermissions=16]="ManagePermissions"}(TeamDashboardPermission||(exports.TeamDashboardPermission=TeamDashboardPermission={}));var WidgetScope;!function(e){e[e.Collection_User=0]="Collection_User",e[e.Project_Team=1]="Project_Team"}(WidgetScope||(exports.WidgetScope=WidgetScope={}));

package/Dashboard/DashboardClient.d.ts

@@ -1,106 +1,106 @@
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-import * as TfsCore from "../Core/Core";
-import * as Dashboard from "../Dashboard/Dashboard";
-export declare class DashboardRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions);
-    static readonly RESOURCE_AREA_ID: string;
-    /**
-     * Create the supplied dashboard.
-     *
-     * @param dashboard - The initial state of the dashboard
-     * @param teamContext - The team context for the operation
-     */
-    createDashboard(dashboard: Dashboard.Dashboard, teamContext: TfsCore.TeamContext): Promise<Dashboard.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.
-     */
-    deleteDashboard(teamContext: TfsCore.TeamContext, dashboardId: string): Promise<void>;
-    /**
-     * Get a dashboard by its ID.
-     *
-     * @param teamContext - The team context for the operation
-     * @param dashboardId -
-     */
-    getDashboard(teamContext: TfsCore.TeamContext, dashboardId: string): Promise<Dashboard.Dashboard>;
-    /**
-     * Get a list of dashboards under a project.
-     *
-     * @param teamContext - The team context for the operation
-     */
-    getDashboardsByProject(teamContext: TfsCore.TeamContext): Promise<Dashboard.Dashboard[]>;
-    /**
-     * 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.
-     */
-    replaceDashboard(dashboard: Dashboard.Dashboard, teamContext: TfsCore.TeamContext, dashboardId: string): Promise<Dashboard.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
-     */
-    replaceDashboards(group: Dashboard.DashboardGroup, teamContext: TfsCore.TeamContext): Promise<Dashboard.DashboardGroup>;
-    /**
-     * 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.
-     */
-    createWidget(widget: Dashboard.Widget, teamContext: TfsCore.TeamContext, dashboardId: string): Promise<Dashboard.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.
-     */
-    deleteWidget(teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.Dashboard>;
-    /**
-     * 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.
-     */
-    getWidget(teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.Widget>;
-    /**
-     * 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.
-     */
-    replaceWidget(widget: Dashboard.Widget, teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.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.
-     */
-    updateWidget(widget: Dashboard.Widget, teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.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
-     */
-    getWidgetMetadata(contributionId: string, project?: string): Promise<Dashboard.WidgetMetadataResponse>;
-    /**
-     * Get all available widget metadata in alphabetical order, including widgets marked with isVisibleFromCatalog == false.
-     *
-     * @param scope -
-     * @param project - Project ID or project name
-     */
-    getWidgetTypes(scope: Dashboard.WidgetScope, project?: string): Promise<Dashboard.WidgetTypesResponse>;
-}
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+import * as TfsCore from "../Core/Core";
+import * as Dashboard from "../Dashboard/Dashboard";
+export declare class DashboardRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions);
+    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
+     */
+    createDashboard(dashboard: Dashboard.Dashboard, teamContext: TfsCore.TeamContext): Promise<Dashboard.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.
+     */
+    deleteDashboard(teamContext: TfsCore.TeamContext, dashboardId: string): Promise<void>;
+    /**
+     * Get a dashboard by its ID.
+     *
+     * @param teamContext - The team context for the operation
+     * @param dashboardId -
+     */
+    getDashboard(teamContext: TfsCore.TeamContext, dashboardId: string): Promise<Dashboard.Dashboard>;
+    /**
+     * Get a list of dashboards under a project.
+     *
+     * @param teamContext - The team context for the operation
+     */
+    getDashboardsByProject(teamContext: TfsCore.TeamContext): Promise<Dashboard.Dashboard[]>;
+    /**
+     * 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.
+     */
+    replaceDashboard(dashboard: Dashboard.Dashboard, teamContext: TfsCore.TeamContext, dashboardId: string): Promise<Dashboard.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
+     */
+    replaceDashboards(group: Dashboard.DashboardGroup, teamContext: TfsCore.TeamContext): Promise<Dashboard.DashboardGroup>;
+    /**
+     * 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.
+     */
+    createWidget(widget: Dashboard.Widget, teamContext: TfsCore.TeamContext, dashboardId: string): Promise<Dashboard.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.
+     */
+    deleteWidget(teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.Dashboard>;
+    /**
+     * 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.
+     */
+    getWidget(teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.Widget>;
+    /**
+     * 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.
+     */
+    replaceWidget(widget: Dashboard.Widget, teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.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.
+     */
+    updateWidget(widget: Dashboard.Widget, teamContext: TfsCore.TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard.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
+     */
+    getWidgetMetadata(contributionId: string, project?: string): Promise<Dashboard.WidgetMetadataResponse>;
+    /**
+     * Get all available widget metadata in alphabetical order, including widgets marked with isVisibleFromCatalog == false.
+     *
+     * @param scope -
+     * @param project - Project ID or project name
+     */
+    getWidgetTypes(scope: Dashboard.WidgetScope, project?: string): Promise<Dashboard.WidgetTypesResponse>;
+}