azure-devops-extension-api 4.230.0 → 4.231.0

package/Alert/Alert.d.ts

@@ -60,6 +60,10 @@ export interface Alert {
      * Tools that have detected this issue.
      */
     tools: Tool[];
+    /**
+     * A truncated/obfuscated version of the secret pertaining to the alert (if applicable).
+     */
+    truncatedSecret: string;
     /**
      * ValidationFingerprints for the secret liveness check. Only return on demanded
      */
@@ -509,7 +513,7 @@ export declare enum ResultType {
  */
 export interface Rule {
     /**
-     * Additional properties of this rule
+     * Additional properties of this rule dependent on the rule type.  For example, dependency rules may include the CVE ID if it is available.
      */
     additionalProperties: {
         [key: string]: any;
@@ -596,12 +600,19 @@ export interface SearchCriteria {
      * If provided, only return alerts last seen before this date. \<br /\>Otherwise return all alerts.
      */
     toDate: Date;
+    /**
+     * If provided with toolName, only return alerts detected by this tool. \<br /\>Otherwise, return alerts detected by all tools.
+     */
+    toolName: string;
 }
 export declare enum Severity {
     Low = 0,
     Medium = 1,
     High = 2,
-    Critical = 3
+    Critical = 3,
+    Note = 4,
+    Warning = 5,
+    Error = 6
 }
 export declare enum State {
     /**
@@ -659,6 +670,7 @@ export interface UxFilters {
      * Alert states to show.  If empty show all alert states
      */
     states: State[];
+    tools: Tool[];
 }
 export interface ValidationFingerprint {
     validationFingerprintHash: string;

package/Alert/Alert.js

@@ -155,6 +155,9 @@ define(["require", "exports"], function (require, exports) {
         Severity[Severity["Medium"] = 1] = "Medium";
         Severity[Severity["High"] = 2] = "High";
         Severity[Severity["Critical"] = 3] = "Critical";
+        Severity[Severity["Note"] = 4] = "Note";
+        Severity[Severity["Warning"] = 5] = "Warning";
+        Severity[Severity["Error"] = 6] = "Error";
     })(Severity = exports.Severity || (exports.Severity = {}));
     var State;
     (function (State) {

package/Alert/Alert.min.js

@@ -1 +1 @@
-define(["require","exports"],function(e,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0});!function(e){e[e.Unknown=0]="Unknown",e[e.Dependency=1]="Dependency",e[e.Secret=2]="Secret",e[e.Code=3]="Code"}(n.AlertType||(n.AlertType={}));!function(e){e[e.Default=0]="Default",e[e.AdoPipeline=1]="AdoPipeline"}(n.AnalysisConfigurationType||(n.AnalysisConfigurationType={}));!function(e){e[e.Unknown=0]="Unknown",e[e.NuGet=1]="NuGet",e[e.Npm=2]="Npm",e[e.Maven=3]="Maven",e[e.Git=4]="Git",e[e.Other=5]="Other",e[e.RubyGems=6]="RubyGems",e[e.Cargo=7]="Cargo",e[e.Pip=8]="Pip",e[e.File=9]="File",e[e.Go=10]="Go",e[e.DockerImage=11]="DockerImage",e[e.Pod=12]="Pod",e[e.Linux=13]="Linux",e[e.Conda=14]="Conda",e[e.DockerReference=15]="DockerReference",e[e.Vcpkg=16]="Vcpkg"}(n.ComponentType||(n.ComponentType={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Fixed=1]="Fixed",e[e.AcceptedRisk=2]="AcceptedRisk",e[e.FalsePositive=3]="FalsePositive"}(n.DismissalType||(n.DismissalType={}));!function(e){e[e.None=0]="None",e[e.ValidationFingerprint=1]="ValidationFingerprint"}(n.ExpandOption||(n.ExpandOption={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Dependency=1]="Dependency",e[e.VersionControl=2]="VersionControl"}(n.ResultType||(n.ResultType={}));!function(e){e[e.Low=0]="Low",e[e.Medium=1]="Medium",e[e.High=2]="High",e[e.Critical=3]="Critical"}(n.Severity||(n.Severity={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Active=1]="Active",e[e.Dismissed=2]="Dismissed",e[e.Fixed=4]="Fixed",e[e.AutoDismissed=8]="AutoDismissed"}(n.State||(n.State={}))});
+define(["require","exports"],function(e,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0});!function(e){e[e.Unknown=0]="Unknown",e[e.Dependency=1]="Dependency",e[e.Secret=2]="Secret",e[e.Code=3]="Code"}(n.AlertType||(n.AlertType={}));!function(e){e[e.Default=0]="Default",e[e.AdoPipeline=1]="AdoPipeline"}(n.AnalysisConfigurationType||(n.AnalysisConfigurationType={}));!function(e){e[e.Unknown=0]="Unknown",e[e.NuGet=1]="NuGet",e[e.Npm=2]="Npm",e[e.Maven=3]="Maven",e[e.Git=4]="Git",e[e.Other=5]="Other",e[e.RubyGems=6]="RubyGems",e[e.Cargo=7]="Cargo",e[e.Pip=8]="Pip",e[e.File=9]="File",e[e.Go=10]="Go",e[e.DockerImage=11]="DockerImage",e[e.Pod=12]="Pod",e[e.Linux=13]="Linux",e[e.Conda=14]="Conda",e[e.DockerReference=15]="DockerReference",e[e.Vcpkg=16]="Vcpkg"}(n.ComponentType||(n.ComponentType={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Fixed=1]="Fixed",e[e.AcceptedRisk=2]="AcceptedRisk",e[e.FalsePositive=3]="FalsePositive"}(n.DismissalType||(n.DismissalType={}));!function(e){e[e.None=0]="None",e[e.ValidationFingerprint=1]="ValidationFingerprint"}(n.ExpandOption||(n.ExpandOption={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Dependency=1]="Dependency",e[e.VersionControl=2]="VersionControl"}(n.ResultType||(n.ResultType={}));!function(e){e[e.Low=0]="Low",e[e.Medium=1]="Medium",e[e.High=2]="High",e[e.Critical=3]="Critical",e[e.Note=4]="Note",e[e.Warning=5]="Warning",e[e.Error=6]="Error"}(n.Severity||(n.Severity={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Active=1]="Active",e[e.Dismissed=2]="Dismissed",e[e.Fixed=4]="Fixed",e[e.AutoDismissed=8]="AutoDismissed"}(n.State||(n.State={}))});

package/Build/Build.d.ts

@@ -214,7 +214,7 @@ export interface Build {
      */
     plans: TaskOrchestrationPlanReference[];
     /**
-     * The build's priority.
+     * Azure Pipelines does not support job priority. This field is deprecated.
      */
     priority: QueuePriority;
     /**

package/Dashboard/WidgetConfigHelpers.d.ts

@@ -0,0 +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>;
+}

package/Dashboard/WidgetConfigHelpers.js

@@ -0,0 +1,45 @@
+/**
+ * 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;
+});

package/Dashboard/WidgetConfigHelpers.min.js

@@ -0,0 +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});

package/Dashboard/WidgetContracts.d.ts

@@ -0,0 +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;
+}

package/Dashboard/WidgetContracts.js

@@ -0,0 +1,25 @@
+/**
+ * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetContracts.ts
+ */
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    /**
+     * Used to differentiate between widget status helpers
+     */
+    var WidgetStatusType;
+    (function (WidgetStatusType) {
+        /**
+         * The widget loaded successfully
+         */
+        WidgetStatusType[WidgetStatusType["Success"] = 0] = "Success";
+        /**
+         * The widget failed to load
+         */
+        WidgetStatusType[WidgetStatusType["Failure"] = 1] = "Failure";
+        /**
+         * The widget needs to be configured
+         */
+        WidgetStatusType[WidgetStatusType["Unconfigured"] = 2] = "Unconfigured";
+    })(WidgetStatusType = exports.WidgetStatusType || (exports.WidgetStatusType = {}));
+});

package/Dashboard/WidgetContracts.min.js

@@ -0,0 +1 @@
+define(["require","exports"],function(e,u){"use strict";Object.defineProperty(u,"__esModule",{value:!0});!function(e){e[e.Success=0]="Success",e[e.Failure=1]="Failure",e[e.Unconfigured=2]="Unconfigured"}(u.WidgetStatusType||(u.WidgetStatusType={}))});

package/Dashboard/WidgetHelpers.d.ts

@@ -0,0 +1,89 @@
+/**
+ * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetHelpers.ts
+ */
+import { CustomSettings, SaveStatus, WidgetStatus } from "./WidgetContracts";
+export declare class WidgetStatusHelper {
+    /**
+     * method to encapsulate a successful result for a widget loading operation (load, reload, openLightbox etc)
+     * @param state any state information to be passed to the initiator of the loading call.
+     * @param title title for the lightbox of a widget when available.
+     * @returns promise encapsulating the status of the widget loading operations.
+     */
+    static Success(state?: string): Promise<WidgetStatus>;
+    /**
+     * method to encapsulate a failed result for a widget loading operation (load, reload, openLightbox etc)
+     * @param message message to display as part within the widget error experience.
+     * @param isUserVisible indicates whether the message should be displayed to the user or a generic error message displayed. Defaults to true.
+     * @param isRichText indicates whether the message is an html that can be rendered as a rich experience. Defaults to false. Only trusted extensions are
+     * allowed to set this to true. For any 3rd party widgets passing this value as true, it will be ignored.
+     * @returns promise encapsulating the status of the widget loading operations.
+     */
+    static Failure(message: string, isUserVisible?: boolean, isRichText?: boolean): Promise<WidgetStatus>;
+    /**
+     * method to encapsulate a result for a widget loading operation that results in the widget being in an unconfigured state.
+     * @returns promise encapsulating the status of the widget loading operations.
+     */
+    static Unconfigured(): Promise<WidgetStatus>;
+}
+export declare class WidgetConfigurationSave {
+    /**
+     * method to encapsulate a valid state that is returned by the widget configuration
+     * @param customSettings settings from the widget configuration to be returned as part of this state.
+     * @returns promise encapsulating the state being returned.
+     */
+    static Valid(customSettings: CustomSettings): Promise<SaveStatus>;
+    /**
+     * method to encapsulate an invalid state that is returned by the widget configuration
+     * @returns promise encapsulating the state being returned.
+     */
+    static Invalid(): Promise<SaveStatus>;
+}
+export declare class WidgetSizeConverter {
+    /**
+    * Cell width of the grid that is used to draw the widgets, this includes the border around the widget (i.e. this is the size of the div, border included)
+    */
+    private static CellWidth;
+    /**
+    * Cell height of the grid that is used to draw the widgets, this includes the border around the widget (i.e. this is the size of the div, border included)
+    */
+    private static CellHeight;
+    /**
+    * Cell gutter width between the cells that is used to draw the widget, this excludes the border around the widget (i.e. this is distance between widgets)
+    */
+    private static CellMarginWidth;
+    /**
+    * Cell gutter height between the cells that is used to draw the widget, this excludes the border around the widget  (i.e. this is distance between widgets)
+    */
+    private static CellMarginHeight;
+    /**
+    * Calculates a dimension in pixels, given widget cell size and grid dimensions
+    * @returns size in pixels
+    */
+    private static CalculatePixelSize;
+    /**
+    * @returns width in pixels for 1x1 widget
+    */
+    static GetWidgetWidth(): number;
+    /**
+    * @returns height in pixels for 1x1 widget
+    */
+    static GetWidgetHeight(): number;
+    /**
+    * @returns width in pixels for widget gutter
+    */
+    static GetWidgetMarginWidth(): number;
+    /**
+    *  @returns height in pixels for widget gutter
+    */
+    static GetWidgetMarginHeight(): number;
+    /**
+    * Converts widget column span into pixels
+    * @returns width in pixels
+    */
+    static ColumnsToPixelWidth(columnSpan: number): number;
+    /**
+    * Converts widget row span into pixels
+    * @returns height in pixels
+    */
+    static RowsToPixelHeight(rowSpan: number): number;
+}

package/Dashboard/WidgetHelpers.js

@@ -0,0 +1,146 @@
+/**
+ * From /Tfs/WebPlatform/Client/TFS/Dashboards/WidgetHelpers.ts
+ */
+define(["require", "exports", "./WidgetContracts"], function (require, exports, WidgetContracts_1) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    var WidgetStatusHelper = /** @class */ (function () {
+        function WidgetStatusHelper() {
+        }
+        /**
+         * method to encapsulate a successful result for a widget loading operation (load, reload, openLightbox etc)
+         * @param state any state information to be passed to the initiator of the loading call.
+         * @param title title for the lightbox of a widget when available.
+         * @returns promise encapsulating the status of the widget loading operations.
+         */
+        WidgetStatusHelper.Success = function (state) {
+            return Promise.resolve({
+                state: state,
+                statusType: WidgetContracts_1.WidgetStatusType.Success
+            });
+        };
+        /**
+         * method to encapsulate a failed result for a widget loading operation (load, reload, openLightbox etc)
+         * @param message message to display as part within the widget error experience.
+         * @param isUserVisible indicates whether the message should be displayed to the user or a generic error message displayed. Defaults to true.
+         * @param isRichText indicates whether the message is an html that can be rendered as a rich experience. Defaults to false. Only trusted extensions are
+         * allowed to set this to true. For any 3rd party widgets passing this value as true, it will be ignored.
+         * @returns promise encapsulating the status of the widget loading operations.
+         */
+        WidgetStatusHelper.Failure = function (message, isUserVisible, isRichText) {
+            if (isUserVisible === void 0) { isUserVisible = true; }
+            if (isRichText === void 0) { isRichText = false; }
+            return Promise.reject({
+                message: message,
+                isRichText: isRichText,
+                isUserVisible: isUserVisible
+            });
+        };
+        /**
+         * method to encapsulate a result for a widget loading operation that results in the widget being in an unconfigured state.
+         * @returns promise encapsulating the status of the widget loading operations.
+         */
+        WidgetStatusHelper.Unconfigured = function () {
+            return Promise.resolve({
+                statusType: WidgetContracts_1.WidgetStatusType.Unconfigured
+            });
+        };
+        return WidgetStatusHelper;
+    }());
+    exports.WidgetStatusHelper = WidgetStatusHelper;
+    var WidgetConfigurationSave = /** @class */ (function () {
+        function WidgetConfigurationSave() {
+        }
+        /**
+         * method to encapsulate a valid state that is returned by the widget configuration
+         * @param customSettings settings from the widget configuration to be returned as part of this state.
+         * @returns promise encapsulating the state being returned.
+         */
+        WidgetConfigurationSave.Valid = function (customSettings) {
+            return Promise.resolve({
+                customSettings: customSettings,
+                isValid: true
+            });
+        };
+        /**
+         * method to encapsulate an invalid state that is returned by the widget configuration
+         * @returns promise encapsulating the state being returned.
+         */
+        WidgetConfigurationSave.Invalid = function () {
+            return Promise.reject({
+                isValid: false
+            });
+        };
+        return WidgetConfigurationSave;
+    }());
+    exports.WidgetConfigurationSave = WidgetConfigurationSave;
+    var WidgetSizeConverter = /** @class */ (function () {
+        function WidgetSizeConverter() {
+        }
+        /**
+        * Calculates a dimension in pixels, given widget cell size and grid dimensions
+        * @returns size in pixels
+        */
+        WidgetSizeConverter.CalculatePixelSize = function (cellCount, gridCellSize, gridMarginSize) {
+            //the dimensions of a multi-celled widget are a combination of space of the occupied cells AND the margins between those cells
+            var marginCount = cellCount - 1;
+            return gridCellSize * cellCount + gridMarginSize * marginCount;
+        };
+        /**
+        * @returns width in pixels for 1x1 widget
+        */
+        WidgetSizeConverter.GetWidgetWidth = function () {
+            return WidgetSizeConverter.CellWidth;
+        };
+        /**
+        * @returns height in pixels for 1x1 widget
+        */
+        WidgetSizeConverter.GetWidgetHeight = function () {
+            return WidgetSizeConverter.CellHeight;
+        };
+        /**
+        * @returns width in pixels for widget gutter
+        */
+        WidgetSizeConverter.GetWidgetMarginWidth = function () {
+            return WidgetSizeConverter.CellMarginWidth;
+        };
+        /**
+        *  @returns height in pixels for widget gutter
+        */
+        WidgetSizeConverter.GetWidgetMarginHeight = function () {
+            return WidgetSizeConverter.CellMarginHeight;
+        };
+        /**
+        * Converts widget column span into pixels
+        * @returns width in pixels
+        */
+        WidgetSizeConverter.ColumnsToPixelWidth = function (columnSpan) {
+            return this.CalculatePixelSize(columnSpan, WidgetSizeConverter.GetWidgetWidth(), WidgetSizeConverter.GetWidgetMarginWidth());
+        };
+        /**
+        * Converts widget row span into pixels
+        * @returns height in pixels
+        */
+        WidgetSizeConverter.RowsToPixelHeight = function (rowSpan) {
+            return this.CalculatePixelSize(rowSpan, WidgetSizeConverter.GetWidgetHeight(), WidgetSizeConverter.GetWidgetMarginHeight());
+        };
+        /**
+        * Cell width of the grid that is used to draw the widgets, this includes the border around the widget (i.e. this is the size of the div, border included)
+        */
+        WidgetSizeConverter.CellWidth = 160;
+        /**
+        * Cell height of the grid that is used to draw the widgets, this includes the border around the widget (i.e. this is the size of the div, border included)
+        */
+        WidgetSizeConverter.CellHeight = 160;
+        /**
+        * Cell gutter width between the cells that is used to draw the widget, this excludes the border around the widget (i.e. this is distance between widgets)
+        */
+        WidgetSizeConverter.CellMarginWidth = 10;
+        /**
+        * Cell gutter height between the cells that is used to draw the widget, this excludes the border around the widget  (i.e. this is distance between widgets)
+        */
+        WidgetSizeConverter.CellMarginHeight = 10;
+        return WidgetSizeConverter;
+    }());
+    exports.WidgetSizeConverter = WidgetSizeConverter;
+});

package/Dashboard/WidgetHelpers.min.js

@@ -0,0 +1 @@
+define(["require","exports","./WidgetContracts"],function(e,t,i){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var n=function(){function e(){}return e.Success=function(e){return Promise.resolve({state:e,statusType:i.WidgetStatusType.Success})},e.Failure=function(e,t,i){return void 0===t&&(t=!0),void 0===i&&(i=!1),Promise.reject({message:e,isRichText:i,isUserVisible:t})},e.Unconfigured=function(){return Promise.resolve({statusType:i.WidgetStatusType.Unconfigured})},e}();t.WidgetStatusHelper=n;var r=function(){function e(){}return e.Valid=function(e){return Promise.resolve({customSettings:e,isValid:!0})},e.Invalid=function(){return Promise.reject({isValid:!1})},e}();t.WidgetConfigurationSave=r;var u=function(){function e(){}return e.CalculatePixelSize=function(e,t,i){return t*e+i*(e-1)},e.GetWidgetWidth=function(){return e.CellWidth},e.GetWidgetHeight=function(){return e.CellHeight},e.GetWidgetMarginWidth=function(){return e.CellMarginWidth},e.GetWidgetMarginHeight=function(){return e.CellMarginHeight},e.ColumnsToPixelWidth=function(t){return this.CalculatePixelSize(t,e.GetWidgetWidth(),e.GetWidgetMarginWidth())},e.RowsToPixelHeight=function(t){return this.CalculatePixelSize(t,e.GetWidgetHeight(),e.GetWidgetMarginHeight())},e.CellWidth=160,e.CellHeight=160,e.CellMarginWidth=10,e.CellMarginHeight=10,e}();t.WidgetSizeConverter=u});

package/Dashboard/index.d.ts

@@ -1,2 +1,5 @@
 export * from "./Dashboard";
 export * from "./DashboardClient";
+export * from "./WidgetConfigHelpers";
+export * from "./WidgetContracts";
+export * from "./WidgetHelpers";