azure-devops-extension-api 4.269.1 → 5.271.0

package/esm/Contributions/Contributions.js

@@ -0,0 +1,182 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+/**
+ * Represents different ways of including contributions based on licensing
+ */
+export var ContributionLicensingBehaviorType;
+(function (ContributionLicensingBehaviorType) {
+    /**
+     * Default value - only include the contribution if the user is licensed for the extension
+     */
+    ContributionLicensingBehaviorType[ContributionLicensingBehaviorType["OnlyIfLicensed"] = 0] = "OnlyIfLicensed";
+    /**
+     * Only include the contribution if the user is NOT licensed for the extension
+     */
+    ContributionLicensingBehaviorType[ContributionLicensingBehaviorType["OnlyIfUnlicensed"] = 1] = "OnlyIfUnlicensed";
+    /**
+     * Always include the contribution regardless of whether or not the user is licensed for the extension
+     */
+    ContributionLicensingBehaviorType[ContributionLicensingBehaviorType["AlwaysInclude"] = 2] = "AlwaysInclude";
+})(ContributionLicensingBehaviorType || (ContributionLicensingBehaviorType = {}));
+/**
+ * The type of value used for a property
+ */
+export var ContributionPropertyType;
+(function (ContributionPropertyType) {
+    /**
+     * Contribution type is unknown (value may be anything)
+     */
+    ContributionPropertyType[ContributionPropertyType["Unknown"] = 0] = "Unknown";
+    /**
+     * Value is a string
+     */
+    ContributionPropertyType[ContributionPropertyType["String"] = 1] = "String";
+    /**
+     * Value is a Uri
+     */
+    ContributionPropertyType[ContributionPropertyType["Uri"] = 2] = "Uri";
+    /**
+     * Value is a GUID
+     */
+    ContributionPropertyType[ContributionPropertyType["Guid"] = 4] = "Guid";
+    /**
+     * Value is True or False
+     */
+    ContributionPropertyType[ContributionPropertyType["Boolean"] = 8] = "Boolean";
+    /**
+     * Value is an integer
+     */
+    ContributionPropertyType[ContributionPropertyType["Integer"] = 16] = "Integer";
+    /**
+     * Value is a double
+     */
+    ContributionPropertyType[ContributionPropertyType["Double"] = 32] = "Double";
+    /**
+     * Value is a DateTime object
+     */
+    ContributionPropertyType[ContributionPropertyType["DateTime"] = 64] = "DateTime";
+    /**
+     * Value is a generic Dictionary/JObject/property bag
+     */
+    ContributionPropertyType[ContributionPropertyType["Dictionary"] = 128] = "Dictionary";
+    /**
+     * Value is an array
+     */
+    ContributionPropertyType[ContributionPropertyType["Array"] = 256] = "Array";
+    /**
+     * Value is an arbitrary/custom object
+     */
+    ContributionPropertyType[ContributionPropertyType["Object"] = 512] = "Object";
+})(ContributionPropertyType || (ContributionPropertyType = {}));
+/**
+ * Options that control the contributions to include in a query
+ */
+export var ContributionQueryOptions;
+(function (ContributionQueryOptions) {
+    ContributionQueryOptions[ContributionQueryOptions["None"] = 0] = "None";
+    /**
+     * Include the direct contributions that have the ids queried.
+     */
+    ContributionQueryOptions[ContributionQueryOptions["IncludeSelf"] = 16] = "IncludeSelf";
+    /**
+     * Include the contributions that directly target the contributions queried.
+     */
+    ContributionQueryOptions[ContributionQueryOptions["IncludeChildren"] = 32] = "IncludeChildren";
+    /**
+     * Include the contributions from the entire sub-tree targeting the contributions queried.
+     */
+    ContributionQueryOptions[ContributionQueryOptions["IncludeSubTree"] = 96] = "IncludeSubTree";
+    /**
+     * Include the contribution being queried as well as all contributions that target them recursively.
+     */
+    ContributionQueryOptions[ContributionQueryOptions["IncludeAll"] = 112] = "IncludeAll";
+    /**
+     * Some callers may want the entire tree back without constraint evaluation being performed.
+     */
+    ContributionQueryOptions[ContributionQueryOptions["IgnoreConstraints"] = 256] = "IgnoreConstraints";
+})(ContributionQueryOptions || (ContributionQueryOptions = {}));
+/**
+ * Set of flags applied to extensions that are relevant to contribution consumers
+ */
+export var ExtensionFlags;
+(function (ExtensionFlags) {
+    /**
+     * A built-in extension is installed for all VSTS accounts by default
+     */
+    ExtensionFlags[ExtensionFlags["BuiltIn"] = 1] = "BuiltIn";
+    /**
+     * The extension comes from a fully-trusted publisher
+     */
+    ExtensionFlags[ExtensionFlags["Trusted"] = 2] = "Trusted";
+})(ExtensionFlags || (ExtensionFlags = {}));
+/**
+ * States of an extension Note:  If you add value to this enum, you need to do 2 other things.  First add the back compat enum in value src\\Vssf\\Sdk\\Server\\Contributions\\InstalledExtensionMessage.cs.  Second, you can not send the new value on the message bus.  You need to remove it from the message bus event prior to being sent.
+ */
+export var ExtensionStateFlags;
+(function (ExtensionStateFlags) {
+    /**
+     * No flags set
+     */
+    ExtensionStateFlags[ExtensionStateFlags["None"] = 0] = "None";
+    /**
+     * Extension is disabled
+     */
+    ExtensionStateFlags[ExtensionStateFlags["Disabled"] = 1] = "Disabled";
+    /**
+     * Extension is a built in
+     */
+    ExtensionStateFlags[ExtensionStateFlags["BuiltIn"] = 2] = "BuiltIn";
+    /**
+     * Extension has multiple versions
+     */
+    ExtensionStateFlags[ExtensionStateFlags["MultiVersion"] = 4] = "MultiVersion";
+    /**
+     * Extension is not installed.  This is for builtin extensions only and can not otherwise be set.
+     */
+    ExtensionStateFlags[ExtensionStateFlags["UnInstalled"] = 8] = "UnInstalled";
+    /**
+     * Error performing version check
+     */
+    ExtensionStateFlags[ExtensionStateFlags["VersionCheckError"] = 16] = "VersionCheckError";
+    /**
+     * Trusted extensions are ones that are given special capabilities. These tend to come from Microsoft and can't be published by the general public.  Note: BuiltIn extensions are always trusted.
+     */
+    ExtensionStateFlags[ExtensionStateFlags["Trusted"] = 32] = "Trusted";
+    /**
+     * Extension is currently in an error state
+     */
+    ExtensionStateFlags[ExtensionStateFlags["Error"] = 64] = "Error";
+    /**
+     * Extension scopes have changed and the extension requires re-authorization
+     */
+    ExtensionStateFlags[ExtensionStateFlags["NeedsReauthorization"] = 128] = "NeedsReauthorization";
+    /**
+     * Error performing auto-upgrade. For example, if the new version has demands not supported the extension cannot be auto-upgraded.
+     */
+    ExtensionStateFlags[ExtensionStateFlags["AutoUpgradeError"] = 256] = "AutoUpgradeError";
+    /**
+     * Extension is currently in a warning state, that can cause a degraded experience. The degraded experience can be caused for example by some installation issues detected such as implicit demands not supported.
+     */
+    ExtensionStateFlags[ExtensionStateFlags["Warning"] = 512] = "Warning";
+    /**
+     * Extension is currently unpublished in the marketplace. Extension usage should be reviewed and removed if it is no longer needed
+     */
+    ExtensionStateFlags[ExtensionStateFlags["Unpublished"] = 1024] = "Unpublished";
+})(ExtensionStateFlags || (ExtensionStateFlags = {}));
+/**
+ * Installation issue type (Warning, Error)
+ */
+export var InstalledExtensionStateIssueType;
+(function (InstalledExtensionStateIssueType) {
+    /**
+     * Represents an installation warning, for example an implicit demand not supported
+     */
+    InstalledExtensionStateIssueType[InstalledExtensionStateIssueType["Warning"] = 0] = "Warning";
+    /**
+     * Represents an installation error, for example an explicit demand not supported
+     */
+    InstalledExtensionStateIssueType[InstalledExtensionStateIssueType["Error"] = 1] = "Error";
+})(InstalledExtensionStateIssueType || (InstalledExtensionStateIssueType = {}));

