@microsoft/applicationinsights-react-js 3.3.0-nightly.2202-06 → 3.3.0-nightly.2204-06

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.
@@ -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",
@@ -281,14 +281,16 @@
281
281
  "parameterTypeTokenRange": {
282
282
  "startIndex": 1,
283
283
  "endIndex": 2
284
- }
284
+ },
285
+ "isOptional": false
285
286
  },
286
287
  {
287
288
  "parameterName": "errorInfo",
288
289
  "parameterTypeTokenRange": {
289
290
  "startIndex": 3,
290
291
  "endIndex": 4
291
- }
292
+ },
293
+ "isOptional": false
292
294
  }
293
295
  ],
294
296
  "name": "componentDidCatch"
@@ -422,6 +424,20 @@
422
424
  "releaseTag": "Public",
423
425
  "name": "ReactPlugin",
424
426
  "members": [
427
+ {
428
+ "kind": "Constructor",
429
+ "canonicalReference": "@microsoft/applicationinsights-react-js!ReactPlugin:constructor(1)",
430
+ "docComment": "/**\n * Constructs a new instance of the `ReactPlugin` class\n */\n",
431
+ "excerptTokens": [
432
+ {
433
+ "kind": "Content",
434
+ "text": "constructor();"
435
+ }
436
+ ],
437
+ "releaseTag": "Public",
438
+ "overloadIndex": 1,
439
+ "parameters": []
440
+ },
425
441
  {
426
442
  "kind": "Method",
427
443
  "canonicalReference": "@microsoft/applicationinsights-react-js!ReactPlugin#getAppInsights:member(1)",
@@ -590,28 +606,32 @@
590
606
  "parameterTypeTokenRange": {
591
607
  "startIndex": 1,
592
608
  "endIndex": 4
593
- }
609
+ },
610
+ "isOptional": false
594
611
  },
595
612
  {
596
613
  "parameterName": "core",
597
614
  "parameterTypeTokenRange": {
598
615
  "startIndex": 5,
599
616
  "endIndex": 6
600
- }
617
+ },
618
+ "isOptional": false
601
619
  },
602
620
  {
603
621
  "parameterName": "extensions",
604
622
  "parameterTypeTokenRange": {
605
623
  "startIndex": 7,
606
624
  "endIndex": 9
607
- }
625
+ },
626
+ "isOptional": false
608
627
  },
609
628
  {
610
629
  "parameterName": "pluginChain",
611
630
  "parameterTypeTokenRange": {
612
631
  "startIndex": 10,
613
632
  "endIndex": 11
614
- }
633
+ },
634
+ "isOptional": true
615
635
  }
616
636
  ],
617
637
  "name": "initialize"
@@ -693,14 +713,16 @@
693
713
  "parameterTypeTokenRange": {
694
714
  "startIndex": 1,
695
715
  "endIndex": 2
696
- }
716
+ },
717
+ "isOptional": false
697
718
  },
698
719
  {
699
720
  "parameterName": "itemCtx",
700
721
  "parameterTypeTokenRange": {
701
722
  "startIndex": 3,
702
723
  "endIndex": 4
703
- }
724
+ },
725
+ "isOptional": true
704
726
  }
705
727
  ],
706
728
  "name": "processTelemetry"
@@ -755,14 +777,16 @@
755
777
  "parameterTypeTokenRange": {
756
778
  "startIndex": 1,
757
779
  "endIndex": 2
758
- }
780
+ },
781
+ "isOptional": false
759
782
  },
760
783
  {
761
784
  "parameterName": "customProperties",
762
785
  "parameterTypeTokenRange": {
763
786
  "startIndex": 3,
764
787
  "endIndex": 4
765
- }
788
+ },
789
+ "isOptional": true
766
790
  }
767
791
  ],
768
792
  "name": "trackEvent"
@@ -786,8 +810,9 @@
786
810
  "text": ", customProperties?: "
787
811
  },
788
812
  {
789
- "kind": "Content",
790
- "text": "{\n [key: string]: any;\n }"
813
+ "kind": "Reference",
814
+ "text": "ICustomProperties",
815
+ "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
791
816
  },
792
817
  {
793
818
  "kind": "Content",
@@ -816,14 +841,16 @@
816
841
  "parameterTypeTokenRange": {
817
842
  "startIndex": 1,
818
843
  "endIndex": 2
819
- }
844
+ },
845
+ "isOptional": false
820
846
  },
821
847
  {
822
848
  "parameterName": "customProperties",
823
849
  "parameterTypeTokenRange": {
824
850
  "startIndex": 3,
825
851
  "endIndex": 4
826
- }
852
+ },
853
+ "isOptional": true
827
854
  }
