azure-devops-extension-api 4.233.0 → 4.235.0

package/Alert/Alert.d.ts

@@ -8,6 +8,10 @@ export interface Alert {
      * Type of the alert. E.g. secret, code, etc.
      */
     alertType: AlertType;
+    /**
+     * Confidence level of the alert.
+     */
+    confidence: Confidence;
     /**
      * Contains information for the dismissal of the alert if the alert has been dismissed.
      */
@@ -65,7 +69,7 @@ export interface Alert {
      */
     truncatedSecret: string;
     /**
-     * ValidationFingerprints for the secret liveness check. Only return on demanded
+     * ValidationFingerprints for the secret liveness check. Only returned on demand in Get API with Expand parameter set to be ValidationFingerprint (not returned in List API)
      */
     validationFingerprints: ValidationFingerprint[];
 }
@@ -98,6 +102,32 @@ export interface AlertAnalysisInstance {
      */
     state: State;
 }
+/**
+ * Alert metadata.
+ */
+export interface AlertMetadata {
+    /**
+     * The ID of the alert.
+     */
+    alertId: number;
+    /**
+     * A list of metadata to be associated with the alert.
+     */
+    metadata: Metadata[];
+}
+/**
+ * Used to represent an update in a relationship between an alert and an artifact.
+ */
+export interface AlertMetadataChange {
+    /**
+     * The ID of the alert.
+     */
+    alertId: number;
+    /**
+     * The change that occurred to the metadata.
+     */
+    metadataChange: MetadataChange;
+}
 export interface AlertStateUpdate {
     dismissedComment: string;
     dismissedReason: DismissalType;
@@ -263,6 +293,9 @@ export declare enum ComponentType {
      * Indicates the component is a loose file. Not a package as understood by different package managers.
      */
     File = 9,
+    /**
+     * Indicates the component is a Go package.
+     */
     Go = 10,
     /**
      * Indicates the component is a Docker Image
@@ -289,6 +322,16 @@ export declare enum ComponentType {
      */
     Vcpkg = 16
 }
+export declare enum Confidence {
+    /**
+     * High confidence level for alert
+     */
+    High = 0,
+    /**
+     * Other confidence level for alert
+     */
+    Other = 1
+}
 /**
  * Information about a vulnerable dependency
  */
@@ -396,6 +439,48 @@ export interface LogicalLocation {
      */
     kind: string;
 }
+/**
+ * The metadata operation to be performed on the alert.
+ */
+export interface Metadata {
+    /**
+     * The type of operation to be performed.
+     */
+    op: MetadataOperation;
+    /**
+     * The metadata value
+     */
+    value: RelationMetadata;
+}
+/**
+ * The change that has been made to the metadata.
+ */
+export interface MetadataChange {
+    /**
+     * The type of change on the metadata.
+     */
+    changeType: MetadataChangeType;
+    /**
+     * Represents a metadata association to an alert.
+     */
+    value: RelationMetadata;
+}
+/**
+ * The type of change that occurred to the metadata.
+ */
+export declare enum MetadataChangeType {
+    None = 0,
+    Created = 1,
+    Updated = 2,
+    Deleted = 3
+}
+/**
+ * The operation to be performed on the metadata.
+ */
+export declare enum MetadataOperation {
+    Add = 0,
+    Remove = 1
+}
 /**
  * Location in the source control system where the issue was found
  */
@@ -428,10 +513,6 @@ export interface Region {
      * The column where the code snippet starts
      */
     columnStart: number;
-    /**
-     * A subset of the code snippet highlighting the issue
-     */
-    highlightSnippet: string;
     /**
      * The line number where the code snippet ends
      */
@@ -440,10 +521,25 @@ export interface Region {
      * The line number where the code snippet starts
      */
     lineStart: number;
+}
+/**
+ * The metadata to be associated with the alert.
+ */
+export interface RelationMetadata {
     /**
-     * The full code snippet
+     * Any additional attributes of the metadata.
      */
-    snippet: string;
+    attributes: {
+        [key: string]: any;
+    };
+    /**
+     * The type of the metadata.
+     */
+    rel: string;
+    /**
+     * The URL of the metadata.
+     */
+    url: string;
 }
 export interface Result {
     /**
@@ -543,11 +639,45 @@ export interface Rule {
      */
     tags: string[];
 }
+export declare enum SarifJobStatus {
+    /**
+     * The job type when it is new
+     */
+    New = 0,
+    /**
+     * The job type when it is queued
+     */
+    Queued = 1,
+    /**
+     * The job type when it is completed
+     */
+    Completed = 2,
+    /**
+     * The job type when it fails
+     */
+    Failed = 3
+}
+export interface SarifUploadStatus {
+    errors: SarifValidationError[];
+    processingStatus: SarifJobStatus;
+}
+export interface SarifValidationError {
+    nodePointer: string;
+    validationError: string;
+}
 export interface SearchCriteria {
+    /**
+     * If provided, only return alerts with the ids specified. \<br /\>Otherwise, return any alert.
+     */
+    alertIds: number[];
     /**
      * If provided, only return alerts of this type. Otherwise, return alerts of all types.
      */
     alertType: AlertType;
+    /**
+     * If provided, only return alerts at these confidence levels. \<br /\>Otherwise, return alerts at any confidence level.
+     */
+    confidenceLevels: Confidence[];
     /**
      * If provided, only alerts for this dependency are returned. \<br /\>Otherwise, return alerts for all dependencies. \<br /\>In a sarif submission, a dependency (or a vulnerable component) is specified in result.RelatedLocations[].logicalLocation.
      */
@@ -658,6 +788,10 @@ export interface UxFilters {
      * Branches to display alerts for.  If empty, show alerts from all branches
      */
     branches: Branch[];
+    /**
+     * Confidence levels to show, only valid when AlertType is Secret.
+     */
+    confidenceLevels: Confidence[];
     packages: Dependency[];
     /**
      * Pipelines to show alerts for.  If empty, show alerts for all pipelines
@@ -720,14 +854,6 @@ export interface VersionControlSnippet {
      * line in the code file where the snippet ends
      */
     endLine: number;
-    /**
-     * subset of the code snippet highlighting the alert issue
-     */
-    highlightSnippet: string;
-    /**
-     * larger code snippet
-     */
-    snippet: string;
     /**
      * column in the code file where the snippet starts
      */
@@ -736,10 +862,6 @@ export interface VersionControlSnippet {
      * line in the code file where the snippet starts
      */
     startLine: number;
-    /**
-     * Version control system where the code was found
-     */
-    versionControl: string;
     /**
      * path of the code file in the version control system
      */

package/Alert/Alert.js

@@ -75,6 +75,9 @@ define(["require", "exports"], function (require, exports) {
          * Indicates the component is a loose file. Not a package as understood by different package managers.
          */
         ComponentType[ComponentType["File"] = 9] = "File";
+        /**
+         * Indicates the component is a Go package.
+         */
         ComponentType[ComponentType["Go"] = 10] = "Go";
         /**
          * Indicates the component is a Docker Image
@@ -101,6 +104,17 @@ define(["require", "exports"], function (require, exports) {
          */
         ComponentType[ComponentType["Vcpkg"] = 16] = "Vcpkg";
     })(ComponentType = exports.ComponentType || (exports.ComponentType = {}));
+    var Confidence;
+    (function (Confidence) {
+        /**
+         * High confidence level for alert
+         */
+        Confidence[Confidence["High"] = 0] = "High";
+        /**
+         * Other confidence level for alert
+         */
+        Confidence[Confidence["Other"] = 1] = "Other";
+    })(Confidence = exports.Confidence || (exports.Confidence = {}));
     var DismissalType;
     (function (DismissalType) {
         /**
@@ -131,6 +145,24 @@ define(["require", "exports"], function (require, exports) {
          */
         ExpandOption[ExpandOption["ValidationFingerprint"] = 1] = "ValidationFingerprint";
     })(ExpandOption = exports.ExpandOption || (exports.ExpandOption = {}));
+    /**
+     * The type of change that occurred to the metadata.
+     */
+    var MetadataChangeType;
+    (function (MetadataChangeType) {
+        MetadataChangeType[MetadataChangeType["None"] = 0] = "None";
+        MetadataChangeType[MetadataChangeType["Created"] = 1] = "Created";
+        MetadataChangeType[MetadataChangeType["Updated"] = 2] = "Updated";
+        MetadataChangeType[MetadataChangeType["Deleted"] = 3] = "Deleted";
+    })(MetadataChangeType = exports.MetadataChangeType || (exports.MetadataChangeType = {}));
+    /**
+     * The operation to be performed on the metadata.
+     */
+    var MetadataOperation;
+    (function (MetadataOperation) {
+        MetadataOperation[MetadataOperation["Add"] = 0] = "Add";
+        MetadataOperation[MetadataOperation["Remove"] = 1] = "Remove";
+    })(MetadataOperation = exports.MetadataOperation || (exports.MetadataOperation = {}));
     /**
      * This enum defines the different result types.
      */
@@ -149,6 +181,25 @@ define(["require", "exports"], function (require, exports) {
          */
         ResultType[ResultType["VersionControl"] = 2] = "VersionControl";
     })(ResultType = exports.ResultType || (exports.ResultType = {}));
+    var SarifJobStatus;
+    (function (SarifJobStatus) {
+        /**
+         * The job type when it is new
+         */
+        SarifJobStatus[SarifJobStatus["New"] = 0] = "New";
+        /**
+         * The job type when it is queued
+         */
+        SarifJobStatus[SarifJobStatus["Queued"] = 1] = "Queued";
+        /**
+         * The job type when it is completed
+         */
+        SarifJobStatus[SarifJobStatus["Completed"] = 2] = "Completed";
+        /**
+         * The job type when it fails
+         */
+        SarifJobStatus[SarifJobStatus["Failed"] = 3] = "Failed";
+    })(SarifJobStatus = exports.SarifJobStatus || (exports.SarifJobStatus = {}));
     var Severity;
     (function (Severity) {
         Severity[Severity["Low"] = 0] = "Low";

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",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={}))});
+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.High=0]="High",e[e.Other=1]="Other"}(n.Confidence||(n.Confidence={}));!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.None=0]="None",e[e.Created=1]="Created",e[e.Updated=2]="Updated",e[e.Deleted=3]="Deleted"}(n.MetadataChangeType||(n.MetadataChangeType={}));!function(e){e[e.Add=0]="Add",e[e.Remove=1]="Remove"}(n.MetadataOperation||(n.MetadataOperation={}));!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.New=0]="New",e[e.Queued=1]="Queued",e[e.Completed=2]="Completed",e[e.Failed=3]="Failed"}(n.SarifJobStatus||(n.SarifJobStatus={}));!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/Alert/AlertClient.d.ts

@@ -45,12 +45,22 @@ export declare class AlertRestClient extends RestClientBase {
      */
     updateAlert(stateUpdate: Alert.AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert.Alert>;
     /**
+     * Get instances of an alert.
+     *
      * @param project - Project ID or project name
-     * @param alertId -
-     * @param repository -
+     * @param alertId - ID of alert to retrieve
+     * @param repository - Name or id of a repository that alert is part of
      * @param ref -
      */
     getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<Alert.AlertAnalysisInstance[]>;
+    /**
+     * Update alert metadata associations.
+     *
+     * @param alertsMetadata - A list of metadata to associate with alerts.
+     * @param project - Project ID or project name
+     * @param repository - The name or ID of the repository.
+     */
+    updateAlertsMetadata(alertsMetadata: Alert.AlertMetadata[], project: string, repository: string): Promise<Alert.AlertMetadataChange[]>;
     /**
      * Upload a Sarif containing security alerts
      *
@@ -70,5 +80,5 @@ export declare class AlertRestClient extends RestClientBase {
      *
      * @param sarifId - Sarif ID returned when the Sarif was uploaded
      */
-    getSarif(sarifId: number): Promise<boolean>;
+    getSarif(sarifId: number): Promise<Alert.SarifUploadStatus>;
 }

package/Alert/AlertClient.js

@@ -187,9 +187,11 @@ define(["require", "exports", "../Common/RestClientBase", "../Common/Util/Serial
             });
         };
         /**
+         * Get instances of an alert.
+         *
          * @param project - Project ID or project name
-         * @param alertId -
-         * @param repository -
+         * @param alertId - ID of alert to retrieve
+         * @param repository - Name or id of a repository that alert is part of
          * @param ref -
          */
         AlertRestClient.prototype.getAlertInstances = function (project, alertId, repository, ref) {
@@ -212,6 +214,29 @@ define(["require", "exports", "../Common/RestClientBase", "../Common/Util/Serial
                 });
             });
         };
