@adobe/alloy 2.26.0 → 2.27.0-beta.0

package/libEs5/core/index.js

@@ -32,6 +32,7 @@ var _injectGetLocationHint = require("./edgeNetwork/injectGetLocationHint.js");
 var _isRequestRetryable = require("./network/isRequestRetryable.js");
 var _getRequestRetryDelay = require("./network/getRequestRetryDelay.js");
 var _injectApplyResponse = require("./edgeNetwork/injectApplyResponse.js");
+var _getMonitors = require("./getMonitors.js");
 var requiredComponents = require("./requiredComponentCreators.js");
 /*
 Copyright 2019 Adobe. All rights reserved.
@@ -51,10 +52,6 @@ const {
   fetch,
   navigator
 } = window;
-
-// set this up as a function so that monitors can be added at anytime
-// eslint-disable-next-line no-underscore-dangle
-const getMonitors = () => window.__alloyMonitors || [];
 const coreConfigValidators = (0, _createCoreConfigs.default)();
 const apexDomain = (0, _index.getApexDomain)(window, _index.cookieJar);
 const sendFetchRequest = (0, _injectSendFetchRequest.default)({
@@ -68,15 +65,16 @@ const getAssuranceValidationTokenParams = (0, _index2.createGetAssuranceValidati
 const getBrowser = (0, _index.injectGetBrowser)({
   userAgent: window.navigator.userAgent
 });
-const createExecuteCommand = ({
-  instanceName,
-  logController: {
-    setDebugEnabled,
-    logger,
-    createComponentLogger
-  },
-  components
-}) => {
+const createExecuteCommand = _ref => {
+  let {
+    instanceName,
+    logController: {
+      setDebugEnabled,
+      logger,
+      createComponentLogger
+    },
+    components
+  } = _ref;
   const componentRegistry = (0, _createComponentRegistry.default)();
   const lifecycle = (0, _createLifecycle.default)(componentRegistry);
   const componentCreators = components.concat(Object.values(requiredComponents));
@@ -213,9 +211,10 @@ const createExecuteCommand = ({
   return executeCommand;
 };
 exports.createExecuteCommand = createExecuteCommand;
-var _default = ({
-  components
-}) => {
+var _default = _ref2 => {
+  let {
+    components
+  } = _ref2;
   // eslint-disable-next-line no-underscore-dangle
   const instanceNames = window.__alloyNS;
   if (instanceNames) {
@@ -226,7 +225,7 @@ var _default = ({
         createLogger: _createLogger.default,
         instanceName,
         createNamespacedStorage,
-        getMonitors
+        getMonitors: _getMonitors.default
       });
       const executeCommand = createExecuteCommand({
         instanceName,

package/libEs5/core/initializeComponents.js

@@ -13,12 +13,13 @@ 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.
 */
