nhb-toolbox 2.3.3 → 2.3.5

package/dist/string/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const LOWERCASE: string[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/string/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/string/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,EAAE,MAAM,EAiIpB,CAAC"}

package/dist/string/constants.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LOWERCASE = void 0;
+exports.LOWERCASE = [
+    // Conjunctions
+    'and',
+    'but',
+    'or',
+    'nor',
+    'for',
+    'so',
+    'yet',
+    'after',
+    'although',
+    'as',
+    'because',
+    'before',
+    'even',
+    'if',
+    'once',
+    'since',
+    'than',
+    'that',
+    'though',
+    'unless',
+    'until',
+    'when',
+    'whenever',
+    'where',
+    'whereas',
+    'wherever',
+    'whether',
+    'while',
+    // Prepositions
+    'about',
+    'above',
+    'across',
+    'after',
+    'against',
+    'along',
+    'among',
+    'around',
+    'as',
+    'at',
+    'before',
+    'behind',
+    'below',
+    'beneath',
+    'beside',
+    'between',
+    'beyond',
+    'but',
+    'by',
+    'concerning',
+    'considering',
+    'despite',
+    'down',
+    'during',
+    'except',
+    'following',
+    'for',
+    'from',
+    'in',
+    'inside',
+    'into',
+    'like',
+    'minus',
+    'near',
+    'of',
+    'off',
+    'on',
+    'onto',
+    'opposite',
+    'out',
+    'outside',
+    'over',
+    'past',
+    'per',
+    'plus',
+    'regarding',
+    'round',
+    'save',
+    'since',
+    'than',
+    'through',
+    'throughout',
+    'till',
+    'to',
+    'toward',
+    'towards',
+    'under',
+    'underneath',
+    'unlike',
+    'until',
+    'up',
+    'upon',
+    'versus',
+    'via',
+    'with',
+    'within',
+    'without',
+    // Articles
+    'a',
+    'an',
+    'the',
+    // Auxiliary Verbs
+    'am',
+    'are',
+    'be',
+    'been',
+    'being',
+    'can',
+    'could',
+    'do',
+    'does',
+    'did',
+    'had',
+    'has',
+    'have',
+    'is',
+    'may',
+    'might',
+    'must',
+    'shall',
+    'should',
+    'was',
+    'were',
+    'will',
+    'would',
+];

package/dist/string/convert.d.ts

@@ -1,11 +1,29 @@
+import type { CaseFormat } from './types';
 /**
- * * Converts a string to `camelCase`, `snake_case`, or `kebab-case`.
+ * Converts a string to a specified case format such as `camelCase`, `snake_case`, `kebab-case`, `PascalCase`, `Title Case`, `lowercase`, or `UPPERCASE`.
  *
- * @param string - The input string to be converted. Words should be separated by **non-alphanumeric characters** (e.g., spaces, hyphens, underscores, dots, slashes, etc.).
- * @param format - The format to convert the string to (`'camelCase'`, `'snake_case'`, or `'kebab-case'`).
+ * This function handles non-alphanumeric characters (e.g., spaces, hyphens, underscores, dots, slashes) as word delimiters. For `Title Case`, prepositions, articles, conjunctions, and auxiliary verbs are not capitalized unless they appear at the start of the title.
+ * You can also convert the string to `lowercase` or `UPPERCASE`, but it's recommended to use default string methods like `string.toLowerCase()` and `string.toUpperCase()` for these cases.
+ *
+ * @param string The input string to be converted. The string should have words separated by non-alphanumeric characters (e.g., spaces, hyphens, underscores, etc.).
+ * @param format The format to convert the string to. The available formats are:
+ *   - `'camelCase'`: Converts to camelCase (e.g., `myVariableName`).
+ *   - `'snake_case'`: Converts to snake_case (e.g., `my_variable_name`).
+ *   - `'kebab-case'`: Converts to kebab-case (e.g., `my-variable-name`).
+ *   - `'PascalCase'`: Converts to PascalCase (e.g., `MyVariableName`).
+ *   - `'Title Case'`: Converts to Title Case (e.g., `My Variable Name`), where certain words like `prepositions, articles, conjunctions and auxiliary verbs` are not capitalized unless at the start.
+ *   - `'lowercase'`: Converts the string to all lowercase characters.
+ *   - `'UPPERCASE'`: Converts the string to all uppercase characters.
  * @returns The formatted string in the specified case format.
+ * @example
+ * convertStringCase('my-example_string', 'camelCase'); // returns 'myExampleString'
+ * convertStringCase('my-example_string', 'snake_case'); // returns 'my_example_string'
+ * convertStringCase('my-example_string', 'kebab-case'); // returns 'my-example-string'
+ * convertStringCase('my example string', 'Title Case'); // returns 'My Example String'
+ * convertStringCase('my example string', 'lowercase'); // returns 'my example string'
+ * convertStringCase('my example string', 'UPPERCASE'); // returns 'MY EXAMPLE STRING'
  */
-export declare function convertStringCase(string: string, format: 'camelCase' | 'snake_case' | 'kebab-case'): string;
+export declare function convertStringCase(string: string, format: CaseFormat): string;
 /**
  * Replaces all occurrences of a string or pattern in the given input string.
  *

package/dist/string/convert.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../src/string/convert.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,wBAAgB,iBAAiB,CAChC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,GAC/C,MAAM,CA8BR;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB,UACvB,MAAM,QACP,MAAM,GAAG,MAAM,WACZ,MAAM,KACb,MAgBF,CAAC"}
+{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../../src/string/convert.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,MAAM,CA6E5E;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB,UACvB,MAAM,QACP,MAAM,GAAG,MAAM,WACZ,MAAM,KACb,MAgBF,CAAC"}

package/dist/string/convert.js

@@ -1,28 +1,79 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceAllInString = void 0;
+exports.convertStringCase = convertStringCase;
+const constants_1 = require("./constants");
 /**
- * * Converts a string to `camelCase`, `snake_case`, or `kebab-case`.
+ * Converts a string to a specified case format such as `camelCase`, `snake_case`, `kebab-case`, `PascalCase`, `Title Case`, `lowercase`, or `UPPERCASE`.
+ *
+ * This function handles non-alphanumeric characters (e.g., spaces, hyphens, underscores, dots, slashes) as word delimiters. For `Title Case`, prepositions, articles, conjunctions, and auxiliary verbs are not capitalized unless they appear at the start of the title.
+ * You can also convert the string to `lowercase` or `UPPERCASE`, but it's recommended to use default string methods like `string.toLowerCase()` and `string.toUpperCase()` for these cases.
  *
- * @param string - The input string to be converted. Words should be separated by **non-alphanumeric characters** (e.g., spaces, hyphens, underscores, dots, slashes, etc.).
- * @param format - The format to convert the string to (`'camelCase'`, `'snake_case'`, or `'kebab-case'`).
+ * @param string The input string to be converted. The string should have words separated by non-alphanumeric characters (e.g., spaces, hyphens, underscores, etc.).
+ * @param format The format to convert the string to. The available formats are:
+ *   - `'camelCase'`: Converts to camelCase (e.g., `myVariableName`).
+ *   - `'snake_case'`: Converts to snake_case (e.g., `my_variable_name`).
+ *   - `'kebab-case'`: Converts to kebab-case (e.g., `my-variable-name`).
+ *   - `'PascalCase'`: Converts to PascalCase (e.g., `MyVariableName`).
+ *   - `'Title Case'`: Converts to Title Case (e.g., `My Variable Name`), where certain words like `prepositions, articles, conjunctions and auxiliary verbs` are not capitalized unless at the start.
+ *   - `'lowercase'`: Converts the string to all lowercase characters.
+ *   - `'UPPERCASE'`: Converts the string to all uppercase characters.
  * @returns The formatted string in the specified case format.
+ * @example
+ * convertStringCase('my-example_string', 'camelCase'); // returns 'myExampleString'
+ * convertStringCase('my-example_string', 'snake_case'); // returns 'my_example_string'
+ * convertStringCase('my-example_string', 'kebab-case'); // returns 'my-example-string'
+ * convertStringCase('my example string', 'Title Case'); // returns 'My Example String'
+ * convertStringCase('my example string', 'lowercase'); // returns 'my example string'
+ * convertStringCase('my example string', 'UPPERCASE'); // returns 'MY EXAMPLE STRING'
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceAllInString = void 0;
-exports.convertStringCase = convertStringCase;
 function convertStringCase(string, format) {
     if (!string || typeof string !== 'string')
         return '';
+    const start = string.match(/^[^\d\w\s]+/)?.[0] || '';
+    const end = string.match(/[^\d\w\s]+$/)?.[0] || '';
+    const core = string.replace(/^[^\d\w\s]+|[^\w\s]+$/g, '').trim();
+    const titleCase = core
+        .split(/\s+/g)
+        .map((part) => {
+        const startSymbol = part.match(/^[^\d\w\s]+/)?.[0] || ''; // Capture leading symbols
+        const endSymbol = part.match(/[^\d\w\s]+$/)?.[0] || ''; // Capture trailing symbols
+        const coreWord = part.replace(/^[^\d\w\s]+|[^\d\w\s]+$/g, ''); // Remove them for processing
+        if (constants_1.LOWERCASE.includes(coreWord.toLowerCase())) {
+            return startSymbol + coreWord.toLowerCase() + endSymbol;
+        }
+        return (startSymbol +
+            coreWord.charAt(0).toUpperCase() +
+            coreWord.slice(1) +
+            endSymbol);
+    })
+        .join(' ');
     const formattedString = string.replace(/[^a-zA-Z0-9]+(.)?/g, (_, chr) => (chr ? chr.toUpperCase() : ''));
     if (!formattedString)
         return '';
     switch (format) {
         case 'camelCase':
+            // return formattedString.replace(/[A-Z]/g, (letter, index) =>
+            // 	index === 0 ? letter.toUpperCase() : letter.toLowerCase(),
+            // );
             return (formattedString.charAt(0).toLowerCase() +
                 formattedString.slice(1));
         case 'snake_case':
             return formattedString.replace(/[A-Z]/g, (letter, index) => index === 0 ? letter.toLowerCase() : `_${letter.toLowerCase()}`);
         case 'kebab-case':
             return formattedString.replace(/[A-Z]/g, (letter, index) => index === 0 ? letter.toLowerCase() : `-${letter.toLowerCase()}`);
+        case 'PascalCase':
+            return (formattedString.charAt(0).toUpperCase() +
+                formattedString.slice(1));
+        case 'Title Case':
+            return (start +
+                titleCase.charAt(0).toUpperCase() +
+                titleCase.slice(1) +
+                end);
+        case 'lowercase':
+            return start + core.toLowerCase() + end;
+        case 'UPPERCASE':
+            return start + core.toUpperCase() + end;
         default:
             return formattedString;
     }

package/dist/string/types.d.ts

@@ -33,5 +33,7 @@ export interface AnagramOptions {
     /** Whether to lookup in the dictionary. Default is `false`. */
     validWords?: boolean;
 }
