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

package/libEs6/components/DecisioningEngine/utils.js

@@ -0,0 +1,83 @@
+/*
+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

@@ -0,0 +1,23 @@
+/*
+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

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

package/libEs6/components/EventMerge/index.js

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

package/libEs6/components/Identity/addEcidQueryToPayload.js

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

package/libEs6/components/Identity/addEcidToPayload.js

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

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

@@ -0,0 +1,23 @@
+/*
+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/index.js";
+import { objectOf, string } from "../../../utils/validation/index.js";
+/**
+ * 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

@@ -0,0 +1,31 @@
+/*
+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

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

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

@@ -0,0 +1,15 @@
+/*
+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

@@ -0,0 +1,13 @@
+/*
+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

@@ -0,0 +1,97 @@
+/*
+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/index.js";
+import getIdentityOptionsValidator from "./getIdentity/getIdentityOptionsValidator.js";
+import appendIdentityToUrlOptionsValidator from "./appendIdentityToUrl/appendIdentityToUrlOptionsValidator.js";
+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

@@ -0,0 +1,69 @@
+/*
+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

@@ -0,0 +1,19 @@
+/*
+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/index.js";
+import ecidNamespace from "../../constants/ecidNamespace.js";
+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

@@ -0,0 +1,34 @@
+/*
+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/index.js";
+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

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

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

@@ -0,0 +1,27 @@
+/*
+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 { createAddIdentity, createHasIdentity, createRequestPayload } from "../../../utils/request/index.js";
+export default (namespaces => {
+  const content = {
+    query: {
+      identity: {
+        fetch: namespaces
+      }
+    }
+  };
+  return createRequestPayload({
+    content,
+    addIdentity: createAddIdentity(content),
+    hasIdentity: createHasIdentity(content)
+  });
+});

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

@@ -0,0 +1,25 @@
+/*
+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 { validateConfigOverride } from "../../../utils/index.js";
+import { objectOf, literal, arrayOf } from "../../../utils/validation/index.js";
+/**
+ * Verifies user provided event options.
+ * @param {*} options The user event options to validate
+ * @returns {*} Validated options
+ */
+export default objectOf({
+  namespaces: arrayOf(literal("ECID")).nonEmpty().uniqueItems().default(["ECID"]),
+  edgeConfigOverrides: validateConfigOverride
+}).noUnknownFields().default({
+  namespaces: ["ECID"]
+});