@microsoft/applicationinsights-react-js 19.3.7-nightly.2507-04 → 19.3.7-nightly.2507-06

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

@@ -0,0 +1,129 @@
+## API Report File for "@microsoft/applicationinsights-react-js"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+import { Context } from 'react';
+import { Dispatch } from 'react';
+import { History as History_2 } from 'history';
+import { IAppInsights } from '@microsoft/applicationinsights-common';
+import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
+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 { IEventTelemetry } from '@microsoft/applicationinsights-common';
+import { IExceptionTelemetry } from '@microsoft/applicationinsights-common';
+import { IMetricTelemetry } from '@microsoft/applicationinsights-common';
+import { IPageViewTelemetry } from '@microsoft/applicationinsights-common';
+import { IPlugin } from '@microsoft/applicationinsights-core-js';
+import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
+import { ITelemetryContext } from '@microsoft/applicationinsights-common';
+import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
+import { ITraceTelemetry } from '@microsoft/applicationinsights-common';
+import * as React_2 from 'react';
+import { default as React_3 } from 'react';
+import { SetStateAction } from 'react';
+
+// @public
+export abstract class AITrackedComponentBase<P> extends React_2.Component<P> {
+    constructor(props: P, reactPlugin: ReactPlugin, componentName: string);
+    // (undocumented)
+    componentDidMount(): void;
+    // (undocumented)
+    protected _componentName: string;
+    // (undocumented)
+    componentWillUnmount(): void;
+    // (undocumented)
+    protected _firstActiveTimestamp: number;
+    // (undocumented)
+    protected _idleCount: number;
+    // (undocumented)
+    protected _idleStartTimestamp: number;
+    // (undocumented)
+    protected _idleTimeout: number;
+    // (undocumented)
+    protected _intervalId?: any;
+    // (undocumented)
+    protected _lastActiveTimestamp: number;
+    // (undocumented)
+    protected _mountTimestamp: number;
+    // (undocumented)
+    protected _reactPlugin: ReactPlugin;
+    // (undocumented)
+    protected _totalIdleTime: number;
+    // (undocumented)
+    protected trackActivity: (e: React_2.SyntheticEvent<any>) => void;
+}
+
+// Warning: (ae-forgotten-export) The symbol "AppInsightsReactContext" needs to be exported by the entry point applicationinsights-react-js.d.ts
+//
+// @public (undocumented)
+export const AppInsightsContext: AppInsightsReactContext;
+
+// Warning: (ae-forgotten-export) The symbol "IAppInsightsErrorBoundaryProps" needs to be exported by the entry point applicationinsights-react-js.d.ts
+// Warning: (ae-forgotten-export) The symbol "IAppInsightsErrorBoundaryState" needs to be exported by the entry point applicationinsights-react-js.d.ts
+//
+// @public (undocumented)
+export class AppInsightsErrorBoundary extends React_3.Component<IAppInsightsErrorBoundaryProps, IAppInsightsErrorBoundaryState> {
+    // (undocumented)
+    componentDidCatch(error: Error, errorInfo: React_3.ErrorInfo): void;
+    // (undocumented)
+    render(): React_3.ReactElement<unknown, string | React_3.JSXElementConstructor<any>>;
+    // (undocumented)
+    state: {
+        hasError: boolean;
+    };
+}
+
+// @public
+export interface IReactExtensionConfig {
+    readonly history?: History_2;
+}
+
+// @public (undocumented)
+export class ReactPlugin extends BaseTelemetryPlugin {
+    constructor();
+    // (undocumented)
+    readonly context: ITelemetryContext;
+    getAppInsights(): IAppInsights;
+    getCookieMgr(): ICookieMgr;
+    // (undocumented)
+    identifier: string;
+    // (undocumented)
+    initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
+    // (undocumented)
+    priority: number;
+    processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    // (undocumented)
+    trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
+    // (undocumented)
+    trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
+    // (undocumented)
+    trackMetric(metric: IMetricTelemetry, customProperties: ICustomProperties): void;
+    // (undocumented)
+    trackPageView(pageView: IPageViewTelemetry): void;
+    // (undocumented)
+    trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void;
+}
+
+// @public (undocumented)
+export const useAppInsightsContext: () => ReactPlugin;
+
+// Warning: (ae-forgotten-export) The symbol "AIReactCustomEvent" needs to be exported by the entry point applicationinsights-react-js.d.ts
+//
+// @public (undocumented)
+export function useTrackEvent<T>(reactPlugin: ReactPlugin, eventName: string, eventData: T, skipFirstRun?: boolean): AIReactCustomEvent<T>;
+
+// @public (undocumented)
+export const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string, customProperties?: ICustomProperties) => () => void;
+
+// @public
+export function withAITracking<P>(reactPlugin: ReactPlugin, Component: React_2.ComponentType<P>, componentName?: string, className?: string): React_2.ComponentClass<P>;
+
+// (No @packageDocumentation comment for this package)
+
+```

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

@@ -0,0 +1,137 @@
+/*
+ * Microsoft Application Insights react plugin, 19.3.7-nightly.2507-06
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ *
+ * Microsoft Application Insights Team
+ * https://github.com/microsoft/applicationinsights-react-js#readme
+ */
+
+declare namespace ApplicationInsights {
+    import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+    import { Context } from 'react';
+    import { Dispatch } from 'react';
+    import { History as History_2 } from 'history';
+    import { IAppInsights } from '@microsoft/applicationinsights-common';
+    import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
+    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 { IEventTelemetry } from '@microsoft/applicationinsights-common';
+    import { IExceptionTelemetry } from '@microsoft/applicationinsights-common';
+    import { IMetricTelemetry } from '@microsoft/applicationinsights-common';
+    import { IPageViewTelemetry } from '@microsoft/applicationinsights-common';
+    import { IPlugin } from '@microsoft/applicationinsights-core-js';
+    import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryContext } from '@microsoft/applicationinsights-common';
+    import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
+    import { ITraceTelemetry } from '@microsoft/applicationinsights-common';
+    import * as React_2 from 'react';
+    import { default as React_3 } from 'react';
+    import { SetStateAction } from 'react';
+
+    type AIReactCustomEvent<T> = Dispatch<SetStateAction<T>>;
+
+    /**
+     * Higher-order component base class to hook Application Insights tracking
+     * in a React component's lifecycle.
+     */
+    abstract class AITrackedComponentBase<P> extends React_2.Component<P> {
+        protected _mountTimestamp: number;
+        protected _firstActiveTimestamp: number;
+        protected _idleStartTimestamp: number;
+        protected _lastActiveTimestamp: number;
+        protected _totalIdleTime: number;
+        protected _idleCount: number;
+        protected _idleTimeout: number;
+        protected _intervalId?: any;
+        protected _componentName: string;
+        protected _reactPlugin: ReactPlugin;
+        constructor(props: P, reactPlugin: ReactPlugin, componentName: string);
+        componentDidMount(): void;
+        componentWillUnmount(): void;
+        protected trackActivity: (e: React_2.SyntheticEvent<any>) => void;
+        private getEngagementTimeSeconds;
+    }
+
+    const AppInsightsContext: AppInsightsReactContext;
+
+    class AppInsightsErrorBoundary extends React_3.Component<IAppInsightsErrorBoundaryProps, IAppInsightsErrorBoundaryState> {
+        state: {
+            hasError: boolean;
+        };
+        componentDidCatch(error: Error, errorInfo: React_3.ErrorInfo): void;
+        render(): React_3.ReactElement<unknown, string | React_3.JSXElementConstructor<any>>;
+    }
+
+    type AppInsightsReactContext = Context<ReactPlugin>;
+
+    interface IAppInsightsErrorBoundaryProps {
+        appInsights: ReactPlugin;
+        onError: React_3.ComponentType<any>;
+        children: React_3.ReactElement;
+    }
+
+    interface IAppInsightsErrorBoundaryState {
+        hasError: boolean;
+    }
+
+    /**
+     * Settings to initialize a ReactAI instance.
+     */
+    interface IReactExtensionConfig {
+        /**
+         * React router history for enabling Application Insights PageView tracking.
+         *
+         * @type {History}
+         * @memberof IReactAISettings
+         */
+        readonly history?: History_2;
+    }
+
+    class ReactPlugin extends BaseTelemetryPlugin {
+        priority: number;
+        identifier: string;
+        readonly context: ITelemetryContext;
+        constructor();
+        initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
+        /**
+         * Get the current cookie manager for this instance
+         */
+        getCookieMgr(): ICookieMgr;
+        /**
+         * Get application insights instance.
+         */
+        getAppInsights(): IAppInsights;
+        /**
+         * Add Part A fields to the event
+         * @param event The event that needs to be processed
+         */
+        processTelemetry(event: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+        trackMetric(metric: IMetricTelemetry, customProperties: ICustomProperties): void;
+        trackPageView(pageView: IPageViewTelemetry): void;
+        trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
+        trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
+        trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void;
+    }
+
+    const useAppInsightsContext: () => ReactPlugin;
+
+    function useTrackEvent<T>(reactPlugin: ReactPlugin, eventName: string, eventData: T, skipFirstRun?: boolean): AIReactCustomEvent<T>;
+
+    const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string, customProperties?: ICustomProperties) => () => void;
+
+    /**
+     * Higher-order component function to hook Application Insights tracking
+     * in a React component's lifecycle.
+     *
+     * @param reactPlugin ReactPlugin instance
+     * @param Component the React component to be instrumented
+     * @param componentName (optional) component name
+     * @param className (optional) className of the HOC div
+     */
+    function withAITracking<P>(reactPlugin: ReactPlugin, Component: React_2.ComponentType<P>, componentName?: string, className?: string): React_2.ComponentClass<P>;
+
+    
+}