azure-devops-extension-api 4.248.0 → 4.248.1

package/src/FeatureManagement/FeatureManagement.ts

@@ -1,166 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-/**
- * 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 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/src/FeatureManagement/FeatureManagementClient.ts

@@ -1,246 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-
-import * as FeatureManagement from "../FeatureManagement/FeatureManagement";
-
-export class FeatureManagementRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions) {
-        super(options);
-    }
-
-    /**
-     * Get a specific feature by its id
-     * 
-     * @param featureId - The contribution id of the feature
-     */
-    public async getFeature(
-        featureId: string
-        ): Promise<FeatureManagement.ContributedFeature> {
-
-        return this.beginRequest<FeatureManagement.ContributedFeature>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureManagement/Features/{featureId}",
-            routeValues: {
-                featureId: featureId
-            }
-        });
-    }
-
-    /**
-     * 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.
-     */
-    public async getFeatures(
-        targetContributionId?: string
-        ): Promise<FeatureManagement.ContributedFeature[]> {
-
-        const queryValues: any = {
-            targetContributionId: targetContributionId
-        };
-
-        return this.beginRequest<FeatureManagement.ContributedFeature[]>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureManagement/Features/{featureId}",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * 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.
-     */
-    public async getFeatureState(
-        featureId: string,
-        userScope: string
-        ): Promise<FeatureManagement.ContributedFeatureState> {
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureState>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureManagement/FeatureStates/{userScope}/{featureId}",
-            routeValues: {
-                featureId: featureId,
-                userScope: userScope
-            }
-        });
-    }
-
-    /**
-     * 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
-     */
-    public async setFeatureState(
-        feature: FeatureManagement.ContributedFeatureState,
-        featureId: string,
-        userScope: string,
-        reason?: string,
-        reasonCode?: string
-        ): Promise<FeatureManagement.ContributedFeatureState> {
-
-        const queryValues: any = {
-            reason: reason,
-            reasonCode: reasonCode
-        };
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureState>({
-            apiVersion: "7.2-preview.1",
-            method: "PATCH",
-            routeTemplate: "_apis/FeatureManagement/FeatureStates/{userScope}/{featureId}",
-            routeValues: {
-                featureId: featureId,
-                userScope: userScope
-            },
-            queryParams: queryValues,
-            body: feature
-        });
-    }
-
-    /**
-     * 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)
-     */
-    public async getFeatureStateForScope(
-        featureId: string,
-        userScope: string,
-        scopeName: string,
-        scopeValue: string
-        ): Promise<FeatureManagement.ContributedFeatureState> {
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureState>({
-            apiVersion: "7.2-preview.1",
-            routeTemplate: "_apis/FeatureManagement/FeatureStates/{userScope}/{scopeName}/{scopeValue}/{featureId}",
-            routeValues: {
-                featureId: featureId,
-                userScope: userScope,
-                scopeName: scopeName,
-                scopeValue: scopeValue
-            }
-        });
-    }
-
-    /**
-     * 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
-     */
-    public async setFeatureStateForScope(
-        feature: FeatureManagement.ContributedFeatureState,
-        featureId: string,
-        userScope: string,
-        scopeName: string,
-        scopeValue: string,
-        reason?: string,
-        reasonCode?: string
-        ): Promise<FeatureManagement.ContributedFeatureState> {
-
-        const queryValues: any = {
-            reason: reason,
-            reasonCode: reasonCode
-        };
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureState>({
-            apiVersion: "7.2-preview.1",
-            method: "PATCH",
-            routeTemplate: "_apis/FeatureManagement/FeatureStates/{userScope}/{scopeName}/{scopeValue}/{featureId}",
-            routeValues: {
-                featureId: featureId,
-                userScope: userScope,
-                scopeName: scopeName,
-                scopeValue: scopeValue
-            },
-            queryParams: queryValues,
-            body: feature
-        });
-    }
-
-    /**
-     * Get the effective state for a list of feature ids
-     * 
-     * @param query - Features to query along with current scope values
-     */
-    public async queryFeatureStates(
-        query: FeatureManagement.ContributedFeatureStateQuery
-        ): Promise<FeatureManagement.ContributedFeatureStateQuery> {
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureStateQuery>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/FeatureManagement/FeatureStatesQuery",
-            body: query
-        });
-    }
-
-    /**
-     * Get the states of the specified features for the default scope
-     * 
-     * @param query - Query describing the features to query.
-     * @param userScope - 
-     */
-    public async queryFeatureStatesForDefaultScope(
-        query: FeatureManagement.ContributedFeatureStateQuery,
-        userScope: string
-        ): Promise<FeatureManagement.ContributedFeatureStateQuery> {
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureStateQuery>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/FeatureManagement/FeatureStatesQuery/{userScope}",
-            routeValues: {
-                userScope: userScope
-            },
-            body: query
-        });
-    }
-
-    /**
-     * 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 - 
-     */
-    public async queryFeatureStatesForNamedScope(
-        query: FeatureManagement.ContributedFeatureStateQuery,
-        userScope: string,
-        scopeName: string,
-        scopeValue: string
-        ): Promise<FeatureManagement.ContributedFeatureStateQuery> {
-
-        return this.beginRequest<FeatureManagement.ContributedFeatureStateQuery>({
-            apiVersion: "7.2-preview.1",
-            method: "POST",
-            routeTemplate: "_apis/FeatureManagement/FeatureStatesQuery/{userScope}/{scopeName}/{scopeValue}",
-            routeValues: {
-                userScope: userScope,
-                scopeName: scopeName,
-                scopeValue: scopeValue
-            },
-            body: query
-        });
-    }
-
-}

