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

package/libEs6/components/DecisioningEngine/index.js

@@ -1,124 +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 { noop, sanitizeOrgIdForCookieName } from "../../utils";
-import createOnResponseHandler from "./createOnResponseHandler";
-import createDecisionProvider from "./createDecisionProvider";
-import createApplyResponse from "./createApplyResponse";
-import createEventRegistry from "./createEventRegistry";
-import createContextProvider from "./createContextProvider";
-import createSubscribeRulesetItems from "./createSubscribeRulesetItems";
-import { CONTEXT_KEY, CONTEXT_EVENT_SOURCE, CONTEXT_EVENT_TYPE } from "./constants";
-import createEvaluateRulesetsCommand from "./createEvaluateRulesetsCommand";
-import { clearLocalStorage, createInMemoryStorage } from "./utils";
-import { objectOf, boolean } from "../../utils/validation";
-const createDecisioningEngine = ({
-  config,
-  createNamespacedStorage,
-  consent
-}) => {
-  const {
-    orgId,
-    personalizationStorageEnabled
-  } = config;
-  const storage = createNamespacedStorage(`${sanitizeOrgIdForCookieName(orgId)}.decisioning.`);
-  if (!personalizationStorageEnabled) {
-    clearLocalStorage(storage.persistent);
-  }
-  const eventRegistry = createEventRegistry({
-    storage: createInMemoryStorage()
-  });
-  const decisionProvider = createDecisionProvider({
-    eventRegistry
-  });
-  const contextProvider = createContextProvider({
-    eventRegistry,
-    window
-  });
-  const evaluateRulesetsCommand = createEvaluateRulesetsCommand({
-    contextProvider,
-    decisionProvider
-  });
-  const subscribeRulesetItems = createSubscribeRulesetItems();
-  let applyResponse;
-  return {
-    lifecycle: {
-      onDecision({
-        propositions
-      }) {
-        subscribeRulesetItems.refresh(propositions);
-      },
-      onComponentsRegistered(tools) {
-        applyResponse = createApplyResponse(tools.lifecycle);
-        if (personalizationStorageEnabled) {
-          consent.awaitConsent().then(() => {
-            eventRegistry.setStorage(storage.persistent);
-          }).catch(() => {
-            if (storage) {
-              clearLocalStorage(storage.persistent);
-            }
-          });
-        }
-      },
-      onBeforeEvent({
-        event,
-        renderDecisions,
-        personalization = {},
-        onResponse = noop
-      }) {
-        const {
-          decisionContext = {}
-        } = personalization;
-        onResponse(createOnResponseHandler({
-          renderDecisions,
-          decisionProvider,
-          applyResponse,
-          event,
-          personalization,
-          decisionContext: contextProvider.getContext({
-            [CONTEXT_KEY.TYPE]: CONTEXT_EVENT_TYPE.EDGE,
-            [CONTEXT_KEY.SOURCE]: CONTEXT_EVENT_SOURCE.REQUEST,
-            ...decisionContext
-          })
-        }));
-        eventRegistry.addExperienceEdgeEvent(event);
-      }
-    },
-    commands: {
-      evaluateRulesets: {
-        run: ({
-          renderDecisions,
-          personalization = {}
-        }) => {
-          const {
-            decisionContext = {}
-          } = personalization;
-          return evaluateRulesetsCommand.run({
-            renderDecisions,
-            decisionContext: {
-              [CONTEXT_KEY.TYPE]: CONTEXT_EVENT_TYPE.RULES_ENGINE,
-              [CONTEXT_KEY.SOURCE]: CONTEXT_EVENT_SOURCE.REQUEST,
-              ...decisionContext
-            },
-            applyResponse
-          });
-        },
-        optionsValidator: evaluateRulesetsCommand.optionsValidator
-      },
-      subscribeRulesetItems: subscribeRulesetItems.command
-    }
-  };
-};
-createDecisioningEngine.namespace = "DecisioningEngine";
-createDecisioningEngine.configValidators = objectOf({
-  personalizationStorageEnabled: boolean().default(false)
-});
-export default createDecisioningEngine;

