@adobe/alloy 2.11.0-alpha.7 → 2.11.0-alpha.8

package/libEs5/components/Personalization/createApplyPropositions.js

@@ -0,0 +1,111 @@
+"use strict";
+
+exports.default = exports.SUPPORTED_SCHEMAS = void 0;
+
+var _composePersonalizationResultingObject = require("./utils/composePersonalizationResultingObject");
+
+var _utils = require("../../utils");
+
+var _schema = require("./constants/schema");
+
+var _scope = require("./constants/scope");
+
+var _validateApplyPropositionsOptions = require("./validateApplyPropositionsOptions");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var SUPPORTED_SCHEMAS = [_schema.DOM_ACTION, _schema.HTML_CONTENT_ITEM];
+exports.SUPPORTED_SCHEMAS = SUPPORTED_SCHEMAS;
+
+var _default = function _default(_ref) {
+  var executeDecisions = _ref.executeDecisions;
+
+  var filterItemsPredicate = function filterItemsPredicate(item) {
+    return SUPPORTED_SCHEMAS.includes(item.schema);
+  };
+
+  var updatePropositionItems = function updatePropositionItems(_ref2) {
+    var items = _ref2.items,
+        metadataForScope = _ref2.metadataForScope;
+    return items.filter(filterItemsPredicate).map(function (item) {
+      if (item.schema !== _schema.HTML_CONTENT_ITEM) {
+        return _objectSpread({}, item);
+      }
+
+      if ((0, _utils.isObject)(metadataForScope)) {
+        return _objectSpread(_objectSpread({}, item), {}, {
+          data: _objectSpread(_objectSpread({}, item.data), {}, {
+            selector: metadataForScope.selector,
+            type: metadataForScope.actionType
+          })
+        });
+      }
+
+      return undefined;
+    }).filter(function (item) {
+      return item;
+    });
+  };
+
+  var filterPropositionsPredicate = function filterPropositionsPredicate(proposition) {
+    return !(proposition.scope === _scope.default && proposition.renderAttempted);
+  };
+
+  var preparePropositions = function preparePropositions(_ref3) {
+    var propositions = _ref3.propositions,
+        metadata = _ref3.metadata;
+    return propositions.filter(filterPropositionsPredicate).map(function (proposition) {
+      if ((0, _utils.isNonEmptyArray)(proposition.items)) {
+        var id = proposition.id,
+            scope = proposition.scope,
+            scopeDetails = proposition.scopeDetails;
+        return {
+          id: id,
+          scope: scope,
+          scopeDetails: scopeDetails,
+          items: updatePropositionItems({
+            items: proposition.items,
+            metadataForScope: metadata[proposition.scope]
+          })
+        };
+      }
+
+      return proposition;
+    }).filter(function (proposition) {
+      return (0, _utils.isNonEmptyArray)(proposition.items);
+    });
+  };
+
+  var applyPropositions = function applyPropositions(_ref4) {
+    var propositions = _ref4.propositions,
+        metadata = _ref4.metadata;
+    var propositionsToExecute = preparePropositions({
+      propositions: propositions,
+      metadata: metadata
+    });
+    return executeDecisions(propositionsToExecute).then(function () {
+      return (0, _composePersonalizationResultingObject.default)(propositionsToExecute, true);
+    });
+  };
+
+  return function (_ref5) {
+    var propositions = _ref5.propositions,
+        _ref5$metadata = _ref5.metadata,
+        metadata = _ref5$metadata === void 0 ? {} : _ref5$metadata;
+
+    if ((0, _utils.isNonEmptyArray)(propositions)) {
+      return applyPropositions({
+        propositions: propositions,
+        metadata: metadata
+      });
+    }
+
+    return Promise.resolve(_validateApplyPropositionsOptions.EMPTY_PROPOSITIONS);
+  };
+};
+
+exports.default = _default;

package/libEs5/components/Personalization/createComponent.js

@@ -8,6 +8,8 @@ var _createPersonalizationDetails = require("./createPersonalizationDetails");
 
 var _loggerMessage = require("./constants/loggerMessage");
 
