@microsoft/applicationinsights-analytics-js 2.7.5-nightly.2203-03 → 2.7.5

package/dist/applicationinsights-analytics-js.api.md

@@ -12,6 +12,7 @@ import { IConfig } from '@microsoft/applicationinsights-common';
 import { IConfiguration } from '@microsoft/applicationinsights-core-js';
 import { ICookieMgr } from '@microsoft/applicationinsights-core-js';
 import { ICustomProperties } from '@microsoft/applicationinsights-core-js';
+import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
 import { IEventTelemetry } from '@microsoft/applicationinsights-common';
 import { IExceptionTelemetry } from '@microsoft/applicationinsights-common';
 import { IMetricTelemetry } from '@microsoft/applicationinsights-common';
@@ -21,30 +22,39 @@ import { IPageViewTelemetry } from '@microsoft/applicationinsights-common';
 import { IPageViewTelemetryInternal } from '@microsoft/applicationinsights-common';
 import { IPlugin } from '@microsoft/applicationinsights-core-js';
 import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
-import { ITelemetryInitializerHandler } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
 import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
 import { ITraceTelemetry } from '@microsoft/applicationinsights-common';
 
 // @public (undocumented)
-class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
+export class ApplicationInsights extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
     constructor();
     // (undocumented)
-    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler | void;
+    addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
     // (undocumented)
     autoRoutePVDelay: number;
     // (undocumented)
     config: IConfig;
     getCookieMgr(): ICookieMgr;
-    // Warning: (ae-forgotten-export) The symbol "_getDefaultConfig" needs to be exported by the entry point applicationinsights-analytics-js.d.ts
-    //
     // (undocumented)
-    static getDefaultConfig: typeof _getDefaultConfig;
+    static getDefaultConfig(config?: IConfig): IConfig;
     // (undocumented)
     identifier: string;
     // (undocumented)
     initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     _onerror(exception: IAutoExceptionTelemetry): void;
+    // Warning: (ae-forgotten-export) The symbol "PageViewManager" needs to be exported by the entry point applicationinsights-analytics-js.d.ts
+    //
+    // (undocumented)
+    protected _pageViewManager: PageViewManager;
+    // Warning: (ae-forgotten-export) The symbol "PageViewPerformanceManager" needs to be exported by the entry point applicationinsights-analytics-js.d.ts
+    //
+    // (undocumented)
+    protected _pageViewPerformanceManager: PageViewPerformanceManager;
+    // Warning: (ae-forgotten-export) The symbol "PageVisitTimeManager" needs to be exported by the entry point applicationinsights-analytics-js.d.ts
+    //
+    // (undocumented)
+    protected _pageVisitTimeManager: PageVisitTimeManager;
     // (undocumented)
     priority: number;
     // (undocumented)
@@ -79,6 +89,8 @@ class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights, IAppI
         [key: string]: number;
     }): void;
     // (undocumented)
+    protected _telemetryInitializers: Array<(envelope: ITelemetryItem) => boolean | void>;
+    // (undocumented)
     trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
     trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
     trackMetric(metric: IMetricTelemetry, customProperties?: ICustomProperties): void;
@@ -88,8 +100,6 @@ class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights, IAppI
     // (undocumented)
     static Version: string;
 }
