azure-devops-extension-api 4.270.0 → 5.272.0

package/FeatureManagement/FeatureManagement.d.ts

@@ -1,161 +1,161 @@
-/**
- * A feature that can be enabled or disabled
- */
-export interface ContributedFeature {
-    /**
-     * Named links describing the feature
-     */
-    _links: any;
-    /**
-     * If true, the feature is enabled unless overridden at some scope
-     */
-    defaultState: boolean;
-    /**
-     * Rules for setting the default value if not specified by any setting/scope. Evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)
-     */
-    defaultValueRules: ContributedFeatureValueRule[];
-    /**
-     * The description of the feature
-     */
-    description: string;
-    /**
-     * Extra properties for the feature
-     */
-    featureProperties: {
-        [key: string]: any;
-    };
-    /**
-     * Handler for listening to setter calls on feature value. These listeners are only invoked after a successful set has occurred
-     */
-    featureStateChangedListeners: ContributedFeatureListener[];
-    /**
-     * The full contribution id of the feature
-     */
-    id: string;
-    /**
-     * If this is set to true, then the id for this feature will be added to the list of claims for the request.
-     */
-    includeAsClaim: boolean;
-    /**
-     * The friendly name of the feature
-     */
-    name: string;
-    /**
-     * Suggested order to display feature in.
-     */
-    order: number;
-    /**
-     * Rules for overriding a feature value. These rules are run before explicit user/host state values are checked. They are evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)
-     */
-    overrideRules: ContributedFeatureValueRule[];
-    /**
-     * The scopes/levels at which settings can set the enabled/disabled state of this feature
-     */
-    scopes: ContributedFeatureSettingScope[];
-    /**
-     * The service instance id of the service that owns this feature
-     */
-    serviceInstanceType: string;
-    /**
-     * Tags associated with the feature.
-     */
-    tags: string[];
-}
-/**
- * The current state of a feature within a given scope
- */
-export declare enum ContributedFeatureEnabledValue {
-    /**
-     * The state of the feature is not set for the specified scope
-     */
-    Undefined = -1,
-    /**
-     * The feature is disabled at the specified scope
-     */
-    Disabled = 0,
-    /**
-     * The feature is enabled at the specified scope
-     */
-    Enabled = 1
-}
-export interface ContributedFeatureHandlerSettings {
-    /**
-     * Name of the handler to run
-     */
-    name: string;
-    /**
-     * Properties to feed to the handler
-     */
-    properties: {
-        [key: string]: any;
-    };
-}
-/**
- * An identifier and properties used to pass into a handler for a listener or plugin
- */
-export interface ContributedFeatureListener extends ContributedFeatureHandlerSettings {
-}
-/**
- * The scope to which a feature setting applies
- */
-export interface ContributedFeatureSettingScope {
-    /**
-     * The name of the settings scope to use when reading/writing the setting
-     */
-    settingScope: string;
-    /**
-     * Whether this is a user-scope or this is a host-wide (all users) setting
-     */
-    userScoped: boolean;
-}
-/**
- * A contributed feature/state pair
- */
-export interface ContributedFeatureState {
-    /**
-     * The full contribution id of the feature
-     */
-    featureId: string;
-    /**
-     * True if the effective state was set by an override rule (indicating that the state cannot be managed by the end user)
-     */
-    overridden: boolean;
-    /**
-     * Reason that the state was set (by a plugin/rule).
-     */
-    reason: string;
-    /**
-     * The scope at which this state applies
-     */
-    scope: ContributedFeatureSettingScope;
-    /**
-     * The current state of this feature
-     */
-    state: ContributedFeatureEnabledValue;
-}
-/**
- * A query for the effective contributed feature states for a list of feature ids
- */
-export interface ContributedFeatureStateQuery {
-    /**
-     * The list of feature ids to query
-     */
-    featureIds: string[];
-    /**
-     * The query result containing the current feature states for each of the queried feature ids
-     */
-    featureStates: {
-        [key: string]: ContributedFeatureState;
-    };
-    /**
-     * A dictionary of scope values (project name, etc.) to use in the query (if querying across scopes)
-     */
-    scopeValues: {
-        [key: string]: string;
-    };
-}
-/**
- * A rule for dynamically getting the enabled/disabled state of a feature
- */
-export interface ContributedFeatureValueRule extends ContributedFeatureHandlerSettings {
-}
+/**
+ * A feature that can be enabled or disabled
+ */
+export interface ContributedFeature {
+    /**
+     * Named links describing the feature
+     */
+    _links: any;
+    /**
+     * If true, the feature is enabled unless overridden at some scope
+     */
+    defaultState: boolean;
+    /**
+     * Rules for setting the default value if not specified by any setting/scope. Evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)
+     */
+    defaultValueRules: ContributedFeatureValueRule[];
+    /**
+     * The description of the feature
+     */
+    description: string;
+    /**
+     * Extra properties for the feature
+     */
+    featureProperties: {
+        [key: string]: any;
+    };
+    /**
+     * Handler for listening to setter calls on feature value. These listeners are only invoked after a successful set has occurred
+     */
+    featureStateChangedListeners: ContributedFeatureListener[];
+    /**
+     * The full contribution id of the feature
+     */
+    id: string;
+    /**
+     * If this is set to true, then the id for this feature will be added to the list of claims for the request.
+     */
+    includeAsClaim: boolean;
+    /**
+     * The friendly name of the feature
+     */
+    name: string;
+    /**
+     * Suggested order to display feature in.
+     */
+    order: number;
+    /**
+     * Rules for overriding a feature value. These rules are run before explicit user/host state values are checked. They are evaluated in order until a rule returns an Enabled or Disabled state (not Undefined)
+     */
+    overrideRules: ContributedFeatureValueRule[];
+    /**
+     * The scopes/levels at which settings can set the enabled/disabled state of this feature
+     */
+    scopes: ContributedFeatureSettingScope[];
+    /**
+     * The service instance id of the service that owns this feature
+     */
+    serviceInstanceType: string;
+    /**
+     * Tags associated with the feature.
+     */
+    tags: string[];
+}
+/**
+ * The current state of a feature within a given scope
+ */
+export declare enum ContributedFeatureEnabledValue {
+    /**
+     * The state of the feature is not set for the specified scope
+     */
+    Undefined = -1,
+    /**
+     * The feature is disabled at the specified scope
+     */
+    Disabled = 0,
+    /**
+     * The feature is enabled at the specified scope
+     */
+    Enabled = 1
+}
+export interface ContributedFeatureHandlerSettings {
+    /**
+     * Name of the handler to run
+     */
+    name: string;
+    /**
+     * Properties to feed to the handler
+     */
+    properties: {
+        [key: string]: any;
+    };
+}
+/**
+ * An identifier and properties used to pass into a handler for a listener or plugin
+ */
+export interface ContributedFeatureListener extends ContributedFeatureHandlerSettings {
+}
+/**
+ * The scope to which a feature setting applies
+ */
+export interface ContributedFeatureSettingScope {
+    /**
+     * The name of the settings scope to use when reading/writing the setting
+     */
+    settingScope: string;
+    /**
+     * Whether this is a user-scope or this is a host-wide (all users) setting
+     */
+    userScoped: boolean;
+}
+/**
+ * A contributed feature/state pair
+ */
+export interface ContributedFeatureState {
+    /**
+     * The full contribution id of the feature
+     */
+    featureId: string;
+    /**
+     * True if the effective state was set by an override rule (indicating that the state cannot be managed by the end user)
+     */
+    overridden: boolean;
+    /**
+     * Reason that the state was set (by a plugin/rule).
+     */
+    reason: string;
+    /**
+     * The scope at which this state applies
+     */
+    scope: ContributedFeatureSettingScope;
+    /**
+     * The current state of this feature
+     */
+    state: ContributedFeatureEnabledValue;
+}
+/**
+ * A query for the effective contributed feature states for a list of feature ids
+ */
+export interface ContributedFeatureStateQuery {
+    /**
+     * The list of feature ids to query
+     */
+    featureIds: string[];
+    /**
+     * The query result containing the current feature states for each of the queried feature ids
+     */
+    featureStates: {
+        [key: string]: ContributedFeatureState;
+    };
+    /**
+     * A dictionary of scope values (project name, etc.) to use in the query (if querying across scopes)
+     */
+    scopeValues: {
+        [key: string]: string;
+    };
+}
+/**
+ * A rule for dynamically getting the enabled/disabled state of a feature
+ */
+export interface ContributedFeatureValueRule extends ContributedFeatureHandlerSettings {
+}

