@adobe/alloy 2.20.0-alpha.0 → 2.20.0-alpha.1

package/libEs5/components/MediaCollection/createHeartbeatEngine.js

@@ -2,6 +2,7 @@
 
 exports.default = void 0;
 var _toInteger = require("../../utils/toInteger");
+var _eventTypes = require("./constants/eventTypes");
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -13,6 +14,12 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
+var ACTION = "ping";
+var getCurrentInterval = function getCurrentInterval(playerSession) {
+  var currentTime = Date.now();
+  return Math.abs(currentTime - playerSession.latestTriggeredEvent) / 1000;
+};
 var _default = function _default(_ref) {
   var config = _ref.config,
     mediaEventManager = _ref.mediaEventManager,
@@ -21,15 +28,15 @@ var _default = function _default(_ref) {
     var playerId = _ref2.playerId,
       sessionId = _ref2.sessionId,
       onBeforeMediaEvent = _ref2.onBeforeMediaEvent;
-    var currentTime = Date.now();
     var mainPingInterval = config.mediaCollection.mainPingInterval;
     var playerSession = mediaSessionCacheManager.getSession(playerId);
-    if (Math.abs(currentTime - playerSession.latestTriggeredEvent) / 1000 > mainPingInterval) {
+    var currentInterval = getCurrentInterval(playerSession);
+    if (currentInterval > mainPingInterval) {
       var _onBeforeMediaEvent = onBeforeMediaEvent(playerId),
         playhead = _onBeforeMediaEvent.playhead,
         qoeDataDetails = _onBeforeMediaEvent.qoeDataDetails;
       var xdm = {
-        eventType: "media.ping",
+        eventType: _eventTypes.default.PING,
         mediaCollection: {
           playhead: (0, _toInteger.default)(playhead),
           sessionID: sessionId,
@@ -42,7 +49,8 @@ var _default = function _default(_ref) {
         }
       });
       return mediaEventManager.trackMediaEvent({
-        event: event
+        event: event,
+        action: ACTION
       }).then(function () {
         mediaSessionCacheManager.updateLastTriggeredEventTS({
           playerId: playerId

package/libEs5/components/MediaCollection/createMediaEventManager.js

@@ -1,11 +1,11 @@
 "use strict";
 
 exports.default = void 0;
-var _mediaEvents = require("./mediaConstants/mediaEvents");
-var _createMediaRequestPayload = require("./createMediaRequestPayload");
+var _eventTypes = require("./constants/eventTypes");
 var _createMediaRequest = require("./createMediaRequest");
 var _injectTimestamp = require("../Context/injectTimestamp");
 var _utils = require("../../utils");
+var _request = require("../../utils/request");
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -26,15 +26,13 @@ var _default = function _default(_ref) {
   return {
     createMediaEvent: function createMediaEvent(_ref2) {
       var options = _ref2.options;
-      var _options$xdm = options.xdm,
-        xdm = _options$xdm === void 0 ? {} : _options$xdm;
-      var event = {
-        xdm: xdm
-      };
+      var event = eventManager.createEvent();
+      var xdm = options.xdm;
       var timestamp = (0, _injectTimestamp.default)(function () {
         return new Date();
       });
-      timestamp(event.xdm);
+      timestamp(xdm);
+      event.setUserXdm(xdm);
       return event;
     },
     createMediaSession: function createMediaSession(options) {
@@ -43,14 +41,15 @@ var _default = function _default(_ref) {
         channel = _config$mediaCollecti.channel,
         version = _config$mediaCollecti.version;
       var event = eventManager.createEvent();
+      var sessionDetails = options.xdm.mediaCollection.sessionDetails;
       event.setUserXdm(options.xdm);
       event.mergeXdm({
-        eventType: _mediaEvents.default.SESSION_START,
+        eventType: _eventTypes.default.SESSION_START,
         mediaCollection: {
           sessionDetails: {
-            playerName: options.xdm.mediaCollection.sessionDetails.playerName || playerName,
-            channel: options.xdm.mediaCollection.sessionDetails.channel || channel,
-            appVersion: options.xdm.mediaCollection.sessionDetails.appVersion || version
+            playerName: sessionDetails.playerName || playerName,
+            channel: sessionDetails.channel || channel,
+            appVersion: sessionDetails.appVersion || version
           }
         }
       });
@@ -69,24 +68,14 @@ var _default = function _default(_ref) {
         }),
         playhead = _onBeforeMediaEvent.playhead,
         qoeDataDetails = _onBeforeMediaEvent.qoeDataDetails;
-      if (event.mergeXdm) {
-        event.mergeXdm({
-          mediaCollection: {
-            playhead: (0, _utils.toInteger)(playhead),
-            qoeDataDetails: qoeDataDetails
-          }
-        });
-        return event;
-      }
-      return (0, _utils.deepAssign)(event, {
-        xdm: {
-          mediaCollection: {
-            playhead: (0, _utils.toInteger)(playhead),
-            qoeDataDetails: qoeDataDetails,
-            sessionID: sessionID
-          }
+      event.mergeXdm({
+        mediaCollection: {
+          playhead: (0, _utils.toInteger)(playhead),
+          qoeDataDetails: qoeDataDetails,
+          sessionID: sessionID
         }
       });
+      return event;
     },
     trackMediaSession: function trackMediaSession(_ref4) {
       var event = _ref4.event,
@@ -98,14 +87,15 @@ var _default = function _default(_ref) {
       });
     },
     trackMediaEvent: function trackMediaEvent(_ref5) {
-      var event = _ref5.event;
-      var action = event.xdm.eventType.split(".")[1];
-      var mediaRequestPayload = (0, _createMediaRequestPayload.default)();
+      var event = _ref5.event,
+        action = _ref5.action;
+      var mediaRequestPayload = (0, _request.createDataCollectionRequestPayload)();
       var request = (0, _createMediaRequest.default)({
         mediaRequestPayload: mediaRequestPayload,
         action: action
       });
       mediaRequestPayload.addEvent(event);
+      event.finalize();
       return consent.awaitConsent().then(function () {
         return sendEdgeNetworkRequest({
           request: request

package/libEs5/components/MediaCollection/createMediaSessionCacheManager.js

@@ -20,28 +20,28 @@ var _default = function _default() {
   var saveHeartbeat = function saveHeartbeat(_ref) {
     var playerId = _ref.playerId,
       heartbeatId = _ref.heartbeatId;
-    var mediaSession = mediaSessionCache[playerId];
-    if (!mediaSession) {
+    var sessionDetails = mediaSessionCache[playerId];
+    if (!sessionDetails) {
       return;
     }
-    mediaSession.heartbeatId = heartbeatId;
+    sessionDetails.heartbeatId = heartbeatId;
   };
   var stopHeartbeat = function stopHeartbeat(_ref2) {
     var playerId = _ref2.playerId;
-    var mediaSession = mediaSessionCache[playerId];
-    if (!mediaSession) {
+    var sessionDetails = mediaSessionCache[playerId];
+    if (!sessionDetails) {
       return;
     }
-    clearInterval(mediaSession.heartbeatId);
-    mediaSession.heartbeatId = null;
+    clearInterval(sessionDetails.heartbeatId);
+    sessionDetails.heartbeatId = null;
   };
   var updateLastTriggeredEventTS = function updateLastTriggeredEventTS(_ref3) {
     var playerId = _ref3.playerId;
-    var player = mediaSessionCache[playerId];
-    if (!player) {
+    var sessionDetails = mediaSessionCache[playerId];
+    if (!sessionDetails) {
       return;
     }
-    player.latestTriggeredEvent = Date.now();
+    sessionDetails.latestTriggeredEvent = Date.now();
   };
   var storeSession = function storeSession(_ref4) {
     var playerId = _ref4.playerId,

package/libEs5/components/MediaCollection/createUpdateMediaSessionState.js

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.default = void 0;
-var _mediaEvents = require("./mediaConstants/mediaEvents");
+var _eventTypes = require("./constants/eventTypes");
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -17,12 +17,8 @@ var _default = function _default(_ref) {
   var mediaSessionCacheManager = _ref.mediaSessionCacheManager;
   return function (_ref2) {
     var playerId = _ref2.playerId,
-      xdm = _ref2.xdm;
-    if (!playerId) {
-      return;
-    }
-    var eventType = xdm.eventType;
-    if (eventType === _mediaEvents.default.SESSION_COMPLETE || eventType === _mediaEvents.default.SESSION_END) {
+      eventType = _ref2.eventType;
+    if (eventType === _eventTypes.default.SESSION_COMPLETE || eventType === _eventTypes.default.SESSION_END) {
       mediaSessionCacheManager.stopHeartbeat({
         playerId: playerId
       });

package/libEs5/components/MediaCollection/index.js

@@ -120,24 +120,30 @@ var createMediaCollection = function createMediaCollection(_ref) {
           var event = mediaEventManager.createMediaEvent({
             options: options
           });
-          var playerId = options.playerId;
+          var playerId = options.playerId,
+            xdm = options.xdm;
+          var eventType = xdm.eventType;
+          var action = eventType.split(".")[1];
           var _mediaSessionCacheMan = mediaSessionCacheManager.getSession(playerId),
             onBeforeMediaEvent = _mediaSessionCacheMan.onBeforeMediaEvent,
             sessionPromise = _mediaSessionCacheMan.sessionPromise;
           sessionPromise.then(function (result) {
-            var finalEvent = mediaEventManager.augmentMediaEvent({
+            mediaEventManager.augmentMediaEvent({
               event: event,
               playerId: playerId,
               onBeforeMediaEvent: onBeforeMediaEvent,
               sessionID: result.sessionId
             });
             return mediaEventManager.trackMediaEvent({
-              event: finalEvent
+              event: event,
+              action: action
             }).then(function () {
               updateMediaSessionState({
                 playerId: playerId,
-                xdm: finalEvent.xdm
+                eventType: eventType
               });
+            }).catch(function (error) {
+              logger.warn("The Media Event of type " + action + " failed.", error);
             });
           });
         }
@@ -151,8 +157,8 @@ createMediaCollection.configValidators = (0, _validation.objectOf)({
     channel: (0, _validation.string)().nonEmpty().required(),
     playerName: (0, _validation.string)().nonEmpty().required(),
     version: (0, _validation.string)(),
-    mainPingInterval: (0, _validation.number)().minimum(10).maximum(60).default(10),
-    adPingInterval: (0, _validation.number)().minimum(10).maximum(60).default(10)
+    mainPingInterval: (0, _validation.number)().minimum(10).maximum(50).default(10),
+    adPingInterval: (0, _validation.number)().minimum(10).maximum(50).default(10)
   }).noUnknownFields()
 });
 var _default = createMediaCollection;

package/libEs5/constants/libraryVersion.js

@@ -14,5 +14,5 @@ governing permissions and limitations under the License.
 */
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
-var _default = "2.20.0-alpha.0";
+var _default = "2.20.0-alpha.1";
 exports.default = _default;

package/libEs5/utils/validation/index.js

@@ -23,6 +23,7 @@ var _numberValidator = require("./numberValidator");
 var _regexpValidator = require("./regexpValidator");
 var _requiredValidator = require("./requiredValidator");
 var _stringValidator = require("./stringValidator");
+var _matchesRegexpValidator = require("./matchesRegexpValidator");
 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; }
 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; }
 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; } /*
@@ -137,6 +138,9 @@ var nonEmptyObject = function nonEmptyObject() {
 var regexp = function regexp() {
   return (0, _utils.nullSafeChain)(this, _regexpValidator.default);
 };
+var matches = function matches(regexpPattern) {
+  return (0, _utils.nullSafeChain)(this, (0, _matchesRegexpValidator.default)(regexpPattern));
+};
 var unique = function createUnique() {
   return (0, _utils.nullSafeChain)(this, (0, _createUniqueValidator.default)());
 };
@@ -208,7 +212,8 @@ var string = function string() {
     regexp: regexp,
     domain: domain,
     nonEmpty: nonEmptyString,
-    unique: unique
+    unique: unique,
+    matches: matches
   });
 };
 var boundAnyOf = anyOf.bind(base);

package/{libEs6/components/MediaCollection/createMediaRequestPayload.js → libEs5/utils/validation/matchesRegexpValidator.js}

@@ -1,3 +1,7 @@
+"use strict";
+
+exports.default = void 0;
+var _utils = require("./utils");
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -9,18 +13,10 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-
-import { createAddIdentity, createHasIdentity, createRequestPayload } from "../../utils/request";
-export default (() => {
-  const content = {};
-  const payload = createRequestPayload({
-    content,
-    addIdentity: createAddIdentity(content),
-    hasIdentity: createHasIdentity(content)
-  });
-  payload.addEvent = event => {
-    content.events = content.events || [];
-    content.events.push(event);
+var _default = function _default(regexp) {
+  return function (value, path) {
+    (0, _utils.assertValid)(regexp.test(value), value, path, "does not match the " + regexp.toString());
+    return value;
   };
-  return payload;
-});
+};
+exports.default = _default;

package/libEs6/components/LegacyMediaAnalytics/createMediaAnalyticsTracker.js

@@ -11,10 +11,10 @@ governing permissions and limitations under the License.
 */
 
 import defer from "../../utils/defer";
-import { AdMetadataKeys, AudioMetadataKeys, mediaEvent as Event, MediaObjectKey, MediaType, PlayerState, StreamType, VideoMetadataKeys } from "./media/constants";
+import { AD_METADATA_KEYS as AdMetadataKeys, AUDIO_METADATA_KEYS as AudioMetadataKeys, EVENT as Event, PLAYER_STATE as PlayerState, STREAM_TYPE as StreamType, MEDIA_OBJECT_KEYS as MediaObjectKey, VIDEO_METADATA_KEYS as VideoMetadataKeys, MEDIA_TYPE as MediaType, MEDIA_EVENTS } from "./media/constants";
 import { deepAssign, isEmptyObject, isNumber } from "../../utils";
 import { adsToXdmKeys, mediaToXdmKeys } from "./media/mediaKeysToXdmConverter";
-import { createMediaObject, createAdBreakObject, createAdObject, createChapterObject, createStateObject, createQoEObject } from "./createMediaHelper";
+import createMediaHelper from "./createMediaHelper";
 const convertSessionDetailsMetadataToXDM = contextData => {
   const customMetadata = [];
   const sessionDetails = {};
@@ -41,7 +41,7 @@ const createMediaDetailsObject = ({
   const mediaDetails = info;
   const customMetadata = [];
   if (context && !isEmptyObject(context)) {
-    if (eventType === Event.AdStart) {
+    if (eventType === MEDIA_EVENTS.AdStart) {
       Object.keys(context).forEach(key => {
         if (adsToXdmKeys[key]) {
           mediaDetails.advertisingDetails[mediaToXdmKeys[key]] = context[key];
@@ -100,20 +100,21 @@ const createGetInstance = ({
   const getEventType = ({
     eventType
   }) => {
-    if (eventType === Event.BufferComplete) {
-      return `media.${Event.Play}`;
+    if (eventType === MEDIA_EVENTS.BufferComplete) {
+      return MEDIA_EVENTS.Play;
     }
-    return `media.${eventType}`;
+    return eventType;
   };
   const trackEvent = ({
     eventType,
     mediaDetails
   }) => {
     return deferSession.promise.then(sessionID => {
+      const action = getEventType({
+        eventType
+      });
       const xdm = {
-        eventType: getEventType({
-          eventType
-        }),
+        eventType: `media.${action}`,
         mediaCollection: {
           sessionID,
           playhead: trackerState.lastPlayhead
@@ -126,12 +127,13 @@ const createGetInstance = ({
         }
       });
       return mediaEventManager.trackMediaEvent({
-        event
+        event,
+        action
       }).then(() => {
         updateLastTimeEventTriggered();
       });
     }).catch(error => {
-      logger.info(error);
+      logger.warn(`An error occurred while sending ${eventType} Media Event.`, error);
     });
   };
   const heartbeatEngine = createHeartbeat({
@@ -175,18 +177,18 @@ const createGetInstance = ({
     },
     trackPlay: () => {
       return trackEvent({
-        eventType: Event.Play
+        eventType: MEDIA_EVENTS.Play
       });
     },
     trackPause: () => {
       return trackEvent({
-        eventType: Event.Pause
+        eventType: MEDIA_EVENTS.Pause
       });
     },
     trackSessionEnd: () => {
       clearInterval(ticker);
       return trackEvent({
-        eventType: Event.SessionEnd
+        eventType: MEDIA_EVENTS.SessionEnd
       }).then(() => {
         deferSession = null;
       });
@@ -194,7 +196,7 @@ const createGetInstance = ({
     trackComplete: () => {
       clearInterval(ticker);
       return trackEvent({
-        eventType: Event.SessionComplete
+        eventType: MEDIA_EVENTS.SessionComplete
       });
     },
     trackError: errorId => {
@@ -207,7 +209,7 @@ const createGetInstance = ({
         errorDetails
       };
       return trackEvent({
-        eventType: Event.SessionEnd,
+        eventType: MEDIA_EVENTS.SessionEnd,
         mediaDetails
       });
     },
@@ -250,6 +252,9 @@ export const createMediaAnalyticsTracker = ({
   mediaEventManager
 }) => {
   logger.info("Media Analytics Component was configured");
+  const mediaAnalyticsHelper = createMediaHelper({
+    logger
+  });
   return {
     getInstance: () => {
       return createGetInstance({
@@ -266,11 +271,6 @@ export const createMediaAnalyticsTracker = ({
     VideoMetadataKeys,
     AudioMetadataKeys,
     AdMetadataKeys,
-    createMediaObject,
-    createAdBreakObject,
-    createAdObject,
-    createChapterObject,
-    createStateObject,
-    createQoEObject
+    ...mediaAnalyticsHelper
   };
 };