azure-devops-extension-api 4.248.0 → 4.250.0

package/src/Build/BuildServices.ts

@@ -1,39 +0,0 @@
-import { BuildDefinitionReference, BuildReference } from "./Build";
-
-/**
- * Contribution ids of Azure Pipelines services which can be obtained from DevOps.getService
- */
-export enum BuildServiceIds {
-
-    /**
-     * Service for getting contextual information when on a builds page
-     */
-    BuildPageDataService = "ms.vss-build-web.build-page-data-service"
-}
-
-/**
- * Contextual information for a build page
- */
-export interface IBuildPageData {
-
-    /**
-     * The currently selected build result when on a build page
-     */
-    build?: BuildReference;
-
-    /**
-     * The currently selected build definition when on a build page
-     */
-    definition?: BuildDefinitionReference;
-}
-
-/**
- * Service for getting contextual information when on a builds page
- */
-export interface IBuildPageDataService {
-
-    /**
-     * Gets contextual information for a build page
-     */
-    getBuildPageData(): IBuildPageData | undefined;
-}

package/src/Build/index.ts

@@ -1,3 +0,0 @@
-export * from "./Build";
-export * from "./BuildClient";
-export * from "./BuildServices";

package/src/Comments/Comments.ts

@@ -1,330 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import * as WebApi from "../WebApi/WebApi";
-
-/**
- * Comment on an artifact like Work Item or Wiki, etc.
- */
-export interface Comment extends CommentResourceReference {
-    /**
-     * The id of the artifact this comment belongs to
-     */
-    artifactId: string;
-    /**
-     * IdentityRef of the creator of the comment.
-     */
-    createdBy: WebApi.IdentityRef;
-    /**
-     * The creation date of the comment.
-     */
-    createdDate: Date;
-    /**
-     * The id assigned to the comment.
-     */
-    id: number;
-    /**
-     * Indicates if the comment has been deleted.
-     */
-    isDeleted: boolean;
-    /**
-     * The mentions of the comment.
-     */
-    mentions: CommentMention[];
-    /**
-     * IdentityRef of the user who last modified the comment.
-     */
-    modifiedBy: WebApi.IdentityRef;
-    /**
-     * The last modification date of the comment.
-     */
-    modifiedDate: Date;
-    /**
-     * The comment id of the parent comment, if any
-     */
-    parentId: number;
-    /**
-     * The reactions on the comment.
-     */
-    reactions: CommentReaction[];
-    /**
-     * The rendered text of the comment
-     */
-    renderedText: string;
-    /**
-     * Replies for this comment
-     */
-    replies: CommentList;
-    /**
-     * Indicates the current state of the comment
-     */
-    state: CommentState;
-    /**
-     * The plaintext/markdown version of the comment
-     */
-    text: string;
-    /**
-     * The current version of the comment
-     */
-    version: number;
-}
-
-/**
- * Represents an attachment to a comment.
- */
-export interface CommentAttachment extends CommentResourceReference {
-    /**
-     * IdentityRef of the creator of the attachment.
-     */
-    createdBy: WebApi.IdentityRef;
-    /**
-     * The creation date of the attachment.
-     */
-    createdDate: Date;
-    /**
-     * Unique Id of the attachment.
-     */
-    id: string;
-}
-
-/**
- * Represents a request to create a work item comment.
- */
-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;
-}
-
-/**
- * Specifies the additional data retrieval options for comments.
- */
-export enum CommentExpandOptions {
-    /**
-     * Include comments only, no mentions, reactions or rendered text
-     */
-    None = 0,
-    /**
-     * Include comment reactions
-     */
-    Reactions = 1,
-    /**
-     * 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
-     */
-    Children = 32,
-    /**
-     * Expand everything including Reactions, Mentions and also include RenderedText (HTML) for markdown comments
-     */
-    All = -17
-}
-
-/**
- * Format of the comment. Ex. Markdown, Html.
- */
-export enum CommentFormat {
-    Markdown = 0,
-    Html = 1
-}
-
-/**
- * Represents a list of comments.
- */
-export interface CommentList extends CommentResourceReference {
-    /**
-     * List of comments in the current batch.
-     */
-    comments: Comment[];
-    /**
-     * A string token that can be used to retrieving next page of comments if available. Otherwise null.
-     */
-    continuationToken: string;
-    /**
-     * The count of comments in the current batch.
-     */
-    count: number;
-    /**
-     * Uri to the next page of comments if it is available. Otherwise null.
-     */
-    nextPage: string;
-    /**
-     * Total count of comments on a work item.
-     */
-    totalCount: number;
-}
-
-/**
- * Contains information about various artifacts mentioned in the comment
- */
-export interface CommentMention extends CommentResourceReference {
-    /**
-     * Id of the artifact this mention belongs to
-     */
-    artifactId: string;
-    /**
-     * Id of the comment associated with this mention. Nullable to support legacy mentions which can potentially have null commentId
-     */
-    commentId: number;
-    /**
-     * Value of the mentioned artifact. Expected Value varies by CommentMentionType: Person:         VSID associated with the identity Work Item:      ID of the work item Pull Request:   ID of the Pull Request
-     */
-    mentionedArtifact: string;
-    /**
-     * The context which represent where this mentioned was parsed from
-     */
-    type: CommentMentionType;
-}
-
-export enum CommentMentionType {
-    /**
-     * An identity was mentioned by using the format \@\{VSID\}
-     */
-    Person = 0,
-    /**
-     * A work item was mentioned by using the format #\{Work Item ID\}
-     */
-    WorkItem = 1,
-    /**
-     * A Pull Request was mentioned by using the format !\{PR Number\}
-     */
-    PullRequest = 2
-}
-
-/**
- * Contains information about comment reaction for a particular reaction type.
- */
-export interface CommentReaction extends CommentResourceReference {
-    /**
-     * The id of the comment this reaction belongs to.
-     */
-    commentId: number;
-    /**
-     * Total number of reactions for the CommentReactionType.
-     */
-    count: number;
-    /**
-     * Flag to indicate if the current user has engaged on this particular EngagementType (e.g. if they liked the associated comment).
-     */
-    isCurrentUserEngaged: boolean;
-    /**
-     * Type of the reaction.
-     */
-    type: CommentReactionType;
-}
-
-/**
- * Represents different reaction types for a comment
- */
-export enum CommentReactionType {
-    Like = 0,
-    Dislike = 1,
-    Heart = 2,
-    Hooray = 3,
-    Smile = 4,
-    Confused = 5
-}
-
-/**
- * Base class for comment resource references
- */
-export interface CommentResourceReference {
-    /**
-     * REST URL for the resource.
-     */
-    url: string;
-}
-
-export enum CommentSortOrder {
-    /**
-     * The results will be sorted in Ascending order.
-     */
-    Asc = 1,
-    /**
-     * The results will be sorted in Descending order.
-     */
-    Desc = 2
-}
-
-/**
- * Represents the possible comment states.
- */
-export enum CommentState {
-    Active = 0,
-    Resolved = 1,
-    Closed = 2
-}
-
-/**
- * Represents a request to update a comment.
- */
-export interface CommentUpdateParameters {
-    /**
-     * Set the current state of the comment
-     */
-    state: CommentState;
-    /**
-     * The updated text of the comment
-     */
-    text: string;
-}
-
-/**
- * Represents a specific version of a comment on a work item.
- */
-export interface CommentVersion extends CommentResourceReference {
-    /**
-     * IdentityRef of the creator of the comment.
-     */
-    createdBy: WebApi.IdentityRef;
-    /**
-     * The creation date of the comment.
-     */
-    createdDate: Date;
-    /**
-     * The id assigned to the comment.
-     */
-    id: number;
-    /**
-     * Indicates if the comment has been deleted at this version.
-     */
-    isDeleted: boolean;
-    /**
-     * IdentityRef of the user who modified the comment at this version.
-     */
-    modifiedBy: WebApi.IdentityRef;
-    /**
-     * The modification date of the comment for this version.
-     */
-    modifiedDate: Date;
-    /**
-     * The rendered content of the comment at this version.
-     */
-    renderedText: string;
-    /**
-     * Indicates the current state of the comment
-     */
-    state: CommentState;
-    /**
-     * The text of the comment at this version.
-     */
-    text: string;
-    /**
-     * The version number.
-     */
-    version: number;
-}

