@microsoft/applicationinsights-analytics-js 2.8.0-nightly.2202-06 → 2.8.0-nightly.2204-04

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/browser/applicationinsights-analytics-js.integrity.json +9 -9
  2. package/browser/applicationinsights-analytics-js.js +1774 -924
  3. package/browser/applicationinsights-analytics-js.js.map +1 -1
  4. package/browser/applicationinsights-analytics-js.min.js +2 -2
  5. package/browser/applicationinsights-analytics-js.min.js.map +1 -1
  6. package/dist/applicationinsights-analytics-js.api.json +138 -229
  7. package/dist/applicationinsights-analytics-js.api.md +8 -18
  8. package/dist/applicationinsights-analytics-js.d.ts +9 -104
  9. package/dist/applicationinsights-analytics-js.js +1774 -924
  10. package/dist/applicationinsights-analytics-js.js.map +1 -1
  11. package/dist/applicationinsights-analytics-js.min.js +2 -2
  12. package/dist/applicationinsights-analytics-js.min.js.map +1 -1
  13. package/dist/applicationinsights-analytics-js.rollup.d.ts +9 -104
  14. package/dist-esm/JavaScriptSDK/AnalyticsPlugin.js +674 -0
  15. package/dist-esm/JavaScriptSDK/AnalyticsPlugin.js.map +1 -0
  16. package/dist-esm/JavaScriptSDK/Telemetry/PageViewManager.js +21 -8
  17. package/dist-esm/JavaScriptSDK/Telemetry/PageViewManager.js.map +1 -1
  18. package/dist-esm/JavaScriptSDK/Telemetry/PageViewPerformanceManager.js +10 -10
  19. package/dist-esm/JavaScriptSDK/Telemetry/PageViewPerformanceManager.js.map +1 -1
  20. package/dist-esm/JavaScriptSDK/Telemetry/PageVisitTimeManager.js +5 -5
  21. package/dist-esm/JavaScriptSDK/Telemetry/PageVisitTimeManager.js.map +1 -1
  22. package/dist-esm/JavaScriptSDK/Timing.js +39 -0
  23. package/dist-esm/JavaScriptSDK/Timing.js.map +1 -0
  24. package/dist-esm/JavaScriptSDK.Interfaces/ITelemetryConfig.js +1 -1
  25. package/dist-esm/applicationinsights-analytics-js.js +2 -2
  26. package/dist-esm/applicationinsights-analytics-js.js.map +1 -1
  27. package/package.json +6 -6
  28. package/src/JavaScriptSDK/{ApplicationInsights.ts → AnalyticsPlugin.ts} +403 -325
  29. package/src/JavaScriptSDK/Telemetry/PageViewManager.ts +32 -13
  30. package/src/JavaScriptSDK/Telemetry/PageViewPerformanceManager.ts +6 -6
  31. package/src/JavaScriptSDK/Telemetry/PageVisitTimeManager.ts +1 -1
  32. package/src/JavaScriptSDK/Timing.ts +46 -0
  33. package/src/applicationinsights-analytics-js.ts +1 -1
  34. package/types/JavaScriptSDK/{ApplicationInsights.d.ts → AnalyticsPlugin.d.ts} +12 -16
  35. package/types/JavaScriptSDK/Telemetry/PageViewManager.d.ts +2 -1
  36. package/types/JavaScriptSDK/Telemetry/PageViewPerformanceManager.d.ts +9 -9
  37. package/types/JavaScriptSDK/Telemetry/PageVisitTimeManager.d.ts +4 -4
  38. package/types/JavaScriptSDK/Timing.d.ts +18 -0
  39. package/types/applicationinsights-analytics-js.d.ts +1 -1
  40. package/types/tsdoc-metadata.json +1 -1
  41. package/dist-esm/JavaScriptSDK/ApplicationInsights.js +0 -606
  42. package/dist-esm/JavaScriptSDK/ApplicationInsights.js.map +0 -1