package/esm/Contributions/Contributions.min.js

@@ -0,0 +1 @@
+export var ContributionLicensingBehaviorType;!function(n){n[n.OnlyIfLicensed=0]="OnlyIfLicensed",n[n.OnlyIfUnlicensed=1]="OnlyIfUnlicensed",n[n.AlwaysInclude=2]="AlwaysInclude"}(ContributionLicensingBehaviorType||(ContributionLicensingBehaviorType={}));export var ContributionPropertyType;!function(n){n[n.Unknown=0]="Unknown",n[n.String=1]="String",n[n.Uri=2]="Uri",n[n.Guid=4]="Guid",n[n.Boolean=8]="Boolean",n[n.Integer=16]="Integer",n[n.Double=32]="Double",n[n.DateTime=64]="DateTime",n[n.Dictionary=128]="Dictionary",n[n.Array=256]="Array",n[n.Object=512]="Object"}(ContributionPropertyType||(ContributionPropertyType={}));export var ContributionQueryOptions;!function(n){n[n.None=0]="None",n[n.IncludeSelf=16]="IncludeSelf",n[n.IncludeChildren=32]="IncludeChildren",n[n.IncludeSubTree=96]="IncludeSubTree",n[n.IncludeAll=112]="IncludeAll",n[n.IgnoreConstraints=256]="IgnoreConstraints"}(ContributionQueryOptions||(ContributionQueryOptions={}));export var ExtensionFlags;!function(n){n[n.BuiltIn=1]="BuiltIn",n[n.Trusted=2]="Trusted"}(ExtensionFlags||(ExtensionFlags={}));export var ExtensionStateFlags;!function(n){n[n.None=0]="None",n[n.Disabled=1]="Disabled",n[n.BuiltIn=2]="BuiltIn",n[n.MultiVersion=4]="MultiVersion",n[n.UnInstalled=8]="UnInstalled",n[n.VersionCheckError=16]="VersionCheckError",n[n.Trusted=32]="Trusted",n[n.Error=64]="Error",n[n.NeedsReauthorization=128]="NeedsReauthorization",n[n.AutoUpgradeError=256]="AutoUpgradeError",n[n.Warning=512]="Warning",n[n.Unpublished=1024]="Unpublished"}(ExtensionStateFlags||(ExtensionStateFlags={}));export var InstalledExtensionStateIssueType;!function(n){n[n.Warning=0]="Warning",n[n.Error=1]="Error"}(InstalledExtensionStateIssueType||(InstalledExtensionStateIssueType={}));

