@adobe/alloy 2.20.0-alpha.1 → 2.20.0-beta.2

package/libEs6/components/LibraryInfo/index.js

@@ -1,57 +0,0 @@
-/*
-Copyright 2019 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 libraryVersion from "../../constants/libraryVersion";
-import { CONFIGURE, SET_DEBUG } from "../../constants/coreCommands";
-const prepareLibraryInfo = ({
-  config,
-  componentRegistry
-}) => {
-  const allCommands = [...componentRegistry.getCommandNames(), CONFIGURE, SET_DEBUG].sort();
-  const resultConfig = {
-    ...config
-  };
-  Object.keys(config).forEach(key => {
-    const value = config[key];
-    if (typeof value !== "function") {
-      return;
-    }
-    resultConfig[key] = value.toString();
-  });
-  return {
-    version: libraryVersion,
-    configs: resultConfig,
-    commands: allCommands
-  };
-};
-const createLibraryInfo = ({
-  config,
-  componentRegistry
-}) => {
-  const libraryInfo = prepareLibraryInfo({
-    config,
-    componentRegistry
-  });
-  return {
-    commands: {
-      getLibraryInfo: {
-        run: () => {
-          return {
-            libraryInfo
-          };
-        }
-      }
-    }
-  };
-};
-createLibraryInfo.namespace = "LibraryInfo";
-export default createLibraryInfo;

package/libEs6/components/MachineLearning/index.js

@@ -1,23 +0,0 @@
-/*
-Copyright 2021 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 processResponse from "./processResponse";
-const createMachineLearning = () => {
-  return {
-    lifecycle: {
-      onResponse: processResponse
-    },
-    commands: {}
-  };
-};
-createMachineLearning.namespace = "MachineLearning";
-export default createMachineLearning;

package/libEs6/components/MachineLearning/processResponse.js

@@ -1,18 +0,0 @@
-/*
-Copyright 2021 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 default (({
-  response
-}) => {
-  return {
-    inferences: response.getPayloadsByType("rtml:inferences")
-  };
-});

package/libEs6/components/MediaCollection/constants/eventTypes.js

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

package/libEs6/components/MediaCollection/createHeartbeatEngine.js

@@ -1,64 +0,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.
-*/
-
-import toInteger from "../../utils/toInteger";
-import MediaEvent from "./constants/eventTypes";
-const ACTION = "ping";
-const getCurrentInterval = playerSession => {
-  const currentTime = Date.now();
-  return Math.abs(currentTime - playerSession.latestTriggeredEvent) / 1000;
-};
-export default (({
-  config,
-  mediaEventManager,
-  mediaSessionCacheManager
-}) => {
-  return ({
-    playerId,
-    sessionId,
-    onBeforeMediaEvent
-  }) => {
-    const {
-      mainPingInterval
-    } = config.mediaCollection;
-    const playerSession = mediaSessionCacheManager.getSession(playerId);
-    const currentInterval = getCurrentInterval(playerSession);
-    if (currentInterval > mainPingInterval) {
-      const {
-        playhead,
-        qoeDataDetails
-      } = onBeforeMediaEvent(playerId);
-      const xdm = {
-        eventType: MediaEvent.PING,
-        mediaCollection: {
-          playhead: toInteger(playhead),
-          sessionID: sessionId,
-          qoeDataDetails
-        }
-      };
-      const event = mediaEventManager.createMediaEvent({
-        options: {
-          xdm
-        }
-      });
-      return mediaEventManager.trackMediaEvent({
-        event,
-        action: ACTION
-      }).then(() => {
-        mediaSessionCacheManager.updateLastTriggeredEventTS({
-          playerId
-        });
-      });
-    }
-    return Promise.resolve();
-  };
-});

package/libEs6/components/MediaCollection/createMediaEventManager.js

