@adobe/alloy 2.19.0-beta.0 → 2.19.0-beta.10

package/libEs6/core/createComponentRegistry.js

@@ -9,12 +9,11 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { intersection, stackError } from "../utils";
 
+import { intersection, stackError } from "../utils";
 const wrapForErrorHandling = (fn, stackMessage) => {
   return (...args) => {
     let result;
-
     try {
       result = fn(...args);
     } catch (error) {
@@ -23,7 +22,6 @@ const wrapForErrorHandling = (fn, stackMessage) => {
         message: stackMessage
       });
     }
-
     if (result instanceof Promise) {
       result = result.catch(error => {
         throw stackError({
@@ -32,24 +30,20 @@ const wrapForErrorHandling = (fn, stackMessage) => {
         });
       });
     }
-
     return result;
   };
-}; // TO-DOCUMENT: All public commands and their signatures.
-
+};
 
+// TO-DOCUMENT: All public commands and their signatures.
 export default (() => {
   const componentsByNamespace = {};
   const commandsByName = {};
   const lifecycleCallbacksByName = {};
-
   const registerComponentCommands = (namespace, componentCommandsByName = {}) => {
     const conflictingCommandNames = intersection(Object.keys(commandsByName), Object.keys(componentCommandsByName));
-
     if (conflictingCommandNames.length) {
       throw new Error(`[ComponentRegistry] Could not register ${namespace} ` + `because it has existing command(s): ${conflictingCommandNames.join(",")}`);
     }
-
     Object.keys(componentCommandsByName).forEach(commandName => {
       const command = componentCommandsByName[commandName];
       command.commandName = commandName;
@@ -57,14 +51,12 @@ export default (() => {
       commandsByName[commandName] = command;
     });
   };
-
   const registerLifecycleCallbacks = (namespace, componentLifecycleCallbacksByName = {}) => {
     Object.keys(componentLifecycleCallbacksByName).forEach(hookName => {
       lifecycleCallbacksByName[hookName] = lifecycleCallbacksByName[hookName] || [];
       lifecycleCallbacksByName[hookName].push(wrapForErrorHandling(componentLifecycleCallbacksByName[hookName], `[${namespace}] An error occurred while executing the ${hookName} lifecycle hook.`));
     });
   };
-
   return {
     register(namespace, component) {
       const {
@@ -75,18 +67,14 @@ export default (() => {
       registerLifecycleCallbacks(namespace, lifecycle);
       componentsByNamespace[namespace] = component;
     },
-
     getCommand(commandName) {
       return commandsByName[commandName];
     },
-
     getCommandNames() {
       return Object.keys(commandsByName);
     },
-
     getLifecycleCallbacks(hookName) {
       return lifecycleCallbacksByName[hookName] || [];
     }
-
   };
 });

package/libEs6/core/createCookieTransfer.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import { endsWith } from "../utils";
 const STATE_STORE_HANDLE_TYPE = "state:store";
 export default (({
@@ -28,10 +29,11 @@ export default (({
       const state = {
         domain: apexDomain,
         cookiesEnabled: true
-      }; // If the endpoint is first-party, there's no need to transfer cookies
+      };
+
+      // If the endpoint is first-party, there's no need to transfer cookies
       // to the payload since they'll be automatically passed through cookie
       // headers.
-
       if (!isEndpointFirstParty) {
         const cookies = cookieJar.get();
         const entries = Object.keys(cookies).filter(shouldTransferCookie).map(qualifyingCookieName => {
@@ -40,15 +42,12 @@ export default (({
             value: cookies[qualifyingCookieName]
           };
         });
-
         if (entries.length) {
           state.entries = entries;
         }
       }
-
       payload.mergeState(state);
     },
-
     /**
      * When receiving from a third-party endpoint, the endpoint won't be able to
      * write first-party cookies, therefore we write first-party cookies
@@ -60,25 +59,20 @@ export default (({
           domain: apexDomain
         };
         const sameSite = stateItem.attrs && stateItem.attrs.SameSite && stateItem.attrs.SameSite.toLowerCase();
-
         if (stateItem.maxAge !== undefined) {
           // cookieJar expects "expires" as a date object
           options.expires = new Date(dateProvider().getTime() + stateItem.maxAge * 1000);
         }
-
         if (sameSite !== undefined) {
           options.sameSite = sameSite;
-        } // When sameSite is set to none, the secure flag must be set.
+        }
+        // When sameSite is set to none, the secure flag must be set.
         // Experience edge will not set the secure flag in these cases.
-
-
         if (sameSite === "none") {
           options.secure = true;
         }
-
         cookieJar.set(stateItem.key, stateItem.value, options);
       });
     }
-
   };
 });

package/libEs6/core/createEvent.js

@@ -9,16 +9,19 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-import { isEmptyObject, deepAssign, isNonEmptyArray, deduplicateArray } from "../utils";
 
+import { isEmptyObject, deepAssign, isNonEmptyArray, deduplicateArray } from "../utils";
 const getXdmPropositions = xdm => {
-  return xdm && // eslint-disable-next-line no-underscore-dangle
-  xdm._experience && // eslint-disable-next-line no-underscore-dangle
-  xdm._experience.decisioning && // eslint-disable-next-line no-underscore-dangle
-  isNonEmptyArray(xdm._experience.decisioning.propositions) ? // eslint-disable-next-line no-underscore-dangle
+  return xdm &&
+  // eslint-disable-next-line no-underscore-dangle
+  xdm._experience &&
+  // eslint-disable-next-line no-underscore-dangle
+  xdm._experience.decisioning &&
+  // eslint-disable-next-line no-underscore-dangle
+  isNonEmptyArray(xdm._experience.decisioning.propositions) ?
+  // eslint-disable-next-line no-underscore-dangle
   xdm._experience.decisioning.propositions : [];
 };
-
 export default (() => {
   const content = {};
   let userXdm;
@@ -26,86 +29,71 @@ export default (() => {
   let documentMayUnload = false;
   let isFinalized = false;
   let shouldSendEvent = true;
-
   const throwIfEventFinalized = methodName => {
     if (isFinalized) {
       throw new Error(`${methodName} cannot be called after event is finalized.`);
     }
   };
-
   const event = {
     setUserXdm(value) {
       throwIfEventFinalized("setUserXdm");
       userXdm = value;
     },
-
     setUserData(value) {
       throwIfEventFinalized("setUserData");
       userData = value;
     },
-
     mergeXdm(xdm) {
       throwIfEventFinalized("mergeXdm");
-
       if (xdm) {
         deepAssign(content, {
           xdm
         });
       }
     },
-
     mergeMeta(meta) {
       throwIfEventFinalized("mergeMeta");
-
       if (meta) {
         deepAssign(content, {
           meta
         });
       }
     },
-
     mergeQuery(query) {
       throwIfEventFinalized("mergeQuery");
-
       if (query) {
         deepAssign(content, {
           query
         });
       }
     },
-
     documentMayUnload() {
       documentMayUnload = true;
     },
-
     finalize(onBeforeEventSend) {
       if (isFinalized) {
         return;
       }
-
       const newPropositions = deduplicateArray([...getXdmPropositions(userXdm), ...getXdmPropositions(content.xdm)], (a, b) => a === b || a.id && b.id && a.id === b.id && a.scope && b.scope && a.scope === b.scope);
-
       if (userXdm) {
         this.mergeXdm(userXdm);
       }
-
       if (newPropositions.length > 0) {
         // eslint-disable-next-line no-underscore-dangle
         content.xdm._experience.decisioning.propositions = newPropositions;
       }
-
       if (userData) {
         content.data = userData;
-      } // the event should already be considered finalized in case onBeforeEventSend throws an error
-
+      }
 
+      // the event should already be considered finalized in case onBeforeEventSend throws an error
       isFinalized = true;
-
       if (onBeforeEventSend) {
         // assume that the onBeforeEventSend callback will fail (in-case of an error)
-        shouldSendEvent = false; // this allows the user to replace the xdm and data properties
-        // on the object passed to the callback
+        shouldSendEvent = false;
 
+        // this allows the user to replace the xdm and data properties
+        // on the object passed to the callback
         const tempContent = {
           xdm: content.xdm || {},
           data: content.data || {}
@@ -114,45 +102,35 @@ export default (() => {
         shouldSendEvent = result !== false;
         content.xdm = tempContent.xdm || {};
         content.data = tempContent.data || {};
-
         if (isEmptyObject(content.xdm)) {
           delete content.xdm;
         }
-
         if (isEmptyObject(content.data)) {
           delete content.data;
         }
       }
     },
-
     getDocumentMayUnload() {
       return documentMayUnload;
     },
-
     isEmpty() {
       return isEmptyObject(content) && (!userXdm || isEmptyObject(userXdm)) && (!userData || isEmptyObject(userData));
     },
-
     shouldSend() {
       return shouldSendEvent;
     },
-
     getViewName() {
-      if (!userXdm || !userXdm.web || !userXdm.web.webPageDetails || !userXdm.web.webPageDetails.viewName) {
+      if (!userXdm || !userXdm.web || !userXdm.web.webPageDetails) {
         return undefined;
       }
-
       return userXdm.web.webPageDetails.viewName;
     },
-
     toJSON() {
       if (!isFinalized) {
         throw new Error("toJSON called before finalize");
       }
-
       return content;
     }
-
   };
   return event;
 });

package/libEs6/core/createEventManager.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import PAGE_WIDE_SCOPE from "../constants/pageWideScope";
 import { createCallbackAggregator, noop } from "../utils";
 import { createRequestParams } from "../utils/request";
@@ -30,21 +31,14 @@ export default (({
   } = config;
   return {
     createEvent,
-
     /**
-     * Sends an event. This includes running the event and payload through
-     * the appropriate lifecycle hooks, sending the request to the server,
-     * and handling the response.
-     * @param {Object} event This will be JSON stringified and used inside
-     * the request payload.
-     * @param {Object} [options]
-     * @param {boolean} [options.renderDecisions=false]
-     * @param {Array} [options.decisionScopes] Note: this option will soon
-     * be deprecated, please use *personalization.decisionScopes* instead
-     * @param {Object} [options.personalization]
-     * @param {Object} [options.serverState]
-     * This will be passed to components
-     * so they can take appropriate action.
+     * Sends an event. This includes running the event and payload through the
+     * appropriate lifecycle hooks, sending the request to the server, and
+     * handling the response.
+     * @param {Object} event This will be JSON stringified and used inside the
+     * request payload.
+     * @param {Object} [options] Options to pass on to the onBeforeEvent
+     * lifecycle method
      * @param {Object} [options.edgeConfigOverrides] Settings that take
      * precedence over the global datastream configuration, including which
      * datastream to use.
@@ -52,10 +46,8 @@ export default (({
      */
     sendEvent(event, options = {}) {
       const {
-        renderDecisions = false,
-        decisionScopes,
         edgeConfigOverrides: localConfigOverrides,
-        personalization
+        ...otherOptions
       } = options;
       const requestParams = createRequestParams({
         payload: createDataCollectionRequestPayload(),
@@ -66,10 +58,8 @@ export default (({
       const onResponseCallbackAggregator = createCallbackAggregator();
       const onRequestFailureCallbackAggregator = createCallbackAggregator();
       return lifecycle.onBeforeEvent({
+        ...otherOptions,
         event,
-        renderDecisions,
-        decisionScopes,
-        personalization,
         onResponse: onResponseCallbackAggregator.add,
         onRequestFailure: onRequestFailureCallbackAggregator.add
       }).then(() => {
@@ -83,25 +73,24 @@ export default (({
           const throwError = () => {
             throw error;
           };
-
           onRequestFailureCallbackAggregator.add(lifecycle.onRequestFailure);
           return onRequestFailureCallbackAggregator.call({
             error
           }).then(throwError, throwError);
-        } // if the callback returns false, the event should not be sent
-
+        }
 
+        // if the callback returns false, the event should not be sent
         if (!event.shouldSend()) {
           onRequestFailureCallbackAggregator.add(lifecycle.onRequestFailure);
           logger.info(EVENT_CANCELLATION_MESSAGE);
           const error = new Error(EVENT_CANCELLATION_MESSAGE);
           return onRequestFailureCallbackAggregator.call({
             error
-          }).then(() => {// Ensure the promise gets resolved with undefined instead
+          }).then(() => {
+            // Ensure the promise gets resolved with undefined instead
             // of an array of return values from the callbacks.
           });
         }
-
         return sendEdgeNetworkRequest({
           request,
           runOnResponseCallbacks: onResponseCallbackAggregator.call,
@@ -109,7 +98,6 @@ export default (({
         });
       });
     },
-
     applyResponse(event, options = {}) {
       const {
         renderDecisions = false,
@@ -141,6 +129,5 @@ export default (({
         });
       });
     }
-
   };
 });

package/libEs6/core/createInstanceFunction.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 export default (executeCommand => {
   return args => {
     // Would use destructuring, but destructuring doesn't work on IE

package/libEs6/core/createLifecycle.js

@@ -9,21 +9,27 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 // TO-DOCUMENT: Lifecycle hooks and their params.
-const hookNames = [// Called after all components have been registered.
-"onComponentsRegistered", // Called before an event is sent on a data collection request
-"onBeforeEvent", // Called before each request is made to the edge.
-"onBeforeRequest", // Called after each response is returned from the edge with a successful
+const hookNames = [
+// Called after all components have been registered.
+"onComponentsRegistered",
+// Called before an event is sent on a data collection request
+"onBeforeEvent",
+// Called before each request is made to the edge.
+"onBeforeRequest",
+// Called after each response is returned from the edge with a successful
 // status code
-"onResponse", // Called after a network request to the edge fails. Either the request
+"onResponse",
+// Called after a network request to the edge fails. Either the request
 // didn't make it to the edge, didn't make it to Konductor, or Konductor
 // failed to return a regularly-structured response. (In this case { error }
 // is passed as the parameter)
 // Also called when the respone returns a 400 or 500 error. (In this case
 // { response } is passed as the parameter)
-"onRequestFailure", // A user clicked on an element.
+"onRequestFailure",
+// A user clicked on an element.
 "onClick"];
-
 const createHook = (componentRegistry, hookName) => {
   return (...args) => {
     return Promise.all(componentRegistry.getLifecycleCallbacks(hookName).map(callback => {
@@ -33,6 +39,7 @@ const createHook = (componentRegistry, hookName) => {
     }));
   };
 };
+
 /**
  * This ensures that if a component's lifecycle method X
  * attempts to execute lifecycle method Y, that all X methods on all components
@@ -40,8 +47,6 @@ const createHook = (componentRegistry, hookName) => {
  * this by kicking the call to the Y method to the next JavaScript tick.
  * @returns {function}
  */
-
-
 const guardHook = fn => {
   return (...args) => {
     return Promise.resolve().then(() => {
@@ -49,7 +54,6 @@ const guardHook = fn => {
     });
   };
 };
-
 export default (componentRegistry => {
   return hookNames.reduce((memo, hookName) => {
     memo[hookName] = guardHook(createHook(componentRegistry, hookName));

package/libEs6/core/createLogController.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import { queryString, stringToBoolean } from "../utils";
 import debugQueryParam from "../constants/debugQueryParam";
 export default (({
@@ -24,29 +25,24 @@ export default (({
   const debugSessionValue = storage.session.getItem("debug");
   let debugEnabled = debugSessionValue === "true";
   let debugEnabledWritableFromConfig = debugSessionValue === null;
-
   const getDebugEnabled = () => debugEnabled;
-
   const setDebugEnabled = (value, {
     fromConfig
   }) => {
     if (!fromConfig || debugEnabledWritableFromConfig) {
       debugEnabled = value;
     }
-
     if (!fromConfig) {
       // Web storage only allows strings, so we explicitly convert to string.
       storage.session.setItem("debug", value.toString());
       debugEnabledWritableFromConfig = false;
     }
   };
-
   if (parsedQueryString[debugQueryParam] !== undefined) {
     setDebugEnabled(stringToBoolean(parsedQueryString[debugQueryParam]), {
       fromConfig: false
     });
   }
-
   return {
     setDebugEnabled,
     logger: createLogger({
@@ -57,7 +53,6 @@ export default (({
       getMonitors,
       console
     }),
-
     createComponentLogger(componentName) {
       return createLogger({
         getDebugEnabled,
@@ -69,6 +64,5 @@ export default (({
         console
       });
     }
-
   };
 });

package/libEs6/core/createLogger.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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";
 export default (({
   getDebugEnabled,
@@ -17,14 +18,11 @@ export default (({
   context
 }) => {
   let prefix = `[${context.instanceName}]`;
-
   if (context.componentName) {
     prefix += ` [${context.componentName}]`;
   }
-
   const notifyMonitors = (method, data) => {
     const monitors = getMonitors();
-
     if (monitors.length > 0) {
       const dataWithContext = assign({}, context, data);
       monitors.forEach(monitor => {
@@ -34,64 +32,52 @@ export default (({
       });
     }
   };
-
   const log = (level, ...rest) => {
     notifyMonitors("onBeforeLog", {
       level,
       arguments: rest
     });
-
     if (getDebugEnabled()) {
       console[level](prefix, ...rest);
     }
   };
-
   return {
     get enabled() {
       return getMonitors().length > 0 || getDebugEnabled();
     },
-
     logOnInstanceCreated(data) {
       notifyMonitors("onInstanceCreated", data);
       log("info", "Instance initialized.");
     },
-
     logOnInstanceConfigured(data) {
       notifyMonitors("onInstanceConfigured", data);
       log("info", "Instance configured. Computed configuration:", data.config);
     },
-
     logOnBeforeCommand(data) {
       notifyMonitors("onBeforeCommand", data);
       log("info", `Executing ${data.commandName} command. Options:`, data.options);
     },
-
     logOnCommandResolved(data) {
       notifyMonitors("onCommandResolved", data);
       log("info", `${data.commandName} command resolved. Result:`, data.result);
     },
-
     logOnCommandRejected(data) {
       notifyMonitors("onCommandRejected", data);
       log("error", `${data.commandName} command was rejected. Error:`, data.error);
     },
-
     logOnBeforeNetworkRequest(data) {
       notifyMonitors("onBeforeNetworkRequest", data);
       log("info", `Request ${data.requestId}: Sending request.`, data.payload);
     },
-
     logOnNetworkResponse(data) {
       notifyMonitors("onNetworkResponse", data);
       const messagesSuffix = data.parsedBody || data.body ? `response body:` : `no response body.`;
       log("info", `Request ${data.requestId}: Received response with status code ${data.statusCode} and ${messagesSuffix}`, data.parsedBody || data.body);
     },
-
     logOnNetworkError(data) {
       notifyMonitors("onNetworkError", data);
       log("error", `Request ${data.requestId}: Network request failed.`, data.error);
     },
-
     /**
      * Outputs informational message to the web console. In some
      * browsers a small "i" icon is displayed next to these items
@@ -99,13 +85,11 @@ export default (({
      * @param {...*} arg Any argument to be logged.
      */
     info: log.bind(null, "info"),
-
     /**
      * Outputs a warning message to the web console.
      * @param {...*} arg Any argument to be logged.
      */
     warn: log.bind(null, "warn"),
-
     /**
      * Outputs an error message to the web console.
      * @param {...*} arg Any argument to be logged.

package/libEs6/core/edgeNetwork/handleRequestFailure.js

@@ -17,7 +17,6 @@ export default (onRequestFailureCallbackAggregator => {
     const throwError = () => {
       throw error;
     };
-
     return onRequestFailureCallbackAggregator.call({
       error
     }).then(throwError, throwError);

package/libEs6/core/edgeNetwork/injectApplyResponse.js

@@ -32,9 +32,7 @@ export default (({
     const onRequestFailureCallbackAggregator = createCallbackAggregator();
     onRequestFailureCallbackAggregator.add(lifecycle.onRequestFailure);
     onRequestFailureCallbackAggregator.add(runOnRequestFailureCallbacks);
-
     const getHeader = key => responseHeaders[key];
-
     return lifecycle.onBeforeRequest({
       request,
       onResponse: onResponseCallbackAggregator.add,
@@ -48,8 +46,9 @@ export default (({
       const response = createResponse({
         content: responseBody,
         getHeader
-      }); // This will clobber any cookies set via HTTP from the server.  So care should be given to remove any state:store handles if that is not desirable
+      });
 
+      // This will clobber any cookies set via HTTP from the server.  So care should be given to remove any state:store handles if that is not desirable
       cookieTransfer.responseToCookies(response);
       return onResponseCallbackAggregator.call({
         response