azure-devops-extension-api 4.248.0 → 4.250.0

package/src/Common/Context.d.ts

@@ -1,46 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-/**
- * Interface for a class that can retrieve authorization tokens to be used in fetch requests.
- */
-export interface IAuthorizationTokenProvider {
-    /**
-     * Gets the authorization header to use in a fetch request
-     *
-     * @param forceRefresh - If true, indicates that we should get a new token, if applicable for current provider.
-     * @returns the value to use for the Authorization header in a request.
-     */
-    getAuthorizationHeader(forceRefresh?: boolean): Promise<string>;
-}
-
-/**
- * Options for a specific instance of a REST client.
- */
-export interface IVssRestClientOptions {
-
-    /**
-    * Auth token manager that can be used to get and attach auth tokens to requests.
-    * If not supplied, the default token provider is used if the serviceInstanceType option is supplied
-    * and is different from the hosting page's service instance type.
-    */
-    authTokenProvider?: IAuthorizationTokenProvider;
-
-    /**
-     * The root URL path to use for this client. Can be relative or absolute.
-     */
-    rootPath?: string | Promise<string>;
-
-    /**
-     * Current session id.
-     */
-    sessionId?: string;
-
-    /**
-     * Current command for activity logging.
-     */
-    command?: string;
-}

package/src/Common/Fetch.ts