@@ -1,115 +0,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.
-*/
-/* eslint-disable import/no-restricted-paths */
-
-import MediaEvents from "./constants/eventTypes";
-import createMediaRequest from "./createMediaRequest";
-import injectTimestamp from "../Context/injectTimestamp";
-import { toInteger } from "../../utils";
-import { createDataCollectionRequestPayload } from "../../utils/request";
-export default (({
-  config,
-  eventManager,
-  consent,
-  sendEdgeNetworkRequest
-}) => {
-  return {
-    createMediaEvent({
-      options
-    }) {
-      const event = eventManager.createEvent();
-      const {
-        xdm
-      } = options;
-      const timestamp = injectTimestamp(() => new Date());
-      timestamp(xdm);
-      event.setUserXdm(xdm);
-      return event;
-    },
-    createMediaSession(options) {
-      const {
-        playerName,
-        channel,
-        version
-      } = config.mediaCollection;
-      const event = eventManager.createEvent();
-      const {
-        sessionDetails
-      } = options.xdm.mediaCollection;
-      event.setUserXdm(options.xdm);
-      event.mergeXdm({
-        eventType: MediaEvents.SESSION_START,
-        mediaCollection: {
-          sessionDetails: {
-            playerName: sessionDetails.playerName || playerName,
-            channel: sessionDetails.channel || channel,
-            appVersion: sessionDetails.appVersion || version
-          }
-        }
-      });
-      return event;
-    },
-    augmentMediaEvent({
-      event,
-      playerId,
-      onBeforeMediaEvent,
-      sessionID
-    }) {
-      if (!playerId || !onBeforeMediaEvent) {
-        return event;
-      }
-      const {
-        playhead,
-        qoeDataDetails
-      } = onBeforeMediaEvent({
-        playerId
-      });
-      event.mergeXdm({
-        mediaCollection: {
-          playhead: toInteger(playhead),
-          qoeDataDetails,
-          sessionID
-        }
-      });
-      return event;
-    },
-    trackMediaSession({
-      event,
-      playerId,
-      onBeforeMediaEvent
-    }) {
-      return eventManager.sendEvent(event, {
-        playerId,
-        onBeforeMediaEvent
-      });
-    },
-    trackMediaEvent({
-      event,
-      action
-    }) {
-      const mediaRequestPayload = createDataCollectionRequestPayload();
-      const request = createMediaRequest({
-        mediaRequestPayload,
-        action
-      });
-      mediaRequestPayload.addEvent(event);
-      event.finalize();
-      return consent.awaitConsent().then(() => {
-        return sendEdgeNetworkRequest({
-          request
-        }).then(() => {
-          return {};
-        });
-      });
-    }
-  };
-});

package/libEs6/components/MediaCollection/createMediaRequest.js

@@ -1,28 +0,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.
-*/
-
-import { createRequest } from "../../utils/request";
-export default (({
-  mediaRequestPayload,
-  action
-}) => {
-  return createRequest({
-    payload: mediaRequestPayload,
-    edgeSubPath: "/va",
-    getAction() {
-      return action;
-    },
-    getUseSendBeacon() {
-      return false;
-    }
-  });
-});

package/libEs6/components/MediaCollection/createMediaSessionCacheManager.js

@@ -1,63 +0,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.
-*/
-
-export default (() => {
-  let mediaSessionCache;
-  const getSession = playerId => {
-    return mediaSessionCache[playerId] || {};
-  };
-  const saveHeartbeat = ({
-    playerId,
-    heartbeatId
-  }) => {
-    const sessionDetails = mediaSessionCache[playerId];
-    if (!sessionDetails) {
-      return;
-    }
-    sessionDetails.heartbeatId = heartbeatId;
-  };
-  const stopHeartbeat = ({
-    playerId
-  }) => {
-    const sessionDetails = mediaSessionCache[playerId];
-    if (!sessionDetails) {
-      return;
-    }
-    clearInterval(sessionDetails.heartbeatId);
-    sessionDetails.heartbeatId = null;
-  };
-  const updateLastTriggeredEventTS = ({
-    playerId
-  }) => {
-    const sessionDetails = mediaSessionCache[playerId];
-    if (!sessionDetails) {
-      return;
-    }
-    sessionDetails.latestTriggeredEvent = Date.now();
-  };
-  const storeSession = ({
-    playerId,
-    sessionDetails
-  }) => {
-    if (mediaSessionCache === undefined) {
-      mediaSessionCache = {};
-    }
-    mediaSessionCache[playerId] = sessionDetails;
-  };
-  return {
-    getSession,
-    stopHeartbeat,
-    updateLastTriggeredEventTS,
-    storeSession,
-    saveHeartbeat
-  };
-});

