@baadal-sdk/dapi 0.14.0 → 0.18.0

package/dist/types/common/error.d.ts

@@ -0,0 +1,4 @@
+export declare class CustomError extends Error {
+    constructor(message: string, options?: any);
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/types/common/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/common/error.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,GAAQ;CAU/C"}

package/dist/types/fs/index.d.ts

@@ -1,5 +1,17 @@
-declare const _default: {
-    log: () => void;
-};
-export default _default;
+export declare const existsFileSync: (file: string, loud?: boolean) => boolean;
+export declare const existsDirSync: (dir: string, loud?: boolean) => boolean;
+export declare const createDir: (dir: string) => Promise<boolean>;
+export declare const readFile: (file: string, warn?: boolean) => Promise<string | null>;
+export declare const readDir: (dir: string, warn?: boolean) => Promise<{
+    dirs: string[] | null;
+    files: string[] | null;
+}>;
+export declare const readDirFiles: (dir: string, warn?: boolean) => Promise<string[] | null>;
+export declare const readDirDirs: (dir: string, warn?: boolean) => Promise<string[] | null>;
+export declare const readDirFilesRec: (dir: string) => Promise<string[] | null>;
+export declare const writeFile: (file: string, contents: string) => Promise<boolean>;
+export declare const appendToFile: (file: string, contents: string) => Promise<boolean>;
+export declare const renameFile: (oldpath: string, newpath: string) => Promise<boolean>;
+export declare const deleteFile: (file: string) => Promise<boolean>;
+export declare const deleteDir: (dir: string) => Promise<boolean>;
 //# sourceMappingURL=index.d.ts.map

package/dist/types/fs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fs/index.ts"],"names":[],"mappings":";;;AAIA,wBAAuB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fs/index.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,cAAc,SAAU,MAAM,4BAiB1C,CAAC;AAQF,eAAO,MAAM,aAAa,QAAS,MAAM,4BAiBxC,CAAC;AAOF,eAAO,MAAM,SAAS,QAAe,MAAM,qBAY1C,CAAC;AAQF,eAAO,MAAM,QAAQ,SAAgB,MAAM,2CAU1C,CAAC;AAQF,eAAO,MAAM,OAAO,QAAe,MAAM;UA4BL,MAAM,EAAE,GAAG,IAAI;WAAS,MAAM,EAAE,GAAG,IAAI;EAC1E,CAAC;AAQF,eAAO,MAAM,YAAY,QAAe,MAAM,6CAI7C,CAAC;AAQF,eAAO,MAAM,WAAW,QAAe,MAAM,6CAI5C,CAAC;AA4BF,eAAO,MAAM,eAAe,QAAS,MAAM,6BAA+B,CAAC;AAQ3E,eAAO,MAAM,SAAS,SAAgB,MAAM,YAAY,MAAM,qBAY7D,CAAC;AAQF,eAAO,MAAM,YAAY,SAAgB,MAAM,YAAY,MAAM,qBAkBhE,CAAC;AAQF,eAAO,MAAM,UAAU,YAAmB,MAAM,WAAW,MAAM,qBAWhE,CAAC;AAOF,eAAO,MAAM,UAAU,SAAgB,MAAM,qBAU5C,CAAC;AAOF,eAAO,MAAM,SAAS,QAAe,MAAM,qBAc1C,CAAC"}

package/dist/types/index.d.ts

@@ -1,6 +1,3 @@
-import fs from './fs';
-declare const foo: () => string;
-export { fs, foo };
-export declare const num = 5;
-export default fs;
+import * as fs from './fs';
+export { fs };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,MAAM,CAAC;AAEtB,QAAA,MAAM,GAAG,cAER,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;AACnB,eAAO,MAAM,GAAG,IAAI,CAAC;AACrB,eAAe,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,EAAE,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baadal-sdk/dapi",
-  "version": "0.14.0",
+  "version": "0.18.0",
   "description": "Dead-simple API wrappers",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -18,31 +18,84 @@
   ],
   "author": "Abhishek Raj <abhi@raj.me>",
   "license": "MIT",
