@adobe/alloy 2.20.0-beta.2 → 2.20.0-beta.6

package/libEs6/components/LegacyMediaAnalytics/constants/constants.js

@@ -0,0 +1,141 @@
+/*
+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.
+*/
+
+export const MEDIA_TYPE = {
+  Video: "video",
+  Audio: "audio"
+};
+export const STREAM_TYPE = {
+  VOD: "vod",
+  Live: "live",
+  Linear: "linear",
+  Podcast: "podcast",
+  Audiobook: "audiobook",
+  AOD: "aod"
+};
+export const PLAYER_STATE = {
+  FullScreen: "fullScreen",
+  ClosedCaption: "closedCaptioning",
+  Mute: "mute",
+  PictureInPicture: "pictureInPicture",
+  InFocus: "inFocus"
+};
+export const 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"
+};
+export const MEDIA_EVENTS_INTERNAL = {
+  SessionStart: "sessionStart",
+  SessionEnd: "sessionEnd",
+  SessionComplete: "sessionComplete",
+  Play: "play",
+  Pause: "pauseStart",
+  Error: "error",
+  StateUpdate: "statesUpdate"
+};
+export const MEDIA_OBJECT_KEYS = {
+  MediaResumed: "media.resumed",
+  GranularAdTracking: "media.granularadtracking"
+};
+export const 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"
+};
+export const 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"
+};
+export const 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"
+};

package/libEs6/components/LegacyMediaAnalytics/constants/mediaKeysToXdmConverter.js

@@ -0,0 +1,46 @@
+/*
+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.
+*/
+
+export const 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"
+};
+export const 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"
+};

package/libEs6/components/LegacyMediaAnalytics/createGetInstance.js

@@ -0,0 +1,239 @@
+/*
+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.
+*/
+import { EVENT, MEDIA_EVENTS_INTERNAL } from "./constants/constants.js";
+import { includes, isEmptyObject, isNil, isNonEmptyArray, isNumber } from "../../utils/index.js";
+import { adsToXdmKeys, mediaToXdmKeys } from "./constants/mediaKeysToXdmConverter.js";
+export default (({
+  logger,
+  trackMediaSession,
+  trackMediaEvent,
+  uuid
+}) => {
+  let trackerState = null;
+  const instantiateTracker = () => {
+    trackerState = {
+      qoe: null,
+      lastPlayhead: 0,
+      playerId: uuid()
+    };
+  };
+  const getEventType = ({
+    eventType
+  }) => {
+    if (eventType === EVENT.BufferComplete || eventType === EVENT.SeekComplete) {
+      return MEDIA_EVENTS_INTERNAL.Play;
+    }
+    if (eventType === EVENT.StateStart || eventType === EVENT.StateEnd) {
+      return MEDIA_EVENTS_INTERNAL.StateUpdate;
+    }
+    if (eventType === EVENT.SeekStart) {
+      return MEDIA_EVENTS_INTERNAL.Pause;
+    }
+    return eventType;
+  };
+  const createXdmObject = ({
+    eventType,
+    mediaDetails = {},
+    contextData = []
+  }) => {
+    const action = getEventType({
+      eventType
+    });
+    if (eventType === EVENT.StateStart) {
+      const xdm = {
+        eventType: `media.${action}`,
+        mediaCollection: {
+          statesStart: [mediaDetails]
+        }
+      };
+      return xdm;
+    }
+    if (eventType === EVENT.StateEnd) {
+      const xdm = {
+        eventType: `media.${action}`,
+        mediaCollection: {
+          statesEnd: [mediaDetails]
+        }
+      };
+      return xdm;
+    }
+    const xdm = {
+      eventType: `media.${action}`,
+      mediaCollection: {
+        ...mediaDetails
+      }
+    };
+    const customMetadata = [];
+    Object.keys(contextData).forEach(key => {
+      if (mediaToXdmKeys[key]) {
+        xdm.mediaCollection.sessionDetails[mediaToXdmKeys[key]] = contextData[key];
+      } else if (adsToXdmKeys[key]) {
+        xdm.mediaCollection.advertisingDetails[adsToXdmKeys[key]] = contextData[key];
+      } else {
+        customMetadata.push({
+          name: key,
+          value: contextData[key]
+        });
+      }
+    });
+    if (isNonEmptyArray(customMetadata)) {
+      xdm.mediaCollection.customMetadata = customMetadata;
+    }
+    return xdm;
+  };
+  return {
+    trackSessionStart: (mediaObject, contextData = {}) => {
+      if (isNil(mediaObject) || isEmptyObject(mediaObject)) {
+        logger.warn("Invalid media object");
+        return {};
+      }
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed. Restarting a new session.");
+        instantiateTracker();
+      }
+      const xdm = createXdmObject({
+        eventType: MEDIA_EVENTS_INTERNAL.SessionStart,
+        mediaDetails: mediaObject,
+        contextData
+      });
+      return trackMediaSession({
+        playerId: trackerState.playerId,
+        getPlayerDetails: () => {
+          return {
+            playhead: trackerState.lastPlayhead,
+            qoeDataDetails: trackerState.qoe
+          };
+        },
+        xdm
+      });
+    },
+    trackPlay: () => {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      const xdm = createXdmObject({
+        eventType: MEDIA_EVENTS_INTERNAL.Play
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm
+      });
+    },
+    trackPause: () => {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      const xdm = createXdmObject({
+        eventType: MEDIA_EVENTS_INTERNAL.Pause
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm
+      });
+    },
+    trackSessionEnd: () => {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      const xdm = createXdmObject({
+        eventType: MEDIA_EVENTS_INTERNAL.SessionEnd
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm
+      });
+    },
+    trackComplete: () => {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      const xdm = createXdmObject({
+        eventType: MEDIA_EVENTS_INTERNAL.SessionComplete
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm
+      });
+    },
+    trackError: errorId => {
+      logger.warn(`trackError(${errorId})`);
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      const errorDetails = {
+        name: errorId,
+        source: "player"
+      };
+      const xdm = createXdmObject({
+        eventType: MEDIA_EVENTS_INTERNAL.Error,
+        mediaDetails: {
+          errorDetails
+        }
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm
+      });
+    },
+    trackEvent: (eventType, info, context) => {
+      if (isEmptyObject(info)) {
+        logger.warn("Invalid media object.");
+        return {};
+      }
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return {};
+      }
+      if (!includes(Object.values(EVENT), eventType)) {
+        logger.warn("Invalid event type");
+        return {};
+      }
+      const xdm = createXdmObject({
+        eventType,
+        mediaDetails: info,
+        contextData: context
+      });
+      return trackMediaEvent({
+        playerId: trackerState.playerId,
+        xdm
+      });
+    },
+    updatePlayhead: time => {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return;
+      }
+      if (isNumber(time)) {
+        trackerState.lastPlayhead = parseInt(time, 10);
+      }
+    },
+    updateQoEObject: qoeObject => {
+      if (trackerState === null) {
+        logger.warn("The Media Session was completed.");
+        return;
+      }
+      if (!qoeObject) {
+        return;
+      }
+      trackerState.qoe = qoeObject;
+    },
+    destroy: () => {
+      logger.warn("Destroy called, destroying the tracker.");
+      trackerState = null;
+    }
+  };
+});

