@azure/msal-common 14.0.0-alpha.1 → 14.0.0-alpha.2

package/dist/response/ServerAuthorizationCodeResponse.d.ts

@@ -1,26 +1,26 @@
-/**
- * Deserialized response object from server authorization code request.
- * - code: authorization code from server
- * - client_info: client info object
- * - state: OAuth2 request state
- * - error: error sent back in hash
- * - error: description
- */
-export type ServerAuthorizationCodeResponse = {
-    code?: string;
-    client_info?: string;
-    state?: string;
-    cloud_instance_name?: string;
-    cloud_instance_host_name?: string;
-    cloud_graph_host_name?: string;
-    msgraph_host?: string;
-    error?: string;
-    error_description?: string;
-    suberror?: string;
-    timestamp?: string;
-    trace_id?: string;
-    correlation_id?: string;
-    claims?: string;
-    accountId?: string;
-};
+/**
+ * Deserialized response object from server authorization code request.
+ * - code: authorization code from server
+ * - client_info: client info object
+ * - state: OAuth2 request state
+ * - error: error sent back in hash
+ * - error: description
+ */
+export type ServerAuthorizationCodeResponse = {
+    code?: string;
+    client_info?: string;
+    state?: string;
+    cloud_instance_name?: string;
+    cloud_instance_host_name?: string;
+    cloud_graph_host_name?: string;
+    msgraph_host?: string;
+    error?: string;
+    error_description?: string;
+    suberror?: string;
+    timestamp?: string;
+    trace_id?: string;
+    correlation_id?: string;
+    claims?: string;
+    accountId?: string;
+};
 //# sourceMappingURL=ServerAuthorizationCodeResponse.d.ts.map

package/dist/response/ServerAuthorizationTokenResponse.d.ts

@@ -1,45 +1,45 @@
-import { AuthenticationScheme } from "../utils/Constants";
-/**
- * Deserialized response object from server authorization code request.
- * - token_type: Indicates the token type value. Can be either Bearer or pop.
- * - scope: The scopes that the access_token is valid for.
- * - expires_in: How long the access token is valid (in seconds).
- * - refresh_in: Duration afer which a token should be renewed, regardless of expiration.
- * - ext_expires_in: How long the access token is valid (in seconds) if the server isn't responding.
- * - access_token: The requested access token. The app can use this token to authenticate to the secured resource, such as a web API.
- * - refresh_token: An OAuth 2.0 refresh token. The app can use this token acquire additional access tokens after the current access token expires.
- * - id_token: A JSON Web Token (JWT). The app can decode the segments of this token to request information about the user who signed in.
- * - key_id: A string that uniquely identifies a public key that the request is bound to.
- *
- * In case of error:
- * - error: An error code string that can be used to classify types of errors that occur, and can be used to react to errors.
- * - error_description: A specific error message that can help a developer identify the root cause of an authentication error.
- * - error_codes: A list of STS-specific error codes that can help in diagnostics.
- * - timestamp: The time at which the error occurred.
- * - trace_id: A unique identifier for the request that can help in diagnostics.
- * - correlation_id: A unique identifier for the request that can help in diagnostics across components.
- */
-export type ServerAuthorizationTokenResponse = {
-    token_type?: AuthenticationScheme;
-    scope?: string;
-    expires_in?: number;
-    refresh_in?: number;
-    ext_expires_in?: number;
-    access_token?: string;
-    refresh_token?: string;
-    id_token?: string;
-    client_info?: string;
-    foci?: string;
-    spa_code?: string;
-    spa_accountid?: string;
-    key_id?: string;
-    error?: string;
-    error_description?: string;
-    error_codes?: Array<string>;
-    suberror?: string;
-    timestamp?: string;
-    trace_id?: string;
-    correlation_id?: string;
-    claims?: string;
-};
+import { AuthenticationScheme } from "../utils/Constants";
+/**
+ * Deserialized response object from server authorization code request.
+ * - token_type: Indicates the token type value. Can be either Bearer or pop.
+ * - scope: The scopes that the access_token is valid for.
+ * - expires_in: How long the access token is valid (in seconds).
+ * - refresh_in: Duration afer which a token should be renewed, regardless of expiration.
+ * - ext_expires_in: How long the access token is valid (in seconds) if the server isn't responding.
+ * - access_token: The requested access token. The app can use this token to authenticate to the secured resource, such as a web API.
+ * - refresh_token: An OAuth 2.0 refresh token. The app can use this token acquire additional access tokens after the current access token expires.
+ * - id_token: A JSON Web Token (JWT). The app can decode the segments of this token to request information about the user who signed in.
+ * - key_id: A string that uniquely identifies a public key that the request is bound to.
+ *
+ * In case of error:
+ * - error: An error code string that can be used to classify types of errors that occur, and can be used to react to errors.
+ * - error_description: A specific error message that can help a developer identify the root cause of an authentication error.
+ * - error_codes: A list of STS-specific error codes that can help in diagnostics.
+ * - timestamp: The time at which the error occurred.
+ * - trace_id: A unique identifier for the request that can help in diagnostics.
+ * - correlation_id: A unique identifier for the request that can help in diagnostics across components.
+ */
+export type ServerAuthorizationTokenResponse = {
+    token_type?: AuthenticationScheme;
+    scope?: string;
+    expires_in?: number;
+    refresh_in?: number;
+    ext_expires_in?: number;
+    access_token?: string;
+    refresh_token?: string;
+    id_token?: string;
+    client_info?: string;
+    foci?: string;
+    spa_code?: string;
+    spa_accountid?: string;
+    key_id?: string;
+    error?: string;
+    error_description?: string;
+    error_codes?: Array<string>;
+    suberror?: string;
+    timestamp?: string;
+    trace_id?: string;
+    correlation_id?: string;
+    claims?: string;
+};
 //# sourceMappingURL=ServerAuthorizationTokenResponse.d.ts.map