package/src/FeatureManagement/index.ts

@@ -1,2 +0,0 @@
-export * from "./FeatureManagement";
-export * from "./FeatureManagementClient";

package/src/FileContainer/FileContainer.ts

@@ -1,205 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-/**
- * Compression type for file stored in Blobstore
- */
-export enum BlobCompressionType {
-    None = 0,
-    GZip = 1
-}
-
-/**
- * Represents an reference to a file in Blobstore
- */
-export interface ContainerItemBlobReference {
-    artifactHash: string;
-    artifactId: number;
-    compressionType: BlobCompressionType;
-    scopeIdentifier: string;
-    sessionId: string;
-}
-
-/**
- * Status of a container item.
- */
-export enum ContainerItemStatus {
-    /**
-     * Item is created.
-     */
-    Created = 1,
-    /**
-     * Item is a file pending for upload.
-     */
-    PendingUpload = 2
-}
-
-/**
- * Type of a container item.
- */
-export enum ContainerItemType {
-    /**
-     * Any item type.
-     */
-    Any = 0,
-    /**
-     * Item is a folder which can have child items.
-     */
-    Folder = 1,
-    /**
-     * Item is a file which is stored in the file service.
-     */
-    File = 2
-}
-
-/**
- * Options a container can have.
- */
-export enum ContainerOptions {
-    /**
-     * No option.
-     */
-    None = 0
-}
-
-/**
- * Represents a container that encapsulates a hierarchical file system.
- */
-export interface FileContainer {
-    /**
-     * Uri of the artifact associated with the container.
-     */
-    artifactUri: string;
-    /**
-     * Download Url for the content of this item.
-     */
-    contentLocation: string;
-    /**
-     * Owner.
-     */
-    createdBy: string;
-    /**
-     * Creation date.
-     */
-    dateCreated: Date;
-    /**
-     * Description.
-     */
-    description: string;
-    /**
-     * Id.
-     */
-    id: number;
-    /**
-     * Location of the item resource.
-     */
-    itemLocation: string;
-    /**
-     * ItemStore Locator for this container.
-     */
-    locatorPath: string;
-    /**
-     * Name.
-     */
-    name: string;
-    /**
-     * Options the container can have.
-     */
-    options: ContainerOptions;
-    /**
-     * Project Id.
-     */
-    scopeIdentifier: string;
-    /**
-     * Security token of the artifact associated with the container.
-     */
-    securityToken: string;
-    /**
-     * Identifier of the optional encryption key.
-     */
-    signingKeyId: string;
-    /**
-     * Total size of the files in bytes.
-     */
-    size: number;
-}
-
-/**
- * Represents an item in a container.
- */
-export interface FileContainerItem {
-    /**
-     * Id for Blobstore reference
-     */
-    artifactId: number;
-    blobMetadata: ContainerItemBlobReference;
-    /**
-     * Container Id.
-     */
-    containerId: number;
-    contentId: number[];
-    /**
-     * Download Url for the content of this item.
-     */
-    contentLocation: string;
-    /**
-     * Creator.
-     */
-    createdBy: string;
-    /**
-     * Creation date.
-     */
-    dateCreated: Date;
-    /**
-     * Last modified date.
-     */
-    dateLastModified: Date;
-    /**
-     * Encoding of the file. Zero if not a file.
-     */
-    fileEncoding: number;
-    /**
-     * Hash value of the file. Null if not a file.
-     */
-    fileHash: number[];
-    /**
-     * Id of the file content.
-     */
-    fileId: number;
-    /**
-     * Length of the file. Zero if not of a file.
-     */
-    fileLength: number;
-    /**
-     * Type of the file. Zero if not a file.
-     */
-    fileType: number;
-    /**
-     * Location of the item resource.
-     */
-    itemLocation: string;
-    /**
-     * Type of the item: Folder, File or String.
-     */
-    itemType: ContainerItemType;
-    /**
-     * Modifier.
-     */
-    lastModifiedBy: string;
-    /**
-     * Unique path that identifies the item.
-     */
-    path: string;
-    /**
-     * Project Id.
-     */
-    scopeIdentifier: string;
-    /**
-     * Status of the item: Created or Pending Upload.
-     */
-    status: ContainerItemStatus;
-    ticket: string;
-}