@aicore/cocodb-ws-client 1.0.14 → 1.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicore/cocodb-ws-client",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Websocket client for cocoDb",
   "main": "src/index.js",
   "type": "module",
@@ -47,23 +47,23 @@
   },
   "homepage": "https://github.com/aicore/cocoDbWsClient#readme",
   "devDependencies": {
-    "@commitlint/cli": "17.4.3",
-    "@commitlint/config-conventional": "17.4.3",
+    "@commitlint/cli": "17.4.4",
+    "@commitlint/config-conventional": "17.4.4",
     "c8": "7.13.0",
     "chai": "4.3.7",
     "cli-color": "2.0.3",
     "documentation": "14.0.1",
-    "eslint": "8.34.0",
-    "glob": "8.1.0",
+    "eslint": "8.36.0",
+    "glob": "9.3.0",
     "husky": "8.0.3",
     "mocha": "10.2.0"
   },
   "dependencies": {
-    "@aicore/libcommonutils": "1.0.19",
-    "ws": "8.12.1"
+    "@aicore/libcommonutils": "1.0.20",
+    "ws": "8.13.0"
   },
   "optionalDependencies": {
     "bufferutil": "4.0.7",
-    "utf-8-validate": "6.0.2"
+    "utf-8-validate": "6.0.3"
   }
 }

package/src/index.js

@@ -25,6 +25,7 @@ export {
     put,
     mathAdd,
     deleteDocument,
+    deleteDocuments,
     deleteDb,
     getFromIndex,
     createIndex,
@@ -80,4 +81,4 @@ export {
  * await db.close();
  * ```
  * @module @aicore/cocodb-ws-client
- */
+ */

package/src/utils/api.js

@@ -219,9 +219,11 @@ export function getFromNonIndex(tableName, queryObject = {}, options= {}) {
  * > This function deletes a document from a table
  * @param {string} tableName - The name of the table you want to delete the document from.
  * @param {string} documentId - The id of the document to delete.
+ * @param {string} [condition] - Optional coco query condition of the form "$.cost<35" that must be satisfied
+ * for delete to happen. See query API for more details on how to write coco query strings.
  * @returns {Promise} A promise.
  */
-export function deleteDocument(tableName, documentId) {
+export function deleteDocument(tableName, documentId, condition) {
     if (isStringEmpty(tableName)) {
         throw new Error('Please provide valid table name');
     }
@@ -233,11 +235,38 @@ export function deleteDocument(tableName, documentId) {
             fn: COCO_DB_FUNCTIONS.deleteDocument,
             request: {
                 tableName: tableName,
-                documentId: documentId
+                documentId: documentId,
+                condition
             }
         });
 }
 
+/**
+ * > This function deletes all documents satisfying query condition from a table
+ * @param {string} tableName - The name of the table in which the key is to be deleted.
+ * @param {string} queryString - The cocDB query string.
+ * @param {Array[string]} useIndexForFields - List of indexed fields in the document.
+ * @returns {Promise} A promise.
+ */
+export function deleteDocuments(tableName, queryString, useIndexForFields = []) {
+    if (isStringEmpty(tableName)) {
+        throw new Error('Please provide valid table name');
+    }
+    if (isStringEmpty(queryString)) {
+        throw new Error('Please provide valid queryString');
+    }
+    return sendMessage(
+        {
+            fn: COCO_DB_FUNCTIONS.deleteDocuments,
+            request: {
+                tableName,
+                queryString,
+                useIndexForFields
+            }
+        });
+}
+
+
 /**
  * > This function deletes a table from the database
  * @param {string} tableName - The name of the table to delete.