package/dist/applicationinsights-analytics-js.api.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.19.4",
5
- "schemaVersion": 1004,
4
+ "toolVersion": "7.20.0",
5
+ "schemaVersion": 1005,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
8
8
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -171,12 +171,12 @@
171
171
  "members": [
172
172
  {
173
173
  "kind": "Class",
174
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights:class",
174
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin:class",
175
175
  "docComment": "",
176
176
  "excerptTokens": [
177
177
  {
178
178
  "kind": "Content",
179
- "text": "export declare class ApplicationInsights extends "
179
+ "text": "export declare class AnalyticsPlugin extends "
180
180
  },
181
181
  {
182
182
  "kind": "Reference",
@@ -211,11 +211,11 @@
211
211
  }
212
212
  ],
213
213
  "releaseTag": "Public",
214
- "name": "ApplicationInsights",
214
+ "name": "AnalyticsPlugin",
215
215
  "members": [
216
216
  {
217
217
  "kind": "Method",
218
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#_onerror:member(1)",
218
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#_onerror:member(1)",
219
219
  "docComment": "/**\n * @description Custom error handler for Application Insights Analytics\n *\n * @param exception - @memberof ApplicationInsights\n */\n",
220
220
  "excerptTokens": [
221
221
  {
@@ -254,140 +254,16 @@
254
254
  "parameterTypeTokenRange": {
255
255
  "startIndex": 1,
256
256
  "endIndex": 2
257
- }
257
+ },
258
+ "isOptional": false
258
259
  }
259
260
  ],
260
261
  "name": "_onerror"
261
262
  },
262
- {
263
- "kind": "Property",
264
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#_pageViewManager:member",
265
- "docComment": "",
266
- "excerptTokens": [
267
- {
268
- "kind": "Content",
269
- "text": "protected _pageViewManager: "
270
- },
271
- {
272
- "kind": "Reference",
273
- "text": "PageViewManager",
274
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!PageViewManager:class"
275
- },
276
- {
277
- "kind": "Content",
278
- "text": ";"
279
- }
280
- ],
281
- "isOptional": false,
282
- "releaseTag": "Public",
283
- "name": "_pageViewManager",
284
- "propertyTypeTokenRange": {
285
- "startIndex": 1,
286
- "endIndex": 2
287
- },
288
- "isStatic": false
289
- },
290
- {
291
- "kind": "Property",
292
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#_pageViewPerformanceManager:member",
293
- "docComment": "",
294
- "excerptTokens": [
295
- {
296
- "kind": "Content",
297
- "text": "protected _pageViewPerformanceManager: "
298
- },
299
- {
300
- "kind": "Reference",
301
- "text": "PageViewPerformanceManager",
302
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!PageViewPerformanceManager:class"
303
- },
304
- {
305
- "kind": "Content",
306
- "text": ";"
307
- }
308
- ],
309
- "isOptional": false,
310
- "releaseTag": "Public",
311
- "name": "_pageViewPerformanceManager",
312
- "propertyTypeTokenRange": {
313
- "startIndex": 1,
314
- "endIndex": 2
315
- },
316
- "isStatic": false
317
- },
318
- {
319
- "kind": "Property",
320
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#_pageVisitTimeManager:member",
321
- "docComment": "",
322
- "excerptTokens": [
323
- {
324
- "kind": "Content",
325
- "text": "protected _pageVisitTimeManager: "
326
- },
327
- {
328
- "kind": "Reference",
329
- "text": "PageVisitTimeManager",
330
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!PageVisitTimeManager:class"
331
- },
332
- {
333
- "kind": "Content",
334
- "text": ";"
335
- }
336
- ],
337
- "isOptional": false,
338
- "releaseTag": "Public",
339
- "name": "_pageVisitTimeManager",
340
- "propertyTypeTokenRange": {
341
- "startIndex": 1,
342
- "endIndex": 2
343
- },
344
- "isStatic": false
345
- },
346
- {
347
- "kind": "Property",
348
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#_telemetryInitializers:member",
349
- "docComment": "",
350
- "excerptTokens": [
351
- {
352
- "kind": "Content",
353
- "text": "protected _telemetryInitializers: "
354
- },
355
- {
356
- "kind": "Reference",
357
- "text": "Array",
358
- "canonicalReference": "!Array:interface"
359
- },
360
- {
361
- "kind": "Content",
362
- "text": "<(envelope: "
363
- },
364
- {
365
- "kind": "Reference",
366
- "text": "ITelemetryItem",
367
- "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryItem:interface"
368
- },
369
- {
370
- "kind": "Content",
371
- "text": ") => boolean | void>"
372
- },
373
- {
374
- "kind": "Content",
375
- "text": ";"
376
- }
377
- ],
378
- "isOptional": false,
379
- "releaseTag": "Public",
380
- "name": "_telemetryInitializers",
381
- "propertyTypeTokenRange": {
382
- "startIndex": 1,
383
- "endIndex": 5
384
- },
385
- "isStatic": false
386
- },
387
263
  {
388
264
  "kind": "Constructor",
389
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights:constructor(1)",
390
- "docComment": "/**\n * Constructs a new instance of the `ApplicationInsights` class\n */\n",
265
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin:constructor(1)",
266
+ "docComment": "/**\n * Constructs a new instance of the `AnalyticsPlugin` class\n */\n",
391
267
  "excerptTokens": [
392
268
  {
393
269
  "kind": "Content",
@@ -400,7 +276,7 @@
400
276
  },
401
277
  {
402
278
  "kind": "Method",
403
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#addTelemetryInitializer:member(1)",
279
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#addTelemetryInitializer:member(1)",
404
280
  "docComment": "",
405
281
  "excerptTokens": [
406
282
  {
@@ -424,9 +300,14 @@
424
300
  "kind": "Content",
425
301
  "text": "): "
426
302
  },
303
+ {
304
+ "kind": "Reference",
305
+ "text": "ITelemetryInitializerHandler",
306
+ "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryInitializerHandler:interface"
307
+ },
427
308
  {
428
309
  "kind": "Content",
429
- "text": "void"
310
+ "text": " | void"
430
311
  },
431
312
  {
432
313
  "kind": "Content",
@@ -437,7 +318,7 @@
437
318
  "isStatic": false,
438
319
  "returnTypeTokenRange": {
439
320
  "startIndex": 5,
440
- "endIndex": 6
321
+ "endIndex": 7
441
322
  },
442
323
  "releaseTag": "Public",
443
324
  "overloadIndex": 1,
@@ -447,14 +328,15 @@
447
328
  "parameterTypeTokenRange": {
448
329
  "startIndex": 1,
449
330
  "endIndex": 4
450
- }
331
+ },
332
+ "isOptional": false
451
333
  }
452
334
  ],
453
335
  "name": "addTelemetryInitializer"
454
336
  },
455
337
  {
456
338
  "kind": "Property",
457
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#autoRoutePVDelay:member",
339
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#autoRoutePVDelay:member",
458
340
  "docComment": "",
459
341
  "excerptTokens": [
460
342
  {
@@ -481,7 +363,7 @@
481
363
  },
482
364
  {
483
365
  "kind": "Property",
484
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#config:member",
366
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#config:member",
485
367
  "docComment": "",
486
368
  "excerptTokens": [
487
369
  {
@@ -509,7 +391,7 @@
509
391
  },
510
392
  {
511
393
  "kind": "Method",
512
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#getCookieMgr:member(1)",
394
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#getCookieMgr:member(1)",
513
395
  "docComment": "/**\n * Get the current cookie manager for this instance\n */\n",
514
396
  "excerptTokens": [
515
397
  {
@@ -538,27 +420,22 @@
538
420
  "name": "getCookieMgr"
539
421
  },
540
422
  {
541
- "kind": "Method",
542
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights.getDefaultConfig:member(1)",
423
+ "kind": "Property",
424
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin.getDefaultConfig:member",
543
425
  "docComment": "",
544
426
  "excerptTokens": [
545
427
  {
546
428
  "kind": "Content",
547
- "text": "static getDefaultConfig(config?: "
548
- },
549
- {
550
- "kind": "Reference",
551
- "text": "IConfig",
552
- "canonicalReference": "@microsoft/applicationinsights-common!IConfig:interface"
429
+ "text": "static getDefaultConfig: "
553
430
  },
554
431
  {
555
432
  "kind": "Content",
556
- "text": "): "
433
+ "text": "typeof "
557
434
  },
558
435
  {
559
436
  "kind": "Reference",
560
- "text": "IConfig",
561
- "canonicalReference": "@microsoft/applicationinsights-common!IConfig:interface"
437
+ "text": "_getDefaultConfig",
438
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!~_getDefaultConfig:function"
562
439
  },
563
440
  {
564
441
  "kind": "Content",
@@ -566,27 +443,17 @@
566
443
  }
567
444
  ],
568
445
  "isOptional": false,
569
- "isStatic": true,
570
- "returnTypeTokenRange": {
571
- "startIndex": 3,
572
- "endIndex": 4
573
- },
574
446
  "releaseTag": "Public",
575
- "overloadIndex": 1,
576
- "parameters": [
577
- {
578
- "parameterName": "config",
579
- "parameterTypeTokenRange": {
580
- "startIndex": 1,
581
- "endIndex": 2
582
- }
583
- }
584
- ],
585
- "name": "getDefaultConfig"
447
+ "name": "getDefaultConfig",
448
+ "propertyTypeTokenRange": {
449
+ "startIndex": 1,
450
+ "endIndex": 3
451
+ },
452
+ "isStatic": true
586
453
  },
587
454
  {
588
455
  "kind": "Property",
589
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#identifier:member",
456
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#identifier:member",
590
457
  "docComment": "",
591
458
  "excerptTokens": [
592
459
  {
@@ -613,7 +480,7 @@
613
480
  },
614
481
  {
615
482
  "kind": "Method",
616
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#initialize:member(1)",
483
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#initialize:member(1)",
617
484
  "docComment": "",
618
485
  "excerptTokens": [
619
486
  {
@@ -692,35 +559,39 @@
692
559
  "parameterTypeTokenRange": {
693
560
  "startIndex": 1,
694
561
  "endIndex": 4
695
- }
562
+ },
563
+ "isOptional": false
696
564
  },
697
565
  {
698
566
  "parameterName": "core",
699
567
  "parameterTypeTokenRange": {
700
568
  "startIndex": 5,
701
569
  "endIndex": 6
702
- }
570
+ },
571
+ "isOptional": false
703
572
  },
704
573
  {
705
574
  "parameterName": "extensions",
706
575
  "parameterTypeTokenRange": {
707
576
  "startIndex": 7,
708
577
  "endIndex": 9
709
- }
578
+ },
579
+ "isOptional": false
710
580
  },
711
581
  {
712
582
  "parameterName": "pluginChain",
713
583
  "parameterTypeTokenRange": {
714
584
  "startIndex": 10,
715
585
  "endIndex": 11
716
- }
586
+ },
587
+ "isOptional": true
717
588
  }
718
589
  ],
719
590
  "name": "initialize"
720
591
  },
721
592
  {
722
593
  "kind": "Property",
723
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#priority:member",
594
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#priority:member",
724
595
  "docComment": "",
725
596
  "excerptTokens": [
726
597
  {
@@ -747,7 +618,7 @@
747
618
  },
748
619
  {
749
620
  "kind": "Method",
750
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#processTelemetry:member(1)",
621
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#processTelemetry:member(1)",
751
622
  "docComment": "",
752
623
  "excerptTokens": [
753
624
  {
@@ -795,21 +666,23 @@
795
666
  "parameterTypeTokenRange": {
796
667
  "startIndex": 1,
797
668
  "endIndex": 2
798
- }
669
+ },
670
+ "isOptional": false
799
671
  },
800
672
  {
801
673
  "parameterName": "itemCtx",
802
674
  "parameterTypeTokenRange": {
803
675
  "startIndex": 3,
804
676
  "endIndex": 4
805
- }
677
+ },
678
+ "isOptional": true
806
679
  }
807
680
  ],
808
681
  "name": "processTelemetry"
809
682
  },
810
683
  {
811
684
  "kind": "Property",
812
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#queue:member",
685
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#queue:member",
813
686
  "docComment": "",
814
687
  "excerptTokens": [
815
688
  {
@@ -841,7 +714,7 @@
841
714
  },
842
715
  {
843
716
  "kind": "Method",
844
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#sendExceptionInternal:member(1)",
717
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#sendExceptionInternal:member(1)",
845
718
  "docComment": "/**\n * @ignore INTERNAL ONLY\n *\n * @param exception - \n *\n * @param properties - \n *\n * @param systemProperties - \n */\n",
846
719
  "excerptTokens": [
847
720
  {
@@ -896,28 +769,31 @@
896
769
  "parameterTypeTokenRange": {
897
770
  "startIndex": 1,
898
771
  "endIndex": 2
899
- }
772
+ },
773
+ "isOptional": false
900
774
  },
901
775
  {
902
776
  "parameterName": "customProperties",
903
777
  "parameterTypeTokenRange": {
904
778
  "startIndex": 3,
905
779
  "endIndex": 4
906
- }
780
+ },
781
+ "isOptional": true
907
782
  },
908
783
  {
909
784
  "parameterName": "systemProperties",
910
785
  "parameterTypeTokenRange": {
911
786
  "startIndex": 5,
912
787
  "endIndex": 6
913
- }
788
+ },
789
+ "isOptional": true
914
790
  }
915
791
  ],
916
792
  "name": "sendExceptionInternal"
917
793
  },
918
794
  {
919
795
  "kind": "Method",
920
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#sendPageViewInternal:member(1)",
796
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#sendPageViewInternal:member(1)",
921
797
  "docComment": "/**\n * Create a page view telemetry item and send it to the SDK pipeline through the core.track API\n *\n * @param pageView - Page view item to be sent\n *\n * @param properties - Custom properties (Part C) that a user can add to the telemetry item\n *\n * @param systemProperties - System level properties (Part A) that a user can add to the telemetry item\n */\n",
922
798
  "excerptTokens": [
923
799
  {
@@ -972,28 +848,31 @@
972
848
  "parameterTypeTokenRange": {
973
849
  "startIndex": 1,
974
850
  "endIndex": 2
975
- }
851
+ },
852
+ "isOptional": false
976
853
  },
977
854
  {
978
855
  "parameterName": "properties",
979
856
  "parameterTypeTokenRange": {
980
857
  "startIndex": 3,
981
858
  "endIndex": 4
982
- }
859
+ },
860
+ "isOptional": true
983
861
  },
984
862
  {
985
863
  "parameterName": "systemProperties",
986
864
  "parameterTypeTokenRange": {
987
865
  "startIndex": 5,
988
866
  "endIndex": 6
989
- }
867
+ },
868
+ "isOptional": true
990
869
  }
991
870
  ],
992
871
  "name": "sendPageViewInternal"
993
872
  },
994
873
  {
995
874
  "kind": "Method",
996
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#sendPageViewPerformanceInternal:member(1)",
875
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#sendPageViewPerformanceInternal:member(1)",
997
876
  "docComment": "/**\n * @ignore INTERNAL ONLY\n *\n * @param pageViewPerformance - \n *\n * @param properties - \n */\n",
998
877
  "excerptTokens": [
999
878
  {
@@ -1048,28 +927,31 @@
1048
927
  "parameterTypeTokenRange": {
1049
928
  "startIndex": 1,
1050
929
  "endIndex": 2
1051
- }
930
+ },
931
+ "isOptional": false
1052
932
  },
1053
933
  {
1054
934
  "parameterName": "properties",
1055
935
  "parameterTypeTokenRange": {
1056
936
  "startIndex": 3,
1057
937
  "endIndex": 4
1058
- }
938
+ },
939
+ "isOptional": true
1059
940
  },
1060
941
  {
1061
942
  "parameterName": "systemProperties",
1062
943
  "parameterTypeTokenRange": {
1063
944
  "startIndex": 5,
1064
945
  "endIndex": 6
1065
- }
946
+ },
947
+ "isOptional": true
1066
948
  }
1067
949
  ],
1068
950
  "name": "sendPageViewPerformanceInternal"
1069
951
  },
