@mll-lab/js-utils 2.8.0 → 2.11.0

package/dist/array.d.ts

@@ -23,3 +23,9 @@ export declare const EMPTY_ARRAY: never[];
  */
 export declare function insertIf<T>(condition: boolean, ...elements: Array<T>): Array<T>;
 export declare function last<T, A extends Array<T>>(array: A): A extends NonEmptyArray<T> ? T : T | undefined;
+/**
+ * Appends element to array if not included or removes it.
+ *
+ * Never mutates the given array, always returns a new array.
+ */
+export declare function toggleElement<T>(array: Array<T>, element: T): Array<T>;

package/dist/germanNumber.d.ts

@@ -0,0 +1,23 @@
+export declare const GERMAN_THOUSAND_SEPARATOR = ".";
+export declare const GERMAN_DECIMAL_SEPARATOR = ",";
+export declare const ENGLISH_THOUSAND_SEPARATOR = ",";
+export declare const ENGLISH_DECIMAL_SEPARATOR = ".";
+declare type FormatNumberOptions = Intl.NumberFormatOptions & {
+    defaultValue?: string;
+};
+export declare function formatGermanNumber(value: number | string | null | undefined, { defaultValue, ...localeOptions }?: FormatNumberOptions): string;
+/**
+ * Parse an input into a number on a best effort basis.
+ *
+ * If the value can not be parsed, this function returns null.
+ */
+export declare function parseGermanNumber(value: string | null | undefined): number | null;
+/**
+ * Check if the given input might be on track to become a parseable german number.
+ *
+ * The regular expression must be quite lenient, as it is used to validate numbers
+ * as they are being typed. We just want to improve the user experience by disallowing
+ * them to enter something totally nonsensical.
+ */
+export declare function isPartialGermanNumber(value: string): boolean;
+export {};

package/dist/germanNumber.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.common.js

@@ -9466,6 +9466,16 @@ function last(array) {
     // @ts-expect-error too magical
     return array[array.length - 1];
 }
+/**
+ * Appends element to array if not included or removes it.
+ *
+ * Never mutates the given array, always returns a new array.
+ */
+function toggleElement(array, element) {
+    return array.includes(element)
+        ? array.filter((e) => e !== element)
+        : array.concat(element);
+}
 
 function toInteger(dirtyNumber) {
   if (dirtyNumber === null || dirtyNumber === true || dirtyNumber === false) {
@@ -15128,6 +15138,63 @@ function hasMessage(error) {
     return typeof error === 'object' && error !== null && 'message' in error;
 }
 
+function __rest(s, e) {
+  var t = {};
+
+  for (var p in s) {
+    if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p];
+  }
+
+  if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+    if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i])) t[p[i]] = s[p[i]];
+  }
+  return t;
+}
+
+const GERMAN_THOUSAND_SEPARATOR = '.';
+const GERMAN_DECIMAL_SEPARATOR = ',';
+const ENGLISH_THOUSAND_SEPARATOR = ',';
+const ENGLISH_DECIMAL_SEPARATOR = '.';
+function formatGermanNumber(value, _a = {}) {
+    var { defaultValue } = _a, localeOptions = __rest(_a, ["defaultValue"]);
+    if (!value) {
+        return '';
+    }
+    const parsed = typeof value === 'string' ? Number.parseFloat(value) : value;
+    if (Number.isNaN(parsed)) {
+        return defaultValue !== null && defaultValue !== void 0 ? defaultValue : '';
+    }
+    return parsed.toLocaleString('de-DE', Object.assign(Object.assign({}, localeOptions), { maximumFractionDigits: 6 }));
+}
+/**
+ * Parse an input into a number on a best effort basis.
+ *
+ * If the value can not be parsed, this function returns null.
+ */
+function parseGermanNumber(value) {
+    if (value === null || value === undefined) {
+        return null;
+    }
+    const normalizedValue = value
+        .replace(new RegExp(`\\${GERMAN_THOUSAND_SEPARATOR}`, 'g'), '')
+        .replace(GERMAN_DECIMAL_SEPARATOR, ENGLISH_DECIMAL_SEPARATOR);
+    const parsed = Number.parseFloat(normalizedValue);
+    if (Number.isNaN(parsed)) {
+        return null;
+    }
+    return parsed;
+}
+/**
+ * Check if the given input might be on track to become a parseable german number.
+ *
+ * The regular expression must be quite lenient, as it is used to validate numbers
+ * as they are being typed. We just want to improve the user experience by disallowing
+ * them to enter something totally nonsensical.
+ */
+function isPartialGermanNumber(value) {
+    return /^-?\d*[.\d]*,?\d*$/.test(value);
+}
+
 /**
  * Round a number to a given number of decimal places.
  *
@@ -15205,12 +15272,33 @@ function joinNonEmpty(maybeStrings, separator) {
     return maybeStrings.filter(Boolean).join(separator);
 }
 
+/**
+ * Converts pixel value to number.
+ *
+ * @example "4px" to 4
+ */
+function pxToNumber(pixels) {
+    const count = (pixels.match(/px/g) || []).length;
+    if (count > 1 || !pixels.endsWith('px')) {
+        throw new Error(`'${pixels}' does not contain a single 'px'`);
+    }
+    const parsedValue = parseFloat(pixels);
+    if (Number.isNaN(parsedValue)) {
+        throw new Error(`'${pixels}' is not a valid single pixel-value`);
+    }
+    return parsedValue;
+}
+
 exports.DOTLESS_DATE_FORMAT = DOTLESS_DATE_FORMAT;
 exports.EMAIL_REGEX = EMAIL_REGEX;
 exports.EMPTY_ARRAY = EMPTY_ARRAY;