@@ -1,239 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-// Fetch polyfill for IE11
-import "whatwg-fetch";
-
-import { IAuthorizationTokenProvider } from "./Context";
-
-/**
-* VSS-specific options for VSS requests
-*/
-export interface IVssRequestOptions {
-
-    /*
-    * Auth token manager that can be used to get and attach auth tokens to requests
-    */
-    authTokenProvider?: IAuthorizationTokenProvider;
-
-    /**
-     * Current session id.
-     */
-    sessionId?: string;
-
-    /**
-     * Current command for activity logging.
-     */
-    command?: string;
-}
-
-/**
- * An IPreRequestEvent is sent before a fetch request is made.
- */
-export interface IPreRequestEvent {
-
-    /**
-     * A unique id that can be used to track this particular request (id is unique among all clients)
-     */
-    requestId: number;
-
-    /**
-     * Url of the request that is about to be issued
-     */
-    requestUrl: string;
-
-    /**
-     * Request settings being used
-     */
-    options?: RequestInit;
-
-    /**
-     * Additional VSS-specific options supplied in the request
-     */
-    vssRequestOptions?: IVssRequestOptions;
-}
-
-/**
- * An IPostRequestEvent is sent after a fetch request has completed.
- */
-export interface IPostRequestEvent {
-
-    /**
-     * A unique id that can be used to track this particular request (id is unique among all clients)
-     */
-    requestId: number;
-
-    /**
-     * Url of the request that is about to be issued
-     */
-    requestUrl: string;
-
-    /**
-     * The Response returned for this request, if the request fails it will be undefined
-     */
-    response?: Response;
-
-    /**
-     * Additional VSS-specific options supplied in the request
-     */
-    vssRequestOptions?: IVssRequestOptions;
-}
-
-/**
- * When a fetch request fails, it will throw a VssServerError. Failure is defined
- * as a request that made it to the server, and the server successfully responded
- * with a failure. This will be any status return that is not a status code in
- * the success range (200-299).
- */
-export interface VssServerError extends Error {
-
-    /**
-     * The status code returned from the server.
-     */
-    status: number;
-
-    /**
-     * The raw text that was returned from the server. If any is available.
-     */
-    responseText: string;
-
-    /**
-     * If the response text was sent and it was in the form of a JSON response
-     * the object will be parsed and deserialized object is available here.
-     *
-     * This commonly has the exception details about the failure from the server.
-     * Things like the message, exception type, and stack trace will be available.
-     */
-    serverError?: any;
-}
-
-/**
- * Issue a fetch request. This is a wrapper around the browser fetch method that handles VSS authentication
- * and triggers events that can be listened to by other modules.
- *
- * @param requestUrl Url to send the request to
- * @param options fetch settings/options for the request
- * @param vssRequestOptions VSS specific request options
- *
- * Triggered Events:
- *  afterRequest -> IPostRequestEvent is sent after the request has completed.
- *  beforeRequest -> IPreRequestEvent is sent before the request is made.
- */
-export async function issueRequest(requestUrl: string, options?: RequestInit, vssRequestOptions?: IVssRequestOptions): Promise<Response> {
-    let response: Response | undefined = undefined;
-
-    // Add a X-VSS-ReauthenticationAction header to all fetch requests
-    if (!options) {
-        options = {};
-    }
-
-    let headers: Headers;
-    
-    // If options.headers is set, check if it is a Headers object, and if not, convert it to one.
-    if (options.headers) {
-        if (options.headers instanceof Headers) {
-            headers = options.headers;
-        }
-        else {
-            headers = new Headers();
-            if (typeof options.headers.hasOwnProperty === "function") {
-                for (const key in options.headers) {
-                    if (options.headers.hasOwnProperty(key)) {
-                        headers.append(key, (options.headers as { [key: string]: string })[key]);
-                    }
-                }
-            }
-        }
-    }
-    else {
-        headers = new Headers();
-    }
-    options.headers = headers;
-
-    headers.append("X-VSS-ReauthenticationAction", "Suppress");
-
-    // Add a X-TFS-Session header with the current sessionId and command for correlation
-    if (vssRequestOptions) {
-        const sessionId = vssRequestOptions.sessionId;
-        const command = vssRequestOptions.command;
-
-        if (sessionId) {
-            if (command) {
-                headers.append("X-TFS-Session", sessionId + "," + command);
-            }
-            else {
-                headers.append("X-TFS-Session", sessionId);
-            }
-        }
-    }
-
-    // Send credentials to the same origin, we will use tokens for differing origins.
-    options.credentials = "same-origin";
-
-    let refreshToken = false;
-
-    do {
-        
-        // Ensure we have an authorization token available from the auth manager.
-        if (vssRequestOptions && vssRequestOptions.authTokenProvider) {
-            const authHeader = await vssRequestOptions.authTokenProvider.getAuthorizationHeader(refreshToken);
-            if (authHeader) {
-                headers.append("Authorization", authHeader);
-                refreshToken = true;
-            }
-            headers.append("X-TFS-FedAuthRedirect", "Suppress");
-        }
-
-        // Execute the http request defined by the caller.
-        try {
-            response = await fetch(requestUrl, options);
-        }
-        catch (ex) {
-            console.warn(`Unhandled exception in fetch for ${requestUrl}: ${ex && ex.toString()}`);
-            const error = new Error("TF400893: Unable to contact the server. Please check your network connection and try again.");
-            error.name = "NetworkException";
-            throw error;
-        }
-
-        // If we recieved a 401 and have a token manager, we will refresh our token and try again.
-        if (response.status === 401 && !refreshToken && vssRequestOptions && vssRequestOptions.authTokenProvider) {
-            refreshToken = true;
-            continue;
-        }
-
-    } while (false);
-
-    // Parse error details from requests that returned non 200-299 status codes.
-    if (!response.ok) {
-
-        // Create a VssServerError and throw it as the result of the fetch request.
-        const error = new Error() as VssServerError;
-        error.name = "TFS.WebApi.Exception";
-        error.status = response.status;
-        error.responseText = await response.text();
-
-        // Attempt to parse the response as a json object, for many of the failures
-        // the server will serialize details into the body.
-        if (error.responseText && error.responseText !== "") {
-            try {
-                error.serverError = JSON.parse(error.responseText);
-                if (error.serverError && error.serverError.message) {
-                    error.message = error.serverError.message;
-                }
-            }
-            catch (exception) {
-            }
-        }
-
-        if (!error.message) {
-            error.message = response.status + ": " + response.statusText;
-        }
-
-        throw error;
-    }
-
-    return response;
-}

package/src/Common/RestClientBase.ts

