typeshi 1.7.17 → 1.7.19

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

@@ -1,5 +1,5 @@
 import { StringCaseOptions, StringPadOptions, StringStripOptions, CleanStringOptions } from "../regex";
-import { FileData, FileExtension } from "./types/Io";
+import { DirectoryFileOptions, FileData, FileExtension } from "./types/Io";
 import { DelimiterCharacterEnum } from "./types";
 /** checks if `pathString (value)` points to an existing directory */
 export declare function isDirectory(value: any): value is string;
@@ -124,8 +124,8 @@ export declare function handleFileArgument(arg1: string | FileData | Record<stri
  * - `if true`,  returned array elements are of form: `path.basename(file)`
  * - `if false`, returned array elements are of form: `path.join(dir, file)`
  * @param targetExtensions `string[] (optional)` - array of file extensions to filter files by.
- * - `If` not provided, all files in the directory will be returned.
- * - `If` provided, only files with extensions matching the array will be returned.
+ * - `if undefined`, all files in the directory will be returned.
+ * - `if defined`, only files with extensions matching the array will be returned.
  * @returns **`targetFiles`** `string[]` array of file paths
  */
 export declare function getDirectoryFiles(dir: string, basenameOnly: boolean, ...targetExtensions: string[]): string[];
@@ -133,11 +133,28 @@ export declare function getDirectoryFiles(dir: string, basenameOnly: boolean, ..
  * `sync`
  * @param dir `string` path to target directory
  * @param targetExtensions `string[] (optional)` - array of file extensions to filter files by.
- * - `If` not provided, all files in the directory will be returned.
- * - `If` provided, only files with extensions matching the array will be returned.
+ * - `if undefined`, all files in the directory will be returned.
+ * - `if defined`, only files with extensions matching the array will be returned.
  * @returns **`targetFiles`** `string[]` array of `full` file paths
  */
 export declare function getDirectoryFiles(dir: string, ...targetExtensions: string[]): string[];
+/**
+ * `sync`
+ * @param dir `string` path to target directory
+ * @param options {@link DirectoryFileOptions}
+ * = `{ basenameOnly?: boolean, recursive?: boolean, targetExtensions?: string[] }`
+ * @param options.basenameOnly `boolean (optional)` `default` = `false`
+ * - `if true`,  returned array elements are of form: `path.basename(file)`
+ * - `if false`, returned array elements are of form: `path.join(dir, file)`
+ * @param options.recursive `boolean (optional)` `default` = `false`
+ * - `true` - get files from `dir` and all of its subdirectories
+ * - `false` - only get files from `dir` (i.e. direct descendants of `dir`)
+ * @param options.targetExtensions `string[] (optional)` - array of file extensions to filter files by.
+ * - `if undefined`, all files in the directory will be returned.
+ * - `if defined`, only files with extensions matching the array will be returned.
+ * @returns **`targetFiles`** `string[]` array of file paths
+ */
+export declare function getDirectoryFiles(dir: string, options: DirectoryFileOptions): string[];
 /**
  * @param dataSource `string | FileData | Record<string, any>[]`
  * @param keyColumn `string`

package/dist/utils/io/reading.js

@@ -573,23 +573,29 @@ async function handleFileArgument(arg1, invocationSource, requiredHeaders = [],
 /**
  * `sync`
  * @param dir `string` path to target directory
- * @param arg2 `boolean (optional)` `default` = `false`
+ * @param arg2 `boolean (optional)` (`basenameOnly`) `default` = `false`
  * - `if true`,  returned array elements are of form: `path.basename(file)`
  * - `if false`, returned array elements are of form: `path.join(dir, file)`
  * @param targetExtensions `string[] (optional)` - array of file extensions to filter files by.
- * - `If` not provided, all files in the directory will be returned.
- * - `If` provided, only files with extensions matching the array will be returned.
+ * - `if undefined`, all files in the directory will be returned.
+ * - `if defined` provided, only files with extensions matching the array will be returned.
  * @returns **`targetFiles`** `string[]` array of file paths
  */
 function getDirectoryFiles(dir, arg2, ...targetExtensions) {
     const source = (0, logging_1.getSourceString)(__filename, getDirectoryFiles.name);
     let basenameOnly = false;
+    let recursive = false;
     if ((0, typeValidation_1.isBoolean)(arg2)) {
         basenameOnly = arg2;
     }
     else if ((0, typeValidation_1.isNonEmptyString)(arg2)) {
         targetExtensions = [arg2, ...targetExtensions];
     }
+    else if ((0, types_1.isDirectoryFileOptions)(arg2)) {
+        basenameOnly = arg2.basenameOnly ?? basenameOnly;
+        targetExtensions = arg2.targetExtensions ?? [];
+        recursive = arg2.recursive ?? false;
+    }
     const targetFiles = [];
     try {
         validate.existingDirectoryArgument(source, { dir });
@@ -601,11 +607,23 @@ function getDirectoryFiles(dir, arg2, ...targetExtensions) {
                 targetExtensions[i] = `.${ext}`;
             }
         }
-        targetFiles.push(...fs_1.default.readdirSync(dir)
+        const dirContent = fs_1.default.readdirSync(dir);
+        targetFiles.push(...dirContent
             .filter(f => (0, typeValidation_1.isNonEmptyArray)(targetExtensions)
             ? (0, regex_1.stringEndsWithAnyOf)(f, targetExtensions, regex_1.RegExpFlagsEnum.IGNORE_CASE)
-            : true // get all files in dir, regardless of extension
+            : fs_1.default.statSync(node_path_1.default.join(dir, f)).isFile() // get all files in dir, regardless of extension
         ).map(f => basenameOnly ? f : node_path_1.default.join(dir, f)));
+        if (recursive) {
+            const childDirs = dirContent
+                .filter(c => isDirectory(node_path_1.default.join(dir, c)))
+                .map(c => node_path_1.default.join(dir, c));
+            for (let childDir of childDirs) {
+                targetFiles.push(...getDirectoryFiles(childDir, {
+                    basenameOnly, recursive, targetExtensions
+                }));
+            }
+        }
+        return targetFiles;
     }
     catch (error) {
         config_1.typeshiLogger.error([`${source} Error retrieving directory files, returning empty array`,
@@ -616,7 +634,6 @@ function getDirectoryFiles(dir, arg2, ...targetExtensions) {
         ].join(config_1.INDENT_LOG_LINE));
         return [];
     }
-    return targetFiles;
 }
 /**
  * @param dataSource `string | FileData | Record<string, any>[]`

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

@@ -1,7 +1,7 @@
 /**
  * @file src/utils/io/types/typeGuards.ts
  */
-import { FileData, NodeLeaves, NodeStructure, RowDictionary, RowSourceMetaData, WriteJsonOptions } from "..";
+import { FileData, NodeLeaves, NodeStructure, DirectoryFileOptions, RowDictionary, RowSourceMetaData, WriteJsonOptions } from ".";
 /**
  * @param value `any`
  * @returns **`isRowSourceMetaData`** `boolean`
@@ -29,3 +29,4 @@ export declare function isWriteJsonOptions(value: any): value is WriteJsonOption
  * - **`false`** `otherwise`.
  */
 export declare function isFileData(value: any): value is FileData;
+export declare function isDirectoryFileOptions(value: unknown): value is DirectoryFileOptions;

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

@@ -9,6 +9,7 @@ exports.isNodeStructure = isNodeStructure;
 exports.isNodeLeaves = isNodeLeaves;
 exports.isWriteJsonOptions = isWriteJsonOptions;
 exports.isFileData = isFileData;
+exports.isDirectoryFileOptions = isDirectoryFileOptions;
 const typeValidation_1 = require("../../typeValidation");
 /**
  * @param value `any`
@@ -36,26 +37,21 @@ function isRowDictionary(value) {
             && typeof value[key] === 'object' && !Array.isArray(value[key])));
 }
 function isNodeStructure(value) {
-    return (value && typeof value === 'object'
-        && !Array.isArray(value)
-        && Object.keys(value).length > 0
-        && Object.entries(value).every(([key, value]) => typeof key === 'string'
-            && (isNodeStructure(value) || isNodeLeaves(value))));
+    const candidate = value;
+    return ((0, typeValidation_1.isObject)(candidate)
+        && Object.entries(candidate).every(([k, v]) => (0, typeValidation_1.isNonEmptyString)(k) && (isNodeLeaves(v) || isNodeStructure(v))));
 }
 function isNodeLeaves(value) {
     return ((Array.isArray(value) && value.every(v => typeof v === 'number'))
         || isRowDictionary(value));
 }
 function isWriteJsonOptions(value) {
-    return (value && typeof value === 'object'
-        && !Array.isArray(value)
-        && value.data !== undefined
-        && (typeof value.data === 'object' || typeof value.data === 'string')
-        && (0, typeValidation_1.isNonEmptyString)(value.filePath)
-        && (value.indent === undefined
-            || (typeof value.indent === 'number' && value.indent >= 0))
-        && (value.enableOverwrite === undefined
-            || typeof value.enableOverwrite === 'boolean'));
+    const candidate = value;
+    return ((0, typeValidation_1.isObject)(candidate)
+        && (typeof candidate.data === 'string' || (0, typeValidation_1.isObject)(candidate.data))
+        && (0, typeValidation_1.isNonEmptyString)(candidate.filePath)
+        && typeValidation_1.isUndefinedOr.positiveInteger(candidate.indent)
+        && typeValidation_1.isUndefinedOr.boolean(candidate.enableOverwrite));
 }
 /**
  * @consideration `FILE_NAME_WITH_EXTENSION_PATTERN = /^[^/\\:*?"<>|]+(\.[^/\\:*?"<>|]+)$/`
@@ -67,9 +63,15 @@ function isWriteJsonOptions(value) {
  * - **`false`** `otherwise`.
  */
 function isFileData(value) {
-    return (value && typeof value === 'object'
-        && (0, typeValidation_1.hasKeys)(value, ['fileName', 'fileContent'])
-        && (0, typeValidation_1.isNonEmptyString)(value.fileName)
-        // && fileNamePattern.test(value.fileName)
-        && (0, typeValidation_1.isNonEmptyString)(value.fileContent));
+    const candidate = value;
+    return ((0, typeValidation_1.isObject)(candidate)
+        && (0, typeValidation_1.isNonEmptyString)(candidate.fileName)
+        && (0, typeValidation_1.isNonEmptyString)(candidate.fileContent));
+}
+function isDirectoryFileOptions(value) {
+    const candidate = value;
+    return ((0, typeValidation_1.isObject)(candidate, false)
+        && typeValidation_1.isOptional.stringArray(candidate.targetExtensions)
+        && typeValidation_1.isOptional.boolean(candidate.basenameOnly)
+        && typeValidation_1.isOptional.boolean(candidate.recursive));
 }

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

@@ -51,3 +51,25 @@ export type ParseOneToManyOptions = {
  * common file extensions handled as input/output
  */
 export type FileExtension = '.csv' | '.tsv' | '.txt' | '.json' | '.xlsx' | '.xls' | '.xml' | '.yaml' | '.yml';
+/**
+ * @interface **`DirectoryFileOptions`** `getDirectoryFiles(parentDir: string, options: DirectoryFileOptions)`
+ */
+export interface DirectoryFileOptions {
+    /**
+     * - `true` - returned array elements are of form: `path.basename(file)`
+     * - `false` - returned array elements are of form: `path.join(dir, file)` (i.e. complete file paths)
+     * */
+    basenameOnly?: boolean;
+    /**
+     * `default` = `false`
+     * - `true` - get files in the `parentDir` and all of its subdirectories
+     * - `false` - only get files in the `parentDir`
+     * */
+    recursive?: boolean;
+    /**
+     * `(optional)` - array of file extensions to filter files by.
+     * - `If` not provided, all files in the directory will be returned.
+     * - `If` provided, only files with extensions matching those in the array will be returned.
+     * */
+    targetExtensions?: string[];
+}

package/package.json

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