@salespark/toolkit 2.1.7 → 2.1.9

package/README.md

@@ -26,7 +26,7 @@ npm i @salespark/toolkit
 
 - **Array utilities**: chunk, uniqBy, deep equality, flatten, groupBy, etc.
 - **Object utilities**: pick, omit, clean objects, deep merge, etc.
-- **String utilities**: slugify, template fill, deburr, sanitize, etc.
+- **String utilities**: slugify, template fill, deburr, sanitize, capitalize words/sentences.
 - **Number utilities**: clamp, round, safe arithmetic/comparisons, safe parse (locale-aware), random digits, etc.
 - **Function utilities**: debounce, throttle, formatCurrency, parseName, currency conversions, etc.
 - **Boolean utilities**: safe boolean conversion with common representations
@@ -267,16 +267,31 @@ objectToString({ name: "John", age: 30 });
 // Result: "name=John_age=30"
 ```
 
-**`cleanObject<T>(obj: T): any`** — Deep-cleans an object by removing null/undefined values.
+**`cleanObject<T>(obj: T, removeEmptyString?: boolean): any`** — Deep-cleans an object by removing null/undefined-like values, with optional empty-string removal.
 
 ```javascript
+// Default behaviour: keep empty strings
 cleanObject({
   name: "John",
   age: null,
   city: undefined,
+  note: "",
   data: { valid: true, invalid: null },
 });
-// Result: {name: 'John', data: {valid: true}}
+// Result: {name: 'John', note: '', data: {valid: true}}
+
+// With removeEmptyString enabled
+cleanObject(
+  {
+    name: "John",
+    age: null,
+    city: undefined,
+    note: "",
+    tags: ["", "ok"],
+  },
+  true
+);
+// Result: {name: 'John', tags: ['ok']}
 ```
 
 ### 🔤 String Utilities
@@ -302,6 +317,30 @@ deburr("café résumé naïve");
 // Result: "cafe resume naive"
 ```
 
