@openui5/sap.ui.webc.common 1.117.1 → 1.119.0

package/src/sap/ui/webc/common/WebComponentMetadata.js

@@ -6,248 +6,36 @@
 
 // Provides class sap.ui.webc.common.WebComponentMetadata
 sap.ui.define([
-		"sap/ui/core/ElementMetadata",
-		"./WebComponentRenderer",
-		"sap/base/strings/camelize"
-	],
-	function(ElementMetadata, WebComponentRenderer, camelize) {
-		"use strict";
-
-		var MAPPING_TYPES = ["attribute", "style", "textContent", "slot", "none"];
-
-		/**
-		 * Creates a new metadata object for a WebComponent Wrapper subclass.
-		 *
-		 * @param {string} sClassName fully qualified name of the class that is described by this metadata object
-		 * @param {object} oClassInfo static info to construct the metadata from
-		 *
-		 * @class
-		 * @author SAP SE
-		 * @version 1.117.1
-		 * @since 1.92.0
-		 * @experimental Since 1.92.0 The API might change. It is not intended for productive usage yet!
-		 * @alias sap.ui.webc.common.WebComponentMetadata
-		 * @extends sap.ui.core.ElementMetadata
-		 * @public
-		 */
-		var WebComponentMetadata = function(sClassName, oClassInfo) {
-			// call super constructor
-			ElementMetadata.apply(this, arguments);
-		};
-
-		//chain the prototypes
-		WebComponentMetadata.prototype = Object.create(ElementMetadata.prototype);
-		WebComponentMetadata.prototype.constructor = WebComponentMetadata;
-
-		// mapping validation function
-		var fnValidateType = function (sType) {
-			return MAPPING_TYPES.includes(sType) ? sType : MAPPING_TYPES[0];
-		};
-
-		// Enrich property factory
-		var OriginalProperty = ElementMetadata.prototype.metaFactoryProperty;
-		var WebComponentProperty = function(oClass, name, info) {
-			OriginalProperty.apply(this, arguments);
-
-			if (!info.mapping || typeof info.mapping === "string") {
-				this._sMapping = fnValidateType(info.mapping);
-			} else if (typeof info.mapping === "object") {
-				this._sMapping = fnValidateType(info.mapping.type);
-				this._sMapTo = info.mapping.to;
-				this._fnMappingFormatter = info.mapping.formatter;
-			}
-		};
-		WebComponentProperty.prototype = Object.create(OriginalProperty.prototype);
-		WebComponentProperty.prototype.constructor = WebComponentProperty;
-		WebComponentMetadata.prototype.metaFactoryProperty = WebComponentProperty;
-
-		// Enrich aggregation factory
-		var OriginalAggregation = ElementMetadata.prototype.metaFactoryAggregation;
-		var WebComponentAggregation = function(oClass, name, info) {
-			OriginalAggregation.apply(this, arguments);
-			this._sSlot = info.slot || "";
-		};
-		WebComponentAggregation.prototype = Object.create(OriginalAggregation.prototype);
-		WebComponentAggregation.prototype.constructor = WebComponentAggregation;
-		WebComponentMetadata.prototype.metaFactoryAggregation = WebComponentAggregation;
-
-		// Enrich association factory
-		var OriginalAssociation = ElementMetadata.prototype.metaFactoryAssociation;
-		var WebComponentAssociation = function(oClass, name, info) {
-			OriginalAssociation.apply(this, arguments);
-			if (!info.mapping || typeof info.mapping !== "object") {
-				this._sMapping = ""; // For associations, "mapping" must be an object, because "to" is required
-			} else {
-				this._sMapping = "property"; // Associations map only to properties, no matter what is set, it's always "property" mapping
-				this._sMapTo = info.mapping.to; // The property, to which the association is related
-				this._fnMappingFormatter = info.mapping.formatter;
-			}
-		};
-		WebComponentAssociation.prototype = Object.create(OriginalAssociation.prototype);
-		WebComponentAssociation.prototype.constructor = WebComponentAssociation;
-		WebComponentMetadata.prototype.metaFactoryAssociation = WebComponentAssociation;
-
-		WebComponentMetadata.prototype.applySettings = function(oClassInfo) {
-			var oStaticInfo = oClassInfo.metadata;
-
-			this._sTag = oStaticInfo.tag;
-			this._aMethods = oStaticInfo.methods || [];
-			this._aGetters = oStaticInfo.getters || [];
-
-			ElementMetadata.prototype.applySettings.call(this, oClassInfo);
-		};
-
-		WebComponentMetadata.prototype.generateAccessors = function() {
-			ElementMetadata.prototype.generateAccessors.call(this);
-			var proto = this.getClass().prototype;
-
-			// Generate accessors for proxied public methods - only if not created explicitly already
-			this._aMethods.forEach(function(name) {
-				if (!proto[name]) {
-					proto[name] = function() {
-						return this.__callPublicMethod(name, arguments);
-					};
-				}
-			});
-
-			// Generate accessors for proxied public getters - only if not created explicitly already
-			this._aGetters.forEach(function(name) {
-				var functionName = "get" + name.substr(0, 1).toUpperCase() + name.substr(1);
-				if (!proto[functionName]) {
-					proto[functionName] = function() {
-						return this.__callPublicGetter(name);
-					};
-				}
-			});
-		};
-
-		/**
-		 * Returns the tag, used to render the Component Wrapper
-		 * @public
-		 * @returns {string}
-		 */
-		WebComponentMetadata.prototype.getTag = function() {
-			return this._sTag;
-		};
-
-		/**
-		 * Returns the list of public methods, proxied by the Component Wrapper to the component itself
-		 * @public
-		 * @returns {Array}
-		 */
-		WebComponentMetadata.prototype.getMethods = function() {
-			return this._aMethods;
-		};
-
-		/**
-		 * Returns the list of public getters, proxied by the Component Wrapper to the component itself
-		 * @public
-		 * @returns {Array}
-		 */
-		WebComponentMetadata.prototype.getGetters = function() {
-			return this._aGetters;
-		};
-
-		/**
-		 * Returns the slot to be assigned to a particular aggregation's items
-		 * @private
-		 */
-		WebComponentMetadata.prototype.getAggregationSlot = function(sAggregationName) {
-			var oAggregation = this._mAllAggregations[sAggregationName];
-			return oAggregation ? oAggregation._sSlot : undefined;
-		};
-
-		/**
-		 * Determines whether the attribute corresponds to a managed property
-		 * @param sAttr the attribute's name
-		 * @returns {boolean}
-		 */
-		WebComponentMetadata.prototype.isManagedAttribute = function(sAttr) {
-			var mProperties = this.getAllProperties();
-			for (var propName in mProperties) {
-				if (mProperties.hasOwnProperty(propName)) {
-					var propData = mProperties[propName];
-					if (propData._sMapping === "attribute" && (propData._sMapTo === sAttr || camelize(sAttr) === propName)) {
-						return true;
-					}
-				}
-			}
-
-			var mAssociations = this.getAllAssociations();
-			for (var sAssocName in mAssociations) {
-				if (mAssociations.hasOwnProperty(sAssocName)) {
-					var oAssocData = mAssociations[sAssocName];
-					if (oAssocData._sMapping === "property" && oAssocData._sMapTo === camelize(sAttr)) {
-						return true;
-					}
-				}
-			}
-
-			return false;
-		};
-
-		/**
-		 * Returns a map, containing all properties of a certain mapping type
-		 * @param sMapping
-		 * @returns {Object}
-		 */
-		WebComponentMetadata.prototype.getPropertiesByMapping = function(sMapping) {
-			var mFiltered = {};
-			var mProperties = this.getAllProperties();
-			var mPrivateProperties = this.getAllPrivateProperties();
-			for (var propName in mProperties) {
-				if (mProperties.hasOwnProperty(propName)) {
-					var propData = mProperties[propName];
-					if (propData._sMapping === sMapping) {
-						mFiltered[propName] = propData;
-					}
-				}
-			}
-
-			for (var propName in mPrivateProperties) {
-				if (mPrivateProperties.hasOwnProperty(propName)) {
-					var propData = mPrivateProperties[propName];
-					if (propData._sMapping === sMapping) {
-						mFiltered[propName] = propData;
-					}
-				}
-			}
-
-			return mFiltered;
-		};
-
-		/**
-		 * Returns a map of all associations that control properties (have mapping to properties)
-		 * returns {Object}
-		 */
-		WebComponentMetadata.prototype.getAssociationsWithMapping = function() {
-			var mFiltered = {};
-			var mAssociations = this.getAllAssociations();
-			for (var sAssocName in mAssociations) {
-				if (mAssociations.hasOwnProperty(sAssocName)) {
-					var oAssocData = mAssociations[sAssocName];
-					if (oAssocData._sMapping) {
-						mFiltered[sAssocName] = oAssocData;
-					}
-				}
-			}
-
-			return mFiltered;
-		};
-
-		/**
-		 * Retrieves the renderer for the described web component class.
-		 * Note: this is always the default renderer and Web Component wrappers should not define their own renderers.
-		 * @public
-		 */
-		WebComponentMetadata.prototype.getRenderer = function() {
-			if (this._oRenderer) {
-				return this._oRenderer;
-			}
-
-			return WebComponentRenderer;
-		};
-
-		return WebComponentMetadata;
-
-	});
+	"sap/ui/core/webc/WebComponentMetadata"
+],
+function(CoreWebComponentMetadata) {
+	"use strict";
+
+	/**
+	 * Creates a new metadata object for a WebComponent Wrapper subclass.
+	 *
+	 * @param {string} sClassName fully qualified name of the class that is described by this metadata object
+	 * @param {object} oClassInfo static info to construct the metadata from
+	 *
+	 * @class
+	 * @author SAP SE
+	 * @version 1.119.0
+	 * @since 1.92.0
+	 * @experimental Since 1.92.0 The API might change. It is not intended for productive usage yet!
+	 * @deprecated Since 1.118.0 Use sap.ui.core.webc.WebComponentMetadata instead!
+	 * @alias sap.ui.webc.common.WebComponentMetadata
+	 * @extends sap.ui.core.webc.WebComponentMetadata
+	 * @public
+	 */
+	var WebComponentMetadata = function(sClassName, oClassInfo) {
+		// call super constructor
+		CoreWebComponentMetadata.apply(this, arguments);
+	};
+
+	//chain the prototypes
+	WebComponentMetadata.prototype = Object.create(CoreWebComponentMetadata.prototype);
+	WebComponentMetadata.prototype.constructor = WebComponentMetadata;
+
+	return WebComponentMetadata;
+
+});

