@sapui5/sap.fe.core 1.99.0 → 1.100.0

package/src/sap/fe/core/controllerextensions/IntentBasedNavigation.js

@@ -1,57 +1,82 @@
 /*!
  * SAP UI development toolkit for HTML5 (SAPUI5)
-        (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
  */
-sap.ui.define(["sap/ui/core/mvc/ControllerExtension", "sap/ui/core/mvc/OverrideExecution"], function(
-	ControllerExtension,
-	OverrideExecution
-) {
-	"use strict";
-
-	/**
-	 * @class Controller extension providing hooks for intent-based navigation
-	 *
-	 * @name sap.fe.core.controllerextensions.IntentBasedNavigation
-	 * @hideconstructor
-	 * @public
-	 * @since 1.86.0
-	 */
-	return ControllerExtension.extend("sap.fe.core.controllerextensions.IntentBasedNavigation", {
-		metadata: {
-			methods: {
-				adaptNavigationContext: {
-					"final": false,
-					"public": true,
-					overrideExecution: OverrideExecution.After
-				}
-			}
-		},
-
-		/**
-		 * @private
-		 * @name sap.fe.core.controllerextensions.IntentBasedNavigation.getMetadata
-		 * @function
-		 */
-		/**
-		 * @private
-		 * @name sap.fe.core.controllerextensions.IntentBasedNavigation.extend
-		 * @function
-		 */
-		/**
-		 * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation.
-		 *
-		 * @function
-		 * @param {sap.fe.navigation.SelectionVariant} oSelectionVariant SelectionVariant provided by SAP Fiori elements.
-		 * @param {object} oNavigationInfo Object containing intent-based navigation-related info
-		 * @param {string} oNavigationInfo.semanticObject Semantic object related to the intent
-		 * @param {string} oNavigationInfo.action Action related to the intent
-		 * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#adaptNavigationContext
-		 * @public
-		 * @since 1.86.0
-		 */
-		adaptNavigationContext: function(oSelectionVariant, oNavigationInfo) {
-			// to be overriden by the application
-		}
-	});
-});
+sap.ui.define(["sap/ui/core/mvc/ControllerExtension", "sap/ui/core/mvc/OverrideExecution", "sap/fe/core/helpers/ClassSupport", "sap/fe/core/controllerextensions/ControllerExtensionMetadata"], function (ControllerExtension, OverrideExecution, ClassSupport, ControllerExtensionMetadata) {
+  "use strict";
+
+  var _dec, _dec2, _class, _class2;
+
+  var UI5Class = ClassSupport.UI5Class;
+  var Public = ClassSupport.Public;
+  var Final = ClassSupport.Final;
+  var Extensible = ClassSupport.Extensible;
+
+  function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+  function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+  function _applyDecoratedDescriptor(target, property, decorators, descriptor, context) { var desc = {}; Object.keys(descriptor).forEach(function (key) { desc[key] = descriptor[key]; }); desc.enumerable = !!desc.enumerable; desc.configurable = !!desc.configurable; if ('value' in desc || desc.initializer) { desc.writable = true; } desc = decorators.slice().reverse().reduce(function (desc, decorator) { return decorator(target, property, desc) || desc; }, desc); if (context && desc.initializer !== void 0) { desc.value = desc.initializer ? desc.initializer.call(context) : void 0; desc.initializer = undefined; } if (desc.initializer === void 0) { Object.defineProperty(target, property, desc); desc = null; } return desc; }
+
+  /**
+   * Controller extension providing hooks for intent-based navigation
+   *
+   * @hideconstructor
+   * @public
+   * @since 1.86.0
+   */
+  var IntentBasedNavigation = (_dec = UI5Class("sap.fe.core.controllerextensions.IntentBasedNavigation", ControllerExtensionMetadata), _dec2 = Extensible(OverrideExecution.After), _dec(_class = (_class2 = /*#__PURE__*/function (_ControllerExtension) {
+    _inherits(IntentBasedNavigation, _ControllerExtension);
+
+    function IntentBasedNavigation() {
+      return _ControllerExtension.apply(this, arguments) || this;
+    }
+
+    var _proto = IntentBasedNavigation.prototype;
+
+    /**
+     * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation.
+     *
+     * @function
+     * @param {sap.fe.navigation.SelectionVariant} oSelectionVariant SelectionVariant provided by SAP Fiori elements.
+     * @param {object} oNavigationInfo Object containing intent-based navigation-related info
+     * @param {string} oNavigationInfo.semanticObject Semantic object related to the intent
+     * @param {string} oNavigationInfo.action Action related to the intent
+     * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#adaptNavigationContext
+     * @public
+     * @since 1.86.0
+     */
+    _proto. // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    adaptNavigationContext = function adaptNavigationContext(oSelectionVariant, oNavigationInfo) {// to be overriden by the application
+    }
+    /**
+     * Navigates to an intent defined by an outbound definition in the manifest.
+     *
+     * @function
+     * @param {string} sOutbound Identifier to locate the outbound definition in the manifest.
+     * This provides the semantic object and action for the intent-based navigation.
+     * Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
+     * See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries} for more information.
+     * @param {object} mNavigationParameters Optional map containing key/value pairs to be passed to the intent.
+     * If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest are ignored.
+     * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#navigateOutbound
+     * @public
+     * @since 1.86.0
+     */
+    ;
+
+    _proto.navigateOutbound = function navigateOutbound(sOutbound, mNavigationParameters) {
+      var _this$base, _this$base2;
+
+      var oInternalModelContext = (_this$base = this.base) === null || _this$base === void 0 ? void 0 : _this$base.getView().getBindingContext("internal");
+      oInternalModelContext.setProperty("externalNavigationContext", {
+        "page": false
+      });
+      (_this$base2 = this.base) === null || _this$base2 === void 0 ? void 0 : _this$base2._intentBasedNavigation.navigateOutbound(sOutbound, mNavigationParameters);
+    };
+
+    return IntentBasedNavigation;
+  }(ControllerExtension), (_applyDecoratedDescriptor(_class2.prototype, "adaptNavigationContext", [Public, _dec2], Object.getOwnPropertyDescriptor(_class2.prototype, "adaptNavigationContext"), _class2.prototype), _applyDecoratedDescriptor(_class2.prototype, "navigateOutbound", [Final, Public], Object.getOwnPropertyDescriptor(_class2.prototype, "navigateOutbound"), _class2.prototype)), _class2)) || _class);
+  return IntentBasedNavigation;
+}, false);
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIkludGVudEJhc2VkTmF2aWdhdGlvbi50cyJdLCJuYW1lcyI6WyJJbnRlbnRCYXNlZE5hdmlnYXRpb24iLCJVSTVDbGFzcyIsIkNvbnRyb2xsZXJFeHRlbnNpb25NZXRhZGF0YSIsIkV4dGVuc2libGUiLCJPdmVycmlkZUV4ZWN1dGlvbiIsIkFmdGVyIiwiYWRhcHROYXZpZ2F0aW9uQ29udGV4dCIsIm9TZWxlY3Rpb25WYXJpYW50Iiwib05hdmlnYXRpb25JbmZvIiwibmF2aWdhdGVPdXRib3VuZCIsInNPdXRib3VuZCIsIm1OYXZpZ2F0aW9uUGFyYW1ldGVycyIsIm9JbnRlcm5hbE1vZGVsQ29udGV4dCIsImJhc2UiLCJnZXRWaWV3IiwiZ2V0QmluZGluZ0NvbnRleHQiLCJzZXRQcm9wZXJ0eSIsIl9pbnRlbnRCYXNlZE5hdmlnYXRpb24iLCJDb250cm9sbGVyRXh0ZW5zaW9uIiwiUHVibGljIiwiRmluYWwiXSwibWFwcGluZ3MiOiI7QUFBQTtBQUNBO0FBQ0E7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBTUE7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7TUFFTUEscUIsV0FETEMsUUFBUSxDQUFDLHdEQUFELEVBQTJEQywyQkFBM0QsQyxVQWdCUEMsVUFBVSxDQUFDQyxpQkFBaUIsQ0FBQ0MsS0FBbkIsQzs7Ozs7Ozs7O0FBYlg7QUFDRDtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO1lBR0M7QUFDQUMsSUFBQUEsc0IsR0FIQSxnQ0FHdUJDLGlCQUh2QixFQUc0REMsZUFINUQsRUFHeUgsQ0FDeEg7QUFDQTtBQUVEO0FBQ0Q7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7OztXQUdDQyxnQixHQUZBLDBCQUVpQkMsU0FGakIsRUFFb0NDLHFCQUZwQyxFQUVtRTtBQUFBOztBQUNsRSxVQUFNQyxxQkFBcUIsaUJBQUcsS0FBS0MsSUFBUiwrQ0FBRyxXQUFXQyxPQUFYLEdBQXFCQyxpQkFBckIsQ0FBdUMsVUFBdkMsQ0FBOUI7QUFDQUgsTUFBQUEscUJBQXFCLENBQUNJLFdBQXRCLENBQWtDLDJCQUFsQyxFQUErRDtBQUFFLGdCQUFRO0FBQVYsT0FBL0Q7QUFDQSwwQkFBS0gsSUFBTCw0REFBV0ksc0JBQVgsQ0FBa0NSLGdCQUFsQyxDQUFtREMsU0FBbkQsRUFBOERDLHFCQUE5RDtBQUNBLEs7OztJQXpDa0NPLG1CLDRFQWNsQ0MsTSw4S0FxQkFDLEssRUFDQUQsTTtTQVFhbkIscUIiLCJzb3VyY2VSb290IjoiLiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBDb250cm9sbGVyRXh0ZW5zaW9uIGZyb20gXCJzYXAvdWkvY29yZS9tdmMvQ29udHJvbGxlckV4dGVuc2lvblwiO1xuaW1wb3J0IE92ZXJyaWRlRXhlY3V0aW9uIGZyb20gXCJzYXAvdWkvY29yZS9tdmMvT3ZlcnJpZGVFeGVjdXRpb25cIjtcbmltcG9ydCBTZWxlY3Rpb25WYXJpYW50IGZyb20gXCJzYXAvZmUvbmF2aWdhdGlvbi9TZWxlY3Rpb25WYXJpYW50XCI7XG5pbXBvcnQgeyBFeHRlbnNpYmxlLCBGaW5hbCwgUHVibGljLCBVSTVDbGFzcyB9IGZyb20gXCJzYXAvZmUvY29yZS9oZWxwZXJzL0NsYXNzU3VwcG9ydFwiO1xuaW1wb3J0IENvbnRyb2xsZXJFeHRlbnNpb25NZXRhZGF0YSBmcm9tIFwic2FwL2ZlL2NvcmUvY29udHJvbGxlcmV4dGVuc2lvbnMvQ29udHJvbGxlckV4dGVuc2lvbk1ldGFkYXRhXCI7XG5pbXBvcnQgUGFnZUNvbnRyb2xsZXIgZnJvbSBcInNhcC9mZS9jb3JlL1BhZ2VDb250cm9sbGVyXCI7XG5pbXBvcnQgeyBJbnRlcm5hbE1vZGVsQ29udGV4dCB9IGZyb20gXCJzYXAvZmUvY29yZS9oZWxwZXJzL01vZGVsSGVscGVyXCI7XG5cbi8qKlxuICogQ29udHJvbGxlciBleHRlbnNpb24gcHJvdmlkaW5nIGhvb2tzIGZvciBpbnRlbnQtYmFzZWQgbmF2aWdhdGlvblxuICpcbiAqIEBoaWRlY29uc3RydWN0b3JcbiAqIEBwdWJsaWNcbiAqIEBzaW5jZSAxLjg2LjBcbiAqL1xuQFVJNUNsYXNzKFwic2FwLmZlLmNvcmUuY29udHJvbGxlcmV4dGVuc2lvbnMuSW50ZW50QmFzZWROYXZpZ2F0aW9uXCIsIENvbnRyb2xsZXJFeHRlbnNpb25NZXRhZGF0YSlcbmNsYXNzIEludGVudEJhc2VkTmF2aWdhdGlvbiBleHRlbmRzIENvbnRyb2xsZXJFeHRlbnNpb24ge1xuXHRiYXNlITogUGFnZUNvbnRyb2xsZXI7XG5cdC8qKlxuXHQgKiBQcm92aWRlcyBhIGhvb2sgdG8gY3VzdG9taXplIHRoZSB7QGxpbmsgc2FwLmZlLm5hdmlnYXRpb24uU2VsZWN0aW9uVmFyaWFudH0gcmVsYXRlZCB0byB0aGUgaW50ZW50LWJhc2VkIG5hdmlnYXRpb24uXG5cdCAqXG5cdCAqIEBmdW5jdGlvblxuXHQgKiBAcGFyYW0ge3NhcC5mZS5uYXZpZ2F0aW9uLlNlbGVjdGlvblZhcmlhbnR9IG9TZWxlY3Rpb25WYXJpYW50IFNlbGVjdGlvblZhcmlhbnQgcHJvdmlkZWQgYnkgU0FQIEZpb3JpIGVsZW1lbnRzLlxuXHQgKiBAcGFyYW0ge29iamVjdH0gb05hdmlnYXRpb25JbmZvIE9iamVjdCBjb250YWluaW5nIGludGVudC1iYXNlZCBuYXZpZ2F0aW9uLXJlbGF0ZWQgaW5mb1xuXHQgKiBAcGFyYW0ge3N0cmluZ30gb05hdmlnYXRpb25JbmZvLnNlbWFudGljT2JqZWN0IFNlbWFudGljIG9iamVjdCByZWxhdGVkIHRvIHRoZSBpbnRlbnRcblx0ICogQHBhcmFtIHtzdHJpbmd9IG9OYXZpZ2F0aW9uSW5mby5hY3Rpb24gQWN0aW9uIHJlbGF0ZWQgdG8gdGhlIGludGVudFxuXHQgKiBAYWxpYXMgc2FwLmZlLmNvcmUuY29udHJvbGxlcmV4dGVuc2lvbnMuSW50ZW50QmFzZWROYXZpZ2F0aW9uI2FkYXB0TmF2aWdhdGlvbkNvbnRleHRcblx0ICogQHB1YmxpY1xuXHQgKiBAc2luY2UgMS44Ni4wXG5cdCAqL1xuXHRAUHVibGljXG5cdEBFeHRlbnNpYmxlKE92ZXJyaWRlRXhlY3V0aW9uLkFmdGVyKVxuXHQvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG5cdGFkYXB0TmF2aWdhdGlvbkNvbnRleHQob1NlbGVjdGlvblZhcmlhbnQ6IFNlbGVjdGlvblZhcmlhbnQsIG9OYXZpZ2F0aW9uSW5mbzogeyBzZW1hbnRpY09iamVjdDogc3RyaW5nOyBhY3Rpb246IHN0cmluZyB9KSB7XG5cdFx0Ly8gdG8gYmUgb3ZlcnJpZGVuIGJ5IHRoZSBhcHBsaWNhdGlvblxuXHR9XG5cblx0LyoqXG5cdCAqIE5hdmlnYXRlcyB0byBhbiBpbnRlbnQgZGVmaW5lZCBieSBhbiBvdXRib3VuZCBkZWZpbml0aW9uIGluIHRoZSBtYW5pZmVzdC5cblx0ICpcblx0ICogQGZ1bmN0aW9uXG5cdCAqIEBwYXJhbSB7c3RyaW5nfSBzT3V0Ym91bmQgSWRlbnRpZmllciB0byBsb2NhdGUgdGhlIG91dGJvdW5kIGRlZmluaXRpb24gaW4gdGhlIG1hbmlmZXN0LlxuXHQgKiBUaGlzIHByb3ZpZGVzIHRoZSBzZW1hbnRpYyBvYmplY3QgYW5kIGFjdGlvbiBmb3IgdGhlIGludGVudC1iYXNlZCBuYXZpZ2F0aW9uLlxuXHQgKiBBZGRpdGlvbmFsbHksIHRoZSBvdXRib3VuZCBkZWZpbml0aW9uIGNhbiBiZSB1c2VkIHRvIHByb3ZpZGUgcGFyYW1ldGVycyBmb3IgaW50ZW50LWJhc2VkIG5hdmlnYXRpb24uXG5cdCAqIFNlZSB7QGxpbmsgdG9waWM6YmUwY2Y0MGY2MTE4NGIzNThiNWZhZWRhZWM5OGIyZGEgRGVzY3JpcHRvciBmb3IgQXBwbGljYXRpb25zLCBDb21wb25lbnRzLCBhbmQgTGlicmFyaWVzfSBmb3IgbW9yZSBpbmZvcm1hdGlvbi5cblx0ICogQHBhcmFtIHtvYmplY3R9IG1OYXZpZ2F0aW9uUGFyYW1ldGVycyBPcHRpb25hbCBtYXAgY29udGFpbmluZyBrZXkvdmFsdWUgcGFpcnMgdG8gYmUgcGFzc2VkIHRvIHRoZSBpbnRlbnQuXG5cdCAqIElmIG1OYXZpZ2F0aW9uUGFyYW1ldGVycyBhcmUgcHJvdmlkZWQsIHRoZSBwYXJhbWV0ZXJzIHByb3ZpZGVkIGluIHRoZSBvdXRib3VuZCBkZWZpbml0aW9uIG9mIHRoZSBtYW5pZmVzdCBhcmUgaWdub3JlZC5cblx0ICogQGFsaWFzIHNhcC5mZS5jb3JlLmNvbnRyb2xsZXJleHRlbnNpb25zLkludGVudEJhc2VkTmF2aWdhdGlvbiNuYXZpZ2F0ZU91dGJvdW5kXG5cdCAqIEBwdWJsaWNcblx0ICogQHNpbmNlIDEuODYuMFxuXHQgKi9cblx0QEZpbmFsXG5cdEBQdWJsaWNcblx0bmF2aWdhdGVPdXRib3VuZChzT3V0Ym91bmQ6IHN0cmluZywgbU5hdmlnYXRpb25QYXJhbWV0ZXJzOiBvYmplY3QpIHtcblx0XHRjb25zdCBvSW50ZXJuYWxNb2RlbENvbnRleHQgPSB0aGlzLmJhc2U/LmdldFZpZXcoKS5nZXRCaW5kaW5nQ29udGV4dChcImludGVybmFsXCIpIGFzIEludGVybmFsTW9kZWxDb250ZXh0O1xuXHRcdG9JbnRlcm5hbE1vZGVsQ29udGV4dC5zZXRQcm9wZXJ0eShcImV4dGVybmFsTmF2aWdhdGlvbkNvbnRleHRcIiwgeyBcInBhZ2VcIjogZmFsc2UgfSk7XG5cdFx0dGhpcy5iYXNlPy5faW50ZW50QmFzZWROYXZpZ2F0aW9uLm5hdmlnYXRlT3V0Ym91bmQoc091dGJvdW5kLCBtTmF2aWdhdGlvblBhcmFtZXRlcnMpO1xuXHR9XG59XG5cbmV4cG9ydCBkZWZhdWx0IEludGVudEJhc2VkTmF2aWdhdGlvbjtcbiJdfQ==

