@bccampus/utils 0.2.2 → 0.3.0

package/dist/set/is-superset.js

@@ -1,12 +1,8 @@
+//#region src/set/is-superset.ts
 function isSuperset(set, subset) {
-  const _set = set instanceof Set ? set : new Set(set);
-  for (const elem of subset) {
-    if (!_set.has(elem)) {
-      return false;
-    }
-  }
-  return true;
+	const _set = set instanceof Set ? set : new Set(set);
+	for (const elem of subset) if (!_set.has(elem)) return false;
+	return true;
 }
-export {
-  isSuperset
-};
+//#endregion
+export { isSuperset };

package/dist/set/set.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/set/symmetric-difference.cjs

@@ -1,14 +1,10 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/set/symmetric-difference.ts
 function symmetricDifference(setA, setB) {
-  const _difference = new Set(setA);
-  for (const elem of setB) {
-    if (_difference.has(elem)) {
-      _difference.delete(elem);
-    } else {
-      _difference.add(elem);
-    }
-  }
-  return _difference;
+	const _difference = new Set(setA);
+	for (const elem of setB) if (_difference.has(elem)) _difference.delete(elem);
+	else _difference.add(elem);
+	return _difference;
 }
+//#endregion
 exports.symmetricDifference = symmetricDifference;

package/dist/set/symmetric-difference.d.ts

@@ -1 +1 @@
-export declare function symmetricDifference(setA: Iterable<any>, setB: Iterable<any>): Set<any>;
+export declare function symmetricDifference(setA: Iterable<unknown>, setB: Iterable<unknown>): Set<unknown>;

package/dist/set/symmetric-difference.js

@@ -1,14 +1,9 @@
+//#region src/set/symmetric-difference.ts
 function symmetricDifference(setA, setB) {
-  const _difference = new Set(setA);
-  for (const elem of setB) {
-    if (_difference.has(elem)) {
-      _difference.delete(elem);
-    } else {
-      _difference.add(elem);
-    }
-  }
-  return _difference;
+	const _difference = new Set(setA);
+	for (const elem of setB) if (_difference.has(elem)) _difference.delete(elem);
+	else _difference.add(elem);
+	return _difference;
 }
-export {
-  symmetricDifference
-};
+//#endregion
+export { symmetricDifference };

package/dist/set/union.cjs

@@ -1,10 +1,9 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/set/union.ts
 function union(setA, setB) {
-  const _union = new Set(setA);
-  for (const elem of setB) {
-    _union.add(elem);
-  }
-  return _union;
+	const _union = new Set(setA);
+	for (const elem of setB) _union.add(elem);
+	return _union;
 }
+//#endregion
 exports.union = union;

package/dist/set/union.d.ts

@@ -1 +1 @@
-export declare function union(setA: Iterable<any>, setB: Iterable<any>): Set<any>;
+export declare function union(setA: Iterable<unknown>, setB: Iterable<unknown>): Set<unknown>;

package/dist/set/union.js

@@ -1,10 +1,8 @@
+//#region src/set/union.ts
 function union(setA, setB) {
-  const _union = new Set(setA);
-  for (const elem of setB) {
-    _union.add(elem);
-  }
-  return _union;
+	const _union = new Set(setA);
+	for (const elem of setB) _union.add(elem);
+	return _union;
 }
-export {
-  union
-};
+//#endregion
+export { union };

package/dist/string/capitalize.cjs

@@ -1,4 +1,7 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const capitalize = (s) => s[0].toUpperCase() + s.slice(1);
+//#region src/string/capitalize.ts
+function capitalize(s) {
+	return s[0].toUpperCase() + s.slice(1);
+}
+//#endregion
 exports.capitalize = capitalize;

package/dist/string/capitalize.d.ts

@@ -1 +1 @@
-export declare const capitalize: <T extends string>(s: T) => Capitalize<typeof s>;
+export declare function capitalize<T extends string>(s: T): string;

package/dist/string/capitalize.js

@@ -1,4 +1,6 @@
-const capitalize = (s) => s[0].toUpperCase() + s.slice(1);
-export {
-  capitalize
-};
+//#region src/string/capitalize.ts
+function capitalize(s) {
+	return s[0].toUpperCase() + s.slice(1);
+}
+//#endregion
+export { capitalize };

package/dist/string/capitalize.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/string/normalize.cjs