1070
952
  {
1071
953
  "kind": "Method",
1072
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#startTrackEvent:member(1)",
954
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#startTrackEvent:member(1)",
1073
955
  "docComment": "/**\n * Start timing an extended event. Call `stopTrackEvent` to log the event when it ends.\n *\n * @param name - A string that identifies this event uniquely within the document.\n */\n",
1074
956
  "excerptTokens": [
1075
957
  {
@@ -1107,14 +989,15 @@
1107
989
  "parameterTypeTokenRange": {
1108
990
  "startIndex": 1,
1109
991
  "endIndex": 2
1110
- }
992
+ },
993
+ "isOptional": false
1111
994
  }
1112
995
  ],
1113
996
  "name": "startTrackEvent"
1114
997
  },
1115
998
  {
1116
999
  "kind": "Method",
1117
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#startTrackPage:member(1)",
1000
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#startTrackPage:member(1)",
1118
1001
  "docComment": "/**\n * Starts the timer for tracking a page load time. Use this instead of `trackPageView` if you want to control when the page view timer starts and stops, but don't want to calculate the duration yourself. This method doesn't send any telemetry. Call `stopTrackPage` to log the end of the page view and send the event.\n *\n * @param name - A string that idenfities this item, unique within this HTML document. Defaults to the document title.\n */\n",
1119
1002
  "excerptTokens": [
1120
1003
  {
@@ -1152,14 +1035,15 @@
1152
1035
  "parameterTypeTokenRange": {
1153
1036
  "startIndex": 1,
1154
1037
  "endIndex": 2
1155
- }
1038
+ },
1039
+ "isOptional": true
1156
1040
  }
1157
1041
  ],