+/** - Case formats for converting a string */
+export type CaseFormat = 'camelCase' | 'snake_case' | 'kebab-case' | 'PascalCase' | 'Title Case' | 'UPPERCASE' | 'lowercase';
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/string/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/string/types.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;IACjC,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,mDAAmD;AACnD,KAAK,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,aAAa,SAAS,OAAO,IACnE,CAAC,SAAS,GAAG,MAAM,KAAK,IAAI,MAAM,IAAI,EAAE,GACvC,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,GAC7D,UAAU,CAAC,CAAC,CAAC,CAAC;AAEjB,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,iBAAiB,IACzE,CAAC,CAAC,eAAe,CAAC,SAAS,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,GAC5C,CAAC,CAAC,qBAAqB,CAAC,SAAS,IAAI,GACtC,eAAe,CACd,CAAC,CAAC,eAAe,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,EACnD,CAAC,CAAC,eAAe,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAC9D,GACA,CAAC,CAAC,eAAe,CAAC,SAAS,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,GAChD,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5B,iDAAiD;AACjD,MAAM,WAAW,eAAe;IAC/B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;CACtC;AAED,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC9B,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACvB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/string/types.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;IACjC,iGAAiG;IACjG,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kFAAkF;IAClF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,mDAAmD;AACnD,KAAK,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,aAAa,SAAS,OAAO,IACnE,CAAC,SAAS,GAAG,MAAM,KAAK,IAAI,MAAM,IAAI,EAAE,GACvC,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,GAC7D,UAAU,CAAC,CAAC,CAAC,CAAC;AAEjB,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,iBAAiB,IACzE,CAAC,CAAC,eAAe,CAAC,SAAS,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,GAC5C,CAAC,CAAC,qBAAqB,CAAC,SAAS,IAAI,GACtC,eAAe,CACd,CAAC,CAAC,eAAe,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,EACnD,CAAC,CAAC,eAAe,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,eAAe,CAAC,GAAG,IAAI,CAC9D,GACA,CAAC,CAAC,eAAe,CAAC,SAAS,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,GAChD,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5B,iDAAiD;AACjD,MAAM,WAAW,eAAe;IAC/B,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8EAA8E;IAC9E,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,gFAAgF;IAChF,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI,CAAC;CACtC;AAED,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC9B,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACvB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,6CAA6C;AAC7C,MAAM,MAAM,UAAU,GACnB,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "2.3.3",
+  "version": "2.3.5",
   "description": "A versatile collection of smart, efficient, and reusable utility functions for everyday development needs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",