package/libEs6/components/LegacyMediaAnalytics/createLegacyMediaComponent.js

@@ -0,0 +1,85 @@
+/*
+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.
+*/
+
+import { noop, uuid } from "../../utils/index.js";
+import { AD_METADATA_KEYS as AdMetadataKeys, AUDIO_METADATA_KEYS as AudioMetadataKeys, EVENT as Event, MEDIA_OBJECT_KEYS as MediaObjectKey, MEDIA_TYPE as MediaType, PLAYER_STATE as PlayerState, STREAM_TYPE as StreamType, VIDEO_METADATA_KEYS as VideoMetadataKeys } from "./constants/constants.js";
+export default (({
+  trackMediaEvent,
+  trackMediaSession,
+  mediaResponseHandler,
+  logger,
+  createMediaHelper,
+  createGetInstance,
+  config
+}) => {
+  return {
+    lifecycle: {
+      onBeforeEvent({
+        mediaOptions,
+        onResponse = noop
+      }) {
+        if (!mediaOptions) {
+          return;
+        }
+        const {
+          legacy,
+          playerId,
+          getPlayerDetails
+        } = mediaOptions;
+        if (!legacy) {
+          return;
+        }
+        onResponse(({
+          response
+        }) => {
+          return mediaResponseHandler({
+            playerId,
+            getPlayerDetails,
+            response
+          });
+        });
+      }
+    },
+    commands: {
+      getMediaAnalyticsTracker: {
+        run: () => {
+          if (!config.streamingMedia) {
+            return Promise.reject(new Error("Streaming media is not configured."));
+          }
+          logger.info("Streaming media is configured in legacy mode.");
+          const mediaAnalyticsHelper = createMediaHelper({
+            logger
+          });
+          return Promise.resolve({
+            getInstance: () => {
+              return createGetInstance({
+                logger,
+                trackMediaEvent,
+                trackMediaSession,
+                uuid
+              });
+            },
+            Event,
+            MediaType,
+            PlayerState,
+            StreamType,
+            MediaObjectKey,
+            VideoMetadataKeys,
+            AudioMetadataKeys,
+            AdMetadataKeys,
+            ...mediaAnalyticsHelper
+          });
+        }
+      }
+    }
+  };
+});

