@sap/open.fe 1.94.0

package/packages/sap.fe.core/src/sap/fe/core/services/NavigationServiceFactory-dbg.js

@@ -0,0 +1,303 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
+ */
+sap.ui.define(
+	["sap/ui/core/service/Service", "sap/ui/core/service/ServiceFactory", "sap/base/Log", "sap/fe/navigation/NavigationHandler"],
+	function(Service, ServiceFactory, Log, NavigationHandler) {
+		"use strict";
+
+		var NavigationService = Service.extend("sap.fe.core.services.NavigationService", {
+			initPromise: null,
+			init: function() {
+				var oContext = this.getContext(),
+					oComponent = oContext && oContext.scopeObject;
+
+				this.oNavHandler = new NavigationHandler(oComponent);
+				this.oNavHandler.setModel(oComponent.getModel());
+				this.initPromise = Promise.resolve(this);
+			},
+			exit: function() {
+				this.oNavHandler.destroy();
+				delete this.oNavHandler;
+			},
+
+			/**
+			 * Triggers a cross-app navigation after saving the inner and the cross-app states.
+			 * @private
+			 * @ui5-restricted
+			 * @param {string} sSemanticObject Semantic object of the target app
+			 * @param {string} sActionName Action of the target app
+			 * @param {object | string } [vNavigationParameters] Navigation parameters as an object with key/value pairs or as a string representation of
+			 *        such an object. If passed as an object, the properties are not checked against the <code>IsPotentialSensitive</code> or
+			 *        <code>Measure</code> type.
+			 * @param {object} [oInnerAppData] Object for storing current state of the app
+			 * @param {Function} [fnOnError] Callback that is called if an error occurs during navigation <br>
+			 * @param {object} oExternalAppData Object for storing the state which will be forwarded to the target component.
+			 * @param {string} [sNavMode] Argument is used to overwrite the FLP-configured target for opening a URL. If used, only the
+			 *        <code>explace</code> or <code>inplace</code> values are allowed. Any other value will lead to an exception
+			 *        <code>NavigationHandler.INVALID_NAV_MODE</code>.
+			 **/
+			navigate: function(sSemanticObject, sActionName, vNavigationParameters, oInnerAppData, fnOnError, oExternalAppData, sNavMode) {
+				// TODO: Navigation Handler does not handle navigation without a context
+				// but in v4 DataFieldForIBN with requiresContext false can trigger a navigation without any context
+				// This should be handled
+				this.oNavHandler.navigate(
+					sSemanticObject,
+					sActionName,
+					vNavigationParameters,
+					oInnerAppData,
+					fnOnError,
+					oExternalAppData,
+					sNavMode
+				);
+			},
+			/**
+			 * Parses the incoming URL and returns a Promise.
+			 * @returns {object} A Promise object which returns the
+			 * extracted app state, the startup parameters, and the type of navigation when execution is successful,
+			 * @private
+			 * @ui5-restricted
+			 **/
+			parseNavigation: function() {
+				return this.oNavHandler.parseNavigation();
+			},
+			/**
+			 * Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control and returns a Promise object.
+			 *
+			 * @param {object} oTableEventParameters The parameters made available by the SmartTable control when the SmartLink control has been clicked,
+			 *        an instance of a PopOver object
+			 * @param {string} sSelectionVariant Stringified JSON object as returned, for example, from getDataSuiteFormat() of the SmartFilterBar control
+			 * @param {object} [mInnerAppData] Object containing the current state of the app. If provided, opening the Popover is deferred until the
+			 *        inner app data is saved in a consistent way.
+			 * @returns {Promise} A Promise object to monitor when all actions of the function have been executed; if the execution is successful, the
+			 *          modified oTableEventParameters is returned; if an error occurs, an error object of type
+			 *          {@link sap.fe.navigation.NavError} is returned
+			 * @private
+			 */
+			_processBeforeSmartLinkPopoverOpens: function(oTableEventParameters, sSelectionVariant, mInnerAppData) {
+				return this.oNavHandler.processBeforeSmartLinkPopoverOpens(oTableEventParameters, sSelectionVariant, mInnerAppData);
+			},
+
+			/**
+			 * Processes selectionVariant string and returns a Promise object (semanticAttributes and AppStateKey).
+			 * @param {string} sSelectionVariant Stringified JSON object
+			 * @returns {object} A Promise object to monitor when all actions of the function have been executed; if the execution is successful, the
+			 *          semanticAttributes as well as the appStateKey are returned; if an error occurs, an error object of type
+			 *          {@link sap.fe.navigation.NavError} is returned
+			 * <br>
+			 * @example <code>
+			 *
+			 * 		var oSelectionVariant = new sap.fe.navigation.SelectionVariant();
+			 * 		oSelectionVariant.addSelectOption("CompanyCode", "I", "EQ", "0001");
+			 * 		oSelectionVariant.addSelectOption("Customer", "I", "EQ", "C0001");
+			 * 		var sSelectionVariant= oSelectionVariant.toJSONString();
+			 *
+			 * 		var oNavigationHandler = new sap.fe.navigation.NavigationHandler(oController);
+			 * 		var oPromiseObject = oNavigationHandler._getAppStateKeyAndUrlParameters(sSelectionVariant);
+			 *
+			 * 		oPromiseObject.done(function(oSemanticAttributes, sAppStateKey){
+			 * 			// here you can add coding that should run after all app state and the semantic attributes have been returned.
+			 * 		});
+			 *
+			 * 		oPromiseObject.fail(function(oError){
+			 * 			//some error handling
+			 * 		});
+			 *
+			 * </code>
+			 * @private
+			 * @ui5-restricted
+			 */
+			getAppStateKeyAndUrlParameters: function(sSelectionVariant) {
+				return this.oNavHandler._getAppStateKeyAndUrlParameters(sSelectionVariant);
+			},
+
+			/**
+			 * Gets the application specific technical parameters.
+			 * @returns {Array} Containing the technical parameters.
+			 * @private
+			 * @ui5-restricted
+			 */
+			getTechnicalParameters: function() {
+				return this.oNavHandler.getTechnicalParameters();
+			},
+			/**
+			 * Sets the application specific technical parameters. Technical parameters will not be added to the selection variant passed to the
+			 * application.
+			 * As a default sap-system, sap-ushell-defaultedParameterNames and hcpApplicationId are considered as technical parameters.
+			 * @param {Array} aTechnicalParameters List of parameter names to be considered as technical parameters. <code>null</code> or
+			 *        <code>undefined</code> may be used to reset the complete list.
+			 * @private
+			 * @ui5-restricted
+			 */
+			setTechnicalParameters: function(aTechnicalParameters) {
+				this.oNavHandler.setTechnicalParameters(aTechnicalParameters);
+			},
+			/**
+			 * Sets the model that is used for verification of sensitive information. If the model is not set, the unnamed component model is used for the
+			 * verification of sensitive information.
+			 * @private
+			 * @ui5-restricted
+			 * @param {sap.ui.model.odata.v2.ODataModel} oModel Model For checking sensitive information
+			 */
+			setModel: function(oModel) {
+				this.oNavHandler.setModel(oModel);
+			},
+			/**
+			 * Changes the URL according to the current app state and stores the app state for later retrieval.
+			 * @private
+			 * @ui5-restricted
+			 * @param {object} mInnerAppData Object containing the current state of the app
+			 * @param {boolean} [bImmediateHashReplace=false] If set to false, the inner app hash will not be replaced until storing is successful; do not
+			 * @returns {object} A Promise object to monitor when all the actions of the function have been executed; if the execution is successful, the
+			 *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is
+			 *          returned
+			 **/
+			storeInnerAppState: function(mInnerAppData, bImmediateHashReplace) {
+				return this.oNavHandler.storeInnerAppState(mInnerAppData);
+			},
+			/**
+				* Changes the URL according to the current app state and stores the app state for later retrieval.
+				* @private
+				* @ui5-restricted
+				* @param {object} mInnerAppData Object containing the current state of the app
+				* @param {boolean} [bImmediateHashReplace=false] If set to false, the inner app hash will not be replaced until storing is successful; do not
+			 * @param bNotLegacy
+
+			 * @returns {object} An object containing the appStateId and a promise object to monitor when all the actions of the function have been
+				* executed; Please note that the appStateKey may be undefined or empty.
+				*/
+			storeInnerAppStateWithImmediateReturn: function(mInnerAppData, bImmediateHashReplace, bNotLegacy) {
+				return this.oNavHandler.storeInnerAppStateWithImmediateReturn(mInnerAppData, bImmediateHashReplace, bNotLegacy);
+			},
+			/**
+			 * Changes the URL according to the current sAppStateKey. As an reaction route change event will be triggered.
+			 * @private
+			 * @ui5-restricted
+			 * @param {string} sAppStateKey The new app state key.
+			 */
+			replaceHash: function(sAppStateKey) {
+				this.oNavHandler.replaceHash(sAppStateKey);
+			},
+			replaceInnerAppStateKey: function(sAppHash, sAppStateKey) {
+				return this.oNavHandler._replaceInnerAppStateKey(sAppHash, sAppStateKey);
+			},
+			/**
+			 * Get single values from SelectionVariant for url parameters.
+			 *
+			 * @private
+			 * @ui5-restricted
+			 * @param {object | string } [vSelectionVariant]
+			 * @param {object} [vSelectionVariant.oUrlParamaters]
+			 * @returns {pbject}
+			 */
+			getUrlParametersFromSelectionVariant: function(vSelectionVariant) {
+				return this.oNavHandler._getURLParametersFromSelectionVariant(vSelectionVariant);
+			},
+
+			/**
+			 * Save app state and return immediately without waiting for response.
+			 *
+			 * @private
+			 * @ui5-restricted
+			 * @param {object} oSelectionVariant Instance of sap.fe.navigation.SelectionVariant
+			 * @returns {string} AppState key
+			 */
+			saveAppStateWithImmediateReturn: function(oSelectionVariant) {
+				if (oSelectionVariant) {
+					var sSelectionVariant = oSelectionVariant.toJSONString(), // create an SV for app state in string format
+						oSelectionVariant = JSON.parse(sSelectionVariant), // convert string into JSON to store in AppState
+						oXAppStateObject = {
+							selectionVariant: oSelectionVariant
+						},
+						oReturn = this.oNavHandler._saveAppStateWithImmediateReturn(oXAppStateObject);
+					return oReturn.appStateKey ? oReturn.appStateKey : "";
+				}
+			},
+
+			/**
+			 * Mix Attributes and selectionVariant.
+			 *
+			 * @param {object|Array} vSemanticAttributes Object/(Array of Objects) containing key/value pairs
+			 * @param {string} sSelectionVariant The selection variant in string format as provided by the SmartFilterBar control
+			 * @param {int} [iSuppressionBehavior=sap.fe.navigation.SuppressionBehavior.standard] Indicates whether semantic
+			 *        attributes with special values (see {@link sap.fe.navigation.SuppressionBehavior suppression behavior}) must be
+			 *        suppressed before they are combined with the selection variant; several
+			 *        {@link sap.fe.navigation.SuppressionBehavior suppression behaviors} can be combined with the bitwise OR operator
+			 *        (|)
+			 * @returns {object} Instance of {@link sap.fe.navigation.SelectionVariant}
+			 */
+			mixAttributesAndSelectionVariant: function(vSemanticAttributes, sSelectionVariant, iSuppressionBehavior) {
+				return this.oNavHandler.mixAttributesAndSelectionVariant(vSemanticAttributes, sSelectionVariant, iSuppressionBehavior);
+			},
+
+			/**
+			 * The method creates a context url based on provided data. This context url can either be used as.
+			 *
+			 * @param {string} sEntitySetName Used for url determination
+			 * @param [oModel] The ODataModel used for url determination. If omitted, the NavigationHandler model is used.
+			 * @returns {string} The context url for the given entities
+			 */
+			constructContextUrl: function(sEntitySetName, oModel) {
+				return this.oNavHandler.constructContextUrl(sEntitySetName, oModel);
+			}
+		});
+
+		function NavigationServicesMock() {
+			this.initPromise = Promise.resolve(this);
+			this.getInterface = function() {
+				return this;
+			};
+
+			function fnGetEmptyObject() {
+				return {};
+			}
+
+			function fnGetPromise() {
+				return Promise.resolve({});
+			}
+
+			function fnGetJQueryPromise() {
+				var oMyDeffered = jQuery.Deferred();
+				oMyDeffered.resolve({}, {}, "initial");
+				return oMyDeffered.promise();
+			}
+
+			function fnGetEmptyString() {
+				return "";
+			}
+
+			// return empty object
+			this.createEmptyAppState = fnGetEmptyObject;
+			this.storeInnerAppStateWithImmediateReturn = fnGetEmptyObject;
+			this.mixAttributesAndSelectionVariant = fnGetEmptyObject;
+
+			// return promise
+			this.getAppState = fnGetPromise;
+			this.getStartupAppState = fnGetPromise;
+			this.parseNavigation = fnGetJQueryPromise;
+
+			// return empty string
+			this.constructContextUrl = fnGetEmptyString;
+
+			this.replaceInnerAppStateKey = function(sAppHash) {
+				return sAppHash ? sAppHash : "";
+			};
+
+			this.navigate = function() {};
+		}
+
+		return ServiceFactory.extend("sap.fe.core.services.NavigationServiceFactory", {
+			createInstance: function(oServiceContext) {
+				var oNavigationService =
+					sap.ushell && sap.ushell.Container ? new NavigationService(oServiceContext) : new NavigationServicesMock();
+				// Wait For init
+				return oNavigationService.initPromise.then(function(oService) {
+					return oService;
+				});
+			}
+		});
+	},
+	true
+);

