@adobe/alloy 2.19.2 → 2.20.0-alpha.1

package/libEs5/components/LegacyMediaAnalytics/media/constants.js

@@ -0,0 +1,154 @@
+"use strict";
+
+exports.VIDEO_METADATA_KEYS = exports.STREAM_TYPE = exports.PLAYER_STATE = exports.MEDIA_TYPE = exports.MEDIA_OBJECT_KEYS = exports.MEDIA_EVENTS = exports.EVENT = exports.AUDIO_METADATA_KEYS = exports.AD_METADATA_KEYS = 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; }
+/*
+Copyright 2023 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 MEDIA_TYPE = {
+  Video: "video",
+  Audio: "audio"
+};
+exports.MEDIA_TYPE = MEDIA_TYPE;
+var STREAM_TYPE = {
+  VOD: "vod",
+  Live: "live",
+  Linear: "linear",
+  Podcast: "podcast",
+  Audiobook: "audiobook",
+  AOD: "aod"
+};
+exports.STREAM_TYPE = STREAM_TYPE;
+var PLAYER_STATE = {
+  FullScreen: "fullScreen",
+  ClosedCaption: "closedCaptioning",
+  Mute: "mute",
+  PictureInPicture: "pictureInPicture",
+  InFocus: "inFocus"
+};
+exports.PLAYER_STATE = PLAYER_STATE;
+var EVENT = {
+  /**
+   * Constant defining event type for AdBreak start
+   */
+  AdBreakStart: "adBreakStart",
+  /**
+   * Constant defining event type for AdBreak complete
+   */
+  AdBreakComplete: "adBreakComplete",
+  /**
+   * Constant defining event type for Ad start
+   */
+  AdStart: "adStart",
+  /**
+   * Constant defining event type for Ad complete
+   */
+  AdComplete: "adComplete",
+  /**
+   * Constant defining event type for Ad skip
+   */
+  AdSkip: "adSkip",
+  /**
+   * Constant defining event type for Chapter start
+   */
+  ChapterStart: "chapterStart",
+  /**
+   * Constant defining event type for Chapter complete
+   */
+  ChapterComplete: "chapterComplete",
+  /**
+   * Constant defining event type for Chapter skip
+   */
+  ChapterSkip: "chapterSkip",
+  /**
+   * Constant defining event type for Seek start
+   */
+  SeekStart: "seekStart",
+  /**
+   * Constant defining event type for Seek complete
+   */
+  SeekComplete: "seekComplete",
+  /**
+   * Constant defining event type for Buffer start
+   */
+  BufferStart: "bufferStart",
+  /**
+   * Constant defining event type for Buffer complete
+   */
+  BufferComplete: "bufferComplete",
+  /**
+   * Constant defining event type for change in Bitrate
+   */
+  BitrateChange: "bitrateChange",
+  /**
+   * Constant defining event type for Custom State Start
+   */
+  StateStart: "stateStart",
+  /**
+   * Constant defining event type for Custom State End
+   */
+  StateEnd: "stateEnd"
+};
+exports.EVENT = EVENT;
+var MEDIA_EVENTS = _objectSpread({
+  SessionStart: "sessionStart",
+  SessionEnd: "sessionEnd",
+  SessionComplete: "sessionComplete",
+  Play: "play",
+  Pause: "pauseStart"
+}, EVENT);
+exports.MEDIA_EVENTS = MEDIA_EVENTS;
+var MEDIA_OBJECT_KEYS = {
+  MediaResumed: "media.resumed",
+  GranularAdTracking: "media.granularadtracking"
+};
+exports.MEDIA_OBJECT_KEYS = MEDIA_OBJECT_KEYS;
+var VIDEO_METADATA_KEYS = {
+  Show: "a.media.show",
+  Season: "a.media.season",
+  Episode: "a.media.episode",
+  AssetId: "a.media.asset",
+  Genre: "a.media.genre",
+  FirstAirDate: "a.media.airDate",
+  FirstDigitalDate: "a.media.digitalDate",
+  Rating: "a.media.rating",
+  Originator: "a.media.originator",
+  Network: "a.media.network",
+  ShowType: "a.media.type",
+  AdLoad: "a.media.adLoad",
+  MVPD: "a.media.pass.mvpd",
+  Authorized: "a.media.pass.auth",
+  DayPart: "a.media.dayPart",
+  Feed: "a.media.feed",
+  StreamFormat: "a.media.format"
+};
+exports.VIDEO_METADATA_KEYS = VIDEO_METADATA_KEYS;
+var AUDIO_METADATA_KEYS = {
+  Artist: "a.media.artist",
+  Album: "a.media.album",
+  Label: "a.media.label",
+  Author: "a.media.author",
+  Station: "a.media.station",
+  Publisher: "a.media.publisher"
+};
+exports.AUDIO_METADATA_KEYS = AUDIO_METADATA_KEYS;
+var 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.AD_METADATA_KEYS = AD_METADATA_KEYS;

