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

package/libEs5/components/Identity/injectEnsureSingleIdentity.js

@@ -0,0 +1,100 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2020 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.
+*/
+// TO-DOCUMENT: We queue subsequent requests until we have an identity cookie.
+var _default = exports.default = function _default(_ref) {
+  var doesIdentityCookieExist = _ref.doesIdentityCookieExist,
+    setDomainForInitialIdentityPayload = _ref.setDomainForInitialIdentityPayload,
+    addLegacyEcidToPayload = _ref.addLegacyEcidToPayload,
+    awaitIdentityCookie = _ref.awaitIdentityCookie,
+    logger = _ref.logger;
+  var obtainedIdentityPromise;
+  var allowRequestToGoWithoutIdentity = function allowRequestToGoWithoutIdentity(request) {
+    setDomainForInitialIdentityPayload(request);
+    return addLegacyEcidToPayload(request.getPayload());
+  };
+
+  /**
+   * Ensures that if no identity cookie exists, we only let one request at a
+   * time without an identity until its response returns. In the meantime,
+   * we queue all other requests, otherwise the requests could result in
+   * multiple ECIDs being minted for the user. Once we get an identity
+   * cookie, we can let the queued requests be sent all at once, since they
+   * will have the newly minted ECID.
+   *
+   * Konductor should make every effort to return an identity, but in
+   * certain scenarios it may not. For example, in cases where the
+   * request does not match what Konductor is expecting (ie 400s).
+   * In cases where Konductor does not set an identity, there should be
+   * no events recorded so we don't need to worry about multiple ECIDs
+   * being minted for each user.
+   *
+   * The reason we allow for multiple sequential requests to be sent without
+   * an identity is to prevent a single malformed request causing all other
+   * requests to never send.
+   */
+  return function (_ref2) {
+    var request = _ref2.request,
+      onResponse = _ref2.onResponse,
+      onRequestFailure = _ref2.onRequestFailure;
+    if (doesIdentityCookieExist()) {
+      request.setIsIdentityEstablished();
+      return Promise.resolve();
+    }
+    if (obtainedIdentityPromise) {
+      // We don't have an identity cookie, but at least one request has
+      // been sent to get it. Konductor may set the identity cookie in the
+      // response. We will hold up this request until the previous request
+      // returns and awaitIdentityCookie confirms the identity was set.
+      logger.info("Delaying request while retrieving ECID from server.");
+      var previousObtainedIdentityPromise = obtainedIdentityPromise;
+
+      // This promise resolves when we have an identity cookie. Additional
+      // requests are chained together so that only one is sent at a time
+      // until we have the identity cookie.
+      obtainedIdentityPromise = previousObtainedIdentityPromise.catch(function () {
+        return awaitIdentityCookie({
+          onResponse: onResponse,
+          onRequestFailure: onRequestFailure
+        });
+      });
+
+      // When this returned promise resolves, the request will go out.
+      return previousObtainedIdentityPromise.then(function () {
+        logger.info("Resuming previously delayed request.");
+        request.setIsIdentityEstablished();
+      })
+      // If Konductor did not set the identity cookie on the previous
+      // request, then awaitIdentityCookie will reject its promise.
+      // Catch the rejection here and allow this request to go out.
+      .catch(function () {
+        return allowRequestToGoWithoutIdentity(request);
+      });
+    }
+
+    // For Alloy+Konductor communication to be as robust as possible and
+    // to ensure we don't mint new ECIDs for requests that would otherwise
+    // be sent in parallel, we'll let this request go out to fetch the
+    // cookie
+    obtainedIdentityPromise = awaitIdentityCookie({
+      onResponse: onResponse,
+      onRequestFailure: onRequestFailure
+    });
+    // This prevents an un-caught promise in the console when the identity isn't set.
+    obtainedIdentityPromise.catch(function () {
+      return undefined;
+    });
+    return allowRequestToGoWithoutIdentity(request);
+  };
+};

package/libEs5/components/Identity/injectHandleResponseForIdSyncs.js

@@ -0,0 +1,20 @@
+"use strict";
+
+exports.default = void 0;
+/*
+Copyright 2020 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 processIdSyncs = _ref.processIdSyncs;
+  return function (response) {
+    return processIdSyncs(response.getPayloadsByType("identity:exchange"));
+  };
+};

package/libEs5/components/Identity/injectProcessIdSyncs.js

@@ -0,0 +1,41 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../utils/index.js");
+/*
+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.
+*/
+
+var createResultLogMessage = function createResultLogMessage(idSync, success) {
+  return "ID sync " + (success ? "succeeded" : "failed") + ": " + idSync.spec.url;
+};
+var _default = exports.default = function _default(_ref) {
+  var fireReferrerHideableImage = _ref.fireReferrerHideableImage,
+    logger = _ref.logger;
+  return function (idSyncs) {
+    var urlIdSyncs = idSyncs.filter(function (idSync) {
+      return idSync.type === "url";
+    });
+    if (!urlIdSyncs.length) {
+      return Promise.resolve();
+    }
+    return Promise.all(urlIdSyncs.map(function (idSync) {
+      return fireReferrerHideableImage(idSync.spec).then(function () {
+        logger.info(createResultLogMessage(idSync, true));
+      }).catch(function () {
+        // We intentionally do not throw an error if id syncs fail. We
+        // consider it a non-critical failure and therefore do not want it to
+        // reject the promise handed back to the customer.
+        logger.error(createResultLogMessage(idSync, false));
+      });
+    })).then(_index.noop);
+  };
+};

