azure-devops-node-api - npm Package Compare versions

Comparing version 11.2.0 to 12.0.0

BuildApi.d.ts

@@ -745,3 +745,3 @@ /// <reference types="node" />
      *
-     * @param {string[]} tags - The tags to add.
+     * @param {string[]} tags - The tags to add. Request body is composed directly from listed tags.
      * @param {string} project - Project ID or project name
@@ -748,0 +748,0 @@ * @param {number} buildId - The ID of the build.

FileContainerApiBase.d.ts

@@ -14,3 +14,3 @@ import basem = require('./ClientApiBases');
     /**
-     * Creates the specified items in in the referenced container.
+     * Creates the specified items in the referenced container.
      *
@@ -17,0 +17,0 @@ * @param {VSSInterfaces.VssJsonCollectionWrapperV<FileContainerInterfaces.FileContainerItem[]>} items

FileContainerApiBase.js

@@ -27,3 +27,3 @@ "use strict";
     /**
-     * Creates the specified items in in the referenced container.
+     * Creates the specified items in the referenced container.
      *
@@ -30,0 +30,0 @@ * @param {VSSInterfaces.VssJsonCollectionWrapperV<FileContainerInterfaces.FileContainerItem[]>} items

GalleryApi.d.ts

@@ -65,2 +65,3 @@ /// <reference types="node" />
     updatePublisherMembers(roleAssignments: GalleryInterfaces.PublisherUserRoleAssignmentRef[], publisherName: string, limitToCallerIdentityDomain?: boolean): Promise<GalleryInterfaces.PublisherRoleAssignment[]>;
+    getPublisherWithoutToken(publisherName: string): Promise<GalleryInterfaces.Publisher>;
     getQuestions(publisherName: string, extensionName: string, count?: number, page?: number, afterDate?: Date): Promise<GalleryInterfaces.QuestionsResult>;
@@ -476,2 +477,6 @@ reportQuestion(concern: GalleryInterfaces.Concern, pubName: string, extName: string, questionId: number): Promise<GalleryInterfaces.Concern>;
     /**
+     * @param {string} publisherName
+     */
+    getPublisherWithoutToken(publisherName: string): Promise<GalleryInterfaces.Publisher>;
+    /**
      * Returns a list of questions with their responses associated with an extension.
@@ -478,0 +483,0 @@ *

interfaces/common/VSSInterfaces.d.ts

@@ -341,8 +341,14 @@ import GraphInterfaces = require("../../interfaces/GraphInterfaces");
 /**
- * This class is used to serialized collections as a single JSON object on the wire, to avoid serializing JSON arrays directly to the client, which can be a security hole
+ * This class is used to serialize collections as a single JSON object on the wire.
  */
 export interface VssJsonCollectionWrapperV<T> extends VssJsonCollectionWrapperBase {
+    /**
+     * The serialized item.
+     */
     value?: T;
 }
 export interface VssJsonCollectionWrapperBase {
+    /**
+     * The number of serialized items.
+     */
     count?: number;
@@ -383,3 +389,3 @@ }
     /**
-     * Optional: A list of scopes which are are relevant to the event.
+     * Optional: A list of scopes which are relevant to the event.
      */
@@ -386,0 +392,0 @@ scopes?: EventScope[];

interfaces/ExtensionManagementInterfaces.d.ts

@@ -19,3 +19,3 @@ import GalleryInterfaces = require("../interfaces/GalleryInterfaces");
     /**
-     * State of the the AcquisitionOperation for the current user
+     * State of the AcquisitionOperation for the current user
      */
@@ -22,0 +22,0 @@ operationState?: AcquisitionOperationState;

interfaces/GalleryInterfaces.js

@@ -244,2 +244,6 @@ /*
     ExtensionQueryFilterType[ExtensionQueryFilterType["TargetPlatform"] = 23] = "TargetPlatform";
+    /**
+     * Retrieve an extension based on the extensionName.
+     */
+    ExtensionQueryFilterType[ExtensionQueryFilterType["ExtensionName"] = 24] = "ExtensionName";
 })(ExtensionQueryFilterType = exports.ExtensionQueryFilterType || (exports.ExtensionQueryFilterType = {}));
