feat: Add a util for splitting name (#36)

* feat: Add a util for splitting name

* v0.0.29

* Update eslint

* Update export

* v0.0.30

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatwoot/utils",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "Chatwoot utils",
   "private": false,
   "license": "MIT",
@@ -24,7 +24,6 @@
     "analyze": "size-limit --why",
     "docs": "typedoc --theme default --out docs ./src"
   },
-  "peerDependencies": {},
   "prettier": {
     "printWidth": 80,
     "semi": true,
@@ -44,6 +43,7 @@
   ],
   "devDependencies": {
     "@size-limit/preset-small-lib": "^7.0.8",
+    "@types/jest": "^29.5.14",
     "husky": "^8.0.1",
     "size-limit": "^8.0.0",
     "tsdx": "^0.14.1",

src/helpers.ts

@@ -150,3 +150,43 @@ export const fileNameWithEllipsis = (
 
   return `${name.slice(0, maxLength)}${ellipsis}${extension}`;
 };
+
+/**
+ * @name splitName
+ * @description Splits a full name into firstName and lastName
+ * @param {string} name - Full name of the user
+ * @returns {Object} Object with firstName and lastName
+ * @example
+ * splitName('Mary Jane Smith') // { firstName: 'Mary Jane', lastName: 'Smith' }
+ * splitName('Alice') // { firstName: 'Alice', lastName: '' }
+ * splitName('John Doe') // { firstName: 'John', lastName: 'Doe' }
+ * splitName('') // { firstName: '', lastName: '' }
+ */
+export const splitName = (
+  fullName: string
+): { firstName: string; lastName: string } => {
+  const trimmedName = fullName.trim();
+  if (!trimmedName) {
+    return {
+      firstName: '',
+      lastName: '',
+    };
+  }
+
+  // Split the name by spaces
+  const nameParts = trimmedName.split(/\s+/);
+
+  // If only one word, treat it as firstName
+  if (nameParts.length === 1) {
+    return {
+      firstName: nameParts[0],
+      lastName: '',
+    };
+  }
+
+  // Last element is lastName, everything else is firstName
+  const lastName = nameParts.pop() || '';
+  const firstName = nameParts.join(' ');
+
+  return { firstName, lastName };
+};

src/index.ts

@@ -6,6 +6,7 @@ import {
   trimContent,
   convertSecondsToTimeUnit,
   fileNameWithEllipsis,
+  splitName,
 } from './helpers';
 
 import { parseBoolean } from './string';
@@ -21,21 +22,22 @@ import { createTypingIndicator } from './typingStatus';
 import { evaluateSLAStatus } from './sla';
 
 export {
+  clamp,
+  convertSecondsToTimeUnit,
+  createTypingIndicator,
   debounce,
-  formatTime,
+  evaluateSLAStatus,
+  fileNameWithEllipsis,
   formatDate,
+  formatTime,
   getContrastingTextColor,
-  trimContent,
+  getMessageVariables,
+  getQuantileIntervals,
+  getUndefinedVariablesInMessage,
   parseBoolean,
-  sortAsc,
   quantile,
-  clamp,
-  getQuantileIntervals,
-  getMessageVariables,
   replaceVariablesInMessage,
-  getUndefinedVariablesInMessage,
-  createTypingIndicator,
-  convertSecondsToTimeUnit,
-  fileNameWithEllipsis,
-  evaluateSLAStatus,
+  sortAsc,
+  splitName,
+  trimContent,
 };

test/helpers.test.ts

@@ -1,4 +1,8 @@
-import { convertSecondsToTimeUnit, fileNameWithEllipsis } from '../src/helpers';
+import {
+  convertSecondsToTimeUnit,
+  fileNameWithEllipsis,
+  splitName,
+} from '../src/helpers';
 
 describe('#convertSecondsToTimeUnit', () => {
   it("it should return { time:  1, unit: 'm' } if  60 seconds passed", () => {
@@ -94,3 +98,33 @@ describe('fileNameWithEllipsis', () => {
     expect(fileNameWithEllipsis(file)).toBe('a.txt');
   });
 });
+
+describe('splitName', () => {
+  it('splits a basic first and last name', () => {
+    expect(splitName('John Doe')).toEqual({
+      firstName: 'John',
+      lastName: 'Doe',
+    });
+  });
+
+  it('handles single name', () => {
+    expect(splitName('John')).toEqual({
+      firstName: 'John',
+      lastName: '',
+    });
+  });
+
+  it('handles empty string', () => {
+    expect(splitName('Mary John Ann')).toEqual({
+      firstName: 'Mary John',
+      lastName: 'Ann',
+    });
+  });
+
+  it('handles extra whitespace', () => {
+    expect(splitName('   Jane    Doe   ')).toEqual({
+      firstName: 'Jane',
+      lastName: 'Doe',
+    });
+  });
+});