@@ -1,186 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-import { IVssRestClientOptions } from "./Context";
-import { issueRequest, IVssRequestOptions } from "./Fetch";
-import { deserializeVssJsonObject } from "./Util/Serialization";
-import { replaceRouteValues, Uri } from "./Util/Url";
-
-/**
-* Parameters for sending a WebApi request
-*/
-export interface RestClientRequestParams {
-
-    /**
-    * Route template that is used to form the request path. If routeTemplate is NOT specified, then locationId 
-    * is used to lookup the template via an OPTIONS request.
-    */
-    routeTemplate: string;
-
-    /**
-    * The api version string to send in the request (e.g. "1.0" or "2.0-preview.2")
-    */
-    apiVersion: string;
-
-    /**
-    * Dictionary of route template replacement values
-    */
-    routeValues?: { [key: string]: any; };
-
-    /**
-    * Data to post. In this case of a GET, this indicates query parameters.
-    * For other requests, this is the request body object (which will be serialized
-    * into a JSON string unless isRawData is set to true).
-    */
-    body?: any;
-
-    /**
-    * Query parameters to add to the url. In the case of a GET, query parameters can
-    * be supplied via 'data' or 'queryParams'. For other verbs such as POST, the
-    * data object specifies the POST body, so queryParams is needed to indicate
-    * parameters to add to the query string of the url (not included in the post body).
-    */
-    queryParams?: { [key: string]: any; };
-
-    /**
-    * HTTP verb (GET by default if not specified)
-    */
-    method?: string;
-
-    /**
-    * The http response (Accept) type. This is "json" (corresponds to application/json Accept header) 
-    * unless otherwise specified. Other possible values are "html", "text", "zip", or "binary" or their accept
-    * header equivalents (e.g. application/zip).
-    */
-    httpResponseType?: string;
-
-    /**
-    * Allows the caller to specify custom request headers.
-    */
-    customHeaders?: { [headerName: string]: any; };
-
-    /**
-     * If true, indicates that the raw Response should be returned in the request's resulting promise
-     * rather than deserializing the response (the default).
-     */
-    returnRawResponse?: boolean;
-
-    /**
-    * If true, this indicates that no processing should be done on the 'data' object
-    * before it is sent in the request. *This is rarely needed*. One case is when posting
-    * an HTML5 File object. 
-    */
-    isRawData?: boolean;
-
-    /**
-     * Current command for activity logging. This will override the RestClient's base option.
-     */
-    command?: string;
-}
-
-/**
-* Base class that should be used (derived from) to make requests to VSS REST apis
-*/
-export class RestClientBase {
-
-    private _options: IVssRestClientOptions;
-    private _rootPath: Promise<string>;
-
-    constructor(options: IVssRestClientOptions) {
-
-        this._options = options || {};
-
-        if (typeof this._options.rootPath === "string") {
-            this._rootPath = Promise.resolve(this._options.rootPath);
-        }
-        else {
-            this._rootPath = this._options.rootPath || Promise.resolve("/");
-        }
-    }
-
-    /**
-    * Gets the root path of the Service
-    *
-    * @returns Promise for the resolving the root path of the service.
-    */
-    protected async getRootPath(): Promise<string> {
-        return this._rootPath;
-    }
-
-    /**
-    * Issue a request to a VSS REST endpoint.
-    *
-    * @param requestParams request options
-    * @returns Promise for the response
-    */
-    protected async beginRequest<T>(requestParams: RestClientRequestParams): Promise<T> {
-        return this._rootPath.then((rootPath: string) => {
-
-            let requestUrl = rootPath + replaceRouteValues(requestParams.routeTemplate, requestParams.routeValues || {});
-            if (requestParams.queryParams) {
-                const uri = new Uri(requestUrl);
-                uri.addQueryParams(requestParams.queryParams);
-                requestUrl = uri.absoluteUri;
-            }
-            
-            return this._issueRequest<T>(requestUrl, requestParams.apiVersion, requestParams);
-        });
-    }
-
-    /**
-     * Issue a request to a VSS REST endpoint at the specified location
-     * 
-     * @param requestUrl Resolved URL of the request
-     * @param apiVersion API version
-     * @param requestParams Optional request parameters
-     */
-    protected _issueRequest<T>(requestUrl: string, apiVersion: string, requestParams: RestClientRequestParams): Promise<T> {
-
-        let fetchOptions: RequestInit = {};
-
-        fetchOptions.method = requestParams.method || "GET";
-        fetchOptions.mode = "cors";
-
-        if (!requestParams.isRawData && requestParams.body && fetchOptions.method.toUpperCase() !== 'GET') {
-            fetchOptions.body = JSON.stringify(requestParams.body);
-        }
-        else {
-            fetchOptions.body = requestParams.body;
-        }
-
-        let acceptType = requestParams.httpResponseType || "application/json";
-        let acceptHeaderValue = `${acceptType};api-version=${apiVersion};excludeUrls=true;enumsAsNumbers=true;msDateFormat=true;noArrayWrap=true`;
-
-        fetchOptions.headers = Object.assign({
-            "Accept": acceptHeaderValue,
-            "Content-Type": requestParams.body && "application/json"
-        }, requestParams.customHeaders) as any /* lib.dom.d.ts does not have the correct type for Headers */;
-
-        let vssRequestOptions = {
-            authTokenProvider: this._options.authTokenProvider,
-            sessionId: this._options.sessionId,
-            command: requestParams.command || this._options.command
-        } as IVssRequestOptions;
-
-        let result = issueRequest(requestUrl, fetchOptions, vssRequestOptions);
-        return result.then((response: Response) => {
-
-            if (requestParams.returnRawResponse) {
-                return response;
-            }
-            else if (acceptType.toLowerCase().indexOf("json") >= 0) {
-                // MSJSON date formats must be replaced in the raw text before JSON parsing
-                return response.text().then(deserializeVssJsonObject);
-            }
-            else if (acceptType.toLowerCase() === "text/plain") {
-                return <any>response.text();
-            }
-            else {
-                return response.arrayBuffer();
-            }
-        });
-    }
-}

