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

package/libEs6/core/network/isRequestRetryable.js

@@ -0,0 +1,25 @@
+/*
+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 { TOO_MANY_REQUESTS, SERVICE_UNAVAILABLE, BAD_GATEWAY, GATEWAY_TIMEOUT } from "../../constants/httpStatusCode.js";
+import { includes } from "../../utils/index.js";
+const MAX_RETRIES = 3;
+const RETRYABLE_STATUS_CODES = [TOO_MANY_REQUESTS, SERVICE_UNAVAILABLE, BAD_GATEWAY, GATEWAY_TIMEOUT];
+
+// These rules are in accordance with
+// https://git.corp.adobe.com/pages/experience-edge/konductor/#/apis/errors?id=handling-4xx-and-5xx-responses
+export default (({
+  response,
+  retriesAttempted
+}) => {
+  return retriesAttempted < MAX_RETRIES && includes(RETRYABLE_STATUS_CODES, response.statusCode);
+});

package/libEs6/core/network/requestMethods/injectSendBeaconRequest.js

@@ -0,0 +1,38 @@
+/*
+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 (({
+  sendBeacon,
+  sendFetchRequest,
+  logger
+}) => {
+  return (url, body) => {
+    const blob = new Blob([body], {
+      type: "text/plain; charset=UTF-8"
+    });
+    if (!sendBeacon(url, blob)) {
+      logger.info("Unable to use `sendBeacon`; falling back to `fetch`.");
+      return sendFetchRequest(url, body);
+    }
+
+    // Using sendBeacon, we technically don't get a response back from
+    // the server, but we'll resolve the promise with an object to maintain
+    // consistency with other network strategies.
+    return Promise.resolve({
+      statusCode: 204,
+      getHeader() {
+        return null;
+      },
+      body: ""
+    });
+  };
+});

package/libEs6/core/network/requestMethods/injectSendFetchRequest.js

@@ -0,0 +1,41 @@
+/*
+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 (({
+  fetch
+}) => {
+  return (url, body) => {
+    return fetch(url, {
+      method: "POST",
+      cache: "no-cache",
+      credentials: "include",
+      // To set the cookie header in the request.
+      headers: {
+        "Content-Type": "text/plain; charset=UTF-8"
+      },
+      referrerPolicy: "no-referrer-when-downgrade",
+      body
+    }).then(response => {
+      return response.text().then(responseBody => ({
+        statusCode: response.status,
+        // We expose headers through a function instead of creating an object
+        // with all the headers up front largely because the native
+        // request.getResponseHeader method is case-insensitive but also because it prevents
+        // us from having to add header parsing logic when using XHR to make requests.
+        getHeader(name) {
+          return response.headers.get(name);
+        },
+        body: responseBody
+      }));
+    });
+  };
+});

package/libEs6/core/network/requestMethods/injectSendXhrRequest.js

@@ -0,0 +1,49 @@
+/*
+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 (({
+  XMLHttpRequest
+}) => {
+  return (url, body) => {
+    return new Promise((resolve, reject) => {
+      const request = new XMLHttpRequest();
+      request.onreadystatechange = () => {
+        if (request.readyState === 4) {
+          if (request.status === 0) {
+            reject(new Error("Request aborted."));
+          } else {
+            resolve({
+              statusCode: request.status,
+              // We expose headers through a function instead of creating an object
+              // with all the headers up front because:
+              // 1. It avoids having to add header parsing code to get all headers.
+              // 2. The native request.getResponseHeader method is case-insensitive.
+              getHeader(name) {
+                return request.getResponseHeader(name);
+              },
+              body: request.responseText
+            });
+          }
+        }
+      };
+      request.onloadstart = () => {
+        request.responseType = "text";
+      };
+      request.open("POST", url, true);
+      request.setRequestHeader("Content-Type", "text/plain; charset=UTF-8");
+      request.withCredentials = true;
+      request.onerror = reject;
+      request.onabort = reject;
+      request.send(body);
+    });
+  };
+});

package/libEs6/core/validateCommandOptions.js

@@ -0,0 +1,33 @@
+/*
+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.
+*/
+
+const COMMAND_DOC_URI = "https://adobe.ly/3sHgQHb";
+export default (({
+  command,
+  options
+}) => {
+  const {
+    commandName,
+    documentationUri = COMMAND_DOC_URI,
+    optionsValidator
+  } = command;
+  let validatedOptions = options;
+  if (optionsValidator) {
+    try {
+      validatedOptions = optionsValidator(options);
+    } catch (validationError) {
+      const invalidOptionsMessage = `Invalid ${commandName} command options:\n\t - ${validationError} For command documentation see: ${documentationUri}`;
+      throw new Error(invalidOptionsMessage);
+    }
+  }
+  return validatedOptions;
+});