1158
1042
  "name": "startTrackPage"
1159
1043
  },
1160
1044
  {
1161
1045
  "kind": "Method",
1162
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#stopTrackEvent:member(1)",
1046
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#stopTrackEvent:member(1)",
1163
1047
  "docComment": "/**\n * Log an extended event that you started timing with `startTrackEvent`.\n *\n * @param name - The string you used to identify this event in `startTrackEvent`.\n *\n * @param properties - map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty.\n *\n * @param measurements - map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty.\n */\n",
1164
1048
  "excerptTokens": [
1165
1049
  {
@@ -1213,28 +1097,31 @@
1213
1097
  "parameterTypeTokenRange": {
1214
1098
  "startIndex": 1,
1215
1099
  "endIndex": 2
1216
- }
1100
+ },
1101
+ "isOptional": false
1217
1102
  },
1218
1103
  {
1219
1104
  "parameterName": "properties",
1220
1105
  "parameterTypeTokenRange": {
1221
1106
  "startIndex": 3,
1222
1107
  "endIndex": 4
1223
- }
1108
+ },
1109
+ "isOptional": true
1224
1110
  },
1225
1111
  {
1226
1112
  "parameterName": "measurements",
1227
1113
  "parameterTypeTokenRange": {
1228
1114
  "startIndex": 5,
1229
1115
  "endIndex": 6
1230
- }
1116
+ },
1117
+ "isOptional": true
1231
1118
  }