828
855
  ],
829
856
  "name": "trackException"
@@ -878,14 +905,16 @@
878
905
  "parameterTypeTokenRange": {
879
906
  "startIndex": 1,
880
907
  "endIndex": 2
881
- }
908
+ },
909
+ "isOptional": false
882
910
  },
883
911
  {
884
912
  "parameterName": "customProperties",
885
913
  "parameterTypeTokenRange": {
886
914
  "startIndex": 3,
887
915
  "endIndex": 4
888
- }
916
+ },
917
+ "isOptional": false
889
918
  }
890
919
  ],
891
920
  "name": "trackMetric"
@@ -931,7 +960,8 @@
931
960
  "parameterTypeTokenRange": {
932
961
  "startIndex": 1,
933
962
  "endIndex": 2
934
- }
963
+ },
964
+ "isOptional": false
935
965
  }
936
966
  ],
937
967
  "name": "trackPageView"
@@ -955,8 +985,9 @@
955
985
  "text": ", customProperties?: "
956
986
  },
957
987
  {
958
- "kind": "Content",
959
- "text": "{\n [key: string]: any;\n }"
988
+ "kind": "Reference",
989
+ "text": "ICustomProperties",
990
+ "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
960
991
  },
961
992
  {
962
993
  "kind": "Content",
@@ -985,14 +1016,16 @@
985
1016
  "parameterTypeTokenRange": {
986
1017
  "startIndex": 1,
987
1018
  "endIndex": 2
988
- }
1019
+ },
1020
+ "isOptional": false
989
1021
  },
990
1022
  {
991
1023
  "parameterName": "customProperties",
992
1024
  "parameterTypeTokenRange": {
993
1025
  "startIndex": 3,
994
1026
  "endIndex": 4
995
- }
1027
+ },
1028
+ "isOptional": true
996
1029
  }
997
1030
  ],
998
1031
  "name": "trackTrace"
@@ -1098,28 +1131,32 @@
1098
1131
  "parameterTypeTokenRange": {
1099
1132
  "startIndex": 1,
1100
1133
  "endIndex": 2
1101
- }
1134
+ },
1135
+ "isOptional": false
1102
1136
  },
1103
1137
  {
1104
1138
  "parameterName": "eventName",
1105
1139
  "parameterTypeTokenRange": {
1106
1140
  "startIndex": 3,
1107
1141
  "endIndex": 4
1108
- }
1142
+ },
1143
+ "isOptional": false
1109
1144
  },
1110
1145
  {
1111
1146
  "parameterName": "eventData",
1112
1147
  "parameterTypeTokenRange": {
1113
1148
  "startIndex": 5,
1114
1149
  "endIndex": 6
1115
- }
1150
+ },
1151
+ "isOptional": false
1116
1152
  },
1117
1153
  {
1118
1154
  "parameterName": "skipFirstRun",
1119
1155
  "parameterTypeTokenRange": {
1120
1156
  "startIndex": 7,
1121
1157
  "endIndex": 8
1122
- }
1158
+ },
1159
+ "isOptional": true
1123
1160
  }
1124
1161
  ],
1125
1162
  "typeParameters": [
@@ -1157,14 +1194,23 @@
1157
1194
  },
1158
1195
  {
1159
1196
  "kind": "Content",
1160
- "text": ", componentName: string) => () => void"
1197
+ "text": ", componentName: string, customProperties?: "
1198
+ },
1199
+ {
1200
+ "kind": "Reference",
1201
+ "text": "ICustomProperties",
1202
+ "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
1203
+ },
1204
+ {
1205
+ "kind": "Content",
1206
+ "text": ") => () => void"
1161
1207
  }
1162
1208
  ],
1163
1209
  "releaseTag": "Public",
1164
1210
  "name": "useTrackMetric",
1165
1211
  "variableTypeTokenRange": {
1166
1212
  "startIndex": 1,
1167
- "endIndex": 4
1213
+ "endIndex": 6
1168
1214
  }
1169
1215
  },
1170
1216
  {
@@ -1240,28 +1286,32 @@
1240
1286
  "parameterTypeTokenRange": {
1241
1287
  "startIndex": 1,
1242
1288
  "endIndex": 2
1243
- }
1289
+ },
1290
+ "isOptional": false
1244
1291
  },
1245
1292
  {
1246
1293
  "parameterName": "Component",
1247
1294
  "parameterTypeTokenRange": {
1248
1295
  "startIndex": 3,
1249
1296
  "endIndex": 5
1250
- }
1297
+ },
1298
+ "isOptional": false
1251
1299
  },
