@aws-amplify/analytics 7.0.1-console-preview.8f82e46.0 → 7.0.1-console-preview.b278dcb.0

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 (136) hide show
  1. package/lib/errors/validation.d.ts +2 -0
  2. package/lib/errors/validation.js +8 -0
  3. package/lib/index.d.ts +1 -1
  4. package/lib/index.js +2 -1
  5. package/lib/providers/kinesis/apis/flushEvents.js +2 -1
  6. package/lib/providers/kinesis/apis/record.js +2 -1
  7. package/lib/providers/kinesis-firehose/apis/flushEvents.js +2 -1
  8. package/lib/providers/kinesis-firehose/apis/record.js +2 -1
  9. package/lib/providers/personalize/apis/flushEvents.js +2 -1
  10. package/lib/providers/personalize/apis/record.js +2 -1
  11. package/lib/providers/personalize/utils/autoTrackMedia.js +2 -1
  12. package/lib/providers/pinpoint/apis/configureAutoTrack.d.ts +15 -0
  13. package/lib/providers/pinpoint/apis/configureAutoTrack.js +35 -0
  14. package/lib/providers/pinpoint/apis/flushEvents.js +2 -1
  15. package/lib/providers/pinpoint/apis/identifyUser.js +4 -5
  16. package/lib/providers/pinpoint/apis/index.d.ts +1 -0
  17. package/lib/providers/pinpoint/apis/index.js +3 -1
  18. package/lib/providers/pinpoint/apis/record.js +1 -1
  19. package/lib/providers/pinpoint/index.d.ts +2 -2
  20. package/lib/providers/pinpoint/index.js +2 -1
  21. package/lib/providers/pinpoint/types/index.d.ts +1 -2
  22. package/lib/providers/pinpoint/types/index.js +0 -3
  23. package/lib/providers/pinpoint/types/inputs.d.ts +5 -1
  24. package/lib/trackers/EventTracker.d.ts +10 -0
  25. package/lib/trackers/EventTracker.js +104 -0
  26. package/lib/trackers/PageViewTracker.d.ts +18 -0
  27. package/lib/trackers/PageViewTracker.js +116 -0
  28. package/lib/trackers/SessionTracker.d.ts +13 -0
  29. package/lib/trackers/SessionTracker.js +73 -0
  30. package/lib/trackers/SessionTracker.native.d.ts +13 -0
  31. package/lib/trackers/SessionTracker.native.js +73 -0
  32. package/lib/trackers/index.d.ts +3 -0
  33. package/lib/trackers/index.js +11 -0
  34. package/lib/tsconfig.tsbuildinfo +1 -1
  35. package/lib/types/index.d.ts +1 -2
  36. package/lib/types/inputs.d.ts +17 -3
  37. package/lib/types/options.d.ts +1 -1
  38. package/lib/types/trackers.d.ts +22 -0
  39. package/lib/utils/eventBuffer/EventBuffer.js +2 -2
  40. package/lib/utils/index.d.ts +2 -0
  41. package/lib/utils/index.js +5 -1
  42. package/lib/utils/trackerConfigHelpers.d.ts +5 -0
  43. package/lib/utils/trackerConfigHelpers.js +15 -0
  44. package/lib/utils/trackerConfigHelpers.native.d.ts +5 -0
  45. package/lib/utils/trackerConfigHelpers.native.js +14 -0
  46. package/lib/utils/trackerHelpers.d.ts +9 -0
  47. package/lib/utils/trackerHelpers.js +44 -0
  48. package/lib-esm/errors/validation.d.ts +2 -0
  49. package/lib-esm/errors/validation.js +8 -0
  50. package/lib-esm/index.d.ts +1 -1
  51. package/lib-esm/index.js +1 -1
  52. package/lib-esm/providers/kinesis/apis/flushEvents.js +2 -1
  53. package/lib-esm/providers/kinesis/apis/record.js +2 -1
  54. package/lib-esm/providers/kinesis-firehose/apis/flushEvents.js +2 -1
  55. package/lib-esm/providers/kinesis-firehose/apis/record.js +3 -2
  56. package/lib-esm/providers/personalize/apis/flushEvents.js +2 -1
  57. package/lib-esm/providers/personalize/apis/record.js +2 -1
  58. package/lib-esm/providers/personalize/utils/autoTrackMedia.js +2 -1
  59. package/lib-esm/providers/pinpoint/apis/configureAutoTrack.d.ts +15 -0
  60. package/lib-esm/providers/pinpoint/apis/configureAutoTrack.js +31 -0
  61. package/lib-esm/providers/pinpoint/apis/flushEvents.js +2 -1
  62. package/lib-esm/providers/pinpoint/apis/identifyUser.js +5 -6
  63. package/lib-esm/providers/pinpoint/apis/index.d.ts +1 -0
  64. package/lib-esm/providers/pinpoint/apis/index.js +1 -0
  65. package/lib-esm/providers/pinpoint/apis/record.js +3 -3
  66. package/lib-esm/providers/pinpoint/index.d.ts +2 -2
  67. package/lib-esm/providers/pinpoint/index.js +1 -1
  68. package/lib-esm/providers/pinpoint/types/index.d.ts +1 -2
  69. package/lib-esm/providers/pinpoint/types/index.js +1 -1
  70. package/lib-esm/providers/pinpoint/types/inputs.d.ts +5 -1
  71. package/lib-esm/trackers/EventTracker.d.ts +10 -0
  72. package/lib-esm/trackers/EventTracker.js +101 -0
  73. package/lib-esm/trackers/PageViewTracker.d.ts +18 -0
  74. package/lib-esm/trackers/PageViewTracker.js +113 -0
  75. package/lib-esm/trackers/SessionTracker.d.ts +13 -0
  76. package/lib-esm/trackers/SessionTracker.js +70 -0
  77. package/lib-esm/trackers/SessionTracker.native.d.ts +13 -0
  78. package/lib-esm/trackers/SessionTracker.native.js +70 -0
  79. package/lib-esm/trackers/index.d.ts +3 -0
  80. package/lib-esm/trackers/index.js +5 -0
  81. package/lib-esm/tsconfig.tsbuildinfo +1 -1
  82. package/lib-esm/types/index.d.ts +1 -2
  83. package/lib-esm/types/inputs.d.ts +17 -3
  84. package/lib-esm/types/options.d.ts +1 -1
  85. package/lib-esm/types/trackers.d.ts +22 -0
  86. package/lib-esm/utils/eventBuffer/EventBuffer.js +1 -1
  87. package/lib-esm/utils/index.d.ts +2 -0
  88. package/lib-esm/utils/index.js +2 -0
  89. package/lib-esm/utils/trackerConfigHelpers.d.ts +5 -0
  90. package/lib-esm/utils/trackerConfigHelpers.js +11 -0
  91. package/lib-esm/utils/trackerConfigHelpers.native.d.ts +5 -0
  92. package/lib-esm/utils/trackerConfigHelpers.native.js +10 -0
  93. package/lib-esm/utils/trackerHelpers.d.ts +9 -0
  94. package/lib-esm/utils/trackerHelpers.js +40 -0
  95. package/package.json +5 -4
  96. package/src/errors/validation.ts +8 -0
  97. package/src/index.ts +3 -1
  98. package/src/providers/kinesis/apis/flushEvents.ts +2 -4
  99. package/src/providers/kinesis/apis/record.ts +2 -4
  100. package/src/providers/kinesis-firehose/apis/flushEvents.ts +2 -4
  101. package/src/providers/kinesis-firehose/apis/record.ts +3 -5
  102. package/src/providers/personalize/apis/flushEvents.ts +2 -4
  103. package/src/providers/personalize/apis/record.ts +2 -4
  104. package/src/providers/personalize/utils/autoTrackMedia.ts +2 -1
  105. package/src/providers/pinpoint/apis/configureAutoTrack.ts +49 -0
  106. package/src/providers/pinpoint/apis/flushEvents.ts +2 -4
  107. package/src/providers/pinpoint/apis/identifyUser.ts +6 -3
  108. package/src/providers/pinpoint/apis/index.ts +1 -0
  109. package/src/providers/pinpoint/apis/record.ts +2 -3
  110. package/src/providers/pinpoint/index.ts +6 -2
  111. package/src/providers/pinpoint/types/index.ts +5 -2
  112. package/src/providers/pinpoint/types/inputs.ts +9 -1
  113. package/src/trackers/EventTracker.ts +135 -0
  114. package/src/trackers/PageViewTracker.ts +160 -0
  115. package/src/trackers/SessionTracker.native.ts +106 -0
  116. package/src/trackers/SessionTracker.ts +106 -0
  117. package/src/trackers/index.ts +6 -0
  118. package/src/types/index.ts +4 -13
  119. package/src/types/inputs.ts +26 -3
  120. package/src/types/options.ts +1 -1
  121. package/src/types/trackers.ts +35 -0
  122. package/src/utils/eventBuffer/EventBuffer.ts +1 -1
  123. package/src/utils/index.ts +2 -0
  124. package/src/utils/trackerConfigHelpers.native.ts +18 -0
  125. package/src/utils/trackerConfigHelpers.ts +19 -0
  126. package/src/utils/trackerHelpers.ts +57 -0
  127. package/lib/providers/pinpoint/types/errors.d.ts +0 -9
  128. package/lib/providers/pinpoint/types/errors.js +0 -15
  129. package/lib/types/analytics.d.ts +0 -50
  130. package/lib-esm/providers/pinpoint/types/errors.d.ts +0 -9
  131. package/lib-esm/providers/pinpoint/types/errors.js +0 -12
  132. package/lib-esm/types/analytics.d.ts +0 -50
  133. package/src/providers/pinpoint/types/errors.ts +0 -12
  134. package/src/types/analytics.ts +0 -70
  135. /package/lib/types/{analytics.js → trackers.js} +0 -0
  136. /package/lib-esm/types/{analytics.js → trackers.js} +0 -0