package/libEs5/components/Identity/injectSetDomainForInitialIdentityPayload.js

@@ -0,0 +1,33 @@
+"use strict";
+
+exports.default = void 0;
+var _getBrowser = require("../../utils/getBrowser.js");
+/*
+Copyright 2020 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 thirdPartyCookiesEnabled = _ref.thirdPartyCookiesEnabled,
+    areThirdPartyCookiesSupportedByDefault = _ref.areThirdPartyCookiesSupportedByDefault;
+  return function (request) {
+    if (thirdPartyCookiesEnabled && areThirdPartyCookiesSupportedByDefault((0, _getBrowser.default)(window))) {
+      // If third-party cookies are enabled by the customer and
+      // supported by the browser, we will send the request to a
+      // a third-party identification domain that allows for more accurate
+      // identification of the user through use of a third-party cookie.
+      // If we have an identity to migrate, we still want to hit the
+      // third-party identification domain because the third-party identification
+      // domain will use our ECID to set the third-party cookie if the third-party
+      // cookie isn't already set, which provides for better cross-domain
+      // identification for future requests.
+      request.setUseIdThirdPartyDomain();
+    }
+  };
+};

package/libEs5/components/Identity/visitorService/awaitVisitorOptIn.js

@@ -0,0 +1,34 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../../utils/index.js");
+/*
+Copyright 2020 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;
+  return new Promise(function (resolve, reject) {
+    if ((0, _index.isObject)(window.adobe) && (0, _index.isObject)(window.adobe.optIn)) {
+      var optInOld = window.adobe.optIn;
+      logger.info("Delaying request while waiting for legacy opt-in to let Visitor retrieve ECID from server.");
+      optInOld.fetchPermissions(function () {
+        if (optInOld.isApproved([optInOld.Categories.ECID])) {
+          logger.info("Received legacy opt-in approval to let Visitor retrieve ECID from server.");
+          resolve();
+        } else {
+          reject(new Error("Legacy opt-in was declined."));
+        }
+      }, true);
+    } else {
+      resolve();
+    }
+  });
+};

package/libEs5/components/Identity/visitorService/getVisitor.js

@@ -0,0 +1,19 @@
+"use strict";
+
+exports.default = void 0;
+var _index = require("../../../utils/index.js");
+/*
+Copyright 2020 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(window) {
+  var Visitor = window.Visitor;
+  return (0, _index.isFunction)(Visitor) && (0, _index.isFunction)(Visitor.getInstance) && Visitor;
+};

package/libEs5/components/Identity/visitorService/injectGetEcidFromVisitor.js

@@ -0,0 +1,49 @@
+"use strict";
+
+exports.default = void 0;
+var _getVisitor = require("./getVisitor.js");
+/*
+Copyright 2020 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,
+    orgId = _ref.orgId,
+    awaitVisitorOptIn = _ref.awaitVisitorOptIn;
+  return function () {
+    var Visitor = (0, _getVisitor.default)(window);
+    if (Visitor) {
+      // Need to explicitly wait for optIn because visitor will call callback
+      // with invalid values prior to optIn being approved
+      return awaitVisitorOptIn({
+        logger: logger
+      }).then(function () {
+        logger.info("Delaying request while using Visitor to retrieve ECID from server.");
+        return new Promise(function (resolve) {
+          var visitor = Visitor.getInstance(orgId, {});
+          visitor.getMarketingCloudVisitorID(function (ecid) {
+            logger.info("Resuming previously delayed request that was waiting for ECID from Visitor.");
+            resolve(ecid);
+          }, true);
+        });
+      }).catch(function (error) {
+        // If consent was denied, get the ECID from experience edge. OptIn and AEP Web SDK
+        // consent should operate independently, but during id migration AEP Web SDK needs
+        // to wait for optIn object consent resolution so that only one ECID is generated.
+        if (error) {
+          logger.info(error.message + ", retrieving ECID from experience edge");
+        } else {
+          logger.info("An error occurred while obtaining the ECID from Visitor.");
+        }
+      });
+    }
+    return Promise.resolve();
+  };
+};

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

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

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

@@ -0,0 +1,49 @@
+"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 = exports.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"
+};
+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"
+};