package/src/sap/fe/core/controllerextensions/IntentBasedNavigation.ts

@@ -0,0 +1,61 @@
+import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
+import SelectionVariant from "sap/fe/navigation/SelectionVariant";
+import { Extensible, Final, Public, UI5Class } from "sap/fe/core/helpers/ClassSupport";
+import ControllerExtensionMetadata from "sap/fe/core/controllerextensions/ControllerExtensionMetadata";
+import PageController from "sap/fe/core/PageController";
+import { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
+
+/**
+ * Controller extension providing hooks for intent-based navigation
+ *
+ * @hideconstructor
+ * @public
+ * @since 1.86.0
+ */
+@UI5Class("sap.fe.core.controllerextensions.IntentBasedNavigation", ControllerExtensionMetadata)
+class IntentBasedNavigation extends ControllerExtension {
+	base!: PageController;
+	/**
+	 * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based navigation.
+	 *
+	 * @function
+	 * @param {sap.fe.navigation.SelectionVariant} oSelectionVariant SelectionVariant provided by SAP Fiori elements.
+	 * @param {object} oNavigationInfo Object containing intent-based navigation-related info
+	 * @param {string} oNavigationInfo.semanticObject Semantic object related to the intent
+	 * @param {string} oNavigationInfo.action Action related to the intent
+	 * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#adaptNavigationContext
+	 * @public
+	 * @since 1.86.0
+	 */
+	@Public
+	@Extensible(OverrideExecution.After)
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	adaptNavigationContext(oSelectionVariant: SelectionVariant, oNavigationInfo: { semanticObject: string; action: string }) {
+		// to be overriden by the application
+	}
+
+	/**
+	 * Navigates to an intent defined by an outbound definition in the manifest.
+	 *
+	 * @function
+	 * @param {string} sOutbound Identifier to locate the outbound definition in the manifest.
+	 * This provides the semantic object and action for the intent-based navigation.
+	 * Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
+	 * See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries} for more information.
+	 * @param {object} mNavigationParameters Optional map containing key/value pairs to be passed to the intent.
+	 * If mNavigationParameters are provided, the parameters provided in the outbound definition of the manifest are ignored.
+	 * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#navigateOutbound
+	 * @public
+	 * @since 1.86.0
+	 */
+	@Final
+	@Public
+	navigateOutbound(sOutbound: string, mNavigationParameters: object) {
+		const oInternalModelContext = this.base?.getView().getBindingContext("internal") as InternalModelContext;
+		oInternalModelContext.setProperty("externalNavigationContext", { "page": false });
+		this.base?._intentBasedNavigation.navigateOutbound(sOutbound, mNavigationParameters);
+	}
+}
+
+export default IntentBasedNavigation;