-export { AnalyticsPlugin }
-export { AnalyticsPlugin as ApplicationInsights }
 
 // @public
 export interface IAppInsightsInternal {

package/dist/applicationinsights-analytics-js.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights JavaScript SDK - Web Analytics, 2.7.5-nightly.2203-03
+ * Microsoft Application Insights JavaScript SDK - Web Analytics, 2.7.5
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -15,6 +15,7 @@ declare namespace ApplicationInsights {
     import { IConfiguration } from '@microsoft/applicationinsights-core-js';
     import { ICookieMgr } from '@microsoft/applicationinsights-core-js';
     import { ICustomProperties } from '@microsoft/applicationinsights-core-js';
+    import { IDiagnosticLogger } from '@microsoft/applicationinsights-core-js';
     import { IEventTelemetry } from '@microsoft/applicationinsights-common';
     import { IExceptionTelemetry } from '@microsoft/applicationinsights-common';
     import { IMetricTelemetry } from '@microsoft/applicationinsights-common';
@@ -24,19 +25,22 @@ declare namespace ApplicationInsights {
     import { IPageViewTelemetryInternal } from '@microsoft/applicationinsights-common';
     import { IPlugin } from '@microsoft/applicationinsights-core-js';
     import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
-    import { ITelemetryInitializerHandler } from '@microsoft/applicationinsights-core-js';
     import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
     import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
     import { ITraceTelemetry } from '@microsoft/applicationinsights-common';
 
-    class AnalyticsPlugin extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
+    class ApplicationInsights extends BaseTelemetryPlugin implements IAppInsights, IAppInsightsInternal {
         static Version: string;
-        static getDefaultConfig: typeof _getDefaultConfig;
+        static getDefaultConfig(config?: IConfig): IConfig;
         identifier: string;
         priority: number;
         config: IConfig;
         queue: Array<() => void>;
         autoRoutePVDelay: number;
+        protected _telemetryInitializers: Array<(envelope: ITelemetryItem) => boolean | void>;
+        protected _pageViewManager: PageViewManager;
+        protected _pageViewPerformanceManager: PageViewPerformanceManager;
+        protected _pageVisitTimeManager: PageVisitTimeManager;
         constructor();
         /**
          * Get the current cookie manager for this instance
@@ -160,13 +164,9 @@ declare namespace ApplicationInsights {
          * @memberof ApplicationInsights
          */
         _onerror(exception: IAutoExceptionTelemetry): void;
-        addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): ITelemetryInitializerHandler | void;
+        addTelemetryInitializer(telemetryInitializer: (item: ITelemetryItem) => boolean | void): void;
         initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
     }
-    export { AnalyticsPlugin }
-    export { AnalyticsPlugin as ApplicationInsights }
-
-    function _getDefaultConfig(config?: IConfig): IConfig;
 
     /**
      * Internal interface to pass appInsights object to subcomponents without coupling
@@ -176,5 +176,100 @@ declare namespace ApplicationInsights {
         sendPageViewPerformanceInternal(pageViewPerformance: IPageViewPerformanceTelemetryInternal, properties?: Object, systemProperties?: Object): void;
     }
 
+    /**
+     * Class encapsulates sending page views and page view performance telemetry.
+     */
+    class PageViewManager {
+        constructor(appInsights: IAppInsightsInternal, overridePageViewDuration: boolean, core: IAppInsightsCore, pageViewPerformanceManager: PageViewPerformanceManager);
+        /**
+         * Currently supported cases:
+         * 1) (default case) track page view called with default parameters, overridePageViewDuration = false. Page view is sent with page view performance when navigation timing data is available.
+         *    a. If navigation timing is not supported then page view is sent right away with undefined duration. Page view performance is not sent.
+         * 2) overridePageViewDuration = true, custom duration provided. Custom duration is used, page view sends right away.
+         * 3) overridePageViewDuration = true, custom duration NOT provided. Page view is sent right away, duration is time spent from page load till now (or undefined if navigation timing is not supported).
+         * 4) overridePageViewDuration = false, custom duration is provided. Page view is sent right away with custom duration.
+         *
+         * In all cases page view performance is sent once (only for the 1st call of trackPageView), or not sent if navigation timing is not supported.
+         */
+        trackPageView(pageView: IPageViewTelemetry, customProperties?: {
+            [key: string]: any;
+        }): void;
+    }
+
+    /**
+     * Class encapsulates sending page view performance telemetry.
+     */
+    class PageViewPerformanceManager {
+        private _logger;
+        private MAX_DURATION_ALLOWED;
+        constructor(core: IAppInsightsCore);
+        populatePageViewPerformanceEvent(pageViewPerformance: IPageViewPerformanceTelemetryInternal): void;
+        getPerformanceTiming(): PerformanceTiming | null;
+        getPerformanceNavigationTiming(): PerformanceNavigationTiming | null;
+        /**
+         * Returns true is window PerformanceNavigationTiming API is supported, false otherwise.
+         */
+        isPerformanceNavigationTimingSupported(): boolean;
+        /**
+         * Returns true is window performance timing API is supported, false otherwise.
+         */
+        isPerformanceTimingSupported(): PerformanceTiming;
+        /**
+         * As page loads different parts of performance timing numbers get set. When all of them are set we can report it.
+         * Returns true if ready, false otherwise.
+         */
+        isPerformanceTimingDataReady(): boolean;
+        /**
+         * This method tells if given durations should be excluded from collection.
+         */
+        shouldCollectDuration(...durations: number[]): boolean;
+    }
+
+    class PageVisitData {
+        pageName: string;
+        pageUrl: string;
+        pageVisitStartTime: number;
+        pageVisitTime: number;
+        constructor(pageName: string, pageUrl: string);
+    }
+
+    /**
+     * Used to track page visit durations
+     */
+    class PageVisitTimeManager {
+        private prevPageVisitDataKeyName;
+        private pageVisitTimeTrackingHandler;
+        private _logger;
+        /**
+         * Creates a new instance of PageVisitTimeManager
+         * @param pageVisitTimeTrackingHandler Delegate that will be called to send telemetry data to AI (when trackPreviousPageVisit is called)
+         * @returns {}
+         */
+        constructor(logger: IDiagnosticLogger, pageVisitTimeTrackingHandler: (pageName: string, pageUrl: string, pageVisitTime: number) => void);
+        /**
+         * Tracks the previous page visit time telemetry (if exists) and starts timing of new page visit time
+         * @param currentPageName Name of page to begin timing for visit duration
+         * @param currentPageUrl Url of page to begin timing for visit duration
+         */
+        trackPreviousPageVisit(currentPageName: string, currentPageUrl: string): void;
+        /**
+         * Stops timing of current page (if exists) and starts timing for duration of visit to pageName
+         * @param pageName Name of page to begin timing visit duration
+         * @returns {PageVisitData} Page visit data (including duration) of pageName from last call to start or restart, if exists. Null if not.
+         */
+        restartPageVisitTimer(pageName: string, pageUrl: string): PageVisitData;
+        /**
+         * Starts timing visit duration of pageName
+         * @param pageName
+         * @returns {}
+         */
+        startPageVisitTimer(pageName: string, pageUrl: string): void;
+        /**
+         * Stops timing of current page, if exists.
+         * @returns {PageVisitData} Page visit data (including duration) of pageName from call to start, if exists. Null if not.
+         */
+        stopPageVisitTimer(): PageVisitData;
+    }
+
     
 }