package/libEs6/components/MediaCollection/createUpdateMediaSessionState.js

@@ -1,30 +0,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.
-*/
-
-import MediaEvents from "./constants/eventTypes";
-export default (({
-  mediaSessionCacheManager
-}) => {
-  return ({
-    playerId,
-    eventType
-  }) => {
-    if (eventType === MediaEvents.SESSION_COMPLETE || eventType === MediaEvents.SESSION_END) {
-      mediaSessionCacheManager.stopHeartbeat({
-        playerId
-      });
-    }
-    mediaSessionCacheManager.updateLastTriggeredEventTS({
-      playerId
-    });
-  };
-});

package/libEs6/components/MediaCollection/index.js

@@ -1,164 +0,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.
-*/
-
-import { string, number, objectOf } from "../../utils/validation";
-import createMediaSessionCacheManager from "./createMediaSessionCacheManager";
-import validateMediaEventOptions from "./validateMediaEventOptions";
-import validateSessionOptions from "./validateMediaSessionOptions";
-import createMediaEventManager from "./createMediaEventManager";
-import { noop } from "../../utils";
-import createHeartbeatEngine from "./createHeartbeatEngine";
-import createUpdateMediaSessionState from "./createUpdateMediaSessionState";
-const createMediaCollection = ({
-  config,
-  logger,
-  eventManager,
-  sendEdgeNetworkRequest,
-  consent
-}) => {
-  const mediaSessionCacheManager = createMediaSessionCacheManager({
-    config
-  });
-  const mediaEventManager = createMediaEventManager({
-    config,
-    eventManager,
-    logger,
-    consent,
-    sendEdgeNetworkRequest
-  });
-  const heartbeatTicker = createHeartbeatEngine({
-    config,
-    mediaEventManager,
-    mediaSessionCacheManager
-  });
-  const updateMediaSessionState = createUpdateMediaSessionState({
-    mediaSessionCacheManager
-  });
-  return {
-    lifecycle: {
-      onBeforeEvent({
-        playerId,
-        onBeforeMediaEvent,
-        onResponse = noop
-      }) {
-        onResponse(({
-          response
-        }) => {
-          const sessionId = response.getPayloadsByType("media-analytics:new-session");
-          logger.info("Media session ID returned: ", sessionId);
-          if (sessionId.length > 0) {
-            if (playerId && onBeforeMediaEvent) {
-              const heartbeatId = setInterval(() => {
-                heartbeatTicker({
-                  sessionId: sessionId[0].sessionId,
-                  playerId,
-                  onBeforeMediaEvent
-                });
-              }, 1000);
-              mediaSessionCacheManager.saveHeartbeat({
-                playerId,
-                heartbeatId
-              });
-            }
-            return {
-              sessionId: sessionId[0].sessionId
-            };
-          }
-          return {};
-        });
-      }
-    },
-    commands: {
-      createMediaSession: {
-        optionsValidator: options => validateSessionOptions({
-          options
-        }),
-        run: options => {
-          const {
-            playerId,
-            onBeforeMediaEvent
-          } = options;
-          const event = mediaEventManager.createMediaSession(options);
-          mediaEventManager.augmentMediaEvent({
-            event,
-            playerId,
-            onBeforeMediaEvent
-          });
-          const sessionPromise = mediaEventManager.trackMediaSession({
-            event,
-            playerId,
-            onBeforeMediaEvent
-          });
-          mediaSessionCacheManager.storeSession({
-            playerId,
-            sessionDetails: {
-              sessionPromise,
-              onBeforeMediaEvent,
-              latestTriggeredEvent: Date.now()
-            }
-          });
-          return sessionPromise;
-        }
-      },
-      sendMediaEvent: {
-        optionsValidator: options => validateMediaEventOptions({
-          options
-        }),
-        run: options => {
-          const event = mediaEventManager.createMediaEvent({
-            options
-          });
-          const {
-            playerId,
-            xdm
-          } = options;
-          const eventType = xdm.eventType;
-          const action = eventType.split(".")[1];
-          const {
-            onBeforeMediaEvent,
-            sessionPromise
-          } = mediaSessionCacheManager.getSession(playerId);
-          sessionPromise.then(result => {
-            mediaEventManager.augmentMediaEvent({
-              event,
-              playerId,
-              onBeforeMediaEvent,
-              sessionID: result.sessionId
-            });
-            return mediaEventManager.trackMediaEvent({
-              event,
-              action
-            }).then(() => {
-              updateMediaSessionState({
-                playerId,
-                eventType
-              });
-            }).catch(error => {
-              logger.warn(`The Media Event of type ${action} failed.`, error);
-            });
-          });
-        }
-      }
-    }
-  };
-};
-createMediaCollection.namespace = "Media Collection";
-createMediaCollection.configValidators = objectOf({
-  mediaCollection: objectOf({
-    channel: string().nonEmpty().required(),
-    playerName: string().nonEmpty().required(),
-    version: string(),
-    mainPingInterval: number().minimum(10).maximum(50).default(10),
-    adPingInterval: number().minimum(10).maximum(50).default(10)
-  }).noUnknownFields()
-});
-export default createMediaCollection;