@@ -886,3 +890,4 @@ /**
             "productArchitecture": 22,
-            "targetPlatform": 23
+            "targetPlatform": 23,
+            "extensionName": 24
         }
@@ -889,0 +894,0 @@ },

interfaces/GraphInterfaces.d.ts

 import IdentitiesInterfaces = require("../interfaces/IdentitiesInterfaces");
+export interface AadGraphMember extends GraphMember {
+    /**
+     * The short, generally unique name for the user in the backing directory. For AAD users, this corresponds to the mail nickname, which is often but not necessarily similar to the part of the user's mail address before the @ sign. For GitHub users, this corresponds to the GitHub user handle.
+     */
+    directoryAlias?: string;
+    /**
+     * When true, the group has been deleted in the identity provider
+     */
+    isDeletedInOrigin?: boolean;
+    metadataUpdateDate?: Date;
+    /**
+     * The meta type of the user in the origin, such as "member", "guest", etc. See UserMetaType for the set of possible values.
+     */
+    metaType?: string;
+}
 export interface GraphCachePolicies {
@@ -250,3 +265,42 @@ /**
 }
+export interface GraphServicePrincipal extends AadGraphMember {
+    applicationId?: string;
+}
 /**
+ * Do not attempt to use this type to create a new service principal. Use one of the subclasses instead. This type does not contain sufficient fields to create a new service principal.
+ */
+export interface GraphServicePrincipalCreationContext {
+    /**
+     * Optional: If provided, we will use this identifier for the storage key of the created service principal
+     */
+    storageKey?: string;
+}
+/**
+ * Use this type to create a new service principal using the OriginID as a reference to an existing service principal from an external AAD backed provider. This is the subset of GraphServicePrincipal fields required for creation of a GraphServicePrincipal for the AAD use case when looking up the service principal by its unique ID in the backing provider.
+ */
+export interface GraphServicePrincipalOriginIdCreationContext extends GraphServicePrincipalCreationContext {
+    /**
+     * This should be the object id of the service principal from the AAD provider. Example: d47d025a-ce2f-4a79-8618-e8862ade30dd Team Services will communicate with the source provider to fill all other fields on creation.
+     */
+    originId: string;
+}
+/**
+ * Use this type to update an existing service principal using the OriginID as a reference to an existing service principal from an external AAD backed provider. This is the subset of GraphServicePrincipal fields required for creation of a GraphServicePrincipal for AAD use case when looking up the service principal by its unique ID in the backing provider.
+ */
+export interface GraphServicePrincipalOriginIdUpdateContext extends GraphServicePrincipalUpdateContext {
+    /**
+     * This should be the object id or sid of the service principal from the source AAD provider. Example: d47d025a-ce2f-4a79-8618-e8862ade30dd Azure Devops will communicate with the source provider to fill all other fields on creation.
+     */
+    originId: string;
+}
+/**
+ * Do not attempt to use this type to update service principal. Use one of the subclasses instead. This type does not contain sufficient fields to create a new service principal.
+ */
+export interface GraphServicePrincipalUpdateContext {
+    /**
+     * Storage key should not be specified in case of updating service principal
+     */
+    storageKey?: string;
+}
+/**
  * Storage key of a Graph entity
@@ -333,19 +387,3 @@ */
 }
-/**
- * Graph user entity
- */
-export interface GraphUser extends GraphMember {
-    /**
-     * The short, generally unique name for the user in the backing directory. For AAD users, this corresponds to the mail nickname, which is often but not necessarily similar to the part of the user's mail address before the @ sign. For GitHub users, this corresponds to the GitHub user handle.
-     */
-    directoryAlias?: string;
-    /**
-     * When true, the group has been deleted in the identity provider
-     */
-    isDeletedInOrigin?: boolean;
-    metadataUpdateDate?: Date;
-    /**
-     * The meta type of the user in the origin, such as "member", "guest", etc. See UserMetaType for the set of possible values.
-     */
-    metaType?: string;
+export interface GraphUser extends AadGraphMember {
 }
@@ -365,2 +403,5 @@ /**
 export interface GraphUserMailAddressCreationContext extends GraphUserCreationContext {
+    /**
+     * This should be the mail address of the user in the source AD or AAD provider. Example: [e-mail] Team Services will communicate with the source provider to fill all other fields on creation.
+     */
     mailAddress: string;
@@ -400,2 +441,11 @@ }
 /**
+ * Use this type for transfering identity rights, for instance after performing a Tenant switch.
+ */
+export interface GraphUserPrincipalNameUpdateContext extends GraphUserUpdateContext {
+    /**
+     * This should be Principal Name (UPN) to which we want to transfer rights. Example: [e-mail]
+     */
+    principalName: string;
+}
+/**
  * Do not attempt to use this type to update user. Use one of the subclasses instead. This type does not contain sufficient fields to create a new user.
@@ -409,2 +459,13 @@ */
 }