package/libEs6/components/LegacyMediaAnalytics/createMediaHelper.js

@@ -0,0 +1,180 @@
+/*
+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.
+*/
+
+import { number, objectOf, string } from "../../utils/validation/index.js";
+export default (({
+  logger
+}) => {
+  const createMediaObject = (friendlyName, name, length, contentType, streamType) => {
+    const mediaObject = {
+      friendlyName,
+      name,
+      length,
+      streamType,
+      contentType
+    };
+    const validate = objectOf({
+      friendlyName: string().nonEmpty(),
+      name: string().nonEmpty(),
+      length: number().required(),
+      streamType: string().nonEmpty(),
+      contentType: string().nonEmpty()
+    });
+    try {
+      const result = validate(mediaObject);
+      const sessionDetails = {
+        name: result.name,
+        friendlyName: result.friendlyName,
+        length: result.length,
+        streamType: result.streamType,
+        contentType: result.contentType
+      };
+      return {
+        sessionDetails
+      };
+    } catch (error) {
+      logger.warn(`An error occurred while creating the Media Object.`, error);
+      return {};
+    }
+  };
+  const createAdBreakObject = (name, position, startTime) => {
+    const adBreakObject = {
+      friendlyName: name,
+      offset: position,
+      index: startTime
+    };
+    const validator = objectOf({
+      friendlyName: string().nonEmpty(),
+      offset: number(),
+      index: number()
+    });
+    try {
+      const result = validator(adBreakObject);
+      const advertisingPodDetails = {
+        friendlyName: result.friendlyName,
+        offset: result.offset,
+        index: result.index
+      };
+      return {
+        advertisingPodDetails
+      };
+    } catch (error) {
+      logger.warn(`An error occurred while creating the Ad Break Object.`, error);
+      return {};
+    }
+  };
+  const createAdObject = (name, id, position, length) => {
+    const adObject = {
+      friendlyName: name,
+      name: id,
+      podPosition: position,
+      length
+    };
+    const validator = objectOf({
+      friendlyName: string().nonEmpty(),
+      name: string().nonEmpty(),
+      podPosition: number(),
+      length: number()
+    });
+    try {
+      const result = validator(adObject);
+      const advertisingDetails = {
+        friendlyName: result.friendlyName,
+        name: result.name,
+        podPosition: result.podPosition,
+        length: result.length
+      };
+      return {
+        advertisingDetails
+      };
+    } catch (error) {
+      logger.warn(`An error occurred while creating the Advertising Object.`, error);
+      return {};
+    }
+  };
+  const createChapterObject = (name, position, length, startTime) => {
+    const chapterDetailsObject = {
+      friendlyName: name,
+      offset: position,
+      length,
+      index: startTime
+    };
+    const validator = objectOf({
+      friendlyName: string().nonEmpty(),
+      offset: number(),
+      length: number(),
+      index: number()
+    });
+    try {
+      const result = validator(chapterDetailsObject);
+      const chapterDetails = {
+        friendlyName: result.friendlyName,
+        offset: result.offset,
+        index: result.index,
+        length: result.length
+      };
+      return {
+        chapterDetails
+      };
+    } catch (error) {
+      logger.warn(`An error occurred while creating the Chapter Object.`, error);
+      return {};
+    }
+  };
+  const createStateObject = stateName => {
+    const STATE_NAME_REGEX = /^[a-zA-Z0-9_]{1,64}$/;
+    const validator = string().matches(STATE_NAME_REGEX, "This is not a valid state name.");
+    try {
+      const result = validator(stateName);
+      return {
+        name: result
+      };
+    } catch (error) {
+      logger.warn(`An error occurred while creating the State Object.`, error);
+      return {};
+    }
+  };
+  const createQoEObject = (bitrate, droppedFrames, fps, startupTime) => {
+    const qoeObject = {
+      bitrate,
+      droppedFrames,
+      fps,
+      startupTime
+    };
+    const validator = objectOf({
+      bitrate: number(),
+      droppedFrames: number(),
+      fps: number(),
+      startupTime: number()
+    });
+    try {
+      const result = validator(qoeObject);
+      return {
+        bitrate: result.bitrate,
+        droppedFrames: result.droppedFrames,
+        framesPerSecond: result.fps,
+        timeToStart: result.startupTime
+      };
+    } catch (error) {
+      logger.warn(`An error occurred while creating the QOE Object.`, error);
+      return {};
+    }
+  };
+  return {
+    createMediaObject,
+    createAdBreakObject,
+    createAdObject,
+    createChapterObject,
+    createStateObject,
+    createQoEObject
+  };
+});