azure-devops-extension-api 4.265.0 → 4.268.0

package/AdvancedSecurity.Reporting/Reporting.d.ts

@@ -1,3 +1,62 @@
+/**
+ * Represents an advanced filter configuration for the Reporting dashboard.
+ */
+export interface AdvancedFilter extends AdvancedFilterCreate {
+    /**
+     * Link references to related REST resources.
+     */
+    _links: any;
+    /**
+     * The identity of the user who last changed the advanced filter.
+     */
+    changedBy: string;
+    /**
+     * The date and time when the advanced filter was last changed.
+     */
+    changedDate: Date;
+    /**
+     * The identity of the user who created the advanced filter.
+     */
+    createdBy: string;
+    /**
+     * The date and time when the advanced filter was created.
+     */
+    createdDate: Date;
+    /**
+     * Unique identifier for the advanced filter.
+     */
+    id: string;
+    /**
+     * Indicates whether the advanced filter has been soft-deleted.
+     */
+    isDeleted: boolean;
+    /**
+     * The URL of the advanced filter.
+     */
+    url: string;
+}
+/**
+ * Represents the data required to create an advanced filter configuration for the Reporting dashboard. Also serves as the base class for AdvancedFilter.
+ */
+export interface AdvancedFilterCreate {
+    /**
+     * The filter criteria to be applied when this advanced filter is selected.
+     */
+    filterCriteria: CombinedAlertFilterCriteria;
+    /**
+     * User-provided name for the advanced filter.
+     */
+    name: string;
+}
+/**
+ * Represents the data required to update an advanced filter configuration. Only the name can be updated.
+ */
+export interface AdvancedFilterUpdate {
+    /**
+     * The new name for the advanced filter.
+     */
+    name: string;
+}
 /**
  * Alert Summary by severity.
  */
@@ -62,6 +121,264 @@ export declare enum AlertType {
      */
     License = 4
 }
