azure-devops-extension-api 4.270.0 → 5.272.0

package/Dashboard/DashboardClient.min.js

@@ -1 +1 @@
-var __extends=this&&this.__extends||function(){var e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var r in t)t.hasOwnProperty(r)&&(e[r]=t[r])};return function(t,r){function o(){this.constructor=t}e(t,r),t.prototype=null===r?Object.create(r):(o.prototype=r.prototype,new o)}}(),__awaiter=this&&this.__awaiter||function(e,t,r,o){return new(r||(r=Promise))(function(a,i){function n(e){try{s(o.next(e))}catch(e){i(e)}}function d(e){try{s(o.throw(e))}catch(e){i(e)}}function s(e){e.done?a(e.value):new r(function(t){t(e.value)}).then(n,d)}s((o=o.apply(e,t||[])).next())})},__generator=this&&this.__generator||function(e,t){function r(r){return function(n){return function(r){if(o)throw new TypeError("Generator is already executing.");for(;d;)try{if(o=1,a&&(i=2&r[0]?a.return:r[0]?a.throw||((i=a.return)&&i.call(a),0):a.next)&&!(i=i.call(a,r[1])).done)return i;switch(a=0,i&&(r=[2&r[0],i.value]),r[0]){case 0:case 1:i=r;break;case 4:return d.label++,{value:r[1],done:!1};case 5:d.label++,a=r[1],r=[0];continue;case 7:r=d.ops.pop(),d.trys.pop();continue;default:if(i=d.trys,!(i=i.length>0&&i[i.length-1])&&(6===r[0]||2===r[0])){d=0;continue}if(3===r[0]&&(!i||r[1]>i[0]&&r[1]<i[3])){d.label=r[1];break}if(6===r[0]&&d.label<i[1]){d.label=i[1],i=r;break}if(i&&d.label<i[2]){d.label=i[2],d.ops.push(r);break}i[2]&&d.ops.pop(),d.trys.pop();continue}r=t.call(e,d)}catch(e){r=[6,e],a=0}finally{o=i=0}if(5&r[0])throw r[1];return{value:r[0]?r[1]:void 0,done:!0}}([r,n])}}var o,a,i,n,d={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]};return n={next:r(0),throw:r(1),return:r(2)},"function"==typeof Symbol&&(n[Symbol.iterator]=function(){return this}),n};define(["require","exports","../Common/RestClientBase"],function(e,t,r){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var o=function(e){function t(t){return e.call(this,t)||this}return __extends(t,e),t.prototype.createDashboard=function(e,t){return __awaiter(this,void 0,void 0,function(){var r,o;return __generator(this,function(a){return r=t.projectId||t.project,o=t.teamId||t.team,[2,this.beginRequest({apiVersion:"7.2-preview.3",method:"POST",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:r,team:o},body:e})]})})},t.prototype.deleteDashboard=function(e,t){return __awaiter(this,void 0,void 0,function(){var r,o;return __generator(this,function(a){return r=e.projectId||e.project,o=e.teamId||e.team,[2,this.beginRequest({apiVersion:"7.2-preview.3",method:"DELETE",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:r,team:o,dashboardId:t}})]})})},t.prototype.getDashboard=function(e,t){return __awaiter(this,void 0,void 0,function(){var r,o;return __generator(this,function(a){return r=e.projectId||e.project,o=e.teamId||e.team,[2,this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:r,team:o,dashboardId:t}})]})})},t.prototype.getDashboardsByProject=function(e){return __awaiter(this,void 0,void 0,function(){var t,r;return __generator(this,function(o){return t=e.projectId||e.project,r=e.teamId||e.team,[2,this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:t,team:r}})]})})},t.prototype.replaceDashboard=function(e,t,r){return __awaiter(this,void 0,void 0,function(){var o,a;return __generator(this,function(i){return o=t.projectId||t.project,a=t.teamId||t.team,[2,this.beginRequest({apiVersion:"7.2-preview.3",method:"PUT",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:o,team:a,dashboardId:r},body:e})]})})},t.prototype.replaceDashboards=function(e,t){return __awaiter(this,void 0,void 0,function(){var r,o;return __generator(this,function(a){return r=t.projectId||t.project,o=t.teamId||t.team,[2,this.beginRequest({apiVersion:"7.2-preview.3",method:"PUT",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:r,team:o},body:e})]})})},t.prototype.createWidget=function(e,t,r){return __awaiter(this,void 0,void 0,function(){var o,a;return __generator(this,function(i){return o=t.projectId||t.project,a=t.teamId||t.team,[2,this.beginRequest({apiVersion:"7.2-preview.2",method:"POST",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:o,team:a,dashboardId:r},body:e})]})})},t.prototype.deleteWidget=function(e,t,r){return __awaiter(this,void 0,void 0,function(){var o,a;return __generator(this,function(i){return o=e.projectId||e.project,a=e.teamId||e.team,[2,this.beginRequest({apiVersion:"7.2-preview.2",method:"DELETE",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:o,team:a,dashboardId:t,widgetId:r}})]})})},t.prototype.getWidget=function(e,t,r){return __awaiter(this,void 0,void 0,function(){var o,a;return __generator(this,function(i){return o=e.projectId||e.project,a=e.teamId||e.team,[2,this.beginRequest({apiVersion:"7.2-preview.2",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:o,team:a,dashboardId:t,widgetId:r}})]})})},t.prototype.replaceWidget=function(e,t,r,o){return __awaiter(this,void 0,void 0,function(){var a,i;return __generator(this,function(n){return a=t.projectId||t.project,i=t.teamId||t.team,[2,this.beginRequest({apiVersion:"7.2-preview.2",method:"PUT",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:a,team:i,dashboardId:r,widgetId:o},body:e})]})})},t.prototype.updateWidget=function(e,t,r,o){return __awaiter(this,void 0,void 0,function(){var a,i;return __generator(this,function(n){return a=t.projectId||t.project,i=t.teamId||t.team,[2,this.beginRequest({apiVersion:"7.2-preview.2",method:"PATCH",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:a,team:i,dashboardId:r,widgetId:o},body:e})]})})},t.prototype.getWidgetMetadata=function(e,t){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(r){return[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Dashboard/WidgetTypes/{contributionId}",routeValues:{project:t,contributionId:e}})]})})},t.prototype.getWidgetTypes=function(e,t){return __awaiter(this,void 0,void 0,function(){var r;return __generator(this,function(o){return r={$scope:e},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Dashboard/WidgetTypes/{contributionId}",routeValues:{project:t},queryParams:r})]})})},t.RESOURCE_AREA_ID="31c84e0a-3ece-48fd-a29d-100849af99ba",t}(r.RestClientBase);t.DashboardRestClient=o});
+"use strict";var __awaiter=this&&this.__awaiter||function(e,t,a,r){return new(a||(a=Promise))(function(o,d){function i(e){try{n(r.next(e))}catch(e){d(e)}}function s(e){try{n(r.throw(e))}catch(e){d(e)}}function n(e){e.done?o(e.value):function(e){return e instanceof a?e:new a(function(t){t(e)})}(e.value).then(i,s)}n((r=r.apply(e,t||[])).next())})};Object.defineProperty(exports,"__esModule",{value:!0}),exports.DashboardRestClient=void 0;const RestClientBase_1=require("../Common/RestClientBase");class DashboardRestClient extends RestClientBase_1.RestClientBase{constructor(e){super(e)}createDashboard(e,t){return __awaiter(this,void 0,void 0,function*(){const a=t.projectId||t.project,r=t.teamId||t.team;return this.beginRequest({apiVersion:"7.2-preview.3",method:"POST",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:a,team:r},body:e})})}deleteDashboard(e,t){return __awaiter(this,void 0,void 0,function*(){const a=e.projectId||e.project,r=e.teamId||e.team;return this.beginRequest({apiVersion:"7.2-preview.3",method:"DELETE",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:a,team:r,dashboardId:t}})})}getDashboard(e,t){return __awaiter(this,void 0,void 0,function*(){const a=e.projectId||e.project,r=e.teamId||e.team;return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:a,team:r,dashboardId:t}})})}getDashboardsByProject(e){return __awaiter(this,void 0,void 0,function*(){const t=e.projectId||e.project,a=e.teamId||e.team;return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:t,team:a}})})}replaceDashboard(e,t,a){return __awaiter(this,void 0,void 0,function*(){const r=t.projectId||t.project,o=t.teamId||t.team;return this.beginRequest({apiVersion:"7.2-preview.3",method:"PUT",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:r,team:o,dashboardId:a},body:e})})}replaceDashboards(e,t){return __awaiter(this,void 0,void 0,function*(){const a=t.projectId||t.project,r=t.teamId||t.team;return this.beginRequest({apiVersion:"7.2-preview.3",method:"PUT",routeTemplate:"{project}/{team}/_apis/Dashboard/Dashboards/{dashboardId}",routeValues:{project:a,team:r},body:e})})}createWidget(e,t,a){return __awaiter(this,void 0,void 0,function*(){const r=t.projectId||t.project,o=t.teamId||t.team;return this.beginRequest({apiVersion:"7.2-preview.2",method:"POST",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:r,team:o,dashboardId:a},body:e})})}deleteWidget(e,t,a){return __awaiter(this,void 0,void 0,function*(){const r=e.projectId||e.project,o=e.teamId||e.team;return this.beginRequest({apiVersion:"7.2-preview.2",method:"DELETE",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:r,team:o,dashboardId:t,widgetId:a}})})}getWidget(e,t,a){return __awaiter(this,void 0,void 0,function*(){const r=e.projectId||e.project,o=e.teamId||e.team;return this.beginRequest({apiVersion:"7.2-preview.2",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:r,team:o,dashboardId:t,widgetId:a}})})}replaceWidget(e,t,a,r){return __awaiter(this,void 0,void 0,function*(){const o=t.projectId||t.project,d=t.teamId||t.team;return this.beginRequest({apiVersion:"7.2-preview.2",method:"PUT",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:o,team:d,dashboardId:a,widgetId:r},body:e})})}updateWidget(e,t,a,r){return __awaiter(this,void 0,void 0,function*(){const o=t.projectId||t.project,d=t.teamId||t.team;return this.beginRequest({apiVersion:"7.2-preview.2",method:"PATCH",routeTemplate:"{project}/{team}/_apis/Dashboard/dashboards/{dashboardId}/Widgets/{widgetId}",routeValues:{project:o,team:d,dashboardId:a,widgetId:r},body:e})})}getWidgetMetadata(e,t){return __awaiter(this,void 0,void 0,function*(){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Dashboard/WidgetTypes/{contributionId}",routeValues:{project:t,contributionId:e}})})}getWidgetTypes(e,t){return __awaiter(this,void 0,void 0,function*(){const a={$scope:e};return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Dashboard/WidgetTypes/{contributionId}",routeValues:{project:t},queryParams:a})})}}exports.DashboardRestClient=DashboardRestClient,DashboardRestClient.RESOURCE_AREA_ID="31c84e0a-3ece-48fd-a29d-100849af99ba";