1232
1119
  ],
1233
1120
  "name": "stopTrackEvent"
1234
1121
  },
1235
1122
  {
1236
1123
  "kind": "Method",
1237
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#stopTrackPage:member(1)",
1124
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#stopTrackPage:member(1)",
1238
1125
  "docComment": "/**\n * Stops the timer that was started by calling `startTrackPage` and sends the pageview load time telemetry with the specified properties and measurements. The duration of the page view will be the time between calling `startTrackPage` and `stopTrackPage`.\n *\n * @param name - The string you used as the name in startTrackPage. Defaults to the document title.\n *\n * @param url - String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.\n *\n * @param properties - map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty.\n *\n * @param measurements - map[string, number] - metrics associated with this page, displayed in Metrics Explorer on the portal. Defaults to empty.\n */\n",
1239
1126
  "excerptTokens": [
1240
1127
  {
@@ -1296,35 +1183,39 @@
1296
1183
  "parameterTypeTokenRange": {
1297
1184
  "startIndex": 1,
1298
1185
  "endIndex": 2
1299
- }
1186
+ },
1187
+ "isOptional": true
1300
1188
  },
1301
1189
  {
1302
1190
  "parameterName": "url",
1303
1191
  "parameterTypeTokenRange": {
1304
1192
  "startIndex": 3,
1305
1193
  "endIndex": 4
1306
- }
1194
+ },
1195
+ "isOptional": true
1307
1196
  },