+export declare enum AlertValidityStatus {
+    /**
+     * When there are no validation fingerprints attached to the alert.
+     */
+    None = 0,
+    /**
+     * When the validations for validation fingerprints associated to the alert have not been conclusive.
+     */
+    Unknown = 1,
+    /**
+     * When at least one validation fingerprint associated to the alert is exploitable.
+     */
+    Active = 2,
+    /**
+     * When all validation fingerprints associated to the alert are not exploitable.
+     */
+    Inactive = 3
+}
+export interface CombinedAlertFilterCriteria {
+    /**
+     * If provided, only return alerts of the specified alert type.
+     */
+    alertType: AlertType;
+    /**
+     * If provided, only return alerts with the specified validity status.
+     */
+    alertValidityStatus: AlertValidityStatus;
+    /**
+     * If provided, only return dependency alerts for the specified package name.
+     */
+    componentName: string;
+    /**
+     * If provided, only return dependency alerts for the specified ecosystem (e.g., NuGet, Npm, Maven).
+     */
+    componentType: ComponentType;
+    /**
+     * If provided, only return alerts with the specified dismissal type (closure reason). Applicable only when filtering for closed/dismissed alerts.
+     */
+    dismissalTypes: DismissalType[];
+    /**
+     * If provided, only return alerts fixed on or before this date.
+     */
+    fixedDateEnd: Date;
+    /**
+     * If provided, only return alerts fixed on or after this date.
+     */
+    fixedDateStart: Date;
+    /**
+     * If provided, only return alerts introduced on or before this date.
+     */
+    introducedDateEnd: Date;
+    /**
+     * If provided, only return alerts introduced on or after this date.
+     */
+    introducedDateStart: Date;
+    /**
+     * If provided, only return alerts whose titles match this pattern.
+     */
+    keywords: string;
+    /**
+     * If provided, only return alerts for projects whose names are in this list.
+     */
+    projects: string[];
+    /**
+     * If provided, only return alerts for repositories whose names are in this list.
+     */
+    repositories: string[];
+    /**
+     * If provided, only return code scanning alerts or secret alerts matching the specified rule name.
+     */
+    ruleName: string;
+    /**
+     * If provided, only return secret alerts matching the specified secret type (rule friendly name or opaque ID).
+     */
+    secretType: string;
+    /**
+     * If provided, only return alerts with the specified severities. Otherwise, return alerts at any severity.
+     */
+    severities: Severity[];
+    /**
+     * If provided, return alerts that are active or inactive based on this value. \<br /\>Otherwise, return alerts in any state.
+     */
+    state: DashboardAlertState;
+    /**
+     * If provided, only return code scanning alerts detected by the specified tool.
+     */
+    toolName: string;
+}
+/**
+ * This enum defines the dependency components.
+ */
+export declare enum ComponentType {
+    Unknown = 0,
+    NuGet = 1,
+    /**
+     * Indicates the component is an Npm package.
+     */
+    Npm = 2,
+    /**
+     * Indicates the component is a Maven artifact.
+     */
+    Maven = 3,
+    /**
+     * Indicates the component is a Git repository.
+     */
+    Git = 4,
+    /**
+     * Indicates the component is not any of the supported component types by Governance.
+     */
+    Other = 5,
+    /**
+     * Indicates the component is a Ruby gem.
+     */
+    RubyGems = 6,
+    /**
+     * Indicates the component is a Cargo package.
+     */
+    Cargo = 7,
+    /**
+     * Indicates the component is a Pip package.
+     */
+    Pip = 8,
+    /**
+     * 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
+     */
+    DockerImage = 11,
+    /**
+     * Indicates the component is a CocoaPods pod.
+     */
+    Pod = 12,
+    /**
+     * Indicates the component is found in a linux environment. A package understood by linux based package managers like apt and rpm.
+     */
+    Linux = 13,
+    /**
+     * Indicates the component is a Conda package.
+     */
+    Conda = 14,
+    /**
+     * Indicates the component is a Docker Reference.
+     */
+    DockerReference = 15,
+    /**
+     * Indicates the component is a Vcpkg Package.
+     */
+    Vcpkg = 16
+}
+/**
+ * An alert entity used in the dashboard for combined alerts.
+ */
+export interface DashboardAlert {
+    /**
+     * Identifier for the alert. It is unique within Azure DevOps organization.
+     */
+    alertId: number;
+    /**
+     * Type of the alert. E.g. secret, code, etc.
+     */
+    alertType: AlertType;
+    /**
+     * This value is computed and returned by the service. This value represents the first time the vulnerability was introduced.
+     */
+    introducedDate: Date;
+    /**
+     * 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.
+     */
+    locations: DashboardAlertPhysicalLocation[];
+    /**
+     * Name of the project where the alert was detected.
+     */
+    projectName: string;
+    /**
+     * Name of the repository where the alert was detected.
+     */
+    repositoryName: string;
+    /**
+     * Severity of the alert.
+     */
+    severity: Severity;
+    /**
+     * This value is computed and returned by the service. It is a value based on the results from all analysis configurations.
+     */
+    state: State;
+    /**
+     * Title will only be rendered as text and does not support markdown formatting. There is a maximum character limit of 256.
+     */
+    title: string;
+    /**
+     * A truncated/obfuscated version of the secret pertaining to the alert (if applicable).
+     */
+    truncatedSecret: string;
+    /**
+     * Validity status of an alert. Currently, this is only applicable to secret alerts. In case of secret alerts, the validity status is computed by looking at the liveness results for validation fingerprints associated to an alert.
+     */
+    validityStatus: AlertValidityStatus;
+}
+/**
+ * Location in the source control system where the issue was found
+ */
+export interface DashboardAlertPhysicalLocation {
+    alertId: number;
+    /**
+     * Path of the file where the issue was found
+     */
+    filePath: string;
+    /**
+     * Details about the location where the issue was found including a snippet
+     */
+    region: Region;
+}
+export declare enum DashboardAlertState {
+    /**
+     * Alert has been detected in the code and corresponds to 'Active' state.
+     */
+    Open = 0,
+    /**
+     * Alert corresponds to 'Unknown', 'Dismissed', 'Fixed' or 'AutoDismissed' states.
+     */
+    Closed = 1
+}
+export declare enum DismissalType {
+    /**
+     * Dismissal type unknown
+     */
+    Unknown = 0,
+    /**
+     * Dismissal indicating alert has been fixed
+     */
+    Fixed = 1,
+    /**
+     * Dismissal indicating user is accepting a risk for the alert
+     */
+    AcceptedRisk = 2,
+    /**
+     * Dismissal indicating alert is a false positive and will likely not be fixed.
+     */
+    FalsePositive = 3,
+    /**
+     * Dismissal indicating user is agreeing to follow license guidance.
+     */
+    AgreedToGuidance = 4,
+    /**
+     * Dismissal indicating backend detection tool was upgraded and the alert is not detected by the new version of tool.
+     */
+    ToolUpgrade = 5,
+    /**
+     * Dismissal indicating the affected dependencency is not distributed to end users.
+     */
+    NotDistributed = 6
+}
 export interface EnablementFilterCriteria {
     /**
      * If provided, only return repos whose titles match this pattern.
@@ -192,6 +509,24 @@ export interface ProjectEnablementSummary {
      */
     repos: RepoEnablementSummary[];
 }
