typeshi 2.0.2 → 2.1.0

package/dist/utils/io/types/Io.d.ts

@@ -1,7 +1,6 @@
 /**
  * @file src/utils/io/Io.ts
  */
-import { DEP_StringCaseOptions, StringPadOptions, DEP_StringStripOptions } from "../../regex/index";
 export type WriteJsonOptions = {
     data: Record<string, any> | string;
     filePath: string;
@@ -25,32 +24,10 @@ export type NodeLeaves = number[] | RowDictionary;
 export type RowDictionary = {
     [rowIndex: number]: Record<string, any>;
 };
-/**
- * @deprecated
- * @typedefn **`ParseOneToManyOptions`**
- * @property {StringStripOptions} keyStripOptions - options for stripping characters from the key
- * @property {StringStripOptions} valueStripOptions - options for stripping characters from the value
- * @property {StringCaseOptions} keyCaseOptions - options for changing the case of the key
- * @property {StringCaseOptions} valueCaseOptions - options for changing the case of the value
- * @property {StringPadOptions} keyPadOptions - options for padding values read from the `keyColumn`
- * @property {StringPadOptions} valuePadOptions - options for padding values read from the `valueColumn`
- *
- * - {@link DEP_StringStripOptions} = `{ char: string, escape?: boolean, stripLeftCondition?: (s: string, ...args: any[]) => boolean, leftArgs?: any[], stripRightCondition?: (s: string, ...args: any[]) => boolean, rightArgs?: any[] }`
- * - {@link DEP_StringCaseOptions}  = `{ toUpper: boolean, toLower: boolean, toTitle: boolean }`
- * - {@link StringPadOptions} = `{ padLength: number, padChar: string, padLeft: boolean, padRight: boolean }`
- */
-export type ParseOneToManyOptions = {
-    keyStripOptions?: DEP_StringStripOptions;
-    valueStripOptions?: DEP_StringStripOptions;
-    keyCaseOptions?: DEP_StringCaseOptions;
-    valueCaseOptions?: DEP_StringCaseOptions;
-    keyPadOptions?: StringPadOptions;
-    valuePadOptions?: StringPadOptions;
-};
 /**
  * common file extensions handled as input/output
  */
-export type FileExtension = '.csv' | '.tsv' | '.txt' | '.json' | '.xlsx' | '.xls' | '.xml' | '.yaml' | '.yml';
+export type FileExtension = '.csv' | '.tsv' | '.txt' | '.json' | '.xlsx' | '.xls' | '.xml' | '.yaml' | '.yml' | (string & {});
 /**
  * @interface **`DirectoryFileOptions`** `getDirectoryFiles(parentDir: string, options: DirectoryFileOptions)`
  */

package/dist/utils/io/types/Io.js

@@ -1,2 +1,5 @@
 "use strict";
+/**
+ * @file src/utils/io/Io.ts
+ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/io/writing.d.ts

@@ -13,7 +13,7 @@ import { WriteJsonOptions } from "./types";
  * @param options.enableOverwrite `boolean` - `optional`, default=`true` If `enableOverwrite` is `true`, the file will be overwritten. If `false`, the `data` will be appended to the file.
  * @returns {void}
  */
-export declare function writeObjectToJsonSync(options: WriteJsonOptions): void;
+export declare function writeJsonSync(options: WriteJsonOptions): void;
 /**
  * Output JSON data to a file with `fs.writeFileSync` or `fs.appendFileSync`.
  * @param data `Record<string, any> | string` - JSON data to write to file
@@ -23,16 +23,15 @@ export declare function writeObjectToJsonSync(options: WriteJsonOptions): void;
  * @param enableOverwrite `boolean` - `optional`, default=`true` If `enableOverwrite` is `true`, the file will be overwritten. If `false`, the `data` will be appended to the file.
  * @returns {void}
  */
-export declare function writeObjectToJsonSync(data: Record<string, any> | string, filePath: string, indent?: number, enableOverwrite?: boolean): void;
-export declare const writeJsonSync: typeof writeObjectToJsonSync;
-export declare const writeArraysToCsvSync: typeof writeListsToCsvSync;
+export declare function writeJsonSync(data: Record<string, any> | string, filePath: string, indent?: number, enableOverwrite?: boolean): void;
 /**
+ * `writeListsToCsvSync`
  * @param listData `Record<string, Array<string>>` map col names to col values
  * @param outputPath `string`
  * @param delimiter `string` - optional, default=`'\t'`
  * @param columnDelimiter `string` - optional, default=`''`
  */
-export declare function writeListsToCsvSync(listData: Record<string, Array<string>>, outputPath: string, delimiter?: string, columnDelimiter?: string): void;
+export declare function writeArraysToCsvSync(listData: Record<string, Array<string>>, outputPath: string, delimiter?: string, columnDelimiter?: string): void;
 /**
  * @param arr `T[]`
  * @param outputPath `string`

package/dist/utils/io/writing.js

@@ -33,9 +33,8 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeArraysToCsvSync = exports.writeJsonSync = void 0;
-exports.writeObjectToJsonSync = writeObjectToJsonSync;
-exports.writeListsToCsvSync = writeListsToCsvSync;
+exports.writeJsonSync = writeJsonSync;
+exports.writeArraysToCsvSync = writeArraysToCsvSync;
 exports.writeArrayToFileSync = writeArrayToFileSync;
 exports.writeRowsToCsvSync = writeRowsToCsvSync;
 exports.trimFileSync = trimFileSync;
@@ -54,10 +53,11 @@ const reading_1 = require("./reading");
 const types_1 = require("./types");
 const typeValidation_1 = require("../typeValidation");
 const logging_1 = require("./logging");
-function writeObjectToJsonSync(
+/** `writeObjectToJsonSync` */
+function writeJsonSync(
 /** {@link WriteJsonOptions} `| Record<string, any> | string`, */
 arg1, filePath, indent = 4, enableOverwrite = true) {
-    const source = (0, logging_1.getSourceString)(__filename, writeObjectToJsonSync.name);
+    const source = (0, logging_1.getSourceString)(__filename, writeJsonSync.name);
     if (!arg1) {
         setupLog_1.typeshiLogger.error(`${source} No data to write to JSON file'`);
         return;
@@ -106,22 +106,21 @@ arg1, filePath, indent = 4, enableOverwrite = true) {
         else {
             fs.appendFileSync(outputPath, jsonData, { flag: 'a' });
         }
-        // mlog.info(`[writing.writeObjectToJson()] file saved to '${outputPath}'`)
+        setupLog_1.typeshiHiddenLogger.info(`${source} file saved to '${outputPath}'`);
     }
     catch (error) {
         setupLog_1.typeshiLogger.error(`${source} Error writing to JSON file'`, error);
         throw error;
     }
 }
-exports.writeJsonSync = writeObjectToJsonSync;
-exports.writeArraysToCsvSync = writeListsToCsvSync;
 /**
+ * `writeListsToCsvSync`
  * @param listData `Record<string, Array<string>>` map col names to col values
  * @param outputPath `string`
  * @param delimiter `string` - optional, default=`'\t'`
  * @param columnDelimiter `string` - optional, default=`''`
  */
-function writeListsToCsvSync(listData, outputPath, delimiter = types_1.DelimiterCharacterEnum.TAB, columnDelimiter = '') {
+function writeArraysToCsvSync(listData, outputPath, delimiter = types_1.DelimiterCharacterEnum.TAB, columnDelimiter = '') {
     const listNames = Object.keys(listData);
     const listValues = Object.values(listData);
     const maxLength = Math.max(...listValues.map(list => list.length));
@@ -220,7 +219,7 @@ function trimFileSync(maxMB = 5, ...filePaths) {
         }
         catch (e) {
             setupLog_1.typeshiLogger.error('Error trimming file to last 10MB', e);
-            throw e;
+            // throw e;
         }
     }
 }
@@ -248,7 +247,7 @@ async function trimFile(maxMB = 5, ...filePaths) {
         }
         catch (e) {
             setupLog_1.typeshiLogger.error('Error trimming file to last 10MB', e);
-            throw e;
+            // throw e;
         }
     }
     await (0, env_1.DELAY)(1000, `[trimFile()] Releasing file handles...`);

