@baadal-sdk/dapi 0.19.0 → 0.23.0

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

@@ -0,0 +1,13 @@
+/**
+ * Partition key vs Composite primary key:
+ * Ref: https://aws.amazon.com/premiumsupport/knowledge-center/primary-key-dynamodb-table/
+ */
+import { StringIndexable } from '../common/common.model';
+export declare const init: (region: string) => void;
+export declare const writeItemForce: <T = any>(table: string, data: T, key?: string) => Promise<T | null>;
+export declare const writeItem: (table: string, data: StringIndexable) => Promise<true | null>;
+export declare const updateItem: (table: string, key: StringIndexable, update: string, attr: StringIndexable, attrNames?: StringIndexable<any> | undefined) => Promise<true | null>;
+export declare const readItem: <T = any>(table: string, key: StringIndexable, projection?: string) => Promise<T | null>;
+export declare const queryItems: (table: string, indexName: string, cond: string, attr: StringIndexable, projection?: string, desc?: boolean) => Promise<StringIndexable<any>[] | null>;
+export declare const scanItems: (table: string, projection?: string) => Promise<StringIndexable<any>[] | null>;
+//# sourceMappingURL=db.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../../src/aws/db.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkBH,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAWzD,eAAO,MAAM,IAAI,WAAY,MAAM,SAKlC,CAAC;AAiCF,eAAO,MAAM,cAAc,mBAA0B,MAAM,6CAE1D,CAAC;AAEF,eAAO,MAAM,SAAS,UAAiB,MAAM,QAAQ,eAAe,yBAiBnE,CAAC;AAEF,eAAO,MAAM,UAAU,UACd,MAAM,OACR,eAAe,UACZ,MAAM,QACR,eAAe,uEAyBtB,CAAC;AAEF,eAAO,MAAM,QAAQ,mBAA0B,MAAM,OAAO,eAAe,2CA0B1E,CAAC;AAEF,eAAO,MAAM,UAAU,UACd,MAAM,aACF,MAAM,QACX,MAAM,QACN,eAAe,gFAuCtB,CAAC;AAEF,eAAO,MAAM,SAAS,UAAiB,MAAM,gEA6B5C,CAAC"}

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

@@ -0,0 +1,11 @@
+declare const db: {
+    writeItemForce: <T = any>(table: string, data: T, key?: string) => Promise<T | null>;
+    writeItem: (table: string, data: import("../common/common.model").StringIndexable<any>) => Promise<true | null>;
+    updateItem: (table: string, key: import("../common/common.model").StringIndexable<any>, update: string, attr: import("../common/common.model").StringIndexable<any>, attrNames?: import("../common/common.model").StringIndexable<any> | undefined) => Promise<true | null>;
+    readItem: <T_1 = any>(table: string, key: import("../common/common.model").StringIndexable<any>, projection?: string) => Promise<T_1 | null>;
+    queryItems: (table: string, indexName: string, cond: string, attr: import("../common/common.model").StringIndexable<any>, projection?: string, desc?: boolean) => Promise<import("../common/common.model").StringIndexable<any>[] | null>;
+    scanItems: (table: string, projection?: string) => Promise<import("../common/common.model").StringIndexable<any>[] | null>;
+};
+declare const init: (region: string) => void;
+export { db, init };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/aws/index.ts"],"names":[],"mappings":"AAEA,QAAA,MAAyB,EAAE;;;;;;;CAAU,CAAC;AAEtC,QAAA,MAAM,IAAI,WAAY,MAAM,SAO3B,CAAC;AAEF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC"}

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

@@ -0,0 +1,4 @@
+export interface StringIndexable<T = any> {
+    [key: string]: T;
+}
+//# sourceMappingURL=common.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.model.d.ts","sourceRoot":"","sources":["../../../src/common/common.model.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC;CAClB"}

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

@@ -13,18 +13,19 @@ export declare const existsFileSync: (file: string, loud?: boolean) => boolean;
  */
 export declare const existsDirSync: (dir: string, loud?: boolean) => boolean;
 /**
- * Create a directory, if it doesn't exist
- * @param dir directory path
- * @returns true if successful, false in case of failure
+ * 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 declare const createDir: (dir: string) => Promise<boolean>;
+export declare const readFile: (file: string, warn?: boolean) => Promise<string | null>;
 /**
  * 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 declare const readFile: (file: string, warn?: boolean) => Promise<string | null>;
+export declare const readFileSync: (file: string, warn?: boolean) => string | null;
 /**
  * Get the list of files/directories in a directory
  * @param dir directory path
@@ -76,6 +77,12 @@ export declare const appendToFile: (file: string, contents: string) => Promise<b
  * @returns true if successful, false on error
  */
 export declare const renameFile: (oldpath: string, newpath: string) => Promise<boolean>;
