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

package/libEs5/components/LegacyMediaAnalytics/createMediaAnalyticsTracker.js

@@ -1,272 +0,0 @@
-"use strict";
-
-exports.createMediaAnalyticsTracker = void 0;
-var _defer = require("../../utils/defer");
-var _constants = require("./media/constants");
-var _utils = require("../../utils");
-var _mediaKeysToXdmConverter = require("./media/mediaKeysToXdmConverter");
-var _createMediaHelper = require("./createMediaHelper");
-/*
-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 convertSessionDetailsMetadataToXDM = function convertSessionDetailsMetadataToXDM(contextData) {
-  var customMetadata = [];
-  var sessionDetails = {};
-  Object.keys(contextData).forEach(function (key) {
-    if (_mediaKeysToXdmConverter.mediaToXdmKeys[key]) {
-      sessionDetails[_mediaKeysToXdmConverter.mediaToXdmKeys[key]] = contextData[key];
-    } else {
-      customMetadata.push({
-        name: key,
-        value: contextData[key]
-      });
-    }
-  });
-  return {
-    sessionDetails: sessionDetails,
-    customMetadata: customMetadata
-  };
-};
-var createMediaDetailsObject = function createMediaDetailsObject(_ref) {
-  var eventType = _ref.eventType,
-    info = _ref.info,
-    context = _ref.context;
-  var mediaDetails = info;
-  var customMetadata = [];
-  if (context && !(0, _utils.isEmptyObject)(context)) {
-    if (eventType === _constants.mediaEvent.AdStart) {
-      Object.keys(context).forEach(function (key) {
-        if (_mediaKeysToXdmConverter.adsToXdmKeys[key]) {
-          mediaDetails.advertisingDetails[_mediaKeysToXdmConverter.mediaToXdmKeys[key]] = context[key];
-        } else {
-          customMetadata.push({
-            name: key,
-            value: context[key]
-          });
-        }
-      });
-    } else {
-      Object.keys(context).forEach(function (key) {
-        customMetadata.push({
-          name: key,
-          value: context[key]
-        });
-      });
-    }
-    mediaDetails.customMetadata = customMetadata;
-  }
-  return mediaDetails;
-};
-var createHeartbeat = function createHeartbeat(_ref2) {
-  var mainPingInterval = _ref2.mainPingInterval,
-    playerState = _ref2.playerState,
-    trackEvent = _ref2.trackEvent;
-  // eslint-disable-next-line consistent-return
-  return function () {
-    var currentTime = Date.now();
-    if (Math.abs(currentTime - playerState.latestTriggeredEvent) / 1000 > mainPingInterval) {
-      return trackEvent({
-        eventType: "ping"
-      });
-    }
-  };
-};
-var createGetInstance = function createGetInstance(_ref3) {
-  var config = _ref3.config,
-    logger = _ref3.logger,
-    mediaEventManager = _ref3.mediaEventManager;
-  var mainPingInterval = config.mediaCollection.mainPingInterval;
-  var trackerState = {
-    qoe: null,
-    lastPlayhead: 0,
-    latestTriggeredEvent: null
-  };
-  var ticker;
-  var deferSession = (0, _defer.default)();
-  var updateLastTimeEventTriggered = function updateLastTimeEventTriggered() {
-    trackerState.latestTriggeredEvent = Date.now();
-  };
-  var getEventType = function getEventType(_ref4) {
-    var eventType = _ref4.eventType;
-    if (eventType === _constants.mediaEvent.BufferComplete) {
-      return "media." + _constants.mediaEvent.Play;
-    }
-    return "media." + eventType;
-  };
-  var _trackEvent = function trackEvent(_ref5) {
-    var eventType = _ref5.eventType,
-      mediaDetails = _ref5.mediaDetails;
-    return deferSession.promise.then(function (sessionID) {
-      var xdm = {
-        eventType: getEventType({
-          eventType: eventType
-        }),
-        mediaCollection: {
-          sessionID: sessionID,
-          playhead: trackerState.lastPlayhead
-        }
-      };
-      (0, _utils.deepAssign)(xdm.mediaCollection, mediaDetails);
-      var event = mediaEventManager.createMediaEvent({
-        options: {
-          xdm: xdm
-        }
-      });
-      return mediaEventManager.trackMediaEvent({
-        event: event
-      }).then(function () {
-        updateLastTimeEventTriggered();
-      });
-    }).catch(function (error) {
-      logger.info(error);
-    });
-  };
-  var heartbeatEngine = createHeartbeat({
-    mainPingInterval: mainPingInterval,
-    deferSession: deferSession,
-    playerState: trackerState,
-    trackEvent: _trackEvent
-  });
-  return {
-    trackSessionStart: function trackSessionStart(mediaObject) {
-      var contextData = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-      if ((0, _utils.isEmptyObject)(mediaObject)) {
-        deferSession.reject("invalid media object");
-        return {};
-      }
-      var mediaCollection = {
-        playhead: 0
-      };
-      var _convertSessionDetail = convertSessionDetailsMetadataToXDM(contextData),
-        sessionDetails = _convertSessionDetail.sessionDetails,
-        customMetadata = _convertSessionDetail.customMetadata;
-      (0, _utils.deepAssign)(mediaCollection, mediaObject, {
-        sessionDetails: sessionDetails
-      }, {
-        customMetadata: customMetadata
-      });
-      var event = mediaEventManager.createMediaSession({
-        xdm: {
-          mediaCollection: mediaCollection
-        }
-      });
-      return mediaEventManager.trackMediaSession({
-        event: event
-      }).then(function (result) {
-        updateLastTimeEventTriggered();
-        deferSession.resolve(result.sessionId);
-        ticker = setInterval(function () {
-          heartbeatEngine();
-        }, 1000);
-      });
-    },
-    trackPlay: function trackPlay() {
-      return _trackEvent({
-        eventType: _constants.mediaEvent.Play
-      });
-    },
-    trackPause: function trackPause() {
-      return _trackEvent({
-        eventType: _constants.mediaEvent.Pause
-      });
-    },
-    trackSessionEnd: function trackSessionEnd() {
-      clearInterval(ticker);
-      return _trackEvent({
-        eventType: _constants.mediaEvent.SessionEnd
-      }).then(function () {
-        deferSession = null;
-      });
-    },
-    trackComplete: function trackComplete() {
-      clearInterval(ticker);
-      return _trackEvent({
-        eventType: _constants.mediaEvent.SessionComplete
-      });
-    },
-    trackError: function trackError(errorId) {
-      logger.info("trackError(" + errorId + ")");
-      var errorDetails = {
-        name: errorId,
-        source: "player"
-      };
-      var mediaDetails = {
-        errorDetails: errorDetails
-      };
-      return _trackEvent({
-        eventType: _constants.mediaEvent.SessionEnd,
-        mediaDetails: mediaDetails
-      });
-    },
-    trackEvent: function trackEvent(eventType, info, context) {
-      if ((0, _utils.isEmptyObject)(info)) {
-        logger.info("invalid media object");
-        return {};
-      }
-      var mediaDetails = createMediaDetailsObject({
-        eventType: eventType,
-        info: info,
-        context: context
-      });
-      return _trackEvent({
-        eventType: eventType,
-        mediaDetails: mediaDetails
-      });
-    },
-    updatePlayhead: function updatePlayhead(time) {
-      if ((0, _utils.isNumber)(time)) {
-        trackerState.lastPlayhead = parseInt(time, 10);
-      }
-    },
-    updateQoEObject: function updateQoEObject(qoeObject) {
-      if (!qoeObject) {
-        return;
-      }
-      trackerState.qoe = qoeObject;
-    },
-    destroy: function destroy() {
-      logger.info("Destroy called, destroying the tracker");
-      clearInterval(ticker);
-      deferSession = null;
-    }
-  };
-};
-var createMediaAnalyticsTracker = function createMediaAnalyticsTracker(_ref6) {
-  var config = _ref6.config,
-    logger = _ref6.logger,
-    mediaEventManager = _ref6.mediaEventManager;
-  logger.info("Media Analytics Component was configured");
-  return {
-    getInstance: function getInstance() {
-      return createGetInstance({
-        config: config,
-        logger: logger,
-        mediaEventManager: mediaEventManager
-      });
-    },
-    Event: _constants.mediaEvent,
-    MediaType: _constants.MediaType,
-    PlayerState: _constants.PlayerState,
-    StreamType: _constants.StreamType,
-    MediaObjectKey: _constants.MediaObjectKey,
-    VideoMetadataKeys: _constants.VideoMetadataKeys,
-    AudioMetadataKeys: _constants.AudioMetadataKeys,
-    AdMetadataKeys: _constants.AdMetadataKeys,
-    createMediaObject: _createMediaHelper.createMediaObject,
-    createAdBreakObject: _createMediaHelper.createAdBreakObject,
-    createAdObject: _createMediaHelper.createAdObject,
-    createChapterObject: _createMediaHelper.createChapterObject,
-    createStateObject: _createMediaHelper.createStateObject,
-    createQoEObject: _createMediaHelper.createQoEObject
-  };
-};
-exports.createMediaAnalyticsTracker = createMediaAnalyticsTracker;

package/libEs5/components/MediaCollection/createHeartbeatEngine.js

@@ -1,55 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _toInteger = require("../../utils/toInteger");
-/*
-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 config = _ref.config,
-    mediaEventManager = _ref.mediaEventManager,
-    mediaSessionCacheManager = _ref.mediaSessionCacheManager;
-  return function (_ref2) {
-    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 _onBeforeMediaEvent = onBeforeMediaEvent(playerId),
-        playhead = _onBeforeMediaEvent.playhead,
-        qoeDataDetails = _onBeforeMediaEvent.qoeDataDetails;
-      var xdm = {
-        eventType: "media.ping",
-        mediaCollection: {
-          playhead: (0, _toInteger.default)(playhead),
-          sessionID: sessionId,
-          qoeDataDetails: qoeDataDetails
-        }
-      };
-      var event = mediaEventManager.createMediaEvent({
-        options: {
-          xdm: xdm
-        }
-      });
-      return mediaEventManager.trackMediaEvent({
-        event: event
-      }).then(function () {
-        mediaSessionCacheManager.updateLastTriggeredEventTS({
-          playerId: playerId
-        });
-      });
-    }
-    return Promise.resolve();
-  };
-};
-exports.default = _default;

package/libEs5/components/MediaCollection/createUpdateMediaSessionState.js

@@ -1,35 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _mediaEvents = require("./mediaConstants/mediaEvents");
-/*
-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,
-      xdm = _ref2.xdm;
-    if (!playerId) {
-      return;
-    }
-    var eventType = xdm.eventType;
-    if (eventType === _mediaEvents.default.SESSION_COMPLETE || eventType === _mediaEvents.default.SESSION_END) {
-      mediaSessionCacheManager.stopHeartbeat({
-        playerId: playerId
-      });
-    }
-    mediaSessionCacheManager.updateLastTriggeredEventTS({
-      playerId: playerId
-    });
-  };
-};
-exports.default = _default;

package/libEs5/components/MediaCollection/index.js

@@ -1,159 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _validation = require("../../utils/validation");
-var _createMediaSessionCacheManager = require("./createMediaSessionCacheManager");
-var _validateMediaEventOptions = require("./validateMediaEventOptions");
-var _validateMediaSessionOptions = require("./validateMediaSessionOptions");
-var _createMediaEventManager = require("./createMediaEventManager");
-var _utils = require("../../utils");
-var _createHeartbeatEngine = require("./createHeartbeatEngine");
-var _createUpdateMediaSessionState = require("./createUpdateMediaSessionState");
-/*
-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 createMediaCollection = function createMediaCollection(_ref) {
-  var config = _ref.config,
-    logger = _ref.logger,
-    eventManager = _ref.eventManager,
-    sendEdgeNetworkRequest = _ref.sendEdgeNetworkRequest,
-    consent = _ref.consent;
-  var mediaSessionCacheManager = (0, _createMediaSessionCacheManager.default)({
-    config: config
-  });
-  var mediaEventManager = (0, _createMediaEventManager.default)({
-    config: config,
-    eventManager: eventManager,
-    logger: logger,
-    consent: consent,
-    sendEdgeNetworkRequest: sendEdgeNetworkRequest
-  });
-  var heartbeatTicker = (0, _createHeartbeatEngine.default)({
-    config: config,
-    mediaEventManager: mediaEventManager,
-    mediaSessionCacheManager: mediaSessionCacheManager
-  });
-  var updateMediaSessionState = (0, _createUpdateMediaSessionState.default)({
-    mediaSessionCacheManager: mediaSessionCacheManager
-  });
-  return {
-    lifecycle: {
-      onBeforeEvent: function onBeforeEvent(_ref2) {
-        var playerId = _ref2.playerId,
-          onBeforeMediaEvent = _ref2.onBeforeMediaEvent,
-          _ref2$onResponse = _ref2.onResponse,
-          onResponse = _ref2$onResponse === void 0 ? _utils.noop : _ref2$onResponse;
-        onResponse(function (_ref3) {
-          var response = _ref3.response;
-          var sessionId = response.getPayloadsByType("media-analytics:new-session");
-          logger.info("Media session ID returned: ", sessionId);
-          if (sessionId.length > 0) {
-            if (playerId && onBeforeMediaEvent) {
-              var heartbeatId = setInterval(function () {
-                heartbeatTicker({
-                  sessionId: sessionId[0].sessionId,
-                  playerId: playerId,
-                  onBeforeMediaEvent: onBeforeMediaEvent
-                });
-              }, 1000);
-              mediaSessionCacheManager.saveHeartbeat({
-                playerId: playerId,
-                heartbeatId: heartbeatId
-              });
-            }
-            return {
-              sessionId: sessionId[0].sessionId
-            };
-          }
-          return {};
-        });
-      }
-    },
-    commands: {
-      createMediaSession: {
-        optionsValidator: function optionsValidator(options) {
-          return (0, _validateMediaSessionOptions.default)({
-            options: options
-          });
-        },
-        run: function run(options) {
-          var playerId = options.playerId,
-            onBeforeMediaEvent = options.onBeforeMediaEvent;
-          var event = mediaEventManager.createMediaSession(options);
-          mediaEventManager.augmentMediaEvent({
-            event: event,
-            playerId: playerId,
-            onBeforeMediaEvent: onBeforeMediaEvent
-          });
-          var sessionPromise = mediaEventManager.trackMediaSession({
-            event: event,
-            playerId: playerId,
-            onBeforeMediaEvent: onBeforeMediaEvent
-          });
-          mediaSessionCacheManager.storeSession({
-            playerId: playerId,
-            sessionDetails: {
-              sessionPromise: sessionPromise,
-              onBeforeMediaEvent: onBeforeMediaEvent,
-              latestTriggeredEvent: Date.now()
-            }
-          });
-          return sessionPromise;
-        }
-      },
-      sendMediaEvent: {
-        optionsValidator: function optionsValidator(options) {
-          return (0, _validateMediaEventOptions.default)({
-            options: options
-          });
-        },
-        run: function run(options) {
-          var event = mediaEventManager.createMediaEvent({
-            options: options
-          });
-          var playerId = options.playerId;
-          var _mediaSessionCacheMan = mediaSessionCacheManager.getSession(playerId),
-            onBeforeMediaEvent = _mediaSessionCacheMan.onBeforeMediaEvent,
-            sessionPromise = _mediaSessionCacheMan.sessionPromise;
-          sessionPromise.then(function (result) {
-            var finalEvent = mediaEventManager.augmentMediaEvent({
-              event: event,
-              playerId: playerId,
-              onBeforeMediaEvent: onBeforeMediaEvent,
-              sessionID: result.sessionId
-            });
-            return mediaEventManager.trackMediaEvent({
-              event: finalEvent
-            }).then(function () {
-              updateMediaSessionState({
-                playerId: playerId,
-                xdm: finalEvent.xdm
-              });
-            });
-          });
-        }
-      }
-    }
-  };
-};
-createMediaCollection.namespace = "Media Collection";
-createMediaCollection.configValidators = (0, _validation.objectOf)({
-  mediaCollection: (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)
-  }).noUnknownFields()
-});
-var _default = createMediaCollection;
-exports.default = _default;

package/libEs5/components/MediaCollection/mediaConstants/mediaEvents.js

@@ -1,13 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-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"
-};
-exports.default = _default;

package/libEs5/components/MediaCollection/validateMediaEventOptions.js

@@ -1,35 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _validation = require("../../utils/validation");
-/*
-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 options = _ref.options;
-  var validator = (0, _validation.anyOf)([(0, _validation.objectOf)({
-    playerId: (0, _validation.string)().required(),
-    xdm: (0, _validation.objectOf)({
-      eventType: (0, _validation.string)().required(),
-      mediaCollection: (0, _validation.objectOf)((0, _validation.anything)())
-    }).required()
-  }).required(), (0, _validation.objectOf)({
-    xdm: (0, _validation.objectOf)({
-      eventType: (0, _validation.string)().required(),
-      mediaCollection: (0, _validation.objectOf)({
-        playhead: (0, _validation.number)().integer().required(),
-        sessionID: (0, _validation.string)().required()
-      }).required()
-    }).required()
-  }).required()], "Error validating the sendMediaEvent command options.");
-  return validator(options);
-};
-exports.default = _default;