package/dist/utils/regex/Str.d.ts

@@ -72,7 +72,8 @@ export declare class Str {
     static replace: typeof applyReplaceParams;
     /**
      * @param s `string`
-     * @param options {@link StringStripOptions} = `{ char?: string, left?: StringStripCondition, right?: StringStripCondition }`
+     * @param options {@link StringStripOptions}
+     * = `{ char?: string, left?: `{@link StringStripCondition}`, right?: StringStripCondition }`
      * @returns **`s`**
      */
     static strip: typeof applyStripOptions;

package/dist/utils/regex/Str.js

@@ -77,7 +77,8 @@ Str.pad = cleaning_1.applyPadOptions;
 Str.replace = cleaning_1.applyReplaceParams;
 /**
  * @param s `string`
- * @param options {@link StringStripOptions} = `{ char?: string, left?: StringStripCondition, right?: StringStripCondition }`
+ * @param options {@link StringStripOptions}
+ * = `{ char?: string, left?: `{@link StringStripCondition}`, right?: StringStripCondition }`
  * @returns **`s`**
  */
 Str.strip = cleaning_1.applyStripOptions;

package/dist/utils/regex/cleaning.d.ts

@@ -1,4 +1,4 @@
-import { DEP_CleanStringOptions, DEP_StringCaseOptions, DEP_StringPadOptions, StringCaseEnum, StringPadOptions, StringReplaceOptions, DEP_StringStripOptions, StringCleanOptions, StringReplaceParams, StringStripOptions } from "./types";
+import { StringCaseEnum, StringPadOptions, StringCleanOptions, StringReplaceParams, StringStripOptions } from "./types";
 /**
  * @param s `string`
  * @param options {@link StringCleanOptions} `(optional)`
@@ -36,63 +36,9 @@ export declare function applyPadOptions(s: string, options: StringPadOptions): s
  * @returns **`s`** `string` with case option applied
  */
 export declare function applyCaseOptions(s: string, caseOptions: StringCaseEnum): string;
-/**
- * @deprecated
- * @param s `string` - the string to handle padding options for
- * @param padOptions — {@link StringPadOptions} - `optional` padding options to apply to the string
- * = `{ padLength: number, padChar: string, padLeft: boolean, padRight: boolean }`
- * - applies the first padding option that is `true` and ignores the rest
- * @returns **`s`** - the string with padding options applied
- * @note `if` `s.length >= padLength`, no padding is applied
- */
-export declare function DEP_applyPadOptions(s: string, padOptions?: DEP_StringPadOptions): string;
-/**
- * @param s `string`
- * @param stripOptions — {@link DEP_StringStripOptions}
- * = `{ char: string, escape?: boolean, stripLeftCondition?: (s: string, ...args: any[]) => boolean, leftArgs?: any[], stripRightCondition?: (s: string, ...args: any[]) => boolean, rightArgs?: any[] }`
- * - if `stripLeftCondition(s, leftArgs)` is `true` or `stripLeftCondition` is `undefined` (i.e. no conditions need to be met to strip left):
- * - - then the left side of the `s` is stripped of `char`
- * - if `stripRightCondition(s, rightArgs)` is `true` or `stripRightCondition` is `undefined` (i.e. no conditions need to be met to strip right):
- * - - then the right side of the `s` is stripped of `char`
- * @param stripOptions.escape escape special regex characters in `char` with `char.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')`
- * @returns `string` - the string with leading and trailing characters removed
- */
-export declare function DEP_applyStripOptions(s: string, stripOptions: DEP_StringStripOptions): string;
 /**
  * @param s `string` - the string to convert to title case
  * @returns **`s`** `string` - the string in title case
  * (i.e. first letter of each word, determined by the `\b` boundary metacharacter, is capitalized)
  */
 export declare function toTitleCase(s: string): string;
-/**
- * @deprecated use {@link applyCaseOptions} with {@link StringCaseEnum} instead
- * @param s `string` - the string to handle case options for
- * @param caseOptions — {@link DEP_StringCaseOptions} - `optional` case options to apply to the string
- * = `{ toUpper: boolean, toLower: boolean, toTitle: boolean }`
- * - applies the first case option that is `true` and ignores the rest
- * @returns **`s`** - the string with case options applied
- */
-export declare function DEP_applyCaseOptions(s: string, caseOptions?: DEP_StringCaseOptions): string;
-export declare function DEP_clean(s: string, options?: DEP_CleanStringOptions): string;
-/**
- * @description
- * - converts to string and trims, then:
- * - applies options in this order: `StringReplaceOptions`, `StringStripOptions`, `StringCaseOptions`, `StringPadOptions`
- * - Removes leading+trailing spaces, extra spaces, commas, and dots from a string (e.g. `'..'` becomes `'.'`)
- * - optionally applies 4 option params with: {@link string.replace}, {@link DEP_applyStripOptions}, {@link DEP_applyCaseOptions}, and {@link DEP_applyPadOptions}.
- * @param s `string` to clean
- * @param stripOptions {@link DEP_StringStripOptions}
- * - `optional` strip options to apply to the string
- * - = `{ char: string, escape?: boolean, stripLeftCondition?: (s: string, ...args: any[]) => boolean, leftArgs?: any[], stripRightCondition?: (s: string, ...args: any[]) => boolean, rightArgs?: any[] }`
- * @param caseOptions {@link DEP_StringCaseOptions}
- * - `optional` case options to apply to the string
- * - = `{ toUpper: boolean, toLower: boolean, toTitle: boolean }`
- * @param padOptions {@link StringPadOptions}
- * - `optional` padding options to apply to the string
- * - = `{ padLength: number, padChar: string, padLeft: boolean, padRight: boolean }`
- * @param replaceOptions {@link StringReplaceOptions}
- * - `optional` replace options to apply to the string
- * - = `Array<`{@link StringReplaceParams}`>` = `{ searchValue: string | RegExp, replaceValue: string }[]`
- * @returns **`s`** `string`
- */
-export declare function DEP_clean(s: string, stripOptions?: DEP_StringStripOptions, caseOptions?: DEP_StringCaseOptions, padOptions?: DEP_StringPadOptions, replaceOptions?: StringReplaceOptions): string;

package/dist/utils/regex/cleaning.js

@@ -5,11 +5,7 @@ exports.applyStripOptions = applyStripOptions;
 exports.applyReplaceParams = applyReplaceParams;
 exports.applyPadOptions = applyPadOptions;
 exports.applyCaseOptions = applyCaseOptions;
-exports.DEP_applyPadOptions = DEP_applyPadOptions;
-exports.DEP_applyStripOptions = DEP_applyStripOptions;
 exports.toTitleCase = toTitleCase;
-exports.DEP_applyCaseOptions = DEP_applyCaseOptions;
-exports.DEP_clean = DEP_clean;
 /**
  * @file src/utils/regex/cleaning.ts
  */
@@ -154,7 +150,7 @@ function applyPadOptions(s, options) {
             s = s.padEnd(maxLength, char);
             return s;
         default:
-            config_1.typeshiLogger.error([`[Str.applyPadOptions()] Invalid argument 'options.side'`,
+            config_1.typeshiLogger.error([`[applyPadOptions()] Invalid argument 'options.side'`,
                 `Expected: 'left' | 'right' | 'both'`,
                 `Received: '${side}'`,
                 `Returing unaltered string...`
@@ -179,77 +175,13 @@ function applyCaseOptions(s, caseOptions) {
             return toTitleCase(s);
         default:
             config_1.typeshiLogger.warn([
-                '[applyCase()] Invalid case option. Returning original string.',
-                `Expected one of: ${Object.values(types_1.StringCaseEnum).join(', ')}`,
-                `Received: ${caseOptions}`
+                '[applyCaseOptions()] Unsupported case option. Returning original string.',
+                `Expected: 'upper' | 'lower' | 'title'`,
+                `Received: '${caseOptions}'`
             ].join(config_1.INDENT_LOG_LINE));
             return s;
     }
 }
-/**
- * @deprecated
- * @param s `string` - the string to handle padding options for
- * @param padOptions — {@link StringPadOptions} - `optional` padding options to apply to the string
- * = `{ padLength: number, padChar: string, padLeft: boolean, padRight: boolean }`
- * - applies the first padding option that is `true` and ignores the rest
- * @returns **`s`** - the string with padding options applied
- * @note `if` `s.length >= padLength`, no padding is applied
- */
-function DEP_applyPadOptions(s, padOptions = { padLength: 24, padChar: ' ', padLeft: false, padRight: false }) {
-    if (!s)
-        return '';
-    const { padLength, padChar, padLeft, padRight } = padOptions;
-    if (typeof padLength !== 'number' || padLength < 0) {
-        config_1.typeshiLogger.warn('handlePadOptions() Invalid padLength. Expected a positive integer, but received:', padLength);
-        return s;
-    }
-    if (s.length >= padLength) {
-        return s; // No padding needed
-    }
-    if (padLeft) {
-        s = s.padStart(padLength, padChar);
-    }
-    else if (padRight) {
-        s = s.padEnd(padLength, padChar);
-    }
-    return s;
-}
-/**
- * @param s `string`
- * @param stripOptions — {@link DEP_StringStripOptions}
- * = `{ char: string, escape?: boolean, stripLeftCondition?: (s: string, ...args: any[]) => boolean, leftArgs?: any[], stripRightCondition?: (s: string, ...args: any[]) => boolean, rightArgs?: any[] }`
- * - if `stripLeftCondition(s, leftArgs)` is `true` or `stripLeftCondition` is `undefined` (i.e. no conditions need to be met to strip left):
- * - - then the left side of the `s` is stripped of `char`
- * - if `stripRightCondition(s, rightArgs)` is `true` or `stripRightCondition` is `undefined` (i.e. no conditions need to be met to strip right):
- * - - then the right side of the `s` is stripped of `char`
- * @param stripOptions.escape escape special regex characters in `char` with `char.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')`
- * @returns `string` - the string with leading and trailing characters removed
- */
-function DEP_applyStripOptions(s, stripOptions) {
-    if (!s)
-        return '';
-    let { char, escape = false, stripLeftCondition = false, leftArgs, stripRightCondition = false, rightArgs } = stripOptions;
-    if (escape) {
-        char = char.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-    }
-    let regexSource = '';
-    const leftSideUnconditionalOrMeetsCondition = !stripLeftCondition || (stripLeftCondition && stripLeftCondition(s, leftArgs));
-    const rightSideUnconditionalOrMeetsCondition = !stripRightCondition || (stripRightCondition && stripRightCondition(s, rightArgs));
-    if (leftSideUnconditionalOrMeetsCondition) {
-        regexSource = regexSource + `^${char}+`;
-    }
-    if (regexSource.length > 0) {
-        regexSource = regexSource + '|';
-    }
-    if (rightSideUnconditionalOrMeetsCondition) {
-        regexSource = regexSource + `${char}+$`;
-    }
-    if (!stripLeftCondition && !stripRightCondition) { // assume strip both sides
-        regexSource = `^${char}+|${char}+$`;
-    }
-    const regex = new RegExp(regexSource, 'g');
-    return s.replace(regex, '');
-}
 /**
  * @param s `string` - the string to convert to title case
  * @returns **`s`** `string` - the string in title case
@@ -262,61 +194,3 @@ function toTitleCase(s) {
         .replace(/\b\w/g, char => char.toUpperCase())
         .replace(/(?<=\b[A-Z]{1})\w*\b/g, char => char.toLowerCase());
 }
-/**
- * @deprecated use {@link applyCaseOptions} with {@link StringCaseEnum} instead
- * @param s `string` - the string to handle case options for
- * @param caseOptions — {@link DEP_StringCaseOptions} - `optional` case options to apply to the string
- * = `{ toUpper: boolean, toLower: boolean, toTitle: boolean }`
- * - applies the first case option that is `true` and ignores the rest
- * @returns **`s`** - the string with case options applied
- */
-function DEP_applyCaseOptions(s, caseOptions = { toUpper: false, toLower: false, toTitle: false }) {
-    if (!s)
-        return '';
-    const { toUpper, toLower, toTitle } = caseOptions;
-    if (toUpper) {
-        s = s.toUpperCase();
-    }
-    else if (toLower) {
-        s = s.toLowerCase();
-    }
-    else if (toTitle) {
-        s = toTitleCase(s);
-    }
-    return s;
-}
-function DEP_clean(s, arg2, arg3, arg4, arg5) {
-    if (!s)
-        return '';
-    const { strip: stripOptions, case: caseOptions, pad: padOptions, replace: replaceOptions } = ((0, types_1.DEP_isCleanStringOptions)(arg2)
-        ? arg2
-        : {
-            strip: arg2,
-            case: arg3,
-            pad: arg4,
-            replace: arg5
-        });
-    s = String(s).trim() || '';
-    s = s.replace(/\s+/g, ' ')
-        .replace(/\.{2,}/g, '.')
-        .replace(/,{2,}/g, ',');
-    if ((0, typeValidation_1.isNonEmptyArray)(replaceOptions)) {
-        s = applyReplaceParams(s, replaceOptions);
-    }
-    if (stripOptions) {
-        s = DEP_applyStripOptions(s, stripOptions);
-    }
-    if (caseOptions) {
-        s = DEP_applyCaseOptions(s, caseOptions);
-    }
-    if (padOptions && padOptions.padLength) {
-        s = DEP_applyPadOptions(s, padOptions);
-    }
-    return s.trim().replace(/,$/g, '');
-}
-/**
- * @TODO convert
- * `s = s.replace(/\s+/g, ' ').replace(/\.{2,}/g, '.').replace(/,{2,}/g, ',');`
- * to StringReplaceOptions and test to ensure consistent output
- * */
-const CLEAN_BASIC_REPLACE_OPTIONS = [];

package/dist/utils/regex/configureParameters.d.ts

@@ -1,15 +1,14 @@
 /**
  * @file src/utils/regex/configureParameters.ts
  */
-import { DEP_StringStripOptions, StringReplaceParams } from ".";
+import { StringReplaceParams, StringStripOptions } from ".";
 /**
  * @param {string} s - `string` - the string to check
  * @returns `!s.endsWith('Ph.D.') && !`{@link stringEndsWithAnyOf}`(s`, {@link COMPANY_ABBREVIATION_PATTERN} as RegExp, `[`{@link RegExpFlagsEnum.IGNORE_CASE}`]) && !stringEndsWithAnyOf(s, /\b[A-Z]\.?\b/, [RegExpFlagsEnum.IGNORE_CASE]);` */
 export declare function doesNotEndWithKnownAbbreviation(s: string): boolean;
-/** strip leading `.` and (trailing `.` if satisfy stripRightCondition: {@link doesNotEndWithKnownAbbreviation}) */
-export declare const STRIP_DOT_IF_NOT_END_WITH_ABBREVIATION: DEP_StringStripOptions;
-/** always strip leading and trailing `.` from a `string` */
-export declare const UNCONDITIONAL_STRIP_DOT_OPTIONS: DEP_StringStripOptions;
+/** strip leading `.` and (trailing `.` if satisfy right.condition: {@link doesNotEndWithKnownAbbreviation}) */
+export declare const STRIP_DOT_IF_NOT_ABBREVIATION: StringStripOptions;
+export declare const STRIP_DOT_UNCONDITIONAL: StringStripOptions;
 /**
  * add space around hyphen if it already has one on a single side,
  */

package/dist/utils/regex/configureParameters.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REPLACE_EM_HYPHEN = exports.ENSURE_SPACE_AROUND_HYPHEN = exports.UNCONDITIONAL_STRIP_DOT_OPTIONS = exports.STRIP_DOT_IF_NOT_END_WITH_ABBREVIATION = void 0;
+exports.REPLACE_EM_HYPHEN = exports.ENSURE_SPACE_AROUND_HYPHEN = exports.STRIP_DOT_UNCONDITIONAL = exports.STRIP_DOT_IF_NOT_ABBREVIATION = void 0;
 exports.doesNotEndWithKnownAbbreviation = doesNotEndWithKnownAbbreviation;
 /**
  * @file src/utils/regex/configureParameters.ts
@@ -21,22 +21,16 @@ function doesNotEndWithKnownAbbreviation(s) {
         && !(0, _1.stringEndsWithAnyOf)(s, _1.COMPANY_ABBREVIATION_PATTERN, _1.RegExpFlagsEnum.IGNORE_CASE)
         && !(0, _1.stringEndsWithAnyOf)(s, initialsPattern, _1.RegExpFlagsEnum.IGNORE_CASE));
 }
-/** strip leading `.` and (trailing `.` if satisfy stripRightCondition: {@link doesNotEndWithKnownAbbreviation}) */
-exports.STRIP_DOT_IF_NOT_END_WITH_ABBREVIATION = {
+/** strip leading `.` and (trailing `.` if satisfy right.condition: {@link doesNotEndWithKnownAbbreviation}) */
+exports.STRIP_DOT_IF_NOT_ABBREVIATION = {
     char: '.',
-    escape: true,
-    stripLeftCondition: undefined,
-    leftArgs: undefined,
-    stripRightCondition: doesNotEndWithKnownAbbreviation,
+    left: undefined,
+    right: {
+        condition: doesNotEndWithKnownAbbreviation
+    }
 };
-/** always strip leading and trailing `.` from a `string` */
-exports.UNCONDITIONAL_STRIP_DOT_OPTIONS = {
-    char: '.',
-    escape: true,
-    stripLeftCondition: undefined,
-    leftArgs: undefined,
-    stripRightCondition: undefined,
-    rightArgs: undefined
+exports.STRIP_DOT_UNCONDITIONAL = {
+    char: '.'
 };
 /**
  * add space around hyphen if it already has one on a single side,

package/dist/utils/regex/email.js

@@ -22,10 +22,5 @@ function isValidEmail(email, excludeSubstrings) {
 function extractEmail(email) {
     if (!email)
         return null;
-    email = email.trim();
-    const match = email.match(exports.EMAIL_REGEX);
-    if (match) {
-        return match;
-    }
-    return null;
+    return email.trim().match(exports.EMAIL_REGEX);
 }

package/dist/utils/regex/entity.js

@@ -60,7 +60,7 @@ function extractName(name, includeJobTitleSuffix = true) {
         return { first: '', middle: '', last: '' };
     const originalName = name;
     const jobTitleSuffix = extractJobTitleSuffix(name);
-    name = (0, cleaning_1.DEP_clean)(name, { replace: exports.CLEAN_NAME_REPLACE_OPTIONS })
+    name = (0, cleaning_1.clean)(name, { replace: exports.CLEAN_NAME_REPLACE_OPTIONS })
         .replace(exports.JOB_TITLE_SUFFIX_PATTERN, ''); // redundant
     const containsInvalidCharsOrCompanyKeywords = ((0, stringOperations_1.stringContainsAnyOf)(name, /[0-9!#&@]/)
         || (0, stringOperations_1.stringContainsAnyOf)(name, exports.COMPANY_KEYWORDS_PATTERN, StringOptions_1.RegExpFlagsEnum.IGNORE_CASE));
@@ -81,8 +81,8 @@ function extractName(name, includeJobTitleSuffix = true) {
         // move last name to the end
         nameSplit.push(nameSplit.shift() || '');
     }
-    nameSplit.map((namePart) => (0, cleaning_1.DEP_clean)(namePart, {
-        strip: _1.STRIP_DOT_IF_NOT_END_WITH_ABBREVIATION,
+    nameSplit.map((namePart) => (0, cleaning_1.clean)(namePart, {
+        strip: _1.STRIP_DOT_IF_NOT_ABBREVIATION,
         replace: [{ searchValue: /(^[-+])*/g, replaceValue: '' }]
     }));
     config_1.typeshiHiddenLogger.debug([`nameSplit.length === ${nameSplit.length},`,
@@ -149,7 +149,7 @@ function extractName(name, includeJobTitleSuffix = true) {
 function extractJobTitleSuffix(s) {
     if (!s || typeof s !== 'string')
         return '';
-    s = (0, cleaning_1.DEP_clean)(s, { replace: [
+    s = (0, cleaning_1.clean)(s, { replace: [
             exports.REMOVE_ATTN_SALUTATION_PREFIX,
             { searchValue: /,$/g, replaceValue: '' }
         ] });

package/dist/utils/regex/misc.d.ts

@@ -20,7 +20,10 @@ export declare const FILE_NAME_WITH_EXTENSION_PATTERN: RegExp;
  * 2. matches `MM/DD/YYYY` format. assumes `MM/DD/YYYY` format if the first part is less than or equal to 12 I think.
  */
 export declare const DATE_STRING_PATTERN: RegExp;
-/** e.g. `"Pangyo-ro, Bundag-Gu, Seongnam-si"` */
+/**
+ * - e.g. `"Pangyo-ro, Bundag-Gu, Seongnam-si"`
+ * `re` = `/^\s*([a-zA-Z]{2,}-[a-zA-Z]{2,},\s*){1,}[a-zA-Z]{2,}-[a-zA-Z]{2,}\s*$/`
+ * */
 export declare const KOREA_ADDRESS_LATIN_TEXT_PATTERN: RegExp;
 /**
  * @param value `string` - the string value from which to extract `leaf`

package/dist/utils/regex/misc.js

@@ -39,7 +39,10 @@ exports.FILE_NAME_WITH_EXTENSION_PATTERN = /^[^/\\:*?"<>|]+(\.[^/\\:*?"<>|]+)$/;
  * 2. matches `MM/DD/YYYY` format. assumes `MM/DD/YYYY` format if the first part is less than or equal to 12 I think.
  */
 exports.DATE_STRING_PATTERN = new RegExp(/^\s*(\d{4}-\d{2}-\d{2}|\d{1,2}[\/-]\d{1,2}[\/-]\d{4})\s*$/);
-/** e.g. `"Pangyo-ro, Bundag-Gu, Seongnam-si"` */
+/**
+ * - e.g. `"Pangyo-ro, Bundag-Gu, Seongnam-si"`
+ * `re` = `/^\s*([a-zA-Z]{2,}-[a-zA-Z]{2,},\s*){1,}[a-zA-Z]{2,}-[a-zA-Z]{2,}\s*$/`
+ * */
 exports.KOREA_ADDRESS_LATIN_TEXT_PATTERN = new RegExp(/^\s*([a-zA-Z]{2,}-[a-zA-Z]{2,},\s*){1,}[a-zA-Z]{2,}-[a-zA-Z]{2,}\s*$/);
 /**
  * @param value `string` - the string value from which to extract `leaf`

package/dist/utils/regex/phone.js

@@ -3,7 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PHONE_REGEX_LIST = exports.KOREA_PHONE_REGEX = exports.JAPAN_PHONE_REGEX = exports.CHINA_PHONE_REGEX = exports.HONG_KONG_PHONE_REGEX = exports.PHONE_REGEX = void 0;
 exports.extractPhone = extractPhone;
 exports.formatPhone = formatPhone;
-const cleaning_1 = require("./cleaning");
+/**
+ * @file src/utils/regex/phone.ts
+ */
+const _1 = require(".");
 const StringOptions_1 = require("./types/StringOptions");
 /**
  * @param phone - `string` - phone number to test
@@ -68,8 +71,9 @@ function formatPhone(phone, re, groupFormat) {
     if (groupFormat) {
         result = result.replace(re, groupFormat);
     }
-    return (0, cleaning_1.DEP_clean)(result, { char: '-', escape: false })
-        .replace(/([a-zA-Z]+\s*$)/, '').trim();
+    return (0, _1.clean)(result, { strip: { char: '-' } })
+        .replace(/([a-zA-Z]+\s*$)/, '')
+        .trim();
 }
 // https://en.wikipedia.org/wiki/List_of_telephone_country_codes
 /**

package/dist/utils/regex/stringOperations.js

@@ -9,7 +9,7 @@ exports.extractSource = extractSource;
  * @file src/utils/regex/stringOperations.ts
  */
 const config_1 = require("../../config");
-const cleaning_1 = require("./cleaning");
+const _1 = require(".");
 const fastest_levenshtein_1 = require("fastest-levenshtein");
 const typeValidation_1 = require("../typeValidation");
 /**
@@ -30,9 +30,8 @@ function stringEndsWithAnyOf(s, suffixes, ...flags) {
         return false;
     }
     let regex = undefined;
-    if (typeof suffixes === 'string') {
+    if (typeof suffixes === 'string')
         suffixes = [suffixes];
-    }
     let flagString = ((0, typeValidation_1.isNonEmptyArray)(flags)
         ? flags.join('')
         : suffixes instanceof RegExp && (0, typeValidation_1.isNonEmptyString)(suffixes.flags)
@@ -150,13 +149,11 @@ function equivalentAlphanumericStrings(s1, s2, tolerance = 0.90) {
     if (!s1 || !s2)
         return false;
     const cleanOptions = {
-        case: { toLower: true },
-        replace: [
-            { searchValue: /[^A-Za-z0-9]/g, replaceValue: '' }
-        ]
+        case: 'lower',
+        replace: [{ searchValue: /[^A-Za-z0-9]/g, replaceValue: '' }]
     };
-    let s1Alphabetical = (0, cleaning_1.DEP_clean)(s1, cleanOptions).split('').sort().join('');
-    let s2Alphabetical = (0, cleaning_1.DEP_clean)(s2, cleanOptions).split('').sort().join('');
+    let s1Alphabetical = (0, _1.clean)(s1, cleanOptions).split('').sort().join('');
+    let s2Alphabetical = (0, _1.clean)(s2, cleanOptions).split('').sort().join('');
     if (s1Alphabetical.length === 0 || s2Alphabetical.length === 0) {
         return false;
     }
@@ -198,7 +195,7 @@ function extractSource(regex) {
     const REMOVE_UNESCAPED_QUESTION_MARK = {
         searchValue: /(?<!\\)\?/g, replaceValue: ''
     };
-    let source = (0, cleaning_1.DEP_clean)(regex.source, {
+    let source = (0, _1.clean)(regex.source, {
         replace: [
             REMOVE_ENDPOINT_CHARS,
             REPLACE_ESCAPED_DOT,

package/dist/utils/regex/types/StringOptions.TypeGuards.d.ts

@@ -1,7 +1,7 @@
 /**
  * @file src/utils/regex/types/StringOptions.TypeGuards.ts
  */
-import { DEP_CleanStringOptions, StringCaseEnum, StringCleanOptions, StringPadEnum, StringPadOptions, StringReplaceParams, StringStripOptions, StringCondition, StringStripCondition } from "./StringOptions";
+import { StringCaseEnum, StringCleanOptions, StringPadEnum, StringPadOptions, StringReplaceParams, StringStripOptions, StringCondition, StringStripCondition } from "./StringOptions";
 export declare function isStringCleanOptions(value: unknown): value is StringCleanOptions;
 export declare function isStringStripOptions(value: unknown): value is StringStripOptions;
 export declare function isStringPadOptions(value: unknown): value is StringPadOptions;
@@ -10,11 +10,3 @@ export declare function isStringPadEnum(value: unknown): value is StringPadEnum;
 export declare function isStringReplaceParams(value: unknown): value is StringReplaceParams;
 export declare function isStringCondition(value: unknown): value is StringCondition;
 export declare function isStringStripCondition(value: unknown): value is StringStripCondition;
-/**
- * - {@link DEP_CleanStringOptions}
- * @param value `any`
- * @returns **`isCleanStringOptions`** `boolean`
- * - **`true`** if the `value` is an object with at least one key in `['strip', 'case', 'pad', 'replace']` and no other keys,
- * - **`false`** `otherwise`.
- */
-export declare function DEP_isCleanStringOptions(value: any): value is DEP_CleanStringOptions;