package/esm/Contributions/ContributionsClient.js

@@ -0,0 +1,78 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+import { RestClientBase } from "../Common/RestClientBase";
+export class ContributionsRestClient extends RestClientBase {
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Query for contribution nodes and provider details according the parameters in the passed in query object.
+     *
+     * @param query -
+     */
+    async queryContributionNodes(query) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/Contribution/nodes/query",
+            body: query
+        });
+    }
+    /**
+     * @param query -
+     * @param scopeName -
+     * @param scopeValue -
+     */
+    async queryDataProviders(query, scopeName, scopeValue) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/Contribution/dataProviders/query/{scopeName}/{scopeValue}",
+            routeValues: {
+                scopeName: scopeName,
+                scopeValue: scopeValue
+            },
+            body: query
+        });
+    }
+    /**
+     * @param contributionIds -
+     * @param includeDisabledApps -
+     * @param assetTypes -
+     */
+    async getInstalledExtensions(contributionIds, includeDisabledApps, assetTypes) {
+        const queryValues = {
+            contributionIds: contributionIds && contributionIds.join(";"),
+            includeDisabledApps: includeDisabledApps,
+            assetTypes: assetTypes && assetTypes.join(":")
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "_apis/Contribution/InstalledApps/{extensionId}",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * @param publisherName -
+     * @param extensionName -
+     * @param assetTypes -
+     */
+    async getInstalledExtensionByName(publisherName, extensionName, assetTypes) {
+        const queryValues = {
+            assetTypes: assetTypes && assetTypes.join(":")
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.2",
+            routeTemplate: "_apis/Contribution/InstalledApps/{publisherName}/{extensionName}",
+            routeValues: {
+                publisherName: publisherName,
+                extensionName: extensionName
+            },
+            queryParams: queryValues
+        });
+    }
+}
+ContributionsRestClient.RESOURCE_AREA_ID = "8477aec9-a4c7-4bd4-a456-ba4c53c989cb";

package/esm/Contributions/ContributionsClient.min.js

@@ -0,0 +1 @@
+import{RestClientBase}from"../Common/RestClientBase";export class ContributionsRestClient extends RestClientBase{constructor(e){super(e)}async queryContributionNodes(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/Contribution/nodes/query",body:e})}async queryDataProviders(e,s,t){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/Contribution/dataProviders/query/{scopeName}/{scopeValue}",routeValues:{scopeName:s,scopeValue:t},body:e})}async getInstalledExtensions(e,s,t){const n={contributionIds:e&&e.join(";"),includeDisabledApps:s,assetTypes:t&&t.join(":")};return this.beginRequest({apiVersion:"7.2-preview.2",routeTemplate:"_apis/Contribution/InstalledApps/{extensionId}",queryParams:n})}async getInstalledExtensionByName(e,s,t){const n={assetTypes:t&&t.join(":")};return this.beginRequest({apiVersion:"7.2-preview.2",routeTemplate:"_apis/Contribution/InstalledApps/{publisherName}/{extensionName}",routeValues:{publisherName:e,extensionName:s},queryParams:n})}};ContributionsRestClient.RESOURCE_AREA_ID="8477aec9-a4c7-4bd4-a456-ba4c53c989cb";

package/esm/Contributions/index.js

@@ -0,0 +1,2 @@
+export * from "./Contributions";
+export * from "./ContributionsClient";

package/esm/Contributions/index.min.js

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

package/esm/Core/Core.js