@@ -0,0 +1,13 @@
1
+ import { SessionTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
2
+ export declare class SessionTracker implements TrackerInterface {
3
+ private options;
4
+ private eventRecorder;
5
+ private initialEventSent;
6
+ private sessionTrackingActive;
7
+ constructor(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions);
8
+ configure(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions): void;
9
+ cleanup(): void;
10
+ private handleStateChange;
11
+ private sessionStarted;
12
+ private sessionStopped;
13
+ }
@@ -0,0 +1,73 @@
1
+ "use strict";
2
+ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3
+ // SPDX-License-Identifier: Apache-2.0
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
+ exports.SessionTracker = void 0;
6
+ var utils_1 = require("@aws-amplify/core/internals/utils");
7
+ var core_1 = require("@aws-amplify/core");
8
+ var SESSION_START_EVENT = '_session.start';
9
+ var SESSION_STOP_EVENT = '_session.stop';
10
+ var logger = new core_1.ConsoleLogger('SessionTracker');
11
+ var SessionTracker = /** @class */ (function () {
12
+ function SessionTracker(eventRecorder, options) {
13
+ this.options = {};
14
+ this.eventRecorder = eventRecorder;
15
+ this.initialEventSent = false;
16
+ this.sessionTrackingActive = false;
17
+ this.handleStateChange = this.handleStateChange.bind(this);
18
+ this.configure(eventRecorder, options);
19
+ }
20
+ SessionTracker.prototype.configure = function (eventRecorder, options) {
21
+ var _a;
22
+ this.eventRecorder = eventRecorder;
23
+ // Clean up any existing listeners
24
+ this.cleanup();
25
+ // Apply defaults
26
+ this.options = {
27
+ attributes: (_a = options === null || options === void 0 ? void 0 : options.attributes) !== null && _a !== void 0 ? _a : {},
28
+ };
29
+ // Setup state listeners
30
+ if (!this.sessionTrackingActive) {
31
+ utils_1.sessionListener.addStateChangeListener(this.handleStateChange, !this.initialEventSent);
32
+ this.sessionTrackingActive = true;
33
+ }
34
+ };
35
+ SessionTracker.prototype.cleanup = function () {
36
+ if (this.sessionTrackingActive) {
37
+ utils_1.sessionListener.removeStateChangeListener(this.handleStateChange);
38
+ }
39
+ this.sessionTrackingActive = false;
40
+ };
41
+ SessionTracker.prototype.handleStateChange = function (state) {
42
+ if (state === 'started') {
43
+ this.sessionStarted();
44
+ }
45
+ else {
46
+ this.sessionStopped();
47
+ }
48
+ };
49
+ SessionTracker.prototype.sessionStarted = function () {
50
+ var _a;
51
+ var attributes = (_a = this.options.attributes) !== null && _a !== void 0 ? _a : {};
52
+ logger.debug('Recording automatically tracked page view event', {
53
+ SESSION_START_EVENT: SESSION_START_EVENT,
54
+ attributes: attributes,
55
+ });
56
+ this.eventRecorder(SESSION_START_EVENT, attributes);
57
+ // NOTE: The initial event will not be re-sent on re-configuration (e.g. to add additional custom attributes)
58
+ if (!this.initialEventSent) {
59
+ this.initialEventSent = true;
60
+ }
61
+ };
62
+ SessionTracker.prototype.sessionStopped = function () {
63
+ var _a;
64
+ var attributes = (_a = this.options.attributes) !== null && _a !== void 0 ? _a : {};
65
+ logger.debug('Recording automatically tracked page view event', {
66
+ SESSION_STOP_EVENT: SESSION_STOP_EVENT,
67
+ attributes: attributes,
68
+ });
69
+ this.eventRecorder(SESSION_STOP_EVENT, attributes);
70
+ };
71
+ return SessionTracker;
72
+ }());
73
+ exports.SessionTracker = SessionTracker;
@@ -0,0 +1,3 @@
1
+ export { EventTracker } from './EventTracker';
2
+ export { PageViewTracker } from './PageViewTracker';
3
+ export { SessionTracker } from './SessionTracker';
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3
+ // SPDX-License-Identifier: Apache-2.0
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
+ exports.SessionTracker = exports.PageViewTracker = exports.EventTracker = void 0;
6
+ var EventTracker_1 = require("./EventTracker");
7
+ Object.defineProperty(exports, "EventTracker", { enumerable: true, get: function () { return EventTracker_1.EventTracker; } });
8
+ var PageViewTracker_1 = require("./PageViewTracker");
9
+ Object.defineProperty(exports, "PageViewTracker", { enumerable: true, get: function () { return PageViewTracker_1.PageViewTracker; } });
10
+ var SessionTracker_1 = require("./SessionTracker");
11
+ Object.defineProperty(exports, "SessionTracker", { enumerable: true, get: function () { return SessionTracker_1.SessionTracker; } });