@salespark/toolkit 2.1.8 → 2.1.9

package/dist/index.d.cts

@@ -233,6 +233,20 @@ declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): O
 declare function objectToString(obj: unknown): string;
 declare function cleanObject<T = unknown>(obj: T, removeEmptyString?: boolean): any;
 
+type Locale = string | string[] | undefined;
+type CapitalizeFirstOptions = {
+    lowerRest?: boolean;
+    locale?: Locale;
+};
+type CapitalizeWordsOptions = {
+    lowerRest?: boolean;
+    locale?: Locale;
+    treatHyphenAsSeparator?: boolean;
+};
+type SentenceCaseOptions = {
+    lowerRest?: boolean;
+    locale?: Locale;
+};
 /******************************************************
  * ##: Slugify String
  * Converts a string to a URL-friendly slug (basic ASCII, keeps numbers and dashes)
@@ -261,6 +275,33 @@ declare function fill(template: string, values: Record<string, string | number>)
  * 21-08-2025: Created
  ****************************************************/
 declare function deburr(str: string): string;
+/******************************************************
+ * ##: Capitalize First Letter
+ * Capitalizes only the first character of a string; optionally lowercases the rest
+ * @param {String} input - Input string
+ * @param {Object} options - { lowerRest = true, locale }
+ * History:
+ * 19-12-2025: Created
+ ****************************************************/
+declare function capitalizeFirst(input: unknown, options?: CapitalizeFirstOptions): string;
+/******************************************************
+ * ##: Capitalize Words
+ * Capitalizes each word in a string with options for hyphens and locale
+ * @param {String} input - Input string
+ * @param {Object} options - { lowerRest = true, locale, treatHyphenAsSeparator = false }
+ * History:
+ * 19-12-2025: Created
+ ****************************************************/
+declare function capitalizeWords(input: unknown, options?: CapitalizeWordsOptions): string;
+/******************************************************
+ * ##: Sentence Case
+ * Capitalizes the first letter of each sentence (. ! ?) with optional lowercasing of the rest
+ * @param {String} input - Input string
+ * @param {Object} options - { lowerRest = true, locale }
+ * History:
+ * 19-12-2025: Created
+ ****************************************************/
+declare function sentenceCase(input: unknown, options?: SentenceCaseOptions): string;
 /**
  * @deprecated Use `deburr` instead.
  */
