@microsoft/applicationinsights-react-js 3.3.2 → 3.3.3-nightly.2205-03

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 (27) hide show
  1. package/browser/applicationinsights-react-js.js +89 -454
  2. package/browser/applicationinsights-react-js.js.map +1 -1
  3. package/browser/applicationinsights-react-js.min.js +2 -2
  4. package/browser/applicationinsights-react-js.min.js.map +1 -1
  5. package/dist/applicationinsights-react-js.api.json +471 -0
  6. package/dist/applicationinsights-react-js.api.md +31 -0
  7. package/dist/applicationinsights-react-js.d.ts +23 -1
  8. package/dist/applicationinsights-react-js.js +89 -454
  9. package/dist/applicationinsights-react-js.js.map +1 -1
  10. package/dist/applicationinsights-react-js.min.js +2 -2
  11. package/dist/applicationinsights-react-js.min.js.map +1 -1
  12. package/dist/applicationinsights-react-js.rollup.d.ts +23 -1
  13. package/dist-esm/AppInsightsContext.js +1 -1
  14. package/dist-esm/AppInsightsErrorBoundary.js +1 -1
  15. package/dist-esm/Interfaces/IReactExtensionConfig.js +1 -1
  16. package/dist-esm/ReactPlugin.js +1 -1
  17. package/dist-esm/applicationinsights-react-js.js +3 -3
  18. package/dist-esm/applicationinsights-react-js.js.map +1 -1
  19. package/dist-esm/useTrackEvent.js +1 -1
  20. package/dist-esm/useTrackMetric.js +1 -1
  21. package/dist-esm/withAITracking.js +78 -64
  22. package/dist-esm/withAITracking.js.map +1 -1
  23. package/package.json +74 -71
  24. package/src/applicationinsights-react-js.ts +3 -2
  25. package/src/withAITracking.tsx +90 -70
  26. package/types/applicationinsights-react-js.d.ts +2 -2
  27. package/types/withAITracking.d.ts +21 -0
package/dist/applicationinsights-react-js.api.json CHANGED
@@ -170,6 +170,477 @@
170
170
  "canonicalReference": "@microsoft/applicationinsights-react-js!",
171
171
  "name": "",