+**`capitalizeFirst(input: string, options?: { lowerRest?: boolean; locale?: string | string[] }): string`** — Capitalizes only the first character; optionally lowercases the rest.
+
+```javascript
+capitalizeFirst("hELLO world");
+// Result: "Hello world"
+```
+
+**`capitalizeWords(input: string, options?: { lowerRest?: boolean; locale?: string | string[]; treatHyphenAsSeparator?: boolean }): string`** — Capitalizes each word; can treat hyphen as separator.
+
+```javascript
+capitalizeWords("e-mail marketing");
+// Result: "E-mail Marketing"
+
+capitalizeWords("e-mail marketing", { treatHyphenAsSeparator: true });
+// Result: "E-Mail Marketing"
+```
+
+**`sentenceCase(input: string, options?: { lowerRest?: boolean; locale?: string | string[] }): string`** — Capitalizes the start of each sentence (. ! ?); optionally lowercases the rest.
+
+```javascript
+sentenceCase("hello world. this is fine!");
+// Result: "Hello world. This is fine!"
+```
+
 **`sanitize(input: unknown, maxLength?: number): string`** — Sanitizes input by removing dangerous content.
 
 ```javascript
@@ -856,5 +895,5 @@ MIT © [SalesPark](https://salespark.io)
 
 ---
 
-_Document version: 9_  
-_Last update: 01-12-2025_
+_Document version: 11_  
+_Last update: 19-12-2025_

package/dist/index.cjs

@@ -187,18 +187,18 @@ function objectToString(obj) {
     }
   }
 }
-var isRemovable = (v) => v === null || v === void 0 || v === "null" || v === "undefined";
-function cleanObject(obj) {
+var isRemovable = (v, removeEmptyString) => v === null || v === void 0 || v === "null" || v === "undefined" || removeEmptyString && v === "";
+function cleanObject(obj, removeEmptyString = false) {
   if (Array.isArray(obj)) {
-    const cleanedArray = obj.map((item) => cleanObject(item)).filter((item) => !isRemovable(item));
+    const cleanedArray = obj.map((item) => cleanObject(item, removeEmptyString)).filter((item) => !isRemovable(item, removeEmptyString));
     return cleanedArray;
   }
   if (obj !== null && typeof obj === "object") {
     const cleaned = {};
     for (const [key, value] of Object.entries(obj)) {
-      if (isRemovable(value)) continue;
-      const nested = cleanObject(value);
-      if (isRemovable(nested)) continue;
+      if (isRemovable(value, removeEmptyString)) continue;
+      const nested = cleanObject(value, removeEmptyString);
+      if (isRemovable(nested, removeEmptyString)) continue;
       const isObj = typeof nested === "object" && nested !== null;
       const isEmptyObj = isObj && !Array.isArray(nested) && Object.keys(nested).length === 0;
       const isEmptyArr = Array.isArray(nested) && nested.length === 0;
@@ -211,6 +211,12 @@ function cleanObject(obj) {
 }
 
 // src/utils/string.ts
+function upper(value, locale) {
+  return locale ? value.toLocaleUpperCase(locale) : value.toUpperCase();
+}
+function lower(value, locale) {
+  return locale ? value.toLocaleLowerCase(locale) : value.toLowerCase();
+}
 function slugify(input) {
   return input.normalize("NFKD").replace(/[\u0300-\u036f]/g, "").toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
 }
@@ -224,6 +230,38 @@ function deburr(str) {
     return str;
   }
 }
+function capitalizeFirst(input, options) {
+  if (typeof input !== "string" || input.length === 0) return "";
+  const { lowerRest = true, locale } = options ?? {};
+  const first = upper(input[0], locale);
+  const rest = lowerRest ? lower(input.slice(1), locale) : input.slice(1);
+  return first + rest;
+}
+function capitalizeWords(input, options) {
+  if (typeof input !== "string" || input.length === 0) return "";
+  const {
+    lowerRest = true,
+    locale,
+    treatHyphenAsSeparator = false
+  } = options ?? {};
+  const wordPattern = treatHyphenAsSeparator ? /[\p{L}\p{N}]+(?:['’][\p{L}\p{N}]+)*/gu : /[\p{L}\p{N}]+(?:['’\-][\p{L}\p{N}]+)*/gu;
+  return input.replace(wordPattern, (word) => {
+    const first = upper(word[0], locale);
+    const rest = lowerRest ? lower(word.slice(1), locale) : word.slice(1);
+    return first + rest;
+  });
+}
+function sentenceCase(input, options) {
+  if (typeof input !== "string" || input.length === 0) return "";
+  const { lowerRest = true, locale } = options ?? {};
+  const base = lowerRest ? lower(input, locale) : input;
+  const sentencePattern = /(^\s*[\p{L}])|([.!?]\s*[\p{L}])/gu;
+  return base.replace(sentencePattern, (match) => {
+    const lastChar = match[match.length - 1];
+    const upperChar = upper(lastChar, locale);
+    return match.slice(0, -1) + upperChar;
+  });
+}
 var removeDiacritics = deburr;
 function sanitize(input, maxLength) {
   if (typeof input !== "string") return "";
@@ -1702,6 +1740,8 @@ exports.areArraysDeepEqualUnordered = areArraysDeepEqualUnordered;
 exports.areArraysEqual = areArraysEqual;
 exports.assessSecurityRisks = assessSecurityRisks;
 exports.basicSanitize = basicSanitize;
+exports.capitalizeFirst = capitalizeFirst;
+exports.capitalizeWords = capitalizeWords;
 exports.checkMarkdownSecurity = checkMarkdownSecurity;
 exports.chunk = chunk;
 exports.clamp = clamp;
@@ -1769,6 +1809,7 @@ exports.safeParseInt = safeParseInt;
 exports.safeSubtract = safeSubtract;
 exports.sanitize = sanitize;
 exports.sanitizeMarkdown = sanitizeMarkdown;
+exports.sentenceCase = sentenceCase;
 exports.shuffle = shuffle;
 exports.slugify = slugify;
 exports.sortBy = sortBy;