@microsoft/applicationinsights-common 3.0.0-beta.2210-19 → 3.0.0-beta.2211-01

package/dist/applicationinsights-common.api.md

@@ -6,9 +6,11 @@
 
 import { createTraceParent } from '@microsoft/applicationinsights-core-js';
 import { _eInternalMessageId } from '@microsoft/applicationinsights-core-js';
+import { eLoggingSeverity } from '@microsoft/applicationinsights-core-js';
 import { EnumValue } from '@microsoft/applicationinsights-core-js';
 import { findW3cTraceParent } from '@microsoft/applicationinsights-core-js';
 import { formatTraceParent } from '@microsoft/applicationinsights-core-js';
+import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
 import { IChannelControls } from '@microsoft/applicationinsights-core-js';
 import { IConfiguration } from '@microsoft/applicationinsights-core-js';
 import { ICookieMgr } from '@microsoft/applicationinsights-core-js';
@@ -838,6 +840,50 @@ export interface ITelemetryTrace {
     traceState?: ITraceState;
 }
 
+// @public
+export interface IThrottleInterval {
+    dayInterval?: number;
+    maxTimesPerMonth?: number;
+    monthInterval?: number;
+}
+
+// @public
+export interface IThrottleLimit {
+    maxSendNumber?: number;
+    samplingRate?: number;
+}
+
+// @public
+export interface IThrottleLocalStorageObj {
+    count: number;
+    date: Date;
+    preTriggerDate?: Date;
+}
+
+// @public
+export interface IThrottleMgrConfig {
+    disabled?: boolean;
+    interval?: IThrottleInterval;
+    limit?: IThrottleLimit;
+    msgKey: IThrottleMsgKey;
+}
+
+// @public (undocumented)
+export const enum IThrottleMsgKey {
+    // (undocumented)
+    cdnDeprecate = 2,
+    // (undocumented)
+    default = 0,
+    // (undocumented)
+    ikeyDeprecate = 1
+}
+
+// @public
+export interface IThrottleResult {
+    isThrottled: boolean;
+    throttleNum: number;
+}
+
 export { ITraceParent }
 
 // @public (undocumented)
@@ -1083,6 +1129,25 @@ export class TelemetryItemCreator {
     static create: typeof createTelemetryItem;
 }
 
+// @public (undocumented)
+export class ThrottleMgr {
+    constructor(throttleMgr?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string);
+    // (undocumented)
+    canThrottle: () => boolean;
+    // (undocumented)
+    flush: () => boolean;
+    // (undocumented)
+    getConfig: () => IThrottleMgrConfig;
+    // (undocumented)
+    isReady: () => boolean;
+    // (undocumented)
+    isTriggered: () => boolean;
+    // (undocumented)
+    onReadyState: (isReady?: boolean) => boolean;
+    // (undocumented)
+    sendMessage: (msgID: _eInternalMessageId, message: string, severity?: eLoggingSeverity) => IThrottleResult | null;
+}
+
 // Warning: (ae-forgotten-export) The symbol "IMessageData" needs to be exported by the entry point applicationinsights-common.d.ts
 //
 // @public (undocumented)

package/dist/applicationinsights-common.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft Application Insights Common JavaScript Library, 3.0.0-beta.2210-19
+ * Microsoft Application Insights Common JavaScript Library, 3.0.0-beta.2211-01
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -9,9 +9,11 @@
 declare namespace ApplicationInsights {
     import { createTraceParent } from '@microsoft/applicationinsights-core-js';
     import { _eInternalMessageId } from '@microsoft/applicationinsights-core-js';
+    import { eLoggingSeverity } from '@microsoft/applicationinsights-core-js';
     import { EnumValue } from '@microsoft/applicationinsights-core-js';
     import { findW3cTraceParent } from '@microsoft/applicationinsights-core-js';
     import { formatTraceParent } from '@microsoft/applicationinsights-core-js';
+    import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
     import { IChannelControls } from '@microsoft/applicationinsights-core-js';
     import { IConfiguration } from '@microsoft/applicationinsights-core-js';
     import { ICookieMgr } from '@microsoft/applicationinsights-core-js';
@@ -1955,6 +1957,110 @@ declare namespace ApplicationInsights {
         name?: string;
     }
 
+    /**
+     * Identifies frequency of items sent
+     * Default: send data on 28th every 3 month each year
+     */
+    interface IThrottleInterval {
+        /**
+         * Identifies month interval that items can be sent
+         * For example, if it is set to 2 and start date is in Jan, items will be sent out every two months (Jan, March, May etc.)
+         * Default: 3
+         */
+        monthInterval?: number;
+        /**
+         * Identifies days that items can be sent within a month
+         * Default: 28
+         */
+        dayInterval?: number;
+        /**
+         * Identifies max times items can be sent within a month
+         * Default: 1
+         */
+        maxTimesPerMonth?: number;
+    }
+
+    /**
+     * Identifies limit number/percentage of items sent per time
+     * If both are provided, minimum number between the two will be used
+     */
+    interface IThrottleLimit {
+        /**
+         * Identifies sampling percentage of items per time
+         * The percentage is set to 4 decimal places, for example: 1 means 0.0001%
+         * Default: 100 (0.01%)
+         */
+        samplingRate?: number;
+        /**
+         * Identifies limit number of items per time
+         * Default: 1
+         */
+        maxSendNumber?: number;
+    }
+
+    /**
+     * Identifies object for local storage
+     */
+    interface IThrottleLocalStorageObj {
+        /**
+         * Identifies start date
+         */
+        date: Date;
+        /**
+         * Identifies current count
+         */
+        count: number;
+        /**
+         * identifies previous triggered throttle date
+         */
+        preTriggerDate?: Date;
+    }
+
+    /**
+     * Identifies basic config
+     */
+    interface IThrottleMgrConfig {
+        /**
+         * Identifies message key to be used for local storage key
+         */
+        msgKey: IThrottleMsgKey;
+        /**
+         * Identifies if throttle is disabled
+         * Default: false
+         */
+        disabled?: boolean;
+        /**
+         * Identifies limit number/percentage of items sent per time
+         */
+        limit?: IThrottleLimit;
+        /**
+         * Identifies frequency of items sent
+         * Default: send data on 28th every 3 month each year
+         */
+        interval?: IThrottleInterval;
+    }
+
+    const enum IThrottleMsgKey {
+        default = 0,
+        ikeyDeprecate = 1,
+        cdnDeprecate = 2
+    }
+
+    /**
+     * Identifies throttle result
+     */
+    interface IThrottleResult {
+        /**
+         * Identifies if items are sent
+         */
+        isThrottled: boolean;
+        /**
+         * Identifies numbers of items are sent
+         * if isThrottled is false, it will be set to 0
+         */
+        throttleNum: number;
+    }
+
     export { ITraceParent }
 
     interface ITraceState {
@@ -2345,6 +2451,17 @@ declare namespace ApplicationInsights {
         static create: typeof createTelemetryItem;
     }
 
+    class ThrottleMgr {
+        canThrottle: () => boolean;
+        sendMessage: (msgID: _eInternalMessageId, message: string, severity?: eLoggingSeverity) => IThrottleResult | null;
+        getConfig: () => IThrottleMgrConfig;
+        isTriggered: () => boolean;
+        isReady: () => boolean;
+        onReadyState: (isReady?: boolean) => boolean;
+        flush: () => boolean;
+        constructor(throttleMgr?: IThrottleMgrConfig, core?: IAppInsightsCore, namePrefix?: string);
+    }
+
     class Trace implements IMessageData, ISerializable {
         static envelopeType: string;
         static dataType: string;