172
172
  "members": [
173
+ {
174
+ "kind": "Class",
175
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase:class",
176
+ "docComment": "/**\n * Higher-order component base class to hook Application Insights tracking in a React component's lifecycle.\n */\n",
177
+ "excerptTokens": [
178
+ {
179
+ "kind": "Content",
180
+ "text": "export declare abstract class AITrackedComponentBase<P> extends "
181
+ },
182
+ {
183
+ "kind": "Reference",
184
+ "text": "React.Component",
185
+ "canonicalReference": "@types/react!~React.Component:class"
186
+ },
187
+ {
188
+ "kind": "Content",
189
+ "text": "<P> "
190
+ }
191
+ ],
192
+ "releaseTag": "Public",
193
+ "typeParameters": [
194
+ {
195
+ "typeParameterName": "P",
196
+ "constraintTokenRange": {
197
+ "startIndex": 0,
198
+ "endIndex": 0
199
+ },
200
+ "defaultTypeTokenRange": {
201
+ "startIndex": 0,
202
+ "endIndex": 0
203
+ }
204
+ }
205
+ ],
206
+ "name": "AITrackedComponentBase",
207
+ "members": [
208
+ {
209
+ "kind": "Property",
210
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_componentName:member",
211
+ "docComment": "",
212
+ "excerptTokens": [
213
+ {
214
+ "kind": "Content",
215
+ "text": "protected _componentName: "
216
+ },
217
+ {
218
+ "kind": "Content",
219
+ "text": "string"
220
+ },
221
+ {
222
+ "kind": "Content",
223
+ "text": ";"
224
+ }
225
+ ],
226
+ "isOptional": false,
227
+ "releaseTag": "Public",
228
+ "name": "_componentName",
229
+ "propertyTypeTokenRange": {
230
+ "startIndex": 1,
231
+ "endIndex": 2
232
+ },
233
+ "isStatic": false
234
+ },
235
+ {
236
+ "kind": "Property",
237
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_firstActiveTimestamp:member",
238
+ "docComment": "",
239
+ "excerptTokens": [
240
+ {
241
+ "kind": "Content",
242
+ "text": "protected _firstActiveTimestamp: "
243
+ },
244
+ {
245
+ "kind": "Content",
246
+ "text": "number"
247
+ },
248
+ {
249
+ "kind": "Content",
250
+ "text": ";"
251
+ }
252
+ ],
253
+ "isOptional": false,
254
+ "releaseTag": "Public",
255
+ "name": "_firstActiveTimestamp",
256
+ "propertyTypeTokenRange": {
257
+ "startIndex": 1,
258
+ "endIndex": 2
259
+ },
260
+ "isStatic": false
261
+ },
262
+ {
263
+ "kind": "Property",
264
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_idleCount:member",
265
+ "docComment": "",
266
+ "excerptTokens": [
267
+ {
268
+ "kind": "Content",
269
+ "text": "protected _idleCount: "
270
+ },
271
+ {
272
+ "kind": "Content",
273
+ "text": "number"
274
+ },
275
+ {
276
+ "kind": "Content",
277
+ "text": ";"
278
+ }
279
+ ],
280
+ "isOptional": false,
281
+ "releaseTag": "Public",
282
+ "name": "_idleCount",
283
+ "propertyTypeTokenRange": {
284
+ "startIndex": 1,
285
+ "endIndex": 2
286
+ },
287
+ "isStatic": false
288
+ },
289
+ {
290
+ "kind": "Property",
291
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_idleStartTimestamp:member",
292
+ "docComment": "",
293
+ "excerptTokens": [
294
+ {
295
+ "kind": "Content",
296
+ "text": "protected _idleStartTimestamp: "
297
+ },
298
+ {
299
+ "kind": "Content",
300
+ "text": "number"
301
+ },
302
+ {
303
+ "kind": "Content",
304
+ "text": ";"
305
+ }
306
+ ],
307
+ "isOptional": false,
308
+ "releaseTag": "Public",
309
+ "name": "_idleStartTimestamp",
310
+ "propertyTypeTokenRange": {
311
+ "startIndex": 1,
312
+ "endIndex": 2
313
+ },
314
+ "isStatic": false
315
+ },
316
+ {
317
+ "kind": "Property",
318
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_idleTimeout:member",
319
+ "docComment": "",
320
+ "excerptTokens": [
321
+ {
322
+ "kind": "Content",
323
+ "text": "protected _idleTimeout: "
324
+ },
325
+ {
326
+ "kind": "Content",
327
+ "text": "number"
328
+ },
329
+ {
330
+ "kind": "Content",
331
+ "text": ";"
332
+ }
333
+ ],
334
+ "isOptional": false,
335
+ "releaseTag": "Public",
336
+ "name": "_idleTimeout",
337
+ "propertyTypeTokenRange": {
338
+ "startIndex": 1,
339
+ "endIndex": 2
340
+ },
341
+ "isStatic": false
342
+ },
343
+ {
344
+ "kind": "Property",
345
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_intervalId:member",
346
+ "docComment": "",
347
+ "excerptTokens": [
348
+ {
349
+ "kind": "Content",
350
+ "text": "protected _intervalId?: "
351
+ },
352
+ {
353
+ "kind": "Content",
354
+ "text": "any"
355
+ },
356
+ {
357
+ "kind": "Content",
358
+ "text": ";"
359
+ }
360
+ ],
361
+ "isOptional": true,
362
+ "releaseTag": "Public",
363
+ "name": "_intervalId",
364
+ "propertyTypeTokenRange": {
365
+ "startIndex": 1,
366
+ "endIndex": 2
367
+ },
368
+ "isStatic": false
369
+ },
370
+ {
371
+ "kind": "Property",
372
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_lastActiveTimestamp:member",
373
+ "docComment": "",
374
+ "excerptTokens": [
375
+ {
376
+ "kind": "Content",
377
+ "text": "protected _lastActiveTimestamp: "
378
+ },
379
+ {
380
+ "kind": "Content",
381
+ "text": "number"
382
+ },
383
+ {
384
+ "kind": "Content",
385
+ "text": ";"
386
+ }
387
+ ],
388
+ "isOptional": false,
389
+ "releaseTag": "Public",
390
+ "name": "_lastActiveTimestamp",
391
+ "propertyTypeTokenRange": {
392
+ "startIndex": 1,
393
+ "endIndex": 2
394
+ },
395
+ "isStatic": false
396
+ },
397
+ {
398
+ "kind": "Property",
399
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_mountTimestamp:member",
400
+ "docComment": "",
401
+ "excerptTokens": [
402
+ {
403
+ "kind": "Content",
404
+ "text": "protected _mountTimestamp: "
405
+ },
406
+ {
407
+ "kind": "Content",
408
+ "text": "number"
409
+ },
410
+ {
411
+ "kind": "Content",
412
+ "text": ";"
413
+ }
414
+ ],
415
+ "isOptional": false,
416
+ "releaseTag": "Public",
417
+ "name": "_mountTimestamp",
418
+ "propertyTypeTokenRange": {
419
+ "startIndex": 1,
420
+ "endIndex": 2
421
+ },
422
+ "isStatic": false
423
+ },
424
+ {
425
+ "kind": "Property",
426
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_reactPlugin:member",
427
+ "docComment": "",
428
+ "excerptTokens": [
429
+ {
430
+ "kind": "Content",
431
+ "text": "protected _reactPlugin: "
432
+ },
433
+ {
434
+ "kind": "Reference",
435
+ "text": "ReactPlugin",
436
+ "canonicalReference": "@microsoft/applicationinsights-react-js!default:class"
437
+ },
438
+ {
439
+ "kind": "Content",
440
+ "text": ";"
441
+ }
442
+ ],
443
+ "isOptional": false,
444
+ "releaseTag": "Public",
445
+ "name": "_reactPlugin",
446
+ "propertyTypeTokenRange": {
447
+ "startIndex": 1,
448
+ "endIndex": 2
449
+ },
450
+ "isStatic": false
451
+ },
452
+ {
453
+ "kind": "Property",
454
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#_totalIdleTime:member",
455
+ "docComment": "",
456
+ "excerptTokens": [
457
+ {
458
+ "kind": "Content",
459
+ "text": "protected _totalIdleTime: "
460
+ },
461
+ {
462
+ "kind": "Content",
463
+ "text": "number"
464
+ },
465
+ {
466
+ "kind": "Content",
467
+ "text": ";"
468
+ }
469
+ ],
470
+ "isOptional": false,
471
+ "releaseTag": "Public",
472
+ "name": "_totalIdleTime",
473
+ "propertyTypeTokenRange": {
474
+ "startIndex": 1,
475
+ "endIndex": 2
476
+ },
477
+ "isStatic": false
478
+ },
479
+ {
480
+ "kind": "Constructor",
481
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase:constructor(1)",
482
+ "docComment": "/**\n * Constructs a new instance of the `AITrackedComponentBase` class\n */\n",
483
+ "excerptTokens": [
484
+ {
485
+ "kind": "Content",
486
+ "text": "constructor(props: "
487
+ },
488
+ {
489
+ "kind": "Content",
490
+ "text": "P"
491
+ },
492
+ {
493
+ "kind": "Content",
494
+ "text": ", reactPlugin: "
495
+ },
496
+ {
497
+ "kind": "Reference",
498
+ "text": "ReactPlugin",
499
+ "canonicalReference": "@microsoft/applicationinsights-react-js!default:class"
500
+ },
501
+ {
502
+ "kind": "Content",
503
+ "text": ", componentName: "
504
+ },
505
+ {
506
+ "kind": "Content",
507
+ "text": "string"
508
+ },
509
+ {
510
+ "kind": "Content",
511
+ "text": ");"
512
+ }
513
+ ],
514
+ "releaseTag": "Public",
515
+ "overloadIndex": 1,
516
+ "parameters": [
517
+ {
518
+ "parameterName": "props",
519
+ "parameterTypeTokenRange": {
520
+ "startIndex": 1,
521
+ "endIndex": 2
522
+ },
523
+ "isOptional": false
524
+ },
525
+ {
526
+ "parameterName": "reactPlugin",
527
+ "parameterTypeTokenRange": {
528
+ "startIndex": 3,
529
+ "endIndex": 4
530
+ },
531
+ "isOptional": false
532
+ },
533
+ {
534
+ "parameterName": "componentName",
535
+ "parameterTypeTokenRange": {
536
+ "startIndex": 5,
537
+ "endIndex": 6
538
+ },
539
+ "isOptional": false
540
+ }
541
+ ]
542
+ },
543
+ {
544
+ "kind": "Method",
545
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#componentDidMount:member(1)",
546
+ "docComment": "",
547
+ "excerptTokens": [
548
+ {
549
+ "kind": "Content",
550
+ "text": "componentDidMount(): "
551
+ },
552
+ {
553
+ "kind": "Content",
554
+ "text": "void"
555
+ },
556
+ {
557
+ "kind": "Content",
558
+ "text": ";"
559
+ }
560
+ ],
561
+ "isOptional": false,
562
+ "isStatic": false,
563
+ "returnTypeTokenRange": {
564
+ "startIndex": 1,
565
+ "endIndex": 2
566
+ },
567
+ "releaseTag": "Public",
568
+ "overloadIndex": 1,
569
+ "parameters": [],
570
+ "name": "componentDidMount"
571
+ },
572
+ {
573
+ "kind": "Method",
574
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#componentWillUnmount:member(1)",
575
+ "docComment": "",
576
+ "excerptTokens": [
577
+ {
578
+ "kind": "Content",
579
+ "text": "componentWillUnmount(): "
580
+ },
581
+ {
582
+ "kind": "Content",
583
+ "text": "void"
584
+ },
585
+ {
586
+ "kind": "Content",
587
+ "text": ";"
588
+ }
589
+ ],
590
+ "isOptional": false,
591
+ "isStatic": false,
592
+ "returnTypeTokenRange": {
593
+ "startIndex": 1,
594
+ "endIndex": 2
595
+ },
596
+ "releaseTag": "Public",
597
+ "overloadIndex": 1,
598
+ "parameters": [],
599
+ "name": "componentWillUnmount"
600
+ },
601
+ {
602
+ "kind": "Property",
603
+ "canonicalReference": "@microsoft/applicationinsights-react-js!AITrackedComponentBase#trackActivity:member",
604
+ "docComment": "",
605
+ "excerptTokens": [
606
+ {
607
+ "kind": "Content",
608
+ "text": "protected trackActivity: "
609
+ },
610
+ {
611
+ "kind": "Content",
612
+ "text": "(e: "
613
+ },
614
+ {
615
+ "kind": "Reference",
616
+ "text": "React.SyntheticEvent",
617
+ "canonicalReference": "@types/react!~React.SyntheticEvent:interface"
618
+ },
619
+ {
620
+ "kind": "Content",
621
+ "text": "<any>) => void"
622
+ },
623
+ {
624
+ "kind": "Content",
625
+ "text": ";"
626
+ }
627
+ ],
628
+ "isOptional": false,
629
+ "releaseTag": "Public",
630
+ "name": "trackActivity",
631
+ "propertyTypeTokenRange": {
632
+ "startIndex": 1,
633
+ "endIndex": 4
634
+ },
635
+ "isStatic": false
636
+ }
637
+ ],
638
+ "extendsTokenRange": {
639
+ "startIndex": 1,
640
+ "endIndex": 2
641
+ },
642
+ "implementsTokenRanges": []
643
+ },
173
644
  {
174
645
  "kind": "Variable",
175
646
  "canonicalReference": "@microsoft/applicationinsights-react-js!AppInsightsContext:var",
package/dist/applicationinsights-react-js.api.md CHANGED
@@ -27,6 +27,37 @@ import * as React_2 from 'react';
27
27
  import { default as React_3 } from 'react';
28
28
  import { SetStateAction } from 'react';
29
29
 
30
+ // @public
31
+ export abstract class AITrackedComponentBase<P> extends React_2.Component<P> {
32
+ constructor(props: P, reactPlugin: ReactPlugin, componentName: string);
33
+ // (undocumented)
34
+ componentDidMount(): void;
35
+ // (undocumented)
36
+ protected _componentName: string;
37
+ // (undocumented)
38
+ componentWillUnmount(): void;
39
+ // (undocumented)
40
+ protected _firstActiveTimestamp: number;
41
+ // (undocumented)
42
+ protected _idleCount: number;
43
+ // (undocumented)
44
+ protected _idleStartTimestamp: number;
45
+ // (undocumented)
46
+ protected _idleTimeout: number;
47
+ // (undocumented)
48
+ protected _intervalId?: any;
49
+ // (undocumented)
50
+ protected _lastActiveTimestamp: number;
51
+ // (undocumented)
52
+ protected _mountTimestamp: number;
53
+ // (undocumented)
54
+ protected _reactPlugin: ReactPlugin;
55
+ // (undocumented)
56
+ protected _totalIdleTime: number;
57
+ // (undocumented)
58
+ protected trackActivity: (e: React_2.SyntheticEvent<any>) => void;
59
+ }
60
+
30
61
  // Warning: (ae-forgotten-export) The symbol "AppInsightsReactContext" needs to be exported by the entry point applicationinsights-react-js.d.ts
31
62
  //
32
63
  // @public (undocumented)
package/dist/applicationinsights-react-js.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  /*
2
- * Microsoft Application Insights react plugin, 3.3.2
2
+ * Microsoft Application Insights react plugin, 3.3.3-nightly.2205-03
3
3
  * Copyright (c) Microsoft and contributors. All rights reserved.
4
4
  *
5
5
  *
@@ -32,6 +32,28 @@ declare namespace ApplicationInsights {
32
32
 
33
33
  type AIReactCustomEvent<T> = Dispatch<SetStateAction<T>>;
34
34
 
35
+ /**
36
+ * Higher-order component base class to hook Application Insights tracking
37
+ * in a React component's lifecycle.
38
+ */
39
+ abstract class AITrackedComponentBase<P> extends React_2.Component<P> {
40
+ protected _mountTimestamp: number;
41
+ protected _firstActiveTimestamp: number;
42
+ protected _idleStartTimestamp: number;
43
+ protected _lastActiveTimestamp: number;
44
+ protected _totalIdleTime: number;
45
+ protected _idleCount: number;
46
+ protected _idleTimeout: number;
47
+ protected _intervalId?: any;
48
+ protected _componentName: string;
49
+ protected _reactPlugin: ReactPlugin;
50
+ constructor(props: P, reactPlugin: ReactPlugin, componentName: string);
51
+ componentDidMount(): void;
52
+ componentWillUnmount(): void;
53
+ protected trackActivity: (e: React_2.SyntheticEvent<any>) => void;
54
+ private getEngagementTimeSeconds;
55
+ }
56
+
35
57
  const AppInsightsContext: AppInsightsReactContext;
36
58
 
37
59
  class AppInsightsErrorBoundary extends React_3.Component<IAppInsightsErrorBoundaryProps, IAppInsightsErrorBoundaryState> {