+var _validateApplyPropositionsOptions = require("./validateApplyPropositionsOptions");
+
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -27,7 +29,8 @@ var _default = function _default(_ref) {
       isAuthoringModeEnabled = _ref.isAuthoringModeEnabled,
       mergeQuery = _ref.mergeQuery,
       viewCache = _ref.viewCache,
-      showContainers = _ref.showContainers;
+      showContainers = _ref.showContainers,
+      applyPropositions = _ref.applyPropositions;
   return {
     lifecycle: {
       onBeforeEvent: function onBeforeEvent(_ref2) {
@@ -98,6 +101,17 @@ var _default = function _default(_ref) {
           clickedElement: clickedElement
         });
       }
+    },
+    commands: {
+      applyPropositions: {
+        optionsValidator: function optionsValidator(options) {
+          return (0, _validateApplyPropositionsOptions.default)({
+            logger: logger,
+            options: options
+          });
+        },
+        run: applyPropositions
+      }
     }
   };
 };

package/libEs5/components/Personalization/index.js

@@ -40,6 +40,8 @@ var _createAutoRenderingHandler = require("./createAutoRenderingHandler");
 
 var _createNonRenderingHandler = require("./createNonRenderingHandler");
 
+var _createApplyPropositions = require("./createApplyPropositions");
+
 /*
 Copyright 2019 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -84,6 +86,9 @@ var createPersonalization = function createPersonalization(_ref) {
     showContainers: _flicker.showContainers,
     collect: collect
   });
+  var applyPropositions = (0, _createApplyPropositions.default)({
+    executeDecisions: executeDecisions
+  });
   var nonRenderingHandler = (0, _createNonRenderingHandler.default)({
     viewCache: viewCache
   });
@@ -120,7 +125,8 @@ var createPersonalization = function createPersonalization(_ref) {
     isAuthoringModeEnabled: _isAuthoringModeEnabled.default,
     mergeQuery: _event.mergeQuery,
     viewCache: viewCache,
-    showContainers: _flicker.showContainers
+    showContainers: _flicker.showContainers,
+    applyPropositions: applyPropositions
   });
 };
 

package/libEs5/components/Personalization/validateApplyPropositionsOptions.js

@@ -0,0 +1,28 @@
+"use strict";
+
+exports.default = exports.EMPTY_PROPOSITIONS = void 0;
+
+var _validation = require("../../utils/validation");
+
+var EMPTY_PROPOSITIONS = {
+  propositions: []
+};
+exports.EMPTY_PROPOSITIONS = EMPTY_PROPOSITIONS;
+
+var _default = function _default(_ref) {
+  var logger = _ref.logger,
+      options = _ref.options;
+  var applyPropositionsOptionsValidator = (0, _validation.objectOf)({
+    propositions: (0, _validation.arrayOf)((0, _validation.objectOf)((0, _validation.anything)())).nonEmpty(),
+    metadata: (0, _validation.objectOf)((0, _validation.anything)())
+  }).required();
+
+  try {
+    return applyPropositionsOptionsValidator(options);
+  } catch (e) {
+    logger.warn("Invalid options for applyPropositions. No propositions will be applied.", e);
+    return EMPTY_PROPOSITIONS;
+  }
+};
+
+exports.default = _default;

package/libEs5/constants/libraryVersion.js

@@ -15,5 +15,5 @@ governing permissions and limitations under the License.
 */
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
-var _default = "2.11.0-alpha.7";
+var _default = "2.11.0-alpha.8";
 exports.default = _default;

package/libEs6/components/Personalization/createApplyPropositions.js