package/src/Common/System.ts

@@ -1,36 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
- export const enum DayOfWeek {
-    /**
-     * Indicates Sunday.
-     */
-    Sunday = 0,
-    /**
-     * Indicates Monday.
-     */
-    Monday = 1,
-    /**
-     * Indicates Tuesday.
-     */
-    Tuesday = 2,
-    /**
-     * Indicates Wednesday.
-     */
-    Wednesday = 3,
-    /**
-     * Indicates Thursday.
-     */
-    Thursday = 4,
-    /**
-     * Indicates Friday.
-     */
-    Friday = 5,
-    /**
-     * Indicates Saturday.
-     */
-    Saturday = 6,
-}

package/src/Common/SystemData.ts

@@ -1,135 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-/**
- * Specifies SQL Server-specific data type of a field, property, for use in a System.Data.SqlClient.SqlParameter.
- */
-export const enum SqlDbType {
-    /**
-     * A 64-bit signed integer.
-     */
-    BigInt = 0,
-    /**
-     * Array of type Byte. A fixed-length stream of binary data ranging between 1 and 8,000 bytes.
-     */
-    Binary = 1,
-    /**
-     * Boolean. An unsigned numeric value that can be 0, 1, or null.
-     */
-    Bit = 2,
-    /**
-     * String. A fixed-length stream of non-Unicode characters ranging between 1 and 8,000 characters.
-     */
-    Char = 3,
-    /**
-     * DateTime. Date and time data ranging in value from January 1, 1753 to December 31, 9999 to an accuracy of 3.33 milliseconds.
-     */
-    DateTime = 4,
-    /**
-     * Decimal. A fixed precision and scale numeric value between -10 38 -1 and 10 38 -1.
-     */
-    Decimal = 5,
-    /**
-     * Double. A floating point number within the range of -1.79E +308 through 1.79E +308.
-     */
-    Float = 6,
-    /**
-     * Array of type Byte. A variable-length stream of binary data ranging from 0 to 2 31 -1 (or 2,147,483,647) bytes.
-     */
-    Image = 7,
-    /**
-     * Int32. A 32-bit signed integer.
-     */
-    Int = 8,
-    /**
-     * Decimal. A currency value ranging from -2 63 (or -9,223,372,036,854,775,808) to 2 63 -1 (or +9,223,372,036,854,775,807) with an accuracy to a ten-thousandth of a currency unit.
-     */
-    Money = 9,
-    /**
-     * String. A fixed-length stream of Unicode characters ranging between 1 and 4,000 characters.
-     */
-    NChar = 10,
-    /**
-     * String. A variable-length stream of Unicode data with a maximum length of 2 30 - 1 (or 1,073,741,823) characters.
-     */
-    NText = 11,
-    /**
-     * String. A variable-length stream of Unicode characters ranging between 1 and 4,000 characters. Implicit conversion fails if the string is greater than 4,000 characters. Explicitly set the object when working with strings longer than 4,000 characters. Use System.Data.SqlDbType.NVarChar when the database column is nvarchar(max).
-     */
-    NVarChar = 12,
-    /**
-     * Single. A floating point number within the range of -3.40E +38 through 3.40E +38.
-     */
-    Real = 13,
-    /**
-     * Guid. A globally unique identifier (or GUID).
-     */
-    UniqueIdentifier = 14,
-    /**
-     * DateTime. Date and time data ranging in value from January 1, 1900 to June 6, 2079 to an accuracy of one minute.
-     */
-    SmallDateTime = 15,
-    /**
-     * Int16. A 16-bit signed integer.
-     */
-    SmallInt = 16,
-    /**
-     * Decimal. A currency value ranging from -214,748.3648 to +214,748.3647 with an accuracy to a ten-thousandth of a currency unit.
-     */
-    SmallMoney = 17,
-    /**
-     * String. A variable-length stream of non-Unicode data with a maximum length of 2 31 -1 (or 2,147,483,647) characters.
-     */
-    Text = 18,
-    /**
-     * Array of type System.Byte. Automatically generated binary numbers, which are guaranteed to be unique within a database. timestamp is used typically as a mechanism for version-stamping table rows. The storage size is 8 bytes.
-     */
-    Timestamp = 19,
-    /**
-     * Byte. An 8-bit unsigned integer.
-     */
-    TinyInt = 20,
-    /**
-     * Array of type Byte. A variable-length stream of binary data ranging between 1 and 8,000 bytes. Implicit conversion fails if the byte array is greater than 8,000 bytes. Explicitly set the object when working with byte arrays larger than 8,000 bytes.
-     */
-    VarBinary = 21,
-    /**
-     * String. A variable-length stream of non-Unicode characters ranging between 1 and 8,000 characters. Use System.Data.SqlDbType.VarChar when the database column is varchar(max).
-     */
-    VarChar = 22,
-    /**
-     * Object. A special data type that can contain numeric, string, binary, or date data as well as the SQL Server values Empty and Null, which is assumed if no other type is declared.
-     */
-    Variant = 23,
-    /**
-     * An XML value. Obtain the XML as a string using the System.Data.SqlClient.SqlDataReader.GetValue(System.Int32) method or System.Data.SqlTypes.SqlXml.Value property, or as an System.Xml.XmlReader by calling the System.Data.SqlTypes.SqlXml.CreateReader method.
-     */
-    Xml = 25,
-    /**
-     * A SQL Server user-defined type (UDT).
-     */
-    Udt = 29,
-    /**
-     * A special data type for specifying structured data contained in table-valued parameters.
-     */
-    Structured = 30,
-    /**
-     * Date data ranging in value from January 1,1 AD through December 31, 9999 AD.
-     */
-    Date = 31,
-    /**
-     * Time data based on a 24-hour clock. Time value range is 00:00:00 through 23:59:59.9999999 with an accuracy of 100 nanoseconds. Corresponds to a SQL Server time value.
-     */
-    Time = 32,
-    /**
-     * Date and time data. Date value range is from January 1,1 AD through December 31, 9999 AD. Time value range is 00:00:00 through 23:59:59.9999999 with an accuracy of 100 nanoseconds.
-     */
-    DateTime2 = 33,
-    /**
-     * Date and time data with time zone awareness. Date value range is from January 1,1 AD through December 31, 9999 AD. Time value range is 00:00:00 through 23:59:59.9999999 with an accuracy of 100 nanoseconds. Time zone value range is -14:00 through +14:00.
-     */
-    DateTimeOffset = 34
-}