package/libEs6/index.js

@@ -0,0 +1,55 @@
+/*
+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.
+*/
+
+// This file is used to rollup the code into an ES module version to be used by other npm projects
+// like the launch extension. Everything that is exported here can be used independently by other
+// npm projects.
+
+import { createExecuteCommand } from "./core/index.js";
+import createLogger from "./core/createLogger.js";
+import createLogController from "./core/createLogController.js";
+import { injectStorage } from "./utils/index.js";
+import { arrayOf, objectOf, string } from "./utils/validation/index.js";
+const {
+  console
+} = window;
+const createNamespacedStorage = injectStorage(window);
+export const createInstance = (options = {}) => {
+  const eventOptionsValidator = objectOf({
+    name: string().default("alloy"),
+    monitors: arrayOf(objectOf({})).default([])
+  }).noUnknownFields();
+  const {
+    name,
+    monitors
+  } = eventOptionsValidator(options);
+
+  // this is a function so that window.__alloyMonitors can be set or added to at any time
+  // eslint-disable-next-line no-underscore-dangle
+  const getMonitors = () => (window.__alloyMonitors || []).concat(monitors);
+  const logController = createLogController({
+    console,
+    locationSearch: window.location.search,
+    createLogger,
+    instanceName: name,
+    createNamespacedStorage,
+    getMonitors
+  });
+  const instance = createExecuteCommand({
+    instanceName: name,
+    logController
+  });
+  logController.logger.logOnInstanceCreated({
+    instance
+  });
+  return instance;
+};

package/libEs6/utils/areThirdPartyCookiesSupportedByDefault.js

@@ -0,0 +1,20 @@
+/*
+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 { CHROME, EDGE, EDGE_CHROMIUM, IE, UNKNOWN } from "../constants/browser.js";
+import includes from "./includes.js";
+
+// Users could have also disabled third-party cookies within these browsers, but
+// we don't know. We also assume "unknown" browsers support third-party cookies,
+// though we don't really know that either. We're making best guesses.
+const browsersSupportingThirdPartyCookie = [CHROME, EDGE, EDGE_CHROMIUM, IE, UNKNOWN];
+export default (browser => includes(browsersSupportingThirdPartyCookie, browser));

package/libEs6/utils/assign.js

@@ -0,0 +1,14 @@
+/*
+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 assign from "@adobe/reactor-object-assign";
+export default assign;

package/libEs6/utils/assignConcatArrayValues.js

@@ -0,0 +1,36 @@
+/*
+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 "./assign.js";
+import isObject from "./isObject.js";
+export default ((...values) => {
+  if (values.length < 2) {
+    // if the number of args is 0 or 1, just use the default behavior from Object.assign
+    return assign(...values);
+  }
+  return values.reduce((accumulator, currentValue) => {
+    if (isObject(currentValue)) {
+      Object.keys(currentValue).forEach(key => {
+        if (Array.isArray(currentValue[key])) {
+          if (Array.isArray(accumulator[key])) {
+            accumulator[key].push(...currentValue[key]);
+          } else {
+            // clone the array so the original isn't modified.
+            accumulator[key] = [...currentValue[key]];
+          }
+        } else {
+          accumulator[key] = currentValue[key];
+        }
+      });
+    }
+    return accumulator;
+  }); // no default value to pass into reduce because we want to skip the first value
+});

package/libEs6/utils/assignIf.js

@@ -0,0 +1,19 @@
+/*
+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 assign from "./assign.js";
+export default ((target, source, predicate) => {
+  if (predicate()) {
+    assign(target, source);
+  }
+  return target;
+});

package/libEs6/utils/clone.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.
+*/
+
+/**
+ * Clones a value by serializing then deserializing the value.
+ * @param {*} value
+ * @returns {any}
+ */
+export default (value => JSON.parse(JSON.stringify(value)));

