azure-devops-extension-api 4.245.1 → 4.247.0

package/src/Policy/Policy.ts

@@ -0,0 +1,173 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+
+import * as WebApi from "../WebApi/WebApi";
+
+/**
+ * The full policy configuration with settings.
+ */
+export interface PolicyConfiguration extends VersionedPolicyConfigurationRef {
+    /**
+     * The links to other objects related to this object.
+     */
+    _links: any;
+    /**
+     * A reference to the identity that created the policy.
+     */
+    createdBy: WebApi.IdentityRef;
+    /**
+     * The date and time when the policy was created.
+     */
+    createdDate: Date;
+    /**
+     * Indicates whether the policy is blocking.
+     */
+    isBlocking: boolean;
+    /**
+     * Indicates whether the policy has been (soft) deleted.
+     */
+    isDeleted: boolean;
+    /**
+     * Indicates whether the policy is enabled.
+     */
+    isEnabled: boolean;
+    /**
+     * If set, this policy requires "Manage Enterprise Policies" permission to create, edit, or delete.
+     */
+    isEnterpriseManaged: boolean;
+    /**
+     * The policy configuration settings.
+     */
+    settings: any;
+}
+
+/**
+ * Policy configuration reference.
+ */
+export interface PolicyConfigurationRef {
+    /**
+     * The policy configuration ID.
+     */
+    id: number;
+    /**
+     * The policy configuration type.
+     */
+    type: PolicyTypeRef;
+    /**
+     * The URL where the policy configuration can be retrieved.
+     */
+    url: string;
+}
+
+/**
+ * This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.
+ */
+export interface PolicyEvaluationRecord {
+    /**
+     * Links to other related objects
+     */
+    _links: any;
+    /**
+     * A string which uniquely identifies the target of a policy evaluation.
+     */
+    artifactId: string;
+    /**
+     * Time when this policy finished evaluating on this pull request.
+     */
+    completedDate: Date;
+    /**
+     * Contains all configuration data for the policy which is being evaluated.
+     */
+    configuration: PolicyConfiguration;
+    /**
+     * Internal context data of this policy evaluation.
+     */
+    context: any;
+    /**
+     * Guid which uniquely identifies this evaluation record (one policy running on one pull request).
+     */
+    evaluationId: string;
+    /**
+     * Time when this policy was first evaluated on this pull request.
+     */
+    startedDate: Date;
+    /**
+     * Status of the policy (Running, Approved, Failed, etc.)
+     */
+    status: PolicyEvaluationStatus;
+}
+
+/**
+ * Status of a policy which is running against a specific pull request.
+ */
+export enum PolicyEvaluationStatus {
+    /**
+     * The policy is either queued to run, or is waiting for some event before progressing.
+     */
+    Queued = 0,
+    /**
+     * The policy is currently running.
+     */
+    Running = 1,
+    /**
+     * The policy has been fulfilled for this pull request.
+     */
+    Approved = 2,
+    /**
+     * The policy has rejected this pull request.
+     */
+    Rejected = 3,
+    /**
+     * The policy does not apply to this pull request.
+     */
+    NotApplicable = 4,
+    /**
+     * The policy has encountered an unexpected error.
+     */
+    Broken = 5
+}
+
+/**
+ * User-friendly policy type with description (used for querying policy types).
+ */
+export interface PolicyType extends PolicyTypeRef {
+    /**
+     * The links to other objects related to this object.
+     */
+    _links: any;
+    /**
+     * Detailed description of the policy type.
+     */
+    description: string;
+}
+
+/**
+ * Policy type reference.
+ */
+export interface PolicyTypeRef {
+    /**
+     * Display name of the policy type.
+     */
+    displayName: string;
+    /**
+     * The policy type ID.
+     */
+    id: string;
+    /**
+     * The URL where the policy type can be retrieved.
+     */
+    url: string;
+}
+
+/**
+ * A particular revision for a policy configuration.
+ */
+export interface VersionedPolicyConfigurationRef extends PolicyConfigurationRef {
+    /**
+     * The policy configuration revision ID.
+     */
+    revision: number;
+}

package/src/Policy/PolicyClient.ts

