@8ms/helpers 1.3.10 → 1.3.11

package/package.json

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

package/string/getCapitalised.d.ts

@@ -0,0 +1,10 @@
+type GetCapitalised = {
+    input: string;
+    split?: string;
+};
+/**
+ * Convert a string into Capitalised Text.
+ * https://stackoverflow.com/a/196991/2664955
+ */
+declare const getCapitalised: ({ input, split }: GetCapitalised) => string;
+export default getCapitalised;

package/string/{formatCapitalise.js → getCapitalised.js}

@@ -4,13 +4,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * Convert a string into Capitalised Text.
  * https://stackoverflow.com/a/196991/2664955
  */
-const formatCapitalise = ({ input, split } = { input: '', split: '_' }) => {
+const getCapitalised = ({ input, split }) => {
+    const splitToken = split || '_';
     return input
-        .replace(`/${split}/g`, ' ')
+        .replace(`/${splitToken}/g`, ' ')
         .replace(/\w\S*/g, function (txt) {
         return txt.charAt(0)
             .toUpperCase() + txt.substr(1)
             .toLowerCase();
     });
 };
-exports.default = formatCapitalise;
+exports.default = getCapitalised;

package/string/getClean.d.ts

@@ -0,0 +1,18 @@
+type GetClean = {
+    accents?: boolean;
+    decoded?: boolean;
+    htmlTags?: boolean;
+    input: any;
+    lowercase?: boolean;
+    propercase?: boolean;
+    punctuation?: boolean;
+    trim?: boolean;
+    underscores?: boolean;
+    uppercase?: boolean;
+    whitespace?: boolean;
+};
+/**
+ * Shorthand function to get a clean version of a string.
+ */
+declare const getCleanString: ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }: GetClean) => string;
+export default getCleanString;

package/string/getClean.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+const getWithoutHtmlTags_1 = __importDefault(require("./getWithoutHtmlTags"));
+const getWithoutAccents_1 = __importDefault(require("./getWithoutAccents"));
+const getProperCase_1 = __importDefault(require("./getProperCase"));
+const getWithoutWhitespaces_1 = __importDefault(require("./getWithoutWhitespaces"));
+const getWithoutPunctuation_1 = __importDefault(require("./getWithoutPunctuation"));
+const getWithoutUnderscores_1 = __importDefault(require("./getWithoutUnderscores"));
+const getDecoded_1 = __importDefault(require("./getDecoded"));
+/**
+ * Shorthand function to get a clean version of a string.
+ */
+const getCleanString = ({ accents, decoded, htmlTags, input, lowercase, propercase, punctuation, trim, underscores, uppercase, whitespace }) => {
+    let response = (0, getString_1.default)({ input });
+    if (decoded) {
+        response = (0, getDecoded_1.default)({
+            input: response,
+        });
+    }
+    if (accents) {
+        response = (0, getWithoutAccents_1.default)({
+            input: response
+        });
+    }
+    if (htmlTags) {
+        response = (0, getWithoutHtmlTags_1.default)({
+            input: response
+        });
+    }
+    if (underscores) {
+        response = (0, getWithoutUnderscores_1.default)({
+            input: response,
+        });
+    }
+    if (punctuation) {
+        response = (0, getWithoutPunctuation_1.default)({
+            input: response
+        });
+    }
+    if (whitespace) {
+        response = (0, getWithoutWhitespaces_1.default)({
+            input: response
+        });
+    }
+    if (lowercase) {
+        response = response.toLowerCase();
+    }
+    if (propercase) {
+        response = (0, getProperCase_1.default)({
+            input: response
+        });
+    }
+    if (uppercase) {
+        response = response.toUpperCase();
+    }
+    if (trim) {
+        response = response.trim();
+    }
+    return response;
+};
+exports.default = getCleanString;

package/string/getCleanFolder.d.ts

@@ -1,7 +1,8 @@
+type GetCleanFolder = {
+    input: string;
+};
 /**
  * Take an input that may have a / before or after the input and return just the folder.
  */
-declare const getCleanFolder: ({ input }: {
-    input: string;
-}) => string;
+declare const getCleanFolder: ({ input }: GetCleanFolder) => string;
 export default getCleanFolder;

package/string/getCleanFolder.js

@@ -7,6 +7,8 @@ const trim_1 = __importDefault(require("lodash/trim"));
 /**
  * Take an input that may have a / before or after the input and return just the folder.
  */
-const getCleanFolder = ({ input }) => (0, trim_1.default)(input, '/')
-    .trim();
+const getCleanFolder = ({ input }) => {
+    return (0, trim_1.default)(input, '/')
+        .trim();
+};
 exports.default = getCleanFolder;

package/string/{getUnescaped.d.ts → getDecoded.d.ts}