package/libEs5/components/LegacyMediaAnalytics/media/mediaKeysToXdmConverter.js

@@ -0,0 +1,51 @@
+"use strict";
+
+exports.mediaToXdmKeys = exports.adsToXdmKeys = void 0;
+/*
+Copyright 2023 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 mediaToXdmKeys = {
+  "a.media.show": "show",
+  "a.media.season": "season",
+  "a.media.episode": "episode",
+  "a.media.asset": "assetID",
+  "a.media.genre": "genre",
+  "a.media.airDate": "firstAirDate",
+  "a.media.digitalDate": "firstDigitalDate",
+  "a.media.rating": "rating",
+  "a.media.originator": "originator",
+  "a.media.network": "network",
+  "a.media.type": "showType",
+  "a.media.adLoad": "adLoad",
+  "a.media.pass.mvpd": "mvpd",
+  "a.media.pass.auth": "authorized",
+  "a.media.dayPart": "dayPart",
+  "a.media.feed": "feed",
+  "a.media.format": "streamFormat",
+  "a.media.artist": "artist",
+  "a.media.album": "album",
+  "a.media.label": "label",
+  "a.media.author": "author",
+  "a.media.station": "station",
+  "a.media.publisher": "publisher",
+  "media.resumed": "hasResume"
+};
+exports.mediaToXdmKeys = mediaToXdmKeys;
+var 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/MediaCollection/constants/eventTypes.js

@@ -0,0 +1,25 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2023 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 = {
+  PAUSE: "media.pauseStart",
+  PLAY: "media.play",
+  BUFFERING: "media.buffering",
+  AD_START: "media.adStart",
+  SESSION_END: "media.sessionEnd",
+  SESSION_START: "media.sessionStart",
+  SESSION_COMPLETE: "media.sessionComplete",
+  PING: "media.ping"
+};
+exports.default = _default;

package/libEs5/components/MediaCollection/createHeartbeatEngine.js

@@ -0,0 +1,63 @@
+"use strict";
+
+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");
+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 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,
+    mediaSessionCacheManager = _ref.mediaSessionCacheManager;
+  return function (_ref2) {
+    var playerId = _ref2.playerId,
+      sessionId = _ref2.sessionId,
+      onBeforeMediaEvent = _ref2.onBeforeMediaEvent;
+    var mainPingInterval = config.mediaCollection.mainPingInterval;
+    var playerSession = mediaSessionCacheManager.getSession(playerId);
+    var currentInterval = getCurrentInterval(playerSession);
+    if (currentInterval > mainPingInterval) {
+      var _onBeforeMediaEvent = onBeforeMediaEvent(playerId),
+        playhead = _onBeforeMediaEvent.playhead,
+        qoeDataDetails = _onBeforeMediaEvent.qoeDataDetails;
+      var xdm = {
+        eventType: _eventTypes.default.PING,
+        mediaCollection: {
+          playhead: (0, _toInteger.default)(playhead),
+          sessionID: sessionId,
+          qoeDataDetails: qoeDataDetails
+        }
+      };
+      var event = mediaEventManager.createMediaEvent({
+        options: {
+          xdm: xdm
+        }
+      });
+      return mediaEventManager.trackMediaEvent({
+        event: event,
+        action: ACTION
+      }).then(function () {
+        mediaSessionCacheManager.updateLastTriggeredEventTS({
+          playerId: playerId
+        });
+      });
+    }
+    return Promise.resolve();
+  };
+};
+exports.default = _default;

package/libEs5/components/MediaCollection/createMediaEventManager.js

@@ -0,0 +1,109 @@
+"use strict";
+
+exports.default = void 0;
+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");
+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.
+*/
+/* eslint-disable import/no-restricted-paths */
+var _default = function _default(_ref) {
+  var config = _ref.config,
+    eventManager = _ref.eventManager,
+    consent = _ref.consent,
+    sendEdgeNetworkRequest = _ref.sendEdgeNetworkRequest;
+  return {
+    createMediaEvent: function createMediaEvent(_ref2) {
+      var options = _ref2.options;
+      var event = eventManager.createEvent();
+      var xdm = options.xdm;
+      var timestamp = (0, _injectTimestamp.default)(function () {
+        return new Date();
+      });
+      timestamp(xdm);
+      event.setUserXdm(xdm);
+      return event;
+    },
+    createMediaSession: function createMediaSession(options) {
+      var _config$mediaCollecti = config.mediaCollection,
+        playerName = _config$mediaCollecti.playerName,
+        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: _eventTypes.default.SESSION_START,
+        mediaCollection: {
+          sessionDetails: {
+            playerName: sessionDetails.playerName || playerName,
+            channel: sessionDetails.channel || channel,
+            appVersion: sessionDetails.appVersion || version
+          }
+        }
+      });
+      return event;
+    },
+    augmentMediaEvent: function augmentMediaEvent(_ref3) {
+      var event = _ref3.event,
+        playerId = _ref3.playerId,
+        onBeforeMediaEvent = _ref3.onBeforeMediaEvent,
+        sessionID = _ref3.sessionID;
+      if (!playerId || !onBeforeMediaEvent) {
+        return event;
+      }
+      var _onBeforeMediaEvent = onBeforeMediaEvent({
+          playerId: playerId
+        }),
+        playhead = _onBeforeMediaEvent.playhead,
+        qoeDataDetails = _onBeforeMediaEvent.qoeDataDetails;
+      event.mergeXdm({
+        mediaCollection: {
+          playhead: (0, _utils.toInteger)(playhead),
+          qoeDataDetails: qoeDataDetails,
+          sessionID: sessionID
+        }
+      });
+      return event;
+    },
+    trackMediaSession: function trackMediaSession(_ref4) {
+      var event = _ref4.event,
+        playerId = _ref4.playerId,
+        onBeforeMediaEvent = _ref4.onBeforeMediaEvent;
+      return eventManager.sendEvent(event, {
+        playerId: playerId,
+        onBeforeMediaEvent: onBeforeMediaEvent
+      });
+    },
+    trackMediaEvent: function trackMediaEvent(_ref5) {
+      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
+        }).then(function () {
+          return {};
+        });
+      });
+    }
+  };
+};
+exports.default = _default;

