@oscarpalmer/atoms 0.182.1 → 0.183.0

package/dist/index.d.mts

@@ -3170,10 +3170,20 @@ type NormalizeOptions = {
    * Convert the string to lower case? _(defaults to `true`)_
    */
   lowerCase?: boolean;
+  /**
+   * Remove special characters from the string? _(defaults to `false`)_
+   *
+   * _(Punctuation and symbol characters are considered special)_
+   */
+  special?: boolean;
   /**
    * Trim the string? _(defaults to `true`)_
    */
   trim?: boolean;
+  /**
+   * Shorten consecutive whitespace characters to a single space? _(defaults to `true`)_
+   */
+  whitespace?: boolean;
 };
 /**
  * String normalizer function

package/dist/index.mjs

@@ -2939,7 +2939,9 @@ function getNormalizeOptions(input) {
 	return {
 		deburr: options.deburr !== false,
 		lowerCase: options.lowerCase !== false,
-		trim: options.trim !== false
+		special: options.special === true,
+		trim: options.trim !== false,
+		whitespace: options.whitespace !== false
 	};
 }
 /**
@@ -2967,9 +2969,11 @@ function normalizeString(value, options) {
 	if (typeof value !== "string") return "";
 	let result = value;
 	if (options.trim) result = result.trim();
+	if (options.whitespace) result = result.replace(WHITESPACE_PATTERN, WHITESPACE_REPLACEMENT);
 	if (options.deburr) result = deburr(result);
 	if (options.lowerCase) result = lowerCase(result);
-	return result;
+	if (options.special) result = result.replace(SPECIAL_PATTERN, SPECIAL_REPLACEMENT);
+	return result.normalize(NORMALIZATION_NORMALIZATION);
 }
 const DEBURR_CHARACTERS = {
 	Æ: "AE",
@@ -3006,6 +3010,11 @@ const DEBURR_CHARACTERS = {
 const DEBURR_NORMALIZATION = "NFD";
 const DEBURR_PATTERN_CHARACTERS = new RegExp(`(${Object.keys(DEBURR_CHARACTERS).join("|")})`, "g");
 const DEBURR_PATTERN_SIMPLE = /[\u0300-\u036f]/g;
+const NORMALIZATION_NORMALIZATION = "NFC";
+const SPECIAL_PATTERN = /[\p{P}\p{S}]/gu;
+const SPECIAL_REPLACEMENT = "";
+const WHITESPACE_PATTERN = /\s+/g;
+const WHITESPACE_REPLACEMENT = " ";
 let deburrMemoizer;
 //#endregion
 //#region src/string/template.ts

package/dist/string/normalize.d.mts

@@ -11,10 +11,20 @@ type NormalizeOptions = {
    * Convert the string to lower case? _(defaults to `true`)_
    */
   lowerCase?: boolean;
+  /**
+   * Remove special characters from the string? _(defaults to `false`)_
+   *
+   * _(Punctuation and symbol characters are considered special)_
+   */
+  special?: boolean;
   /**
    * Trim the string? _(defaults to `true`)_
    */
   trim?: boolean;
+  /**
+   * Shorten consecutive whitespace characters to a single space? _(defaults to `true`)_
+   */
+  whitespace?: boolean;
 };
 /**
  * String normalizer function

package/dist/string/normalize.mjs

@@ -21,7 +21,9 @@ function getNormalizeOptions(input) {
 	return {
 		deburr: options.deburr !== false,
 		lowerCase: options.lowerCase !== false,
-		trim: options.trim !== false
+		special: options.special === true,
+		trim: options.trim !== false,
+		whitespace: options.whitespace !== false
 	};
 }
 /**
@@ -49,9 +51,11 @@ function normalizeString(value, options) {
 	if (typeof value !== "string") return "";
 	let result = value;
 	if (options.trim) result = result.trim();
+	if (options.whitespace) result = result.replace(WHITESPACE_PATTERN, WHITESPACE_REPLACEMENT);
 	if (options.deburr) result = deburr(result);
 	if (options.lowerCase) result = lowerCase(result);
-	return result;
+	if (options.special) result = result.replace(SPECIAL_PATTERN, SPECIAL_REPLACEMENT);
+	return result.normalize(NORMALIZATION_NORMALIZATION);
 }
 const DEBURR_CHARACTERS = {
 	Æ: "AE",
@@ -88,6 +92,11 @@ const DEBURR_CHARACTERS = {
 const DEBURR_NORMALIZATION = "NFD";
 const DEBURR_PATTERN_CHARACTERS = new RegExp(`(${Object.keys(DEBURR_CHARACTERS).join("|")})`, "g");
 const DEBURR_PATTERN_SIMPLE = /[\u0300-\u036f]/g;
+const NORMALIZATION_NORMALIZATION = "NFC";
+const SPECIAL_PATTERN = /[\p{P}\p{S}]/gu;
+const SPECIAL_REPLACEMENT = "";
+const WHITESPACE_PATTERN = /\s+/g;
+const WHITESPACE_REPLACEMENT = " ";
 let deburrMemoizer;
 //#endregion
 export { deburr, initializeNormalizer, normalize };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.182.1",
+	"version": "0.183.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"helper",

package/src/string/normalize.ts

@@ -16,10 +16,20 @@ export type NormalizeOptions = {
 	 * Convert the string to lower case? _(defaults to `true`)_
 	 */
 	lowerCase?: boolean;
+	/**
+	 * Remove special characters from the string? _(defaults to `false`)_
+	 *
+	 * _(Punctuation and symbol characters are considered special)_
+	 */
+	special?: boolean;
 	/**
 	 * Trim the string? _(defaults to `true`)_
 	 */
 	trim?: boolean;
+	/**
+	 * Shorten consecutive whitespace characters to a single space? _(defaults to `true`)_
+	 */
+	whitespace?: boolean;
 };
 
 /**
@@ -70,7 +80,9 @@ function getNormalizeOptions(input?: NormalizeOptions): Options {
 	return {
 		deburr: options.deburr !== false,
 		lowerCase: options.lowerCase !== false,
+		special: options.special === true,
 		trim: options.trim !== false,
+		whitespace: options.whitespace !== false,
 	};
 }
 
@@ -110,6 +122,10 @@ function normalizeString(value: string, options: Options): string {
 		result = result.trim();
 	}
 
+	if (options.whitespace) {
+		result = result.replace(WHITESPACE_PATTERN, WHITESPACE_REPLACEMENT);
+	}
+
 	if (options.deburr) {
 		result = deburr(result);
 	}
@@ -118,7 +134,11 @@ function normalizeString(value: string, options: Options): string {
 		result = lowerCase(result);
 	}
 
-	return result;
+	if (options.special) {
+		result = result.replace(SPECIAL_PATTERN, SPECIAL_REPLACEMENT);
+	}
+
+	return result.normalize(NORMALIZATION_NORMALIZATION);
 }
 
 // #endregion
@@ -164,6 +184,16 @@ const DEBURR_PATTERN_CHARACTERS = new RegExp(`(${Object.keys(DEBURR_CHARACTERS).
 
 const DEBURR_PATTERN_SIMPLE = /[\u0300-\u036f]/g;
 
+const NORMALIZATION_NORMALIZATION = 'NFC';
+
+const SPECIAL_PATTERN = /[\p{P}\p{S}]/gu;
+
+const SPECIAL_REPLACEMENT = '';
+
+const WHITESPACE_PATTERN = /\s+/g;
+
+const WHITESPACE_REPLACEMENT = ' ';
+
 let deburrMemoizer: Memoized<typeof deburr>;
 
 // #endregion