@microsoft/applicationinsights-perfmarkmeasure-js 3.1.0-nightly3.2402-09 → 3.1.1-nightly3.2402-13

package/dist-es5/PerfMarkMeasureManager.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.0-nightly3.2402-09
+ * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.1-nightly3.2402-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 /**

package/dist-es5/__DynamicConstants.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.0-nightly3.2402-09
+ * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.1-nightly3.2402-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-es5/applicationinsights-perfmarkmeasure-js.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.0-nightly3.2402-09
+ * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.1-nightly3.2402-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 

package/dist-es5/interfaces/IPerfMarkMeasureConfiguration.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.0-nightly3.2402-09
+ * Application Insights JavaScript SDK - Performance Mark and Measure Manager plugin, 3.1.1-nightly3.2402-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@microsoft/applicationinsights-perfmarkmeasure-js",
-    "version": "3.1.0-nightly3.2402-09",
+    "version": "3.1.1-nightly3.2402-13",
     "description": "Microsoft Application Insights Performance Mark and Measure Manager plugin",
     "homepage": "https://github.com/microsoft/ApplicationInsights-JS#readme",
     "author": "Microsoft Application Insights Team",
@@ -32,7 +32,7 @@
         "@microsoft/ai-test-framework": "0.0.1",
         "@microsoft/applicationinsights-rollup-plugin-uglify3-js": "1.0.0",
         "@microsoft/applicationinsights-rollup-es5": "1.0.2",
-        "@microsoft/api-extractor": "^7.18.19",
+        "@microsoft/api-extractor": "^7.40.0",
         "typescript": "^4.9.3",
         "tslib": "^2.0.0",
         "grunt": "^1.5.3",
@@ -55,8 +55,8 @@
     "dependencies": {
         "@microsoft/dynamicproto-js": "^2.0.3",
         "@microsoft/applicationinsights-shims": "3.0.1",
-        "@microsoft/applicationinsights-core-js": "3.1.0-nightly3.2402-09",
-        "@nevware21/ts-utils": ">= 0.10.4 < 2.x"
+        "@microsoft/applicationinsights-core-js": "3.1.1-nightly3.2402-13",
+        "@nevware21/ts-utils": ">= 0.10.5 < 2.x"
     },
     "license": "MIT",
     "publishConfig": {

package/types/applicationinsights-perfmarkmeasure-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Performance Mark and Measure Manager plugin, 3.1.0-nightly3.2402-09
+ * Microsoft Application Insights Performance Mark and Measure Manager plugin, 3.1.1-nightly3.2402-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -20,10 +20,15 @@ import { IPerfManagerProvider } from '@microsoft/applicationinsights-core-js';
 import { PerfManager } from '@microsoft/applicationinsights-core-js';
 
 export { doPerf }
+
 export { INotificationManager }
+
 export { IPerfEvent }
+
 export { IPerfManager }
+
 export { IPerfManagerProvider }
+
 /**
  * @copyright Microsoft 2021
  */
@@ -95,4 +100,4 @@ export declare class PerfMarkMeasureManager extends PerfManager {
     fire(perfEvent: IPerfEvent): void;
 }
 
-export { }
+export { }