package/packages/sap.fe.core/src/sap/fe/core/services/NavigationServiceFactory.js

@@ -0,0 +1,6 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
+ */
+sap.ui.define(["sap/ui/core/service/Service","sap/ui/core/service/ServiceFactory","sap/base/Log","sap/fe/navigation/NavigationHandler"],function(S,a,L,N){"use strict";var b=S.extend("sap.fe.core.services.NavigationService",{initPromise:null,init:function(){var C=this.getContext(),o=C&&C.scopeObject;this.oNavHandler=new N(o);this.oNavHandler.setModel(o.getModel());this.initPromise=Promise.resolve(this);},exit:function(){this.oNavHandler.destroy();delete this.oNavHandler;},navigate:function(s,A,n,i,o,e,d){this.oNavHandler.navigate(s,A,n,i,o,e,d);},parseNavigation:function(){return this.oNavHandler.parseNavigation();},_processBeforeSmartLinkPopoverOpens:function(t,s,i){return this.oNavHandler.processBeforeSmartLinkPopoverOpens(t,s,i);},getAppStateKeyAndUrlParameters:function(s){return this.oNavHandler._getAppStateKeyAndUrlParameters(s);},getTechnicalParameters:function(){return this.oNavHandler.getTechnicalParameters();},setTechnicalParameters:function(t){this.oNavHandler.setTechnicalParameters(t);},setModel:function(m){this.oNavHandler.setModel(m);},storeInnerAppState:function(i,I){return this.oNavHandler.storeInnerAppState(i);},storeInnerAppStateWithImmediateReturn:function(i,I,n){return this.oNavHandler.storeInnerAppStateWithImmediateReturn(i,I,n);},replaceHash:function(A){this.oNavHandler.replaceHash(A);},replaceInnerAppStateKey:function(A,s){return this.oNavHandler._replaceInnerAppStateKey(A,s);},getUrlParametersFromSelectionVariant:function(s){return this.oNavHandler._getURLParametersFromSelectionVariant(s);},saveAppStateWithImmediateReturn:function(s){if(s){var d=s.toJSONString(),s=JSON.parse(d),x={selectionVariant:s},r=this.oNavHandler._saveAppStateWithImmediateReturn(x);return r.appStateKey?r.appStateKey:"";}},mixAttributesAndSelectionVariant:function(s,d,i){return this.oNavHandler.mixAttributesAndSelectionVariant(s,d,i);},constructContextUrl:function(e,m){return this.oNavHandler.constructContextUrl(e,m);}});function c(){this.initPromise=Promise.resolve(this);this.getInterface=function(){return this;};function g(){return{};}function G(){return Promise.resolve({});}function f(){var m=jQuery.Deferred();m.resolve({},{},"initial");return m.promise();}function d(){return"";}this.createEmptyAppState=g;this.storeInnerAppStateWithImmediateReturn=g;this.mixAttributesAndSelectionVariant=g;this.getAppState=G;this.getStartupAppState=G;this.parseNavigation=f;this.constructContextUrl=d;this.replaceInnerAppStateKey=function(A){return A?A:"";};this.navigate=function(){};}return a.extend("sap.fe.core.services.NavigationServiceFactory",{createInstance:function(s){var n=sap.ushell&&sap.ushell.Container?new b(s):new c();return n.initPromise.then(function(o){return o;});}});},true);