@@ -1,6 +1,11 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/string/normalize.ts
+/**
+* Trims white spaces and
+* replaces multiple white space characters with a single space
+*/
 function normalize(text) {
-  return text.trim().replace(/\s+/g, " ");
+	return text.trim().replace(/\s+/g, " ");
 }
+//#endregion
 exports.normalize = normalize;

package/dist/string/normalize.js

@@ -1,6 +1,10 @@
+//#region src/string/normalize.ts
+/**
+* Trims white spaces and
+* replaces multiple white space characters with a single space
+*/
 function normalize(text) {
-  return text.trim().replace(/\s+/g, " ");
+	return text.trim().replace(/\s+/g, " ");
 }
-export {
-  normalize
-};
+//#endregion
+export { normalize };

package/dist/string/normalize.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/string/pluralize/index.cjs

@@ -1,6 +1,7 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const string_pluralize_pluralize = require("./pluralize.cjs");
-const pluralize = new string_pluralize_pluralize.Pluralize();
-exports.Pluralize = string_pluralize_pluralize.Pluralize;
+const require_string_pluralize_pluralize = require("./pluralize.cjs");
+//#region src/string/pluralize/index.ts
+var pluralize = new require_string_pluralize_pluralize.Pluralize();
+//#endregion
+exports.Pluralize = require_string_pluralize_pluralize.Pluralize;
 exports.pluralize = pluralize;

package/dist/string/pluralize/index.js

@@ -1,6 +1,5 @@
 import { Pluralize } from "./pluralize.js";
-const pluralize = new Pluralize();
-export {
-  Pluralize,
-  pluralize
-};
+//#region src/string/pluralize/index.ts
+var pluralize = new Pluralize();
+//#endregion
+export { Pluralize, pluralize };

package/dist/string/pluralize/pluralize.cjs

