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

package/src/applicationinsights-common.ts

@@ -5,6 +5,7 @@ export {
     correlationIdGetCorrelationContextValue, dateTimeUtilsNow, dateTimeUtilsDuration, isInternalApplicationInsightsEndpoint,
     createDistributedTraceContextFromTrace
 } from "./Util";
+export { ThrottleMgr } from "./ThrottleMgr";
 export { parseConnectionString, ConnectionStringParser } from "./ConnectionStringParser";
 export { FieldType } from "./Enums";
 export { IRequestHeaders, RequestHeaders, eRequestHeaders } from "./RequestResponseHeaders";
@@ -57,7 +58,8 @@ export { IPropertiesPlugin } from "./Interfaces/IPropertiesPlugin";
 export { IUser, IUserContext } from "./Interfaces/Context/IUser";
 export { ITelemetryTrace, ITraceState } from "./Interfaces/Context/ITelemetryTrace";
 export { IRequestContext } from "./Interfaces/IRequestContext";
-export { eDistributedTracingModes, DistributedTracingModes } from "./Enums";
+export { IThrottleLocalStorageObj, IThrottleMgrConfig, IThrottleResult, IThrottleLimit, IThrottleInterval } from "./Interfaces/IThrottleMgr";
+export { eDistributedTracingModes, DistributedTracingModes, IThrottleMsgKey } from "./Enums";
 export { stringToBoolOrDefault, msToTimeSpan, getExtensionByName, isCrossOriginError } from "./HelperFuncs";
 export {
     isBeaconsSupported as isBeaconApiSupported,

package/types/Enums.d.ts

@@ -33,3 +33,8 @@ export declare const enum eDistributedTracingModes {
 }
 export declare const DistributedTracingModes: import("@microsoft/applicationinsights-core-js").EnumValue<typeof eDistributedTracingModes>;
 export declare type DistributedTracingModes = number | eDistributedTracingModes;
+export declare const enum IThrottleMsgKey {
+    default = 0,
+    ikeyDeprecate = 1,
+    cdnDeprecate = 2
+}

package/types/Interfaces/IThrottleMgr.d.ts

@@ -0,0 +1,94 @@
+import { IThrottleMsgKey } from "../Enums";
+/**
+ * Identifies limit number/percentage of items sent per time
+ * If both are provided, minimum number between the two will be used
+ */
+export 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 frequency of items sent
+ * Default: send data on 28th every 3 month each year
+ */
+export 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 basic config
+*/
+export 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;
+}
+/**
+* Identifies object for local storage
+*/
+export interface IThrottleLocalStorageObj {
+    /**
+    * Identifies start date
+    */
+    date: Date;
+    /**
+    * Identifies current count
+    */
+    count: number;
+    /**
+     * identifies previous triggered throttle date
+     */
+    preTriggerDate?: Date;
+}
+/**
+* Identifies throttle result
+*/
+export 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;
+}

package/types/ThrottleMgr.d.ts

@@ -0,0 +1,12 @@
+import { IAppInsightsCore, _eInternalMessageId, eLoggingSeverity } from "@microsoft/applicationinsights-core-js";
+import { IThrottleMgrConfig, IThrottleResult } from "./Interfaces/IThrottleMgr";
+export declare 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);
+}

package/types/__DynamicConstants.d.ts

@@ -3,29 +3,35 @@ export declare const _DYN_LENGTH = "length";
 export declare const _DYN_TO_LOWER_CASE = "toLowerCase";
 export declare const _DYN_INGESTIONENDPOINT = "ingestionendpoint";
 export declare const _DYN_TO_STRING = "toString";
-export declare const _DYN_REMOVE_ITEM = "removeItem";
-export declare const _DYN_NAME = "name";
-export declare const _DYN_PATHNAME = "pathname";
-export declare const _DYN_CORRELATION_HEADER_E0 = "correlationHeaderExcludePatterns";
 export declare const _DYN_EXTENSION_CONFIG = "extensionConfig";
 export declare const _DYN_EXCEPTIONS = "exceptions";
 export declare const _DYN_PARSED_STACK = "parsedStack";