+/**
+ * Create a directory, if it doesn't exist
+ * @param dir directory path
+ * @returns true if successful, false in case of failure
+ */
+export declare const createDir: (dir: string) => Promise<boolean>;
 /**
  * Delete a file
  * @param file file path

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fs/index.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,4BAiB1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAS,MAAM,4BAiBxC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,qBAY1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAgB,MAAM,2CAU1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,QAAe,MAAM;UA4BL,MAAM,EAAE,GAAG,IAAI;WAAS,MAAM,EAAE,GAAG,IAAI;EAC1E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,QAAe,MAAM,6CAI7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,QAAe,MAAM,6CAI5C,CAAC;AAuBF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,MAAM,6BAA+B,CAAC;AAE3E;;;;;GAKG;AACH,eAAO,MAAM,SAAS,SAAgB,MAAM,YAAY,MAAM,qBAY7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAgB,MAAM,YAAY,MAAM,qBAkBhE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,YAAmB,MAAM,WAAW,MAAM,qBAWhE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,SAAgB,MAAM,qBAU5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,qBAc1C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fs/index.ts"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,SAAU,MAAM,4BAiB1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAS,MAAM,4BAiBxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,SAAgB,MAAM,2CAU1C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,MAAM,kCAUxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,QAAe,MAAM;UA4BL,MAAM,EAAE,GAAG,IAAI;WAAS,MAAM,EAAE,GAAG,IAAI;EAC1E,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,QAAe,MAAM,6CAI7C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,QAAe,MAAM,6CAI5C,CAAC;AAuBF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,MAAM,6BAA+B,CAAC;AAE3E;;;;;GAKG;AACH,eAAO,MAAM,SAAS,SAAgB,MAAM,YAAY,MAAM,qBAY7D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAgB,MAAM,YAAY,MAAM,qBAkBhE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,YAAmB,MAAM,WAAW,MAAM,qBAWhE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,qBAY1C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,SAAgB,MAAM,qBAU5C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,SAAS,QAAe,MAAM,qBAe1C,CAAC"}

package/dist/types/index.d.ts

@@ -1,3 +1,9 @@
 import * as fs from './fs';
-export { fs };
+import * as aws from './aws';
+export { fs, aws };
+declare const _default: {
+    fs: typeof fs;
+    aws: typeof aws;
+};
+export default _default;
 //# 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,KAAK,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAAE,EAAE,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAG7B,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;;;;;AACnB,wBAA2B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baadal-sdk/dapi",
-  "version": "0.19.0",
+  "version": "0.23.0",
   "description": "Dead-simple API wrappers",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -10,7 +10,8 @@
     ".": {
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js"
-    }
+    },
+    "./cjs": "./dist/cjs/index.js"
   },
   "files": [
     "dist",
@@ -19,7 +20,7 @@
   "author": "Abhishek Raj <abhi@raj.me>",
   "license": "MIT",
   "engines": {
-    "node": ">=12.5.0"
+    "node": ">=14.10.0"
   },
   "scripts": {
     "build": "npm run verify && bash tasks/build.sh",
@@ -67,11 +68,15 @@
     "ts-node": "10.2.1",
     "typescript": "4.4.3",
     "webpack": "5.53.0",
-    "webpack-cli": "4.8.0"
+    "webpack-cli": "4.8.0",
+    "webpack-node-externals": "3.0.0"
   },
   "dependencies": {
-    "core-js": "3.18.0",
-    "rimraf": "3.0.2"
+    "@aws-sdk/client-dynamodb": "^3.34.0",
+    "@aws-sdk/lib-dynamodb": "^3.34.0",
+    "core-js": "^3.18.0",
+    "rimraf": "^3.0.2",
+    "short-uuid": "^4.2.0"
   },
   "peerDependencies": {
     "react": ">=16.8.6",

package/src/aws/db.ts

@@ -0,0 +1,244 @@
+/**
+ * Partition key vs Composite primary key:
+ * Ref: https://aws.amazon.com/premiumsupport/knowledge-center/primary-key-dynamodb-table/
+ */
+
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import {
+  DynamoDBDocumentClient,
+  GetCommand,
+  GetCommandInput,
+  PutCommand,
+  PutCommandInput,
+  UpdateCommand,
+  UpdateCommandInput,
+  QueryCommand,
+  QueryCommandInput,
+  ScanCommand,
+  ScanCommandInput,
+} from '@aws-sdk/lib-dynamodb';
+import short from 'short-uuid';
+
+import { StringIndexable } from '../common/common.model';
+import { CustomError } from '../common/error';
+
+let dbDocClient: DynamoDBDocumentClient | null = null;
+
+const DynamoDBError = (msg: string) => new CustomError(msg, { name: 'DynamoDBError' });
+
+const initializationError = () => {
+  throw DynamoDBError('DynamoDB is possibly uninitialized!');
+};
+
+export const init = (region: string) => {
+  const dbClient = new DynamoDBClient({ region });
+
+  // Ref: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html#configuration
+  dbDocClient = DynamoDBDocumentClient.from(dbClient);
+};
+
+const writeItemForceHelper = async <T = any>(table: string, data: T, key: string, i: number): Promise<T | null> => {
+  if (!dbDocClient) return initializationError();
+  if (!table || !data) return null;
+
+  if (!(data as any)[key]) {
+    (data as any)[key] = short.uuid();
+  }
+  const cmdParams: PutCommandInput = { TableName: table, Item: data, ConditionExpression: `attribute_not_exists(${key})` };
+  const command = new PutCommand(cmdParams);
+  const numberOfAttempts = 3;
+
+  try {
+    await dbDocClient.send(command);
+  } catch (err: any) {
+    // console.error('PutCommandInput:', cmdParams);
+    // console.error(err);
+    if (err.name === 'ConditionalCheckFailedException') {
+      if (i < numberOfAttempts - 1) {
+        (data as any)[key] = short.uuid(); // new primary key
+        const ret: T | null = await writeItemForceHelper(table, data, key, i + 1);
+        return ret;
+      }
+      console.error('PutCommandInput:', cmdParams);
+      console.error('[ERROR] Maximum attempts overflow!');
+    }
+    return null;
+  }
+
+  return data;
+};
+
+export const writeItemForce = async <T = any>(table: string, data: T, key = 'id'): Promise<T | null> => {
+  return writeItemForceHelper<T>(table, data, key, 0);
+};
+
+export const writeItem = async (table: string, data: StringIndexable) => {
+  if (!dbDocClient) return initializationError();
+  if (!table || !data) return null;
+
+  const cmdParams: PutCommandInput = { TableName: table, Item: data };
+  const command = new PutCommand(cmdParams);
+
+  try {
+    await dbDocClient.send(command);
+  } catch (err) {
+    console.error('PutCommandInput:', cmdParams);
+    console.error(err);
+    return null;
+    // throw err;
+  }
+
+  return true;
+};
+
+export const updateItem = async (
+  table: string,
+  key: StringIndexable,
+  update: string,
+  attr: StringIndexable,
+  attrNames?: StringIndexable
+) => {
+  if (!dbDocClient) return initializationError();
+  if (!table || !key || !update || !attr) return null;
+
+  let cmdParams: UpdateCommandInput = {
+    TableName: table,
+    Key: key,
+    UpdateExpression: update,
+    ExpressionAttributeValues: attr,
+  };
+  if (attrNames) cmdParams = { ...cmdParams, ExpressionAttributeNames: attrNames };
+  const command = new UpdateCommand(cmdParams);
+
+  try {
+    await dbDocClient.send(command);
+  } catch (err) {
+    console.error('UpdateCommandInput:', cmdParams);
+    console.error(err);
+    return null;
+    // throw err;
+  }
+
+  return true;
+};
+
+export const readItem = async <T = any>(table: string, key: StringIndexable, projection = '') => {
+  if (!dbDocClient) return initializationError();
+  if (!table || !key) return null;
+
+  let contents: T | null = null;
+  let cmdParams: GetCommandInput = { TableName: table, Key: key };
+
+  // Ref: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ProjectionExpressions.html
+  if (projection) cmdParams = { ...cmdParams, ProjectionExpression: projection };
+
+  const command = new GetCommand(cmdParams);
+
+  try {
+    const results = await dbDocClient.send(command);
+    const item = results.Item;
+
+    if (item) {
+      contents = item as T;
+    }
+  } catch (err) {
+    console.error('GetCommandInput:', cmdParams);
+    console.error(err);
+    // throw err;
+  }
+
+  return contents;
+};
+
+export const queryItems = async (
+  table: string,
+  indexName: string,
+  cond: string,
+  attr: StringIndexable,
+  projection = '',
+  desc = false
+) => {
+  if (!dbDocClient) return initializationError();
+  if (!table || !cond || !attr) return null;
+
+  let contents: StringIndexable[] | null = null;
+
+  // Ref: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html
+  // Ref: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-example-query-scan.html
+  // Ref: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/SQLtoNoSQL.Indexes.QueryAndScan.html#SQLtoNoSQL.Indexes.QueryAndScan.DynamoDB
+  let cmdParams: QueryCommandInput = {
+    TableName: table,
+    KeyConditionExpression: cond,
+    ExpressionAttributeValues: attr,
+    // FilterExpression: "contains (category_id, :cid)",
+  };
+
+  if (indexName) cmdParams = { ...cmdParams, IndexName: indexName };
+  if (projection) cmdParams = { ...cmdParams, ProjectionExpression: projection };
+  if (desc) cmdParams = { ...cmdParams, ScanIndexForward: false };
+
+  const command = new QueryCommand(cmdParams);
+
+  try {
+    const results = await dbDocClient.send(command);
+    const items = results.Items;
+
+    if (items) {
+      contents = items;
+    }
+  } catch (err) {
+    console.error('QueryCommandInput:', command.input);
+    console.error(err);
+    // throw err;
+  }
+
+  return contents;
+};
+
+export const scanItems = async (table: string, projection = '') => {
+  if (!dbDocClient) return initializationError();
+  if (!table) return null;
+
+  let contents: StringIndexable[] | null = null;
+
+  // Ref: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/dynamodb-example-query-scan.html
+  let cmdParams: ScanCommandInput = {
+    TableName: table,
+  };
+
+  if (projection) cmdParams = { ...cmdParams, ProjectionExpression: projection };
+
+  const command = new ScanCommand(cmdParams);
+
+  try {
+    const results = await dbDocClient.send(command);
+    const items = results.Items;
+
+    if (items) {
+      contents = items;
+    }
+  } catch (err) {
+    console.error('ScanCommandInput:', cmdParams);
+    console.error(err);
+    // throw err;
+  }
+
+  return contents;
+};
+
+// ----------------
+
+// await dbWriteItem('lesson_list', { id: 'id_001', title: 'My Lesson' });
+
+// const contents = await dbReadItem('lesson_list', { id: 'id_001' });
+// console.log(contents);
+
+// await dbUpdateItem(
+//   'lesson_list',
+//   { id: 'id_001' },
+//   'set #a = :a, #b = :b',
+//   { ':a': 'abhi@raj.me', ':b': 'Abhishek Raj' },
+//   { '#a': 'email', '#b': 'name' }
+// );
+
+// ----------------