+  "engines": {
+    "node": ">=12.5.0"
+  },
   "scripts": {
-    "build": "bash tasks/build.sh",
+    "build": "npm run verify && bash tasks/build.sh",
     "clean": "shx rm -rf dist",
-    "prepublishOnly": "run-s --silent clean build",
-    "pub": "npm publish",
-    "pub:test": "npm publish --dry-run"
+    "lint": "eslint '**/*.{js,jsx,ts,tsx}'",
+    "lint:fix": "npm run lint -- --fix",
+    "prepub": "run-s --silent clean build",
+    "pub": "npm run prepub && npm publish",
+    "pub:test": "npm run prepub && npm publish --dry-run",
+    "test": "ts-node test/index.ts",
+    "verify": "jsonlint -q tsconfig.json",
+    "blame": "git log -S",
+    "hist": "git log --oneline | grep -i",
+    "follow": "git log --follow --oneline",
+    "ncu": "ncu",
+    "ncuu": "ncu -u"
   },
   "devDependencies": {
     "@babel/core": "7.15.5",
     "@babel/preset-env": "7.15.6",
+    "@babel/preset-react": "^7.14.5",
     "@babel/preset-typescript": "7.15.0",
     "@types/node": "16.9.6",
+    "@types/react": "^16.0.0",
+    "@types/react-dom": "^16.0.0",
+    "@types/rimraf": "3.0.2",
+    "@typescript-eslint/eslint-plugin": "4.31.2",
+    "@typescript-eslint/parser": "4.31.2",
     "babel-loader": "8.2.2",
+    "eslint": "7.32.0",
+    "eslint-config-airbnb": "18.2.1",
+    "eslint-config-airbnb-typescript": "14.0.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-import": "2.24.2",
+    "eslint-plugin-jsx-a11y": "6.4.1",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-react": "7.26.0",
+    "eslint-plugin-react-hooks": "4.2.0",
+    "husky": "4.3.8",
+    "jsonlint": "1.6.3",
+    "lint-staged": "11.1.2",
     "npm-run-all": "4.1.5",
+    "prettier": "2.4.1",
     "shx": "0.3.3",
+    "ts-node": "10.2.1",
     "typescript": "4.4.3",
     "webpack": "5.53.0",
     "webpack-cli": "4.8.0"
   },
   "dependencies": {
-    "core-js": "3.18.0"
+    "core-js": "3.18.0",
+    "rimraf": "3.0.2"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.6",
+    "react-dom": ">=16.8.6"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
   },
   "browserslist": [
     "chrome >= 23"
   ],
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": "eslint --fix"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/baadal/dapi.git"

package/src/common/error.ts

@@ -0,0 +1,12 @@
+export class CustomError extends Error {
+  constructor(message: string, options: any = {}) {
+    super(message);
+
+    // Maintains proper stack trace for where our error was thrown (only available on V8)
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, CustomError);
+    }
+
+    this.name = options.name || 'CustomError';
+  }
+}

package/src/fs/index.ts