+export declare const _DYN_REMOVE_ITEM = "removeItem";
+export declare const _DYN_SUBSTRING = "substring";
+export declare const _DYN_STRINGIFY = "stringify";
+export declare const _DYN_NAME = "name";
 export declare const _DYN_PROPERTIES = "properties";
 export declare const _DYN_MEASUREMENTS = "measurements";
-export declare const _DYN_STRINGIFY = "stringify";
 export declare const _DYN_MESSAGE = "message";
 export declare const _DYN_SIZE_IN_BYTES = "sizeInBytes";
 export declare const _DYN_TYPE_NAME = "typeName";
 export declare const _DYN_SEVERITY_LEVEL = "severityLevel";
 export declare const _DYN_PROBLEM_GROUP = "problemGroup";
 export declare const _DYN_IS_MANUAL = "isManual";
-export declare const _DYN__CREATE_FROM_INTERFA1 = "CreateFromInterface";
+export declare const _DYN__CREATE_FROM_INTERFA0 = "CreateFromInterface";
 export declare const _DYN_HAS_FULL_STACK = "hasFullStack";
 export declare const _DYN_LEVEL = "level";
 export declare const _DYN_METHOD = "method";
 export declare const _DYN_ASSEMBLY = "assembly";
 export declare const _DYN_FILE_NAME = "fileName";
 export declare const _DYN_LINE = "line";
+export declare const _DYN_COUNT = "count";
 export declare const _DYN_DURATION = "duration";
 export declare const _DYN_RECEIVED_RESPONSE = "receivedResponse";
-export declare const _DYN_SUBSTRING = "substring";
+export declare const _DYN_PRE_TRIGGER_DATE = "preTriggerDate";
+export declare const _DYN_DISABLED = "disabled";
+export declare const _DYN_DATE = "date";
+export declare const _DYN_GET_UTCDATE = "getUTCDate";
+export declare const _DYN_MAX_TIMES_PER_MONTH = "maxTimesPerMonth";
+export declare const _DYN_PATHNAME = "pathname";
+export declare const _DYN_CORRELATION_HEADER_E1 = "correlationHeaderExcludePatterns";

package/types/applicationinsights-common.d.ts

@@ -1,4 +1,5 @@
 export { correlationIdSetPrefix, correlationIdGetPrefix, correlationIdCanIncludeCorrelationHeader, correlationIdGetCorrelationContext, correlationIdGetCorrelationContextValue, dateTimeUtilsNow, dateTimeUtilsDuration, isInternalApplicationInsightsEndpoint, createDistributedTraceContextFromTrace } from "./Util";
+export { ThrottleMgr } from "./ThrottleMgr";
 export { parseConnectionString, ConnectionStringParser } from "./ConnectionStringParser";
 export { FieldType } from "./Enums";
 export { IRequestHeaders, RequestHeaders, eRequestHeaders } from "./RequestResponseHeaders";
@@ -46,7 +47,8 @@ export { IPropertiesPlugin } from "./Interfaces/IPropertiesPlugin";
 export { IUser, IUserContext } from "./Interfaces/Context/IUser";
 export { ITelemetryTrace, ITraceState } from "./Interfaces/Context/ITelemetryTrace";
 export { IRequestContext } from "./Interfaces/IRequestContext";
-export { eDistributedTracingModes, DistributedTracingModes } from "./Enums";
+export { IThrottleLocalStorageObj, IThrottleMgrConfig, IThrottleResult, IThrottleLimit, IThrottleInterval } from "./Interfaces/IThrottleMgr";
+export { eDistributedTracingModes, DistributedTracingModes, IThrottleMsgKey } from "./Enums";
 export { stringToBoolOrDefault, msToTimeSpan, getExtensionByName, isCrossOriginError } from "./HelperFuncs";
 export { isBeaconsSupported as isBeaconApiSupported, ITraceParent, createTraceParent, parseTraceParent, isValidTraceId, isValidSpanId, isValidTraceParent, isSampledFlag, formatTraceParent, findW3cTraceParent } from "@microsoft/applicationinsights-core-js";
 export { createDomEvent } from "./DomHelperFuncs";

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.33.4"
+      "packageVersion": "7.33.6"
     }
   ]
 }