@@ -0,0 +1,315 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+import { deserializeVssJsonObject } from "../Common/Util/Serialization";
+
+import * as Policy from "../Policy/Policy";
+import * as WebApi from "../WebApi/WebApi";
+
+export class PolicyRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions) {
+        super(options);
+    }
+
+    public static readonly RESOURCE_AREA_ID = "fb13a388-40dd-4a04-b530-013a739c72ef";
+
+    /**
+     * Create a policy configuration of a given policy type.
+     * 
+     * @param configuration - The policy configuration to create.
+     * @param project - Project ID or project name
+     */
+    public async createPolicyConfiguration(
+        configuration: Policy.PolicyConfiguration,
+        project: string
+        ): Promise<Policy.PolicyConfiguration> {
+
+        return this.beginRequest<Policy.PolicyConfiguration>({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "{project}/_apis/policy/Configurations/{configurationId}",
+            routeValues: {
+                project: project
+            },
+            body: configuration
+        });
+    }
+
+    /**
+     * Delete a policy configuration by its ID.
+     * 
+     * @param project - Project ID or project name
+     * @param configurationId - ID of the policy configuration to delete.
+     */
+    public async deletePolicyConfiguration(
+        project: string,
+        configurationId: number
+        ): Promise<void> {
+
+        return this.beginRequest<void>({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "{project}/_apis/policy/Configurations/{configurationId}",
+            routeValues: {
+                project: project,
+                configurationId: configurationId
+            }
+        });
+    }
+
+    /**
+     * Get a policy configuration by its ID.
+     * 
+     * @param project - Project ID or project name
+     * @param configurationId - ID of the policy configuration
+     */
+    public async getPolicyConfiguration(
+        project: string,
+        configurationId: number
+        ): Promise<Policy.PolicyConfiguration> {
+
+        return this.beginRequest<Policy.PolicyConfiguration>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/Configurations/{configurationId}",
+            routeValues: {
+                project: project,
+                configurationId: configurationId
+            }
+        });
+    }
+
+    /**
+     * Get a list of policy configurations in a project.
+     * 
+     * @param project - Project ID or project name
+     * @param scope - [Provided for legacy reasons] The scope on which a subset of policies is defined.
+     * @param policyType - Filter returned policies to only this type
+     */
+    public async getPolicyConfigurations(
+        project: string,
+        scope?: string,
+        policyType?: string
+        ): Promise<WebApi.PagedList<Policy.PolicyConfiguration>> {
+
+        const queryValues: any = {
+            scope: scope,
+            policyType: policyType
+        };
+
+        return this.beginRequest<Response>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/Configurations/{configurationId}",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues,
+            returnRawResponse: true
+        }).then(async response => {
+            const body = <WebApi.PagedList<Policy.PolicyConfiguration>>await response.text().then(deserializeVssJsonObject);
+            body.continuationToken = response.headers.get("x-ms-continuationtoken");
+            return body;
+        });
+    }
+
+    /**
+     * Update a policy configuration by its ID.
+     * 
+     * @param configuration - The policy configuration to update.
+     * @param project - Project ID or project name
+     * @param configurationId - ID of the existing policy configuration to be updated.
+     */
+    public async updatePolicyConfiguration(
+        configuration: Policy.PolicyConfiguration,
+        project: string,
+        configurationId: number
+        ): Promise<Policy.PolicyConfiguration> {
+
+        return this.beginRequest<Policy.PolicyConfiguration>({
+            apiVersion: "7.2-preview.1",
+            method: "PUT",
+            routeTemplate: "{project}/_apis/policy/Configurations/{configurationId}",
+            routeValues: {
+                project: project,
+                configurationId: configurationId
+            },
+            body: configuration
+        });
+    }
+
+    /**
+     * Gets the present evaluation state of a policy.
+     * 
+     * @param project - Project ID or project name
+     * @param evaluationId - ID of the policy evaluation to be retrieved.
+     */
+    public async getPolicyEvaluation(
+        project: string,
+        evaluationId: string
+        ): Promise<Policy.PolicyEvaluationRecord> {
+
+        return this.beginRequest<Policy.PolicyEvaluationRecord>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/Evaluations/{evaluationId}",
+            routeValues: {
+                project: project,
+                evaluationId: evaluationId
+            }
+        });
+    }
+
+    /**
+     * Requeue the policy evaluation.
+     * 
+     * @param project - Project ID or project name
+     * @param evaluationId - ID of the policy evaluation to be retrieved.
+     */
+    public async requeuePolicyEvaluation(
+        project: string,
+        evaluationId: string
+        ): Promise<Policy.PolicyEvaluationRecord> {
+
+        return this.beginRequest<Policy.PolicyEvaluationRecord>({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/policy/Evaluations/{evaluationId}",
+            routeValues: {
+                project: project,
+                evaluationId: evaluationId
+            }
+        });
+    }
+
+    /**
+     * Retrieves a list of all the policy evaluation statuses for a specific pull request.
+     * 
+     * @param project - Project ID or project name
+     * @param artifactId - A string which uniquely identifies the target of a policy evaluation.
+     * @param includeNotApplicable - Some policies might determine that they do not apply to a specific pull request. Setting this parameter to true will return evaluation records even for policies which don't apply to this pull request.
+     * @param top - The number of policy evaluation records to retrieve.
+     * @param skip - The number of policy evaluation records to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
+     */
+    public async getPolicyEvaluations(
+        project: string,
+        artifactId: string,
+        includeNotApplicable?: boolean,
+        top?: number,
+        skip?: number
+        ): Promise<Policy.PolicyEvaluationRecord[]> {
+
+        const queryValues: any = {
+            artifactId: artifactId,
+            includeNotApplicable: includeNotApplicable,
+            '$top': top,
+            '$skip': skip
+        };
+
+        return this.beginRequest<Policy.PolicyEvaluationRecord[]>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/Evaluations",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * Retrieve a specific revision of a given policy by ID.
+     * 
+     * @param project - Project ID or project name
+     * @param configurationId - The policy configuration ID.
+     * @param revisionId - The revision ID.
+     */
+    public async getPolicyConfigurationRevision(
+        project: string,
+        configurationId: number,
+        revisionId: number
+        ): Promise<Policy.PolicyConfiguration> {
+
+        return this.beginRequest<Policy.PolicyConfiguration>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/configurations/{configurationId}/Revisions/{revisionId}",
+            routeValues: {
+                project: project,
+                configurationId: configurationId,
+                revisionId: revisionId
+            }
+        });
+    }
+
+    /**
+     * Retrieve all revisions for a given policy.
+     * 
+     * @param project - Project ID or project name
+     * @param configurationId - The policy configuration ID.
+     * @param top - The number of revisions to retrieve.
+     * @param skip - The number of revisions to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.
+     */
+    public async getPolicyConfigurationRevisions(
+        project: string,
+        configurationId: number,
+        top?: number,
+        skip?: number
+        ): Promise<Policy.PolicyConfiguration[]> {
+
+        const queryValues: any = {
+            '$top': top,
+            '$skip': skip
+        };
+
+        return this.beginRequest<Policy.PolicyConfiguration[]>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/configurations/{configurationId}/Revisions/{revisionId}",
+            routeValues: {
+                project: project,
+                configurationId: configurationId
+            },
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * Retrieve a specific policy type by ID.
+     * 
+     * @param project - Project ID or project name
+     * @param typeId - The policy ID.
+     */
+    public async getPolicyType(
+        project: string,
+        typeId: string
+        ): Promise<Policy.PolicyType> {
+
+        return this.beginRequest<Policy.PolicyType>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/Types/{typeId}",
+            routeValues: {
+                project: project,
+                typeId: typeId
+            }
+        });
+    }
+
+    /**
+     * Retrieve all available policy types.
+     * 
+     * @param project - Project ID or project name
+     */
+    public async getPolicyTypes(
+        project: string
+        ): Promise<Policy.PolicyType[]> {
+
+        return this.beginRequest<Policy.PolicyType[]>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "{project}/_apis/policy/Types/{typeId}",
+            routeValues: {
+                project: project
+            }
+        });
+    }
+
+}

