azure-devops-extension-api 4.247.0 → 4.248.1

package/src/FileContainer/FileContainerClient.ts

@@ -1,154 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "../Common/Context";
-import { RestClientBase } from "../Common/RestClientBase";
-
-import * as FileContainer from "../FileContainer/FileContainer";
-import * as WebApi from "../WebApi/WebApi";
-
-export class FileContainerRestClient extends RestClientBase {
-    constructor(options: IVssRestClientOptions) {
-        super(options);
-    }
-
-    /**
-     * Creates the specified items in the referenced container.
-     * 
-     * @param items - 
-     * @param containerId - 
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     */
-    public async createItems(
-        items: WebApi.VssJsonCollectionWrapperV<FileContainer.FileContainerItem[]>,
-        containerId: number,
-        scope?: string
-        ): Promise<FileContainer.FileContainerItem[]> {
-
-        const queryValues: any = {
-            scope: scope
-        };
-
-        return this.beginRequest<FileContainer.FileContainerItem[]>({
-            apiVersion: "7.2-preview.4",
-            method: "POST",
-            routeTemplate: "_apis/resources/Containers/{containerId}/{*itemPath}",
-            routeValues: {
-                containerId: containerId
-            },
-            queryParams: queryValues,
-            body: items
-        });
-    }
-
-    /**
-     * Deletes the specified items in a container.
-     * 
-     * @param containerId - Container Id.
-     * @param itemPath - Path to delete.
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     */
-    public async deleteItem(
-        containerId: number,
-        itemPath: string,
-        scope?: string
-        ): Promise<void> {
-
-        const queryValues: any = {
-            itemPath: itemPath,
-            scope: scope
-        };
-
-        return this.beginRequest<void>({
-            apiVersion: "7.2-preview.4",
-            method: "DELETE",
-            routeTemplate: "_apis/resources/Containers/{containerId}/{*itemPath}",
-            routeValues: {
-                containerId: containerId
-            },
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Gets containers filtered by a comma separated list of artifact uris within the same scope, if not specified returns all containers
-     * 
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     * @param artifactUris - 
-     */
-    public async getContainers(
-        scope?: string,
-        artifactUris?: string
-        ): Promise<FileContainer.FileContainer[]> {
-
-        const queryValues: any = {
-            scope: scope,
-            artifactUris: artifactUris
-        };
-
-        return this.beginRequest<FileContainer.FileContainer[]>({
-            apiVersion: "7.2-preview.4",
-            routeTemplate: "_apis/resources/Containers/{containerId}/{*itemPath}",
-            queryParams: queryValues
-        });
-    }
-
-    /**
-     * Gets the specified file container object in a format dependent upon the given parameters or HTTP Accept request header
-     * 
-     * @param containerId - The requested container Id
-     * @param scope - A guid representing the scope of the container. This is often the project id.
-     * @param itemPath - The path to the item of interest
-     * @param metadata - If true, this overrides any specified format parameter or HTTP Accept request header to provide non-recursive information for the given itemPath
-     * @param format - If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'.  If $format is specified, then api-version should also be specified as a query parameter.
-     * @param downloadFileName - If specified and returning other than JSON format, then this download name will be used (else defaults to itemPath)
-     * @param includeDownloadTickets - 
-     * @param isShallow - If true, returns only immediate children(files & folders) for the given itemPath. False will return all items recursively within itemPath.
-     * @param ignoreRequestedMediaType - Set to true to ignore the HTTP Accept request header. Default is false.
-     * @param includeBlobMetadata - 
-     * @param saveAbsolutePath - Set to false to not save the absolute path to the specified directory of the artifact in the returned archive. Works only for artifact directories. Default is true.
-     * @param preferRedirect - Set to true to get the redirect response which leads to the stream with content. Default is false.
-     */
-    public async getItems(
-        containerId: number,
-        scope?: string,
-        itemPath?: string,
-        metadata?: boolean,
-        format?: string,
-        downloadFileName?: string,
-        includeDownloadTickets?: boolean,
-        isShallow?: boolean,
-        ignoreRequestedMediaType?: boolean,
-        includeBlobMetadata?: boolean,
-        saveAbsolutePath?: boolean,
-        preferRedirect?: boolean
-        ): Promise<FileContainer.FileContainerItem[]> {
-
-        const queryValues: any = {
-            scope: scope,
-            itemPath: itemPath,
-            metadata: metadata,
-            '$format': format,
-            downloadFileName: downloadFileName,
-            includeDownloadTickets: includeDownloadTickets,
-            isShallow: isShallow,
-            ignoreRequestedMediaType: ignoreRequestedMediaType,
-            includeBlobMetadata: includeBlobMetadata,
-            saveAbsolutePath: saveAbsolutePath,
-            preferRedirect: preferRedirect
-        };
-
-        return this.beginRequest<FileContainer.FileContainerItem[]>({
-            apiVersion: "7.2-preview.4",
-            routeTemplate: "_apis/resources/Containers/{containerId}/{*itemPath}",
-            routeValues: {
-                containerId: containerId
-            },
-            queryParams: queryValues
-        });
-    }
-
-}

package/src/FileContainer/index.ts

@@ -1,2 +0,0 @@
-export * from "./FileContainer";
-export * from "./FileContainerClient";

package/src/FormInput/FormInput.ts

@@ -1,288 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-/**
- * Enumerates data types that are supported as subscription input values.
- */
-export enum InputDataType {
-    /**
-     * No data type is specified.
-     */
-    None = 0,
-    /**
-     * Represents a textual value.
-     */
-    String = 10,
-    /**
-     * Represents a numeric value.
-     */
-    Number = 20,
-    /**
-     * Represents a value of true or false.
-     */
-    Boolean = 30,
-    /**
-     * Represents a Guid.
-     */
-    Guid = 40,
-    /**
-     * Represents a URI.
-     */
-    Uri = 50
-}
-
-/**
- * Describes an input for subscriptions.
- */
-export interface InputDescriptor {
-    /**
-     * The ids of all inputs that the value of this input is dependent on.
-     */
-    dependencyInputIds: string[];
-    /**
-     * Description of what this input is used for
-     */
-    description: string;
-    /**
-     * The group localized name to which this input belongs and can be shown as a header for the container that will include all the inputs in the group.
-     */
-    groupName: string;
-    /**
-     * If true, the value information for this input is dynamic and should be fetched when the value of dependency inputs change.
-     */
-    hasDynamicValueInformation: boolean;
-    /**
-     * Identifier for the subscription input
-     */
-    id: string;
-    /**
-     * Mode in which the value of this input should be entered
-     */
-    inputMode: InputMode;
-    /**
-     * Gets whether this input is confidential, such as for a password or application key
-     */
-    isConfidential: boolean;
-    /**
-     * Localized name which can be shown as a label for the subscription input
-     */
-    name: string;
-    /**
-     * Custom properties for the input which can be used by the service provider
-     */
-    properties: { [key: string] : any; };
-    /**
-     * Underlying data type for the input value. When this value is specified, InputMode, Validation and Values are optional.
-     */
-    type: string;
-    /**
-     * Gets whether this input is included in the default generated action description.
-     */
-    useInDefaultDescription: boolean;
-    /**
-     * Information to use to validate this input's value
-     */
-    validation: InputValidation;
-    /**
-     * A hint for input value. It can be used in the UI as the input placeholder.
-     */
-    valueHint: string;
-    /**
-     * Information about possible values for this input
-     */
-    values: InputValues;
-}
-
-/**
- * Defines a filter for subscription inputs. The filter matches a set of inputs if any (one or more) of the groups evaluates to true.
- */
-export interface InputFilter {
-    /**
-     * Groups of input filter expressions. This filter matches a set of inputs if any (one or more) of the groups evaluates to true.
-     */
-    conditions: InputFilterCondition[];
-}
-
-/**
- * An expression which can be applied to filter a list of subscription inputs
- */
-export interface InputFilterCondition {
-    /**
-     * Whether or not to do a case sensitive match
-     */
-    caseSensitive: boolean;
-    /**
-     * The Id of the input to filter on
-     */
-    inputId: string;
-    /**
-     * The "expected" input value to compare with the actual input value
-     */
-    inputValue: string;
-    /**
-     * The operator applied between the expected and actual input value
-     */
-    operator: InputFilterOperator;
-}
-
-export enum InputFilterOperator {
-    Equals = 0,
-    NotEquals = 1
-}
-
-/**
- * Mode in which a subscription input should be entered (in a UI)
- */
-export enum InputMode {
-    /**
-     * This input should not be shown in the UI
-     */
-    None = 0,
-    /**
-     * An input text box should be shown
-     */
-    TextBox = 10,
-    /**
-     * An password input box should be shown
-     */
-    PasswordBox = 20,
-    /**
-     * A select/combo control should be shown
-     */
-    Combo = 30,
-    /**
-     * Radio buttons should be shown
-     */
-    RadioButtons = 40,
-    /**
-     * Checkbox should be shown(for true/false values)
-     */
-    CheckBox = 50,
-    /**
-     * A multi-line text area should be shown
-     */
-    TextArea = 60
-}
-
-/**
- * Describes what values are valid for a subscription input
- */
-export interface InputValidation {
-    /**
-     * Gets or sets the data type to validate.
-     */
-    dataType: InputDataType;
-    /**
-     * Gets or sets if this is a required field.
-     */
-    isRequired: boolean;
-    /**
-     * Gets or sets the maximum length of this descriptor.
-     */
-    maxLength: number;
-    /**
-     * Gets or sets the minimum value for this descriptor.
-     */
-    maxValue: number;
-    /**
-     * Gets or sets the minimum length of this descriptor.
-     */
-    minLength: number;
-    /**
-     * Gets or sets the minimum value for this descriptor.
-     */
-    minValue: number;
-    /**
-     * Gets or sets the pattern to validate.
-     */
-    pattern: string;
-    /**
-     * Gets or sets the error on pattern mismatch.
-     */
-    patternMismatchErrorMessage: string;
-    /**
-     * Gets or sets the warning on pattern mismatch.
-     */
-    patternMismatchWarningMessage: string;
-    /**
-     * Gets or sets the pattern to validate.
-     */
-    warningPattern: string;
-}
-
-/**
- * Information about a single value for an input
- */
-export interface InputValue {
-    /**
-     * Any other data about this input
-     */
-    data: { [key: string] : any; };
-    /**
-     * The text to show for the display of this value
-     */
-    displayValue: string;
-    /**
-     * The value to store for this input
-     */
-    value: string;
-}
-
-/**
- * Information about the possible/allowed values for a given subscription input
- */
-export interface InputValues {
-    /**
-     * The default value to use for this input
-     */
-    defaultValue: string;
-    /**
-     * Errors encountered while computing dynamic values.
-     */
-    error: InputValuesError;
-    /**
-     * The id of the input
-     */
-    inputId: string;
-    /**
-     * Should this input be disabled
-     */
-    isDisabled: boolean;
-    /**
-     * Should the value be restricted to one of the values in the PossibleValues (True) or are the values in PossibleValues just a suggestion (False)
-     */
-    isLimitedToPossibleValues: boolean;
-    /**
-     * Should this input be made read-only
-     */
-    isReadOnly: boolean;
-    /**
-     * Possible values that this input can take
-     */
-    possibleValues: InputValue[];
-}
-
-/**
- * Error information related to a subscription input value.
- */
-export interface InputValuesError {
-    /**
-     * The error message.
-     */
-    message: string;
-}
-
-export interface InputValuesQuery {
-    currentValues: { [key: string] : string; };
-    /**
-     * The input values to return on input, and the result from the consumer on output.
-     */
-    inputValues: InputValues[];
-    /**
-     * Subscription containing information about the publisher/consumer and the current input values
-     */
-    resource: any;
-}

package/src/FormInput/index.ts

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