@@ -1,210 +1,164 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const string_pluralize_rules_irregular = require("./rules/irregular.cjs");
-const string_pluralize_rules_pluralization = require("./rules/pluralization.cjs");
-const string_pluralize_rules_singularization = require("./rules/singularization.cjs");
-const string_pluralize_rules_uncountable = require("./rules/uncountable.cjs");
-const TagIndexRegExp = /\$(\d{1,2})/g;
-class Pluralize {
-  // Rule storage - pluralize and singularize need to be run sequentially,
-  // while other rules can be optimized using an object for instant lookups.
-  pluralRules = [];
-  singularRules = [];
-  uncountables = {};
-  irregularPlurals = {};
-  irregularSingles = {};
-  constructor() {
-    for (let index = 0; index < string_pluralize_rules_irregular.IRREGULAR_WORDS.length; index += 1) {
-      this.addIrregularRule(
-        string_pluralize_rules_irregular.IRREGULAR_WORDS[index][0],
-        string_pluralize_rules_irregular.IRREGULAR_WORDS[index][1]
-      );
-    }
-    for (let index = 0; index < string_pluralize_rules_pluralization.PLURALIZATION_RULES.length; index += 1) {
-      this.addPluralRule(
-        string_pluralize_rules_pluralization.PLURALIZATION_RULES[index][0],
-        string_pluralize_rules_pluralization.PLURALIZATION_RULES[index][1]
-      );
-    }
-    for (let index = 0; index < string_pluralize_rules_singularization.SINGULARIZATION_RULES.length; index += 1) {
-      this.addSingularRule(
-        string_pluralize_rules_singularization.SINGULARIZATION_RULES[index][0],
-        string_pluralize_rules_singularization.SINGULARIZATION_RULES[index][1]
-      );
-    }
-    for (let index = 0; index < string_pluralize_rules_uncountable.UNCOUNTABLE_WORDS.length; index += 1) {
-      this.addUncountableRule(string_pluralize_rules_uncountable.UNCOUNTABLE_WORDS[index]);
-    }
-  }
-  /**
-   * Add a pluralization rule to the collection.
-   */
-  addPluralRule(rule, replacement) {
-    this.pluralRules.push([this.sanitizeRule(rule), replacement]);
-  }
-  /**
-   * Add a singularization rule to the collection.
-   */
-  addSingularRule(rule, replacement) {
-    this.singularRules.push([this.sanitizeRule(rule), replacement]);
-  }
-  /**
-   * Add an uncountable word rule.
-   */
-  addUncountableRule(word) {
-    if (typeof word === "string") {
-      this.uncountables[word.toLowerCase()] = true;
-      return;
-    }
-    this.addPluralRule(word, "$0");
-    this.addSingularRule(word, "$0");
-  }
-  /**
-   * Add an irregular word definition.
-   *
-   * @param {string} single
-   * @param {string} plural
-   */
-  addIrregularRule(single, plural) {
-    plural = plural.toLowerCase();
-    single = single.toLowerCase();
-    this.irregularSingles[single] = plural;
-    this.irregularPlurals[plural] = single;
-  }
-  /**
-   * Sanitize a pluralization rule to a usable regular expression.
-   */
-  sanitizeRule(rule) {
-    if (typeof rule === "string") {
-      return new RegExp(`^${rule}$`, "i");
-    }
-    return rule;
-  }
-  /**
-   * Pass in a word token to produce a function that can replicate the case on
-   * another word.
-   */
-  restoreCase(word, token) {
-    if (word === token) return token;
-    if (word === word.toLowerCase()) return token.toLowerCase();
-    if (word === word.toUpperCase()) return token.toUpperCase();
-    if (word[0] === word[0].toUpperCase()) {
-      return token.charAt(0).toUpperCase() + token.substr(1).toLowerCase();
-    }
-    return token.toLowerCase();
-  }
-  /**
-   * Interpolate a regexp string.
-   *
-   * @param  {string} str
-   * @param  {Array}  args
-   * @return {string}
-   */
-  interpolate(str, args) {
-    return str.replace(TagIndexRegExp, (match, index) => {
-      return args[index] || "";
-    });
-  }
-  /**
-   * Replace a word using a rule.
-   */
-  replace(word, rule) {
-    return word.replace(rule[0], (match, index, ...args) => {
-      const result = this.interpolate(rule[1], args);
-      if (match === "") {
-        return this.restoreCase(word[index - 1], result);
-      }
-      return this.restoreCase(match, result);
-    });
-  }
-  /**
-   * Sanitize a word by passing in the word and sanitization rules.
-   */
-  sanitizeWord(token, word, rules) {
-    if (!token.length || this.uncountables[token]) {
-      return word;
-    }
-    let len = rules.length;
-    while (len--) {
-      const rule = rules[len];
-      if (typeof rule[0] === "string" || rule[0].test(word))
-        return this.replace(word, rule);
-    }
-    return word;
-  }
-  /**
-   * Replace a word with the updated word.
-   */
-  old_replaceWord(replaceMap, keepMap, rules) {
-    return (word) => {
-      const token = word.toLowerCase();
-      if (keepMap[token]) {
-        return this.restoreCase(word, token);
-      }
-      if (replaceMap[token]) {
-        return this.restoreCase(word, replaceMap[token]);
-      }
-      return this.sanitizeWord(token, word, rules);
-    };
-  }
-  /**
-   * Replace a word with the updated word.
-   */
-  replaceWord(word, direction) {
-    const replaceMap = direction === "SingularToPlural" ? this.irregularSingles : this.irregularPlurals;
-    const keepMap = direction === "SingularToPlural" ? this.irregularPlurals : this.irregularSingles;
-    const rules = direction === "SingularToPlural" ? this.pluralRules : this.singularRules;
-    const token = word.toLowerCase();
-    if (keepMap[token]) {
-      return this.restoreCase(word, token);
-    }
-    if (replaceMap[token]) {
-      return this.restoreCase(word, replaceMap[token]);
-    }
-    return this.sanitizeWord(token, word, rules);
-  }
-  /**
-   * Check if a word is part of the map.
-   */
-  checkWord(word, reason) {
-    const replaceMap = reason === "Plurality" ? this.irregularSingles : this.irregularPlurals;
-    const keepMap = reason === "Plurality" ? this.irregularPlurals : this.irregularSingles;
-    const rules = reason === "Singularity" ? this.pluralRules : this.singularRules;
-    const token = word.toLowerCase();
-    if (keepMap[token]) return true;
-    if (replaceMap[token]) return false;
-    return this.sanitizeWord(token, token, rules) === token;
-  }
-  /**
-   * Pluralize or singularize a word based on the passed in count.
-   */
-  pluralize(word, count, inclusive) {
-    const pluralized = count === 1 ? this.singular(word) : this.plural(word);
-    return (inclusive ? `${count} ` : "") + pluralized;
-  }
-  /**
-   * Pluralize a word.
-   */
-  plural(singularWord) {
-    return this.replaceWord(singularWord, "SingularToPlural");
-  }
-  /**
-   * Check if a word is plural.
-   */
-  isPlural(word) {
-    this.checkWord(word, "Plurality");
-  }
-  /**
-   * Singularize a word.
-   */
-  singular(pluralWord) {
-    return this.replaceWord(pluralWord, "PluralToSingular");
-  }
-  /**
-   * Check if a word is singular.
-   */
-  isSingular(word) {
-    this.checkWord(word, "Singularity");
-  }
-}
+const require_string_pluralize_rules_irregular = require("./rules/irregular.cjs");
+const require_string_pluralize_rules_pluralization = require("./rules/pluralization.cjs");
+const require_string_pluralize_rules_singularization = require("./rules/singularization.cjs");
+const require_string_pluralize_rules_uncountable = require("./rules/uncountable.cjs");
+//#region src/string/pluralize/pluralize.ts
+var TagIndexRegExp = /\$(\d{1,2})/g;
+var Pluralize = class {
+	pluralRules = [];
+	singularRules = [];
+	uncountables = {};
+	irregularPlurals = {};
+	irregularSingles = {};
+	constructor() {
+		for (let index = 0; index < require_string_pluralize_rules_irregular.IRREGULAR_WORDS.length; index += 1) this.addIrregularRule(require_string_pluralize_rules_irregular.IRREGULAR_WORDS[index][0], require_string_pluralize_rules_irregular.IRREGULAR_WORDS[index][1]);
+		for (let index = 0; index < require_string_pluralize_rules_pluralization.PLURALIZATION_RULES.length; index += 1) this.addPluralRule(require_string_pluralize_rules_pluralization.PLURALIZATION_RULES[index][0], require_string_pluralize_rules_pluralization.PLURALIZATION_RULES[index][1]);
+		for (let index = 0; index < require_string_pluralize_rules_singularization.SINGULARIZATION_RULES.length; index += 1) this.addSingularRule(require_string_pluralize_rules_singularization.SINGULARIZATION_RULES[index][0], require_string_pluralize_rules_singularization.SINGULARIZATION_RULES[index][1]);
+		for (let index = 0; index < require_string_pluralize_rules_uncountable.UNCOUNTABLE_WORDS.length; index += 1) this.addUncountableRule(require_string_pluralize_rules_uncountable.UNCOUNTABLE_WORDS[index]);
+	}
+	/**
+	* Add a pluralization rule to the collection.
+	*/
+	addPluralRule(rule, replacement) {
+		this.pluralRules.push([this.sanitizeRule(rule), replacement]);
+	}
+	/**
+	* Add a singularization rule to the collection.
+	*/
+	addSingularRule(rule, replacement) {
+		this.singularRules.push([this.sanitizeRule(rule), replacement]);
+	}
+	/**
+	* Add an uncountable word rule.
+	*/
+	addUncountableRule(word) {
+		if (typeof word === "string") {
+			this.uncountables[word.toLowerCase()] = true;
+			return;
+		}
+		this.addPluralRule(word, "$0");
+		this.addSingularRule(word, "$0");
+	}
+	/**
+	* Add an irregular word definition.
+	*
+	* @param {string} single
+	* @param {string} plural
+	*/
+	addIrregularRule(single, plural) {
+		plural = plural.toLowerCase();
+		single = single.toLowerCase();
+		this.irregularSingles[single] = plural;
+		this.irregularPlurals[plural] = single;
+	}
+	/**
+	* Sanitize a pluralization rule to a usable regular expression.
+	*/
+	sanitizeRule(rule) {
+		if (typeof rule === "string") return new RegExp(`^${rule}$`, "i");
+		return rule;
+	}
+	/**
+	* Pass in a word token to produce a function that can replicate the case on
+	* another word.
+	*/
+	restoreCase(word, token) {
+		if (word === token) return token;
+		if (word === word.toUpperCase()) return token.toUpperCase();
+		if (word[0] === word[0].toUpperCase()) return token.charAt(0).toUpperCase() + token.substring(1).toLowerCase();
+		return token.toLowerCase();
+	}
+	/**
+	* Interpolate a regexp string.
+	*
+	* @param  {string} str
+	* @param  {Array}  args
+	* @return {string}
+	*/
+	interpolate(str, args) {
+		return str.replace(TagIndexRegExp, (match, index) => {
+			return args[index] || "";
+		});
+	}
+	/**
+	* Replace a word using a rule.
+	*/
+	replace(word, rule) {
+		return word.replace(rule[0], (...args) => {
+			const [match, index] = args;
+			const result = this.interpolate(rule[1], args);
+			if (match === "") return this.restoreCase(word[index - 1], result);
+			return this.restoreCase(match, result);
+		});
+	}
+	/**
+	* Sanitize a word by passing in the word and sanitization rules.
+	*/
+	sanitizeWord(token, word, rules) {
+		if (!token.length || this.uncountables[token]) return word;
+		let len = rules.length;
+		while (len--) {
+			const rule = rules[len];
+			if (typeof rule[0] === "string" || rule[0].test(word)) return this.replace(word, rule);
+		}
+		return word;
+	}
+	/**
+	* Replace a word with the updated word.
+	*/
+	replaceWord(word, direction) {
+		const replaceMap = direction === "SingularToPlural" ? this.irregularSingles : this.irregularPlurals;
+		const keepMap = direction === "SingularToPlural" ? this.irregularPlurals : this.irregularSingles;
+		const rules = direction === "SingularToPlural" ? this.pluralRules : this.singularRules;
+		const token = word.toLowerCase();
+		if (keepMap[token]) return this.restoreCase(word, token);
+		if (replaceMap[token]) return this.restoreCase(word, replaceMap[token]);
+		return this.sanitizeWord(token, word, rules);
+	}
+	/**
+	* Check if a word is part of the map.
+	*/
+	checkWord(word, reason) {
+		const replaceMap = reason === "Plurality" ? this.irregularSingles : this.irregularPlurals;
+		const keepMap = reason === "Plurality" ? this.irregularPlurals : this.irregularSingles;
+		const rules = reason === "Plurality" ? this.pluralRules : this.singularRules;
+		const token = word.toLowerCase();
+		if (keepMap[token]) return true;
+		if (replaceMap[token]) return false;
+		return this.sanitizeWord(token, token, rules) === token;
+	}
+	/**
+	* Pluralize or singularize a word based on the passed in count.
+	*/
+	pluralize(word, count, inclusive = false) {
+		const pluralized = count === 1 ? this.singular(word) : this.plural(word);
+		return (inclusive ? `${count} ` : "") + pluralized;
+	}
+	/**
+	* Pluralize a word.
+	*/
+	plural(singularWord) {
+		return this.replaceWord(singularWord, "SingularToPlural");
+	}
+	/**
+	* Check if a word is plural.
+	*/
+	isPlural(word) {
+		return this.checkWord(word, "Plurality");
+	}
+	/**
+	* Singularize a word.
+	*/
+	singular(pluralWord) {
+		return this.replaceWord(pluralWord, "PluralToSingular");
+	}
+	/**
+	* Check if a word is singular.
+	*/
+	isSingular(word) {
+		return this.checkWord(word, "Singularity");
+	}
+};
+//#endregion
 exports.Pluralize = Pluralize;

