@openui5/sap.ui.webc.common 1.115.1 → 1.117.0

package/src/sap/ui/webc/common/thirdparty/base/Device.js

@@ -4,90 +4,167 @@ sap.ui.define(["exports"], function (_exports) {
   Object.defineProperty(_exports, "__esModule", {
     value: true
   });
-  _exports.supportsTouch = _exports.isTablet = _exports.isSafari = _exports.isPhone = _exports.isIOS = _exports.isIE = _exports.isDesktop = _exports.isCombi = _exports.isChrome = _exports.isAndroid = void 0;
-  const ua = navigator.userAgent;
-  const touch = "ontouchstart" in window || navigator.maxTouchPoints > 0;
-  const ie = /(msie|trident)/i.test(ua);
-  const chrome = !ie && /(Chrome|CriOS)/.test(ua);
-  const safari = !ie && !chrome && /(Version|PhantomJS)\/(\d+\.\d+).*Safari/.test(ua);
-  const webkit = !ie && /webkit/.test(ua);
-  const windows = navigator.platform.indexOf("Win") !== -1;
-  const iOS = navigator.platform.match(/iPhone|iPad|iPod/) || navigator.userAgent.match(/Mac/) && "ontouchend" in document;
-  const android = !windows && /Android/.test(ua);
-  const androidPhone = android && /(?=android)(?=.*mobile)/i.test(ua);
-  const ipad = /ipad/i.test(ua) || /Macintosh/i.test(ua) && "ontouchend" in document;
-  // With iOS 13 the string 'iPad' was removed from the user agent string through a browser setting, which is applied on all sites by default:
-  // "Request Desktop Website -> All websites" (for more infos see: https://forums.developer.apple.com/thread/119186).
-  // Therefore the OS is detected as MACINTOSH instead of iOS and the device is a tablet if the Device.support.touch is true.
-
+  _exports.supportsTouch = _exports.isTablet = _exports.isSafari = _exports.isPhone = _exports.isIOS = _exports.isIE = _exports.isFirefox = _exports.isDesktop = _exports.isCombi = _exports.isChrome = _exports.isAndroid = void 0;
+  const isSSR = typeof document === "undefined";
+  const internals = {
+    get userAgent() {
+      if (isSSR) {
+        return "";
+      }
+      return navigator.userAgent;
+    },
+    get touch() {
+      if (isSSR) {
+        return false;
+      }
+      return "ontouchstart" in window || navigator.maxTouchPoints > 0;
+    },
+    get ie() {
+      if (isSSR) {
+        return false;
+      }
+      return /(msie|trident)/i.test(internals.userAgent);
+    },
+    get chrome() {
+      if (isSSR) {
+        return false;
+      }
+      return !internals.ie && /(Chrome|CriOS)/.test(internals.userAgent);
+    },
+    get firefox() {
+      if (isSSR) {
+        return false;
+      }
+      return /Firefox/.test(internals.userAgent);
+    },
+    get safari() {
+      if (isSSR) {
+        return false;
+      }
+      return !internals.ie && !internals.chrome && /(Version|PhantomJS)\/(\d+\.\d+).*Safari/.test(internals.userAgent);
+    },
+    get webkit() {
+      if (isSSR) {
+        return false;
+      }
+      return !internals.ie && /webkit/.test(internals.userAgent);
+    },
+    get windows() {
+      if (isSSR) {
+        return false;
+      }
+      return navigator.platform.indexOf("Win") !== -1;
+    },
+    get iOS() {
+      if (isSSR) {
+        return false;
+      }
+      return !!navigator.platform.match(/iPhone|iPad|iPod/) || !!(internals.userAgent.match(/Mac/) && "ontouchend" in document);
+    },
+    get android() {
+      if (isSSR) {
+        return false;
+      }
+      return !internals.windows && /Android/.test(internals.userAgent);
+    },
+    get androidPhone() {
+      if (isSSR) {
+        return false;
+      }
+      return internals.android && /(?=android)(?=.*mobile)/i.test(internals.userAgent);
+    },
+    get ipad() {
+      if (isSSR) {
+        return false;
+      }
+      // With iOS 13 the string 'iPad' was removed from the user agent string through a browser setting, which is applied on all sites by default:
+      // "Request Desktop Website -> All websites" (for more infos see: https://forums.developer.apple.com/thread/119186).
+      // Therefore the OS is detected as MACINTOSH instead of iOS and the device is a tablet if the Device.support.touch is true.
+      return /ipad/i.test(internals.userAgent) || /Macintosh/i.test(internals.userAgent) && "ontouchend" in document;
+    }
+  };
   let windowsVersion;
   let webkitVersion;
   let tablet;
   const isWindows8OrAbove = () => {
-    if (!windows) {
+    if (isSSR) {
+      return false;
+    }
+    if (!internals.windows) {
       return false;
     }
     if (windowsVersion === undefined) {
-      const matches = ua.match(/Windows NT (\d+).(\d)/);
+      const matches = internals.userAgent.match(/Windows NT (\d+).(\d)/);
       windowsVersion = matches ? parseFloat(matches[1]) : 0;
     }
     return windowsVersion >= 8;
   };
   const isWebkit537OrAbove = () => {
-    if (!webkit) {
+    if (isSSR) {
+      return false;
+    }
+    if (!internals.webkit) {
       return false;
     }
     if (webkitVersion === undefined) {
-      const matches = ua.match(/(webkit)[ /]([\w.]+)/);
+      const matches = internals.userAgent.match(/(webkit)[ /]([\w.]+)/);
       webkitVersion = matches ? parseFloat(matches[1]) : 0;
     }
     return webkitVersion >= 537.10;
   };
   const detectTablet = () => {
+    if (isSSR) {
+      return false;
+    }
     if (tablet !== undefined) {
       return;
     }
-    if (ipad) {
+    if (internals.ipad) {
       tablet = true;
       return;
     }
-    if (touch) {
+    if (internals.touch) {
       if (isWindows8OrAbove()) {
         tablet = true;
         return;
       }
-      if (chrome && android) {
-        tablet = !/Mobile Safari\/[.0-9]+/.test(ua);
+      if (internals.chrome && internals.android) {
+        tablet = !/Mobile Safari\/[.0-9]+/.test(internals.userAgent);
         return;
       }
       let densityFactor = window.devicePixelRatio ? window.devicePixelRatio : 1; // may be undefined in Windows Phone devices
-      if (android && isWebkit537OrAbove()) {
+      if (internals.android && isWebkit537OrAbove()) {
         densityFactor = 1;
       }
       tablet = Math.min(window.screen.width / densityFactor, window.screen.height / densityFactor) >= 600;
       return;
     }
-    tablet = ie && ua.indexOf("Touch") !== -1 || android && !androidPhone;
+    tablet = internals.ie && internals.userAgent.indexOf("Touch") !== -1 || internals.android && !internals.androidPhone;
   };
-  const supportsTouch = () => touch;
+  const supportsTouch = () => internals.touch;
   _exports.supportsTouch = supportsTouch;
-  const isIE = () => ie;
+  const isIE = () => internals.ie;
   _exports.isIE = isIE;
-  const isSafari = () => safari;
+  const isSafari = () => internals.safari;
   _exports.isSafari = isSafari;
-  const isChrome = () => chrome;
+  const isChrome = () => internals.chrome;
   _exports.isChrome = isChrome;
+  const isFirefox = () => internals.firefox;
+  _exports.isFirefox = isFirefox;
   const isTablet = () => {
     detectTablet();
-    return (touch || isWindows8OrAbove()) && tablet;
+    return (internals.touch || isWindows8OrAbove()) && tablet;
   };
   _exports.isTablet = isTablet;
   const isPhone = () => {
     detectTablet();
-    return touch && !tablet;
+    return internals.touch && !tablet;
   };
   _exports.isPhone = isPhone;
   const isDesktop = () => {
+    if (isSSR) {
+      return false;
+    }
     return !isTablet() && !isPhone() || isWindows8OrAbove();
   };
   _exports.isDesktop = isDesktop;
@@ -96,11 +173,11 @@ sap.ui.define(["exports"], function (_exports) {
   };
   _exports.isCombi = isCombi;
   const isIOS = () => {
-    return iOS;
+    return internals.iOS;
   };
   _exports.isIOS = isIOS;
   const isAndroid = () => {
-    return android || androidPhone;
+    return internals.android || internals.androidPhone;
   };
   _exports.isAndroid = isAndroid;
 });

package/src/sap/ui/webc/common/thirdparty/base/EventProvider.js

@@ -34,7 +34,6 @@ sap.ui.define(["exports"], function (_exports) {
         eventRegistry.delete(eventName);
       }
     }
-
     /**
      * Fires an event and returns the results of all event listeners as an array.
      *
@@ -49,10 +48,9 @@ sap.ui.define(["exports"], function (_exports) {
         return [];
       }
       return eventListeners.map(fn => {
-        return fn.call(this, data); // eslint-disable-line
+        return fn.call(this, data);
       });
     }
-
     /**
      * Fires an event and returns a promise that will resolve once all listeners have resolved.
      *

package/src/sap/ui/webc/common/thirdparty/base/FontFace.js

@@ -9,13 +9,11 @@ sap.ui.define(["exports", "./ManagedStyles", "./FeaturesRegistry", "./generated/
   _OverrideFontFace = _interopRequireDefault(_OverrideFontFace);
   function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
   const insertFontFace = () => {
-    const OpenUI5Support = (0, _FeaturesRegistry.getFeature)("OpenUI5Support");
-
+    const openUI5Support = (0, _FeaturesRegistry.getFeature)("OpenUI5Support");
     // Only set the main font if there is no OpenUI5 support, or there is, but OpenUI5 is not loaded
-    if (!OpenUI5Support || !OpenUI5Support.isLoaded()) {
+    if (!openUI5Support || !openUI5Support.isLoaded()) {
       insertMainFontFace();
     }
-
     // Always set the override font - OpenUI5 in CSS Vars mode does not set it, unlike the main font
     insertOverrideFontFace();
   };

package/src/sap/ui/webc/common/thirdparty/base/IgnoreCustomElements.js

@@ -0,0 +1,47 @@
+sap.ui.define(["exports"], function (_exports) {
+  "use strict";
+
+  Object.defineProperty(_exports, "__esModule", {
+    value: true
+  });
+  _exports.shouldIgnoreCustomElement = _exports.ignoreCustomElements = void 0;
+  /**
+   * The tag prefixes to be ignored.
+   */
+  const tagPrefixes = [];
+  /**
+   * Ignores all custom HTML elements with a given tag prefix to improve the rendering performance of the UI5 Web Components.
+   * <br>
+   *
+   * <b>When used:</b> the UI5 Web Components framework treats all custom HTML elements,
+   * starting with the given prefix as if they are standard HTML elements, such as: `div`, `span`, etc, without additional processing.
+   * <br>
+   *
+   * <b>When not used:</b> the framework waits for the slotted children to be defined and registered first,
+   * because the state or visual appearance of the parent may rely on the slotted elements/children.
+   *
+   * <b>Note:</b> We recommend using `ignoreCustomElements` when slotting custom HTML elements (with only semantic purpose)
+   * inside UI5 Web Components, to improve the time to render.
+   *
+   * @public
+   * @since 1.14.0
+   * @param { string } tagPrefix
+   */
+  const ignoreCustomElements = tagPrefix => {
+    if (typeof tagPrefix !== "string" || !tagPrefix.length) {
+      throw new Error("Only string characters for a tag prefix.");
+    }
+    tagPrefixes.push(tagPrefix);
+  };
+  /**
+   * Determines whether custom elements with the given tag should be ignored.
+   *
+   * @private
+   * @param { string } tag
+   */
+  _exports.ignoreCustomElements = ignoreCustomElements;
+  const shouldIgnoreCustomElement = tag => {
+    return tagPrefixes.some(pref => tag.startsWith(pref));
+  };
+  _exports.shouldIgnoreCustomElement = shouldIgnoreCustomElement;
+});

package/src/sap/ui/webc/common/thirdparty/base/InitialConfiguration.js

@@ -1,25 +1,27 @@
-sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generated/AssetParameters"], function (_exports, _merge, _FeaturesRegistry, _AssetParameters) {
+sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generated/AssetParameters", "./validateThemeRoot", "./types/AnimationMode"], function (_exports, _merge, _FeaturesRegistry, _AssetParameters, _validateThemeRoot, _AnimationMode) {
   "use strict";
 
   Object.defineProperty(_exports, "__esModule", {
     value: true
   });
-  _exports.getTheme = _exports.getRTL = _exports.getNoConflict = _exports.getLanguage = _exports.getFormatSettings = _exports.getFetchDefaultLanguage = _exports.getCalendarType = _exports.getAnimationMode = void 0;
+  _exports.getTimezone = _exports.getThemeRoot = _exports.getTheme = _exports.getRTL = _exports.getNoConflict = _exports.getLanguage = _exports.getFormatSettings = _exports.getFetchDefaultLanguage = _exports.getCalendarType = _exports.getAnimationMode = void 0;
   _merge = _interopRequireDefault(_merge);
+  _validateThemeRoot = _interopRequireDefault(_validateThemeRoot);
+  _AnimationMode = _interopRequireDefault(_AnimationMode);
   function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
   let initialized = false;
   let initialConfig = {
-    animationMode: "full",
+    animationMode: _AnimationMode.default.Full,
     theme: _AssetParameters.DEFAULT_THEME,
-    rtl: null,
-    language: null,
-    calendarType: null,
+    themeRoot: undefined,
+    rtl: undefined,
+    language: undefined,
+    timezone: undefined,
+    calendarType: undefined,
     noConflict: false,
-    // no URL
     formatSettings: {},
     fetchDefaultLanguage: false
   };
-
   /* General settings */
   const getAnimationMode = () => {
     initConfiguration();
@@ -31,6 +33,11 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
     return initialConfig.theme;
   };
   _exports.getTheme = getTheme;
+  const getThemeRoot = () => {
+    initConfiguration();
+    return initialConfig.themeRoot;
+  };
+  _exports.getThemeRoot = getThemeRoot;
   const getRTL = () => {
     initConfiguration();
     return initialConfig.rtl;
@@ -40,7 +47,6 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
     initConfiguration();
     return initialConfig.language;
   };
-
   /**
    * Returns if the default language, that is inlined at build time,
    * should be fetched over the network instead.
@@ -56,12 +62,25 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
     initConfiguration();
     return initialConfig.noConflict;
   };
+  /**
+   * Get the configured calendar type
+   * @returns { String } the name of the configured calendar type
+   */
   _exports.getNoConflict = getNoConflict;
   const getCalendarType = () => {
     initConfiguration();
     return initialConfig.calendarType;
   };
+  /**
+   * Returns the configured IANA timezone ID.
+   * @returns { String } the configured IANA timezone ID, e.g. "America/New_York"
+   */
   _exports.getCalendarType = getCalendarType;
+  const getTimezone = () => {
+    initConfiguration();
+    return initialConfig.timezone;
+  };
+  _exports.getTimezone = getTimezone;
   const getFormatSettings = () => {
     initConfiguration();
     return initialConfig.formatSettings;
@@ -72,7 +91,6 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
   booleanMapping.set("false", false);
   const parseConfigurationScript = () => {
     const configScript = document.querySelector("[data-ui5-config]") || document.querySelector("[data-id='sap-ui-config']"); // for backward compatibility
-
     let configJSON;
     if (configScript) {
       try {
@@ -88,7 +106,6 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
   };
   const parseURLParameters = () => {
     const params = new URLSearchParams(window.location.search);
-
     // Process "sap-*" params first
     params.forEach((value, key) => {
       const parts = key.split("sap-").length;
@@ -97,7 +114,6 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
       }
       applyURLParam(key, value, "sap");
     });
-
     // Process "sap-ui-*" params
     params.forEach((value, key) => {
       if (!key.startsWith("sap-ui")) {
@@ -106,7 +122,11 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
       applyURLParam(key, value, "sap-ui");
     });
   };
-  const normalizeParamValue = (param, value) => {
+  const normalizeThemeRootParamValue = value => {
+    const themeRoot = value.split("@")[1];
+    return (0, _validateThemeRoot.default)(themeRoot);
+  };
+  const normalizeThemeParamValue = (param, value) => {
     if (param === "theme" && value.includes("@")) {
       // the theme parameter might have @<URL-TO-THEME> in the value - strip this
       return value.split("@")[0];
@@ -119,28 +139,31 @@ sap.ui.define(["exports", "./thirdparty/merge", "./FeaturesRegistry", "./generat
     if (booleanMapping.has(value)) {
       value = booleanMapping.get(lowerCaseValue);
     }
-    value = normalizeParamValue(param, value);
-    initialConfig[param] = value;
+    if (param === "theme") {
+      initialConfig.theme = normalizeThemeParamValue(param, value);
+      if (value && value.includes("@")) {
+        initialConfig.themeRoot = normalizeThemeRootParamValue(value);
+      }
+    } else {
+      initialConfig[param] = value;
+    }
   };
   const applyOpenUI5Configuration = () => {
-    const OpenUI5Support = (0, _FeaturesRegistry.getFeature)("OpenUI5Support");
-    if (!OpenUI5Support || !OpenUI5Support.isLoaded()) {
+    const openUI5Support = (0, _FeaturesRegistry.getFeature)("OpenUI5Support");
+    if (!openUI5Support || !openUI5Support.isLoaded()) {
       return;
     }
-    const OpenUI5Config = OpenUI5Support.getConfigurationSettingsObject();
+    const OpenUI5Config = openUI5Support.getConfigurationSettingsObject();
     initialConfig = (0, _merge.default)(initialConfig, OpenUI5Config);
   };
   const initConfiguration = () => {
-    if (initialized) {
+    if (typeof document === "undefined" || initialized) {
       return;
     }
-
     // 1. Lowest priority - configuration script
     parseConfigurationScript();
-
     // 2. URL parameters overwrite configuration script parameters
     parseURLParameters();
-
     // 3. If OpenUI5 is detected, it has the highest priority
     applyOpenUI5Configuration();
     initialized = true;