+        /**
+         * Update alert metadata associations.
+         *
+         * @param alertsMetadata - A list of metadata to associate with alerts.
+         * @param project - Project ID or project name
+         * @param repository - The name or ID of the repository.
+         */
+        AlertRestClient.prototype.updateAlertsMetadata = function (alertsMetadata, project, repository) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    return [2 /*return*/, this.beginRequest({
+                            apiVersion: "7.2-preview.1",
+                            method: "PATCH",
+                            routeTemplate: "{project}/_apis/Alert/repositories/{repository}/alerts/Metadata",
+                            routeValues: {
+                                project: project,
+                                repository: repository
+                            },
+                            body: alertsMetadata
+                        })];
+                });
+            });
+        };
         /**
          * Upload a Sarif containing security alerts
          *
@@ -271,7 +296,7 @@ define(["require", "exports", "../Common/RestClientBase", "../Common/Util/Serial
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
                     return [2 /*return*/, this.beginRequest({
-                            apiVersion: "7.2-preview.1",
+                            apiVersion: "7.2-preview.2",
                             routeTemplate: "_apis/Alert/Sarifs/{sarifId}",
                             routeValues: {
                                 sarifId: sarifId

package/Alert/AlertClient.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(n,i){function a(e){try{u(o.next(e))}catch(e){i(e)}}function s(e){try{u(o.throw(e))}catch(e){i(e)}}function u(e){e.done?n(e.value):new r(function(t){t(e.value)}).then(a,s)}u((o=o.apply(e,t||[])).next())})},__generator=this&&this.__generator||function(e,t){function r(r){return function(a){return function(r){if(o)throw new TypeError("Generator is already executing.");for(;s;)try{if(o=1,n&&(i=2&r[0]?n.return:r[0]?n.throw||((i=n.return)&&i.call(n),0):n.next)&&!(i=i.call(n,r[1])).done)return i;switch(n=0,i&&(r=[2&r[0],i.value]),r[0]){case 0:case 1:i=r;break;case 4:return s.label++,{value:r[1],done:!1};case 5:s.label++,n=r[1],r=[0];continue;case 7:r=s.ops.pop(),s.trys.pop();continue;default:if(i=s.trys,!(i=i.length>0&&i[i.length-1])&&(6===r[0]||2===r[0])){s=0;continue}if(3===r[0]&&(!i||r[1]>i[0]&&r[1]<i[3])){s.label=r[1];break}if(6===r[0]&&s.label<i[1]){s.label=i[1],i=r;break}if(i&&s.label<i[2]){s.label=i[2],s.ops.push(r);break}i[2]&&s.ops.pop(),s.trys.pop();continue}r=t.call(e,s)}catch(e){r=[6,e],n=0}finally{o=i=0}if(5&r[0])throw r[1];return{value:r[0]?r[1]:void 0,done:!0}}([r,a])}}var o,n,i,a,s={label:0,sent:function(){if(1&i[0])throw i[1];return i[1]},trys:[],ops:[]};return a={next:r(0),throw:r(1),return:r(2)},"function"==typeof Symbol&&(a[Symbol.iterator]=function(){return this}),a};define(["require","exports","../Common/RestClientBase","../Common/Util/Serialization"],function(e,t,r,o){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var n=function(e){function t(t){return e.call(this,t)||this}return __extends(t,e),t.prototype.getAlert=function(e,t,r,o,n){return __awaiter(this,void 0,void 0,function(){var i;return __generator(this,function(a){return i={ref:o,expand:n},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:e,alertId:t,repository:r},queryParams:i})]})})},t.prototype.getAlerts=function(e,t,r,n,i,a){return __awaiter(this,void 0,void 0,function(){var s,u=this;return __generator(this,function(p){return s={top:r,orderBy:n,criteria:i,continuationToken:a},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:e,repository:t},queryParams:s,returnRawResponse:!0}).then(function(e){return __awaiter(u,void 0,void 0,function(){var t;return __generator(this,function(r){switch(r.label){case 0:return[4,e.text().then(o.deserializeVssJsonObject)];case 1:return t=r.sent(),t.continuationToken=e.headers.get("x-ms-continuationtoken"),[2,t]}})})})]})})},t.prototype.getAlertSarif=function(e,t,r,o,n){return __awaiter(this,void 0,void 0,function(){var i;return __generator(this,function(a){return i={ref:o,expand:n},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:e,alertId:t,repository:r},queryParams:i})]})})},t.prototype.updateAlert=function(e,t,r,o){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(n){return[2,this.beginRequest({apiVersion:"7.2-preview.1",method:"PATCH",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:t,alertId:r,repository:o},body:e})]})})},t.prototype.getAlertInstances=function(e,t,r,o){return __awaiter(this,void 0,void 0,function(){var n;return __generator(this,function(i){return n={ref:o},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Instances",routeValues:{project:e,alertId:t,repository:r},queryParams:n})]})})},t.prototype.uploadSarif=function(e,t,r){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(o){return[2,this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/sarifs",routeValues:{project:t,repository:r},customHeaders:{"Content-Type":"application/octet-stream"},body:e})]})})},t.prototype.getUxFilters=function(e,t,r){return __awaiter(this,void 0,void 0,function(){var o;return __generator(this,function(n){return o={alertType:r},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/filters",routeValues:{project:e,repository:t},queryParams:o})]})})},t.prototype.getSarif=function(e){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(t){return[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/Alert/Sarifs/{sarifId}",routeValues:{sarifId:e}})]})})},t}(r.RestClientBase);t.AlertRestClient=n});
+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(i,n){function a(e){try{u(o.next(e))}catch(e){n(e)}}function s(e){try{u(o.throw(e))}catch(e){n(e)}}function u(e){e.done?i(e.value):new r(function(t){t(e.value)}).then(a,s)}u((o=o.apply(e,t||[])).next())})},__generator=this&&this.__generator||function(e,t){function r(r){return function(a){return function(r){if(o)throw new TypeError("Generator is already executing.");for(;s;)try{if(o=1,i&&(n=2&r[0]?i.return:r[0]?i.throw||((n=i.return)&&n.call(i),0):i.next)&&!(n=n.call(i,r[1])).done)return n;switch(i=0,n&&(r=[2&r[0],n.value]),r[0]){case 0:case 1:n=r;break;case 4:return s.label++,{value:r[1],done:!1};case 5:s.label++,i=r[1],r=[0];continue;case 7:r=s.ops.pop(),s.trys.pop();continue;default:if(n=s.trys,!(n=n.length>0&&n[n.length-1])&&(6===r[0]||2===r[0])){s=0;continue}if(3===r[0]&&(!n||r[1]>n[0]&&r[1]<n[3])){s.label=r[1];break}if(6===r[0]&&s.label<n[1]){s.label=n[1],n=r;break}if(n&&s.label<n[2]){s.label=n[2],s.ops.push(r);break}n[2]&&s.ops.pop(),s.trys.pop();continue}r=t.call(e,s)}catch(e){r=[6,e],i=0}finally{o=n=0}if(5&r[0])throw r[1];return{value:r[0]?r[1]:void 0,done:!0}}([r,a])}}var o,i,n,a,s={label:0,sent:function(){if(1&n[0])throw n[1];return n[1]},trys:[],ops:[]};return a={next:r(0),throw:r(1),return:r(2)},"function"==typeof Symbol&&(a[Symbol.iterator]=function(){return this}),a};define(["require","exports","../Common/RestClientBase","../Common/Util/Serialization"],function(e,t,r,o){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var i=function(e){function t(t){return e.call(this,t)||this}return __extends(t,e),t.prototype.getAlert=function(e,t,r,o,i){return __awaiter(this,void 0,void 0,function(){var n;return __generator(this,function(a){return n={ref:o,expand:i},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:e,alertId:t,repository:r},queryParams:n})]})})},t.prototype.getAlerts=function(e,t,r,i,n,a){return __awaiter(this,void 0,void 0,function(){var s,u=this;return __generator(this,function(p){return s={top:r,orderBy:i,criteria:n,continuationToken:a},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:e,repository:t},queryParams:s,returnRawResponse:!0}).then(function(e){return __awaiter(u,void 0,void 0,function(){var t;return __generator(this,function(r){switch(r.label){case 0:return[4,e.text().then(o.deserializeVssJsonObject)];case 1:return t=r.sent(),t.continuationToken=e.headers.get("x-ms-continuationtoken"),[2,t]}})})})]})})},t.prototype.getAlertSarif=function(e,t,r,o,i){return __awaiter(this,void 0,void 0,function(){var n;return __generator(this,function(a){return n={ref:o,expand:i},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:e,alertId:t,repository:r},queryParams:n})]})})},t.prototype.updateAlert=function(e,t,r,o){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(i){return[2,this.beginRequest({apiVersion:"7.2-preview.1",method:"PATCH",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/Alerts/{alertId}",routeValues:{project:t,alertId:r,repository:o},body:e})]})})},t.prototype.getAlertInstances=function(e,t,r,o){return __awaiter(this,void 0,void 0,function(){var i;return __generator(this,function(n){return i={ref:o},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/{alertId}/Instances",routeValues:{project:e,alertId:t,repository:r},queryParams:i})]})})},t.prototype.updateAlertsMetadata=function(e,t,r){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(o){return[2,this.beginRequest({apiVersion:"7.2-preview.1",method:"PATCH",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/alerts/Metadata",routeValues:{project:t,repository:r},body:e})]})})},t.prototype.uploadSarif=function(e,t,r){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(o){return[2,this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/sarifs",routeValues:{project:t,repository:r},customHeaders:{"Content-Type":"application/octet-stream"},body:e})]})})},t.prototype.getUxFilters=function(e,t,r){return __awaiter(this,void 0,void 0,function(){var o;return __generator(this,function(i){return o={alertType:r},[2,this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"{project}/_apis/Alert/repositories/{repository}/filters",routeValues:{project:e,repository:t},queryParams:o})]})})},t.prototype.getSarif=function(e){return __awaiter(this,void 0,void 0,function(){return __generator(this,function(t){return[2,this.beginRequest({apiVersion:"7.2-preview.2",routeTemplate:"_apis/Alert/Sarifs/{sarifId}",routeValues:{sarifId:e}})]})})},t}(r.RestClientBase);t.AlertRestClient=i});

