@baadal-sdk/dapi 0.28.4 → 0.31.0

package/src/fs/index.ts

@@ -1,24 +1,19 @@
-import path from 'path';
 import util from 'util';
 import fs from 'fs';
 import fsa from 'fs/promises';
 
+import { assertPath } from '../utils';
 import { CustomError } from '../common/error';
 import { warn as cwarn } from '../common/logger';
 
-const assertPath = (p: string) => {
-  if (!p || p.startsWith('/')) return p;
-  return path.resolve(process.cwd(), p);
-};
-
 /**
  * Check whether a file exists
  * @param file file path
  * @param loud whether to throw errors [default: false]
- * @returns true if it exists, false otherwise
+ * @returns true if it exists, false if it doesn't, null in case of error
  */
 export const existsFileSync = (file: string, loud = false) => {
-  if (!file) return false;
+  if (!file) return null;
   file = assertPath(file);
   try {
     if (!fs.existsSync(file)) {
@@ -26,7 +21,7 @@ export const existsFileSync = (file: string, loud = false) => {
       throw new CustomError(`File does not exist: ${file}`);
     }
   } catch (e) {
-    if (!loud) return false;
+    if (!loud) return null;
     if (e instanceof CustomError) {
       throw e;
     } else {
@@ -40,10 +35,10 @@ export const existsFileSync = (file: string, loud = false) => {
  * Check whether a directory exists
  * @param dir directory path
  * @param loud whether to throw errors [default: false]
- * @returns true if it exists, false otherwise
+ * @returns true if it exists, false if it doesn't, null in case of error
  */
 export const existsDirSync = (dir: string, loud = false) => {
-  if (!dir) return false;
+  if (!dir) return null;
   dir = assertPath(dir);
   try {
     if (!fs.existsSync(dir)) {
@@ -51,7 +46,7 @@ export const existsDirSync = (dir: string, loud = false) => {
       throw new CustomError(`Directory does not exist: ${dir}`);
     }
   } catch (e) {
-    if (!loud) return false;
+    if (!loud) return null;
     if (e instanceof CustomError) {
       throw e;
     } else {
@@ -101,61 +96,62 @@ export const readFileSync = (file: string, warn = false) => {
  * Get the list of files/directories in a directory
  * @param dir directory path
  * @param warn whether to show warnings [default: false]
- * @returns an object {dirs,files} containing list of directories & files
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
+ * @returns an object {dirs,files} containing list of directories & files, null in case or error
  */
-export const readDir = async (dir: string, warn = false) => {
-  if (!dir) return { dirs: null, files: null };
+export const readDir = async (dir: string, warn = false, hiddenItems = false) => {
+  if (!dir) return null;
   dir = assertPath(dir);
 
-  let files: string[] | null = null;
-  let dirs: string[] | null = null;
+  let dirs: string[] = [];
+  let files: string[] = [];
 
   try {
     const items = await fsa.readdir(dir, { withFileTypes: true });
     items.forEach(item => {
       if (item.isDirectory()) {
-        if (!dirs) {
-          dirs = [item.name];
-        } else {
-          dirs.push(item.name);
-        }
+        dirs.push(item.name);
       } else if (item.isFile()) {
-        if (!files) {
-          files = [item.name];
-        } else {
-          files.push(item.name);
-        }
+        files.push(item.name);
       }
     });
   } catch (e) {
     if (warn) cwarn(`Cannot read dir: ${dir}`);
+    return null;
+  }
+
+  if (!hiddenItems) {
+    dirs = (dirs as string[]).filter(d => !d.startsWith('.'));
+    files = (files as string[]).filter(f => !f.startsWith('.'));
   }
 
-  return { dirs, files } as { dirs: string[] | null; files: string[] | null };
+  return { dirs, files };
 };
 
 /**
  * Get the list of files in a directory
  * @param dir directory path
  * @param warn whether to show warnings [default: false]
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
  * @returns list of files, null in case of error or no items
  */
-export const readDirFiles = async (dir: string, warn = false) => {
+export const readDirFiles = async (dir: string, warn = false, hiddenItems = false) => {
   if (!dir) return null;
   dir = assertPath(dir);
-  return (await readDir(dir, warn)).files;
+  return (await readDir(dir, warn, hiddenItems))?.files;
 };
 
 /**
  * Get the list of directories in a directory
  * @param dir directory path
  * @param warn whether to show warnings [default: false]
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
  * @returns list of directories, null in case of error or no items
  */
-export const readDirDirs = async (dir: string, warn = false) => {
+export const readDirDirs = async (dir: string, warn = false, hiddenItems = false) => {
   if (!dir) return null;
   dir = assertPath(dir);
-  return (await readDir(dir, warn)).dirs;
+  return (await readDir(dir, warn, hiddenItems))?.dirs;
 };
 
 const readDirFilesRecHelper = async (dir: string, basePath = ''): Promise<string[] | null> => {
@@ -163,7 +159,10 @@ const readDirFilesRecHelper = async (dir: string, basePath = ''): Promise<string
   dir = assertPath(dir);
 
   const dirPath = basePath ? `${dir}/${basePath}` : dir;
-  const { dirs, files } = await readDir(dirPath);
+  const readDirObj = await readDir(dirPath);
+  if (!readDirObj) return null;
+
+  const { dirs, files } = readDirObj;
   let allFiles: string[] = files || [];
   allFiles = allFiles.map(file => (basePath ? `${basePath}/${file}` : file));
   const absDirs = (dirs || []).map(d => (basePath ? `${basePath}/${d}` : d));
@@ -176,24 +175,31 @@ const readDirFilesRecHelper = async (dir: string, basePath = ''): Promise<string
     }
   });
 
-  return allFiles.length ? allFiles : null;
+  return allFiles;
 };
 
 /**
  * Get the (recursive) list of files in a directory
  * @param dir directory path
- * @returns complete (recursive) list of files, null in case of error or no items
+ * @param hiddenItems whether to include items starting with dot(.) [default: false]
+ * @returns complete (recursive) list of files, null in case of error
  */
-export const readDirFilesRec = (dir: string) => readDirFilesRecHelper(dir);
+export const readDirFilesRec = async (dir: string, hiddenItems = false) => {
+  let allFiles = await readDirFilesRecHelper(dir);
+  if (!hiddenItems) {
+    if (allFiles) allFiles = allFiles.filter(f => !f.startsWith('.'));
+  }
+  return allFiles;
+};
 
 /**
  * Write contents to a file (creates the file path if it doesn't exist)
  * @param file file path
  * @param contents contents to write
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
 export const writeFile = async (file: string, contents: string) => {
-  if (!file || !contents) return false;
+  if (!file || !contents) return null;
   file = assertPath(file);
   try {
     const dir = file.substring(0, file.lastIndexOf('/'));
@@ -201,7 +207,7 @@ export const writeFile = async (file: string, contents: string) => {
     await fsa.writeFile(file, contents);
   } catch (e) {
     console.error(`Error while writing to ${file}`, e);
-    return false;
+    return null;
   }
   return true;
 };
@@ -210,10 +216,10 @@ export const writeFile = async (file: string, contents: string) => {
  * Append contents to a file
  * @param file file path
  * @param contents contents to append
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
 export const appendToFile = async (file: string, contents: string) => {
-  if (!file || !contents) return false;
+  if (!file || !contents) return null;
   file = assertPath(file);
   try {
     const dir = file.substring(0, file.lastIndexOf('/'));
@@ -227,7 +233,7 @@ export const appendToFile = async (file: string, contents: string) => {
     // stream.end();
   } catch (e) {
     console.error(`Error while appending to ${file}`, e);
-    return false;
+    return null;
   }
   return true;
 };
@@ -236,17 +242,17 @@ export const appendToFile = async (file: string, contents: string) => {
  * Rename a file
  * @param oldpath old file path
  * @param newpath new file path
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
 export const renameFile = async (oldpath: string, newpath: string) => {
-  if (!oldpath || !newpath) return false;
+  if (!oldpath || !newpath) return null;
   oldpath = assertPath(oldpath);
   newpath = assertPath(newpath);
   try {
     await fsa.rename(oldpath, newpath);
   } catch (e) {
     console.error(`Error while renaming file ${oldpath} to ${newpath}`, e);
-    return false;
+    return null;
   }
   return true;
 };
@@ -254,10 +260,10 @@ export const renameFile = async (oldpath: string, newpath: string) => {
 /**
  * Create a directory, if it doesn't exist
  * @param dir directory path
- * @returns true if successful, false in case of failure
+ * @returns true if successful, null in case of failure/error
  */
 export const createDir = async (dir: string) => {
-  if (!dir) return false;
+  if (!dir) return null;
   dir = assertPath(dir);
   try {
     if (!existsDirSync(dir)) {
@@ -265,7 +271,7 @@ export const createDir = async (dir: string) => {
     }
   } catch (e) {
     console.error(`Error while creating directory: ${dir}`, e);
-    return false;
+    return null;
   }
   return true;
 };
@@ -273,16 +279,16 @@ export const createDir = async (dir: string) => {
 /**
  * Delete a file
  * @param file file path
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
 export const deleteFile = async (file: string) => {
-  if (!file) return false;
+  if (!file) return null;
   file = assertPath(file);
   try {
     await fsa.unlink(file);
   } catch (e) {
     console.error(`Error while deleting file ${file}`, e);
-    return false;
+    return null;
   }
   return true;
 };
@@ -290,10 +296,10 @@ export const deleteFile = async (file: string) => {
 /**
  * Delete a directory
  * @param dir directory path
- * @returns true if successful, false on error
+ * @returns true if successful, null in case of error
  */
 export const deleteDir = async (dir: string) => {
-  if (!dir) return false;
+  if (!dir) return null;
   dir = assertPath(dir);
   try {
     const rimraf = require('rimraf');
@@ -304,7 +310,7 @@ export const deleteDir = async (dir: string) => {
     // await fsa.rm(dir, { recursive: true, force: true });
   } catch (e) {
     console.error(`Error while deleting dir ${dir}`, e);
-    return false;
+    return null;
   }
   return true;
 };

package/src/index.ts

@@ -1,7 +1,8 @@
 import * as fs from './fs';
 import * as aws from './aws';
 import * as gh from './gh';
+import * as utils from './utils';
 
 // Ref: https://stackoverflow.com/a/41283945
-export { fs, aws, gh }; // named exports
-export default { fs, aws, gh }; // default export
+export { fs, aws, gh, utils }; // named exports
+export default { fs, aws, gh, utils }; // default export

package/src/utils/index.ts

@@ -0,0 +1,39 @@
+import path from 'path';
+import crypto from 'crypto';
+import fsa from 'fs/promises';
+
+import { error } from '../common/logger';
+
+export const assertPath = (p: string) => {
+  if (!p || p.startsWith('/')) return p;
+  return path.resolve(process.cwd(), p);
+};
+
+export const sha1Hash = (data: string) => {
+  if (!data) return null;
+  const hashSum = crypto.createHash('sha1');
+  hashSum.update(data);
+  return hashSum.digest('hex');
+};
+
+export const sha256Hash = (data: string | Buffer) => {
+  if (!data) return null;
+  const hashSum = crypto.createHash('sha256');
+  hashSum.update(data);
+  return hashSum.digest('hex');
+};
+
+export const fileHash = async (file: string) => {
+  if (!file) return null;
+  let contents: Buffer | null = null;
+
+  try {
+    // get buffer (instead of utf8 string) to support binary data
+    contents = await fsa.readFile(file);
+  } catch (e) {
+    error(e);
+    return null;
+  }
+
+  return sha256Hash(contents);
+};

package/dist/types/aws/db-client.d.ts

@@ -1,7 +0,0 @@
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-declare const _default: {
-    dbDocClient: DynamoDBDocumentClient | null;
-    id: string | null;
-};
-export default _default;
-//# sourceMappingURL=db-client.d.ts.map

package/dist/types/aws/db-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"db-client.d.ts","sourceRoot":"","sources":["../../../src/aws/db-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;;iBAKV,sBAAsB,GAAG,IAAI;QAAM,MAAM,GAAG,IAAI;;AAArG,wBAAwG"}

package/src/aws/db-client.ts

@@ -1,6 +0,0 @@
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-
-const dbDocClient: DynamoDBDocumentClient | null = null;
-const id: string | null = null;
-
-export default { dbDocClient, id } as { dbDocClient: DynamoDBDocumentClient | null; id: string | null };