package/libEs6/utils/cookieJar.js

@@ -0,0 +1,19 @@
+/*
+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 cookie from "js-cookie";
+export default {
+  get: cookie.get,
+  set: cookie.set,
+  remove: cookie.remove,
+  withConverter: cookie.withConverter
+};

package/libEs6/utils/crc32.js

@@ -0,0 +1,33 @@
+/* eslint-disable */
+
+/*
+crc32 · JavaScript Function to Calculate CRC32 of a String
+Description
+  Below is a JavaScript function to calculate CRC32 of a string. 
+  The string can be either ASCII or Unicode. 
+  Unicode strings will be encoded in UTF-8. 
+  The polynomial used in calculation is 0xedb88320. 
+  This polynomial is used in Ethernet, Gzip, PNG, SATA and many other technologies.
+*/
+const crc32 = (() => {
+  const table = [];
+  for (let i = 0; i < 256; i++) {
+    let c = i;
+    for (let j = 0; j < 8; j++) {
+      c = c & 1 ? 0xedb88320 ^ c >>> 1 : c >>> 1;
+    }
+    table.push(c);
+  }
+  return function (str, crc) {
+    str = unescape(encodeURIComponent(str));
+    if (!crc) crc = 0;
+    crc = crc ^ -1;
+    for (let i = 0; i < str.length; i++) {
+      const y = (crc ^ str.charCodeAt(i)) & 0xff;
+      crc = crc >>> 8 ^ table[y];
+    }
+    crc = crc ^ -1;
+    return crc >>> 0;
+  };
+})();
+export default crc32;

package/libEs6/utils/createCallbackAggregator.js

@@ -0,0 +1,31 @@
+/*
+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.
+*/
+
+/**
+ * Allows callbacks to be registered and then later called. When the
+ * callbacks are called, their responses are combined into a single promise.
+ */
+export default (() => {
+  const callbacks = [];
+  return {
+    add(callback) {
+      callbacks.push(callback);
+    },
+    call(...args) {
+      // While this utility doesn't necessarily need to be doing the
+      // Promise.all, it's currently useful everywhere this is used and
+      // reduces repetitive code. We can factor it out later if we want
+      // to make this utility more "pure".
+      return Promise.all(callbacks.map(callback => callback(...args)));
+    }
+  };
+});

package/libEs6/utils/createLoggingCookieJar.js

@@ -0,0 +1,28 @@
+/*
+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 default (({
+  logger,
+  cookieJar
+}) => {
+  return {
+    ...cookieJar,
+    set(key, value, options) {
+      logger.info("Setting cookie", {
+        name: key,
+        value,
+        ...options
+      });
+      cookieJar.set(key, value, options);
+    }
+  };
+});

package/libEs6/utils/createMerger.js

@@ -0,0 +1,30 @@
+/*
+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 deepAssign from "./deepAssign.js";
+
+/**
+ * Creates a function that, when passed an object of updates, will merge
+ * the updates onto the current value of a payload property.
+ * @param {Object} content The base object to modify
+ * @param {String } key The property to merge updates into. This
+ * can be a dot-notation property path.
+ * @returns {Function}
+ */
+export default ((content, key) => updates => {
+  const propertyPath = key.split(".");
+  const hostObjectForUpdates = propertyPath.reduce((obj, propertyName) => {
+    obj[propertyName] = obj[propertyName] || {};
+    return obj[propertyName];
+  }, content);
+  deepAssign(hostObjectForUpdates, updates);
+});