package/libEs5/components/MediaCollection/createMediaRequest.js

@@ -0,0 +1,30 @@
+"use strict";
+
+exports.default = void 0;
+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");
+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 = function _default(_ref) {
+  var mediaRequestPayload = _ref.mediaRequestPayload,
+    action = _ref.action;
+  return (0, _request.createRequest)({
+    payload: mediaRequestPayload,
+    edgeSubPath: "/va",
+    getAction: function getAction() {
+      return action;
+    },
+    getUseSendBeacon: function getUseSendBeacon() {
+      return false;
+    }
+  });
+};
+exports.default = _default;

package/libEs5/components/MediaCollection/createMediaSessionCacheManager.js

@@ -0,0 +1,62 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2023 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 = function _default() {
+  var mediaSessionCache;
+  var getSession = function getSession(playerId) {
+    return mediaSessionCache[playerId] || {};
+  };
+  var saveHeartbeat = function saveHeartbeat(_ref) {
+    var playerId = _ref.playerId,
+      heartbeatId = _ref.heartbeatId;
+    var sessionDetails = mediaSessionCache[playerId];
+    if (!sessionDetails) {
+      return;
+    }
+    sessionDetails.heartbeatId = heartbeatId;
+  };
+  var stopHeartbeat = function stopHeartbeat(_ref2) {
+    var playerId = _ref2.playerId;
+    var sessionDetails = mediaSessionCache[playerId];
+    if (!sessionDetails) {
+      return;
+    }
+    clearInterval(sessionDetails.heartbeatId);
+    sessionDetails.heartbeatId = null;
+  };
+  var updateLastTriggeredEventTS = function updateLastTriggeredEventTS(_ref3) {
+    var playerId = _ref3.playerId;
+    var sessionDetails = mediaSessionCache[playerId];
+    if (!sessionDetails) {
+      return;
+    }
+    sessionDetails.latestTriggeredEvent = Date.now();
+  };
+  var storeSession = function storeSession(_ref4) {
+    var playerId = _ref4.playerId,
+      sessionDetails = _ref4.sessionDetails;
+    if (mediaSessionCache === undefined) {
+      mediaSessionCache = {};
+    }
+    mediaSessionCache[playerId] = sessionDetails;
+  };
+  return {
+    getSession: getSession,
+    stopHeartbeat: stopHeartbeat,
+    updateLastTriggeredEventTS: updateLastTriggeredEventTS,
+    storeSession: storeSession,
+    saveHeartbeat: saveHeartbeat
+  };
+};
+exports.default = _default;

package/libEs5/components/MediaCollection/createUpdateMediaSessionState.js

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.default = void 0;
+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");
+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 = function _default(_ref) {
+  var mediaSessionCacheManager = _ref.mediaSessionCacheManager;
+  return function (_ref2) {
+    var playerId = _ref2.playerId,
+      eventType = _ref2.eventType;
+    if (eventType === _eventTypes.default.SESSION_COMPLETE || eventType === _eventTypes.default.SESSION_END) {
+      mediaSessionCacheManager.stopHeartbeat({
+        playerId: playerId
+      });
+    }
+    mediaSessionCacheManager.updateLastTriggeredEventTS({
+      playerId: playerId
+    });
+  };
+};
+exports.default = _default;