package/src/aws/index.ts

@@ -0,0 +1,14 @@
+import * as dbAll from './db';
+
+const { init: dbInit, ...db } = dbAll;
+
+const init = (region: string) => {
+  if (!region) {
+    console.warn(`[WARN] AWS initialization error! Missing region: ${region}`);
+    return;
+  }
+
+  dbInit(region);
+};
+
+export { db, init }; // named exports

package/src/common/common.model.ts

@@ -0,0 +1,3 @@
+export interface StringIndexable<T = any> {
+  [key: string]: T;
+}

package/src/fs/index.ts

@@ -2,7 +2,6 @@ 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';
 
@@ -62,22 +61,21 @@ export const existsDirSync = (dir: string, loud = false) => {
 };
 
 /**
- * Create a directory, if it doesn't exist
- * @param dir directory path
- * @returns true if successful, false in case of failure
+ * 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 createDir = async (dir: string) => {
-  if (!dir) return false;
-  dir = assertPath(dir);
+export const readFile = async (file: string, warn = false) => {
+  if (!file) return null;
+  file = assertPath(file);
+  let contents = null;
   try {
-    if (!existsDirSync(dir)) {
-      await fsa.mkdir(dir, { recursive: true });
-    }
+    contents = await fsa.readFile(file, 'utf8');
   } catch (e) {
-    console.error(`Error while creating directory: ${dir}`, e);
-    return false;
+    if (warn) console.warn(`Cannot read file: ${file}`);
   }
-  return true;
+  return contents;
 };
 
 /**
@@ -86,12 +84,12 @@ export const createDir = async (dir: string) => {
  * @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) => {
+export const readFileSync = (file: string, warn = false) => {
   if (!file) return null;
   file = assertPath(file);
   let contents = null;
   try {
-    contents = await fsa.readFile(file, 'utf8');
+    contents = fs.readFileSync(file, 'utf8');
   } catch (e) {
     if (warn) console.warn(`Cannot read file: ${file}`);
   }
@@ -252,6 +250,25 @@ export const renameFile = async (oldpath: string, newpath: string) => {
   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;
+};
+
 /**
  * Delete a file
  * @param file file path
@@ -278,6 +295,7 @@ export const deleteDir = async (dir: string) => {
   if (!dir) return false;
   dir = assertPath(dir);
   try {
+    const rimraf = require('rimraf');
     const rimrafPr = util.promisify(rimraf);
     await rimrafPr(dir);
 

package/src/index.ts

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