package/types/applicationinsights-perfmarkmeasure-js.namespaced.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Performance Mark and Measure Manager plugin, 3.1.0-nightly3.2402-09
+ * Microsoft Application Insights Performance Mark and Measure Manager plugin, 3.1.1-nightly3.2402-13
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -7,18 +7,218 @@
  */
 
 declare namespace ApplicationInsights {
-    import { doPerf } from '@microsoft/applicationinsights-core-js';
-    import { INotificationManager } from '@microsoft/applicationinsights-core-js';
-    import { IPerfEvent } from '@microsoft/applicationinsights-core-js';
-    import { IPerfManager } from '@microsoft/applicationinsights-core-js';
-    import { IPerfManagerProvider } from '@microsoft/applicationinsights-core-js';
-    import { PerfManager } from '@microsoft/applicationinsights-core-js';
-
-    
-    
-    
-    
-    
+    /**
+     * Helper function to wrap a function with a perf event
+     * @param mgrSource - The Performance Manager or a Performance provider source (may be null)
+     * @param getSource - The callback to create the source name for the event (if perf monitoring is enabled)
+     * @param func - The function to call and measure
+     * @param details - A function to return the payload details
+     * @param isAsync - Is the event / function being call asynchronously or synchronously
+     */
+    function doPerf<T>(mgrSource: IPerfManagerProvider | IPerfManager, getSource: () => string, func: (perfEvt?: IPerfEvent) => T, details?: () => any, isAsync?: boolean): T;
+
+    /**
+     * This defines the handler function that is called via the finally when the promise is resolved or rejected
+     */
+    type FinallyPromiseHandler = (() => void) | undefined | null;
+
+    interface ICustomProperties {
+        [key: string]: any;
+    }
+
+    /**
+     * An interface used for the notification listener.
+     * @interface
+     */
+    interface INotificationListener {
+        /**
+         * [Optional] A function called when events are sent.
+         * @param events - The array of events that have been sent.
+         */
+        eventsSent?: (events: ITelemetryItem[]) => void;
+        /**
+         * [Optional] A function called when events are discarded.
+         * @param events - The array of events that have been discarded.
+         * @param reason - The reason for discarding the events. The EventsDiscardedReason
+         * constant should be used to check the different values.
+         */
+        eventsDiscarded?: (events: ITelemetryItem[], reason: number) => void;
+        /**
+         * [Optional] A function called when the events have been requested to be sent to the sever.
+         * @param sendReason - The reason why the event batch is being sent.
+         * @param isAsync - A flag which identifies whether the requests are being sent in an async or sync manner.
+         */
+        eventsSendRequest?: (sendReason: number, isAsync?: boolean) => void;
+        /**
+         * [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
+         * the event can be displayed via the debug plugin extension.
+         * @param perfEvent
+         */
+        perfEvent?: (perfEvent: IPerfEvent) => void;
+        /**
+         * Unload and remove any state that this INotificationListener may be holding, this is generally called when the
+         * owning Manager is being unloaded.
+         * @param isAsync - Can the unload be performed asynchronously (default)
+         * @return If the unload occurs synchronously then nothing should be returned, if happening asynchronously then
+         * the function should return an [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
+         * / Promise to allow any listeners to wait for the operation to complete.
+         */
+        unload?(isAsync?: boolean): void | IPromise<void>;
+    }
+
+    /**
+     * Class to manage sending notifications to all the listeners.
+     */
+    interface INotificationManager {
+        listeners: INotificationListener[];
+        /**
+         * Adds a notification listener.
+         * @param listener - The notification listener to be added.
+         */
+        addNotificationListener(listener: INotificationListener): void;
+        /**
+         * Removes all instances of the listener.
+         * @param listener - AWTNotificationListener to remove.
+         */
+        removeNotificationListener(listener: INotificationListener): void;
+        /**
+         * Notification for events sent.
+         * @param events - The array of events that have been sent.
+         */
+        eventsSent(events: ITelemetryItem[]): void;
+        /**
+         * Notification for events being discarded.
+         * @param events - The array of events that have been discarded by the SDK.
+         * @param reason - The reason for which the SDK discarded the events. The EventsDiscardedReason
+         * constant should be used to check the different values.
+         */
+        eventsDiscarded(events: ITelemetryItem[], reason: number): void;
+        /**
+         * [Optional] A function called when the events have been requested to be sent to the sever.
+         * @param sendReason - The reason why the event batch is being sent.
+         * @param isAsync - A flag which identifies whether the requests are being sent in an async or sync manner.
+         */
+        eventsSendRequest?(sendReason: number, isAsync: boolean): void;
+        /**
+         * [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
+         * the event can be displayed via the debug plugin extension.
+         * @param perfEvent - The perf event details
+         */
+        perfEvent?(perfEvent: IPerfEvent): void;
+        /**
+         * Unload and remove any state that this INotificationManager may be holding, this is generally called when the
+         * owning SDK is being unloaded.
+         * @param isAsync - Can the unload be performed asynchronously (default)
+         * @return If the unload occurs synchronously then nothing should be returned, if happening asynchronously then
+         * the function should return an [IPromise](https://nevware21.github.io/ts-async/typedoc/interfaces/IPromise.html)
+         * / Promise to allow any listeners to wait for the operation to complete.
+         */
+        unload?(isAsync?: boolean): void | IPromise<void>;
+    }
+
+    /**
+     * This interface identifies the details of an internal performance event - it does not represent an outgoing reported event
+     */
+    interface IPerfEvent {
+        /**
+         * The name of the performance event
+         */
+        name: string;
+        /**
+         * The start time of the performance event
+         */
+        start: number;
+        /**
+         * The payload (contents) of the perfEvent, may be null or only set after the event has completed depending on
+         * the runtime environment.
+         */
+        payload: any;
+        /**
+         * Is this occurring from an asynchronous event
+         */
+        isAsync: boolean;
+        /**
+         * Identifies the total inclusive time spent for this event, including the time spent for child events,
+         * this will be undefined until the event is completed
+         */
+        time?: number;
+        /**
+         * Identifies the exclusive time spent in for this event (not including child events),
+         * this will be undefined until the event is completed.
+         */
+        exTime?: number;
+        /**
+         * The Parent event that was started before this event was created
+         */
+        parent?: IPerfEvent;
+        /**
+         * The child perf events that are contained within the total time of this event.
+         */
+        childEvts?: IPerfEvent[];
+        /**
+         * Identifies whether this event is a child event of a parent
+         */
+        isChildEvt: () => boolean;
+        /**
+         * Get the names additional context associated with this perf event
+         */
+        getCtx?: (key: string) => any;
+        /**
+         * Set the named additional context to be associated with this perf event, this will replace any existing value
+         */
+        setCtx?: (key: string, value: any) => void;
+        /**
+         * Mark this event as completed, calculating the total execution time.
+         */
+        complete: () => void;
+    }
+
+    /**
+     * This defines an internal performance manager for tracking and reporting the internal performance of the SDK -- It does
+     * not represent or report any event to the server.
+     */
+    interface IPerfManager {
+        /**
+         * Create a new event and start timing, the manager may return null/undefined to indicate that it does not
+         * want to monitor this source event.
+         * @param src - The source name of the event
+         * @param payloadDetails - An optional callback function to fetch the payload details for the event.
+         * @param isAsync - Is the event occurring from a async event
+         */
+        create(src: string, payloadDetails?: () => any, isAsync?: boolean): IPerfEvent | null | undefined;
+        /**
+         * Complete the perfEvent and fire any notifications.
+         * @param perfEvent - Fire the event which will also complete the passed event
+         */
+        fire(perfEvent: IPerfEvent): void;
+        /**
+         * Set an execution context value
+         * @param key - The context key name
+         * @param value - The value
+         */
+        setCtx(key: string, value: any): void;
+        /**
+         * Get the execution context value
+         * @param key - The context key
+         */
+        getCtx(key: string): any;
+    }
+
+    /**
+     * Identifies an interface to a host that can provide an IPerfManager implementation
+     */
+    interface IPerfManagerProvider {
+        /**
+         * Get the current performance manager
+         */
+        getPerfMgr(): IPerfManager;
+        /**
+         * Set the current performance manager
+         * @param perfMgr - The performance manager
+         */
+        setPerfMgr(perfMgr: IPerfManager): void;
+    }
+
     /**
      * @copyright Microsoft 2021
      */
@@ -73,6 +273,293 @@ declare namespace ApplicationInsights {
         };
     }
 