@@ -1,4 +1,4 @@
-type GetUnescaped = {
+type GetDecoded = {
     input: any;
 };
 /**
@@ -6,5 +6,5 @@ type GetUnescaped = {
  * E.g. there's => there's
  * https://stackoverflow.com/a/42182294/2664955
  */
-declare const getUnescaped: ({ input }: GetUnescaped) => string;
-export default getUnescaped;
+declare const getDecoded: ({ input }: GetDecoded) => string;
+export default getDecoded;

package/string/{getUnescaped.js → getDecoded.js}

@@ -5,9 +5,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * E.g. there's => there's
  * https://stackoverflow.com/a/42182294/2664955
  */
-const getUnescaped = ({ input }) => {
+const getDecoded = ({ input }) => {
     let el = document.createElement("textarea");
     el.innerHTML = input;
     return el.value;
 };
-exports.default = getUnescaped;
+exports.default = getDecoded;

package/string/{toProperCase.d.ts → getProperCase.d.ts}

@@ -1,7 +1,7 @@
 /**
  * Return a string "With Proper Casing".
  */
-declare const toProperCase: ({ input }: {
+declare const getProperCase: ({ input }: {
     input: any;
 }) => string;
-export default toProperCase;
+export default getProperCase;

package/string/{toProperCase.js → getProperCase.js}

@@ -7,12 +7,10 @@ const getString_1 = __importDefault(require("./getString"));
 /**
  * Return a string "With Proper Casing".
  */
-const toProperCase = ({ input }) => {
-    const preparedInput = (0, getString_1.default)({ input });
-    const clean = preparedInput.split('_')
-        .join(' ');
-    return clean.replace(/\w\S*/g, word => word.charAt(0)
+const getProperCase = ({ input }) => {
+    const response = (0, getString_1.default)({ input });
+    return response.replace(/\w\S*/g, word => word.charAt(0)
         .toUpperCase() + word.substr(1)
         .toLowerCase());
 };
-exports.default = toProperCase;
+exports.default = getProperCase;

package/string/getWithoutAccents.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutAccents = {
+    input: string;
+};
+/**
+ * Remove the accents from a string.
+ * https://stackoverflow.com/a/37511463
+ */
+declare const getWithoutAccents: ({ input }: GetWithoutAccents) => string;
+export default getWithoutAccents;

package/string/getWithoutAccents.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Remove the accents from a string.
+ * https://stackoverflow.com/a/37511463
+ */
+const getWithoutAccents = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .normalize("NFD")
+        .replace(/[\u0300-\u036f]/g, "");
+};
+exports.default = getWithoutAccents;

package/string/{getStrippedTags.d.ts → getWithoutHtmlTags.d.ts}

@@ -1,9 +1,9 @@
-type GetStrippedTags = {
+type GetWithoutHtmlTags = {
     input: any;
 };
 /**
  * Removes all HTML tags from an input.
  * https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
  */
-declare const getStrippedTags: ({ input }: GetStrippedTags) => string;
-export default getStrippedTags;
+declare const getWithoutHtmlTags: ({ input }: GetWithoutHtmlTags) => string;
+export default getWithoutHtmlTags;

package/string/{getStrippedTags.js → getWithoutHtmlTags.js}

@@ -8,11 +8,11 @@ const getString_1 = __importDefault(require("./getString"));
  * Removes all HTML tags from an input.
  * https://css-tricks.com/snippets/javascript/strip-html-tags-in-javascript/
  */
-const getStrippedTags = ({ input }) => {
+const getWithoutHtmlTags = ({ input }) => {
     const regexPattern = /(<([^>]+)>)/gi;
     const inputString = (0, getString_1.default)({
         input,
     });
     return inputString.replace(regexPattern, '');
 };
-exports.default = getStrippedTags;
+exports.default = getWithoutHtmlTags;

package/string/getWithoutPunctuation.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutPunctuation = {
+    input: string;
+};
+/**
+ * Remove all punctuation from a string and replace with a space.
+ * https://stackoverflow.com/a/25575009
+ */
+declare const getWithoutPunctuation: ({ input }: GetWithoutPunctuation) => string;
+export default getWithoutPunctuation;

package/string/getWithoutPunctuation.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Remove all punctuation from a string and replace with a space.
+ * https://stackoverflow.com/a/25575009
+ */
+const getWithoutPunctuation = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,\-.\/:;<=>?@\[\]^_`{|}~]/g, '')
+        .replace(/\s+/g, ' ');
+};
+exports.default = getWithoutPunctuation;

package/string/getWithoutUnderscores.d.ts

@@ -0,0 +1,8 @@
+type GetWithoutUnderscores = {
+    input: string;
+};
+/**
+ * Replace all underscores with a space.
+ */
+declare const getWithoutUnderscores: ({ input }: GetWithoutUnderscores) => string;
+export default getWithoutUnderscores;

package/string/getWithoutUnderscores.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Replace all underscores with a space.
+ */
+const getWithoutUnderscores = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace('_', ' ');
+};
+exports.default = getWithoutUnderscores;

package/string/getWithoutWhitespaces.d.ts

@@ -0,0 +1,9 @@
+type GetWithoutWhitespaces = {
+    input: string;
+};
+/**
+ * Remove all new lines, tabs multiple spaces, with a single space.
+ * https://stackoverflow.com/a/45029224
+ */
+declare const getWithoutWhitespaces: ({ input }: GetWithoutWhitespaces) => string;
+export default getWithoutWhitespaces;

package/string/getWithoutWhitespaces.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getString_1 = __importDefault(require("./getString"));
+/**
+ * Remove all new lines, tabs multiple spaces, with a single space.
+ * https://stackoverflow.com/a/45029224
+ */
+const getWithoutWhitespaces = ({ input }) => {
+    return (0, getString_1.default)({ input })
+        .replace(/\s+/g, ' ')
+        .trim();
+};
+exports.default = getWithoutWhitespaces;

package/string/formatCapitalise.d.ts

@@ -1,9 +0,0 @@
-/**
- * Convert a string into Capitalised Text.
- * https://stackoverflow.com/a/196991/2664955
- */
-declare const formatCapitalise: ({ input, split }?: {
-    input: string;
-    split: string;
-}) => string;
-export default formatCapitalise;