package/libEs6/components/DecisioningEngine/utils.js

@@ -1,83 +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 createRestoreStorage = (storage, storageKey) => {
-  return defaultValue => {
-    const stored = storage.getItem(storageKey);
-    if (!stored) {
-      return defaultValue;
-    }
-    try {
-      return JSON.parse(stored);
-    } catch (e) {
-      return defaultValue;
-    }
-  };
-};
-export const createSaveStorage = (storage, storageKey, prepareFn = value => value) => {
-  return value => {
-    storage.setItem(storageKey, JSON.stringify(prepareFn(value)));
-  };
-};
-export const getExpirationDate = retentionPeriod => {
-  const expirationDate = new Date();
-  expirationDate.setDate(expirationDate.getDate() - retentionPeriod);
-  return expirationDate;
-};
-export const getActivityId = proposition => {
-  const {
-    scopeDetails = {}
-  } = proposition;
-  const {
-    activity = {}
-  } = scopeDetails;
-  const {
-    id
-  } = activity;
-  return id;
-};
-export const createInMemoryStorage = () => {
-  const inMemoryStorage = {};
-  return {
-    getItem: key => {
-      return key in inMemoryStorage ? inMemoryStorage[key] : null;
-    },
-    setItem: (key, value) => {
-      inMemoryStorage[key] = value;
-    }
-  };
-};
-export const clearLocalStorage = storage => {
-  storage.clear();
-};
-export const hasExperienceData = xdm => {
-  const {
-    eventType = "",
-    _experience
-  } = xdm;
-  if (!eventType || eventType === "") {
-    return false;
-  }
-  if (!_experience || typeof _experience !== "object") {
-    return false;
-  }
-  return true;
-};
-export const getDecisionProvider = proposition => {
-  const {
-    scopeDetails = {}
-  } = proposition;
-  const {
-    decisionProvider
-  } = scopeDetails;
-  return decisionProvider;
-};

package/libEs6/components/EventMerge/createComponent.js

@@ -1,23 +0,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.
-*/
-
-export default (({
-  createEventMergeId
-}) => {
-  return {
-    commands: {
-      createEventMergeId: {
-        run: createEventMergeId
-      }
-    }
-  };
-});

package/libEs6/components/EventMerge/createEventMergeId.js

@@ -1,18 +0,0 @@
-/*
-Copyright 20219 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 { uuid } from "../../utils";
-export default (() => {
-  return {
-    eventMergeId: uuid()
-  };
-});

package/libEs6/components/EventMerge/index.js

@@ -1,21 +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 createEventMergeId from "./createEventMergeId";
-import createComponent from "./createComponent";
-const createEventMerge = () => {
-  return createComponent({
-    createEventMergeId
-  });
-};
-createEventMerge.namespace = "EventMerge";
-export default createEventMerge;

package/libEs6/components/Identity/addEcidQueryToPayload.js

@@ -1,20 +0,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.
-*/
-
-import ecidNamespace from "../../constants/ecidNamespace";
-export default (payload => {
-  payload.mergeQuery({
-    identity: {
-      fetch: [ecidNamespace]
-    }
-  });
-});

package/libEs6/components/Identity/addEcidToPayload.js

@@ -1,18 +0,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.
-*/
-
-import ecidNamespace from "../../constants/ecidNamespace";
-export default ((payload, ecid) => {
-  payload.addIdentity(ecidNamespace, {
-    id: ecid
-  });
-});

package/libEs6/components/Identity/appendIdentityToUrl/appendIdentityToUrlOptionsValidator.js