1252
1300
  {
1253
1301
  "parameterName": "componentName",
1254
1302
  "parameterTypeTokenRange": {
1255
1303
  "startIndex": 6,
1256
1304
  "endIndex": 7
1257
- }
1305
+ },
1306
+ "isOptional": true
1258
1307
  },
1259
1308
  {
1260
1309
  "parameterName": "className",
1261
1310
  "parameterTypeTokenRange": {
1262
1311
  "startIndex": 8,
1263
1312
  "endIndex": 9
1264
- }
1313
+ },
1314
+ "isOptional": true
1265
1315
  }
1266
1316
  ],
1267
1317
  "typeParameters": [
@@ -54,6 +54,7 @@ export interface IReactExtensionConfig {
54
54
 
55
55
  // @public (undocumented)
56
56
  export class ReactPlugin extends BaseTelemetryPlugin {
57
+ constructor();
57
58
  getAppInsights(): IAppInsights;
58
59
  getCookieMgr(): ICookieMgr;
59
60
  // (undocumented)
@@ -66,17 +67,13 @@ export class ReactPlugin extends BaseTelemetryPlugin {
66
67
  // (undocumented)
67
68
  trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
68
69
  // (undocumented)
69
- trackException(exception: IExceptionTelemetry, customProperties?: {
70
- [key: string]: any;
71
- }): void;
70
+ trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
72
71
  // (undocumented)
73
72
  trackMetric(metric: IMetricTelemetry, customProperties: ICustomProperties): void;
74
73
  // (undocumented)
75
74
  trackPageView(pageView: IPageViewTelemetry): void;
76
75
  // (undocumented)
77
- trackTrace(trace: ITraceTelemetry, customProperties?: {
78
- [key: string]: any;
79
- }): void;
76
+ trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void;
80
77
  }
81
78
 
82
79
  // @public (undocumented)
@@ -88,7 +85,7 @@ export const useAppInsightsContext: () => ReactPlugin;
88
85
  export function useTrackEvent<T>(reactPlugin: ReactPlugin, eventName: string, eventData: T, skipFirstRun?: boolean): AIReactCustomEvent<T>;
89
86
 
90
87
  // @public (undocumented)
91
- export const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string) => () => void;
88
+ export const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string, customProperties?: ICustomProperties) => () => void;
92
89
 
93
90
  // @public
94
91
  export function withAITracking<P>(reactPlugin: ReactPlugin, Component: React_2.ComponentType<P>, componentName?: string, className?: string): React_2.ComponentClass<P>;
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Microsoft Application Insights react plugin, 3.3.0-nightly.2202-06
2
+ * Microsoft Application Insights react plugin, 3.3.0-nightly.2204-06
3
3
  * Copyright (c) Microsoft and contributors. All rights reserved.
4
4
  *
5
5
  *
@@ -69,8 +69,7 @@ declare namespace ApplicationInsights {
69
69
  class ReactPlugin extends BaseTelemetryPlugin {
70
70
  priority: number;
71
71
  identifier: string;
72
- private _analyticsPlugin;
73
- private _extensionConfig;
72
+ constructor();
74
73
  initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
75
74
  /**
76
75
  * Get the current cookie manager for this instance
@@ -88,20 +87,15 @@ declare namespace ApplicationInsights {
88
87
  trackMetric(metric: IMetricTelemetry, customProperties: ICustomProperties): void;
89
88
  trackPageView(pageView: IPageViewTelemetry): void;
90
89
  trackEvent(event: IEventTelemetry, customProperties?: ICustomProperties): void;
91
- trackException(exception: IExceptionTelemetry, customProperties?: {
92
- [key: string]: any;
93
- }): void;
94
- trackTrace(trace: ITraceTelemetry, customProperties?: {
95
- [key: string]: any;
96
- }): void;
97
- private addHistoryListener;
90
+ trackException(exception: IExceptionTelemetry, customProperties?: ICustomProperties): void;
91
+ trackTrace(trace: ITraceTelemetry, customProperties?: ICustomProperties): void;
98
92
  }
99
93
 
100
94
  const useAppInsightsContext: () => ReactPlugin;
101
95
 
102
96
  function useTrackEvent<T>(reactPlugin: ReactPlugin, eventName: string, eventData: T, skipFirstRun?: boolean): AIReactCustomEvent<T>;
103
97
 
104
- const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string) => () => void;
98
+ const useTrackMetric: (reactPlugin: ReactPlugin, componentName: string, customProperties?: ICustomProperties) => () => void;
105
99
 
106
100
  /**
107
101
  * Higher-order component function to hook Application Insights tracking