package/Build/Build.d.ts

@@ -2307,7 +2307,13 @@ export interface RealtimeBuildEvent {
     buildId: number;
 }
 export declare enum RepositoryCleanOptions {
+    /**
+     * Run git clean -fdx && git reset --hard or Tf /scorch on $(build.sourcesDirectory)
+     */
     Source = 0,
+    /**
+     * Run git clean -fdx && git reset --hard or Tf /scorch on $(build.sourcesDirectory), also re-create $(build.binariesDirectory)
+     */
     SourceAndOutputDir = 1,
     /**
      * Re-create $(build.sourcesDirectory)

package/Build/Build.js

@@ -452,7 +452,13 @@ define(["require", "exports"], function (require, exports) {
     })(QueuePriority = exports.QueuePriority || (exports.QueuePriority = {}));
     var RepositoryCleanOptions;
     (function (RepositoryCleanOptions) {
+        /**
+         * Run git clean -fdx && git reset --hard or Tf /scorch on $(build.sourcesDirectory)
+         */
         RepositoryCleanOptions[RepositoryCleanOptions["Source"] = 0] = "Source";
+        /**
+         * Run git clean -fdx && git reset --hard or Tf /scorch on $(build.sourcesDirectory), also re-create $(build.binariesDirectory)
+         */
         RepositoryCleanOptions[RepositoryCleanOptions["SourceAndOutputDir"] = 1] = "SourceAndOutputDir";
         /**
          * Re-create $(build.sourcesDirectory)

package/Comments/Comments.d.ts

@@ -89,6 +89,9 @@ export interface CommentCreateParameters {
      * Optional CommentId of the parent in order to add a reply for an existing comment
      */
     parentId: number;
+    /**
+     * Text of the comment
+     */
     text: string;
 }
 /**
@@ -107,6 +110,9 @@ export declare enum CommentExpandOptions {
      * Include the rendered text (html) in addition to markdown text
      */
     RenderedText = 8,
