@baadal-sdk/dapi 0.31.6 → 1.0.0

package/src/fs/index.ts

@@ -1,316 +0,0 @@
-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';
-
-/**
- * Check whether a file exists
- * @param file file path
- * @param loud whether to throw errors [default: false]
- * @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 null;
-  file = assertPath(file);
-  try {
-    if (!fs.existsSync(file)) {
-      if (!loud) return false;
-      throw new CustomError(`File does not exist: ${file}`);
-    }
-  } catch (e) {
-    if (!loud) return null;
-    if (e instanceof CustomError) {
-      throw e;
-    } else {
-      throw new CustomError(`Error while accessing file: ${file}`);
-    }
-  }
-  return true;
-};
-
-/**
- * Check whether a directory exists
- * @param dir directory path
- * @param loud whether to throw errors [default: false]
- * @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 null;
-  dir = assertPath(dir);
-  try {
-    if (!fs.existsSync(dir)) {
-      if (!loud) return false;
-      throw new CustomError(`Directory does not exist: ${dir}`);
-    }
-  } catch (e) {
-    if (!loud) return null;
-    if (e instanceof CustomError) {
-      throw e;
-    } else {
-      throw new CustomError(`Error while accessing directory: ${dir}`);
-    }
-  }
-  return true;
-};
-
-/**
- * Read contents of a file
- * @param file file path
- * @param warn whether to show warnings [default: false]
- * @returns contents of the file, null in case of error
- */
-export const readFile = async (file: string, warn = false) => {
-  if (!file) return null;
-  file = assertPath(file);
-  let contents = null;
-  try {
-    contents = await fsa.readFile(file, 'utf8');
-  } catch (e) {
-    if (warn) cwarn(`Cannot read file: ${file}`);
-  }
-  return contents;
-};
-
-/**
- * Read contents of a file
- * @param file file path
- * @param warn whether to show warnings [default: false]
- * @returns contents of the file, null in case of error
- */
-export const readFileSync = (file: string, warn = false) => {
-  if (!file) return null;
-  file = assertPath(file);
-  let contents = null;
-  try {
-    contents = fs.readFileSync(file, 'utf8');
-  } catch (e) {
-    if (warn) cwarn(`Cannot read file: ${file}`);
-  }
-  return contents;
-};
-
-/**
- * Get the list of files/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 an object {dirs,files} containing list of directories & files, null in case or error
- */
-export const readDir = async (dir: string, warn = false, hiddenItems = false) => {
-  if (!dir) return null;
-  dir = assertPath(dir);
-
-  let dirs: string[] = [];
-  let files: string[] = [];
-
-  try {
-    const items = await fsa.readdir(dir, { withFileTypes: true });
-    items.forEach(item => {
-      if (item.isDirectory()) {
-        dirs.push(item.name);
-      } else if (item.isFile()) {
-        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 };
-};
-
-/**
- * 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
- */
-export const readDirFiles = async (dir: string, warn = false, hiddenItems = false) => {
-  if (!dir) return null;
-  dir = assertPath(dir);
-  return (await readDir(dir, warn, hiddenItems))?.files || null;
-};
-
-/**
- * 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
- */
-export const readDirDirs = async (dir: string, warn = false, hiddenItems = false) => {
-  if (!dir) return null;
-  dir = assertPath(dir);
-  return (await readDir(dir, warn, hiddenItems))?.dirs || null;
-};
-
-const readDirFilesRecHelper = async (dir: string, basePath = ''): Promise<string[] | null> => {
-  if (!dir) return null;
-  dir = assertPath(dir);
-
-  const dirPath = basePath ? `${dir}/${basePath}` : dir;
-  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));
-
-  const pList = absDirs.map(dirx => readDirFilesRecHelper(dir, dirx));
-  const filesxList = await Promise.all(pList);
-  filesxList.forEach(filesx => {
-    if (filesx) {
-      allFiles = [...allFiles, ...filesx];
-    }
-  });
-
-  return allFiles;
-};
-
-/**
- * Get the (recursive) list of files in a directory
- * @param dir directory path
- * @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 = 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, null in case of error
- */
-export const writeFile = async (file: string, contents: string) => {
-  if (!file || !contents) return null;
-  file = assertPath(file);
-  try {
-    const dir = file.substring(0, file.lastIndexOf('/'));
-    await fsa.mkdir(dir, { recursive: true });
-    await fsa.writeFile(file, contents);
-  } catch (e) {
-    console.error(`Error while writing to ${file}`, e);
-    return null;
-  }
-  return true;
-};
-
-/**
- * Append contents to a file
- * @param file file path
- * @param contents contents to append
- * @returns true if successful, null in case of error
- */
-export const appendToFile = async (file: string, contents: string) => {
-  if (!file || !contents) return null;
-  file = assertPath(file);
-  try {
-    const dir = file.substring(0, file.lastIndexOf('/'));
-    await fsa.mkdir(dir, { recursive: true });
-
-    await fsa.appendFile(file, contents + '\n');
-
-    // Ref: https://stackoverflow.com/a/43370201
-    // const stream = fs.createWriteStream(file, { flags: 'a' });
-    // stream.write(contents + '\n');
-    // stream.end();
-  } catch (e) {
-    console.error(`Error while appending to ${file}`, e);
-    return null;
-  }
-  return true;
-};
-
-/**
- * Rename a file
- * @param oldpath old file path
- * @param newpath new file path
- * @returns true if successful, null in case of error
- */
-export const renameFile = async (oldpath: string, newpath: string) => {
-  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 null;
-  }
-  return true;
-};
-
-/**
- * Create a directory, if it doesn't exist
- * @param dir directory path
- * @returns true if successful, null in case of failure/error
- */
-export const createDir = async (dir: string) => {
-  if (!dir) return null;
-  dir = assertPath(dir);
-  try {
-    if (!existsDirSync(dir)) {
-      await fsa.mkdir(dir, { recursive: true });
-    }
-  } catch (e) {
-    console.error(`Error while creating directory: ${dir}`, e);
-    return null;
-  }
-  return true;
-};
-
-/**
- * Delete a file
- * @param file file path
- * @returns true if successful, null in case of error
- */
-export const deleteFile = async (file: string) => {
-  if (!file) return null;
-  file = assertPath(file);
-  try {
-    await fsa.unlink(file);
-  } catch (e) {
-    console.error(`Error while deleting file ${file}`, e);
-    return null;
-  }
-  return true;
-};
-
-/**
- * Delete a directory
- * @param dir directory path
- * @returns true if successful, null in case of error
- */
-export const deleteDir = async (dir: string) => {
-  if (!dir) return null;
-  dir = assertPath(dir);
-  try {
-    const rimraf = require('rimraf');
-    const rimrafPr = util.promisify(rimraf);
-    await rimrafPr(dir);
-
-    // Added in: v14.14.0
-    // await fsa.rm(dir, { recursive: true, force: true });
-  } catch (e) {
-    console.error(`Error while deleting dir ${dir}`, e);
-    return null;
-  }
-  return true;
-};

