jsgar 4.6.2 → 4.8.0

package/dist/gar.umd.js

@@ -193,8 +193,9 @@
          * @param {string} [logLevel='INFO'] - Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
          * @param {boolean} [uniqueKeyAndRecordUpdates=false] - Only one update per key/record
          * @param {string} [token=null] - Token for authenticated connections (appended as ?token= query param)
+         * @param {boolean} [logEveryMessage=false] - If true, log every message sent and received at INFO level.
          */
-        constructor(wsEndpoint, user, working_namespace = null, heartbeatTimeoutInterval = 60000, allowSelfSignedCertificate = false, logLevel = 'INFO', uniqueKeyAndRecordUpdates = false, token = null) {
+        constructor(wsEndpoint, user, working_namespace = null, heartbeatTimeoutInterval = 60000, allowSelfSignedCertificate = false, logLevel = 'INFO', uniqueKeyAndRecordUpdates = false, token = null, logEveryMessage = false) {
             this.wsEndpoint = token ? `${wsEndpoint}${wsEndpoint.includes('?') ? '&' : '?'}token=${token}` : wsEndpoint;
             this.websocket = null;
             this.messageQueue = [];
@@ -208,6 +209,7 @@
                 this.scaledHeartbeatTimeoutInterval *= this.timeoutScale;
             }
             this.unique_key_and_record_updates = uniqueKeyAndRecordUpdates;
+            this.logEveryMessage = logEveryMessage;
             this.version = 650709;
             this.uuid = GARClient._generateUUID();
 
@@ -440,7 +442,9 @@
                     if (message === null) break;
                     if (this._isSocketOpen()) {
                         this.websocket.send(JSON.stringify(message));
-                        this.log('DEBUG', `Sent: ${JSON.stringify(message)}`);
+                        if (this.logEveryMessage) {
+                            this.log('INFO', `Sent: ${JSON.stringify(message)}`);
+                        }
                     }
                 } catch (e) {
                     this.log('WARNING', `Error sending message: ${e.message}`);
@@ -915,6 +919,9 @@
          * @param {Object} message - Incoming message
          */
         _processMessage(message) {
+            if (this.logEveryMessage) {
+                this.log('INFO', `Received: ${JSON.stringify(message)}`);
+            }
             const msgType = message.message_type;
             let subscriptionGroup = 0;
             if (msgType === 'TopicIntroduction') {
@@ -1324,13 +1331,29 @@
          * @param {boolean} [options.skipOwnershipChecks=false] - Bypass ownership validation.
          * @param {boolean} [options.requireExisting=false] - Only write to existing keys; do not create new keys.
          * @param {number} [options.clientKeyId=0] - The g::Client key ID for ownership. 0 uses the connection key.
+         * @param {string} [options.clientKeyName=''] - If non-empty, atomically introduce this g::Client key with
+         *     the message. The server creates the key and maps the remote id in one round-trip; no separate
+         *     KeyIntroduction is sent. Ignored if the name is already mapped locally (existing id is reused).
          */
-        updateActiveOwnership({ msgRef = 0, ownershipAction = 'None', skipOwnershipChecks = false, requireExisting = false, clientKeyId = 0 } = {}) {
+        updateActiveOwnership({ msgRef = 0, ownershipAction = 'None', skipOwnershipChecks = false, requireExisting = false, clientKeyId = 0, clientKeyName = '' } = {}) {
+            if (clientKeyName) {
+                const existingId = this.localKeyMap.get(clientKeyName);
+                if (existingId !== undefined) {
+                    clientKeyId = existingId;
+                    clientKeyName = '';
+                } else {
+                    clientKeyId = this.localKeyCounter++;
+                    this.localKeyMap.set(clientKeyName, clientKeyId);
+                }
+            }
             const newOwnership = { msg_ref: msgRef, ownership_action: ownershipAction, skip_ownership_checks: skipOwnershipChecks, require_existing: requireExisting, client_key_id: clientKeyId };
             const cur = this._activeOwnership;
-            if (newOwnership.msg_ref !== cur.msg_ref || newOwnership.ownership_action !== cur.ownership_action || newOwnership.skip_ownership_checks !== cur.skip_ownership_checks || newOwnership.require_existing !== cur.require_existing || newOwnership.client_key_id !== cur.client_key_id) {
+            const changed = newOwnership.msg_ref !== cur.msg_ref || newOwnership.ownership_action !== cur.ownership_action || newOwnership.skip_ownership_checks !== cur.skip_ownership_checks || newOwnership.require_existing !== cur.require_existing || newOwnership.client_key_id !== cur.client_key_id;
+            if (changed || clientKeyName) {
                 this._activeOwnership = newOwnership;
-                this.sendMessage({ message_type: 'ActiveOwnership', value: newOwnership });
+                const value = { ...newOwnership };
+                if (clientKeyName) value.client_key_name = clientKeyName;
+                this.sendMessage({ message_type: 'ActiveOwnership', value });
             }
         }
 

package/gar.js

@@ -187,8 +187,9 @@ class GARClient {
      * @param {string} [logLevel='INFO'] - Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
      * @param {boolean} [uniqueKeyAndRecordUpdates=false] - Only one update per key/record
      * @param {string} [token=null] - Token for authenticated connections (appended as ?token= query param)
+     * @param {boolean} [logEveryMessage=false] - If true, log every message sent and received at INFO level.
      */
-    constructor(wsEndpoint, user, working_namespace = null, heartbeatTimeoutInterval = 60000, allowSelfSignedCertificate = false, logLevel = 'INFO', uniqueKeyAndRecordUpdates = false, token = null) {
+    constructor(wsEndpoint, user, working_namespace = null, heartbeatTimeoutInterval = 60000, allowSelfSignedCertificate = false, logLevel = 'INFO', uniqueKeyAndRecordUpdates = false, token = null, logEveryMessage = false) {
         this.wsEndpoint = token ? `${wsEndpoint}${wsEndpoint.includes('?') ? '&' : '?'}token=${token}` : wsEndpoint;
         this.websocket = null;
         this.messageQueue = [];
@@ -202,6 +203,7 @@ class GARClient {
             this.scaledHeartbeatTimeoutInterval *= this.timeoutScale;
         }
         this.unique_key_and_record_updates = uniqueKeyAndRecordUpdates;
+        this.logEveryMessage = logEveryMessage;
         this.version = 650709;
         this.uuid = GARClient._generateUUID();
 
@@ -434,7 +436,9 @@ class GARClient {
                 if (message === null) break;
                 if (this._isSocketOpen()) {
                     this.websocket.send(JSON.stringify(message));
-                    this.log('DEBUG', `Sent: ${JSON.stringify(message)}`);
+                    if (this.logEveryMessage) {
+                        this.log('INFO', `Sent: ${JSON.stringify(message)}`);
+                    }
                 }
             } catch (e) {
                 this.log('WARNING', `Error sending message: ${e.message}`);
@@ -909,6 +913,9 @@ class GARClient {
      * @param {Object} message - Incoming message
      */
     _processMessage(message) {
+        if (this.logEveryMessage) {
+            this.log('INFO', `Received: ${JSON.stringify(message)}`);
+        }
         const msgType = message.message_type;
         let subscriptionGroup = 0;
         if (msgType === 'TopicIntroduction') {
@@ -1318,13 +1325,29 @@ class GARClient {
      * @param {boolean} [options.skipOwnershipChecks=false] - Bypass ownership validation.
      * @param {boolean} [options.requireExisting=false] - Only write to existing keys; do not create new keys.
      * @param {number} [options.clientKeyId=0] - The g::Client key ID for ownership. 0 uses the connection key.
+     * @param {string} [options.clientKeyName=''] - If non-empty, atomically introduce this g::Client key with
+     *     the message. The server creates the key and maps the remote id in one round-trip; no separate
+     *     KeyIntroduction is sent. Ignored if the name is already mapped locally (existing id is reused).
      */
-    updateActiveOwnership({ msgRef = 0, ownershipAction = 'None', skipOwnershipChecks = false, requireExisting = false, clientKeyId = 0 } = {}) {
+    updateActiveOwnership({ msgRef = 0, ownershipAction = 'None', skipOwnershipChecks = false, requireExisting = false, clientKeyId = 0, clientKeyName = '' } = {}) {
+        if (clientKeyName) {
+            const existingId = this.localKeyMap.get(clientKeyName);
+            if (existingId !== undefined) {
+                clientKeyId = existingId;
+                clientKeyName = '';
+            } else {
+                clientKeyId = this.localKeyCounter++;
+                this.localKeyMap.set(clientKeyName, clientKeyId);
+            }
+        }
         const newOwnership = { msg_ref: msgRef, ownership_action: ownershipAction, skip_ownership_checks: skipOwnershipChecks, require_existing: requireExisting, client_key_id: clientKeyId };
         const cur = this._activeOwnership;
-        if (newOwnership.msg_ref !== cur.msg_ref || newOwnership.ownership_action !== cur.ownership_action || newOwnership.skip_ownership_checks !== cur.skip_ownership_checks || newOwnership.require_existing !== cur.require_existing || newOwnership.client_key_id !== cur.client_key_id) {
+        const changed = newOwnership.msg_ref !== cur.msg_ref || newOwnership.ownership_action !== cur.ownership_action || newOwnership.skip_ownership_checks !== cur.skip_ownership_checks || newOwnership.require_existing !== cur.require_existing || newOwnership.client_key_id !== cur.client_key_id;
+        if (changed || clientKeyName) {
             this._activeOwnership = newOwnership;
-            this.sendMessage({ message_type: 'ActiveOwnership', value: newOwnership });
+            const value = { ...newOwnership };
+            if (clientKeyName) value.client_key_name = clientKeyName;
+            this.sendMessage({ message_type: 'ActiveOwnership', value });
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsgar",
-  "version": "4.6.2",
+  "version": "4.8.0",
   "description": "A Javascript client for the GAR protocol",
   "type": "module",
   "main": "dist/gar.umd.js",