@@ -1,23 +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.
-*/
-
-import { validateConfigOverride } from "../../../utils";
-import { objectOf, string } from "../../../utils/validation";
-/**
- * Verifies user provided event options.
- * @param {*} options The user event options to validate
- * @returns {*} Validated options
- */
-export default objectOf({
-  url: string().required().nonEmpty(),
-  edgeConfigOverrides: validateConfigOverride
-}).required().noUnknownFields();

package/libEs6/components/Identity/appendIdentityToUrl/injectAppendIdentityToUrl.js

@@ -1,31 +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.
-*/
-const URL_REGEX = /^([^?#]*)(\??[^#]*)(#?.*)$/;
-const getSeparator = queryString => {
-  if (queryString === "") {
-    return "?";
-  }
-  if (queryString === "?") {
-    return "";
-  }
-  return "&";
-};
-export default (({
-  dateProvider,
-  orgId
-}) => (ecid, url) => {
-  const ts = Math.round(dateProvider().getTime() / 1000);
-  const adobemc = encodeURIComponent(`TS=${ts}|MCMID=${ecid}|MCORGID=${encodeURIComponent(orgId)}`);
-  const [, location, queryString, fragment] = url.match(URL_REGEX);
-  const separator = getSeparator(queryString);
-  return `${location}${queryString}${separator}adobe_mc=${adobemc}${fragment}`;
-});

package/libEs6/components/Identity/configValidators.js

@@ -1,18 +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 { boolean, objectOf } from "../../utils/validation";
-const configValidators = objectOf({
-  thirdPartyCookiesEnabled: boolean().default(true),
-  idMigrationEnabled: boolean().default(true)
-});
-export default configValidators;

package/libEs6/components/Identity/constants/authState.js

@@ -1,15 +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.
-*/
-
-export const AMBIGUOUS = "ambiguous";
-export const AUTHENTICATED = "authenticated";
-export const LOGGED_OUT = "loggedOut";

package/libEs6/components/Identity/constants/defaultIdSyncTtlMinutes.js

@@ -1,13 +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.
-*/
-
-export default 10080; // 7 days

package/libEs6/components/Identity/createComponent.js

@@ -1,97 +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 { assign } from "../../utils";
-import getIdentityOptionsValidator from "./getIdentity/getIdentityOptionsValidator";
-import appendIdentityToUrlOptionsValidator from "./appendIdentityToUrl/appendIdentityToUrlOptionsValidator";
-export default (({
-  addEcidQueryToPayload,
-  addQueryStringIdentityToPayload,
-  ensureSingleIdentity,
-  setLegacyEcid,
-  handleResponseForIdSyncs,
-  getEcidFromResponse,
-  getIdentity,
-  consent,
-  appendIdentityToUrl,
-  logger
-}) => {
-  let ecid;
-  let edge = {};
-  return {
-    lifecycle: {
-      onBeforeRequest({
-        request,
-        onResponse,
-        onRequestFailure
-      }) {
-        // Querying the ECID on every request to be able to set the legacy cookie, and make it
-        // available for the `getIdentity` command.
-        addEcidQueryToPayload(request.getPayload());
-        addQueryStringIdentityToPayload(request.getPayload());
-        return ensureSingleIdentity({
-          request,
-          onResponse,
-          onRequestFailure
-        });
-      },
-      onResponse({
-        response
-      }) {
-        if (!ecid) {
-          ecid = getEcidFromResponse(response);
-
-          // Only data collection calls will have an ECID in the response.
-          // https://jira.corp.adobe.com/browse/EXEG-1234
-          if (ecid) {
-            setLegacyEcid(ecid);
-          }
-        }
-        // For sendBeacon requests, getEdge() will return {}, so we are using assign here
-        // so that sendBeacon requests don't override the edge info from before.
-        edge = assign(edge, response.getEdge());
-        return handleResponseForIdSyncs(response);
-      }
-    },
-    commands: {
-      getIdentity: {
-        optionsValidator: getIdentityOptionsValidator,
-        run: options => {
-          return consent.awaitConsent().then(() => {
-            return ecid ? undefined : getIdentity(options);
-          }).then(() => {
-            return {
-              identity: {
-                ECID: ecid
-              },
-              edge
-            };
-          });
-        }
-      },
-      appendIdentityToUrl: {
-        optionsValidator: appendIdentityToUrlOptionsValidator,
-        run: options => {
-          return consent.withConsent().then(() => {
-            return ecid ? undefined : getIdentity(options);
-          }).then(() => {
-            return {
-              url: appendIdentityToUrl(ecid, options.url)
-            };
-          }).catch(error => {
-            logger.warn(`Unable to append identity to url. ${error.message}`);
-            return options;
-          });
-        }
-      }
-    }
-  };
-});

package/libEs6/components/Identity/createLegacyIdentity.js

@@ -1,69 +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.
-*/
-
-/**
- * Handles migration of ECID to and from Visitor.js.
- */
-export default (({
-  config,
-  getEcidFromVisitor,
-  apexDomain,
-  isPageSsl,
-  cookieJar
-}) => {
-  const {
-    idMigrationEnabled,
-    orgId
-  } = config;
-  const amcvCookieName = `AMCV_${orgId}`;
-  const getEcidFromLegacyCookies = () => {
-    let ecid = null;
-    const secidCookieName = "s_ecid";
-    const legacyEcidCookieValue = cookieJar.get(secidCookieName) || cookieJar.get(amcvCookieName);
-    if (legacyEcidCookieValue) {
-      const reg = /(^|\|)MCMID\|(\d+)($|\|)/;
-      const matches = legacyEcidCookieValue.match(reg);
-      if (matches) {
-        // Destructuring arrays breaks in IE
-        ecid = matches[2];
-      }
-    }
-    return ecid;
-  };
-  return {
-    getEcid() {
-      if (idMigrationEnabled) {
-        const ecid = getEcidFromLegacyCookies();
-        if (ecid) {
-          return Promise.resolve(ecid);
-        }
-        return getEcidFromVisitor();
-      }
-      return Promise.resolve();
-    },
-    setEcid(ecid) {
-      if (idMigrationEnabled && getEcidFromLegacyCookies() !== ecid) {
-        const extraOptions = isPageSsl ? {
-          sameSite: "none",
-          secure: true
-        } : {};
-        cookieJar.set(amcvCookieName, `MCMID|${ecid}`, {
-          domain: apexDomain,
-          // Without `expires` this will be a session cookie.
-          expires: 390,
-          // days, or 13 months.
-          ...extraOptions
-        });
-      }
-    }
-  };
-});

package/libEs6/components/Identity/getEcidFromResponse.js

@@ -1,19 +0,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.
-*/
-
-import { find } from "../../utils";
-import ecidNamespace from "../../constants/ecidNamespace";
-export default (response => {
-  const identityResultPayloads = response.getPayloadsByType("identity:result");
-  const ecidPayload = find(identityResultPayloads, payload => payload.namespace && payload.namespace.code === ecidNamespace);
-  return ecidPayload ? ecidPayload.id : undefined;
-});

package/libEs6/components/Identity/getIdentity/createGetIdentity.js

@@ -1,34 +0,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.
-*/
-
-import { createRequestParams } from "../../../utils/request";
-export default (({
-  sendEdgeNetworkRequest,
-  createIdentityRequestPayload,
-  createIdentityRequest,
-  globalConfigOverrides
-}) => {
-  return ({
-    namespaces,
-    edgeConfigOverrides: localConfigOverrides
-  } = {}) => {
-    const requestParams = createRequestParams({
-      payload: createIdentityRequestPayload(namespaces),
-      globalConfigOverrides,
-      localConfigOverrides
-    });
-    const request = createIdentityRequest(requestParams);
-    return sendEdgeNetworkRequest({
-      request
-    });
-  };
-});

package/libEs6/components/Identity/getIdentity/createIdentityRequest.js

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