@tstdl/base 0.91.51 → 0.92.0

package/utils/helpers.js

@@ -1,7 +1,6 @@
 import { supportsNotification } from '../supports.js';
 import { DetailsError } from '../errors/details.error.js';
 import { decycle } from './object/decycle.js';
-import { isDefined } from './type-guards.js';
 /**
  * Create an structured clone of an value using Notification if available, otherwise history state (may alters history)
  *
@@ -68,34 +67,6 @@ export function parseFirstAndFamilyName(name) {
         familyName: familyName.length > 0 ? familyName : undefined
     };
 }
-/**
- * Trims, lowercases, replaces multi-character whitespace with a single space and unicode normalization
- * @param text text to normalize
- * @param options specify what to normalize. Defaults to all except unicode
- * @returns normalized text
- */
-export function normalizeText(text, options = { trim: true, lowercase: true, multipleWhitespace: true, diacritics: true, ligatures: true }) {
-    let normalized = text;
-    if (options.trim == true) {
-        normalized = normalized.trim();
-    }
-    if (options.lowercase == true) {
-        normalized = normalized.toLowerCase();
-    }
-    if (options.multipleWhitespace == true) {
-        normalized = normalized.replace(/\s+/ug, ' ');
-    }
-    if (options.diacritics == true) {
-        normalized = normalized.normalize('NFD').replace(/\p{Diacritic}/ug, '');
-    }
-    if (options.ligatures == true) {
-        normalized = normalized.normalize('NFKC');
-    }
-    if (isDefined(options.unicode)) {
-        normalized = normalized.normalize(options.unicode);
-    }
-    return normalized;
-}
 export function iif(condition, trueFn, falseFn) {
     return condition ? trueFn() : falseFn();
 }

package/utils/index.d.ts

@@ -49,6 +49,7 @@ export * from './sort.js';
 export * from './throw.js';
 export * from './timer.js';
 export * from './timing.js';
+export * from './try-ignore.js';
 export * from './type-guards.js';
 export * from './type-of.js';
 export * from './type/index.js';

package/utils/index.js

@@ -49,6 +49,7 @@ export * from './sort.js';
 export * from './throw.js';
 export * from './timer.js';
 export * from './timing.js';
+export * from './try-ignore.js';
 export * from './type-guards.js';
 export * from './type-of.js';
 export * from './type/index.js';

package/utils/string/index.d.ts

@@ -1,4 +1,5 @@
 export * from './hypenate.js';
+export * from './normalize.js';
 export * from './snake-case.js';
 export * from './title-case.js';
 export * from './trim.js';

package/utils/string/index.js

@@ -1,4 +1,5 @@
 export * from './hypenate.js';
+export * from './normalize.js';
 export * from './snake-case.js';
 export * from './title-case.js';
 export * from './trim.js';

package/utils/string/normalize.d.ts

@@ -0,0 +1,50 @@
+export type NormalizeTextOptions = {
+    /**
+     * Remove leading and trailing whitespace
+     */
+    trim?: boolean;
+    /**
+     * Lowercase all characters
+     */
+    lowercase?: boolean;
+    /**
+     * Remove multiple consecutive whitespace characters
+     */
+    multipleWhitespace?: boolean;
+    /**
+     * Remove diacritics (è -> e)
+     *
+     * applies unicode NFD normalization and removes diacritics
+     * @see unicode option
+     */
+    diacritics?: boolean;
+    /**
+     * Replace ligatures with their consecutive characters (æ -> ae)
+     *
+     * applies unicode NFKC normalization
+     * @see unicode option
+     */
+    ligatures?: boolean;
+    /**
+     * Unicode normalization
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize
+     */
+    unicode?: 'NFC' | 'NFD' | 'NFKC' | 'NFKD';
+};
+/**
+ * Trims, lowercases, replaces multi-character whitespace with a single space and unicode normalization
+ * @param text text to normalize
+ * @param options specify what to normalize. Defaults to all except unicode
+ * @returns normalized text
+ */
+export declare function normalizeText(text: string, options?: NormalizeTextOptions): string;
+/**
+ * Normalizes text input by trimming whitespace and returning null if text is empty.
+ *
+ * @param text The input text to normalize
+ * @param allowNull If true, null or undefined input (or input that becomes empty after trimming) will return null. If false, an error will be thrown in these cases. Defaults to true.
+ * @returns The trimmed string. If allowNull is true and the input is null, undefined, or empty after trimming, returns null.
+ * @throws {Error} If allowNull is false and the input is null, undefined, or empty after trimming.
+ */
+export declare function normalizeTextInput(text: string | null | undefined, allowNull?: true): string | null;
+export declare function normalizeTextInput(text: string | null | undefined, allowNull: false): string;

package/utils/string/normalize.js

@@ -0,0 +1,39 @@
+import { isDefined, isNullOrUndefined } from '../type-guards.js';
+/**
+ * Trims, lowercases, replaces multi-character whitespace with a single space and unicode normalization
+ * @param text text to normalize
+ * @param options specify what to normalize. Defaults to all except unicode
+ * @returns normalized text
+ */
+export function normalizeText(text, options = { trim: true, lowercase: true, multipleWhitespace: true, diacritics: true, ligatures: true }) {
+    let normalized = text;
+    if (options.trim == true) {
+        normalized = normalized.trim();
+    }
+    if (options.lowercase == true) {
+        normalized = normalized.toLowerCase();
+    }
+    if (options.multipleWhitespace == true) {
+        normalized = normalized.replace(/\s+/ug, ' ');
+    }
+    if (options.diacritics == true) {
+        normalized = normalized.normalize('NFD').replace(/\p{Diacritic}/ug, '');
+    }
+    if (options.ligatures == true) {
+        normalized = normalized.normalize('NFKC');
+    }
+    if (isDefined(options.unicode)) {
+        normalized = normalized.normalize(options.unicode);
+    }
+    return normalized;
+}
+export function normalizeTextInput(text, allowNull) {
+    const normalized = text?.trim();
+    if (isNullOrUndefined(normalized) || (normalized.length == 0)) {
+        if (allowNull == false) {
+            throw new Error('Invalid input.');
+        }
+        return null;
+    }
+    return normalized;
+}

package/utils/try-ignore.d.ts

@@ -0,0 +1,2 @@
+export declare function tryIgnore(fn: () => any): void;
+export declare function tryIgnoreAsync(fn: () => Promise<any>): Promise<void>;

package/utils/try-ignore.js

@@ -0,0 +1,12 @@
+export function tryIgnore(fn) {
+    try {
+        fn();
+    }
+    catch { /* ignore */ }
+}
+export async function tryIgnoreAsync(fn) {
+    try {
+        await fn();
+    }
+    catch { /* ignore */ }
+}