/*!
 * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
 * Licensed under the MIT License.
 */
/**
 * Represents token response
 * @legacy
 * @beta
 */
export interface TokenResponse {
    /** Token value */
    token: string;
    /**
     * Authorization header value will be used verbatim when making network call that requires the token.
     * If not provided, the token value will be assumed to be a Bearer token and will be used to generate the
     * Authorization header value in the following format: `Bearer ${token}`.
     */
    readonly authorizationHeader?: string;
    /**
     * Whether or not the token was obtained from local cache.
     * @remarks `undefined` indicates that it could not be determined whether or not the token was obtained this way.
     */
    fromCache?: boolean;
}
/**
 * Represents access token fetch options
 * @legacy
 * @beta
 */
export interface TokenFetchOptions {
    /**
     * Value indicating whether fresh token has to be returned.
     * If false then it is okay to return cached unexpired token if available.
     */
    refresh: boolean;
    /**
     * Claims that have to be passed with token fetch request.
     * These can be used to specify additional information that must be passed to token authority.
     */
    claims?: string;
    /**
     * Tenant id of authority that must be handling token fetch.
     * If it is not specified then it is up to token fetching logic to determine which tenant authority
     * to use to issue access token.
     */
    tenantId?: string;
    /**
     * Request that will be made using the fetched token.
     * - url: full request url, including query params
     * - method: method type
     * Request info may be encoded into the returned token that the receiver can use to validate that caller is allowed to make specific call.
     */
    readonly request?: {
        url: string;
        method: "GET" | "POST" | "PATCH" | "DELETE" | "PUT";
    };
}
/**
 * Represents access token fetch options for ODSP resource
 * @legacy
 * @beta
 */
export interface OdspResourceTokenFetchOptions extends TokenFetchOptions {
    /** Site url representing ODSP resource location */
    siteUrl: string;
    /** ODSP drive id where resource resides. Optional, used only when fetching token to access ODSP file */
    driveId?: string;
    /** ODSP item id representing resource. Optional, used only when fetching token to access ODSP file */
    itemId?: string;
}
/**
 * Method signature for callback method used to fetch access token
 * @param options - token fetch options
 * @returns If successful, TokenResponse object representing token value along with flag indicating
 * whether token came from cache. Legacy implementation may return a string for token value;
 * in this case it should be assumes that fromCache signal is undefined. Null is returned in case of failure.
 * @legacy
 * @beta
 */
export type TokenFetcher<T> = (options: T) => Promise<string | TokenResponse | null>;
/**
 * Helper method which transforms return value for TokenFetcher method to token string
 * @param tokenResponse - return value for TokenFetcher method
 * @returns Token value
 * @internal
 */
export declare const tokenFromResponse: (tokenResponse: string | TokenResponse | null | undefined) => string | null;
/**
 * Helper method which transforms return value for TokenFetcher method to Authorization header value
 * @param tokenResponse - return value for TokenFetcher method
 * @returns Authorization header value
 * @internal
 */
export declare const authHeaderFromTokenResponse: (tokenResponse: string | TokenResponse | null | undefined) => string | null;
/**
 * Helper method which returns flag indicating whether token response comes from local cache
 * @param tokenResponse - return value for TokenFetcher method
 * @returns Value indicating whether response came from cache.
 * Undefined is returned when we could not determine the source of token.
 * @internal
 */
export declare const isTokenFromCache: (tokenResponse: string | TokenResponse | null) => boolean | undefined;
/**
 * Identity types supported by ODSP driver.
 * `Consumer` represents user authenticated with Microsoft Account (MSA).
 * `Enterprise` represents user authenticated with M365 tenant account.
 * @legacy
 * @beta
 */
export type IdentityType = "Consumer" | "Enterprise";
/**
 * @returns Authorization header value
 * @internal
 */
export type InstrumentedStorageTokenFetcher = (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry?: boolean) => Promise<string>;
/**
 * @internal
 */
export type InstrumentedTokenFetcher = (options: TokenFetchOptions, name: string, alwaysRecordTokenFetchTelemetry?: boolean) => Promise<string | null>;
//# sourceMappingURL=tokenFetch.d.ts.map