+    /**
+     * Create a Promise object that represents the eventual completion (or failure) of an asynchronous operation and its resulting value.
+     * This interface definition, closely mirrors the typescript / javascript PromiseLike<T> and Promise<T> definitions as well as providing
+     * simular functions as that provided by jQuery deferred objects.
+     *
+     * The returned Promise is a proxy for a value not necessarily known when the promise is created. It allows you to associate handlers
+     * with an asynchronous action's eventual success value or failure reason. This lets asynchronous methods return values like synchronous
+     * methods: instead of immediately returning the final value, the asynchronous method returns a promise to supply the value at some point
+     * in the future.
+     *
+     * A Promise is in one of these states:
+     * <ul>
+     * <li> pending: initial state, neither fulfilled nor rejected.
+     * <li> fulfilled: meaning that the operation was completed successfully.
+     * <li> rejected: meaning that the operation failed.
+     * </ul>
+     *
+     * A pending promise can either be fulfilled with a value or rejected with a reason (error). When either of these options happens, the
+     * associated handlers queued up by a promise's then method are called synchronously. If the promise has already been fulfilled or rejected
+     * when a corresponding handler is attached, the handler will be called synchronously, so there is no race condition between an asynchronous
+     * operation completing and its handlers being attached.
+     *
+     * As the `then()` and `catch()` methods return promises, they can be chained.
+     * @typeParam T - Identifies the expected return type from the promise
+     */
+    interface IPromise<T> extends PromiseLike<T>, Promise<T> {
+        /**
+         * Returns a string representation of the current state of the promise. The promise can be in one of four states.
+         * <ul>
+         * <li> <b>"pending"</b>: The promise is not yet in a completed state (neither "rejected"; or "resolved").</li>
+         * <li> <b>"resolved"</b>: The promise is in the resolved state.</li>
+         * <li> <b>"rejected"</b>: The promise is in the rejected state.</li>
+         * </ul>
+         * @example
+         * ```ts
+         * let doResolve;
+         * let promise: IPromise<any> = createSyncPromise((resolve) => {
+         *  doResolve = resolve;
+         * });
+         *
+         * let state: string = promise.state();
+         * console.log("State: " + state);      // State: pending
+         * doResolve(true);                     // Promise will resolve synchronously as it's a synchronous promise
+         * console.log("State: " + state);      // State: resolved
+         * ```
+         */
+        state?: string;
+        /**
+         * Attaches callbacks for the resolution and/or rejection of the Promise.
+         * @param onResolved The callback to execute when the Promise is resolved.
+         * @param onRejected The callback to execute when the Promise is rejected.
+         * @returns A Promise for the completion of which ever callback is executed.
+         * @example
+         * ```ts
+         * const promise1 = createPromise((resolve, reject) => {
+         *   resolve('Success!');
+         * });
+         *
+         * promise1.then((value) => {
+         *   console.log(value);
+         *   // expected output: "Success!"
+         * });
+         * ```
+         */
+        then<TResult1 = T, TResult2 = never>(onResolved?: ResolvedPromiseHandler<T, TResult1>, onRejected?: RejectedPromiseHandler<TResult2>): IPromise<TResult1 | TResult2>;
+        /**
+         * Attaches callbacks for the resolution and/or rejection of the Promise.
+         * @param onResolved The callback to execute when the Promise is resolved.
+         * @param onRejected The callback to execute when the Promise is rejected.
+         * @returns A Promise for the completion of which ever callback is executed.
+         * @example
+         * ```ts
+         * const promise1 = createPromise((resolve, reject) => {
+         *   resolve('Success!');
+         * });
+         *
+         * promise1.then((value) => {
+         *   console.log(value);
+         *   // expected output: "Success!"
+         * });
+         * ```
+         */
+        then<TResult1 = T, TResult2 = never>(onResolved?: ResolvedPromiseHandler<T, TResult1>, onRejected?: RejectedPromiseHandler<TResult2>): PromiseLike<TResult1 | TResult2>;
+        /**
+         * Attaches callbacks for the resolution and/or rejection of the Promise.
+         * @param onResolved The callback to execute when the Promise is resolved.
+         * @param onRejected The callback to execute when the Promise is rejected.
+         * @returns A Promise for the completion of which ever callback is executed.
+         * @example
+         * ```ts
+         * const promise1 = createPromise((resolve, reject) => {
+         *   resolve('Success!');
+         * });
+         *
+         * promise1.then((value) => {
+         *   console.log(value);
+         *   // expected output: "Success!"
+         * });
+         * ```
+         */
+        then<TResult1 = T, TResult2 = never>(onResolved?: ResolvedPromiseHandler<T, TResult1>, onRejected?: RejectedPromiseHandler<TResult2>): Promise<TResult1 | TResult2>;
+        /**
+         * Attaches a callback for only the rejection of the Promise.
+         * @param onRejected The callback to execute when the Promise is rejected.
+         * @returns A Promise for the completion of the callback.
+         * @example
+         * ```ts
+         * const promise1 = createPromise((resolve, reject) => {
+         *   throw 'Uh-oh!';
+         * });
+         *
+         * promise1.catch((error) => {
+         *   console.error(error);
+         * });
+         * // expected output: Uh-oh!
+         * ```
+         */
+        catch<TResult = never>(onRejected?: ((reason: any) => TResult | IPromise<TResult>) | undefined | null): IPromise<T | TResult>;
+        /**
+         * Attaches a callback for only the rejection of the Promise.
+         * @param onRejected The callback to execute when the Promise is rejected.
+         * @returns A Promise for the completion of the callback.
+         * @example
+         * ```ts
+         * const promise1 = createPromise((resolve, reject) => {
+         *   throw 'Uh-oh!';
+         * });
+         *
+         * promise1.catch((error) => {
+         *   console.error(error);
+         * });
+         * // expected output: Uh-oh!
+         * ```
+         */
+        catch<TResult = never>(onRejected?: ((reason: any) => TResult | IPromise<TResult>) | undefined | null): PromiseLike<T | TResult>;
+        /**
+         * Attaches a callback for only the rejection of the Promise.
+         * @param onRejected The callback to execute when the Promise is rejected.
+         * @returns A Promise for the completion of the callback.
+         * @example
+         * ```ts
+         * const promise1 = createPromise((resolve, reject) => {
+         *   throw 'Uh-oh!';
+         * });
+         *
+         * promise1.catch((error) => {
+         *   console.error(error);
+         * });
+         * // expected output: Uh-oh!
+         * ```
+         */
+        catch<TResult = never>(onRejected?: ((reason: any) => TResult | IPromise<TResult>) | undefined | null): Promise<T | TResult>;
+        /**
+         * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
+         * resolved value cannot be modified from the callback.
+         * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
+         * @returns A Promise for the completion of the callback.
+         * @example
+         * ```ts
+         * function doFunction() {
+         *   return createPromise((resolve, reject) => {
+         *     if (Math.random() > 0.5) {
+         *       resolve('Function has completed');
+         *     } else {
+         *       reject(new Error('Function failed to process'));
+         *     }
+         *   });
+         * }
+         *
+         * doFunction().then((data) => {
+         *     console.log(data);
+         * }).catch((err) => {
+         *     console.error(err);
+         * }).finally(() => {
+         *     console.log('Function processing completed');
+         * });
+         * ```
+         */
+        finally(onfinally?: FinallyPromiseHandler): IPromise<T>;
+        /**
+         * Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
+         * resolved value cannot be modified from the callback.
+         * @param onfinally The callback to execute when the Promise is settled (fulfilled or rejected).
+         * @returns A Promise for the completion of the callback.
+         * @example
+         * ```ts
+         * function doFunction() {
+         *   return createPromise((resolve, reject) => {
+         *     if (Math.random() > 0.5) {
+         *       resolve('Function has completed');
+         *     } else {
+         *       reject(new Error('Function failed to process'));
+         *     }
+         *   });
+         * }
+         *
+         * doFunction().then((data) => {
+         *     console.log(data);
+         * }).catch((err) => {
+         *     console.error(err);
+         * }).finally(() => {
+         *     console.log('Function processing completed');
+         * });
+         * ```
+         */
+        finally(onFinally?: FinallyPromiseHandler): Promise<T>;
+    }
+
+    /**
+     * Telemety item supported in Core
+     */
+    interface ITelemetryItem {
+        /**
+         * CommonSchema Version of this SDK
+         */
+        ver?: string;
+        /**
+         * Unique name of the telemetry item
+         */
+        name: string;
+        /**
+         * Timestamp when item was sent
+         */
+        time?: string;
+        /**
+         * Identifier of the resource that uniquely identifies which resource data is sent to
+         */
+        iKey?: string;
+        /**
+         * System context properties of the telemetry item, example: ip address, city etc
+         */
+        ext?: {
+            [key: string]: any;
+        };
+        /**
+         * System context property extensions that are not global (not in ctx)
+         */
+        tags?: Tags;
+        /**
+         * Custom data
+         */
+        data?: ICustomProperties;
+        /**
+         * Telemetry type used for part B
+         */
+        baseType?: string;
+        /**
+         * Based on schema for part B
+         */
+        baseData?: {
+            [key: string]: any;
+        };
+    }
+
+    class PerfManager implements IPerfManager {
+        /**
+         * General bucket used for execution context set and retrieved via setCtx() and getCtx.
+         * Defined as private so it can be visualized via the DebugPlugin
+         */
+        // private ctx;
+        constructor(manager?: INotificationManager);
+        /**
+         * Create a new event and start timing, the manager may return null/undefined to indicate that it does not
+         * want to monitor this source event.
+         * @param src - The source name of the event
+         * @param payloadDetails - An optional callback function to fetch the payload details for the event.
+         * @param isAsync - Is the event occurring from a async event
+         */
+        create(src: string, payload?: any, isAsync?: boolean): IPerfEvent | null | undefined;
+        /**
+         * Complete the perfEvent and fire any notifications.
+         * @param perfEvent - Fire the event which will also complete the passed event
+         */
+        fire(perfEvent: IPerfEvent): void;
+        /**
+         * Set an execution context value
+         * @param key - The context key name
+         * @param value - The value
+         */
+        setCtx(key: string, value: any): void;
+        /**
+         * Get the execution context value
+         * @param key - The context key
+         */
+        getCtx(key: string): any;
+    }
+
     class PerfMarkMeasureManager extends PerfManager {
         constructor(config?: IPerfMarkMeasureConfiguration, manager?: INotificationManager);
         /**
@@ -90,5 +577,22 @@ declare namespace ApplicationInsights {
         fire(perfEvent: IPerfEvent): void;
     }
 
-    
+    /**
+     * This defines the handler function for when a promise is rejected.
+     * @param value This is the value passed as part of resolving the Promise
+     * @return This may return a value, another Promise or void. @see {@link IPromise.then} for how the value is handled.
+     */
+    type RejectedPromiseHandler<T = never> = (((reason: any) => T | IPromise<T> | PromiseLike<T>) | undefined | null);
+
+    /**
+     * This defines the handler function for when a promise is resolved.
+     * @param value This is the value passed as part of resolving the Promise
+     * @return This may return a value, another Promise or void. @see {@link IPromise.then} for how the value is handled.
+     */
+    type ResolvedPromiseHandler<T, TResult1 = T> = (((value: T) => TResult1 | IPromise<TResult1> | PromiseLike<TResult1>) | undefined | null);
+
+    interface Tags {
+        [key: string]: any;
+    }
+
 }