package/FeatureManagement/FeatureManagement.js

@@ -1,27 +1,26 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-define(["require", "exports"], function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    /**
-     * The current state of a feature within a given scope
-     */
-    var ContributedFeatureEnabledValue;
-    (function (ContributedFeatureEnabledValue) {
-        /**
-         * The state of the feature is not set for the specified scope
-         */
-        ContributedFeatureEnabledValue[ContributedFeatureEnabledValue["Undefined"] = -1] = "Undefined";
-        /**
-         * The feature is disabled at the specified scope
-         */
-        ContributedFeatureEnabledValue[ContributedFeatureEnabledValue["Disabled"] = 0] = "Disabled";
-        /**
-         * The feature is enabled at the specified scope
-         */
-        ContributedFeatureEnabledValue[ContributedFeatureEnabledValue["Enabled"] = 1] = "Enabled";
-    })(ContributedFeatureEnabledValue = exports.ContributedFeatureEnabledValue || (exports.ContributedFeatureEnabledValue = {}));
-});
+"use strict";
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContributedFeatureEnabledValue = void 0;
+/**
+ * The current state of a feature within a given scope
+ */
+var ContributedFeatureEnabledValue;
+(function (ContributedFeatureEnabledValue) {
+    /**
+     * The state of the feature is not set for the specified scope
+     */
+    ContributedFeatureEnabledValue[ContributedFeatureEnabledValue["Undefined"] = -1] = "Undefined";
+    /**
+     * The feature is disabled at the specified scope
+     */
+    ContributedFeatureEnabledValue[ContributedFeatureEnabledValue["Disabled"] = 0] = "Disabled";
+    /**
+     * The feature is enabled at the specified scope
+     */
+    ContributedFeatureEnabledValue[ContributedFeatureEnabledValue["Enabled"] = 1] = "Enabled";
+})(ContributedFeatureEnabledValue || (exports.ContributedFeatureEnabledValue = ContributedFeatureEnabledValue = {}));