@@ -0,0 +1,102 @@
+/*
+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 composePersonalizationResultingObject from "./utils/composePersonalizationResultingObject";
+import { isNonEmptyArray, isObject } from "../../utils";
+import { DOM_ACTION, HTML_CONTENT_ITEM } from "./constants/schema";
+import PAGE_WIDE_SCOPE from "./constants/scope";
+import { EMPTY_PROPOSITIONS } from "./validateApplyPropositionsOptions";
+export const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM];
+export default (({
+  executeDecisions
+}) => {
+  const filterItemsPredicate = item => SUPPORTED_SCHEMAS.includes(item.schema);
+
+  const updatePropositionItems = ({
+    items,
+    metadataForScope
+  }) => {
+    return items.filter(filterItemsPredicate).map(item => {
+      if (item.schema !== HTML_CONTENT_ITEM) {
+        return { ...item
+        };
+      }
+
+      if (isObject(metadataForScope)) {
+        return { ...item,
+          data: { ...item.data,
+            selector: metadataForScope.selector,
+            type: metadataForScope.actionType
+          }
+        };
+      }
+
+      return undefined;
+    }).filter(item => item);
+  };
+
+  const filterPropositionsPredicate = proposition => {
+    return !(proposition.scope === PAGE_WIDE_SCOPE && proposition.renderAttempted);
+  };
+
+  const preparePropositions = ({
+    propositions,
+    metadata
+  }) => {
+    return propositions.filter(filterPropositionsPredicate).map(proposition => {
+      if (isNonEmptyArray(proposition.items)) {
+        const {
+          id,
+          scope,
+          scopeDetails
+        } = proposition;
+        return {
+          id,
+          scope,
+          scopeDetails,
+          items: updatePropositionItems({
+            items: proposition.items,
+            metadataForScope: metadata[proposition.scope]
+          })
+        };
+      }
+
+      return proposition;
+    }).filter(proposition => isNonEmptyArray(proposition.items));
+  };
+
+  const applyPropositions = ({
+    propositions,
+    metadata
+  }) => {
+    const propositionsToExecute = preparePropositions({
+      propositions,
+      metadata
+    });
+    return executeDecisions(propositionsToExecute).then(() => {
+      return composePersonalizationResultingObject(propositionsToExecute, true);
+    });
+  };
+
+  return ({
+    propositions,
+    metadata = {}
+  }) => {
+    if (isNonEmptyArray(propositions)) {
+      return applyPropositions({
+        propositions,
+        metadata
+      });
+    }
+
+    return Promise.resolve(EMPTY_PROPOSITIONS);
+  };
+});

package/libEs6/components/Personalization/createComponent.js

@@ -12,6 +12,7 @@ governing permissions and limitations under the License.
 import { noop, defer } from "../../utils";
 import createPersonalizationDetails from "./createPersonalizationDetails";
 import { AUTHORING_ENABLED } from "./constants/loggerMessage";
+import validateApplyPropositionsOptions from "./validateApplyPropositionsOptions";
 export default (({
   logger,
   fetchDataHandler,
@@ -20,7 +21,8 @@ export default (({
   isAuthoringModeEnabled,
   mergeQuery,
   viewCache,
-  showContainers
+  showContainers,
+  applyPropositions
 }) => {
   return {
     lifecycle: {
@@ -87,6 +89,15 @@ export default (({
         });
       }
 
+    },
+    commands: {
+      applyPropositions: {
+        optionsValidator: options => validateApplyPropositionsOptions({
+          logger,
+          options
+        }),
+        run: applyPropositions
+      }
     }
   };
 });

package/libEs6/components/Personalization/index.js

@@ -28,6 +28,7 @@ import createClickStorage from "./createClickStorage";
 import createRedirectHandler from "./createRedirectHandler";
 import createAutorenderingHandler from "./createAutoRenderingHandler";
 import createNonRenderingHandler from "./createNonRenderingHandler";
+import createApplyPropositions from "./createApplyPropositions";
 
 const createPersonalization = ({
   config,
@@ -62,6 +63,9 @@ const createPersonalization = ({
     showContainers,
     collect
   });
+  const applyPropositions = createApplyPropositions({
+    executeDecisions
+  });
   const nonRenderingHandler = createNonRenderingHandler({
     viewCache
   });
@@ -98,7 +102,8 @@ const createPersonalization = ({
     isAuthoringModeEnabled,
     mergeQuery,
     viewCache,
-    showContainers
+    showContainers,
+    applyPropositions
   });
 };
 

package/libEs6/components/Personalization/validateApplyPropositionsOptions.js

@@ -0,0 +1,20 @@
+import { anything, objectOf, arrayOf } from "../../utils/validation";
+export const EMPTY_PROPOSITIONS = {
+  propositions: []
+};
+export default (({
+  logger,
+  options
+}) => {
+  const applyPropositionsOptionsValidator = objectOf({
+    propositions: arrayOf(objectOf(anything())).nonEmpty(),
+    metadata: objectOf(anything())
+  }).required();
+
+  try {
+    return applyPropositionsOptionsValidator(options);
+  } catch (e) {
+    logger.warn("Invalid options for applyPropositions. No propositions will be applied.", e);
+    return EMPTY_PROPOSITIONS;
+  }
+});

package/libEs6/constants/libraryVersion.js

@@ -11,4 +11,4 @@ governing permissions and limitations under the License.
 */
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
-export default "2.11.0-alpha.7";
+export default "2.11.0-alpha.8";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.11.0-alpha.7",
+  "version": "2.11.0-alpha.8",
   "description": "Adobe Experience Platform Web SDK",
   "main": "libEs5/index.js",
   "module": "libEs6/index.js",
@@ -64,7 +64,7 @@
     "uuid": "^3.3.2"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.11.0-alpha.6",
+    "@adobe/alloy": "^2.11.0-alpha.7",
     "@babel/cli": "^7.12.8",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",