+export interface Region {
+    /**
+     * The column where the code snippet ends
+     */
+    columnEnd: number;
+    /**
+     * The column where the code snippet starts
+     */
+    columnStart: number;
+    /**
+     * The line number where the code snippet ends
+     */
+    lineEnd: number;
+    /**
+     * The line number where the code snippet starts
+     */
+    lineStart: number;
+}
 /**
  * Repo Alert Summary.
  */
@@ -241,6 +576,12 @@ export interface RepoEnablementSummary {
      * Repo Name.
      */
     repoName: string;
+    /**
+     * Repo scan type metadata for different scan types.
+     */
+    scanTypeMetadata: {
+        [key: number]: ScanTypeSummaryMetadata;
+    };
     /**
      * Repo enablement summary for different scan types.
      */
@@ -258,6 +599,15 @@ export interface ReportingUXComputedFilters {
      */
     projects: Project[];
 }
+/**
+ * Metadata for a scan type.
+ */
+export interface ScanTypeSummaryMetadata {
+    /**
+     * The date and time of the last scan for the associated alert type/repo combination. Null if no scan has been performed.
+     */
+    lastScanDate: Date;
+}
 export interface ScanTypeSummaryProperties {
     /**
      * True if alerts are enabled for the associated alert type/repo combination, false if disabled.
@@ -288,6 +638,28 @@ export declare enum Severity {
     Error = 6,
     Undefined = 7
 }
+export declare enum State {
+    /**
+     * Alert is in an indeterminate state
+     */
+    Unknown = 0,
+    /**
+     * Alert has been detected in the code
+     */
+    Active = 1,
+    /**
+     * Alert was dismissed by a user
+     */
+    Dismissed = 2,
+    /**
+     * The issue is no longer detected in the code
+     */
+    Fixed = 4,
+    /**
+     * The tool has determined that the issue is no longer a risk
+     */
+    AutoDismissed = 8
+}
 export declare enum TimePeriod {
     Undefined = 0,
     Last24Hours = 5,

package/AdvancedSecurity.Reporting/Reporting.js

@@ -29,6 +29,135 @@ define(["require", "exports"], function (require, exports) {
          */
         AlertType[AlertType["License"] = 4] = "License";
     })(AlertType = exports.AlertType || (exports.AlertType = {}));
+    var AlertValidityStatus;
+    (function (AlertValidityStatus) {
+        /**
+         * When there are no validation fingerprints attached to the alert.
+         */
+        AlertValidityStatus[AlertValidityStatus["None"] = 0] = "None";
+        /**
+         * When the validations for validation fingerprints associated to the alert have not been conclusive.
+         */
+        AlertValidityStatus[AlertValidityStatus["Unknown"] = 1] = "Unknown";
+        /**
+         * When at least one validation fingerprint associated to the alert is exploitable.
+         */
+        AlertValidityStatus[AlertValidityStatus["Active"] = 2] = "Active";
+        /**
+         * When all validation fingerprints associated to the alert are not exploitable.
+         */
+        AlertValidityStatus[AlertValidityStatus["Inactive"] = 3] = "Inactive";
+    })(AlertValidityStatus = exports.AlertValidityStatus || (exports.AlertValidityStatus = {}));
+    /**
+     * This enum defines the dependency components.
+     */
+    var ComponentType;
+    (function (ComponentType) {
+        ComponentType[ComponentType["Unknown"] = 0] = "Unknown";
+        ComponentType[ComponentType["NuGet"] = 1] = "NuGet";
+        /**
+         * Indicates the component is an Npm package.
+         */
+        ComponentType[ComponentType["Npm"] = 2] = "Npm";
+        /**
+         * Indicates the component is a Maven artifact.
+         */
+        ComponentType[ComponentType["Maven"] = 3] = "Maven";
+        /**
+         * Indicates the component is a Git repository.
+         */
+        ComponentType[ComponentType["Git"] = 4] = "Git";
+        /**
+         * Indicates the component is not any of the supported component types by Governance.
+         */
+        ComponentType[ComponentType["Other"] = 5] = "Other";
+        /**
+         * Indicates the component is a Ruby gem.
+         */
+        ComponentType[ComponentType["RubyGems"] = 6] = "RubyGems";
+        /**
+         * Indicates the component is a Cargo package.
+         */
+        ComponentType[ComponentType["Cargo"] = 7] = "Cargo";
+        /**
+         * Indicates the component is a Pip package.
+         */
+        ComponentType[ComponentType["Pip"] = 8] = "Pip";
+        /**
+         * 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
+         */
+        ComponentType[ComponentType["DockerImage"] = 11] = "DockerImage";
+        /**
+         * Indicates the component is a CocoaPods pod.
+         */
+        ComponentType[ComponentType["Pod"] = 12] = "Pod";
+        /**
+         * Indicates the component is found in a linux environment. A package understood by linux based package managers like apt and rpm.
+         */
+        ComponentType[ComponentType["Linux"] = 13] = "Linux";
+        /**
+         * Indicates the component is a Conda package.
+         */
+        ComponentType[ComponentType["Conda"] = 14] = "Conda";
+        /**
+         * Indicates the component is a Docker Reference.
+         */
+        ComponentType[ComponentType["DockerReference"] = 15] = "DockerReference";
+        /**
+         * Indicates the component is a Vcpkg Package.
+         */
+        ComponentType[ComponentType["Vcpkg"] = 16] = "Vcpkg";
+    })(ComponentType = exports.ComponentType || (exports.ComponentType = {}));
+    var DashboardAlertState;
+    (function (DashboardAlertState) {
+        /**
+         * Alert has been detected in the code and corresponds to 'Active' state.
+         */
+        DashboardAlertState[DashboardAlertState["Open"] = 0] = "Open";
+        /**
+         * Alert corresponds to 'Unknown', 'Dismissed', 'Fixed' or 'AutoDismissed' states.
+         */
+        DashboardAlertState[DashboardAlertState["Closed"] = 1] = "Closed";
+    })(DashboardAlertState = exports.DashboardAlertState || (exports.DashboardAlertState = {}));
+    var DismissalType;
+    (function (DismissalType) {
+        /**
+         * Dismissal type unknown
+         */
+        DismissalType[DismissalType["Unknown"] = 0] = "Unknown";
+        /**
+         * Dismissal indicating alert has been fixed
+         */
+        DismissalType[DismissalType["Fixed"] = 1] = "Fixed";
+        /**
+         * Dismissal indicating user is accepting a risk for the alert
+         */
+        DismissalType[DismissalType["AcceptedRisk"] = 2] = "AcceptedRisk";
+        /**
+         * Dismissal indicating alert is a false positive and will likely not be fixed.
+         */
+        DismissalType[DismissalType["FalsePositive"] = 3] = "FalsePositive";
+        /**
+         * Dismissal indicating user is agreeing to follow license guidance.
+         */
+        DismissalType[DismissalType["AgreedToGuidance"] = 4] = "AgreedToGuidance";
+        /**
+         * Dismissal indicating backend detection tool was upgraded and the alert is not detected by the new version of tool.
+         */
+        DismissalType[DismissalType["ToolUpgrade"] = 5] = "ToolUpgrade";
+        /**
+         * Dismissal indicating the affected dependencency is not distributed to end users.
+         */
+        DismissalType[DismissalType["NotDistributed"] = 6] = "NotDistributed";
+    })(DismissalType = exports.DismissalType || (exports.DismissalType = {}));
     var Severity;
     (function (Severity) {
         Severity[Severity["Low"] = 0] = "Low";
@@ -40,6 +169,29 @@ define(["require", "exports"], function (require, exports) {
         Severity[Severity["Error"] = 6] = "Error";
         Severity[Severity["Undefined"] = 7] = "Undefined";
     })(Severity = exports.Severity || (exports.Severity = {}));
+    var State;
+    (function (State) {
+        /**
+         * Alert is in an indeterminate state
+         */
+        State[State["Unknown"] = 0] = "Unknown";
+        /**
+         * Alert has been detected in the code
+         */
+        State[State["Active"] = 1] = "Active";
+        /**
+         * Alert was dismissed by a user
+         */
+        State[State["Dismissed"] = 2] = "Dismissed";
+        /**
+         * The issue is no longer detected in the code
+         */
+        State[State["Fixed"] = 4] = "Fixed";
+        /**
+         * The tool has determined that the issue is no longer a risk
+         */
+        State[State["AutoDismissed"] = 8] = "AutoDismissed";
+    })(State = exports.State || (exports.State = {}));
     var TimePeriod;
     (function (TimePeriod) {
         TimePeriod[TimePeriod["Undefined"] = 0] = "Undefined";

package/AdvancedSecurity.Reporting/Reporting.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",e[e.License=4]="License"}(n.AlertType||(n.AlertType={}));!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",e[e.Undefined=7]="Undefined"}(n.Severity||(n.Severity={}));!function(e){e[e.Undefined=0]="Undefined",e[e.Last24Hours=5]="Last24Hours",e[e.Last7Days=6]="Last7Days",e[e.Last14Days=7]="Last14Days",e[e.Last30Days=8]="Last30Days",e[e.Last90Days=9]="Last90Days"}(n.TimePeriod||(n.TimePeriod={}))});
+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",e[e.License=4]="License"}(n.AlertType||(n.AlertType={}));!function(e){e[e.None=0]="None",e[e.Unknown=1]="Unknown",e[e.Active=2]="Active",e[e.Inactive=3]="Inactive"}(n.AlertValidityStatus||(n.AlertValidityStatus={}));!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.Open=0]="Open",e[e.Closed=1]="Closed"}(n.DashboardAlertState||(n.DashboardAlertState={}));!function(e){e[e.Unknown=0]="Unknown",e[e.Fixed=1]="Fixed",e[e.AcceptedRisk=2]="AcceptedRisk",e[e.FalsePositive=3]="FalsePositive",e[e.AgreedToGuidance=4]="AgreedToGuidance",e[e.ToolUpgrade=5]="ToolUpgrade",e[e.NotDistributed=6]="NotDistributed"}(n.DismissalType||(n.DismissalType={}));!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",e[e.Undefined=7]="Undefined"}(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={}));!function(e){e[e.Undefined=0]="Undefined",e[e.Last24Hours=5]="Last24Hours",e[e.Last7Days=6]="Last7Days",e[e.Last14Days=7]="Last14Days",e[e.Last30Days=8]="Last30Days",e[e.Last90Days=9]="Last90Days"}(n.TimePeriod||(n.TimePeriod={}))});