package/FeatureManagement/FeatureManagement.min.js

@@ -1 +1 @@
-define(["require","exports"],function(e,n){"use strict";Object.defineProperty(n,"__esModule",{value:!0});!function(e){e[e.Undefined=-1]="Undefined",e[e.Disabled=0]="Disabled",e[e.Enabled=1]="Enabled"}(n.ContributedFeatureEnabledValue||(n.ContributedFeatureEnabledValue={}))});
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ContributedFeatureEnabledValue=void 0;var ContributedFeatureEnabledValue;!function(e){e[e.Undefined=-1]="Undefined",e[e.Disabled=0]="Disabled",e[e.Enabled=1]="Enabled"}(ContributedFeatureEnabledValue||(exports.ContributedFeatureEnabledValue=ContributedFeatureEnabledValue={}));

package/FeatureManagement/FeatureManagementClient.d.ts

@@ -1,78 +1,78 @@
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-import * as FeatureManagement from "../FeatureManagement/FeatureManagement";
-export declare class FeatureManagementRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions);
-    /**
-     * Get a specific feature by its id
-     *
-     * @param featureId - The contribution id of the feature
-     */
-    getFeature(featureId: string): Promise<FeatureManagement.ContributedFeature>;
-    /**
-     * Get a list of all defined features
-     *
-     * @param targetContributionId - Optional target contribution. If null/empty, return all features. If specified include the features that target the specified contribution.
-     */
-    getFeatures(targetContributionId?: string): Promise<FeatureManagement.ContributedFeature[]>;
-    /**
-     * Get the state of the specified feature for the given user/all-users scope
-     *
-     * @param featureId - Contribution id of the feature
-     * @param userScope - User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
-     */
-    getFeatureState(featureId: string, userScope: string): Promise<FeatureManagement.ContributedFeatureState>;
-    /**
-     * Set the state of a feature
-     *
-     * @param feature - Posted feature state object. Should specify the effective value.
-     * @param featureId - Contribution id of the feature
-     * @param userScope - User-Scope at which to set the value. Should be "me" for the current user or "host" for all users.
-     * @param reason - Reason for changing the state
-     * @param reasonCode - Short reason code
-     */
-    setFeatureState(feature: FeatureManagement.ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<FeatureManagement.ContributedFeatureState>;
-    /**
-     * Get the state of the specified feature for the given named scope
-     *
-     * @param featureId - Contribution id of the feature
-     * @param userScope - User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
-     * @param scopeName - Scope at which to get the feature setting for (e.g. "project" or "team")
-     * @param scopeValue - Value of the scope (e.g. the project or team id)
-     */
-    getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<FeatureManagement.ContributedFeatureState>;
-    /**
-     * Set the state of a feature at a specific scope
-     *
-     * @param feature - Posted feature state object. Should specify the effective value.
-     * @param featureId - Contribution id of the feature
-     * @param userScope - User-Scope at which to set the value. Should be "me" for the current user or "host" for all users.
-     * @param scopeName - Scope at which to get the feature setting for (e.g. "project" or "team")
-     * @param scopeValue - Value of the scope (e.g. the project or team id)
-     * @param reason - Reason for changing the state
-     * @param reasonCode - Short reason code
-     */
-    setFeatureStateForScope(feature: FeatureManagement.ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<FeatureManagement.ContributedFeatureState>;
-    /**
-     * Get the effective state for a list of feature ids
-     *
-     * @param query - Features to query along with current scope values
-     */
-    queryFeatureStates(query: FeatureManagement.ContributedFeatureStateQuery): Promise<FeatureManagement.ContributedFeatureStateQuery>;
-    /**
-     * Get the states of the specified features for the default scope
-     *
-     * @param query - Query describing the features to query.
-     * @param userScope -
-     */
-    queryFeatureStatesForDefaultScope(query: FeatureManagement.ContributedFeatureStateQuery, userScope: string): Promise<FeatureManagement.ContributedFeatureStateQuery>;
-    /**
-     * Get the states of the specified features for the specific named scope
-     *
-     * @param query - Query describing the features to query.
-     * @param userScope -
-     * @param scopeName -
-     * @param scopeValue -
-     */
-    queryFeatureStatesForNamedScope(query: FeatureManagement.ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<FeatureManagement.ContributedFeatureStateQuery>;
-}
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+import * as FeatureManagement from "../FeatureManagement/FeatureManagement";
+export declare class FeatureManagementRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions);
+    /**
+     * Get a specific feature by its id
+     *
+     * @param featureId - The contribution id of the feature
+     */
+    getFeature(featureId: string): Promise<FeatureManagement.ContributedFeature>;
+    /**
+     * Get a list of all defined features
+     *
+     * @param targetContributionId - Optional target contribution. If null/empty, return all features. If specified include the features that target the specified contribution.
+     */
+    getFeatures(targetContributionId?: string): Promise<FeatureManagement.ContributedFeature[]>;
+    /**
+     * Get the state of the specified feature for the given user/all-users scope
+     *
+     * @param featureId - Contribution id of the feature
+     * @param userScope - User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
+     */
+    getFeatureState(featureId: string, userScope: string): Promise<FeatureManagement.ContributedFeatureState>;
+    /**
+     * Set the state of a feature
+     *
+     * @param feature - Posted feature state object. Should specify the effective value.
+     * @param featureId - Contribution id of the feature
+     * @param userScope - User-Scope at which to set the value. Should be "me" for the current user or "host" for all users.
+     * @param reason - Reason for changing the state
+     * @param reasonCode - Short reason code
+     */
+    setFeatureState(feature: FeatureManagement.ContributedFeatureState, featureId: string, userScope: string, reason?: string, reasonCode?: string): Promise<FeatureManagement.ContributedFeatureState>;
+    /**
+     * Get the state of the specified feature for the given named scope
+     *
+     * @param featureId - Contribution id of the feature
+     * @param userScope - User-Scope at which to get the value. Should be "me" for the current user or "host" for all users.
+     * @param scopeName - Scope at which to get the feature setting for (e.g. "project" or "team")
+     * @param scopeValue - Value of the scope (e.g. the project or team id)
+     */
+    getFeatureStateForScope(featureId: string, userScope: string, scopeName: string, scopeValue: string): Promise<FeatureManagement.ContributedFeatureState>;
+    /**
+     * Set the state of a feature at a specific scope
+     *
+     * @param feature - Posted feature state object. Should specify the effective value.
+     * @param featureId - Contribution id of the feature
+     * @param userScope - User-Scope at which to set the value. Should be "me" for the current user or "host" for all users.
+     * @param scopeName - Scope at which to get the feature setting for (e.g. "project" or "team")
+     * @param scopeValue - Value of the scope (e.g. the project or team id)
+     * @param reason - Reason for changing the state
+     * @param reasonCode - Short reason code
+     */
+    setFeatureStateForScope(feature: FeatureManagement.ContributedFeatureState, featureId: string, userScope: string, scopeName: string, scopeValue: string, reason?: string, reasonCode?: string): Promise<FeatureManagement.ContributedFeatureState>;
+    /**
+     * Get the effective state for a list of feature ids
+     *
+     * @param query - Features to query along with current scope values
+     */
+    queryFeatureStates(query: FeatureManagement.ContributedFeatureStateQuery): Promise<FeatureManagement.ContributedFeatureStateQuery>;
+    /**
+     * Get the states of the specified features for the default scope
+     *
+     * @param query - Query describing the features to query.
+     * @param userScope -
+     */
+    queryFeatureStatesForDefaultScope(query: FeatureManagement.ContributedFeatureStateQuery, userScope: string): Promise<FeatureManagement.ContributedFeatureStateQuery>;
+    /**
+     * Get the states of the specified features for the specific named scope
+     *
+     * @param query - Query describing the features to query.
+     * @param userScope -
+     * @param scopeName -
+     * @param scopeValue -
+     */
+    queryFeatureStatesForNamedScope(query: FeatureManagement.ContributedFeatureStateQuery, userScope: string, scopeName: string, scopeValue: string): Promise<FeatureManagement.ContributedFeatureStateQuery>;
+}