@@ -781,4 +822,4 @@ declare const assessSecurityRisks: (risks: SecurityRisk[]) => {
 declare const isBrowser: boolean;
 declare const isNode: boolean;
 
-export { type SecurityCheckResult, type SecurityRisk, addSpaceBetweenNumbers, addThousandsSpace, areArraysDeepEqualUnordered, areArraysEqual, assessSecurityRisks, basicSanitize, checkMarkdownSecurity, chunk, clamp, cleanObject, compact, currencyToSymbol, debounce, deburr, delay, difference, fill, flatten, flattenDepth, flattenDepthBase, flattenOnce, formatBytes, formatCurrency, formatDecimalNumber, getStringSimilarity, groupBy, hasNilOrEmpty, humanFileSize, intersection, isBrowser, isFlattenable, isNil, isNilEmptyOrZeroLen, isNilEmptyOrZeroLength, isNilOrEmpty, isNilOrNaN, isNilOrZeroLen, isNilOrZeroLength, isNilText, isNilTextOrEmpty, isNode, isNullOrUndefined, isNullOrUndefinedEmptyOrZero, isNullOrUndefinedInArray, isNullOrUndefinedOrNaN, isNullOrUndefinedTextInc, isNullUndefinedOrEmpty, isNullUndefinedOrEmptyEnforced, isNullUndefinedOrZero, isPTTaxId, isValidIBAN, isValidPTTaxId, numbersEqual, objectToString, omit, otp, parseName, parseToBool, parseToNumber, pick, pluck, pushAll, randomDigits, removeDiacritics, round, safeAdd, safeDivide, safeMultiply, safeParseFloat, safeParseInt, safeSubtract, sanitize, sanitizeMarkdown, shuffle, slugify, sortBy, stringSimilarity, symbolToCurrency, throttle, toBool, toInteger, toNumber, uniq, uniqBy };
+export { type CapitalizeFirstOptions, type CapitalizeWordsOptions, type SecurityCheckResult, type SecurityRisk, type SentenceCaseOptions, addSpaceBetweenNumbers, addThousandsSpace, areArraysDeepEqualUnordered, areArraysEqual, assessSecurityRisks, basicSanitize, capitalizeFirst, capitalizeWords, checkMarkdownSecurity, chunk, clamp, cleanObject, compact, currencyToSymbol, debounce, deburr, delay, difference, fill, flatten, flattenDepth, flattenDepthBase, flattenOnce, formatBytes, formatCurrency, formatDecimalNumber, getStringSimilarity, groupBy, hasNilOrEmpty, humanFileSize, intersection, isBrowser, isFlattenable, isNil, isNilEmptyOrZeroLen, isNilEmptyOrZeroLength, isNilOrEmpty, isNilOrNaN, isNilOrZeroLen, isNilOrZeroLength, isNilText, isNilTextOrEmpty, isNode, isNullOrUndefined, isNullOrUndefinedEmptyOrZero, isNullOrUndefinedInArray, isNullOrUndefinedOrNaN, isNullOrUndefinedTextInc, isNullUndefinedOrEmpty, isNullUndefinedOrEmptyEnforced, isNullUndefinedOrZero, isPTTaxId, isValidIBAN, isValidPTTaxId, numbersEqual, objectToString, omit, otp, parseName, parseToBool, parseToNumber, pick, pluck, pushAll, randomDigits, removeDiacritics, round, safeAdd, safeDivide, safeMultiply, safeParseFloat, safeParseInt, safeSubtract, sanitize, sanitizeMarkdown, sentenceCase, shuffle, slugify, sortBy, stringSimilarity, symbolToCurrency, throttle, toBool, toInteger, toNumber, uniq, uniqBy };

package/dist/index.d.ts

@@ -233,6 +233,20 @@ declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): O
 declare function objectToString(obj: unknown): string;
 declare function cleanObject<T = unknown>(obj: T, removeEmptyString?: boolean): any;
 
+type Locale = string | string[] | undefined;
+type CapitalizeFirstOptions = {
+    lowerRest?: boolean;
+    locale?: Locale;
+};
+type CapitalizeWordsOptions = {
+    lowerRest?: boolean;
+    locale?: Locale;
+    treatHyphenAsSeparator?: boolean;
+};
+type SentenceCaseOptions = {
+    lowerRest?: boolean;
+    locale?: Locale;
+};
 /******************************************************
  * ##: Slugify String
  * Converts a string to a URL-friendly slug (basic ASCII, keeps numbers and dashes)
@@ -261,6 +275,33 @@ declare function fill(template: string, values: Record<string, string | number>)
  * 21-08-2025: Created
  ****************************************************/
 declare function deburr(str: string): string;
+/******************************************************
+ * ##: Capitalize First Letter
+ * Capitalizes only the first character of a string; optionally lowercases the rest
+ * @param {String} input - Input string
+ * @param {Object} options - { lowerRest = true, locale }
+ * History:
+ * 19-12-2025: Created
+ ****************************************************/
+declare function capitalizeFirst(input: unknown, options?: CapitalizeFirstOptions): string;
+/******************************************************
+ * ##: Capitalize Words
+ * Capitalizes each word in a string with options for hyphens and locale
+ * @param {String} input - Input string
+ * @param {Object} options - { lowerRest = true, locale, treatHyphenAsSeparator = false }
+ * History:
+ * 19-12-2025: Created
+ ****************************************************/
+declare function capitalizeWords(input: unknown, options?: CapitalizeWordsOptions): string;
+/******************************************************
+ * ##: Sentence Case
+ * Capitalizes the first letter of each sentence (. ! ?) with optional lowercasing of the rest
+ * @param {String} input - Input string
+ * @param {Object} options - { lowerRest = true, locale }
+ * History:
+ * 19-12-2025: Created
+ ****************************************************/
+declare function sentenceCase(input: unknown, options?: SentenceCaseOptions): string;
 /**
  * @deprecated Use `deburr` instead.
  */