package/dist/telemetry/performance/IPerformanceClient.d.ts

@@ -1,43 +1,43 @@
-import { Counters, PerformanceEvent, PerformanceEvents, StaticFields } from "./PerformanceEvent";
-import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
-export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
-export type InProgressPerformanceEvent = {
-    endMeasurement: (event?: Partial<PerformanceEvent>) => PerformanceEvent | null;
-    discardMeasurement: () => void;
-    addStaticFields: (staticFields: StaticFields) => void;
-    increment: (counters: Counters) => void;
-    event: PerformanceEvent;
-    measurement: IPerformanceMeasurement;
-};
-export interface IPerformanceClient {
-    startMeasurement(measureName: PerformanceEvents, correlationId?: string): InProgressPerformanceEvent;
-    endMeasurement(event: PerformanceEvent): PerformanceEvent | null;
-    discardMeasurements(correlationId: string): void;
-    addStaticFields(staticFields: StaticFields, correlationId: string): void;
-    removePerformanceCallback(callbackId: string): boolean;
-    addPerformanceCallback(callback: PerformanceCallbackFunction): string;
-    emitEvents(events: PerformanceEvent[], correlationId: string): void;
-    startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement;
-    generateId(): string;
-    calculateQueuedTime(preQueueTime: number, currentTime: number): number;
-    addQueueMeasurement(eventName: PerformanceEvents, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
-    setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
-}
-/**
- * Queue measurement type
- */
-export type QueueMeasurement = {
-    /**
-     * Name of performance event
-     */
-    eventName: PerformanceEvents;
-    /**
-     * Time spent in JS queue
-     */
-    queueTime: number;
-    /**
-     * Incomplete pre-queue events are instrumentation bugs that should be fixed.
-     */
-    manuallyCompleted?: boolean;
-};
+import { Counters, PerformanceEvent, PerformanceEvents, StaticFields } from "./PerformanceEvent";
+import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
+export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
+export type InProgressPerformanceEvent = {
+    endMeasurement: (event?: Partial<PerformanceEvent>) => PerformanceEvent | null;
+    discardMeasurement: () => void;
+    addStaticFields: (staticFields: StaticFields) => void;
+    increment: (counters: Counters) => void;
+    event: PerformanceEvent;
+    measurement: IPerformanceMeasurement;
+};
+export interface IPerformanceClient {
+    startMeasurement(measureName: PerformanceEvents, correlationId?: string): InProgressPerformanceEvent;
+    endMeasurement(event: PerformanceEvent): PerformanceEvent | null;
+    discardMeasurements(correlationId: string): void;
+    addStaticFields(staticFields: StaticFields, correlationId: string): void;
+    removePerformanceCallback(callbackId: string): boolean;
+    addPerformanceCallback(callback: PerformanceCallbackFunction): string;
+    emitEvents(events: PerformanceEvent[], correlationId: string): void;
+    startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement;
+    generateId(): string;
+    calculateQueuedTime(preQueueTime: number, currentTime: number): number;
+    addQueueMeasurement(eventName: PerformanceEvents, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
+    setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
+}
+/**
+ * Queue measurement type
+ */
+export type QueueMeasurement = {
+    /**
+     * Name of performance event
+     */
+    eventName: PerformanceEvents;
+    /**
+     * Time spent in JS queue
+     */
+    queueTime: number;
+    /**
+     * Incomplete pre-queue events are instrumentation bugs that should be fixed.
+     */
+    manuallyCompleted?: boolean;
+};
 //# sourceMappingURL=IPerformanceClient.d.ts.map

package/dist/telemetry/performance/IPerformanceMeasurement.d.ts

@@ -1,6 +1,6 @@
-export interface IPerformanceMeasurement {
-    startMeasurement(): void;
-    endMeasurement(): void;
-    flushMeasurement(): number | null;
-}
+export interface IPerformanceMeasurement {
+    startMeasurement(): void;
+    endMeasurement(): void;
+    flushMeasurement(): number | null;
+}
 //# sourceMappingURL=IPerformanceMeasurement.d.ts.map

package/dist/telemetry/performance/PerformanceClient.d.ts

@@ -1,190 +1,190 @@
-import { ApplicationTelemetry } from "../../config/ClientConfiguration";
-import { Logger } from "../../logger/Logger";
-import { InProgressPerformanceEvent, IPerformanceClient, PerformanceCallbackFunction, QueueMeasurement } from "./IPerformanceClient";
-import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
-import { Counters, PerformanceEvent, PerformanceEvents, StaticFields } from "./PerformanceEvent";
-export interface PreQueueEvent {
-    name: PerformanceEvents;
-    time: number;
-}
-export declare abstract class PerformanceClient implements IPerformanceClient {
-    protected authority: string;
-    protected libraryName: string;
-    protected libraryVersion: string;
-    protected applicationTelemetry: ApplicationTelemetry;
-    protected clientId: string;
-    protected logger: Logger;
-    protected callbacks: Map<string, PerformanceCallbackFunction>;
-    /**
-     * Multiple events with the same correlation id.
-     * @protected
-     * @type {Map<string, PerformanceEvent>}
-     */
-    protected eventsByCorrelationId: Map<string, PerformanceEvent>;
-    /**
-     * Map of pre-queue times by correlation Id
-     *
-     * @protected
-     * @type {Map<string, PreQueueEvent>}
-     */
-    protected preQueueTimeByCorrelationId: Map<string, PreQueueEvent>;
-    /**
-     * Map of queue measurements by correlation Id
-     *
-     * @protected
-     * @type {Map<string, Array<QueueMeasurement>>}
-     */
-    protected queueMeasurements: Map<string, Array<QueueMeasurement>>;
-    /**
-     * Creates an instance of PerformanceClient,
-     * an abstract class containing core performance telemetry logic.
-     *
-     * @constructor
-     * @param {string} clientId Client ID of the application
-     * @param {string} authority Authority used by the application
-     * @param {Logger} logger Logger used by the application
-     * @param {string} libraryName Name of the library
-     * @param {string} libraryVersion Version of the library
-     */
-    constructor(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry);
-    /**
-     * Generates and returns a unique id, typically a guid.
-     *
-     * @abstract
-     * @returns {string}
-     */
-    abstract generateId(): string;
-    /**
-     * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
-     * Note: this function can be changed to abstract at the next major version bump.
-     *
-     * @param {string} measureName
-     * @param {string} correlationId
-     * @returns {IPerformanceMeasurement}
-     */
-    startPerformanceMeasurement(measureName: string, // eslint-disable-line @typescript-eslint/no-unused-vars
-    correlationId: string): IPerformanceMeasurement;
-    /**
-     * Sets pre-queue time by correlation Id
-     *
-     * @abstract
-     * @param {PerformanceEvents} eventName
-     * @param {string} correlationId
-     * @returns
-     */
-    abstract setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
-    /**
-     * Get integral fields.
-     * Override to change the set.
-     */
-    getIntFields(): ReadonlySet<string>;
-    /**
-     * Gets map of pre-queue times by correlation Id
-     *
-     * @param {PerformanceEvents} eventName
-     * @param {string} correlationId
-     * @returns {number}
-     */
-    getPreQueueTime(eventName: PerformanceEvents, correlationId: string): number | void;
-    /**
-     * Calculates the difference between current time and time when function was queued.
-     * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
-     *
-     * @param {number} preQueueTime
-     * @param {number} currentTime
-     * @returns {number}
-     */
-    calculateQueuedTime(preQueueTime: number, currentTime: number): number;
-    /**
-     * Adds queue measurement time to QueueMeasurements array for given correlation ID.
-     *
-     * @param {PerformanceEvents} eventName
-     * @param {?string} correlationId
-     * @param {?number} queueTime
-     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
-     * @returns
-     */
-    addQueueMeasurement(eventName: PerformanceEvents, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
-    /**
-     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
-     *
-     * @param {PerformanceEvents} measureName
-     * @param {?string} [correlationId]
-     * @returns {InProgressPerformanceEvent}
-     */
-    startMeasurement(measureName: PerformanceEvents, correlationId?: string): InProgressPerformanceEvent;
-    /**
-     * Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
-     * as consumers should instead use the function returned by startMeasurement.
-     * Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
-     * otherwise.
-     *
-     * @param {PerformanceEvent} event
-     * @param {IPerformanceMeasurement} measurement
-     * @returns {(PerformanceEvent | null)}
-     */
-    endMeasurement(event: PerformanceEvent, measurement?: IPerformanceMeasurement): PerformanceEvent | null;
-    /**
-     * Saves extra information to be emitted when the measurements are flushed
-     * @param fields
-     * @param correlationId
-     */
-    addStaticFields(fields: StaticFields, correlationId: string): void;
-    /**
-     * Increment counters to be emitted when the measurements are flushed
-     * @param counters {Counters}
-     * @param correlationId {string} correlation identifier
-     */
-    increment(counters: Counters, correlationId: string): void;
-    /**
-     * Upserts event into event cache.
-     * First key is the correlation id, second key is the event id.
-     * Allows for events to be grouped by correlation id,
-     * and to easily allow for properties on them to be updated.
-     *
-     * @private
-     * @param {PerformanceEvent} event
-     */
-    private cacheEventByCorrelationId;
-    private getQueueInfo;
-    /**
-     * Removes measurements for a given correlation id.
-     *
-     * @param {string} correlationId
-     */
-    discardMeasurements(correlationId: string): void;
-    /**
-     * Removes cache for a given correlation id.
-     *
-     * @param {string} correlationId correlation identifier
-     */
-    private discardCache;
-    /**
-     * Registers a callback function to receive performance events.
-     *
-     * @param {PerformanceCallbackFunction} callback
-     * @returns {string}
-     */
-    addPerformanceCallback(callback: PerformanceCallbackFunction): string;
-    /**
-     * Removes a callback registered with addPerformanceCallback.
-     *
-     * @param {string} callbackId
-     * @returns {boolean}
-     */
-    removePerformanceCallback(callbackId: string): boolean;
-    /**
-     * Emits events to all registered callbacks.
-     *
-     * @param {PerformanceEvent[]} events
-     * @param {?string} [correlationId]
-     */
-    emitEvents(events: PerformanceEvent[], correlationId: string): void;
-    /**
-     * Enforce truncation of integral fields in performance event.
-     * @param {PerformanceEvent} event performance event to update.
-     * @param {Set<string>} intFields integral fields.
-     */
-    private truncateIntegralFields;
-}
+import { ApplicationTelemetry } from "../../config/ClientConfiguration";
+import { Logger } from "../../logger/Logger";
+import { InProgressPerformanceEvent, IPerformanceClient, PerformanceCallbackFunction, QueueMeasurement } from "./IPerformanceClient";
+import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
+import { Counters, PerformanceEvent, PerformanceEvents, StaticFields } from "./PerformanceEvent";
+export interface PreQueueEvent {
+    name: PerformanceEvents;
+    time: number;
+}
+export declare abstract class PerformanceClient implements IPerformanceClient {
+    protected authority: string;
+    protected libraryName: string;
+    protected libraryVersion: string;
+    protected applicationTelemetry: ApplicationTelemetry;
+    protected clientId: string;
+    protected logger: Logger;
+    protected callbacks: Map<string, PerformanceCallbackFunction>;
+    /**
+     * Multiple events with the same correlation id.
+     * @protected
+     * @type {Map<string, PerformanceEvent>}
+     */
+    protected eventsByCorrelationId: Map<string, PerformanceEvent>;
+    /**
+     * Map of pre-queue times by correlation Id
+     *
+     * @protected
+     * @type {Map<string, PreQueueEvent>}
+     */
+    protected preQueueTimeByCorrelationId: Map<string, PreQueueEvent>;
+    /**
+     * Map of queue measurements by correlation Id
+     *
+     * @protected
+     * @type {Map<string, Array<QueueMeasurement>>}
+     */
+    protected queueMeasurements: Map<string, Array<QueueMeasurement>>;
+    /**
+     * Creates an instance of PerformanceClient,
+     * an abstract class containing core performance telemetry logic.
+     *
+     * @constructor
+     * @param {string} clientId Client ID of the application
+     * @param {string} authority Authority used by the application
+     * @param {Logger} logger Logger used by the application
+     * @param {string} libraryName Name of the library
+     * @param {string} libraryVersion Version of the library
+     */
+    constructor(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry);
+    /**
+     * Generates and returns a unique id, typically a guid.
+     *
+     * @abstract
+     * @returns {string}
+     */
+    abstract generateId(): string;
+    /**
+     * Starts and returns an platform-specific implementation of IPerformanceMeasurement.
+     * Note: this function can be changed to abstract at the next major version bump.
+     *
+     * @param {string} measureName
+     * @param {string} correlationId
+     * @returns {IPerformanceMeasurement}
+     */
+    startPerformanceMeasurement(measureName: string, // eslint-disable-line @typescript-eslint/no-unused-vars
+    correlationId: string): IPerformanceMeasurement;
+    /**
+     * Sets pre-queue time by correlation Id
+     *
+     * @abstract
+     * @param {PerformanceEvents} eventName
+     * @param {string} correlationId
+     * @returns
+     */
+    abstract setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
+    /**
+     * Get integral fields.
+     * Override to change the set.
+     */
+    getIntFields(): ReadonlySet<string>;
+    /**
+     * Gets map of pre-queue times by correlation Id
+     *
+     * @param {PerformanceEvents} eventName
+     * @param {string} correlationId
+     * @returns {number}
+     */
+    getPreQueueTime(eventName: PerformanceEvents, correlationId: string): number | void;
+    /**
+     * Calculates the difference between current time and time when function was queued.
+     * Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
+     *
+     * @param {number} preQueueTime
+     * @param {number} currentTime
+     * @returns {number}
+     */
+    calculateQueuedTime(preQueueTime: number, currentTime: number): number;
+    /**
+     * Adds queue measurement time to QueueMeasurements array for given correlation ID.
+     *
+     * @param {PerformanceEvents} eventName
+     * @param {?string} correlationId
+     * @param {?number} queueTime
+     * @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
+     * @returns
+     */
+    addQueueMeasurement(eventName: PerformanceEvents, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
+    /**
+     * Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
+     *
+     * @param {PerformanceEvents} measureName
+     * @param {?string} [correlationId]
+     * @returns {InProgressPerformanceEvent}
+     */
+    startMeasurement(measureName: PerformanceEvents, correlationId?: string): InProgressPerformanceEvent;
+    /**
+     * Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
+     * as consumers should instead use the function returned by startMeasurement.
+     * Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
+     * otherwise.
+     *
+     * @param {PerformanceEvent} event
+     * @param {IPerformanceMeasurement} measurement
+     * @returns {(PerformanceEvent | null)}
+     */
+    endMeasurement(event: PerformanceEvent, measurement?: IPerformanceMeasurement): PerformanceEvent | null;
+    /**
+     * Saves extra information to be emitted when the measurements are flushed
+     * @param fields
+     * @param correlationId
+     */
+    addStaticFields(fields: StaticFields, correlationId: string): void;
+    /**
+     * Increment counters to be emitted when the measurements are flushed
+     * @param counters {Counters}
+     * @param correlationId {string} correlation identifier
+     */
+    increment(counters: Counters, correlationId: string): void;
+    /**
+     * Upserts event into event cache.
+     * First key is the correlation id, second key is the event id.
+     * Allows for events to be grouped by correlation id,
+     * and to easily allow for properties on them to be updated.
+     *
+     * @private
+     * @param {PerformanceEvent} event
+     */
+    private cacheEventByCorrelationId;
+    private getQueueInfo;
+    /**
+     * Removes measurements for a given correlation id.
+     *
+     * @param {string} correlationId
+     */
+    discardMeasurements(correlationId: string): void;
+    /**
+     * Removes cache for a given correlation id.
+     *
+     * @param {string} correlationId correlation identifier
+     */
+    private discardCache;
+    /**
+     * Registers a callback function to receive performance events.
+     *
+     * @param {PerformanceCallbackFunction} callback
+     * @returns {string}
+     */
+    addPerformanceCallback(callback: PerformanceCallbackFunction): string;
+    /**
+     * Removes a callback registered with addPerformanceCallback.
+     *
+     * @param {string} callbackId
+     * @returns {boolean}
+     */
+    removePerformanceCallback(callbackId: string): boolean;
+    /**
+     * Emits events to all registered callbacks.
+     *
+     * @param {PerformanceEvent[]} events
+     * @param {?string} [correlationId]
+     */
+    emitEvents(events: PerformanceEvent[], correlationId: string): void;
+    /**
+     * Enforce truncation of integral fields in performance event.
+     * @param {PerformanceEvent} event performance event to update.
+     * @param {Set<string>} intFields integral fields.
+     */
+    private truncateIntegralFields;
+}
 //# sourceMappingURL=PerformanceClient.d.ts.map