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

package/libEs5/components/LegacyMediaAnalytics/{media → constants}/constants.js

@@ -1,9 +1,6 @@
 "use strict";
 
-exports.mediaEvent = exports.VideoMetadataKeys = exports.StreamType = exports.PlayerState = exports.MediaType = exports.MediaObjectKey = exports.Event = exports.AudioMetadataKeys = exports.AdMetadataKeys = void 0;
-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; }
+exports.VIDEO_METADATA_KEYS = exports.STREAM_TYPE = exports.PLAYER_STATE = exports.MEDIA_TYPE = exports.MEDIA_OBJECT_KEYS = exports.MEDIA_EVENTS_INTERNAL = exports.EVENT = exports.AUDIO_METADATA_KEYS = exports.AD_METADATA_KEYS = void 0;
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -16,12 +13,11 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-var MediaType = {
+var MEDIA_TYPE = exports.MEDIA_TYPE = {
   Video: "video",
   Audio: "audio"
 };
-exports.MediaType = MediaType;
-var StreamType = {
+var STREAM_TYPE = exports.STREAM_TYPE = {
   VOD: "vod",
   Live: "live",
   Linear: "linear",
@@ -29,16 +25,14 @@ var StreamType = {
   Audiobook: "audiobook",
   AOD: "aod"
 };
-exports.StreamType = StreamType;
-var PlayerState = {
+var PLAYER_STATE = exports.PLAYER_STATE = {
   FullScreen: "fullScreen",
   ClosedCaption: "closedCaptioning",
   Mute: "mute",
   PictureInPicture: "pictureInPicture",
   InFocus: "inFocus"
 };
-exports.PlayerState = PlayerState;
-var Event = {
+var EVENT = exports.EVENT = {
   /**
    * Constant defining event type for AdBreak start
    */
@@ -100,21 +94,20 @@ var Event = {
    */
   StateEnd: "stateEnd"
 };
-exports.Event = Event;
-var mediaEvent = _objectSpread({
+var MEDIA_EVENTS_INTERNAL = exports.MEDIA_EVENTS_INTERNAL = {
   SessionStart: "sessionStart",
   SessionEnd: "sessionEnd",
   SessionComplete: "sessionComplete",
   Play: "play",
-  Pause: "pauseStart"
-}, Event);
-exports.mediaEvent = mediaEvent;
-var MediaObjectKey = {
+  Pause: "pauseStart",
+  Error: "error",
+  StateUpdate: "statesUpdate"
+};
+var MEDIA_OBJECT_KEYS = exports.MEDIA_OBJECT_KEYS = {
   MediaResumed: "media.resumed",
   GranularAdTracking: "media.granularadtracking"
 };
-exports.MediaObjectKey = MediaObjectKey;
-var VideoMetadataKeys = {
+var VIDEO_METADATA_KEYS = exports.VIDEO_METADATA_KEYS = {
   Show: "a.media.show",
   Season: "a.media.season",
   Episode: "a.media.episode",
@@ -133,8 +126,7 @@ var VideoMetadataKeys = {
   Feed: "a.media.feed",
   StreamFormat: "a.media.format"
 };
-exports.VideoMetadataKeys = VideoMetadataKeys;
-var AudioMetadataKeys = {
+var AUDIO_METADATA_KEYS = exports.AUDIO_METADATA_KEYS = {
   Artist: "a.media.artist",
   Album: "a.media.album",
   Label: "a.media.label",
@@ -142,13 +134,11 @@ var AudioMetadataKeys = {
   Station: "a.media.station",
   Publisher: "a.media.publisher"
 };
-exports.AudioMetadataKeys = AudioMetadataKeys;
-var AdMetadataKeys = {
+var AD_METADATA_KEYS = exports.AD_METADATA_KEYS = {
   Advertiser: "a.media.ad.advertiser",
   CampaignId: "a.media.ad.campaign",
   CreativeId: "a.media.ad.creative",
   PlacementId: "a.media.ad.placement",
   SiteId: "a.media.ad.site",
   CreativeUrl: "a.media.ad.creativeURL"
-};
-exports.AdMetadataKeys = AdMetadataKeys;
+};

package/libEs5/components/LegacyMediaAnalytics/{media → constants}/mediaKeysToXdmConverter.js

@@ -13,7 +13,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-var mediaToXdmKeys = {
+var mediaToXdmKeys = exports.mediaToXdmKeys = {
   "a.media.show": "show",
   "a.media.season": "season",
   "a.media.episode": "episode",
@@ -39,13 +39,11 @@ var mediaToXdmKeys = {
   "a.media.publisher": "publisher",
   "media.resumed": "hasResume"
 };
-exports.mediaToXdmKeys = mediaToXdmKeys;
-var adsToXdmKeys = {
+var adsToXdmKeys = exports.adsToXdmKeys = {
   "a.media.ad.advertiser": "advertiser",
   "a.media.ad.campaign": "campaignID",
   "a.media.ad.creative": "creativeID",
   "a.media.ad.placement": "placementID",
   "a.media.ad.site": "siteID",
   "a.media.ad.creativeURL": "creativeURL"
-};
-exports.adsToXdmKeys = adsToXdmKeys;
+};

package/libEs5/components/LegacyMediaAnalytics/createGetInstance.js

@@ -0,0 +1,246 @@
+"use strict";
+
+exports.default = void 0;
+var _constants = require("./constants/constants");
+var _utils = require("../../utils");
+var _mediaKeysToXdmConverter = require("./constants/mediaKeysToXdmConverter");
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+var _default = exports.default = function _default(_ref) {
+  var logger = _ref.logger,
+    trackMediaSession = _ref.trackMediaSession,
+    trackMediaEvent = _ref.trackMediaEvent,
+    uuid = _ref.uuid;
+  var trackerState = {
+    qoe: null,
+    lastPlayhead: 0,
+    playerId: uuid()
+  };
+  var getEventType = function getEventType(_ref2) {
+    var eventType = _ref2.eventType;
+    if (eventType === _constants.EVENT.BufferComplete || eventType === _constants.EVENT.SeekComplete) {
+      return _constants.MEDIA_EVENTS_INTERNAL.Play;
+    }
+    if (eventType === _constants.EVENT.StateStart || eventType === _constants.EVENT.StateEnd) {
+      return _constants.MEDIA_EVENTS_INTERNAL.StateUpdate;
+    }
+    if (eventType === _constants.EVENT.SeekStart) {
+      return _constants.MEDIA_EVENTS_INTERNAL.Pause;
+    }
+    return eventType;
+  };
+  var createXdmObject = function createXdmObject(_ref3) {
+    var eventType = _ref3.eventType,
+      _ref3$mediaDetails = _ref3.mediaDetails,
+      mediaDetails = _ref3$mediaDetails === void 0 ? {} : _ref3$mediaDetails,
+      _ref3$contextData = _ref3.contextData,
+      contextData = _ref3$contextData === void 0 ? [] : _ref3$contextData;
+    var action = getEventType({
+      eventType: eventType
+    });
+    if (eventType === _constants.EVENT.StateStart) {
+      var _xdm = {
+        eventType: "media." + action,
+        mediaCollection: {
+          statesStart: [mediaDetails]
+        }
+      };
+      return _xdm;
+    }
+    if (eventType === _constants.EVENT.StateEnd) {
+      var _xdm2 = {
+        eventType: "media." + action,
+        mediaCollection: {
+          statesEnd: [mediaDetails]
+        }
+      };
+      return _xdm2;
+    }
+    var xdm = {
+      eventType: "media." + action,
+      mediaCollection: _objectSpread({}, mediaDetails)
+    };
+    var customMetadata = [];
+    Object.keys(contextData).forEach(function (key) {
+      if (_mediaKeysToXdmConverter.mediaToXdmKeys[key]) {
+        xdm.mediaCollection.sessionDetails[_mediaKeysToXdmConverter.mediaToXdmKeys[key]] = contextData[key];
+      } else if (_mediaKeysToXdmConverter.adsToXdmKeys[key]) {
+        xdm.mediaCollection.advertisingDetails[_mediaKeysToXdmConverter.adsToXdmKeys[key]] = contextData[key];
+      } else {
+        customMetadata.push({
+          name: key,
+          value: contextData[key]
+        });
+      }
+    });
+    if ((0, _utils.isNonEmptyArray)(customMetadata)) {
+      xdm.mediaCollection.customMetadata = customMetadata;
+    }
+    return xdm;
+  };
+  return {
+    trackSessionStart: function trackSessionStart(mediaObject) {
+      var contextData = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      if ((0, _utils.isEmptyObject)(mediaObject)) {
+        logger.warn("Invalid media object");
+        return {};
+      }
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed. Restarting a new session.");
+        trackerState = {
+          qoe: null,
+          lastPlayhead: 0,
+          playerId: uuid()
+        };
+      }
+      var xdm = createXdmObject({
+        eventType: _constants.MEDIA_EVENTS_INTERNAL.SessionStart,
+        mediaDetails: mediaObject,
+        contextData: contextData
+      });
+      return trackMediaSession({
+        playerId: trackerState.playerId,
+        getPlayerDetails: function getPlayerDetails() {
+          return {
+            playhead: trackerState.lastPlayhead,
+            qoeDataDetails: trackerState.qoe
+          };
+        },
+        xdm: xdm
+      });
+    },
+    trackPlay: function trackPlay() {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      var xdm = createXdmObject({
+        eventType: _constants.MEDIA_EVENTS_INTERNAL.Play
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm: xdm
+      });
+    },
+    trackPause: function trackPause() {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      var xdm = createXdmObject({
+        eventType: _constants.MEDIA_EVENTS_INTERNAL.Pause
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm: xdm
+      });
+    },
+    trackSessionEnd: function trackSessionEnd() {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      var xdm = createXdmObject({
+        eventType: _constants.MEDIA_EVENTS_INTERNAL.SessionEnd
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm: xdm
+      });
+    },
+    trackComplete: function trackComplete() {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      var xdm = createXdmObject({
+        eventType: _constants.MEDIA_EVENTS_INTERNAL.SessionComplete
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm: xdm
+      });
+    },
+    trackError: function trackError(errorId) {
+      logger.warn("trackError(" + errorId + ")");
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      var errorDetails = {
+        name: errorId,
+        source: "player"
+      };
+      var xdm = createXdmObject({
+        eventType: _constants.MEDIA_EVENTS_INTERNAL.Error,
+        mediaDetails: {
+          errorDetails: errorDetails
+        }
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm: xdm
+      });
+    },
+    trackEvent: function trackEvent(eventType, info, context) {
+      if ((0, _utils.isEmptyObject)(info)) {
+        logger.warn("Invalid media object.");
+        return {};
+      }
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      if (!(0, _utils.includes)(Object.values(_constants.EVENT), eventType)) {
+        logger.warn("Invalid event type");
+        return {};
+      }
+      var xdm = createXdmObject({
+        eventType: eventType,
+        mediaDetails: info,
+        contextData: context
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm: xdm
+      });
+    },
+    updatePlayhead: function updatePlayhead(time) {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return;
+      }
+      if ((0, _utils.isNumber)(time)) {
+        trackerState.lastPlayhead = parseInt(time, 10);
+      }
+    },
+    updateQoEObject: function updateQoEObject(qoeObject) {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return;
+      }
+      if (!qoeObject) {
+        return;
+      }
+      trackerState.qoe = qoeObject;
+    },
+    destroy: function destroy() {
+      logger.warn("Destroy called, destroying the tracker.");
+      trackerState = null;
+    }
+  };
+};

package/libEs5/components/LegacyMediaAnalytics/createLegacyMediaComponent.js

@@ -0,0 +1,87 @@
+"use strict";
+
+exports.default = void 0;
+var _utils = require("../../utils");
+var _constants = require("./constants/constants");
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+var _default = exports.default = function _default(_ref) {
+  var trackMediaEvent = _ref.trackMediaEvent,
+    trackMediaSession = _ref.trackMediaSession,
+    mediaResponseHandler = _ref.mediaResponseHandler,
+    logger = _ref.logger,
+    createMediaHelper = _ref.createMediaHelper,
+    createGetInstance = _ref.createGetInstance,
+    config = _ref.config;
+  return {
+    lifecycle: {
+      onBeforeEvent: function onBeforeEvent(_ref2) {
+        var mediaOptions = _ref2.mediaOptions,
+          _ref2$onResponse = _ref2.onResponse,
+          onResponse = _ref2$onResponse === void 0 ? _utils.noop : _ref2$onResponse;
+        if (!mediaOptions) {
+          return;
+        }
+        var legacy = mediaOptions.legacy,
+          playerId = mediaOptions.playerId,
+          getPlayerDetails = mediaOptions.getPlayerDetails;
+        if (!legacy) {
+          return;
+        }
+        onResponse(function (_ref3) {
+          var response = _ref3.response;
+          return mediaResponseHandler({
+            playerId: playerId,
+            getPlayerDetails: getPlayerDetails,
+            response: response
+          });
+        });
+      }
+    },
+    commands: {
+      getMediaAnalyticsTracker: {
+        run: function run() {
+          if (!config.streamingMedia) {
+            return Promise.reject(new Error("Streaming media is not configured."));
+          }
+          logger.info("Streaming media is configured in legacy mode.");
+          var mediaAnalyticsHelper = createMediaHelper({
+            logger: logger
+          });
+          return Promise.resolve(_objectSpread({
+            getInstance: function getInstance() {
+              return createGetInstance({
+                logger: logger,
+                trackMediaEvent: trackMediaEvent,
+                trackMediaSession: trackMediaSession,
+                uuid: _utils.uuid
+              });
+            },
+            Event: _constants.EVENT,
+            MediaType: _constants.MEDIA_TYPE,
+            PlayerState: _constants.PLAYER_STATE,
+            StreamType: _constants.STREAM_TYPE,
+            MediaObjectKey: _constants.MEDIA_OBJECT_KEYS,
+            VideoMetadataKeys: _constants.VIDEO_METADATA_KEYS,
+            AudioMetadataKeys: _constants.AUDIO_METADATA_KEYS,
+            AdMetadataKeys: _constants.AD_METADATA_KEYS
+          }, mediaAnalyticsHelper));
+        }
+      }
+    }
+  };
+};