+export interface IdentityMapping {
+    source?: UserPrincipalName;
+    target?: UserPrincipalName;
+}
+export interface IdentityMappings {
+    mappings?: IdentityMapping[];
+}
+export interface MappingResult {
+    code?: string;
+    errorMessage?: string;
+}
 export interface PagedGraphGroups {
@@ -420,2 +481,12 @@ /**
 }
+export interface PagedGraphServicePrincipals {
+    /**
+     * This will be non-null if there is another page of data. There will never be more than one continuation token returned by a request.
+     */
+    continuationToken?: string[];
+    /**
+     * The enumerable list of service principals found within a page.
+     */
+    graphServicePrincipals?: GraphServicePrincipal[];
+}
 export interface PagedGraphUsers {
@@ -436,5 +507,15 @@ /**
 }
+export interface ResolveDisconnectedUsersResponse {
+    code?: string;
+    errorMessage?: string;
+    mappingResults?: MappingResult[];
+}
+export interface UserPrincipalName {
+    principalName?: string;
+}
 export declare var TypeInfo: {
+    AadGraphMember: any;
     GraphScope: any;
     GraphScopeCreationContext: any;
+    GraphServicePrincipal: any;
     GraphTraversalDirection: {
@@ -448,3 +529,4 @@ enumValues: {
     GraphUser: any;
+    PagedGraphServicePrincipals: any;
     PagedGraphUsers: any;
 };

interfaces/GraphInterfaces.js

@@ -20,4 +20,6 @@ /*
 exports.TypeInfo = {
+    AadGraphMember: {},
     GraphScope: {},
     GraphScopeCreationContext: {},
+    GraphServicePrincipal: {},
     GraphTraversalDirection: {
@@ -31,4 +33,10 @@ enumValues: {
     GraphUser: {},
+    PagedGraphServicePrincipals: {},
     PagedGraphUsers: {},
 };
+exports.TypeInfo.AadGraphMember.fields = {
+    metadataUpdateDate: {
+        isDate: true,
+    }
+};
 exports.TypeInfo.GraphScope.fields = {
@@ -44,2 +52,7 @@ scopeType: {
 };
+exports.TypeInfo.GraphServicePrincipal.fields = {
+    metadataUpdateDate: {
+        isDate: true,
+    }
+};
 exports.TypeInfo.GraphUser.fields = {
@@ -50,2 +63,8 @@ metadataUpdateDate: {
 };
+exports.TypeInfo.PagedGraphServicePrincipals.fields = {
+    graphServicePrincipals: {
+        isArray: true,
+        typeInfo: exports.TypeInfo.GraphServicePrincipal
+    }
+};
 exports.TypeInfo.PagedGraphUsers.fields = {
@@ -52,0 +71,0 @@ graphUsers: {

interfaces/NotificationInterfaces.d.ts

@@ -755,3 +755,3 @@ import FormInputInterfaces = require("../interfaces/common/FormInputInterfaces");
     /**
-     * REST API URL of the subscriotion.
+     * REST API URL of the subscription.
      */
@@ -1122,3 +1122,3 @@ url?: string;
     /**
-     * Flags to specify the the type subscriptions to query for.
+     * Flags to specify the type subscriptions to query for.
      */
@@ -1125,0 +1125,0 @@ flags?: SubscriptionFlags;

interfaces/TaskAgentInterfaces.js

@@ -145,2 +145,3 @@ /*
     ElasticComputeState[ElasticComputeState["Stopped"] = 5] = "Stopped";
+    ElasticComputeState[ElasticComputeState["Reimaging"] = 6] = "Reimaging";
 })(ElasticComputeState = exports.ElasticComputeState || (exports.ElasticComputeState = {}));
@@ -162,2 +163,8 @@ var ElasticNodeState;
     ElasticNodeState[ElasticNodeState["Lost"] = 12] = "Lost";
+    ElasticNodeState[ElasticNodeState["ReimagingCompute"] = 13] = "ReimagingCompute";
+    ElasticNodeState[ElasticNodeState["RestartingAgent"] = 14] = "RestartingAgent";
+    ElasticNodeState[ElasticNodeState["FailedToStartPendingDelete"] = 15] = "FailedToStartPendingDelete";
+    ElasticNodeState[ElasticNodeState["FailedToRestartPendingDelete"] = 16] = "FailedToRestartPendingDelete";
+    ElasticNodeState[ElasticNodeState["FailedVMPendingDelete"] = 17] = "FailedVMPendingDelete";
+    ElasticNodeState[ElasticNodeState["AssignedPendingDelete"] = 18] = "AssignedPendingDelete";
 })(ElasticNodeState = exports.ElasticNodeState || (exports.ElasticNodeState = {}));
@@ -230,2 +237,5 @@ var ElasticPoolState;
 })(ExclusiveLockType = exports.ExclusiveLockType || (exports.ExclusiveLockType = {}));
+/**
+ * The type of issue based on severity.
+ */
 var IssueType;
@@ -506,2 +516,5 @@ (function (IssueType) {
 })(TaskOrchestrationPlanState = exports.TaskOrchestrationPlanState || (exports.TaskOrchestrationPlanState = {}));
+/**
+ * The result of an operation tracked by a timeline record.
+ */
 var TaskResult;
@@ -516,2 +529,5 @@ (function (TaskResult) {
 })(TaskResult = exports.TaskResult || (exports.TaskResult = {}));
+/**
+ * The state of the timeline record.
+ */
 var TimelineRecordState;
@@ -636,3 +652,4 @@ (function (TimelineRecordState) {
             "failed": 4,
-            "stopped": 5
+            "stopped": 5,
+            "reimaging": 6
         }
@@ -656,3 +673,9 @@ },
             "deleted": 11,
-            "lost": 12
+            "lost": 12,
+            "reimagingCompute": 13,
+            "restartingAgent": 14,
+            "failedToStartPendingDelete": 15,
+            "failedToRestartPendingDelete": 16,
+            "failedVMPendingDelete": 17,
+            "assignedPendingDelete": 18
         }