package/Dashboard/WidgetConfigHelpers.d.ts

@@ -1,34 +1,34 @@
-/**
- * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetConfigHelpers.ts
- */
-import { EventArgs } from "./WidgetContracts";
-export declare 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.
-    */
-    static ConfigurationChange: string;
-    /**
-     * 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.
-     */
-    static ConfigurationError: string;
-    /**
-     * 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
-     */
-    static GeneralSettingsChanged: string;
-    /**
-     * @param payload the event arguments we pass when we want to notify the configuration.
-     */
-    static Args<T>(payload: T): EventArgs<T>;
-}
+/**
+ * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetConfigHelpers.ts
+ */
+import { EventArgs } from "./WidgetContracts";
+export declare 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.
+    */
+    static ConfigurationChange: string;
+    /**
+     * 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.
+     */
+    static ConfigurationError: string;
+    /**
+     * 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
+     */
+    static GeneralSettingsChanged: string;
+    /**
+     * @param payload the event arguments we pass when we want to notify the configuration.
+     */
+    static Args<T>(payload: T): EventArgs<T>;
+}

package/Dashboard/WidgetConfigHelpers.js

@@ -1,45 +1,41 @@
-/**
- * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetConfigHelpers.ts
- */
-define(["require", "exports"], function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    var ConfigurationEvent = /** @class */ (function () {
-        function ConfigurationEvent() {
-        }
-        /**
-         * @param payload the event arguments we pass when we want to notify the configuration.
-         */
-        ConfigurationEvent.Args = function (payload) {
-            return {
-                data: payload
-            };
-        };
-        /**
-        * 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.
-        */
-        ConfigurationEvent.ConfigurationChange = "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.
-         */
-        ConfigurationEvent.ConfigurationError = "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
-         */
-        ConfigurationEvent.GeneralSettingsChanged = "ms.vss-dashboards-web.generalSettingsChanged";
-        return ConfigurationEvent;
-    }());
-    exports.ConfigurationEvent = ConfigurationEvent;
-});
+"use strict";
+/**
+ * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetConfigHelpers.ts
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationEvent = void 0;
+class ConfigurationEvent {
+    /**
+     * @param payload the event arguments we pass when we want to notify the configuration.
+     */
+    static Args(payload) {
+        return {
+            data: payload
+        };
+    }
+}
+exports.ConfigurationEvent = 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.
+*/
+ConfigurationEvent.ConfigurationChange = "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.
+ */
+ConfigurationEvent.ConfigurationError = "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
+ */
+ConfigurationEvent.GeneralSettingsChanged = "ms.vss-dashboards-web.generalSettingsChanged";

package/Dashboard/WidgetConfigHelpers.min.js

@@ -1 +1 @@
-define(["require","exports"],function(n,e){"use strict";Object.defineProperty(e,"__esModule",{value:!0});var r=function(){function n(){}return n.Args=function(n){return{data:n}},n.ConfigurationChange="ms.vss-dashboards-web.configurationChange",n.ConfigurationError="ms.vss-dashboards-web.configurationError",n.GeneralSettingsChanged="ms.vss-dashboards-web.generalSettingsChanged",n}();e.ConfigurationEvent=r});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ConfigurationEvent=void 0;class ConfigurationEvent{static Args(n){return{data:n}}}exports.ConfigurationEvent=ConfigurationEvent,ConfigurationEvent.ConfigurationChange="ms.vss-dashboards-web.configurationChange",ConfigurationEvent.ConfigurationError="ms.vss-dashboards-web.configurationError",ConfigurationEvent.GeneralSettingsChanged="ms.vss-dashboards-web.generalSettingsChanged";

package/Dashboard/WidgetContracts.d.ts

@@ -1,213 +1,213 @@
-/**
- * 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 declare 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;
-}
+/**
+ * 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 declare 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;
+}