@ui5/webcomponents-localization 0.0.0-f651a470c → 0.0.0-f6676abdd

package/dist/sap/base/util/Version.js

@@ -0,0 +1,157 @@
+// @evo-todo make it a simple object with immutable properties (Object.defineProperties)
+
+// -------------------------- VERSION -------------------------------------
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+var rVersion = /^[0-9]+(?:\.([0-9]+)(?:\.([0-9]+))?)?(.*)$/;
+
+/**
+ * Returns a Version instance created from the given parameters.
+ *
+ * This function can either be called as a constructor (using <code>new</code>) or as a normal function.
+ * It always returns an immutable Version instance.
+ *
+ * The parts of the version number (major, minor, patch, suffix) can be provided in several ways:
+ * <ul>
+ * <li>Version("1.2.3-SNAPSHOT")    - as a dot-separated string. Any non-numerical char or a dot followed
+ *                                    by a non-numerical char starts the suffix portion. Any missing major,
+ *                                    minor or patch versions will be set to 0.</li>
+ * <li>Version(1,2,3,"-SNAPSHOT")   - as individual parameters. Major, minor and patch must be integer numbers
+ *                                    or empty, suffix must be a string not starting with digits.</li>
+ * <li>Version([1,2,3,"-SNAPSHOT"]) - as an array with the individual parts. The same type restrictions apply
+ *                                    as before.</li>
+ * <li>Version(otherVersion)        - as a Version instance (cast operation). Returns the given instance instead
+ *                                    of creating a new one.</li>
+ * </ul>
+ *
+ * To keep the code size small, this implementation mainly validates the single string variant.
+ * All other variants are only validated to some degree. It is the responsibility of the caller to
+ * provide proper parts.
+ *
+ * @param {int|string|any[]|module:sap/base/util/Version} vMajor the major part of the version (int) or any of the single
+ *        parameter variants explained above.
+ * @param {int} iMinor the minor part of the version number
+ * @param {int} iPatch the patch part of the version number
+ * @param {string} sSuffix the suffix part of the version number
+ * @class Represents a version consisting of major, minor, patch version, and suffix, for example '1.2.7-SNAPSHOT'.
+ * @since 1.58
+ * @alias module:sap/base/util/Version
+ * @public
+ */
+function Version(vMajor, iMinor, iPatch, sSuffix) {
+  if (vMajor instanceof Version) {
+    // note: even a constructor may return a value different from 'this'
+    return vMajor;
+  }
+  if (!(this instanceof Version)) {
+    // act as a cast operator when called as function (not as a constructor)
+    return new Version(vMajor, iMinor, iPatch, sSuffix);
+  }
+  var m;
+  if (typeof vMajor === "string") {
+    m = rVersion.exec(vMajor);
+  } else if (Array.isArray(vMajor)) {
+    m = vMajor;
+  } else {
+    m = arguments;
+  }
+  m = m || [];
+  function norm(v) {
+    v = parseInt(v);
+    return isNaN(v) ? 0 : v;
+  }
+  vMajor = norm(m[0]);
+  iMinor = norm(m[1]);
+  iPatch = norm(m[2]);
+  sSuffix = String(m[3] || "");
+
+  /**
+   * Returns a string representation of this version.
+   *
+   * @return {string} a string representation of this version.
+   * @public
+   */
+  this.toString = function () {
+    return vMajor + "." + iMinor + "." + iPatch + sSuffix;
+  };
+
+  /**
+   * Returns the major version part of this version.
+   *
+   * @return {int} the major version part of this version
+   * @public
+   */
+  this.getMajor = function () {
+    return vMajor;
+  };
+
+  /**
+   * Returns the minor version part of this version.
+   *
+   * @return {int} the minor version part of this version
+   * @public
+   */
+  this.getMinor = function () {
+    return iMinor;
+  };
+
+  /**
+   * Returns the patch (or micro) version part of this version.
+   *
+   * @return {int} the patch version part of this version
+   * @public
+   */
+  this.getPatch = function () {
+    return iPatch;
+  };
+
+  /**
+   * Returns the version suffix of this version.
+   *
+   * @return {string} the version suffix of this version
+   * @public
+   */
+  this.getSuffix = function () {
+    return sSuffix;
+  };
+
+  /**
+   * Compares this version with a given one.
+   *
+   * The version with which this version should be compared can be given as a <code>sap/base/util/Version</code> instance,
+   * as a string (e.g. <code>v.compareto("1.4.5")</code>). Or major, minor, patch and suffix values can be given as
+   * separate parameters (e.g. <code>v.compareTo(1, 4, 5)</code>) or in an array (e.g. <code>v.compareTo([1, 4, 5])</code>).
+   *
+   * @return {int} 0, if the given version is equal to this version, a negative value if the given other version is greater
+   *               and a positive value otherwise
+   * @public
+   */
+  this.compareTo = function () {
+    var vOther = Version.apply(window, arguments);
+    /*eslint-disable no-nested-ternary */
+    return vMajor - vOther.getMajor() || iMinor - vOther.getMinor() || iPatch - vOther.getPatch() || (sSuffix < vOther.getSuffix() ? -1 : sSuffix === vOther.getSuffix() ? 0 : 1);
+    /*eslint-enable no-nested-ternary */
+  };
+}
+
+/**
+ * Checks whether this version is in the range of the given interval (start inclusive, end exclusive).
+ *
+ * The boundaries against which this version should be checked can be given as  <code>sap/base/util/Version</code>
+ * instances (e.g. <code>v.inRange(v1, v2)</code>), as strings (e.g. <code>v.inRange("1.4", "2.7")</code>)
+ * or as arrays (e.g. <code>v.inRange([1,4], [2,7])</code>).
+ *
+ * @param {string|any[]|module:sap/base/util/Version} vMin the start of the range (inclusive)
+ * @param {string|any[]|module:sap/base/util/Version} vMax the end of the range (exclusive)
+ * @return {boolean} <code>true</code> if this version is greater or equal to <code>vMin</code> and smaller
+ *                   than <code>vMax</code>, <code>false</code> otherwise.
+ * @public
+ */
+Version.prototype.inRange = function (vMin, vMax) {
+  return this.compareTo(vMin) >= 0 && this.compareTo(vMax) < 0;
+};
+export default Version;