-var _default = ({
-  componentCreators,
-  lifecycle,
-  componentRegistry,
-  getImmediatelyAvailableTools
-}) => {
+var _default = _ref => {
+  let {
+    componentCreators,
+    lifecycle,
+    componentRegistry,
+    getImmediatelyAvailableTools
+  } = _ref;
   componentCreators.forEach(createComponent => {
     const {
       namespace

package/libEs5/core/injectCreateResponse.js

@@ -18,54 +18,58 @@ governing permissions and limitations under the License.
  * helper methods.
  * @returns Response
  */
-var _default = ({
-  extractEdgeInfo
-}) => ({
-  content = {},
-  getHeader
-}) => {
-  const {
-    handle = [],
-    errors = [],
-    warnings = []
-  } = content;
+var _default = _ref => {
+  let {
+    extractEdgeInfo
+  } = _ref;
+  return _ref2 => {
+    let {
+      content = {},
+      getHeader
+    } = _ref2;
+    const {
+      handle = [],
+      errors = [],
+      warnings = []
+    } = content;
 
-  /**
-   * Response object.
-   * @typedef {Object} Response
-   */
-  return {
     /**
-     * Returns matching fragments of the response by type.
-     * @param {String} type A string with the current format: <namespace:action>
-     *
-     * @example
-     * getPayloadsByType("identity:persist")
+     * Response object.
+     * @typedef {Object} Response
      */
-    getPayloadsByType(type) {
-      return handle.filter(fragment => fragment.type === type).flatMap(fragment => fragment.payload);
-    },
-    /**
-     * Returns all errors.
-     */
-    getErrors() {
-      return errors;
-    },
-    /**
-     * Returns all warnings.
-     */
-    getWarnings() {
-      return warnings;
-    },
-    /**
-     * Returns an object containing the regionId from the x-adobe-edge header
-     */
-    getEdge() {
-      return extractEdgeInfo(getHeader(_httpHeaderNames.ADOBE_EDGE));
-    },
-    toJSON() {
-      return content;
-    }
+    return {
+      /**
+       * Returns matching fragments of the response by type.
+       * @param {String} type A string with the current format: <namespace:action>
+       *
+       * @example
+       * getPayloadsByType("identity:persist")
+       */
+      getPayloadsByType(type) {
+        return handle.filter(fragment => fragment.type === type).flatMap(fragment => fragment.payload);
+      },
+      /**
+       * Returns all errors.
+       */
+      getErrors() {
+        return errors;
+      },
+      /**
+       * Returns all warnings.
+       */
+      getWarnings() {
+        return warnings;
+      },
+      /**
+       * Returns an object containing the regionId from the x-adobe-edge header
+       */
+      getEdge() {
+        return extractEdgeInfo(getHeader(_httpHeaderNames.ADOBE_EDGE));
+      },
+      toJSON() {
+        return content;
+      }
+    };
   };
 };
 exports.default = _default;

package/libEs5/core/injectExecuteCommand.js

@@ -15,13 +15,14 @@ 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.
 */
-var _default = ({
-  logger,
-  configureCommand,
-  setDebugCommand,
-  handleError,
-  validateCommandOptions
-}) => {
+var _default = _ref => {
+  let {
+    logger,
+    configureCommand,
+    setDebugCommand,
+    handleError,
+    validateCommandOptions
+  } = _ref;
   let configurePromise;
   const getExecutor = (commandName, options) => {
     let executor;
@@ -82,7 +83,8 @@ var _default = ({
     }
     return executor;
   };
-  return (commandName, options = {}) => {
+  return function (commandName) {
+    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
     return new Promise(resolve => {
       // We have to wrap the getExecutor() call in the promise so the promise
       // will be rejected if getExecutor() throws errors.

package/libEs5/core/injectHandleError.js

@@ -14,23 +14,26 @@ 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.
 */
-var _default = ({
-  errorPrefix,
-  logger
-}) => (error, operation) => {
-  const err = (0, _index.toError)(error);
+var _default = _ref => {
+  let {
+    errorPrefix,
+    logger
+  } = _ref;
+  return (error, operation) => {
+    const err = (0, _index.toError)(error);
 
-  // In the case of declined consent, we've opted to not reject the promise
-  // returned to the customer, but instead resolve the promise with an
-  // empty result object.
-  if (err.code === _createConsentStateMachine.DECLINED_CONSENT_ERROR_CODE) {
-    logger.warn("The " + operation + " could not fully complete. " + err.message);
-    return {};
-  }
-  (0, _index.updateErrorMessage)({
-    error: err,
-    message: errorPrefix + " " + err.message
-  });
-  throw err;
+    // In the case of declined consent, we've opted to not reject the promise
+    // returned to the customer, but instead resolve the promise with an
+    // empty result object.
+    if (err.code === _createConsentStateMachine.DECLINED_CONSENT_ERROR_CODE) {
+      logger.warn("The " + operation + " could not fully complete. " + err.message);
+      return {};
+    }
+    (0, _index.updateErrorMessage)({
+      error: err,
+      message: errorPrefix + " " + err.message
+    });
+    throw err;
+  };
 };
 exports.default = _default;

package/libEs5/core/injectShouldTransferCookie.js

@@ -14,15 +14,18 @@ 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.
 */
-var _default = ({
-  orgId,
-  targetMigrationEnabled
-}) => name => {
-  // We have a contract with the server that we will pass
-  // all cookies whose names are namespaced according to the
-  // logic in isNamespacedCookieName as well as any legacy
-  // cookie names (so that the server can handle migrating
-  // identities on websites previously using Visitor.js)
-  return (0, _index.isNamespacedCookieName)(orgId, name) || name === _legacyCookies.AT_QA_MODE || targetMigrationEnabled && name === _legacyCookies.MBOX;
+var _default = _ref => {
+  let {
+    orgId,
+    targetMigrationEnabled
+  } = _ref;
+  return name => {
+    // We have a contract with the server that we will pass
+    // all cookies whose names are namespaced according to the
+    // logic in isNamespacedCookieName as well as any legacy
+    // cookie names (so that the server can handle migrating
+    // identities on websites previously using Visitor.js)
+    return (0, _index.isNamespacedCookieName)(orgId, name) || name === _legacyCookies.AT_QA_MODE || targetMigrationEnabled && name === _legacyCookies.MBOX;
+  };
 };
 exports.default = _default;

package/libEs5/core/network/getRequestRetryDelay.js

@@ -56,10 +56,11 @@ const getDelayFromHeader = response => {
 // practices outlined in https://docs.microsoft.com/en-us/azure/architecture/best-practices/transient-faults:
 //  * Incremental retry
 //  * Random interval
-var _default = ({
-  response,
-  retriesAttempted
-}) => {
+var _default = _ref => {
+  let {
+    response,
+    retriesAttempted
+  } = _ref;
   // Technically, only 429 or 503 responses should have a Retry-After header, but we'll respect the
   // header if we find it on any response.
   let delayInMillis = getDelayFromHeader(response);

package/libEs5/core/network/injectSendNetworkRequest.js

@@ -13,22 +13,24 @@ 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.
 */
-var _default = ({
-  logger,
-  sendFetchRequest,
-  sendBeaconRequest,
-  isRequestRetryable,
-  getRequestRetryDelay
-}) => {
+var _default = _ref => {
+  let {
+    logger,
+    sendFetchRequest,
+    sendBeaconRequest,
+    isRequestRetryable,
+    getRequestRetryDelay
+  } = _ref;
   /**
    * Send a network request and returns details about the response.
    */
-  return ({
-    requestId,
-    url,
-    payload,
-    useSendBeacon
-  }) => {
+  return _ref2 => {
+    let {
+      requestId,
+      url,
+      payload,
+      useSendBeacon
+    } = _ref2;
     // We want to log raw payload and event data rather than
     // our fancy wrapper objects. Calling payload.toJSON() is
     // insufficient to get all the nested raw data, because it's
@@ -42,7 +44,8 @@ var _default = ({
       requestId,
       payload: parsedPayload
     });
-    const executeRequest = (retriesAttempted = 0) => {
+    const executeRequest = function () {
+      let retriesAttempted = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
       const requestMethod = useSendBeacon ? sendBeaconRequest : sendFetchRequest;
       return requestMethod(url, stringifiedPayload).then(response => {
         const requestIsRetryable = isRequestRetryable({

package/libEs5/core/network/isRequestRetryable.js

@@ -19,10 +19,11 @@ const RETRYABLE_STATUS_CODES = [_httpStatusCode.TOO_MANY_REQUESTS, _httpStatusCo
 
 // These rules are in accordance with
 // https://git.corp.adobe.com/pages/experience-edge/konductor/#/apis/errors?id=handling-4xx-and-5xx-responses
-var _default = ({
-  response,
-  retriesAttempted
-}) => {
+var _default = _ref => {
+  let {
+    response,
+    retriesAttempted
+  } = _ref;
   return retriesAttempted < MAX_RETRIES && RETRYABLE_STATUS_CODES.includes(response.statusCode);
 };
 exports.default = _default;

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

@@ -12,11 +12,12 @@ 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.
 */
-var _default = ({
-  sendBeacon,
-  sendFetchRequest,
-  logger
-}) => {
+var _default = _ref => {
+  let {
+    sendBeacon,
+    sendFetchRequest,
+    logger
+  } = _ref;
   return (url, body) => {
     const blob = new Blob([body], {
       type: "text/plain; charset=UTF-8"

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

@@ -12,9 +12,10 @@ 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.
 */
-var _default = ({
-  fetch
-}) => {
+var _default = _ref => {
+  let {
+    fetch
+  } = _ref;
   return (url, body) => {
     return fetch(url, {
       method: "POST",

package/libEs5/core/types.js

@@ -0,0 +1,19 @@
+"use strict";
+
+exports.Types = void 0;
+/**
+ * @typedef {object} AlloyMonitor
+ * @property {function(data): void} [onBeforeLog]
+ * @property {function(data): void} [onInstanceCreated]
+ * @property {function(data): void} [onInstanceConfigured]
+ * @property {function(data): void} [onBeforeCommand]
+ * @property {function(data): void} [onCommandResolved]
+ * @property {function(data): void} [onCommandRejected]
+ * @property {function(data): void} [onBeforeNetworkRequest]
+ * @property {function(data): void} [onNetworkResponse]
+ * @property {function(data): void} [onNetworkError]
+ * @property {function(data): void} [onContentHiding]
+ * @property {function(data): void} [onContentRendering]
+ */
+
+const Types = exports.Types = {};

package/libEs5/core/validateCommandOptions.js

@@ -14,10 +14,11 @@ governing permissions and limitations under the License.
 */
 
 const COMMAND_DOC_URI = "https://adobe.ly/3sHgQHb";
-var _default = ({
-  command,
-  options
-}) => {
+var _default = _ref => {
+  let {
+    command,
+    options
+  } = _ref;
   const {
     commandName,
     documentationUri = COMMAND_DOC_URI,

package/libEs5/index.js

@@ -6,6 +6,7 @@ var _createLogger = require("./core/createLogger.js");
 var _createLogController = require("./core/createLogController.js");
 var _index2 = require("./utils/index.js");
 var _index3 = require("./utils/validation/index.js");
+var _getMonitors = require("./core/getMonitors.js");
 var optionalComponents = require("./core/componentCreators.js");
 exports.components = optionalComponents;
 /*
@@ -24,11 +25,27 @@ governing permissions and limitations under the License.
 // like the launch extension. Everything that is exported here can be used independently by other
 // npm projects.
 
+/** @import { AlloyMonitor } from './types.js' */
+
 const {
   console
 } = window;
 const createNamespacedStorage = (0, _index2.injectStorage)(window);
-const createCustomInstance = (options = {}) => {
+
+/**
+ * Creates a custom Alloy instance which can reduce the library size and increase performance.
+ *
+ * @type {(options: Object) => Function}
+ * @param {Object} [options] - Configuration options for the instance.
+ * @param {string} [options.name=alloy] - The name of the instance.
+ * @param {Array<AlloyMonitor>} [options.monitors] - Monitors for the instance.
+ * @param {Array<Function>} [options.components] - Components for the instance.
+ * @returns {(commandName: string, options?: Object) => Promise<any>} A callable Alloy instance.
+ *
+ * @see {@link https://experienceleague.adobe.com/en/docs/experience-platform/web-sdk/install/create-custom-build} for more details.
+ */
+const createCustomInstance = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   const eventOptionsValidator = (0, _index3.objectOf)({
     name: (0, _index3.string)().default("alloy"),
     monitors: (0, _index3.arrayOf)((0, _index3.objectOf)({})).default([]),
@@ -39,17 +56,13 @@ const createCustomInstance = (options = {}) => {
     monitors,
     components
   } = 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 = (0, _createLogController.default)({
     console,
     locationSearch: window.location.search,
     createLogger: _createLogger.default,
     instanceName: name,
     createNamespacedStorage,
-    getMonitors
+    getMonitors: _getMonitors.default.bind(null, monitors)
   });
   const instance = (0, _index.createExecuteCommand)({
     instanceName: name,
@@ -61,8 +74,25 @@ const createCustomInstance = (options = {}) => {
   });
   return instance;
 };
+
+/**
+ * Creates a new Alloy instance.
+ *
+ * @type {(options?: Object) => Function}
+ * @param {Object} [options] - Configuration options for the instance.
+ * @param {string} [options.name=alloy] - The name of the instance.
+ * @param {Array<AlloyMonitor>} [options.monitors] - (Optional) Monitors for the instance.
+ * @returns {(commandName: string, options?: Object) => Promise<any>} A callable Alloy instance.
+ *
+ * @example
+ * const alloy = createInstance({ name: "myInstance" });
+ * alloy("configure", { datastreamId: "myDatastreamId", orgId: "myOrgId" });
+ *
+ * @see {@link https://experienceleague.adobe.com/en/docs/experience-platform/web-sdk/install/npm} for more details.
+ */
 exports.createCustomInstance = createCustomInstance;
-const createInstance = (options = {}) => {
+const createInstance = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
   const eventOptionsValidator = (0, _index3.objectOf)({
     name: (0, _index3.string)().default("alloy"),
     monitors: (0, _index3.arrayOf)((0, _index3.objectOf)({})).default([])

package/libEs5/utils/assignConcatArrayValues.js

@@ -13,7 +13,10 @@ 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.
 */
-var _default = (...values) => {
+var _default = exports.default = function _default() {
+  for (var _len = arguments.length, values = new Array(_len), _key = 0; _key < _len; _key++) {
+    values[_key] = arguments[_key];
+  }
   if (values.length < 2) {
     // if the number of args is 0 or 1, just use the default behavior from Object.assign
     return Object.assign(...values);
@@ -35,5 +38,4 @@ var _default = (...values) => {
     }
     return accumulator;
   }); // no default value to pass into reduce because we want to skip the first value
-};
-exports.default = _default;
+};

package/libEs5/utils/createCallbackAggregator.js

@@ -22,7 +22,10 @@ var _default = () => {
     add(callback) {
       callbacks.push(callback);
     },
-    call(...args) {
+    call() {
+      for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+        args[_key] = arguments[_key];
+      }
       // 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

package/libEs5/utils/createCollect.js

@@ -15,19 +15,21 @@ 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.
 */
-var _default = ({
-  eventManager,
-  mergeDecisionsMeta
-}) => {
+var _default = _ref => {
+  let {
+    eventManager,
+    mergeDecisionsMeta
+  } = _ref;
   // Called when a decision is auto-rendered for the __view__ scope or a SPA view(display and empty display notification)
-  return ({
-    decisionsMeta = [],
-    propositionAction,
-    documentMayUnload = false,
-    eventType = _eventType.DISPLAY,
-    propositionEventTypes = [(0, _propositionEventType.getPropositionEventType)(eventType)],
-    viewName
-  }) => {
+  return _ref2 => {
+    let {
+      decisionsMeta = [],
+      propositionAction,
+      documentMayUnload = false,
+      eventType = _eventType.DISPLAY,
+      propositionEventTypes = [(0, _propositionEventType.getPropositionEventType)(eventType)],
+      viewName
+    } = _ref2;
     const event = eventManager.createEvent();
     const data = {
       eventType

package/libEs5/utils/createLoggingCookieJar.js

@@ -12,10 +12,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.
 */
-var _default = ({
-  logger,
-  cookieJar
-}) => {
+var _default = _ref => {
+  let {
+    logger,
+    cookieJar
+  } = _ref;
   return {
     ...cookieJar,
     set(key, value, options) {