@@ -781,4 +822,4 @@ declare const assessSecurityRisks: (risks: SecurityRisk[]) => {
 declare const isBrowser: boolean;
 declare const isNode: boolean;
 
-export { type SecurityCheckResult, type SecurityRisk, addSpaceBetweenNumbers, addThousandsSpace, areArraysDeepEqualUnordered, areArraysEqual, assessSecurityRisks, basicSanitize, checkMarkdownSecurity, chunk, clamp, cleanObject, compact, currencyToSymbol, debounce, deburr, delay, difference, fill, flatten, flattenDepth, flattenDepthBase, flattenOnce, formatBytes, formatCurrency, formatDecimalNumber, getStringSimilarity, groupBy, hasNilOrEmpty, humanFileSize, intersection, isBrowser, isFlattenable, isNil, isNilEmptyOrZeroLen, isNilEmptyOrZeroLength, isNilOrEmpty, isNilOrNaN, isNilOrZeroLen, isNilOrZeroLength, isNilText, isNilTextOrEmpty, isNode, isNullOrUndefined, isNullOrUndefinedEmptyOrZero, isNullOrUndefinedInArray, isNullOrUndefinedOrNaN, isNullOrUndefinedTextInc, isNullUndefinedOrEmpty, isNullUndefinedOrEmptyEnforced, isNullUndefinedOrZero, isPTTaxId, isValidIBAN, isValidPTTaxId, numbersEqual, objectToString, omit, otp, parseName, parseToBool, parseToNumber, pick, pluck, pushAll, randomDigits, removeDiacritics, round, safeAdd, safeDivide, safeMultiply, safeParseFloat, safeParseInt, safeSubtract, sanitize, sanitizeMarkdown, shuffle, slugify, sortBy, stringSimilarity, symbolToCurrency, throttle, toBool, toInteger, toNumber, uniq, uniqBy };
+export { type CapitalizeFirstOptions, type CapitalizeWordsOptions, type SecurityCheckResult, type SecurityRisk, type SentenceCaseOptions, addSpaceBetweenNumbers, addThousandsSpace, areArraysDeepEqualUnordered, areArraysEqual, assessSecurityRisks, basicSanitize, capitalizeFirst, capitalizeWords, checkMarkdownSecurity, chunk, clamp, cleanObject, compact, currencyToSymbol, debounce, deburr, delay, difference, fill, flatten, flattenDepth, flattenDepthBase, flattenOnce, formatBytes, formatCurrency, formatDecimalNumber, getStringSimilarity, groupBy, hasNilOrEmpty, humanFileSize, intersection, isBrowser, isFlattenable, isNil, isNilEmptyOrZeroLen, isNilEmptyOrZeroLength, isNilOrEmpty, isNilOrNaN, isNilOrZeroLen, isNilOrZeroLength, isNilText, isNilTextOrEmpty, isNode, isNullOrUndefined, isNullOrUndefinedEmptyOrZero, isNullOrUndefinedInArray, isNullOrUndefinedOrNaN, isNullOrUndefinedTextInc, isNullUndefinedOrEmpty, isNullUndefinedOrEmptyEnforced, isNullUndefinedOrZero, isPTTaxId, isValidIBAN, isValidPTTaxId, numbersEqual, objectToString, omit, otp, parseName, parseToBool, parseToNumber, pick, pluck, pushAll, randomDigits, removeDiacritics, round, safeAdd, safeDivide, safeMultiply, safeParseFloat, safeParseInt, safeSubtract, sanitize, sanitizeMarkdown, sentenceCase, shuffle, slugify, sortBy, stringSimilarity, symbolToCurrency, throttle, toBool, toInteger, toNumber, uniq, uniqBy };

package/dist/index.js

@@ -209,6 +209,12 @@ function cleanObject(obj, removeEmptyString = false) {
 }
 
 // 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, "");
 }