+    /**
+     * If specified, then ONLY rendered text (html) will be returned, w/o markdown. Supposed to be used internally from data provides for optimization purposes.
+     */
     RenderedTextOnly = 16,
     /**
      * If specified, then responses will be expanded in the results
@@ -220,6 +226,9 @@ export declare enum CommentReactionType {
  * Base class for comment resource references
  */
 export interface CommentResourceReference {
+    /**
+     * REST URL for the resource.
+     */
     url: string;
 }
 export declare enum CommentSortOrder {

package/Comments/Comments.js

@@ -23,6 +23,9 @@ define(["require", "exports"], function (require, exports) {
          * Include the rendered text (html) in addition to markdown text
          */
         CommentExpandOptions[CommentExpandOptions["RenderedText"] = 8] = "RenderedText";
+        /**
+         * If specified, then ONLY rendered text (html) will be returned, w/o markdown. Supposed to be used internally from data provides for optimization purposes.
+         */
         CommentExpandOptions[CommentExpandOptions["RenderedTextOnly"] = 16] = "RenderedTextOnly";
         /**
          * If specified, then responses will be expanded in the results

package/Core/Core.d.ts

@@ -347,16 +347,34 @@ export interface TeamProjectReference {
  * A data transfer object that stores the metadata associated with the creation of temporary data.
  */
 export interface TemporaryDataCreatedDTO extends TemporaryDataDTO {
+    /**
+     * Temporary data expiration date.
+     */
     expirationDate: Date;
+    /**
+     * Temporary data id.
+     */
     id: string;
+    /**
+     * Rest url for the temporary data.
+     */
     url: string;
 }
 /**
  * A data transfer object that stores the metadata associated with the temporary data.
  */
 export interface TemporaryDataDTO {
+    /**
+     * Temporary data expire in seconds
+     */
     expirationSeconds: number;
+    /**
+     * Temporary data origin
+     */
     origin: string;
+    /**
+     * Temporary data.
+     */
     value: any;
 }
 /**

package/Dashboard/Dashboard.d.ts

@@ -152,6 +152,9 @@ export declare enum DashboardScope {
      */
     Project = 2
 }
+/**
+ * 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.
+ */
 export declare enum GroupMemberPermission {
     None = 0,
     Edit = 1,
@@ -192,6 +195,9 @@ export interface SemanticVersion {
      */
     patch: number;
 }
+/**
+ * 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.
+ */
 export declare enum TeamDashboardPermission {
     None = 0,
     Read = 1,

package/Dashboard/Dashboard.js

@@ -24,6 +24,9 @@ define(["require", "exports"], function (require, exports) {
          */
         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";
@@ -31,6 +34,9 @@ define(["require", "exports"], function (require, exports) {
         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";

package/ExtensionManagement/ExtensionManagementClient.d.ts

@@ -6,12 +6,14 @@ export declare class ExtensionManagementRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
     static readonly RESOURCE_AREA_ID: string;
     /**
-     * @param itemId -
-     * @param testCommerce -
-     * @param isFreeOrTrialInstall -
-     * @param isAccountOwner -
-     * @param isLinked -
-     * @param isConnectedServer -
+     * This API is called by acquisition/install page to get possible user actions like Buy/Request
+     *
+     * @param itemId - Fully qualified name of extension (\<publisher_id\>.\<extension_id\>)
+     * @param testCommerce - Parameter to test paid preview extension without making azure plans public
+     * @param isFreeOrTrialInstall - Parameter represents install or trial workflow (required for legacy install flows)
+     * @param isAccountOwner - Parameter represents whether user is owner or PCA of an account
+     * @param isLinked - Parameter represents whether account is linked with a subscription
+     * @param isConnectedServer - Parameter represents whether Buy operation should be evaluated
      * @param isBuyOperationValid -
      */
     getAcquisitionOptions(itemId: string, testCommerce?: boolean, isFreeOrTrialInstall?: boolean, isAccountOwner?: boolean, isLinked?: boolean, isConnectedServer?: boolean, isBuyOperationValid?: boolean): Promise<ExtensionManagement.AcquisitionOptions>;

package/ExtensionManagement/ExtensionManagementClient.js

@@ -57,12 +57,14 @@ define(["require", "exports", "../Common/RestClientBase"], function (require, ex
             return _super.call(this, options) || this;
         }
         /**
-         * @param itemId -
-         * @param testCommerce -
-         * @param isFreeOrTrialInstall -
-         * @param isAccountOwner -
-         * @param isLinked -
-         * @param isConnectedServer -
+         * This API is called by acquisition/install page to get possible user actions like Buy/Request
+         *
+         * @param itemId - Fully qualified name of extension (\<publisher_id\>.\<extension_id\>)
+         * @param testCommerce - Parameter to test paid preview extension without making azure plans public
+         * @param isFreeOrTrialInstall - Parameter represents install or trial workflow (required for legacy install flows)
+         * @param isAccountOwner - Parameter represents whether user is owner or PCA of an account
+         * @param isLinked - Parameter represents whether account is linked with a subscription
+         * @param isConnectedServer - Parameter represents whether Buy operation should be evaluated
          * @param isBuyOperationValid -
          */
         ExtensionManagementRestClient.prototype.getAcquisitionOptions = function (itemId, testCommerce, isFreeOrTrialInstall, isAccountOwner, isLinked, isConnectedServer, isBuyOperationValid) {