@baadal-sdk/dapi 0.31.3 → 0.31.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baadal-sdk/dapi",
-  "version": "0.31.3",
+  "version": "0.31.5",
   "description": "Dead-simple API wrappers",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -39,55 +39,9 @@
     "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/mime-types": "^2.1.1",
-    "@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",
-    "webpack-node-externals": "3.0.0"
-  },
-  "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.34.0",
-    "@aws-sdk/client-s3": "^3.36.0",
-    "@aws-sdk/lib-dynamodb": "^3.34.0",
-    "@baadal-sdk/utils": "0.12.0",
-    "@octokit/core": "^3.5.1",
-    "chalk": "^2.4.2",
-    "core-js": "^3.18.0",
-    "mime-types": "^2.1.33",
-    "rimraf": "^3.0.2",
-    "short-uuid": "^4.2.0"
-  },
   "peerDependencies": {
-    "react": ">=16.8.6",
-    "react-dom": ">=16.8.6"
+    "react": ">=18.2.0",
+    "react-dom": ">=18.2.0"
   },
   "peerDependenciesMeta": {
     "react": {
@@ -97,6 +51,52 @@
       "optional": true
     }
   },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.264.0",
+    "@aws-sdk/client-s3": "^3.264.0",
+    "@aws-sdk/lib-dynamodb": "^3.264.0",
+    "@baadal-sdk/utils": "0.12.0",
+    "@octokit/core": "^4.2.0",
+    "chalk": "^5.2.0",
+    "core-js": "^3.27.2",
+    "mime-types": "^2.1.35",
+    "rimraf": "^4.1.2",
+    "short-uuid": "^4.2.2"
+  },
+  "devDependencies": {
+    "@babel/core": "7.20.12",
+    "@babel/preset-env": "7.20.2",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "7.18.6",
+    "@types/mime-types": "2.1.1",
+    "@types/node": "18.11.19",
+    "@types/react": "18.0.27",
+    "@types/react-dom": "18.0.10",
+    "@types/rimraf": "3.0.2",
+    "@typescript-eslint/eslint-plugin": "5.50.0",
+    "@typescript-eslint/parser": "5.50.0",
+    "babel-loader": "9.1.2",
+    "eslint": "8.33.0",
+    "eslint-config-airbnb": "19.0.4",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "husky": "4.3.8",
+    "jsonlint": "1.6.3",
+    "lint-staged": "11.1.2",
+    "npm-run-all": "4.1.5",
+    "prettier": "2.8.3",
+    "shx": "0.3.4",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.5",
+    "webpack": "5.75.0",
+    "webpack-cli": "5.0.1",
+    "webpack-node-externals": "3.0.0"
+  },
   "browserslist": [
     "chrome >= 23"
   ],

package/src/aws/db.ts

@@ -33,7 +33,7 @@ import { dbClient } from './client';
 import { StringIndexable } from '../common/common.model';
 import { CustomError } from '../common/error';
 import { warn, error } from '../common/logger';
-import { BATCH_SIZE, CHUNK_SIZE } from '../common/const';
+import { BATCH_SIZE, CHUNK_SIZE, MAX_RETRY_ATTEMPTS } from '../common/const';
 
 const DynamoDBError = (msg: string) => new CustomError(msg, { name: 'DynamoDBError' });
 
@@ -70,7 +70,13 @@ const tryInit = (silent = false) => {
 // auto-initialize on load
 tryInit(true);
 
-const writeItemForceHelper = async <T = any>(table: string, item: T, key: string, i: number): Promise<T | null> => {
+const writeItemForceHelper = async <T = any>(
+  table: string,
+  item: T,
+  key: string,
+  i: number,
+  imax?: number
+): Promise<T | null> => {
   if (!dbClient.client) tryInit();
   if (!dbClient.client) return null;
   if (!table || !item) return null;
@@ -80,7 +86,7 @@ const writeItemForceHelper = async <T = any>(table: string, item: T, key: string
   }
   const cmdParams: PutCommandInput = { TableName: table, Item: item, ConditionExpression: `attribute_not_exists(${key})` };
   const command = new PutCommand(cmdParams);
-  const numberOfAttempts = 3;
+  const numberOfAttempts = imax ?? MAX_RETRY_ATTEMPTS;
 
   try {
     await dbClient.client.send(command);
@@ -88,11 +94,15 @@ const writeItemForceHelper = async <T = any>(table: string, item: T, key: string
     if (err.name === 'ConditionalCheckFailedException') {
       if (i < numberOfAttempts - 1) {
         (item as any)[key] = short.uuid(); // new primary key
-        const ret: T | null = await writeItemForceHelper(table, item, key, i + 1);
+        const ret: T | null = await writeItemForceHelper(table, item, key, i + 1, imax);
         return ret;
       }
       console.error('PutCommandInput:', cmdParams);
-      error('[ERROR] Maximum attempts overflow!');
+      if (numberOfAttempts === 1) {
+        error(`[ERROR] An item with the same key(${(item as any)[key]}) already exists!`);
+      } else {
+        error('[ERROR] Maximum attempts overflow!');
+      }
     }
     return null;
   }
@@ -106,6 +116,8 @@ export interface WriteItemForceInput<T = any> {
   key?: string;
 }
 
+export type WriteItemUniqueInput<T = any> = WriteItemForceInput<T>;
+
 /**
  * Write an item to a DynamoDB table, retry in case of key conflict
  * @param input input command object
@@ -130,6 +142,32 @@ export const writeItemForce = async <T = any>(input: WriteItemForceInput<T>): Pr
   return writeItemForceHelper<T>(input.table, input.item, key, 0);
 };
 
+/**
+ * Write an item (uniquely) to a DynamoDB table.
+ * Unlike `writeItemForce`, it does not retry in case of key conflict
+ * Unlike `writeItem`, it does not overwrite an item with the same key (if it exists)
+ * @param input input command object
+ * @returns the created item, null in case of error or key conflict (i.e., if item with same key already exists)
+ *
+ * ```js
+ * writeItemUnique({
+ *   table: 'lesson_list',
+ *   item: { id: 'id_001', title: 'My Lesson' },
+ *   key: 'id',
+ * });
+ *
+ * interface WriteItemUniqueInput<T = any> {
+ *   table: string;
+ *   item: T;
+ *   key?: string; // default: `id`
+ * }
+ * ```
+ */
+export const writeItemUnique = async <T = any>(input: WriteItemUniqueInput<T>): Promise<T | null> => {
+  const key = input.key || 'id';
+  return writeItemForceHelper<T>(input.table, input.item, key, 0, 1);
+};
+
 export interface WriteItemInput {
   table: string;
   item: StringIndexable;

package/src/common/const.ts

@@ -1,2 +1,3 @@
 export const BATCH_SIZE = 20; // (max) number of items in a batch request
 export const CHUNK_SIZE = 10; // (max) number of parallel requests at a time
+export const MAX_RETRY_ATTEMPTS = 3; // (max) number of retry attempts in case of key conflict