@@ -1,5 +1,291 @@
-const log = () => {
-  console.log('fs/log');
+import path from 'path';
+import util from 'util';
+import fs from 'fs';
+import fsa from 'fs/promises';
+import rimraf from 'rimraf';
+
+import { CustomError } from '../common/error';
+
+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
+ */
+export const existsFileSync = (file: string, loud = false) => {
+  if (!file) return false;
+  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 false;
+    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 otherwise
+ */
+export const existsDirSync = (dir: string, loud = false) => {
+  if (!dir) return false;
+  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 false;
+    if (e instanceof CustomError) {
+      throw e;
+    } else {
+      throw new CustomError(`Error while accessing directory: ${dir}`);
+    }
+  }
+  return true;
+};
+
+/**
+ * Create a directory, if it doesn't exist
+ * @param dir directory path
+ * @returns true if successful, false in case of failure
+ */
+export const createDir = async (dir: string) => {
+  if (!dir) return false;
+  dir = assertPath(dir);
+  try {
+    if (!existsDirSync(dir)) {
+      await fsa.mkdir(dir, { recursive: true });
+    }
+  } catch (e) {
+    console.error(`Error while creating directory: ${dir}`, e);
+    return false;
+  }
+  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) console.warn(`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]
+ * @returns an object {dirs,files} containing list of directories & files
+ */
+export const readDir = async (dir: string, warn = false) => {
+  if (!dir) return { dirs: null, files: null };
+  dir = assertPath(dir);
+
+  let files: string[] | null = null;
+  let dirs: string[] | null = null;
+
+  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);
+        }
+      } else if (item.isFile()) {
+        if (!files) {
+          files = [item.name];
+        } else {
+          files.push(item.name);
+        }
+      }
+    });
+  } catch (e) {
+    if (warn) console.warn(`Cannot read dir: ${dir}`);
+  }
+
+  return { dirs, files } as { dirs: string[] | null; files: string[] | null };
+};
+
+/**
+ * Get the list of files in a directory
+ * @param dir directory path
+ * @param warn whether to show warnings [default: false]
+ * @returns list of files, null in case of error or no items
+ */
+export const readDirFiles = async (dir: string, warn = false) => {
+  if (!dir) return null;
+  dir = assertPath(dir);
+  return (await readDir(dir, warn)).files;
+};
+
+/**
+ * Get the list of directories in a directory
+ * @param dir directory path
+ * @param warn whether to show warnings [default: false]
+ * @returns list of directories, null in case of error or no items
+ */
+export const readDirDirs = async (dir: string, warn = false) => {
+  if (!dir) return null;
+  dir = assertPath(dir);
+  return (await readDir(dir, warn)).dirs;
 };
 
-export default { log };
+const readDirFilesRecHelper = async (dir: string, basePath = ''): Promise<string[] | null> => {
+  if (!dir) return null;
+  dir = assertPath(dir);
+
+  const dirPath = basePath ? `${dir}/${basePath}` : dir;
+  const { dirs, files } = await readDir(dirPath);
+  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.length ? allFiles : null;
+};
+
+/**
+ * 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
+ */
+export const readDirFilesRec = (dir: string) => readDirFilesRecHelper(dir);
+
+/**
+ * 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
+ */
+export const writeFile = async (file: string, contents: string) => {
+  if (!file || !contents) return false;
+  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 false;
+  }
+  return true;
+};
+
+/**
+ * Append contents to a file
+ * @param file file path
+ * @param contents contents to append
+ * @returns true if successful, false on error
+ */
+export const appendToFile = async (file: string, contents: string) => {
+  if (!file || !contents) return false;
+  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 false;
+  }
+  return true;
+};
+
+/**
+ * Rename a file
+ * @param oldpath old file path
+ * @param newpath new file path
+ * @returns true if successful, false on error
+ */
+export const renameFile = async (oldpath: string, newpath: string) => {
+  if (!oldpath || !newpath) return false;
+  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 true;
+};
+
+/**
+ * Delete a file
+ * @param file file path
+ * @returns true if successful, false on error
+ */
+export const deleteFile = async (file: string) => {
+  if (!file) return false;
+  file = assertPath(file);
+  try {
+    await fsa.unlink(file);
+  } catch (e) {
+    console.error(`Error while deleting file ${file}`, e);
+    return false;
+  }
+  return true;
+};
+
+/**
+ * Delete a directory
+ * @param dir directory path
+ * @returns true if successful, false on error
+ */
+export const deleteDir = async (dir: string) => {
+  if (!dir) return false;
+  dir = assertPath(dir);
+  try {
+    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 false;
+  }
+  return true;
+};

package/src/index.ts

@@ -1,16 +1,3 @@
-import fs from './fs';
+import * as fs from './fs';
 
-const foo = () => {
-  return 'bar';
-};
-
-export { fs, foo };
-export const num = 5;
-export default fs;
-
-// ----------------
-// TODO:
-// npm pack, tarball, gzip [why?]
-// eslint, prettier
-// husky/lint-staged
-// ----------------
+export { fs };