package/src/Policy/index.ts

@@ -0,0 +1,2 @@
+export * from "./Policy";
+export * from "./PolicyClient";

package/src/Profile/Profile.ts

@@ -0,0 +1,187 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+
+/**
+ * Identifies an attribute with a name and a container.
+ */
+export interface AttributeDescriptor {
+    /**
+     * The name of the attribute.
+     */
+    attributeName: string;
+    /**
+     * The container the attribute resides in.
+     */
+    containerName: string;
+}
+
+/**
+ * Stores a set of named profile attributes.
+ */
+export interface AttributesContainer {
+    /**
+     * The attributes stored by the container.
+     */
+    attributes: { [key: string] : ProfileAttribute; };
+    /**
+     * The name of the container.
+     */
+    containerName: string;
+    /**
+     * The maximum revision number of any attribute within the container.
+     */
+    revision: number;
+}
+
+export interface Avatar {
+    isAutoGenerated: boolean;
+    size: AvatarSize;
+    timeStamp: Date;
+    value: number[];
+}
+
+/**
+ * Small = 34 x 34 pixels; Medium = 44 x 44 pixels; Large = 220 x 220 pixels
+ */
+export enum AvatarSize {
+    Small = 0,
+    Medium = 1,
+    Large = 2
+}
+
+/**
+ * A profile attribute which always has a value for each profile.
+ */
+export interface CoreProfileAttribute extends ProfileAttributeBase<any> {
+}
+
+export interface CreateProfileContext {
+    ciData: { [key: string] : any; };
+    contactWithOffers: boolean;
+    countryName: string;
+    displayName: string;
+    emailAddress: string;
+    hasAccount: boolean;
+    language: string;
+    phoneNumber: string;
+    /**
+     * The current state of the profile.
+     */
+    profileState: ProfileState;
+}
+
+export interface GeoRegion {
+    regionCode: string;
+}
+
+/**
+ * A user profile.
+ */
+export interface Profile {
+    /**
+     * The attributes of this profile.
+     */
+    applicationContainer: AttributesContainer;
+    /**
+     * The core attributes of this profile.
+     */
+    coreAttributes: { [key: string] : CoreProfileAttribute; };
+    /**
+     * The maximum revision number of any attribute.
+     */
+    coreRevision: number;
+    /**
+     * The unique identifier of the profile.
+     */
+    id: string;
+    /**
+     * The current state of the profile.
+     */
+    profileState: ProfileState;
+    /**
+     * The maximum revision number of any attribute.
+     */
+    revision: number;
+    /**
+     * The time at which this profile was last changed.
+     */
+    timeStamp: Date;
+}
+
+/**
+ * A named object associated with a profile.
+ */
+export interface ProfileAttribute extends ProfileAttributeBase<string> {
+}
+
+export interface ProfileAttributeBase<T> {
+    /**
+     * The descriptor of the attribute.
+     */
+    descriptor: AttributeDescriptor;
+    /**
+     * The revision number of the attribute.
+     */
+    revision: number;
+    /**
+     * The time the attribute was last changed.
+     */
+    timeStamp: Date;
+    /**
+     * The value of the attribute.
+     */
+    value: T;
+}
+
+/**
+ * Country/region information
+ */
+export interface ProfileRegion {
+    /**
+     * The two-letter code defined in ISO 3166 for the country/region.
+     */
+    code: string;
+    /**
+     * Localized country/region name
+     */
+    name: string;
+}
+
+/**
+ * Container of country/region information
+ */
+export interface ProfileRegions {
+    /**
+     * List of country/region code with contact consent requirement type of notice
+     */
+    noticeContactConsentRequirementRegions: string[];
+    /**
+     * List of country/region code with contact consent requirement type of opt-out
+     */
+    optOutContactConsentRequirementRegions: string[];
+    /**
+     * List of country/regions
+     */
+    regions: ProfileRegion[];
+}
+
+/**
+ * The state of a profile.
+ */
+export enum ProfileState {
+    /**
+     * The profile is in use.
+     */
+    Custom = 0,
+    /**
+     * The profile is in use, but can only be read.
+     */
+    CustomReadOnly = 1,
+    /**
+     * The profile may only be read.
+     */
+    ReadOnly = 2
+}