package/libEs6/components/MediaCollection/validateMediaEventOptions.js

@@ -1,32 +0,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.
-*/
-import { anyOf, anything, number, objectOf, string } from "../../utils/validation";
-export default (({
-  options
-}) => {
-  const validator = anyOf([objectOf({
-    playerId: string().required(),
-    xdm: objectOf({
-      eventType: string().required(),
-      mediaCollection: objectOf(anything())
-    }).required()
-  }).required(), objectOf({
-    xdm: objectOf({
-      eventType: string().required(),
-      mediaCollection: objectOf({
-        playhead: number().integer().required(),
-        sessionID: string().required()
-      }).required()
-    }).required()
-  }).required()], "Error validating the sendMediaEvent command options.");
-  return validator(options);
-});

package/libEs6/components/MediaCollection/validateMediaSessionOptions.js

@@ -1,34 +0,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.
-*/
-
-import { anyOf, anything, callback, number, objectOf, string } from "../../utils/validation";
-export default (({
-  options
-}) => {
-  const sessionValidator = anyOf([objectOf({
-    playerId: string().required(),
-    onBeforeMediaEvent: callback().required(),
-    xdm: objectOf({
-      mediaCollection: objectOf({
-        sessionDetails: objectOf(anything()).required()
-      })
-    })
-  }).required(), objectOf({
-    xdm: objectOf({
-      mediaCollection: objectOf({
-        playhead: number().required(),
-        sessionDetails: objectOf(anything()).required()
-      })
-    })
-  }).required()], "Error validating the createMediaSession command options.");
-  return sessionValidator(options);
-});

package/libEs6/components/Personalization/constants/loggerMessage.js

@@ -1,13 +0,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.
-*/
-export const AUTHORING_ENABLED = "Rendering is disabled for authoring mode.";
-export const REDIRECT_EXECUTION_ERROR = "An error occurred while executing the redirect offer.";

package/libEs6/components/Personalization/constants/scopeType.js

@@ -1,15 +0,0 @@
-/*
-Copyright 2022 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 VIEW_SCOPE_TYPE = "view";
-export const PAGE_SCOPE_TYPE = "page";
-export const PROPOSITION_SCOPE_TYPE = "proposition";