package/src/Comments/index.ts

@@ -1 +0,0 @@
-export * from "./Comments";

package/src/Common/Client.ts

@@ -1,37 +0,0 @@
-import { getAccessToken, getService } from "azure-devops-extension-sdk";
-import { IVssRestClientOptions } from "./Context";
-import { CommonServiceIds, ILocationService } from "./CommonServices";
-
-/**
- * A REST client factory is the method used to create and initialize an IVssRestClient.
- */
-export type RestClientFactory<T> = {
-    new (options: IVssRestClientOptions): T;
-    RESOURCE_AREA_ID?: string;
-}
-
-export function getClient<T>(clientClass: RestClientFactory<T>, clientOptions?: IVssRestClientOptions) {
-
-    const options = clientOptions || {};
-
-    if (!options.rootPath) {
-        options.rootPath = getService<ILocationService>(CommonServiceIds.LocationService).then(locationService => {
-            if (clientClass.RESOURCE_AREA_ID) {
-                return locationService.getResourceAreaLocation(clientClass.RESOURCE_AREA_ID);
-            }
-            else {
-                return locationService.getServiceLocation();
-            }
-        });
-    }
-
-    if (!options.authTokenProvider) {
-        options.authTokenProvider = {
-            getAuthorizationHeader: (): Promise<string> => {
-                return getAccessToken().then(token => token ? ("Bearer " + token) : "");
-            }
-        };
-    }
-
-    return new clientClass(options);
-}