package/src/gh/index.ts

@@ -1,60 +0,0 @@
-import { Octokit } from '@octokit/core';
-
-import { CustomError } from '../common/error';
-import { error } from '../common/logger';
-
-let github: Octokit | null = null;
-let owner: string | null = null;
-
-const GitHubError = (msg: string) => new CustomError(msg, { name: 'GitHubError' });
-
-const initializationError = () => {
-  throw GitHubError('GitHub SDK is possibly uninitialized!');
-};
-
-/**
- * Initialize GitHub SDK
- * @param authToken GitHub auth token for the user account [GITHUB_TOKEN]
- * @param account account id for the GitHub user account [GITHUB_ACCOUNT]
- */
-export const init = (authToken: string, account: string) => {
-  if (!authToken || !account) {
-    error(`GitHub initialization error! authToken: ${!!authToken}, account: ${!!account}`);
-    return;
-  }
-  github = new Octokit({ auth: authToken });
-  owner = account;
-};
-
-/**
- * Get contents of a particular file in a repo
- * @param repo name of the repo
- * @param path path of a file in the repo
- * @returns an object {response,headers} containing response and response headers, null in case of error
- */
-export const getContent = async (repo: string, path: string) => {
-  if (!github || !owner) return initializationError();
-
-  try {
-    const ghResp = await github.request('GET /repos/{owner}/{repo}/contents/{path}', {
-      owner,
-      repo,
-      path,
-    });
-    const response = ghResp.data as GitHubContent;
-    const { headers } = ghResp;
-    return { response, headers };
-  } catch (e) {
-    error(`[ERROR:gh.getContent]`, e);
-  }
-
-  return null;
-};
-
-// --------------
-
-export interface GitHubContent {
-  path: string;
-  content: string;
-  sha: string;
-}

package/src/index.ts

@@ -1,8 +0,0 @@
-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, utils }; // named exports
-export default { fs, aws, gh, utils }; // default export

package/src/utils/index.ts

@@ -1,39 +0,0 @@
-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);
-};