azure-devops-extension-api 4.236.0 → 4.237.0

package/Alert/Alert.d.ts

@@ -44,6 +44,10 @@ export interface Alert {
      * This value is computed and returned by the service. It is a value based on the results from all analysis configurations. An example of a physical location is a file location.
      */
     physicalLocations: PhysicalLocation[];
+    /**
+     * Relations between alerts and other artifacts.
+     */
+    relations: RelationMetadata[];
     /**
      * Repository URL where the alert was detected.
      */
@@ -177,6 +181,12 @@ export interface AnalysisConfiguration {
     toolVersion: string;
 }
 export interface AnalysisConfigurationDetails {
+    /**
+     * Properties of the pipeline.
+     */
+    additionalProperties: {
+        [key: string]: any;
+    };
     /**
      * Reference to a git object, e.g. branch ref.
      */
@@ -478,8 +488,18 @@ export declare enum MetadataChangeType {
  * The operation to be performed on the metadata.
  */
 export declare enum MetadataOperation {
-    Add = 0,
-    Remove = 1
+    /**
+     * Represents the defualt value if the operation is not specified or not supported.
+     */
+    None = 0,
+    /**
+     * Represents the addition of the metadata.
+     */
+    Add = 1,
+    /**
+     * Represents the removal of the metadata.
+     */
+    Remove = 2
 }
 /**
  * Location in the source control system where the issue was found
@@ -503,6 +523,9 @@ export interface Pipeline {
     name: string;
     phase: string;
     phaseId: string;
+    properties: {
+        [key: string]: any;
+    };
 }
 export interface Region {
     /**

package/Alert/Alert.js

@@ -160,8 +160,18 @@ define(["require", "exports"], function (require, exports) {
      */
     var MetadataOperation;
     (function (MetadataOperation) {
-        MetadataOperation[MetadataOperation["Add"] = 0] = "Add";
-        MetadataOperation[MetadataOperation["Remove"] = 1] = "Remove";
+        /**
+         * Represents the defualt value if the operation is not specified or not supported.
+         */
+        MetadataOperation[MetadataOperation["None"] = 0] = "None";
+        /**
+         * Represents the addition of the metadata.
+         */
+        MetadataOperation[MetadataOperation["Add"] = 1] = "Add";
+        /**
+         * Represents the removal of the metadata.
+         */
+        MetadataOperation[MetadataOperation["Remove"] = 2] = "Remove";
     })(MetadataOperation = exports.MetadataOperation || (exports.MetadataOperation = {}));
     /**
      * This enum defines the different result types.

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.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={}))});
+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.None=0]="None",e[e.Add=1]="Add",e[e.Remove=2]="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/Git/GitClient.d.ts

@@ -357,6 +357,74 @@ export declare class GitRestClient extends RestClientBase {
      * @param includeLinks - True to include links.
      */
     getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<Git.GitForkSyncRequest[]>;
+    /**
+     * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+     *
+     * @param repositoryId - The name or ID of the repository.
+     * @param path - The item path.
+     * @param project - Project ID or project name
+     * @param scopePath - The path scope.  The default is null.
+     * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+     * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+     * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+     * @param download - Set to true to download the response as a file.  Default is false.
+     * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+     * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+     * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+     */
+    getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<Git.GitItem>;
+    /**
+     * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+     *
+     * @param repositoryId - The name or ID of the repository.
+     * @param path - The item path.
+     * @param project - Project ID or project name
+     * @param scopePath - The path scope.  The default is null.
+     * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+     * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+     * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+     * @param download - Set to true to download the response as a file.  Default is false.
+     * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+     * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+     * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+     */
+    getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>;
+    /**
+     * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+     *
+     * @param repositoryId - The name or ID of the repository.
+     * @param path - The item path.
+     * @param project - Project ID or project name
+     * @param scopePath - The path scope.  The default is null.
+     * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+     * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+     * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+     * @param download - Set to true to download the response as a file.  Default is false.
+     * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+     * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+     * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+     */
+    getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>;
+    /**
+     * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+     *
+     * @param repositoryId - The name or ID of the repository.
+     * @param path - The item path.
+     * @param project - Project ID or project name
+     * @param scopePath - The path scope.  The default is null.
+     * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+     * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+     * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+     * @param download - Set to true to download the response as a file.  Default is false.
+     * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+     * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+     * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+     * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+     */
+    getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: Git.VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: Git.GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>;
     /**
      * Create an import request.
      *

package/Git/GitClient.js

@@ -1149,6 +1149,185 @@ define(["require", "exports", "../Common/RestClientBase", "../Common/Util/Serial
                 });
             });
         };
+        /**
+         * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+         *
+         * @param repositoryId - The name or ID of the repository.
+         * @param path - The item path.
+         * @param project - Project ID or project name
+         * @param scopePath - The path scope.  The default is null.
+         * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+         * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+         * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+         * @param download - Set to true to download the response as a file.  Default is false.
+         * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+         * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+         * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+         * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+         */
+        GitRestClient.prototype.getHfsItem = function (repositoryId, path, project, scopePath, recursionLevel, includeContentMetadata, latestProcessedChange, download, versionDescriptor, includeContent, resolveHfs, sanitize) {
+            return __awaiter(this, void 0, void 0, function () {
+                var queryValues;
+                return __generator(this, function (_a) {
+                    queryValues = {
+                        path: path,
+                        scopePath: scopePath,
+                        recursionLevel: recursionLevel,
+                        includeContentMetadata: includeContentMetadata,
+                        latestProcessedChange: latestProcessedChange,
+                        download: download,
+                        versionDescriptor: versionDescriptor,
+                        includeContent: includeContent,
+                        resolveHfs: resolveHfs,
+                        sanitize: sanitize
+                    };
+                    return [2 /*return*/, this.beginRequest({
+                            apiVersion: "7.2-preview.1",
+                            routeTemplate: "{project}/_apis/git/repositories/{repositoryId}/HfsItems/{*path}",
+                            routeValues: {
+                                project: project,
+                                repositoryId: repositoryId
+                            },
+                            queryParams: queryValues
+                        })];
+                });
+            });
+        };
+        /**
+         * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+         *
+         * @param repositoryId - The name or ID of the repository.
+         * @param path - The item path.
+         * @param project - Project ID or project name
+         * @param scopePath - The path scope.  The default is null.
+         * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+         * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+         * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+         * @param download - Set to true to download the response as a file.  Default is false.
+         * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+         * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+         * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+         * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+         */
+        GitRestClient.prototype.getHfsItemContent = function (repositoryId, path, project, scopePath, recursionLevel, includeContentMetadata, latestProcessedChange, download, versionDescriptor, includeContent, resolveHfs, sanitize) {
+            return __awaiter(this, void 0, void 0, function () {
+                var queryValues;
+                return __generator(this, function (_a) {
+                    queryValues = {
+                        path: path,
+                        scopePath: scopePath,
+                        recursionLevel: recursionLevel,
+                        includeContentMetadata: includeContentMetadata,
+                        latestProcessedChange: latestProcessedChange,
+                        download: download,
+                        versionDescriptor: versionDescriptor,
+                        includeContent: includeContent,
+                        resolveHfs: resolveHfs,
+                        sanitize: sanitize
+                    };
+                    return [2 /*return*/, this.beginRequest({
+                            apiVersion: "7.2-preview.1",
+                            httpResponseType: "application/octet-stream",
+                            routeTemplate: "{project}/_apis/git/repositories/{repositoryId}/HfsItems/{*path}",
+                            routeValues: {
+                                project: project,
+                                repositoryId: repositoryId
+                            },
+                            queryParams: queryValues
+                        })];
+                });
+            });
+        };
+        /**
+         * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+         *
+         * @param repositoryId - The name or ID of the repository.
+         * @param path - The item path.
+         * @param project - Project ID or project name
+         * @param scopePath - The path scope.  The default is null.
+         * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+         * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+         * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+         * @param download - Set to true to download the response as a file.  Default is false.
+         * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+         * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+         * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+         * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+         */
+        GitRestClient.prototype.getHfsItemText = function (repositoryId, path, project, scopePath, recursionLevel, includeContentMetadata, latestProcessedChange, download, versionDescriptor, includeContent, resolveHfs, sanitize) {
+            return __awaiter(this, void 0, void 0, function () {
+                var queryValues;
+                return __generator(this, function (_a) {
+                    queryValues = {
+                        path: path,
+                        scopePath: scopePath,
+                        recursionLevel: recursionLevel,
+                        includeContentMetadata: includeContentMetadata,
+                        latestProcessedChange: latestProcessedChange,
+                        download: download,
+                        versionDescriptor: versionDescriptor,
+                        includeContent: includeContent,
+                        resolveHfs: resolveHfs,
+                        sanitize: sanitize
+                    };
+                    return [2 /*return*/, this.beginRequest({
+                            apiVersion: "7.2-preview.1",
+                            httpResponseType: "text/plain",
+                            routeTemplate: "{project}/_apis/git/repositories/{repositoryId}/HfsItems/{*path}",
+                            routeValues: {
+                                project: project,
+                                repositoryId: repositoryId
+                            },
+                            queryParams: queryValues
+                        })];
+                });
+            });
+        };
+        /**
+         * Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.
+         *
+         * @param repositoryId - The name or ID of the repository.
+         * @param path - The item path.
+         * @param project - Project ID or project name
+         * @param scopePath - The path scope.  The default is null.
+         * @param recursionLevel - The recursion level of this request. The default is 'none', no recursion.
+         * @param includeContentMetadata - Set to true to include content metadata.  Default is false.
+         * @param latestProcessedChange - Set to true to include the latest changes.  Default is false.
+         * @param download - Set to true to download the response as a file.  Default is false.
+         * @param versionDescriptor - Version descriptor.  Default is the default branch for the repository.
+         * @param includeContent - Set to true to include item content when requesting json.  Default is false.
+         * @param resolveHfs - Set to true to resolve Git HFS pointer files to return actual content from Git HFS.  Default is true.
+         * @param sanitize - Set to true to sanitize an svg file and return it as image. Useful only if requested for svg file. Default is false.
+         */
+        GitRestClient.prototype.getHfsItemZip = function (repositoryId, path, project, scopePath, recursionLevel, includeContentMetadata, latestProcessedChange, download, versionDescriptor, includeContent, resolveHfs, sanitize) {
+            return __awaiter(this, void 0, void 0, function () {
+                var queryValues;
+                return __generator(this, function (_a) {
+                    queryValues = {
+                        path: path,
+                        scopePath: scopePath,
+                        recursionLevel: recursionLevel,
+                        includeContentMetadata: includeContentMetadata,
+                        latestProcessedChange: latestProcessedChange,
+                        download: download,
+                        versionDescriptor: versionDescriptor,
+                        includeContent: includeContent,
+                        resolveHfs: resolveHfs,
+                        sanitize: sanitize
+                    };
+                    return [2 /*return*/, this.beginRequest({
+                            apiVersion: "7.2-preview.1",
+                            httpResponseType: "application/zip",
+                            routeTemplate: "{project}/_apis/git/repositories/{repositoryId}/HfsItems/{*path}",
+                            routeValues: {
+                                project: project,
+                                repositoryId: repositoryId
+                            },
+                            queryParams: queryValues
+                        })];
+                });
+            });
+        };
         /**
          * Create an import request.
          *