@aicore/cocodb-ws-client 1.0.23 → 1.0.26

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicore/cocodb-ws-client",
-  "version": "1.0.23",
+  "version": "1.0.26",
   "description": "Websocket client for cocoDb",
   "main": "src/index.js",
   "type": "module",
@@ -38,7 +38,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/aicore/template-nodejs.git"
+    "url": "git+https://github.com/aicore/cocoDbWsClient.git"
   },
   "author": "Charly, core.ai",
   "license": "AGPL-3.0-or-later",
@@ -47,20 +47,20 @@
   },
   "homepage": "https://github.com/aicore/cocoDbWsClient#readme",
   "devDependencies": {
-    "@commitlint/cli": "19.8.0",
-    "@commitlint/config-conventional": "19.8.0",
+    "@commitlint/cli": "19.8.1",
+    "@commitlint/config-conventional": "19.8.1",
     "c8": "10.1.3",
-    "chai": "5.2.0",
+    "chai": "5.3.3",
     "cli-color": "2.0.4",
     "documentation": "14.0.3",
-    "eslint": "9.25.0",
-    "glob": "11.0.1",
+    "eslint": "9.39.2",
+    "glob": "11.1.0",
     "husky": "9.1.7",
-    "mocha": "11.1.0"
+    "mocha": "11.7.5"
   },
   "dependencies": {
     "@aicore/libcommonutils": "1.0.20",
-    "ws": "8.18.1"
+    "ws": "8.18.3"
   },
   "optionalDependencies": {
     "bufferutil": "4.0.9",

package/src/index.js

@@ -35,7 +35,10 @@ export {
     getFromNonIndex,
     hello,
     update,
-    query
+    query,
+    listDatabases,
+    listTables,
+    getTableIndexes
 
 } from './utils/api.js';
 

package/src/utils/api.js

@@ -392,3 +392,51 @@ export function query(tableName, queryString, useIndexForFields = null, options=
         });
 }
 
+/**
+ * Lists all databases on the MySQL server.
+ * @example <caption>Sample usage</caption>
+ * const response = await listDatabases();
+ * console.log(response.databases); // ['mysql', 'information_schema', 'mydb']
+ * @returns {Promise<Object>} A promise resolving to {isSuccess: boolean, databases: string[]}
+ */
+export function listDatabases() {
+    return sendMessage({
+        fn: 'listDatabases',
+        request: {}
+    });
+}
+
+/**
+ * Lists all tables in a database.
+ * @param {string} databaseName - The name of the database
+ * @returns {Promise<Object>} A promise resolving to {isSuccess: boolean, tables: string[]}
+ */
+export function listTables(databaseName) {
+    if (isStringEmpty(databaseName)) {
+        throw new Error('Please provide valid databaseName');
+    }
+    return sendMessage({
+        fn: 'listTables',
+        request: {
+            databaseName: databaseName
+        }
+    });
+}
+
+/**
+ * Gets index information for a table.
+ * @param {string} tableName - The table name in database.tableName format
+ * @returns {Promise<Object>} A promise resolving to {isSuccess: boolean, indexes: IndexInfo[]}
+ */
+export function getTableIndexes(tableName) {
+    if (isStringEmpty(tableName)) {
+        throw new Error('Please provide valid tableName');
+    }
+    return sendMessage({
+        fn: 'getTableIndexes',
+        request: {
+            tableName: tableName
+        }
+    });
+}
+

package/src/utils/client.js

@@ -1,6 +1,22 @@
 import {WS} from "./WebSocket.js";
 import {isString, isObject, isStringEmpty, COCO_DB_FUNCTIONS} from "@aicore/libcommonutils";
 
+// Additional functions not yet in COCO_DB_FUNCTIONS from libcommonutils
+const ADDITIONAL_FUNCTIONS = {
+    listDatabases: 'listDatabases',
+    listTables: 'listTables',
+    getTableIndexes: 'getTableIndexes'
+};
+
+/**
+ * Checks if a function name is a valid cocodb function
+ * @param {string} fn - The function name to check
+ * @returns {boolean} True if the function is valid
+ */
+function isValidFunction(fn) {
+    return (fn in COCO_DB_FUNCTIONS) || (fn in ADDITIONAL_FUNCTIONS);
+}
+
 let client = null,
     cocoDBEndPointURL = null,
     cocoAuthKey = null,