@@ -659,0 +682,0 @@ },

interfaces/TfvcInterfaces.d.ts

@@ -65,2 +65,6 @@ import TfsCoreInterfaces = require("../interfaces/CoreInterfaces");
     isFork?: boolean;
+    /**
+     * True if the repository is in maintenance. False otherwise.
+     */
+    isInMaintenance?: boolean;
     name?: string;
@@ -67,0 +71,0 @@ parentRepository?: GitRepositoryRef;

interfaces/WorkInterfaces.d.ts

@@ -264,2 +264,3 @@ import SystemInterfaces = require("../interfaces/common/System");
 export interface BoardRow {
+    color?: string;
     id?: string;
@@ -332,3 +333,3 @@ name?: string;
     /**
-     * Flag indicating whether to show show parent field on cards
+     * Flag indicating whether to show parent field on cards
      */
@@ -617,2 +618,6 @@ showParent?: boolean;
     /**
+     * Date when the plan was last accessed. Default is null.
+     */
+    lastAccessed?: Date;
+    /**
      * Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.
@@ -619,0 +624,0 @@ */

interfaces/WorkInterfaces.js

@@ -429,2 +429,5 @@ /*
     },
+    lastAccessed: {
+        isDate: true,
+    },
     modifiedDate: {
@@ -431,0 +434,0 @@ isDate: true,

interfaces/WorkItemTrackingInterfaces.d.ts

@@ -482,2 +482,15 @@ import VSSInterfaces = require("../interfaces/common/VSSInterfaces");
 /**
+ * Describes an update request for a work item field.
+ */
+export interface FieldUpdate {
+    /**
+     * Indicates whether the user wants to restore the field.
+     */
+    isDeleted?: boolean;
+    /**
+     * Indicates whether the user wants to lock the field.
+     */
+    isLocked?: boolean;
+}
+/**
  * Enum for field usages.
@@ -967,2 +980,20 @@ */
 /**
+ * Describes a request to create a temporary query
+ */
+export interface TemporaryQueryRequestModel extends WorkItemTrackingResource {
+    /**
+     * The WIQL text of the temporary query
+     */
+    wiql?: string;
+}
+/**
+ * The result of a temporary query creation.
+ */
+export interface TemporaryQueryResponseModel {
+    /**
+     * The id of the temporary query item.
+     */
+    id?: string;
+}
+/**
  * Types of tree node structures.
@@ -1190,2 +1221,28 @@ */
 /**
+ * Describes response to delete a set of work items.
+ */
+export interface WorkItemDeleteBatch {
+    /**
+     * List of results for each work item
+     */
+    results?: WorkItemDelete[];
+}
+/**
+ * Describes a request to delete a set of work items
+ */
+export interface WorkItemDeleteBatchRequest {
+    /**
+     * Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.
+     */
+    destroy?: boolean;
+    /**
+     * The requested work item ids
+     */
+    ids?: number[];
+    /**
+     * Optional parameter, if set to true, notifications will be disabled.
+     */
+    skipNotifications?: boolean;
+}
+/**
  * Reference to a deleted work item.
@@ -1353,2 +1410,11 @@ */
 /**
+ * Describes a field on a work item and it's properties specific to that work item type.
+ */
+export interface WorkItemField2 extends WorkItemField {
+    /**
+     * Indicates whether this field is marked as locked for editing.
+     */
+    isLocked?: boolean;
+}
+/**
  * Describes a work item field operation.
@@ -1616,2 +1682,3 @@ */
     id?: string;
+    lastUpdated?: Date;
     name?: string;
@@ -1767,3 +1834,3 @@ url?: string;
 /**
- * Describes work item type nam, its icon and color.
+ * Describes work item type name, its icon and color.
  */
@@ -1780,2 +1847,6 @@ export interface WorkItemTypeColorAndIcon {
     /**
+     * Indicates if the work item is disabled in the process.
+     */
+    isDisabled?: boolean;
+    /**
      * The name of the work item type.
@@ -1786,2 +1857,15 @@ */
 /**
+ * Describes the list of allowed values of the field.
+ */
+export interface WorkItemTypeFieldAlowedValues {
+    /**
+     * The list of field allowed values.
+     */
+    allowedValues?: string[];
+    /**
+     * Name of the field.
+     */
+    fieldName?: string;
+}
+/**
  * Field instance of a work item type.
@@ -2126,2 +2210,3 @@ */
     WorkItemField: any;
+    WorkItemField2: any;
     WorkItemHistory: any;
@@ -2138,2 +2223,3 @@ WorkItemQueryClause: any;
     };
+    WorkItemTagDefinition: any;
     WorkItemTypeFieldsExpandLevel: {
@@ -2140,0 +2226,0 @@ enumValues: {

interfaces/WorkItemTrackingInterfaces.js

@@ -602,2 +602,3 @@ /*
     WorkItemField: {},
+    WorkItemField2: {},
     WorkItemHistory: {},
@@ -614,2 +615,3 @@ WorkItemQueryClause: {},
     },
+    WorkItemTagDefinition: {},
     WorkItemTypeFieldsExpandLevel: {
@@ -806,2 +808,10 @@ enumValues: {
 };
+exports.TypeInfo.WorkItemField2.fields = {
+    type: {
+        enumType: exports.TypeInfo.FieldType
+    },
+    usage: {
+        enumType: exports.TypeInfo.FieldUsage
+    }
+};
 exports.TypeInfo.WorkItemHistory.fields = {
@@ -832,2 +842,7 @@ revisedDate: {
 };
+exports.TypeInfo.WorkItemTagDefinition.fields = {
+    lastUpdated: {
+        isDate: true,
+    }
+};
 exports.TypeInfo.WorkItemTypeTemplateUpdateModel.fields = {
@@ -834,0 +849,0 @@ actionType: {

interfaces/WorkItemTrackingProcessInterfaces.d.ts

@@ -188,2 +188,3 @@ /**
     isIdentity?: boolean;
+    isLocked?: boolean;
     name?: string;
@@ -497,3 +498,3 @@ type?: FieldType;
     /**
-     * Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.
+     * Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.
      */
@@ -777,2 +778,6 @@ customization?: CustomizationType;
     /**
+     * Information about field definition being locked for editing
+     */
+    isLocked?: boolean;
+    /**
      * Name of the field.
@@ -779,0 +784,0 @@ */

package.json

 {
     "name": "azure-devops-node-api",
     "description": "Node client for Azure DevOps and TFS REST APIs",
-    "version": "11.2.0",
+    "version": "12.0.0",
     "main": "./WebApi.js",
@@ -31,2 +31,4 @@ "types": "./WebApi.d.ts",
     "devDependencies": {
+        "@types/glob": "5.0.35",
+        "@types/minimatch": "3.0.3",
         "@types/mocha": "^2.2.44",
@@ -33,0 +35,0 @@ "@types/shelljs": "0.7.8",

PolicyApi.d.ts

@@ -5,3 +5,3 @@ import basem = require('./ClientApiBases');
 export interface IPolicyApi extends basem.ClientApiBase {
-    createPolicyConfiguration(configuration: PolicyInterfaces.PolicyConfiguration, project: string, configurationId?: number): Promise<PolicyInterfaces.PolicyConfiguration>;
+    createPolicyConfiguration(configuration: PolicyInterfaces.PolicyConfiguration, project: string): Promise<PolicyInterfaces.PolicyConfiguration>;
     deletePolicyConfiguration(project: string, configurationId: number): Promise<void>;
@@ -27,5 +27,4 @@ getPolicyConfiguration(project: string, configurationId: number): Promise<PolicyInterfaces.PolicyConfiguration>;
      * @param {string} project - Project ID or project name
-     * @param {number} configurationId
      */
-    createPolicyConfiguration(configuration: PolicyInterfaces.PolicyConfiguration, project: string, configurationId?: number): Promise<PolicyInterfaces.PolicyConfiguration>;
+    createPolicyConfiguration(configuration: PolicyInterfaces.PolicyConfiguration, project: string): Promise<PolicyInterfaces.PolicyConfiguration>;
     /**
@@ -32,0 +31,0 @@ * Delete a policy configuration by its ID.

PolicyApi.js

@@ -31,10 +31,8 @@ "use strict";
      * @param {string} project - Project ID or project name
-     * @param {number} configurationId
      */
-    createPolicyConfiguration(configuration, project, configurationId) {
+    createPolicyConfiguration(configuration, project) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
                 let routeValues = {
-                    project: project,
-                    configurationId: configurationId
+                    project: project
                 };
@@ -41,0 +39,0 @@ try {

TaskApi.d.ts

@@ -22,2 +22,5 @@ /// <reference types="node" />
     getPlanGroupsQueueMetrics(scopeIdentifier: string, hubName: string): Promise<TaskAgentInterfaces.TaskOrchestrationPlanGroupsQueueMetrics[]>;
+    createOidcToken(claims: {
+        [key: string]: string;
+    }, scopeIdentifier: string, hubName: string, planId: string, jobId: string, serviceConnectionId: string): Promise<TaskAgentInterfaces.TaskHubOidcToken>;
     getQueuedPlanGroups(scopeIdentifier: string, hubName: string, statusFilter?: TaskAgentInterfaces.PlanGroupStatus, count?: number): Promise<TaskAgentInterfaces.TaskOrchestrationQueuedPlanGroup[]>;
@@ -37,3 +40,3 @@ getQueuedPlanGroup(scopeIdentifier: string, hubName: string, planGroup: string): Promise<TaskAgentInterfaces.TaskOrchestrationQueuedPlanGroup>;
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -46,3 +49,3 @@ * @param {string} type
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -57,3 +60,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -70,3 +73,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -81,3 +84,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -92,3 +95,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -101,8 +104,10 @@ * @param {string} timelineId
     /**
-     * @param {TaskAgentInterfaces.TimelineRecordFeedLinesWrapper} lines
+     * Append content to timeline record feed.
+     *
+     * @param {TaskAgentInterfaces.TimelineRecordFeedLinesWrapper} lines - Content to be appended to the timeline record feed.
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
-     * @param {string} timelineId
-     * @param {string} recordId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - ID of the plan.
+     * @param {string} timelineId - ID of the task's timeline.
+     * @param {string} recordId - ID of the timeline record.
      */
@@ -112,3 +117,3 @@ appendTimelineRecordFeed(lines: TaskAgentInterfaces.TimelineRecordFeedLinesWrapper, scopeIdentifier: string, hubName: string, planId: string, timelineId: string, recordId: string): Promise<void>;
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -125,3 +130,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} orchestrationId
@@ -131,7 +136,9 @@ */
     /**
+     * Append a log to a task's log. The log should be sent in the body of the request as a TaskLog object stream.
+     *
      * @param {NodeJS.ReadableStream} contentStream - Content to upload
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
-     * @param {number} logId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - The ID of the plan.
+     * @param {number} logId - The ID of the log.
      */
@@ -141,3 +148,3 @@ appendLogContent(customHeaders: any, contentStream: NodeJS.ReadableStream, scopeIdentifier: string, hubName: string, planId: string, logId: number): Promise<TaskAgentInterfaces.TaskLog>;
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -150,6 +157,8 @@ * @param {number} logId
     /**
-     * @param {TaskAgentInterfaces.TaskLog} log
+     * Create a log and connect it to a pipeline run's execution plan.
+     *
+     * @param {TaskAgentInterfaces.TaskLog} log - An object that contains information about log's path.
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - The ID of the plan.
      */
@@ -159,3 +168,3 @@ createLog(log: TaskAgentInterfaces.TaskLog, scopeIdentifier: string, hubName: string, planId: string): Promise<TaskAgentInterfaces.TaskLog>;
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -169,3 +178,3 @@ * @param {number} logId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -176,8 +185,19 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      */
     getPlanGroupsQueueMetrics(scopeIdentifier: string, hubName: string): Promise<TaskAgentInterfaces.TaskOrchestrationPlanGroupsQueueMetrics[]>;
     /**
+     * @param {{ [key: string] : string; }} claims
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId
+     * @param {string} jobId
+     * @param {string} serviceConnectionId
+     */
+    createOidcToken(claims: {
+        [key: string]: string;
+    }, scopeIdentifier: string, hubName: string, planId: string, jobId: string, serviceConnectionId: string): Promise<TaskAgentInterfaces.TaskHubOidcToken>;
+    /**
+     * @param {string} scopeIdentifier - The project GUID to scope the request
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {TaskAgentInterfaces.PlanGroupStatus} statusFilter
@@ -189,3 +209,3 @@ * @param {number} count
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planGroup
@@ -196,3 +216,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -203,3 +223,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -211,7 +231,9 @@ * @param {string} timelineId
     /**
-     * @param {VSSInterfaces.VssJsonCollectionWrapperV<TaskAgentInterfaces.TimelineRecord[]>} records
+     * Update timeline records if they already exist, otherwise create new ones for the same timeline.
+     *
+     * @param {VSSInterfaces.VssJsonCollectionWrapperV<TaskAgentInterfaces.TimelineRecord[]>} records - The array of timeline records to be updated.
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
-     * @param {string} timelineId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - The ID of the plan.
+     * @param {string} timelineId - The ID of the timeline.
      */
@@ -222,3 +244,3 @@ updateRecords(records: VSSInterfaces.VssJsonCollectionWrapperV<TaskAgentInterfaces.TimelineRecord[]>, scopeIdentifier: string, hubName: string, planId: string, timelineId: string): Promise<TaskAgentInterfaces.TimelineRecord[]>;
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -229,3 +251,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -237,3 +259,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -247,3 +269,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -250,0 +272,0 @@ */

TaskApi.js

@@ -28,3 +28,3 @@ "use strict";
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -60,3 +60,3 @@ * @param {string} type
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -100,3 +100,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -149,3 +149,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -186,3 +186,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -221,3 +221,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -255,8 +255,10 @@ * @param {string} timelineId
     /**
-     * @param {TaskAgentInterfaces.TimelineRecordFeedLinesWrapper} lines
+     * Append content to timeline record feed.
+     *
+     * @param {TaskAgentInterfaces.TimelineRecordFeedLinesWrapper} lines - Content to be appended to the timeline record feed.
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
-     * @param {string} timelineId
-     * @param {string} recordId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - ID of the plan.
+     * @param {string} timelineId - ID of the task's timeline.
+     * @param {string} recordId - ID of the timeline record.
      */
@@ -290,3 +292,3 @@ appendTimelineRecordFeed(lines, scopeIdentifier, hubName, planId, timelineId, recordId) {
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -336,3 +338,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} orchestrationId
@@ -364,7 +366,9 @@ */
     /**
+     * Append a log to a task's log. The log should be sent in the body of the request as a TaskLog object stream.
+     *
      * @param {NodeJS.ReadableStream} contentStream - Content to upload
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
-     * @param {number} logId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - The ID of the plan.
+     * @param {number} logId - The ID of the log.
      */
@@ -400,3 +404,3 @@ appendLogContent(customHeaders, contentStream, scopeIdentifier, hubName, planId, logId) {
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -442,6 +446,8 @@ * @param {number} logId
     /**
-     * @param {TaskAgentInterfaces.TaskLog} log
+     * Create a log and connect it to a pipeline run's execution plan.
+     *
+     * @param {TaskAgentInterfaces.TaskLog} log - An object that contains information about log's path.
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - The ID of the plan.
      */
@@ -473,3 +479,3 @@ createLog(log, scopeIdentifier, hubName, planId) {
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -510,3 +516,3 @@ * @param {number} logId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -539,3 +545,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      */
@@ -565,4 +571,42 @@ getPlanGroupsQueueMetrics(scopeIdentifier, hubName) {
     /**
+     * @param {{ [key: string] : string; }} claims
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId
+     * @param {string} jobId
+     * @param {string} serviceConnectionId
+     */
+    createOidcToken(claims, scopeIdentifier, hubName, planId, jobId, serviceConnectionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (serviceConnectionId == null) {
+                throw new TypeError('serviceConnectionId can not be null or undefined');
+            }
+            return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                let routeValues = {
+                    scopeIdentifier: scopeIdentifier,
+                    hubName: hubName,
+                    planId: planId,
+                    jobId: jobId
+                };
+                let queryValues = {
+                    serviceConnectionId: serviceConnectionId,
+                };
+                try {
+                    let verData = yield this.vsoClient.getVersioningData("7.1-preview.1", "distributedtask", "69a319f4-28c1-4bfd-93e6-ea0ff5c6f1a2", routeValues, queryValues);
+                    let url = verData.requestUrl;
+                    let options = this.createRequestOptions('application/json', verData.apiVersion);
+                    let res;
+                    res = yield this.rest.create(url, claims, options);
+                    let ret = this.formatResponse(res.result, null, false);
+                    resolve(ret);
+                }
+                catch (err) {
+                    reject(err);
+                }
+            }));
+        });
+    }
+    /**
+     * @param {string} scopeIdentifier - The project GUID to scope the request
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {TaskAgentInterfaces.PlanGroupStatus} statusFilter
@@ -599,3 +643,3 @@ * @param {number} count
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planGroup
@@ -628,3 +672,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -657,3 +701,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -691,7 +735,9 @@ * @param {string} timelineId
     /**
-     * @param {VSSInterfaces.VssJsonCollectionWrapperV<TaskAgentInterfaces.TimelineRecord[]>} records
+     * Update timeline records if they already exist, otherwise create new ones for the same timeline.
+     *
+     * @param {VSSInterfaces.VssJsonCollectionWrapperV<TaskAgentInterfaces.TimelineRecord[]>} records - The array of timeline records to be updated.
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
-     * @param {string} planId
-     * @param {string} timelineId
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
+     * @param {string} planId - The ID of the plan.
+     * @param {string} timelineId - The ID of the timeline.
      */
@@ -725,3 +771,3 @@ updateRecords(records, scopeIdentifier, hubName, planId, timelineId) {
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -754,3 +800,3 @@ */
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -785,3 +831,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -822,3 +868,3 @@ * @param {string} timelineId
      * @param {string} scopeIdentifier - The project GUID to scope the request
-     * @param {string} hubName - The name of the server hub: "build" for the Build server or "rm" for the Release Management server
+     * @param {string} hubName - The name of the server hub. Common examples: "build", "rm", "checks"
      * @param {string} planId
@@ -825,0 +871,0 @@ */

WorkItemTrackingProcessApi.d.ts

@@ -453,3 +453,3 @@ import basem = require('./ClientApiBases');
     /**
-     * Removes a work itewm type in the process.
+     * Removes a work item type in the process.
      *
@@ -456,0 +456,0 @@ * @param {string} processId - The ID of the process.

WorkItemTrackingProcessDefinitionsApi.d.ts

@@ -356,3 +356,3 @@ import basem = require('./ClientApiBases');
     /**
-     * Removes a work itewm type in the process.
+     * Removes a work item type in the process.
      *
@@ -359,0 +359,0 @@ * @param {string} processId - The ID of the process

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4131166

increased by0.49%

Lines of code

103108

increased by0.63%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

9

increased by28.57%

No dependency changes