typeshi 1.6.0 → 1.7.2

package/dist/utils/argumentValidation.d.ts

@@ -176,19 +176,4 @@ export declare function existingPathArgument(source: string, arg2: string | {
  * @returns **`bracketedString`** `string`
  */
 export declare const bracketed: (s: string) => string;
-declare const validate: {
-    stringArgument: typeof stringArgument;
-    multipleStringArguments: typeof multipleStringArguments;
-    numericStringArgument: typeof numericStringArgument;
-    booleanArgument: typeof booleanArgument;
-    numberArgument: typeof numberArgument;
-    arrayArgument: typeof arrayArgument;
-    enumArgument: typeof enumArgument;
-    objectArgument: typeof objectArgument;
-    functionArgument: typeof functionArgument;
-    existingPathArgument: typeof existingPathArgument;
-    existingDirectoryArgument: typeof existingDirectoryArgument;
-    existingFileArgument: typeof existingFileArgument;
-    multipleExistingFileArguments: typeof multipleExistingFileArguments;
-};
-export default validate;
+export {};

package/dist/utils/argumentValidation.js

@@ -813,19 +813,19 @@ function getSourceString(fileName, func, funcInfo, startLine, endLine) {
 // isEnumArgumentOptions,
 // isEnumObject,
 // isObjectArgumentOptions,
-const validate = {
-    stringArgument,
-    multipleStringArguments,
-    numericStringArgument,
-    booleanArgument,
-    numberArgument,
-    arrayArgument,
-    enumArgument,
-    objectArgument,
-    functionArgument,
-    existingPathArgument,
-    existingDirectoryArgument,
-    existingFileArgument,
-    multipleExistingFileArguments
-};
-exports.default = validate;
+// const validate = {
+//     stringArgument,
+//     multipleStringArguments,
+//     numericStringArgument,
+//     booleanArgument,
+//     numberArgument,
+//     arrayArgument,
+//     enumArgument,
+//     objectArgument,
+//     functionArgument,
+//     existingPathArgument,
+//     existingDirectoryArgument,
+//     existingFileArgument,
+//     multipleExistingFileArguments
+// }
+// export default validate;

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

@@ -95,25 +95,33 @@ export declare function getCurrentPacificTime(): string;
  */
 export declare function toPacificTime(initialDateString: string): string;
 export declare const Milliseconds: {
-    from: {
-        hours: (n: number) => number;
-        minutes: (n: number) => number;
-        seconds: (n: number) => number;
+    readonly from: {
+        readonly hours: (n: number) => number;
+        readonly minutes: (n: number) => number;
+        readonly seconds: (n: number) => number;
         /**
          * @param d `Date` object
          * @returns `number` milliseconds since epoch
          */
-        date: (d: Date) => number;
+        readonly date: (d: Date) => number;
+        readonly localeString: (s: string) => number | null;
     };
-    to: {
-        hours: (n: number) => number;
-        minutes: (n: number) => number;
-        seconds: (n: number) => number;
+    readonly to: {
+        readonly hours: (n: number) => number;
+        readonly minutes: (n: number) => number;
+        readonly seconds: (n: number) => number;
         /**
          * interprets `n` as milliseconds since epoch
          * @param n `number` milliseconds
          * @returns `Date` object
          */
-        date: (n: number) => Date;
+        readonly date: (n: number) => Date;
+        /**
+         * @param n `number` milliseconds since epoch
+         * @param locale `string` default = `'en-US'`
+         * @param timeZone `string` default = `'America/Los_Angeles'`
+         * @returns `string` locale date string
+         */
+        readonly localeString: (n: number, locale?: string, timeZone?: string) => string;
     };
 };

package/dist/utils/io/dateTime.js

@@ -217,6 +217,16 @@ exports.Milliseconds = {
          */
         date: (d) => {
             return d.getTime();
+        },
+        localeString: (s) => {
+            try {
+                const date = parseLocaleStringToDate(s);
+                return date.getTime();
+            }
+            catch (error) {
+                console.error(error);
+                return null;
+            }
         }
     },
     to: {
@@ -236,6 +246,16 @@ exports.Milliseconds = {
          */
         date: (n) => {
             return new Date(n);
+        },
+        /**
+         * @param n `number` milliseconds since epoch
+         * @param locale `string` default = `'en-US'`
+         * @param timeZone `string` default = `'America/Los_Angeles'`
+         * @returns `string` locale date string
+         */
+        localeString: (n, locale = exports.DEFAULT_LOCALE, timeZone = exports.DEFAULT_TIMEZONE) => {
+            const date = new Date(n);
+            return date.toLocaleString(locale, { timeZone });
         }
     },
 };

package/dist/utils/io/reading.js

@@ -70,13 +70,11 @@ const stream_1 = require("stream");
 const csv_parser_1 = __importDefault(require("csv-parser"));
 const xlsx_1 = __importDefault(require("xlsx"));
 const regex_1 = require("../regex");
-const misc_1 = require("../regex/misc");
 const config_1 = require("../../config");
 const types_1 = require("./types");
 const typeValidation_1 = require("../typeValidation");
 const validate = __importStar(require("../argumentValidation"));
 const logging_1 = require("./logging");
-const F = (0, misc_1.extractFileName)(__filename);
 /** for testing if `pathString (value)` points to an existing directory */
 function isDirectory(value) {
     return ((0, typeValidation_1.isNonEmptyString)(value)
@@ -119,7 +117,7 @@ exports.readJsonSync = readJsonFileAsObject;
  * - JSON data as an object
  */
 function readJsonFileAsObject(filePath) {
-    const source = (0, logging_1.getSourceString)(F, readJsonFileAsObject.name);
+    const source = (0, logging_1.getSourceString)(__filename, readJsonFileAsObject.name);
     try {
         filePath = coerceFileExtension(filePath, 'json');
         const data = fs_1.default.readFileSync(filePath, 'utf8');
@@ -140,7 +138,7 @@ function readJsonFileAsObject(filePath) {
  * @returns **`validatedFilePath`** `string`
  */
 function coerceFileExtension(filePath, expectedExtension) {
-    validate.multipleStringArguments(`reading.coerceFileExtension`, { filePath, expectedExtension });
+    validate.multipleStringArguments((0, logging_1.getSourceString)(__filename, coerceFileExtension.name), { filePath, expectedExtension });
     expectedExtension = expectedExtension.replace(/\./, '');
     if (filePath.endsWith(`.${expectedExtension}`)) {
         return filePath;
@@ -165,7 +163,7 @@ function coerceFileExtension(filePath, expectedExtension) {
  * @returns **`concatenatedRows`** `Promise<Record<string, any>[]>`
  */
 async function concatenateFiles(arg1, sheetName = 'Sheet1', requiredHeaders = [], strictRequirement = true, targetExtensions = ['.csv', '.tsv', '.xlsx']) {
-    const source = (0, logging_1.getSourceString)(F, concatenateFiles.name);
+    const source = (0, logging_1.getSourceString)(__filename, concatenateFiles.name);
     validate.stringArgument(source, { sheetName });
     validate.arrayArgument(source, { targetExtensions, isNonEmptyString: typeValidation_1.isNonEmptyString });
     let files;
@@ -433,7 +431,7 @@ async function getOneToOneDictionary(arg1, keyColumn, valueColumn, keyOptions, v
  * @returns **`values`** `Promise<Array<string>>` - sorted array of values (as strings) from the specified column.
  */
 async function getColumnValues(arg1, columnName, cleaner, allowDuplicates = false) {
-    const source = `[reading.getColumnValues()]`;
+    const source = (0, logging_1.getSourceString)(__filename, getColumnValues.name);
     validate.stringArgument(source, { columnName });
     validate.booleanArgument(source, { allowDuplicates });
     if (cleaner)
@@ -485,7 +483,7 @@ async function getIndexedColumnValues(arg1, columnName, cleaner) {
  * @returns **`rows`** `Promise<Record<string, any>[]>`
  */
 async function handleFileArgument(arg1, invocationSource, requiredHeaders = [], sheetName) {
-    const source = (0, logging_1.getSourceString)(F, handleFileArgument.name);
+    const source = (0, logging_1.getSourceString)(__filename, handleFileArgument.name);
     validate.stringArgument(source, { invocationSource });
     validate.arrayArgument(source, { requiredHeaders, isNonEmptyString: typeValidation_1.isNonEmptyString }, true);
     let rows = [];
@@ -532,7 +530,7 @@ async function handleFileArgument(arg1, invocationSource, requiredHeaders = [],
  * @returns **`targetFiles`** `string[]` array of full file paths
  */
 function getDirectoryFiles(dir, ...targetExtensions) {
-    const source = (0, logging_1.getSourceString)(F, getDirectoryFiles.name);
+    const source = (0, logging_1.getSourceString)(__filename, getDirectoryFiles.name);
     validate.existingPathArgument(source, { dir });
     validate.arrayArgument(source, { targetExtensions, isNonEmptyString: typeValidation_1.isNonEmptyString }, true);
     // ensure all target extensions start with period
@@ -557,7 +555,7 @@ function getDirectoryFiles(dir, ...targetExtensions) {
  * @returns **`dict`** `Promise<Record<string, string[]>>`
  */
 async function getOneToManyDictionary(dataSource, keyColumn, valueColumn, keyOptions, valueOptions, sheetName) {
-    const source = (0, logging_1.getSourceString)(F, getOneToManyDictionary.name);
+    const source = (0, logging_1.getSourceString)(__filename, getOneToManyDictionary.name);
     validate.multipleStringArguments(source, { keyColumn, valueColumn });
     if (keyOptions)
         validate.objectArgument(source, { keyOptions, isCleanStringOptions: regex_1.isCleanStringOptions });
@@ -1130,7 +1128,7 @@ async function extractTargetRows(
  * - `Record<string, any>[]` -> array of rows
  * */
 rowSource, targetColumn, targetValues, extractor, extractorArgs) {
-    const source = (0, logging_1.getSourceString)(F, extractTargetRows.name);
+    const source = (0, logging_1.getSourceString)(__filename, extractTargetRows.name);
     if (!(0, typeValidation_1.isNonEmptyString)(rowSource) && !(0, typeValidation_1.isNonEmptyArray)(rowSource)) {
         throw new Error([`${source} Invalid param 'rowSource'`,
             `Expected rowSource: string | Record<string, any>[]`,

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

@@ -29,7 +29,7 @@ export declare const writeJsonSync: typeof writeObjectToJsonSync;
  */
 export declare function indentedStringify(data: Record<string, any> | string, indent?: number, spaces?: number): string;
 /**
- * @returns **`timestamp`** `string` = `(${MM}-${DD})_(${HH}-${mm}.${ss}.${ms})`
+ * @returns **`timestamp`** `string` = `(${MM}-${DD})_(${HH}.${mm}.${ss}.${ms})`
  */
 export declare function getFileNameTimestamp(): string;
 /**

package/dist/utils/io/writing.js

@@ -135,7 +135,7 @@ function indentedStringify(data, indent = 0, spaces = 4) {
     return jsonString;
 }
 /**
- * @returns **`timestamp`** `string` = `(${MM}-${DD})_(${HH}-${mm}.${ss}.${ms})`
+ * @returns **`timestamp`** `string` = `(${MM}-${DD})_(${HH}.${mm}.${ss}.${ms})`
  */
 function getFileNameTimestamp() {
     const now = new Date();
@@ -145,7 +145,7 @@ function getFileNameTimestamp() {
     const mm = String(now.getMinutes()).padStart(2, '0');
     const ss = String(now.getSeconds()).padStart(2, '0');
     const ms = String(now.getMilliseconds()).padStart(3, '0');
-    return `(${MM}-${DD})_(${HH}-${mm}.${ss}.${ms})`;
+    return `(${MM}-${DD})_(${HH}.${mm}.${ss}.${ms})`;
 }
 /**
  * @param listData `Record<string, Array<string>>` map col names to col values

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "typeshi",
-    "version": "1.6.0",
+    "version": "1.7.2",
     "description": "TypeScript utility modules",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",