1308
1197
  {
1309
1198
  "parameterName": "properties",
1310
1199
  "parameterTypeTokenRange": {
1311
1200
  "startIndex": 5,
1312
1201
  "endIndex": 6
1313
- }
1202
+ },
1203
+ "isOptional": true
1314
1204
  },
1315
1205
  {
1316
1206
  "parameterName": "measurement",
1317
1207
  "parameterTypeTokenRange": {
1318
1208
  "startIndex": 7,
1319
1209
  "endIndex": 8
1320
- }
1210
+ },
1211
+ "isOptional": true
1321
1212
  }
1322
1213
  ],
1323
1214
  "name": "stopTrackPage"
1324
1215
  },
1325
1216
  {
1326
1217
  "kind": "Method",
1327
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#trackEvent:member(1)",
1218
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#trackEvent:member(1)",
1328
1219
  "docComment": "",
1329
1220
  "excerptTokens": [
1330
1221
  {
@@ -1372,21 +1263,23 @@
1372
1263
  "parameterTypeTokenRange": {
1373
1264
  "startIndex": 1,
1374
1265
  "endIndex": 2
1375
- }
1266
+ },
1267
+ "isOptional": false
1376
1268
  },
1377
1269
  {
1378
1270
  "parameterName": "customProperties",
1379
1271
  "parameterTypeTokenRange": {
1380
1272
  "startIndex": 3,
1381
1273
  "endIndex": 4
1382
- }
1274
+ },
1275
+ "isOptional": true
1383
1276
  }