@@ -222,6 +228,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 "";
@@ -1694,6 +1732,6 @@ var assessSecurityRisks = (risks) => {
 var isBrowser = typeof globalThis !== "undefined" && typeof globalThis.document !== "undefined";
 var isNode = typeof process !== "undefined" && !!process.versions?.node;
 
-export { addSpaceBetweenNumbers, addThousandsSpace, areArraysDeepEqualUnordered, areArraysEqual, assessSecurityRisks, basicSanitize, checkMarkdownSecurity, chunk, clamp, cleanObject, compact, currencyToSymbol, debounce, deburr, delay, difference, fill, flatten, flattenDepth, flattenDepthBase, flattenOnce, formatBytes, formatCurrency, formatDecimalNumber, getStringSimilarity, groupBy, hasNilOrEmpty, humanFileSize, intersection, isBrowser, isFlattenable, isNil, isNilEmptyOrZeroLen, isNilEmptyOrZeroLength, isNilOrEmpty, isNilOrNaN, isNilOrZeroLen, isNilOrZeroLength, isNilText, isNilTextOrEmpty, isNode, isNullOrUndefined, isNullOrUndefinedEmptyOrZero, isNullOrUndefinedInArray, isNullOrUndefinedOrNaN, isNullOrUndefinedTextInc, isNullUndefinedOrEmpty, isNullUndefinedOrEmptyEnforced, isNullUndefinedOrZero, isPTTaxId, isValidIBAN, isValidPTTaxId, numbersEqual, objectToString, omit, otp, parseName, parseToBool, parseToNumber, pick, pluck, pushAll, randomDigits, removeDiacritics, round, safeAdd, safeDivide, safeMultiply, safeParseFloat, safeParseInt, safeSubtract, sanitize, sanitizeMarkdown, shuffle, slugify, sortBy, stringSimilarity, symbolToCurrency, throttle, toBool, toInteger, toNumber, uniq, uniqBy };
+export { addSpaceBetweenNumbers, addThousandsSpace, areArraysDeepEqualUnordered, areArraysEqual, assessSecurityRisks, basicSanitize, capitalizeFirst, capitalizeWords, checkMarkdownSecurity, chunk, clamp, cleanObject, compact, currencyToSymbol, debounce, deburr, delay, difference, fill, flatten, flattenDepth, flattenDepthBase, flattenOnce, formatBytes, formatCurrency, formatDecimalNumber, getStringSimilarity, groupBy, hasNilOrEmpty, humanFileSize, intersection, isBrowser, isFlattenable, isNil, isNilEmptyOrZeroLen, isNilEmptyOrZeroLength, isNilOrEmpty, isNilOrNaN, isNilOrZeroLen, isNilOrZeroLength, isNilText, isNilTextOrEmpty, isNode, isNullOrUndefined, isNullOrUndefinedEmptyOrZero, isNullOrUndefinedInArray, isNullOrUndefinedOrNaN, isNullOrUndefinedTextInc, isNullUndefinedOrEmpty, isNullUndefinedOrEmptyEnforced, isNullUndefinedOrZero, isPTTaxId, isValidIBAN, isValidPTTaxId, numbersEqual, objectToString, omit, otp, parseName, parseToBool, parseToNumber, pick, pluck, pushAll, randomDigits, removeDiacritics, round, safeAdd, safeDivide, safeMultiply, safeParseFloat, safeParseInt, safeSubtract, sanitize, sanitizeMarkdown, sentenceCase, shuffle, slugify, sortBy, stringSimilarity, symbolToCurrency, throttle, toBool, toInteger, toNumber, uniq, uniqBy };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map