@@ -0,0 +1,76 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+export var ConnectedServiceKind;
+(function (ConnectedServiceKind) {
+    /**
+     * Custom or unknown service
+     */
+    ConnectedServiceKind[ConnectedServiceKind["Custom"] = 0] = "Custom";
+    /**
+     * Azure Subscription
+     */
+    ConnectedServiceKind[ConnectedServiceKind["AzureSubscription"] = 1] = "AzureSubscription";
+    /**
+     * Chef Connection
+     */
+    ConnectedServiceKind[ConnectedServiceKind["Chef"] = 2] = "Chef";
+    /**
+     * Generic Connection
+     */
+    ConnectedServiceKind[ConnectedServiceKind["Generic"] = 3] = "Generic";
+})(ConnectedServiceKind || (ConnectedServiceKind = {}));
+/**
+ * Type of process customization on a collection.
+ */
+export var ProcessCustomizationType;
+(function (ProcessCustomizationType) {
+    /**
+     * Process customization can't be computed.
+     */
+    ProcessCustomizationType[ProcessCustomizationType["Unknown"] = -1] = "Unknown";
+    /**
+     * Customization based on project-scoped xml customization
+     */
+    ProcessCustomizationType[ProcessCustomizationType["Xml"] = 0] = "Xml";
+    /**
+     * Customization based on process inheritance
+     */
+    ProcessCustomizationType[ProcessCustomizationType["Inherited"] = 1] = "Inherited";
+})(ProcessCustomizationType || (ProcessCustomizationType = {}));
+export var ProcessType;
+(function (ProcessType) {
+    ProcessType[ProcessType["System"] = 0] = "System";
+    ProcessType[ProcessType["Custom"] = 1] = "Custom";
+    ProcessType[ProcessType["Inherited"] = 2] = "Inherited";
+})(ProcessType || (ProcessType = {}));
+export var ProjectChangeType;
+(function (ProjectChangeType) {
+    ProjectChangeType[ProjectChangeType["Modified"] = 0] = "Modified";
+    ProjectChangeType[ProjectChangeType["Deleted"] = 1] = "Deleted";
+    ProjectChangeType[ProjectChangeType["Added"] = 2] = "Added";
+})(ProjectChangeType || (ProjectChangeType = {}));
+export var ProjectVisibility;
+(function (ProjectVisibility) {
+    ProjectVisibility[ProjectVisibility["Unchanged"] = -1] = "Unchanged";
+    /**
+     * The project is only visible to users with explicit access.
+     */
+    ProjectVisibility[ProjectVisibility["Private"] = 0] = "Private";
+    /**
+     * Enterprise level project visibility
+     */
+    ProjectVisibility[ProjectVisibility["Organization"] = 1] = "Organization";
+    /**
+     * The project is visible to all.
+     */
+    ProjectVisibility[ProjectVisibility["Public"] = 2] = "Public";
+    ProjectVisibility[ProjectVisibility["SystemPrivate"] = 3] = "SystemPrivate";
+})(ProjectVisibility || (ProjectVisibility = {}));
+export var SourceControlTypes;
+(function (SourceControlTypes) {
+    SourceControlTypes[SourceControlTypes["Tfvc"] = 1] = "Tfvc";
+    SourceControlTypes[SourceControlTypes["Git"] = 2] = "Git";
+})(SourceControlTypes || (SourceControlTypes = {}));

package/esm/Core/Core.min.js

@@ -0,0 +1 @@
+export var ConnectedServiceKind;!function(e){e[e.Custom=0]="Custom",e[e.AzureSubscription=1]="AzureSubscription",e[e.Chef=2]="Chef",e[e.Generic=3]="Generic"}(ConnectedServiceKind||(ConnectedServiceKind={}));export var ProcessCustomizationType;!function(e){e[e.Unknown=-1]="Unknown",e[e.Xml=0]="Xml",e[e.Inherited=1]="Inherited"}(ProcessCustomizationType||(ProcessCustomizationType={}));export var ProcessType;!function(e){e[e.System=0]="System",e[e.Custom=1]="Custom",e[e.Inherited=2]="Inherited"}(ProcessType||(ProcessType={}));export var ProjectChangeType;!function(e){e[e.Modified=0]="Modified",e[e.Deleted=1]="Deleted",e[e.Added=2]="Added"}(ProjectChangeType||(ProjectChangeType={}));export var ProjectVisibility;!function(e){e[e.Unchanged=-1]="Unchanged",e[e.Private=0]="Private",e[e.Organization=1]="Organization",e[e.Public=2]="Public",e[e.SystemPrivate=3]="SystemPrivate"}(ProjectVisibility||(ProjectVisibility={}));export var SourceControlTypes;!function(e){e[e.Tfvc=1]="Tfvc",e[e.Git=2]="Git"}(SourceControlTypes||(SourceControlTypes={}));