1384
1277
  ],
1385
1278
  "name": "trackEvent"
1386
1279
  },
1387
1280
  {
1388
1281
  "kind": "Method",
1389
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#trackException:member(1)",
1282
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#trackException:member(1)",
1390
1283
  "docComment": "/**\n * Log an exception you have caught.\n *\n * @param exception - Object which contains exception to be sent\n *\n * @param customProperties - Additional data used to filter pages and metrics in the portal. Defaults to empty.\n *\n * Any property of type double will be considered a measurement, and will be treated by Application Insights as a metric. @memberof ApplicationInsights\n */\n",
1391
1284
  "excerptTokens": [
1392
1285
  {
@@ -1434,21 +1327,23 @@
1434
1327
  "parameterTypeTokenRange": {
1435
1328
  "startIndex": 1,
1436
1329
  "endIndex": 2
1437
- }
1330
+ },
1331
+ "isOptional": false
1438
1332
  },
1439
1333
  {
1440
1334
  "parameterName": "customProperties",
1441
1335
  "parameterTypeTokenRange": {
1442
1336
  "startIndex": 3,
1443
1337
  "endIndex": 4
1444
- }
1338
+ },
1339
+ "isOptional": true
1445
1340
  }
1446
1341
  ],
1447
1342
  "name": "trackException"
1448
1343
  },
1449
1344
  {
1450
1345
  "kind": "Method",
1451
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#trackMetric:member(1)",
1346
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#trackMetric:member(1)",
1452
1347
  "docComment": "/**\n * @description Log a numeric value that is not associated with a specific event. Typically used to send regular reports of performance indicators. To send single measurement, just use the name and average fields of {@link IMetricTelemetry}. If you take measurements frequently, you can reduce the telemetry bandwidth by aggregating multiple measurements and sending the resulting average at intervals\n *\n * @param metric - input object argument. Only name and average are mandatory.\n *\n * @param customProperties - additional data used to filter metrics in the portal. Defaults to empty. @memberof ApplicationInsights\n */\n",
1453
1348
  "excerptTokens": [
1454
1349
  {
@@ -1496,21 +1391,23 @@
1496
1391
  "parameterTypeTokenRange": {
1497
1392
  "startIndex": 1,
1498
1393
  "endIndex": 2
1499
- }
1394
+ },
1395
+ "isOptional": false
1500
1396
  },
1501
1397
  {
1502
1398
  "parameterName": "customProperties",
1503
1399
  "parameterTypeTokenRange": {
1504
1400
  "startIndex": 3,
1505
1401
  "endIndex": 4
1506
- }
1402
+ },
1403
+ "isOptional": true
1507
1404
  }
1508
1405
  ],
1509
1406
  "name": "trackMetric"
1510
1407
  },
1511
1408
  {
1512
1409
  "kind": "Method",
1513
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#trackPageView:member(1)",
1410
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#trackPageView:member(1)",
1514
1411
  "docComment": "/**\n * Logs that a page or other item was viewed.\n *\n * @param IPageViewTelemetry - The string you used as the name in startTrackPage. Defaults to the document title.\n *\n * @param customProperties - Additional data used to filter events and metrics. Defaults to empty. If a user wants to provide duration for pageLoad, it'll have to be in pageView.properties.duration\n */\n",
1515
1412
  "excerptTokens": [
1516
1413
  {
@@ -1558,21 +1455,23 @@
1558
1455
  "parameterTypeTokenRange": {
1559
1456
  "startIndex": 1,
1560
1457
  "endIndex": 2
1561
- }
1458
+ },
1459
+ "isOptional": true
1562
1460
  },
1563
1461
  {
1564
1462
  "parameterName": "customProperties",
1565
1463
  "parameterTypeTokenRange": {
1566
1464
  "startIndex": 3,
1567
1465
  "endIndex": 4
1568
- }
1466
+ },
1467
+ "isOptional": true
1569
1468
  }
1570
1469
  ],
1571
1470
  "name": "trackPageView"
1572
1471
  },
