@8ms/helpers 2.0.30 → 2.0.31

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "2.0.30",
+	"version": "2.0.31",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"

package/string/getCapitalised.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCapitalised = void 0;
+const reservedWords_1 = require("./reservedWords");
 /**
  * Convert a string into Capitalised Text.
  * https://stackoverflow.com/a/196991/2664955
@@ -10,6 +11,12 @@ const getCapitalised = (input, split = "_") => {
     return input
         .replace(regex, " ")
         .replace(/\w\S*/g, function (txt) {
+        // Check if individual word is reserved
+        const reservedWord = (0, reservedWords_1.isReservedWord)(txt);
+        if (reservedWord) {
+            return reservedWord;
+        }
+        // Regular capitalization for non-reserved words
         return txt.charAt(0)
             .toUpperCase() + txt.substr(1)
             .toLowerCase();

package/string/getProperCase.d.ts

@@ -1,5 +1,5 @@
 type GetProperCaseProps = {
-    input: string;
+    input: any;
     hyphen?: boolean;
     pipe?: boolean;
     underscore?: boolean;

package/string/getProperCase.js

@@ -1,25 +1,47 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProperCase = void 0;
+const reservedWords_1 = require("./reservedWords");
 /**
  * Return a string "With Proper Casing".
  */
 const getProperCase = (props) => {
-    let response = props.input;
+    const cleanInput = props.input.toString()
+        .trim();
+    // Don't process if the entire input is a reserved word
+    if (reservedWords_1.reservedWords.includes(cleanInput.toUpperCase())) {
+        return cleanInput;
+    }
+    // Build the split pattern - always include spaces
+    let splitPattern = /\s+/;
+    // Add optional separators based on user preferences
+    const separators = [];
     if (props?.hyphen) {
-        response = response.split(/-/g)
-            .join(" ");
+        separators.push("-");
     }
     if (props?.pipe) {
-        response = response.split(/\|/g)
-            .join(" ");
+        separators.push("\\|");
     }
     if (props?.underscore) {
-        response = response.split(/_/g)
-            .join(" ");
+        separators.push("_");
+    }
+    if (separators.length > 0) {
+        splitPattern = new RegExp(`[\\s${separators.join("")}]+`, "g");
     }
-    return response.replace(/\w\S*/g, word => word.charAt(0)
-        .toUpperCase() + word.substr(1)
-        .toLowerCase());
+    // Split the input into words and apply proper casing
+    const words = cleanInput.split(splitPattern)
+        .filter(word => word.length > 0) // Remove empty strings
+        .map(word => {
+        // Check if individual word is reserved
+        const reservedWord = (0, reservedWords_1.isReservedWord)(word);
+        if (reservedWord) {
+            return reservedWord;
+        }
+        // Apply proper case
+        return word.charAt(0)
+            .toUpperCase() + word.slice(1)
+            .toLowerCase();
+    });
+    return words.join(' ');
 };
 exports.getProperCase = getProperCase;

package/string/reservedWords.d.ts

@@ -0,0 +1,5 @@
+export declare const reservedWords: string[];
+/**
+ * Check if its a reserved word, the casing may be specific eg, OpenAI.
+ */
+export declare const isReservedWord: (word: string) => any;

package/string/reservedWords.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isReservedWord = exports.reservedWords = void 0;
+exports.reservedWords = [
+    "AI",
+    "GA4",
+    "GSC",
+    "OpenAI",
+    "PPC",
+    "SEO",
+    "UpTimeRobot",
+];
+/**
+ * Check if its a reserved word, the casing may be specific eg, OpenAI.
+ */
+const isReservedWord = (word) => {
+    let response = null;
+    for (let i = 0; i < exports.reservedWords.length; i++) {
+        if (exports.reservedWords[i].toLowerCase() === word.toLowerCase()) {
+            response = exports.reservedWords[i];
+            break;
+        }
+    }
+    return response;
+};
+exports.isReservedWord = isReservedWord;