@@ -34,6 +50,7 @@ function _checkActivityForHibernation() {
         return;
     }
     if(!client || client.hibernating
+        || client.userClosedConnection
         || !client.connectionEstablished // cant hibernate if connection isnt already established/ is being establised
         || ID_TO_RESOLVE_REJECT_MAP.size > 0){ // if there are any pending responses, we cant hibernate
         return;
@@ -91,8 +108,18 @@ function _setupClientAndWaitForClose(connectedCb) {
             __receiveMessage(data);
         });
 
+        let terminated = false;
         function _connectionTerminated(reason) {
+            if (terminated) {
+                return;
+            }
+            terminated = true;
+
             console.log(reason);
+            // not set bufferRequests = true for unexpected failures.
+            // Real connection failures → reject immediately, don't buffer
+            // Hibernation → buffer and reconnect transparently
+
             client.connectionEstablished = false;
             for (let [sequenceNumber, handler] of ID_TO_RESOLVE_REJECT_MAP) {
                 handler.reject(reason);
@@ -100,11 +127,20 @@ function _setupClientAndWaitForClose(connectedCb) {
             }
             resolve();
         }
-        client.on('close', function () {
-            // https://websockets.spec.whatwg.org/#eventdef-websocket-error
-            // https://stackoverflow.com/questions/40084398/is-onclose-always-called-after-onerror-for-websocket
-            // we do not need to listen for error event as an error event is immediately followed by a close event.
-            _connectionTerminated('connection closed');
+
+        client.on('error', function (err) {
+            // ECONNREFUSED, ENOTFOUND, TLS errors, etc. can land here
+            _connectionTerminated(err);
+        });
+
+        client.on('close', function (code, reasonBuf) {
+            // reasonBuf may be a Buffer in ws; keep it simple
+            _connectionTerminated(`connection closed (${code})`);
+        });
+
+        // Optional but useful: HTTP-level failures (proxies, 401, 403, 502...)
+        client.on('unexpected-response', function (req, res) {
+            _connectionTerminated(`unexpected-response: ${res.statusCode}`);
         });
     });
 }
@@ -131,13 +167,14 @@ function _cancelBackoffTimer() {
     }
 }
 
-async function _setupAndMaintainConnection(firstConnectionCb, neverConnectedCB) {
+async function _setupAndMaintainConnection(resolveOnFirstConnect, reject) {
     backoffTimer = null;
     function connected() {
         _resetBackoffTime();
-        if(firstConnectionCb){
-            firstConnectionCb("connected");
-            firstConnectionCb = null;
+        if(resolveOnFirstConnect){
+            resolveOnFirstConnect("connected");
+            resolveOnFirstConnect = null;
+            reject = null;
             // setup hibernate timer on first connection
             activityInHibernateInterval = 1;
             hibernateTimer = setInterval(_checkActivityForHibernation, INACTIVITY_TIME_FOR_HIBERNATE);
@@ -160,8 +197,8 @@ async function _setupAndMaintainConnection(firstConnectionCb, neverConnectedCB)
     client && client.userClosedConnectionCB && client.userClosedConnectionCB();
     client = cocoDBEndPointURL = cocoAuthKey = null;
     id = 0;
-    if(neverConnectedCB){
-        neverConnectedCB(new Error("user Cancelled"));
+    if(reject){
+        reject(new Error("user Cancelled"));
     }
 }
 
@@ -219,7 +256,7 @@ export function close() {
         currentClient.userClosedConnection = true;
         currentClient.userClosedConnectionCB = function () {
             for(let entry of pendingSendMessages){
-                entry.reject();
+                entry.reject(new Error('Connection closed'));
             }
             pendingSendMessages = [];
             resolve();
@@ -239,7 +276,7 @@ export function close() {
  * @returns {string} A function that increments the id variable and returns the new value as a hexadecimal string.
  */
 function getId() {
-    id++;
+    id++; // Will take about 300 years to run out at 1 million sustained tps to db with Number.MAX_SAFE_INTEGER
     return id.toString(16);
 }
 
@@ -256,7 +293,7 @@ function _sendMessage(message, resolve, reject) {
         reject('Please provide valid Object');
         return;
     }
-    if (!isString(message.fn) || !(message.fn in COCO_DB_FUNCTIONS)) {
+    if (!isString(message.fn) || !isValidFunction(message.fn)) {
         reject('please provide valid function name');
         return;
     }
@@ -284,7 +321,7 @@ function _sendPendingMessages() {
  */
 export function sendMessage(message) {
     // make a copy as the user may start modifying the object while we are sending it.
-    message = structuredClone(message);
+    message = JSON.parse(JSON.stringify(message)); // faster than structured clone for most cases
     return new Promise(function (resolve, reject) {
         if(bufferRequests){
             if(pendingSendMessages.length > MAX_PENDING_SEND_BUFFER_SIZE){