package/packages/sap.fe.core/src/sap/fe/core/services/ResourceModelServiceFactory-dbg.js

@@ -0,0 +1,84 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
+ */
+sap.ui.define(
+	[
+		"sap/ui/core/service/Service",
+		"sap/ui/core/service/ServiceFactory",
+		"sap/ui/model/resource/ResourceModel",
+		"sap/base/i18n/ResourceBundle"
+	],
+	function(Service, ServiceFactory, ResourceModel, ResourceBundle) {
+		"use strict";
+
+		var ResourceModelService = Service.extend("sap.fe.core.services.ResourceModelService", {
+			initPromise: Promise.resolve(),
+			init: function() {
+				var oContext = this.getContext();
+				var mSettings = oContext.settings;
+				this.oFactory = oContext.factory;
+
+				// When enhancing i18n keys the value in the last resource bundle takes precedence
+				// hence arrange various resource bundles so that enhanceI18n provided by the application is the last.
+				// The following order is used :
+				// 1. sap.fe bundle - sap.fe.core.messagebundle (passed with mSettings.bundles)
+				// 2. sap.fe bundle - sap.fe.templates.messagebundle (passed with mSettings.bundles)
+				// 3. Multiple bundles passed by the application as part of enhanceI18n
+				var aBundles = mSettings.bundles.concat(mSettings.enhanceI18n || []).map(function(vI18n) {
+					// if value passed for enhanceI18n is a Resource Model, return the associated bundle
+					// else the value is a bundleUrl, return Resource Bundle configuration so that a bundle can be created
+					return typeof vI18n.isA === "function" && vI18n.isA("sap.ui.model.resource.ResourceModel")
+						? vI18n.getResourceBundle()
+						: { bundleName: vI18n.replace(/\//g, ".") };
+				});
+
+				this.oResourceModel = new ResourceModel({
+					bundleName: aBundles[0].bundleName,
+					enhanceWith: aBundles.slice(1),
+					async: true
+				});
+
+				if (oContext.scopeType === "component") {
+					var oComponent = oContext.scopeObject;
+					oComponent.setModel(this.oResourceModel, mSettings.modelName);
+				}
+
+				this.initPromise = this.oResourceModel.getResourceBundle().then(
+					function(oBundle) {
+						this.oResourceModel.__bundle = oBundle;
+						return this;
+					}.bind(this)
+				);
+			},
+
+			getResourceModel: function() {
+				return this.oResourceModel;
+			},
+			exit: function() {
+				// Deregister global instance
+				this.oFactory.removeGlobalInstance();
+			}
+		});
+
+		return ServiceFactory.extend("sap.fe.core.services.ResourceModelServiceFactory", {
+			_oInstances: {},
+			createInstance: function(oServiceContext) {
+				var sKey =
+					oServiceContext.settings.bundles.join(",") +
+					(oServiceContext.settings.enhanceI18n ? "," + oServiceContext.settings.enhanceI18n.join(",") : "");
+
+				if (!this._oInstances[sKey]) {
+					this._oInstances[sKey] = new ResourceModelService(Object.assign({ factory: this }, oServiceContext));
+				}
+
+				return this._oInstances[sKey].initPromise;
+			},
+			removeGlobalInstance: function() {
+				this._oInstances = {};
+			}
+		});
+	},
+	true
+);

package/packages/sap.fe.core/src/sap/fe/core/services/ResourceModelServiceFactory.js

@@ -0,0 +1,6 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
+ */
+sap.ui.define(["sap/ui/core/service/Service","sap/ui/core/service/ServiceFactory","sap/ui/model/resource/ResourceModel","sap/base/i18n/ResourceBundle"],function(S,a,R,b){"use strict";var c=S.extend("sap.fe.core.services.ResourceModelService",{initPromise:Promise.resolve(),init:function(){var C=this.getContext();var s=C.settings;this.oFactory=C.factory;var B=s.bundles.concat(s.enhanceI18n||[]).map(function(i){return typeof i.isA==="function"&&i.isA("sap.ui.model.resource.ResourceModel")?i.getResourceBundle():{bundleName:i.replace(/\//g,".")};});this.oResourceModel=new R({bundleName:B[0].bundleName,enhanceWith:B.slice(1),async:true});if(C.scopeType==="component"){var o=C.scopeObject;o.setModel(this.oResourceModel,s.modelName);}this.initPromise=this.oResourceModel.getResourceBundle().then(function(d){this.oResourceModel.__bundle=d;return this;}.bind(this));},getResourceModel:function(){return this.oResourceModel;},exit:function(){this.oFactory.removeGlobalInstance();}});return a.extend("sap.fe.core.services.ResourceModelServiceFactory",{_oInstances:{},createInstance:function(s){var k=s.settings.bundles.join(",")+(s.settings.enhanceI18n?","+s.settings.enhanceI18n.join(","):"");if(!this._oInstances[k]){this._oInstances[k]=new c(Object.assign({factory:this},s));}return this._oInstances[k].initPromise;},removeGlobalInstance:function(){this._oInstances={};}});},true);