package/src/Common/Util/Serialization.ts

@@ -1,59 +0,0 @@
-/*
- * ---------------------------------------------------------
- * Copyright(C) Microsoft Corporation. All rights reserved.
- * ---------------------------------------------------------
- */
-
-const msAjaxDateRegEx = new RegExp('(^|[^\\\\])\\"\\\\/Date\\((-?[0-9]+)(?:[a-zA-Z]|(?:\\+|-)[0-9]{4})?\\)\\\\/\\"', 'g');
-
-/**
- * Handle the raw text of a JSON response which may contain MSJSON style dates and
- * deserialize (JSON.parse) the data in a way that restores Date objects rather than
- * strings.
- * 
- * MSJSON style dates are in the form:
- * 
- *     "lastModified": "\/Date(1496158224000)\/"
- * 
- * This format unnecessarily (but intentionally) escapes the "/" character. So the parsed
- * JSON will have no trace of the escape character (\).
- * 
- * @param text The raw JSON text
- */
-export function deserializeVssJsonObject<T>(text: string): T | null {
-
-    function replaceMsJsonDates(object: any, parentObject: any, parentObjectKey: string) {
-
-        if (parentObject && typeof object.__msjson_date__ === "number") {
-            parentObject[parentObjectKey] = new Date(object.__msjson_date__);
-            return;
-        }
-
-        for (let key in object) {
-            const value = object[key];
-            if (value !== null && typeof value === "object") {
-                replaceMsJsonDates(object[key], object, key);
-            }
-        }
-    }
-
-    let deserializedData: T | null = null;
-
-    if (text) {
-
-        // Replace MSJSON dates with an object that we can easily identify after JSON.parse.
-        // This replaces the string value (like "\/Date(1496158224000)\/") with a JSON object that 
-        // has an "__msjson_date__" key.
-        const replacedText = text.replace(msAjaxDateRegEx, "$1{\"__msjson_date__\":$2 }");
-
-        // Do the actual JSON deserialization
-        deserializedData = JSON.parse(replacedText);
-
-        // Go through the parsed object and create actual Date objects for our replacements made above
-        if (replacedText !== text) {
-            replaceMsJsonDates(deserializedData, null, "");
-        }
-    }
-
-    return deserializedData;
-}