package/AdvancedSecurity.Reporting/ReportingClient.d.ts

@@ -1,19 +1,61 @@
 import { IVssRestClientOptions } from "../Common/Context";
 import { RestClientBase } from "../Common/RestClientBase";
 import * as Reporting from "../AdvancedSecurity.Reporting/Reporting";
+import * as WebApi from "../WebApi/WebApi";
 export declare class ReportingRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
+    /**
+     * Creates a new advanced filter for the organization.
+     *
+     * @param filter - The advanced filter to create.
+     */
+    createAdvancedFilter(filter: Reporting.AdvancedFilterCreate): Promise<Reporting.AdvancedFilter>;
+    /**
+     * Deletes an advanced filter.
+     *
+     * @param filterId - The ID of the advanced filter to delete.
+     */
+    deleteAdvancedFilter(filterId: string): Promise<void>;
+    /**
+     * Gets a specific advanced filter by its ID.
+     *
+     * @param filterId - The ID of the advanced filter to retrieve.
+     */
+    getAdvancedFilter(filterId: string): Promise<Reporting.AdvancedFilter>;
+    /**
+     * Gets all advanced filters for the organization.
+     *
+     * @param includeDeleted - Whether to include soft-deleted filters.
+     */
+    listAdvancedFilters(includeDeleted?: boolean): Promise<Reporting.AdvancedFilter[]>;
+    /**
+     * Updates an advanced filter. Only the name can be updated.
+     *
+     * @param filter - The update data containing the new name.
+     * @param filterId - The ID of the advanced filter to update.
+     */
+    updateAdvancedFilter(filter: Reporting.AdvancedFilterUpdate, filterId: string): Promise<void>;
     /**
      */
     getUXComputedFilters(): Promise<Reporting.ReportingUXComputedFilters>;
     /**
      * Get Alert summary by severity for the org
      *
-     * @param criteria -
+     * @param criteria - Options to limit the summaries returned
      */
     getAlertSummaryForOrg(criteria?: Reporting.FilterCriteria): Promise<Reporting.OrgAlertSummary>;
     /**
-     * @param criteria -
+     * Get Combined Alerts for the org
+     *
+     * @param criteria - Options to filter the combined alerts returned
+     * @param top - The maximum number of alerts to return
+     * @param continuationToken - If there are more alerts than can be returned, a continuation token is placed in the "x-ms-continuationtoken" header.  Use that token here to get the next page of alerts
+     */
+    getCombinedAlertsForOrg(criteria?: Reporting.CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<WebApi.PagedList<Reporting.DashboardAlert>>;
+    /**
+     * Get Enablement summary for the org
+     *
+     * @param criteria - Options to limit the summaries returned
      */
     getEnablementSummaryForOrg(criteria?: Reporting.EnablementFilterCriteria): Promise<Reporting.OrgEnablementSummary>;
 }