package/dist/sap/base/util/_merge.js

@@ -1,32 +1,89 @@
-import isPlainObject from './isPlainObject.js';
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+import isPlainObject from "./isPlainObject.js";
 var oToken = Object.create(null);
+
+/**
+ * Performs object extension by merging source objects into a target object.
+ *
+ * @example
+ * var oMerged = _merge(true, false, {}, {prop1:1}, {prop2:2});
+ *
+ * @function
+ * @since 1.71
+ * @private
+ * @alias module:sap/base/util/_merge
+ * @param {boolean} deep Shallow copy or deep merge
+ * @param {boolean} skipUndefined Whether <code>undefined</code> values will be skipped, otherwise <code>undefined</code> values will overwrite existing values
+ * @param {object} target The object that will receive new properties
+ * @param {...object} [source] One or more objects which get merged into the target object
+ * @return {object} the target object which is the result of the merge
+ */
 var fnMerge = function () {
-    var src, copyIsArray, copy, name, options, clone, target = arguments[2] || {}, i = 3, length = arguments.length, deep = arguments[0] || false, skipToken = arguments[1] ? undefined : oToken;
-    if (typeof target !== 'object' && typeof target !== 'function') {
-        target = {};
-    }
-    for (; i < length; i++) {
-        if ((options = arguments[i]) != null) {
-            for (name in options) {
-                src = target[name];
-                copy = options[name];
-                if (name === '__proto__' || target === copy) {
-                    continue;
-                }
-                if (deep && copy && (isPlainObject(copy) || (copyIsArray = Array.isArray(copy)))) {
-                    if (copyIsArray) {
-                        copyIsArray = false;
-                        clone = src && Array.isArray(src) ? src : [];
-                    } else {
-                        clone = src && isPlainObject(src) ? src : {};
-                    }
-                    target[name] = fnMerge(deep, arguments[1], clone, copy);
-                } else if (copy !== skipToken) {
-                    target[name] = copy;
-                }
-            }
+  /*
+   * The code in this function is taken from jQuery 3.6.0 "jQuery.extend" and got modified.
+   *
+   * jQuery JavaScript Library v3.6.0
+   * https://jquery.com/
+   *
+   * Copyright OpenJS Foundation and other contributors
+   * Released under the MIT license
+   * https://jquery.org/license
+   */
+  var src,
+    copyIsArray,
+    copy,
+    name,
+    options,
+    clone,
+    target = arguments[2] || {},
+    i = 3,
+    length = arguments.length,
+    deep = arguments[0] || false,
+    skipToken = arguments[1] ? undefined : oToken;
+
+  // Handle case when target is a string or something (possible in deep copy)
+  if (typeof target !== "object" && typeof target !== "function") {
+    target = {};
+  }
+  for (; i < length; i++) {
+    if ((options = arguments[i]) != null) {
+      // Extend the base object
+      for (name in options) {
+        src = target[name];
+        copy = options[name];
+
+        // Prevent never-ending loop
+        // Prevent Object.prototype pollution for $.extend( true, ... )
+        // For further information, please visit https://github.com/jquery/jquery/pull/4333
+        if (name === "__proto__" || target === copy) {
+          continue;
+        }
+
+        // Recurse if we're merging plain objects or arrays
+        if (deep && copy && (isPlainObject(copy) || (copyIsArray = Array.isArray(copy)))) {
+          if (copyIsArray) {
+            copyIsArray = false;
+            clone = src && Array.isArray(src) ? src : [];
+          } else {
+            clone = src && isPlainObject(src) ? src : {};
+          }
+
+          // Never move original objects, clone them
+          target[name] = fnMerge(deep, arguments[1], clone, copy);
+
+          // Don't bring in undefined values
+        } else if (copy !== skipToken) {
+          target[name] = copy;
         }
+      }
     }
-    return target;
+  }
+
+  // Return the modified object
+  return target;
 };
 export default fnMerge;

package/dist/sap/base/util/array/uniqueSort.js

@@ -1,19 +1,41 @@
-import assert from '../../assert.js';
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+import assert from "../../assert.js";
+/**
+ * Sorts the given array in-place and removes any duplicates (identified by "===").
+ *
+ * Uses Array#sort()
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
+ *
+ * Use <code>jQuery.uniqueSort()</code> for arrays of DOMElements.
+ *
+ * @function
+ * @since 1.58
+ * @param {any[]} aArray An Array of any type
+ * @alias module:sap/base/util/array/uniqueSort
+ * @return {any[]} Same array as given (for chaining)
+ * @public
+ */
 var fnUniqueSort = function (aArray) {
-    assert(Array.isArray(aArray), 'uniqueSort: input parameter must be an Array');
-    var iLength = aArray.length;
-    if (iLength > 1) {
-        aArray.sort();
-        var j = 0;
-        for (var i = 1; i < iLength; i++) {
-            if (aArray.indexOf(aArray[i]) === i) {
-                aArray[++j] = aArray[i];
-            }
-        }
-        if (++j < iLength) {
-            aArray.splice(j, iLength - j);
-        }
+  assert(Array.isArray(aArray), "uniqueSort: input parameter must be an Array");
+  var iLength = aArray.length;
+  if (iLength > 1) {
+    aArray.sort();
+    var j = 0;
+    for (var i = 1; i < iLength; i++) {
+      // invariant: i is the entry to check, j is the last unique entry known so far
+      if (aArray.indexOf(aArray[i]) === i) {
+        aArray[++j] = aArray[i];
+      }
     }
-    return aArray;
+    // cut off the rest - if any
+    if (++j < iLength) {
+      aArray.splice(j, iLength - j);
+    }
+  }
+  return aArray;
 };
 export default fnUniqueSort;

package/dist/sap/base/util/deepClone.js

@@ -0,0 +1,102 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+import isPlainObject from "./isPlainObject.js";
+/**
+ * Creates a deep clone of the source value.
+ *
+ * Only arrays, JavaScript Date objects and objects that pass the {@link module:sap/base/util/isPlainObject isPlainObject}
+ * check will be cloned. For other object types, a <code>TypeError</code> will be thrown as there's no standard way
+ * to clone them. Primitive values (boolean, number, string) as well as <code>null</code> and <code>undefined</code>
+ * will be copied, they have value semantics anyhow.
+ *
+ * <code>deepClone</code> is designed to match the semantics of {@link module:sap/base/util/deepEqual deepEqual}.
+ * Any deeply cloned object should be deep-equal to the source. However, not every object that can be handled
+ * by <code>deepEqual</code> can also be deeply cloned (e.g. <code>deepClone</code> fails on non-plain objects).
+ *
+ * To limit the time needed for a deep clone and to avoid endless recursion in case of cyclic structures, the
+ * recursion depth is limited by the parameter <code>maxDepth</code>, which defaults to 10. When the recursion
+ * depth exceeds the given limit, a <code>TypeError</code> is thrown.
+ *
+ * Note that object identities are not honored by the clone operation. If the original source contained multiple
+ * references to the same plain object instance, the clone will contain a different clone for each reference.
+ *
+ * @example <caption>Simple operation</caption>
+ * var oSource = { a: 1, b: { x: "test", y : 5.0 }, c: new Date(), d: null };
+ * var oClone = deepClone(oValue);
+ *
+ * deepEqual(oClone, oSource); // true
+ * oClone !== oSource; // true
+ * oClone.b !== oSource.b; // true
+ * oClone.c !== oSource.c; // true
+ *
+ * @example <caption>Object Identities</caption>
+ * var oCommon = { me: "unique" };
+ * var oValue = { a: oCommon, b: oCommon };
+ * var oClone = deepClone(oValue);
+ *
+ * deepEqual(oClone, oSource); // true
+ * oSource.a === oSource.b; // true
+ * oClone.a === oClone.b; // false
+ * deepEqual(oClone.a, oClone.b); // true
+ *
+ * @since 1.63
+ * @public
+ * @alias module:sap/base/util/deepClone
+ * @param {any} src Source value that shall be cloned
+ * @param {int} [maxDepth=10] Maximum recursion depth for the clone operation, deeper structures will throw an error
+ * @returns {any} A clone of the source value
+ * @throws {TypeError} When a non-plain object is encountered or when the max structure depth is exceeded
+ */
+var fnDeepClone = function (src, maxDepth) {
+  if (!maxDepth) {
+    maxDepth = 10;
+  }
+  return clone(src, 0, maxDepth);
+};
+function clone(src, depth, maxDepth) {
+  // avoid endless recursion due to cyclic structures
+  if (depth > maxDepth) {
+    throw new TypeError("The structure depth of the source exceeds the maximum depth (" + maxDepth + ")");
+  }
+  if (src == null) {
+    return src;
+  } else if (src instanceof Date) {
+    if (src.clone) {
+      // sap.ui.core.date.UI5Date
+      return src.clone();
+    }
+
+    // clone date object using #getTime(). Officially the date constructor does not support parameter Date.
+    return new Date(src.getTime());
+  } else if (Array.isArray(src)) {
+    return cloneArray(src, depth, maxDepth);
+  } else if (typeof src === "object") {
+    return cloneObject(src, depth, maxDepth);
+  } else {
+    return src;
+  }
+}
+function cloneArray(src, depth, maxDepth) {
+  var aClone = [];
+  for (var i = 0; i < src.length; i++) {
+    aClone.push(clone(src[i], depth + 1, maxDepth));
+  }
+  return aClone;
+}
+function cloneObject(src, depth, maxDepth) {
+  if (!isPlainObject(src)) {
+    throw new TypeError("Cloning is only supported for plain objects");
+  }
+  var oClone = {};
+  for (var key in src) {
+    if (key === "__proto__") {
+      continue;
+    }
+    oClone[key] = clone(src[key], depth + 1, maxDepth);
+  }
+  return oClone;
+}
+export default fnDeepClone;

package/dist/sap/base/util/deepEqual.js

@@ -1,59 +1,83 @@
-import Log from '../Log.js';
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+/*global Node */
+//@evo-todo check isEqualNode dependency: not yet available...
+//@evo-todo dependency to global name 'Node' contradicts sap/base package
+import Log from "../Log.js";
+/**
+ * Compares the two given values for equality, especially by comparing the content.
+ *
+ * <b>Note:</b> Function does not work with comparing XML objects.
+ *
+ * @function
+ * @since 1.58
+ * @param {any} a A value of any type
+ * @param {any} b A value of any type
+ * @param {int} [maxDepth=10] Maximum recursion depth
+ * @param {boolean} [contains] Whether all existing properties in a are equal as in b
+ * @alias module:sap/base/util/deepEqual
+ * @return {boolean} Whether a and b are equal
+ * @public
+ */
 var fnEqual = function (a, b, maxDepth, contains, depth) {
-    if (typeof maxDepth == 'boolean') {
-        contains = maxDepth;
-        maxDepth = undefined;
-    }
-    if (!depth) {
-        depth = 0;
+  // Optional parameter normalization
+  if (typeof maxDepth == "boolean") {
+    contains = maxDepth;
+    maxDepth = undefined;
+  }
+  if (!depth) {
+    depth = 0;
+  }
+  if (!maxDepth) {
+    maxDepth = 10;
+  }
+  if (depth > maxDepth) {
+    Log.warning("deepEqual comparison exceeded maximum recursion depth of " + maxDepth + ". Treating values as unequal");
+    return false;
+  }
+  if (a === b || Number.isNaN(a) && Number.isNaN(b)) {
+    return true;
+  }
+  if (Array.isArray(a) && Array.isArray(b)) {
+    if (!contains && a.length !== b.length) {
+      return false;
     }
-    if (!maxDepth) {
-        maxDepth = 10;
+    if (a.length > b.length) {
+      return false;
     }
-    if (depth > maxDepth) {
-        Log.warning('deepEqual comparison exceeded maximum recursion depth of ' + maxDepth + '. Treating values as unequal');
+    for (var i = 0; i < a.length; i++) {
+      if (!fnEqual(a[i], b[i], maxDepth, contains, depth + 1)) {
         return false;
+      }
     }
-    if (a === b || Number.isNaN(a) && Number.isNaN(b)) {
-        return true;
-    }
-    if (Array.isArray(a) && Array.isArray(b)) {
-        if (!contains && a.length !== b.length) {
-            return false;
-        }
-        if (a.length > b.length) {
-            return false;
-        }
-        for (var i = 0; i < a.length; i++) {
-            if (!fnEqual(a[i], b[i], maxDepth, contains, depth + 1)) {
-                return false;
-            }
-        }
-        return true;
-    }
-    if (typeof a == 'object' && typeof b == 'object') {
-        if (!a || !b) {
-            return false;
-        }
-        if (a.constructor !== b.constructor) {
-            return false;
-        }
-        if (!contains && Object.keys(a).length !== Object.keys(b).length) {
-            return false;
-        }
-        if (a instanceof Node) {
-            return a.isEqualNode(b);
-        }
-        if (a instanceof Date) {
-            return a.valueOf() === b.valueOf();
-        }
-        for (var i in a) {
-            if (!fnEqual(a[i], b[i], maxDepth, contains, depth + 1)) {
-                return false;
-            }
-        }
-        return true;
+    return true;
+  }
+  if (typeof a == "object" && typeof b == "object") {
+    if (!a || !b) {
+      return false;
     }
-    return false;
+    if (a.constructor !== b.constructor) {
+      return false;
+    }
+    if (!contains && Object.keys(a).length !== Object.keys(b).length) {
+      return false;
+    }
+    if (a instanceof Node) {
+      return a.isEqualNode(b);
+    }
+    if (a instanceof Date) {
+      return a.valueOf() === b.valueOf();
+    }
+    for (var i in a) {
+      if (!fnEqual(a[i], b[i], maxDepth, contains, depth + 1)) {
+        return false;
+      }
+    }
+    return true;
+  }
+  return false;
 };
 export default fnEqual;

package/dist/sap/base/util/extend.js

@@ -1,10 +1,61 @@
-import _merge from './_merge.js';
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+import _merge from "./_merge.js";
+/**
+ * Performs object extension by merging source objects into a target object. Generates a shallow copy.
+ *
+ * If during merging a key in the target object exists it is overwritten with the source object's value.
+ * Usage is the same as <code>jQuery.extend(...)</code>.
+ * Values that are <code>undefined</code> are ignored.
+ *
+ * As alternative you may also use <code>Object.assign</code>, but note that <code>Object.assign</code>
+ * only copies enumerable and own properties and doesn't copy properties on the prototype and non-enumerable
+ * properties. Also, values that are <code>undefined</code> are NOT ignored.
+ *
+ * For deep copies, you may use {@link module:sap/base/util/deepExtend sap/base/util/deepExtend}.
+ *
+ * @example
+ * var oResult = extend({}, {
+ *   prop1: {
+ *     prop1a: "1a"
+ *   }
+ * }, {
+ *   prop2: {
+ *     prop2a: "2a"
+ *   }
+ * }, {
+ *   prop1: {
+ *      prop1b: "1b"
+ *   }
+ * }, {
+ *   prop2: undefined
+ * });
+ *
+ *
+ * console.log(oResult);
+ * {
+ *   "prop1": {
+ *     "prop1b": "1b"
+ *   },
+ *   "prop2": {
+ *     "prop2a": "2a"
+ *   }
+ * }
+ *
+ * @function
+ * @alias module:sap/base/util/extend
+ * @param {object} target The object that will receive new properties
+ * @param {...object} [source] One or more objects which get merged into the target object
+ * @return {object} the target object which is the result of the merge
+ * @public
+ * @since 1.71
+ */
 var fnExtend = function () {
-    var args = [
-        false,
-        true
-    ];
-    args.push.apply(args, arguments);
-    return _merge.apply(null, args);
+  var args = [false, true];
+  args.push.apply(args, arguments);
+  return _merge.apply(null, args);
 };
 export default fnExtend;

package/dist/sap/base/util/isEmptyObject.js

@@ -0,0 +1,34 @@
+/**
+ * Validates if the given object is empty, that is that it has no enumerable properties.
+ *
+ * Note that <code>null</code> and <code>undefined</code> comply with this definition of 'empty'.
+ * The behavior for non-object values is undefined and might change in future.
+ *
+ * @example
+ * sap.ui.require(["sap/base/util/isEmptyObject"], function(isEmptyObject){
+ *      isEmptyObject({}); // true
+ *      isEmptyObject({test: '123'}); // false
+ *      isEmptyObject(null); // true
+ *      isEmptyObject(undefined); // true
+ * });
+ *
+ * @function
+ * @since 1.65
+ * @public
+ * @name module:sap/base/util/isEmptyObject
+ * @param {Object} obj the object which is checked
+ * @returns {boolean} whether or not the given object is empty
+ */ /*!
+     * OpenUI5
+     * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+     * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+     */
+
+var fnIsEmptyObject = function isEmptyObject(obj) {
+  // eslint-disable-next-line no-unreachable-loop
+  for (var sName in obj) {
+    return false;
+  }
+  return true;
+};
+export default fnIsEmptyObject;