+exports.ENGLISH_DECIMAL_SEPARATOR = ENGLISH_DECIMAL_SEPARATOR;
+exports.ENGLISH_THOUSAND_SEPARATOR = ENGLISH_THOUSAND_SEPARATOR;
 exports.GERMAN_DATE_FORMAT = GERMAN_DATE_FORMAT;
 exports.GERMAN_DATE_TIME_FORMAT = GERMAN_DATE_TIME_FORMAT;
+exports.GERMAN_DECIMAL_SEPARATOR = GERMAN_DECIMAL_SEPARATOR;
 exports.GERMAN_DOTLESS_DATE_FORMAT = GERMAN_DOTLESS_DATE_FORMAT;
+exports.GERMAN_THOUSAND_SEPARATOR = GERMAN_THOUSAND_SEPARATOR;
 exports.ISO_DATE_FORMAT = ISO_DATE_FORMAT;
 exports.ISO_DATE_TIME_FORMAT = ISO_DATE_TIME_FORMAT;
 exports.SECONDLESS_DATE_TIME_FORMAT = SECONDLESS_DATE_TIME_FORMAT;
@@ -15222,6 +15310,7 @@ exports.formatDotlessDate = formatDotlessDate;
 exports.formatGerman = formatGerman;
 exports.formatGermanDateTime = formatGermanDateTime;
 exports.formatGermanDotlessDate = formatGermanDotlessDate;
+exports.formatGermanNumber = formatGermanNumber;
 exports.formatIsoDate = formatIsoDate;
 exports.formatIsoDateTime = formatIsoDateTime;
 exports.formatSecondlessDateTime = formatSecondlessDateTime;
@@ -15235,6 +15324,7 @@ exports.isLabId = isLabId;
 exports.isNonEmptyArray = isNonEmptyArray;
 exports.isNotNullish = isNotNullish;
 exports.isOnlyDigits = isOnlyDigits;
+exports.isPartialGermanNumber = isPartialGermanNumber;
 exports.isRackBarcode = isRackBarcode;
 exports.isString = isString;
 exports.isToday = isToday;
@@ -15248,10 +15338,13 @@ exports.parseGermanDate = parseGermanDate;
 exports.parseGermanDateFlexible = parseGermanDateFlexible;
 exports.parseGermanDateTime = parseGermanDateTime;
 exports.parseGermanDotlessDate = parseGermanDotlessDate;
+exports.parseGermanNumber = parseGermanNumber;
 exports.parseIsoDate = parseIsoDate;
 exports.parseIsoDateTime = parseIsoDateTime;
 exports.parseSecondlessDateTime = parseSecondlessDateTime;
 exports.pluralize = pluralize;
+exports.pxToNumber = pxToNumber;
 exports.round = round;
+exports.toggleElement = toggleElement;
 exports.withoutIndex = withoutIndex;
 //# sourceMappingURL=index.common.js.map