package/libEs6/utils/createSubscription.js

@@ -0,0 +1,70 @@
+/*
+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 { values } from "./index.js";
+const defaultPreprocessor = (params, ...args) => {
+  return args;
+};
+
+// eslint-disable-next-line no-unused-vars
+const defaultEmissionCondition = (params, ...args) => true;
+const createSubscription = () => {
+  let preprocessor = defaultPreprocessor;
+  let emissionCondition = defaultEmissionCondition;
+  let counter = 0;
+  const subscriptions = {};
+  const createUnsubscribe = id => {
+    return () => {
+      delete subscriptions[id];
+    };
+  };
+  const add = (callback, params = undefined) => {
+    if (typeof callback !== "function") {
+      return () => undefined;
+    }
+    counter += 1;
+    subscriptions[counter] = {
+      callback,
+      params
+    };
+    return createUnsubscribe(counter);
+  };
+  const setEmissionPreprocessor = value => {
+    if (typeof value === "function") {
+      preprocessor = value;
+    }
+  };
+  const setEmissionCondition = value => {
+    if (typeof value === "function") {
+      emissionCondition = value;
+    }
+  };
+  const emit = (...args) => {
+    values(subscriptions).forEach(({
+      callback,
+      params
+    }) => {
+      const result = preprocessor(params, ...args);
+      if (emissionCondition(params, ...result)) {
+        callback(...result);
+      }
+    });
+  };
+  const hasSubscriptions = () => Object.keys(subscriptions).length > 0;
+  return {
+    add,
+    emit,
+    hasSubscriptions,
+    setEmissionPreprocessor,
+    setEmissionCondition
+  };
+};
+export default createSubscription;

package/libEs6/utils/createTaskQueue.js

@@ -0,0 +1,48 @@
+/*
+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.
+*/
+
+/**
+ * Sequences tasks.
+ */
+export default (() => {
+  let queueLength = 0;
+  let lastPromiseInQueue = Promise.resolve();
+  return {
+    /**
+     * Add a task to the queue. If no task is currenty running,
+     * the task will begin immediately.
+     * @param {Function} task A function that will be called when
+     * the task should be run. If the task it asynchronous, it should
+     * return a promise.
+     * @returns {Promise} A promise that will be resolved or rejected
+     * with whatever value the task resolved or rejects its promise.
+     */
+    addTask(task) {
+      queueLength += 1;
+      const lastPromiseFulfilledHandler = () => {
+        return task().finally(() => {
+          queueLength -= 1;
+        });
+      };
+      lastPromiseInQueue = lastPromiseInQueue.then(lastPromiseFulfilledHandler, lastPromiseFulfilledHandler);
+      return lastPromiseInQueue;
+    },
+    /**
+     * How many tasks are in the queue. This includes the task
+     * that's currently running.
+     * @returns {number}
+     */
+    get length() {
+      return queueLength;
+    }
+  };
+});

package/libEs6/utils/deduplicateArray.js

@@ -0,0 +1,23 @@
+/*
+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.
+*/
+const REFERENCE_EQUALITY = (a, b) => a === b;
+const findIndex = (array, item, isEqual) => {
+  for (let i = 0; i < array.length; i += 1) {
+    if (isEqual(array[i], item)) {
+      return i;
+    }
+  }
+  return -1;
+};
+export default ((array, isEqual = REFERENCE_EQUALITY) => {
+  return array.filter((item, index) => findIndex(array, item, isEqual) === index);
+});