@adobe/alloy 2.19.1 → 2.20.0-alpha.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.
- package/libEs5/components/LegacyMediaAnalytics/createMediaAnalyticsTracker.js +272 -0
- package/libEs5/components/LegacyMediaAnalytics/createMediaHelper.js +182 -0
- package/libEs5/components/LegacyMediaAnalytics/index.js +48 -0
- package/libEs5/components/LegacyMediaAnalytics/media/constants.js +154 -0
- package/libEs5/components/LegacyMediaAnalytics/media/mediaKeysToXdmConverter.js +51 -0
- package/libEs5/components/MediaCollection/createHeartbeatEngine.js +55 -0
- package/libEs5/components/MediaCollection/createMediaEventManager.js +119 -0
- package/libEs5/components/MediaCollection/createMediaRequest.js +30 -0
- package/libEs5/components/MediaCollection/createMediaRequestPayload.js +29 -0
- package/libEs5/components/MediaCollection/createMediaSessionCacheManager.js +62 -0
- package/libEs5/components/MediaCollection/createUpdateMediaSessionState.js +35 -0
- package/libEs5/components/MediaCollection/index.js +159 -0
- package/libEs5/components/MediaCollection/mediaConstants/mediaEvents.js +13 -0
- package/libEs5/components/MediaCollection/validateMediaEventOptions.js +35 -0
- package/libEs5/components/MediaCollection/validateMediaSessionOptions.js +36 -0
- package/libEs5/constants/libraryVersion.js +1 -1
- package/libEs5/core/componentCreators.js +3 -1
- package/libEs5/core/edgeNetwork/injectSendEdgeNetworkRequest.js +1 -1
- package/libEs5/utils/request/createRequest.js +8 -1
- package/libEs5/utils/validation/createMaximumValidator.js +22 -0
- package/libEs5/utils/validation/index.js +5 -0
- package/libEs6/components/LegacyMediaAnalytics/createMediaAnalyticsTracker.js +276 -0
- package/libEs6/components/LegacyMediaAnalytics/createMediaHelper.js +173 -0
- package/libEs6/components/LegacyMediaAnalytics/index.js +45 -0
- package/libEs6/components/LegacyMediaAnalytics/media/constants.js +140 -0
- package/libEs6/components/LegacyMediaAnalytics/media/mediaKeysToXdmConverter.js +46 -0
- package/libEs6/components/MediaCollection/createHeartbeatEngine.js +57 -0
- package/libEs6/components/MediaCollection/createMediaEventManager.js +122 -0
- package/libEs6/components/MediaCollection/createMediaRequest.js +28 -0
- package/libEs6/components/MediaCollection/createMediaRequestPayload.js +26 -0
- package/libEs6/components/MediaCollection/createMediaSessionCacheManager.js +63 -0
- package/libEs6/components/MediaCollection/createUpdateMediaSessionState.js +36 -0
- package/libEs6/components/MediaCollection/index.js +158 -0
- package/libEs6/components/MediaCollection/mediaConstants/mediaEvents.js +9 -0
- package/libEs6/components/MediaCollection/validateMediaEventOptions.js +32 -0
- package/libEs6/components/MediaCollection/validateMediaSessionOptions.js +34 -0
- package/libEs6/constants/libraryVersion.js +1 -1
- package/libEs6/core/componentCreators.js +3 -1
- package/libEs6/core/edgeNetwork/injectSendEdgeNetworkRequest.js +1 -1
- package/libEs6/utils/request/createRequest.js +8 -1
- package/libEs6/utils/validation/createMaximumValidator.js +16 -0
- package/libEs6/utils/validation/index.js +5 -0
- package/package.json +2 -2
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
exports.createMediaAnalyticsTracker = void 0;
|
|
4
|
+
var _defer = require("../../utils/defer");
|
|
5
|
+
var _constants = require("./media/constants");
|
|
6
|
+
var _utils = require("../../utils");
|
|
7
|
+
var _mediaKeysToXdmConverter = require("./media/mediaKeysToXdmConverter");
|
|
8
|
+
var _createMediaHelper = require("./createMediaHelper");
|
|
9
|
+
/*
|
|
10
|
+
Copyright 2023 Adobe. All rights reserved.
|
|
11
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
12
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
13
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
14
|
+
|
|
15
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
16
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
17
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
18
|
+
governing permissions and limitations under the License.
|
|
19
|
+
*/
|
|
20
|
+
|
|
21
|
+
var convertSessionDetailsMetadataToXDM = function convertSessionDetailsMetadataToXDM(contextData) {
|
|
22
|
+
var customMetadata = [];
|
|
23
|
+
var sessionDetails = {};
|
|
24
|
+
Object.keys(contextData).forEach(function (key) {
|
|
25
|
+
if (_mediaKeysToXdmConverter.mediaToXdmKeys[key]) {
|
|
26
|
+
sessionDetails[_mediaKeysToXdmConverter.mediaToXdmKeys[key]] = contextData[key];
|
|
27
|
+
} else {
|
|
28
|
+
customMetadata.push({
|
|
29
|
+
name: key,
|
|
30
|
+
value: contextData[key]
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
});
|
|
34
|
+
return {
|
|
35
|
+
sessionDetails: sessionDetails,
|
|
36
|
+
customMetadata: customMetadata
|
|
37
|
+
};
|
|
38
|
+
};
|
|
39
|
+
var createMediaDetailsObject = function createMediaDetailsObject(_ref) {
|
|
40
|
+
var eventType = _ref.eventType,
|
|
41
|
+
info = _ref.info,
|
|
42
|
+
context = _ref.context;
|
|
43
|
+
var mediaDetails = info;
|
|
44
|
+
var customMetadata = [];
|
|
45
|
+
if (context && !(0, _utils.isEmptyObject)(context)) {
|
|
46
|
+
if (eventType === _constants.mediaEvent.AdStart) {
|
|
47
|
+
Object.keys(context).forEach(function (key) {
|
|
48
|
+
if (_mediaKeysToXdmConverter.adsToXdmKeys[key]) {
|
|
49
|
+
mediaDetails.advertisingDetails[_mediaKeysToXdmConverter.mediaToXdmKeys[key]] = context[key];
|
|
50
|
+
} else {
|
|
51
|
+
customMetadata.push({
|
|
52
|
+
name: key,
|
|
53
|
+
value: context[key]
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
});
|
|
57
|
+
} else {
|
|
58
|
+
Object.keys(context).forEach(function (key) {
|
|
59
|
+
customMetadata.push({
|
|
60
|
+
name: key,
|
|
61
|
+
value: context[key]
|
|
62
|
+
});
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
mediaDetails.customMetadata = customMetadata;
|
|
66
|
+
}
|
|
67
|
+
return mediaDetails;
|
|
68
|
+
};
|
|
69
|
+
var createHeartbeat = function createHeartbeat(_ref2) {
|
|
70
|
+
var mainPingInterval = _ref2.mainPingInterval,
|
|
71
|
+
playerState = _ref2.playerState,
|
|
72
|
+
trackEvent = _ref2.trackEvent;
|
|
73
|
+
// eslint-disable-next-line consistent-return
|
|
74
|
+
return function () {
|
|
75
|
+
var currentTime = Date.now();
|
|
76
|
+
if (Math.abs(currentTime - playerState.latestTriggeredEvent) / 1000 > mainPingInterval) {
|
|
77
|
+
return trackEvent({
|
|
78
|
+
eventType: "ping"
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
var createGetInstance = function createGetInstance(_ref3) {
|
|
84
|
+
var config = _ref3.config,
|
|
85
|
+
logger = _ref3.logger,
|
|
86
|
+
mediaEventManager = _ref3.mediaEventManager;
|
|
87
|
+
var mainPingInterval = config.mediaCollection.mainPingInterval;
|
|
88
|
+
var trackerState = {
|
|
89
|
+
qoe: null,
|
|
90
|
+
lastPlayhead: 0,
|
|
91
|
+
latestTriggeredEvent: null
|
|
92
|
+
};
|
|
93
|
+
var ticker;
|
|
94
|
+
var deferSession = (0, _defer.default)();
|
|
95
|
+
var updateLastTimeEventTriggered = function updateLastTimeEventTriggered() {
|
|
96
|
+
trackerState.latestTriggeredEvent = Date.now();
|
|
97
|
+
};
|
|
98
|
+
var getEventType = function getEventType(_ref4) {
|
|
99
|
+
var eventType = _ref4.eventType;
|
|
100
|
+
if (eventType === _constants.mediaEvent.BufferComplete) {
|
|
101
|
+
return "media." + _constants.mediaEvent.Play;
|
|
102
|
+
}
|
|
103
|
+
return "media." + eventType;
|
|
104
|
+
};
|
|
105
|
+
var _trackEvent = function trackEvent(_ref5) {
|
|
106
|
+
var eventType = _ref5.eventType,
|
|
107
|
+
mediaDetails = _ref5.mediaDetails;
|
|
108
|
+
return deferSession.promise.then(function (sessionID) {
|
|
109
|
+
var xdm = {
|
|
110
|
+
eventType: getEventType({
|
|
111
|
+
eventType: eventType
|
|
112
|
+
}),
|
|
113
|
+
mediaCollection: {
|
|
114
|
+
sessionID: sessionID,
|
|
115
|
+
playhead: trackerState.lastPlayhead
|
|
116
|
+
}
|
|
117
|
+
};
|
|
118
|
+
(0, _utils.deepAssign)(xdm.mediaCollection, mediaDetails);
|
|
119
|
+
var event = mediaEventManager.createMediaEvent({
|
|
120
|
+
options: {
|
|
121
|
+
xdm: xdm
|
|
122
|
+
}
|
|
123
|
+
});
|
|
124
|
+
return mediaEventManager.trackMediaEvent({
|
|
125
|
+
event: event
|
|
126
|
+
}).then(function () {
|
|
127
|
+
updateLastTimeEventTriggered();
|
|
128
|
+
});
|
|
129
|
+
}).catch(function (error) {
|
|
130
|
+
logger.info(error);
|
|
131
|
+
});
|
|
132
|
+
};
|
|
133
|
+
var heartbeatEngine = createHeartbeat({
|
|
134
|
+
mainPingInterval: mainPingInterval,
|
|
135
|
+
deferSession: deferSession,
|
|
136
|
+
playerState: trackerState,
|
|
137
|
+
trackEvent: _trackEvent
|
|
138
|
+
});
|
|
139
|
+
return {
|
|
140
|
+
trackSessionStart: function trackSessionStart(mediaObject) {
|
|
141
|
+
var contextData = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
|
142
|
+
if ((0, _utils.isEmptyObject)(mediaObject)) {
|
|
143
|
+
deferSession.reject("invalid media object");
|
|
144
|
+
return {};
|
|
145
|
+
}
|
|
146
|
+
var mediaCollection = {
|
|
147
|
+
playhead: 0
|
|
148
|
+
};
|
|
149
|
+
var _convertSessionDetail = convertSessionDetailsMetadataToXDM(contextData),
|
|
150
|
+
sessionDetails = _convertSessionDetail.sessionDetails,
|
|
151
|
+
customMetadata = _convertSessionDetail.customMetadata;
|
|
152
|
+
(0, _utils.deepAssign)(mediaCollection, mediaObject, {
|
|
153
|
+
sessionDetails: sessionDetails
|
|
154
|
+
}, {
|
|
155
|
+
customMetadata: customMetadata
|
|
156
|
+
});
|
|
157
|
+
var event = mediaEventManager.createMediaSession({
|
|
158
|
+
xdm: {
|
|
159
|
+
mediaCollection: mediaCollection
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
return mediaEventManager.trackMediaSession({
|
|
163
|
+
event: event
|
|
164
|
+
}).then(function (result) {
|
|
165
|
+
updateLastTimeEventTriggered();
|
|
166
|
+
deferSession.resolve(result.sessionId);
|
|
167
|
+
ticker = setInterval(function () {
|
|
168
|
+
heartbeatEngine();
|
|
169
|
+
}, 1000);
|
|
170
|
+
});
|
|
171
|
+
},
|
|
172
|
+
trackPlay: function trackPlay() {
|
|
173
|
+
return _trackEvent({
|
|
174
|
+
eventType: _constants.mediaEvent.Play
|
|
175
|
+
});
|
|
176
|
+
},
|
|
177
|
+
trackPause: function trackPause() {
|
|
178
|
+
return _trackEvent({
|
|
179
|
+
eventType: _constants.mediaEvent.Pause
|
|
180
|
+
});
|
|
181
|
+
},
|
|
182
|
+
trackSessionEnd: function trackSessionEnd() {
|
|
183
|
+
clearInterval(ticker);
|
|
184
|
+
return _trackEvent({
|
|
185
|
+
eventType: _constants.mediaEvent.SessionEnd
|
|
186
|
+
}).then(function () {
|
|
187
|
+
deferSession = null;
|
|
188
|
+
});
|
|
189
|
+
},
|
|
190
|
+
trackComplete: function trackComplete() {
|
|
191
|
+
clearInterval(ticker);
|
|
192
|
+
return _trackEvent({
|
|
193
|
+
eventType: _constants.mediaEvent.SessionComplete
|
|
194
|
+
});
|
|
195
|
+
},
|
|
196
|
+
trackError: function trackError(errorId) {
|
|
197
|
+
logger.info("trackError(" + errorId + ")");
|
|
198
|
+
var errorDetails = {
|
|
199
|
+
name: errorId,
|
|
200
|
+
source: "player"
|
|
201
|
+
};
|
|
202
|
+
var mediaDetails = {
|
|
203
|
+
errorDetails: errorDetails
|
|
204
|
+
};
|
|
205
|
+
return _trackEvent({
|
|
206
|
+
eventType: _constants.mediaEvent.SessionEnd,
|
|
207
|
+
mediaDetails: mediaDetails
|
|
208
|
+
});
|
|
209
|
+
},
|
|
210
|
+
trackEvent: function trackEvent(eventType, info, context) {
|
|
211
|
+
if ((0, _utils.isEmptyObject)(info)) {
|
|
212
|
+
logger.info("invalid media object");
|
|
213
|
+
return {};
|
|
214
|
+
}
|
|
215
|
+
var mediaDetails = createMediaDetailsObject({
|
|
216
|
+
eventType: eventType,
|
|
217
|
+
info: info,
|
|
218
|
+
context: context
|
|
219
|
+
});
|
|
220
|
+
return _trackEvent({
|
|
221
|
+
eventType: eventType,
|
|
222
|
+
mediaDetails: mediaDetails
|
|
223
|
+
});
|
|
224
|
+
},
|
|
225
|
+
updatePlayhead: function updatePlayhead(time) {
|
|
226
|
+
if ((0, _utils.isNumber)(time)) {
|
|
227
|
+
trackerState.lastPlayhead = parseInt(time, 10);
|
|
228
|
+
}
|
|
229
|
+
},
|
|
230
|
+
updateQoEObject: function updateQoEObject(qoeObject) {
|
|
231
|
+
if (!qoeObject) {
|
|
232
|
+
return;
|
|
233
|
+
}
|
|
234
|
+
trackerState.qoe = qoeObject;
|
|
235
|
+
},
|
|
236
|
+
destroy: function destroy() {
|
|
237
|
+
logger.info("Destroy called, destroying the tracker");
|
|
238
|
+
clearInterval(ticker);
|
|
239
|
+
deferSession = null;
|
|
240
|
+
}
|
|
241
|
+
};
|
|
242
|
+
};
|
|
243
|
+
var createMediaAnalyticsTracker = function createMediaAnalyticsTracker(_ref6) {
|
|
244
|
+
var config = _ref6.config,
|
|
245
|
+
logger = _ref6.logger,
|
|
246
|
+
mediaEventManager = _ref6.mediaEventManager;
|
|
247
|
+
logger.info("Media Analytics Component was configured");
|
|
248
|
+
return {
|
|
249
|
+
getInstance: function getInstance() {
|
|
250
|
+
return createGetInstance({
|
|
251
|
+
config: config,
|
|
252
|
+
logger: logger,
|
|
253
|
+
mediaEventManager: mediaEventManager
|
|
254
|
+
});
|
|
255
|
+
},
|
|
256
|
+
Event: _constants.mediaEvent,
|
|
257
|
+
MediaType: _constants.MediaType,
|
|
258
|
+
PlayerState: _constants.PlayerState,
|
|
259
|
+
StreamType: _constants.StreamType,
|
|
260
|
+
MediaObjectKey: _constants.MediaObjectKey,
|
|
261
|
+
VideoMetadataKeys: _constants.VideoMetadataKeys,
|
|
262
|
+
AudioMetadataKeys: _constants.AudioMetadataKeys,
|
|
263
|
+
AdMetadataKeys: _constants.AdMetadataKeys,
|
|
264
|
+
createMediaObject: _createMediaHelper.createMediaObject,
|
|
265
|
+
createAdBreakObject: _createMediaHelper.createAdBreakObject,
|
|
266
|
+
createAdObject: _createMediaHelper.createAdObject,
|
|
267
|
+
createChapterObject: _createMediaHelper.createChapterObject,
|
|
268
|
+
createStateObject: _createMediaHelper.createStateObject,
|
|
269
|
+
createQoEObject: _createMediaHelper.createQoEObject
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
exports.createMediaAnalyticsTracker = createMediaAnalyticsTracker;
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
exports.createStateObject = exports.createQoEObject = exports.createMediaObject = exports.createChapterObject = exports.createAdObject = exports.createAdBreakObject = void 0;
|
|
4
|
+
var _validation = require("../../utils/validation");
|
|
5
|
+
/*
|
|
6
|
+
Copyright 2023 Adobe. All rights reserved.
|
|
7
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
8
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
9
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
|
|
11
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
12
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
13
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
14
|
+
governing permissions and limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
var createMediaObject = function createMediaObject(friendlyName, name, length, contentType, streamType) {
|
|
18
|
+
var mediaObject = {
|
|
19
|
+
friendlyName: friendlyName,
|
|
20
|
+
name: name,
|
|
21
|
+
length: length,
|
|
22
|
+
streamType: streamType,
|
|
23
|
+
contentType: contentType
|
|
24
|
+
};
|
|
25
|
+
var validate = (0, _validation.objectOf)({
|
|
26
|
+
friendlyName: (0, _validation.string)().nonEmpty(),
|
|
27
|
+
name: (0, _validation.string)().nonEmpty(),
|
|
28
|
+
length: (0, _validation.number)().required(),
|
|
29
|
+
streamType: (0, _validation.string)().nonEmpty(),
|
|
30
|
+
contentType: (0, _validation.string)().nonEmpty()
|
|
31
|
+
});
|
|
32
|
+
try {
|
|
33
|
+
var result = validate(mediaObject);
|
|
34
|
+
var sessionDetails = {
|
|
35
|
+
name: result.name,
|
|
36
|
+
friendlyName: result.friendlyName,
|
|
37
|
+
length: result.length,
|
|
38
|
+
streamType: result.streamType,
|
|
39
|
+
contentType: result.contentType
|
|
40
|
+
};
|
|
41
|
+
return {
|
|
42
|
+
sessionDetails: sessionDetails
|
|
43
|
+
};
|
|
44
|
+
} catch (error) {
|
|
45
|
+
return {};
|
|
46
|
+
}
|
|
47
|
+
};
|
|
48
|
+
exports.createMediaObject = createMediaObject;
|
|
49
|
+
var createAdBreakObject = function createAdBreakObject(name, position, startTime) {
|
|
50
|
+
var adBreakObject = {
|
|
51
|
+
friendlyName: name,
|
|
52
|
+
offset: position,
|
|
53
|
+
index: startTime
|
|
54
|
+
};
|
|
55
|
+
var validator = (0, _validation.objectOf)({
|
|
56
|
+
friendlyName: (0, _validation.string)().nonEmpty(),
|
|
57
|
+
offset: (0, _validation.number)(),
|
|
58
|
+
index: (0, _validation.number)()
|
|
59
|
+
});
|
|
60
|
+
try {
|
|
61
|
+
var result = validator(adBreakObject);
|
|
62
|
+
var advertisingPodDetails = {
|
|
63
|
+
friendlyName: result.friendlyName,
|
|
64
|
+
offset: result.offset,
|
|
65
|
+
index: result.index
|
|
66
|
+
};
|
|
67
|
+
return {
|
|
68
|
+
advertisingPodDetails: advertisingPodDetails
|
|
69
|
+
};
|
|
70
|
+
} catch (error) {
|
|
71
|
+
return {};
|
|
72
|
+
}
|
|
73
|
+
};
|
|
74
|
+
exports.createAdBreakObject = createAdBreakObject;
|
|
75
|
+
var createAdObject = function createAdObject(name, id, position, length) {
|
|
76
|
+
var adObject = {
|
|
77
|
+
friendlyName: name,
|
|
78
|
+
name: id,
|
|
79
|
+
podPosition: position,
|
|
80
|
+
length: length
|
|
81
|
+
};
|
|
82
|
+
var validator = (0, _validation.objectOf)({
|
|
83
|
+
friendlyName: (0, _validation.string)().nonEmpty(),
|
|
84
|
+
name: (0, _validation.string)().nonEmpty(),
|
|
85
|
+
podPosition: (0, _validation.number)(),
|
|
86
|
+
length: (0, _validation.number)()
|
|
87
|
+
});
|
|
88
|
+
try {
|
|
89
|
+
var result = validator(adObject);
|
|
90
|
+
var advertisingDetails = {
|
|
91
|
+
friendlyName: result.friendlyName,
|
|
92
|
+
name: result.name,
|
|
93
|
+
podPosition: result.podPosition,
|
|
94
|
+
length: result.length
|
|
95
|
+
};
|
|
96
|
+
return {
|
|
97
|
+
advertisingDetails: advertisingDetails
|
|
98
|
+
};
|
|
99
|
+
} catch (error) {
|
|
100
|
+
return {};
|
|
101
|
+
}
|
|
102
|
+
};
|
|
103
|
+
exports.createAdObject = createAdObject;
|
|
104
|
+
var createChapterObject = function createChapterObject(name, position, length, startTime) {
|
|
105
|
+
var chapterDetailsObject = {
|
|
106
|
+
friendlyName: name,
|
|
107
|
+
offset: position,
|
|
108
|
+
length: length,
|
|
109
|
+
index: startTime
|
|
110
|
+
};
|
|
111
|
+
var validator = (0, _validation.objectOf)({
|
|
112
|
+
friendlyName: (0, _validation.string)().nonEmpty(),
|
|
113
|
+
offset: (0, _validation.number)(),
|
|
114
|
+
length: (0, _validation.number)(),
|
|
115
|
+
index: (0, _validation.number)()
|
|
116
|
+
});
|
|
117
|
+
try {
|
|
118
|
+
var result = validator(chapterDetailsObject);
|
|
119
|
+
var chapterDetails = {
|
|
120
|
+
friendlyName: result.friendlyName,
|
|
121
|
+
offset: result.offset,
|
|
122
|
+
index: result.index,
|
|
123
|
+
length: result.length
|
|
124
|
+
};
|
|
125
|
+
return {
|
|
126
|
+
chapterDetails: chapterDetails
|
|
127
|
+
};
|
|
128
|
+
} catch (error) {
|
|
129
|
+
return {};
|
|
130
|
+
}
|
|
131
|
+
};
|
|
132
|
+
exports.createChapterObject = createChapterObject;
|
|
133
|
+
var createStateObject = function createStateObject(stateName) {
|
|
134
|
+
var STATE_NAME_REGEX = new RegExp("^[a-zA-Z0-9_\\.]{1,64}$");
|
|
135
|
+
var state = {
|
|
136
|
+
state: stateName
|
|
137
|
+
};
|
|
138
|
+
var validator = (0, _validation.objectOf)({
|
|
139
|
+
state: (0, _validation.string)().regexp(STATE_NAME_REGEX)
|
|
140
|
+
});
|
|
141
|
+
try {
|
|
142
|
+
var result = validator(state);
|
|
143
|
+
var stateDetails = {
|
|
144
|
+
name: result.name
|
|
145
|
+
};
|
|
146
|
+
return {
|
|
147
|
+
stateDetails: stateDetails
|
|
148
|
+
};
|
|
149
|
+
} catch (error) {
|
|
150
|
+
return {};
|
|
151
|
+
}
|
|
152
|
+
};
|
|
153
|
+
exports.createStateObject = createStateObject;
|
|
154
|
+
var createQoEObject = function createQoEObject(bitrate, droppedFrames, fps, startupTime) {
|
|
155
|
+
var qoeObject = {
|
|
156
|
+
bitrate: bitrate,
|
|
157
|
+
droppedFrames: droppedFrames,
|
|
158
|
+
fps: fps,
|
|
159
|
+
startupTime: startupTime
|
|
160
|
+
};
|
|
161
|
+
var validator = (0, _validation.objectOf)({
|
|
162
|
+
bitrate: (0, _validation.number)(),
|
|
163
|
+
droppedFrames: (0, _validation.number)(),
|
|
164
|
+
fps: (0, _validation.number)(),
|
|
165
|
+
startupTime: (0, _validation.number)()
|
|
166
|
+
});
|
|
167
|
+
try {
|
|
168
|
+
var result = validator(qoeObject);
|
|
169
|
+
var qoeDetails = {
|
|
170
|
+
bitrate: result.bitrate,
|
|
171
|
+
droppedFrames: result.droppedFrames,
|
|
172
|
+
fps: result.fps,
|
|
173
|
+
startupTime: result.startupTime
|
|
174
|
+
};
|
|
175
|
+
return {
|
|
176
|
+
qoeDetails: qoeDetails
|
|
177
|
+
};
|
|
178
|
+
} catch (error) {
|
|
179
|
+
return {};
|
|
180
|
+
}
|
|
181
|
+
};
|
|
182
|
+
exports.createQoEObject = createQoEObject;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
exports.default = void 0;
|
|
4
|
+
var _createMediaAnalyticsTracker = require("./createMediaAnalyticsTracker");
|
|
5
|
+
var _createMediaEventManager = require("../MediaCollection/createMediaEventManager");
|
|
6
|
+
/*
|
|
7
|
+
Copyright 2023 Adobe. All rights reserved.
|
|
8
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
9
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
10
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
|
|
12
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
13
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
14
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
15
|
+
governing permissions and limitations under the License.
|
|
16
|
+
*/
|
|
17
|
+
/* eslint-disable import/no-restricted-paths */
|
|
18
|
+
|
|
19
|
+
var createLegacyMediaAnalytics = function createLegacyMediaAnalytics(_ref) {
|
|
20
|
+
var eventManager = _ref.eventManager,
|
|
21
|
+
sendEdgeNetworkRequest = _ref.sendEdgeNetworkRequest,
|
|
22
|
+
config = _ref.config,
|
|
23
|
+
logger = _ref.logger,
|
|
24
|
+
consent = _ref.consent;
|
|
25
|
+
var mediaEventManager = (0, _createMediaEventManager.default)({
|
|
26
|
+
sendEdgeNetworkRequest: sendEdgeNetworkRequest,
|
|
27
|
+
config: config,
|
|
28
|
+
logger: logger,
|
|
29
|
+
consent: consent,
|
|
30
|
+
eventManager: eventManager
|
|
31
|
+
});
|
|
32
|
+
return {
|
|
33
|
+
commands: {
|
|
34
|
+
getMediaAnalyticsTracker: {
|
|
35
|
+
run: function run() {
|
|
36
|
+
return (0, _createMediaAnalyticsTracker.createMediaAnalyticsTracker)({
|
|
37
|
+
config: config,
|
|
38
|
+
logger: logger,
|
|
39
|
+
mediaEventManager: mediaEventManager
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
createLegacyMediaAnalytics.namespace = "Legacy Media Analytics";
|
|
47
|
+
var _default = createLegacyMediaAnalytics;
|
|
48
|
+
exports.default = _default;
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
exports.mediaEvent = exports.VideoMetadataKeys = exports.StreamType = exports.PlayerState = exports.MediaType = exports.MediaObjectKey = exports.Event = exports.AudioMetadataKeys = exports.AdMetadataKeys = void 0;
|
|
4
|
+
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
|
|
5
|
+
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
6
|
+
function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
7
|
+
/*
|
|
8
|
+
Copyright 2023 Adobe. All rights reserved.
|
|
9
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
10
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
11
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
|
|
13
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
14
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
15
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
16
|
+
governing permissions and limitations under the License.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
var MediaType = {
|
|
20
|
+
Video: "video",
|
|
21
|
+
Audio: "audio"
|
|
22
|
+
};
|
|
23
|
+
exports.MediaType = MediaType;
|
|
24
|
+
var StreamType = {
|
|
25
|
+
VOD: "vod",
|
|
26
|
+
Live: "live",
|
|
27
|
+
Linear: "linear",
|
|
28
|
+
Podcast: "podcast",
|
|
29
|
+
Audiobook: "audiobook",
|
|
30
|
+
AOD: "aod"
|
|
31
|
+
};
|
|
32
|
+
exports.StreamType = StreamType;
|
|
33
|
+
var PlayerState = {
|
|
34
|
+
FullScreen: "fullScreen",
|
|
35
|
+
ClosedCaption: "closedCaptioning",
|
|
36
|
+
Mute: "mute",
|
|
37
|
+
PictureInPicture: "pictureInPicture",
|
|
38
|
+
InFocus: "inFocus"
|
|
39
|
+
};
|
|
40
|
+
exports.PlayerState = PlayerState;
|
|
41
|
+
var Event = {
|
|
42
|
+
/**
|
|
43
|
+
* Constant defining event type for AdBreak start
|
|
44
|
+
*/
|
|
45
|
+
AdBreakStart: "adBreakStart",
|
|
46
|
+
/**
|
|
47
|
+
* Constant defining event type for AdBreak complete
|
|
48
|
+
*/
|
|
49
|
+
AdBreakComplete: "adBreakComplete",
|
|
50
|
+
/**
|
|
51
|
+
* Constant defining event type for Ad start
|
|
52
|
+
*/
|
|
53
|
+
AdStart: "adStart",
|
|
54
|
+
/**
|
|
55
|
+
* Constant defining event type for Ad complete
|
|
56
|
+
*/
|
|
57
|
+
AdComplete: "adComplete",
|
|
58
|
+
/**
|
|
59
|
+
* Constant defining event type for Ad skip
|
|
60
|
+
*/
|
|
61
|
+
AdSkip: "adSkip",
|
|
62
|
+
/**
|
|
63
|
+
* Constant defining event type for Chapter start
|
|
64
|
+
*/
|
|
65
|
+
ChapterStart: "chapterStart",
|
|
66
|
+
/**
|
|
67
|
+
* Constant defining event type for Chapter complete
|
|
68
|
+
*/
|
|
69
|
+
ChapterComplete: "chapterComplete",
|
|
70
|
+
/**
|
|
71
|
+
* Constant defining event type for Chapter skip
|
|
72
|
+
*/
|
|
73
|
+
ChapterSkip: "chapterSkip",
|
|
74
|
+
/**
|
|
75
|
+
* Constant defining event type for Seek start
|
|
76
|
+
*/
|
|
77
|
+
SeekStart: "seekStart",
|
|
78
|
+
/**
|
|
79
|
+
* Constant defining event type for Seek complete
|
|
80
|
+
*/
|
|
81
|
+
SeekComplete: "seekComplete",
|
|
82
|
+
/**
|
|
83
|
+
* Constant defining event type for Buffer start
|
|
84
|
+
*/
|
|
85
|
+
BufferStart: "bufferStart",
|
|
86
|
+
/**
|
|
87
|
+
* Constant defining event type for Buffer complete
|
|
88
|
+
*/
|
|
89
|
+
BufferComplete: "bufferComplete",
|
|
90
|
+
/**
|
|
91
|
+
* Constant defining event type for change in Bitrate
|
|
92
|
+
*/
|
|
93
|
+
BitrateChange: "bitrateChange",
|
|
94
|
+
/**
|
|
95
|
+
* Constant defining event type for Custom State Start
|
|
96
|
+
*/
|
|
97
|
+
StateStart: "stateStart",
|
|
98
|
+
/**
|
|
99
|
+
* Constant defining event type for Custom State End
|
|
100
|
+
*/
|
|
101
|
+
StateEnd: "stateEnd"
|
|
102
|
+
};
|
|
103
|
+
exports.Event = Event;
|
|
104
|
+
var mediaEvent = _objectSpread({
|
|
105
|
+
SessionStart: "sessionStart",
|
|
106
|
+
SessionEnd: "sessionEnd",
|
|
107
|
+
SessionComplete: "sessionComplete",
|
|
108
|
+
Play: "play",
|
|
109
|
+
Pause: "pauseStart"
|
|
110
|
+
}, Event);
|
|
111
|
+
exports.mediaEvent = mediaEvent;
|
|
112
|
+
var MediaObjectKey = {
|
|
113
|
+
MediaResumed: "media.resumed",
|
|
114
|
+
GranularAdTracking: "media.granularadtracking"
|
|
115
|
+
};
|
|
116
|
+
exports.MediaObjectKey = MediaObjectKey;
|
|
117
|
+
var VideoMetadataKeys = {
|
|
118
|
+
Show: "a.media.show",
|
|
119
|
+
Season: "a.media.season",
|
|
120
|
+
Episode: "a.media.episode",
|
|
121
|
+
AssetId: "a.media.asset",
|
|
122
|
+
Genre: "a.media.genre",
|
|
123
|
+
FirstAirDate: "a.media.airDate",
|
|
124
|
+
FirstDigitalDate: "a.media.digitalDate",
|
|
125
|
+
Rating: "a.media.rating",
|
|
126
|
+
Originator: "a.media.originator",
|
|
127
|
+
Network: "a.media.network",
|
|
128
|
+
ShowType: "a.media.type",
|
|
129
|
+
AdLoad: "a.media.adLoad",
|
|
130
|
+
MVPD: "a.media.pass.mvpd",
|
|
131
|
+
Authorized: "a.media.pass.auth",
|
|
132
|
+
DayPart: "a.media.dayPart",
|
|
133
|
+
Feed: "a.media.feed",
|
|
134
|
+
StreamFormat: "a.media.format"
|
|
135
|
+
};
|
|
136
|
+
exports.VideoMetadataKeys = VideoMetadataKeys;
|
|
137
|
+
var AudioMetadataKeys = {
|
|
138
|
+
Artist: "a.media.artist",
|
|
139
|
+
Album: "a.media.album",
|
|
140
|
+
Label: "a.media.label",
|
|
141
|
+
Author: "a.media.author",
|
|
142
|
+
Station: "a.media.station",
|
|
143
|
+
Publisher: "a.media.publisher"
|
|
144
|
+
};
|
|
145
|
+
exports.AudioMetadataKeys = AudioMetadataKeys;
|
|
146
|
+
var AdMetadataKeys = {
|
|
147
|
+
Advertiser: "a.media.ad.advertiser",
|
|
148
|
+
CampaignId: "a.media.ad.campaign",
|
|
149
|
+
CreativeId: "a.media.ad.creative",
|
|
150
|
+
PlacementId: "a.media.ad.placement",
|
|
151
|
+
SiteId: "a.media.ad.site",
|
|
152
|
+
CreativeUrl: "a.media.ad.creativeURL"
|
|
153
|
+
};
|
|
154
|
+
exports.AdMetadataKeys = AdMetadataKeys;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
exports.mediaToXdmKeys = exports.adsToXdmKeys = void 0;
|
|
4
|
+
/*
|
|
5
|
+
Copyright 2023 Adobe. All rights reserved.
|
|
6
|
+
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
you may not use this file except in compliance with the License. You may obtain a copy
|
|
8
|
+
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
|
|
10
|
+
Unless required by applicable law or agreed to in writing, software distributed under
|
|
11
|
+
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
12
|
+
OF ANY KIND, either express or implied. See the License for the specific language
|
|
13
|
+
governing permissions and limitations under the License.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
var mediaToXdmKeys = {
|
|
17
|
+
"a.media.show": "show",
|
|
18
|
+
"a.media.season": "season",
|
|
19
|
+
"a.media.episode": "episode",
|
|
20
|
+
"a.media.asset": "assetID",
|
|
21
|
+
"a.media.genre": "genre",
|
|
22
|
+
"a.media.airDate": "firstAirDate",
|
|
23
|
+
"a.media.digitalDate": "firstDigitalDate",
|
|
24
|
+
"a.media.rating": "rating",
|
|
25
|
+
"a.media.originator": "originator",
|
|
26
|
+
"a.media.network": "network",
|
|
27
|
+
"a.media.type": "showType",
|
|
28
|
+
"a.media.adLoad": "adLoad",
|
|
29
|
+
"a.media.pass.mvpd": "mvpd",
|
|
30
|
+
"a.media.pass.auth": "authorized",
|
|
31
|
+
"a.media.dayPart": "dayPart",
|
|
32
|
+
"a.media.feed": "feed",
|
|
33
|
+
"a.media.format": "streamFormat",
|
|
34
|
+
"a.media.artist": "artist",
|
|
35
|
+
"a.media.album": "album",
|
|
36
|
+
"a.media.label": "label",
|
|
37
|
+
"a.media.author": "author",
|
|
38
|
+
"a.media.station": "station",
|
|
39
|
+
"a.media.publisher": "publisher",
|
|
40
|
+
"media.resumed": "hasResume"
|
|
41
|
+
};
|
|
42
|
+
exports.mediaToXdmKeys = mediaToXdmKeys;
|
|
43
|
+
var adsToXdmKeys = {
|
|
44
|
+
"a.media.ad.advertiser": "advertiser",
|
|
45
|
+
"a.media.ad.campaign": "campaignID",
|
|
46
|
+
"a.media.ad.creative": "creativeID",
|
|
47
|
+
"a.media.ad.placement": "placementID",
|
|
48
|
+
"a.media.ad.site": "siteID",
|
|
49
|
+
"a.media.ad.creativeURL": "creativeURL"
|
|
50
|
+
};
|
|
51
|
+
exports.adsToXdmKeys = adsToXdmKeys;
|