1573
1472
  {
1574
1473
  "kind": "Method",
1575
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#trackPageViewPerformance:member(1)",
1474
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#trackPageViewPerformance:member(1)",
1576
1475
  "docComment": "/**\n * Send browser performance metrics.\n *\n * @param pageViewPerformance - \n *\n * @param customProperties - \n */\n",
1577
1476
  "excerptTokens": [
1578
1477
  {
@@ -1620,21 +1519,23 @@
1620
1519
  "parameterTypeTokenRange": {
1621
1520
  "startIndex": 1,
1622
1521
  "endIndex": 2
1623
- }
1522
+ },
1523
+ "isOptional": false
1624
1524
  },
1625
1525
  {
1626
1526
  "parameterName": "customProperties",
1627
1527
  "parameterTypeTokenRange": {
1628
1528
  "startIndex": 3,
1629
1529
  "endIndex": 4
1630
- }
1530
+ },
1531
+ "isOptional": true
1631
1532
  }
1632
1533
  ],
1633
1534
  "name": "trackPageViewPerformance"
1634
1535
  },
1635
1536
  {
1636
1537
  "kind": "Method",
1637
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights#trackTrace:member(1)",
1538
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin#trackTrace:member(1)",
1638
1539
  "docComment": "/**\n * @description Log a diagnostic message\n *\n * @param trace - \n *\n * @param - ICustomProperties. @memberof ApplicationInsights\n */\n",
1639
1540
  "excerptTokens": [
1640
1541
  {
@@ -1682,21 +1583,23 @@
1682
1583
  "parameterTypeTokenRange": {
1683
1584
  "startIndex": 1,
1684
1585
  "endIndex": 2
1685
- }
1586
+ },
1587
+ "isOptional": false
1686
1588
  },
1687
1589
  {
1688
1590
  "parameterName": "customProperties",
1689
1591
  "parameterTypeTokenRange": {
1690
1592
  "startIndex": 3,
1691
1593
  "endIndex": 4
1692
- }
1594
+ },
1595
+ "isOptional": true
1693
1596
  }
1694
1597
  ],
1695
1598
  "name": "trackTrace"
1696
1599
  },
1697
1600
  {
1698
1601
  "kind": "Property",
1699
- "canonicalReference": "@microsoft/applicationinsights-analytics-js!ApplicationInsights.Version:member",
1602
+ "canonicalReference": "@microsoft/applicationinsights-analytics-js!AnalyticsPlugin.Version:member",
1700
1603
  "docComment": "",
1701
1604
  "excerptTokens": [
1702
1605
  {
@@ -1808,21 +1711,24 @@
1808
1711
  "parameterTypeTokenRange": {
1809
1712
  "startIndex": 1,
1810
1713
  "endIndex": 2
1811
- }
1714
+ },
1715
+ "isOptional": false
1812
1716
  },
1813
1717
  {
1814
1718
  "parameterName": "properties",
1815
1719
  "parameterTypeTokenRange": {
1816
1720
  "startIndex": 3,
1817
1721
  "endIndex": 4
1818
- }
1722
+ },
1723
+ "isOptional": true
1819
1724
  },
1820
1725
  {
1821
1726
  "parameterName": "systemProperties",
1822
1727
  "parameterTypeTokenRange": {
1823
1728
  "startIndex": 5,
1824
1729
  "endIndex": 6
1825
- }
1730
+ },
1731
+ "isOptional": true
1826
1732
  }
1827
1733
  ],
1828
1734
  "name": "sendPageViewInternal"
@@ -1885,21 +1791,24 @@
1885
1791
  "parameterTypeTokenRange": {
1886
1792
  "startIndex": 1,
1887
1793
  "endIndex": 2
1888
- }
1794
+ },
1795
+ "isOptional": false
1889
1796
  },
1890
1797
  {
1891
1798
  "parameterName": "properties",
1892
1799
  "parameterTypeTokenRange": {
1893
1800
  "startIndex": 3,
1894
1801
  "endIndex": 4
1895
- }
1802
+ },
1803
+ "isOptional": true
1896
1804
  },
1897
1805
  {
1898
1806
  "parameterName": "systemProperties",
1899
1807
  "parameterTypeTokenRange": {
1900
1808
  "startIndex": 5,
1901
1809
  "endIndex": 6
1902
- }
1810
+ },
1811
+ "isOptional": true
1903
1812
  }
1904
1813
  ],
1905
1814
  "name": "sendPageViewPerformanceInternal"