package/dist/string/pluralize/pluralize.d.ts

@@ -41,7 +41,7 @@ export declare class Pluralize {
      * @param  {Array}  args
      * @return {string}
      */
-    interpolate(str: string, args: string[]): string;
+    private interpolate;
     /**
      * Replace a word using a rule.
      */
@@ -50,10 +50,6 @@ export declare class Pluralize {
      * Sanitize a word by passing in the word and sanitization rules.
      */
     sanitizeWord(token: string, word: string, rules: Rule[]): string;
-    /**
-     * Replace a word with the updated word.
-     */
-    old_replaceWord(replaceMap: Record<string, string>, keepMap: Record<string, string>, rules: Rule[]): (word: string) => string;
     /**
      * Replace a word with the updated word.
      */
@@ -65,7 +61,7 @@ export declare class Pluralize {
     /**
      * Pluralize or singularize a word based on the passed in count.
      */
-    pluralize(word: string, count: number, inclusive: boolean): string;
+    pluralize(word: string, count: number, inclusive?: boolean): string;
     /**
      * Pluralize a word.
      */
@@ -73,7 +69,7 @@ export declare class Pluralize {
     /**
      * Check if a word is plural.
      */
-    isPlural(word: string): void;
+    isPlural(word: string): boolean;
     /**
      * Singularize a word.
      */
@@ -81,5 +77,5 @@ export declare class Pluralize {
     /**
      * Check if a word is singular.
      */
-    isSingular(word: string): void;
+    isSingular(word: string): boolean;
 }