package/src/sap/ui/webc/common/library.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @namespace
 	 * @name sap.ui.webc
 	 * @author SAP SE
-	 * @version 1.117.1
+	 * @version 1.119.0
 	 * @public
 	 * @since 1.92.0
 	 * @experimental Since 1.92.0
@@ -41,14 +41,14 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.webc.common
 	 * @author SAP SE
-	 * @version 1.117.1
+	 * @version 1.119.0
 	 * @public
 	 * @since 1.92.0
 	 * @experimental Since 1.92.0
 	 */
 	var thisLib = Library.init({
 		name : "sap.ui.webc.common",
-		version: "1.117.1",
+		version: "1.119.0",
 		dependencies : ["sap.ui.core"],
 		noLibraryCSS: true,
 		designtime: "sap/ui/webc/common/designtime/library.designtime",

package/src/sap/ui/webc/common/thirdparty/base/config/Theme.js

@@ -1,81 +1,52 @@
-sap.ui.define(["exports", "../InitialConfiguration", "../Render", "../theming/applyTheme", "../theming/getThemeDesignerTheme", "../generated/AssetParameters"], function (_exports, _InitialConfiguration, _Render, _applyTheme, _getThemeDesignerTheme, _AssetParameters) {
-  "use strict";
-
-  Object.defineProperty(_exports, "__esModule", {
-    value: true
-  });
-  _exports.setTheme = _exports.isTheme = _exports.isLegacyThemeFamily = _exports.getTheme = _exports.getDefaultTheme = void 0;
-  _applyTheme = _interopRequireDefault(_applyTheme);
-  _getThemeDesignerTheme = _interopRequireDefault(_getThemeDesignerTheme);
-  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-  let curTheme;
-  /**
-   * Returns the current theme.
-   * @public
-   * @returns {string} the current theme name
-   */
-  const getTheme = () => {
-    if (curTheme === undefined) {
-      curTheme = (0, _InitialConfiguration.getTheme)();
+sap.ui.define([
+    'exports',
+    '../InitialConfiguration',
+    '../Render',
+    '../theming/applyTheme',
+    '../theming/getThemeDesignerTheme',
+    '../generated/AssetParameters'
+], function (_exports, _InitialConfiguration, _Render, _applyTheme, _getThemeDesignerTheme, _AssetParameters) {
+    'use strict';
+    Object.defineProperty(_exports, '__esModule', { value: true });
+    _exports.setTheme = _exports.isTheme = _exports.isLegacyThemeFamily = _exports.getTheme = _exports.getDefaultTheme = void 0;
+    _applyTheme = _interopRequireDefault(sap.ui.require('sap/ui/webc/common/thirdparty/base/theming/applyTheme'));
+    _getThemeDesignerTheme = _interopRequireDefault(_getThemeDesignerTheme);
+    function _interopRequireDefault(obj) {
+        return obj && obj.__esModule ? obj : { default: obj };
     }
-    return curTheme;
-  };
-  /**
-   * Applies a new theme after fetching its assets from the network.
-   * @public
-   * @param {string} theme the name of the new theme
-   * @returns {Promise<void>} a promise that is resolved when the new theme assets have been fetched and applied to the DOM
-   */
-  _exports.getTheme = getTheme;
-  const setTheme = async theme => {
-    if (curTheme === theme) {
-      return;
-    }
-    curTheme = theme;
-    // Update CSS Custom Properties
-    await (0, _applyTheme.default)(curTheme);
-    await (0, _Render.reRenderAllUI5Elements)({
-      themeAware: true
-    });
-  };
-  /**
-   * Returns the default theme.
-   *
-   * Note: Default theme might be different than the configurated one.
-   *
-   * @public
-   * @returns {string}
-   */
-  _exports.setTheme = setTheme;
-  const getDefaultTheme = () => {
-    return _AssetParameters.DEFAULT_THEME;
-  };
-  /**
-   * Returns if the given theme name is the one currently applied.
-   * @private
-   * @param {string} theme
-   * @returns {boolean}
-   */
-  _exports.getDefaultTheme = getDefaultTheme;
-  const isTheme = theme => {
-    const currentTheme = getTheme();
-    return currentTheme === theme || currentTheme === `${theme}_exp`;
-  };
-  /**
-   * Returns if the currently set theme is part of legacy theme families ("sap_belize" or "sap_fiori_3").
-   * <b>Note</b>: in addition, the method checks the base theme of a custom theme, built via the ThemeDesigner.
-   *
-   * @private
-   * @returns { boolean }
-   */
-  _exports.isTheme = isTheme;
-  const isLegacyThemeFamily = () => {
-    const currentTheme = getTheme();
-    if (!isKnownTheme(currentTheme)) {
-      return !(0, _getThemeDesignerTheme.default)()?.baseThemeName?.startsWith("sap_horizon");
-    }
-    return !currentTheme.startsWith("sap_horizon");
-  };
-  _exports.isLegacyThemeFamily = isLegacyThemeFamily;
-  const isKnownTheme = theme => _AssetParameters.SUPPORTED_THEMES.includes(theme);
+    let curTheme;
+    const getTheme = () => {
+        if (curTheme === undefined) {
+            curTheme = (0, _InitialConfiguration.getTheme)();
+        }
+        return curTheme;
+    };
+    _exports.getTheme = getTheme;
+    const setTheme = async theme => {
+        if (curTheme === theme) {
+            return;
+        }
+        curTheme = theme;
+        await (0, sap.ui.require('sap/ui/webc/common/thirdparty/base/theming/applyTheme').default)(curTheme);
+        await (0, _Render.reRenderAllUI5Elements)({ themeAware: true });
+    };
+    _exports.setTheme = setTheme;
+    const getDefaultTheme = () => {
+        return _AssetParameters.DEFAULT_THEME;
+    };
+    _exports.getDefaultTheme = getDefaultTheme;
+    const isTheme = theme => {
+        const currentTheme = getTheme();
+        return currentTheme === theme || currentTheme === `${ theme }_exp`;
+    };
+    _exports.isTheme = isTheme;
+    const isLegacyThemeFamily = () => {
+        const currentTheme = getTheme();
+        if (!isKnownTheme(currentTheme)) {
+            return !(0, _getThemeDesignerTheme.default)()?.baseThemeName?.startsWith('sap_horizon');
+        }
+        return !currentTheme.startsWith('sap_horizon');
+    };
+    _exports.isLegacyThemeFamily = isLegacyThemeFamily;
+    const isKnownTheme = theme => _AssetParameters.SUPPORTED_THEMES.includes(theme);
 });

package/src/sap/ui/webc/common/thirdparty/base/config/ThemeRoot.js

@@ -1,70 +1,47 @@
-sap.ui.define(["exports", "../util/createLinkInHead", "../validateThemeRoot", "../InitialConfiguration", "./Theme"], function (_exports, _createLinkInHead, _validateThemeRoot, _InitialConfiguration, _Theme) {
-  "use strict";
-
-  Object.defineProperty(_exports, "__esModule", {
-    value: true
-  });
-  _exports.setThemeRoot = _exports.getThemeRoot = _exports.attachCustomThemeStylesToHead = void 0;
-  _createLinkInHead = _interopRequireDefault(_createLinkInHead);
-  _validateThemeRoot = _interopRequireDefault(_validateThemeRoot);
-  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-  let currThemeRoot;
-  /**
-   * Returns the current theme root.
-   *
-   * @public
-   * @since 1.14.0
-   * @returns { string } the current theme root
-   */
-  const getThemeRoot = () => {
-    if (currThemeRoot === undefined) {
-      currThemeRoot = (0, _InitialConfiguration.getThemeRoot)();
+sap.ui.define([
+    'exports',
+    '../util/createLinkInHead',
+    '../validateThemeRoot',
+    '../InitialConfiguration',
+    './Theme'
+], function (_exports, _createLinkInHead, _validateThemeRoot, _InitialConfiguration, _Theme) {
+    'use strict';
+    Object.defineProperty(_exports, '__esModule', { value: true });
+    _exports.setThemeRoot = _exports.getThemeRoot = _exports.attachCustomThemeStylesToHead = void 0;
+    _createLinkInHead = _interopRequireDefault(_createLinkInHead);
+    _validateThemeRoot = _interopRequireDefault(_validateThemeRoot);
+    function _interopRequireDefault(obj) {
+        return obj && obj.__esModule ? obj : { default: obj };
     }
-    return currThemeRoot;
-  };
-  /**
-   * Sets theme root for the current theme.
-   * When set, the framework will validate the theme root and fetch the theme styles (CSS variables) from this location.
-   *
-   * <b>Note:</b> The feature is specific to custom themes, created with the `UI Theme Designer`.
-   * The provided theme root is used only as a base to construct the actual location of the theme styles: `{themeRoot}/.../css_variables.css`.
-   *
-   * <br/>
-   *
-   * <b>Note:</b> Certain security restrictions will apply before fetching the theme assets.
-   * Absolute URLs to a different origin than the current page will result in using the current page as an origin.
-   * To allow specific origins, use &lt;meta name="sap-allowedThemeOrigins" content="https://my-example-host.com/"&gt; tag inside the &lt;head&gt; of the page.
-   *
-   * @public
-   * @since 1.14.0
-   * @param { string } themeRoot the new theme root
-   * @returns { Promise<void> }
-   */
-  _exports.getThemeRoot = getThemeRoot;
-  const setThemeRoot = themeRoot => {
-    if (currThemeRoot === themeRoot) {
-      return;
-    }
-    currThemeRoot = themeRoot;
-    if (!(0, _validateThemeRoot.default)(themeRoot)) {
-      console.warn(`The ${themeRoot} is not valid. Check the allowed origins as suggested in the "setThemeRoot" description.`); // eslint-disable-line
-      return;
-    }
-    return attachCustomThemeStylesToHead((0, _Theme.getTheme)());
-  };
-  _exports.setThemeRoot = setThemeRoot;
-  const formatThemeLink = theme => {
-    return `${getThemeRoot()}Base/baseLib/${theme}/css_variables.css`; // theme root is always set at this point.
-  };
-
-  const attachCustomThemeStylesToHead = async theme => {
-    const link = document.querySelector(`[sap-ui-webcomponents-theme="${theme}"]`);
-    if (link) {
-      document.head.removeChild(link);
-    }
-    await (0, _createLinkInHead.default)(formatThemeLink(theme), {
-      "sap-ui-webcomponents-theme": theme
-    });
-  };
-  _exports.attachCustomThemeStylesToHead = attachCustomThemeStylesToHead;
+    let currThemeRoot;
+    const getThemeRoot = () => {
+        if (currThemeRoot === undefined) {
+            currThemeRoot = (0, _InitialConfiguration.getThemeRoot)();
+        }
+        return currThemeRoot;
+    };
+    _exports.getThemeRoot = getThemeRoot;
+    const setThemeRoot = themeRoot => {
+        if (currThemeRoot === themeRoot) {
+            return;
+        }
+        currThemeRoot = themeRoot;
+        if (!(0, _validateThemeRoot.default)(themeRoot)) {
+            console.warn(`The ${ themeRoot } is not valid. Check the allowed origins as suggested in the "setThemeRoot" description.`);
+            return;
+        }
+        return attachCustomThemeStylesToHead((0, sap.ui.require('sap/ui/webc/common/thirdparty/base/config/Theme').getTheme)());
+    };
+    _exports.setThemeRoot = setThemeRoot;
+    const formatThemeLink = theme => {
+        return `${ getThemeRoot() }Base/baseLib/${ theme }/css_variables.css`;
+    };
+    const attachCustomThemeStylesToHead = async theme => {
+        const link = document.querySelector(`[sap-ui-webcomponents-theme="${ theme }"]`);
+        if (link) {
+            document.head.removeChild(link);
+        }
+        await (0, _createLinkInHead.default)(formatThemeLink(theme), { 'sap-ui-webcomponents-theme': theme });
+    };
+    _exports.attachCustomThemeStylesToHead = attachCustomThemeStylesToHead;
 });