jsgar 4.1.0 → 4.3.1

package/dist/gar.umd.js

@@ -123,6 +123,7 @@
         /**
          * Reset all connection-related state:
          * server/client topic/key mappings, counters, grace flags, and records.
+         * Note: Clients must call this to safely reconnect before running start() on a separate thread
          */
         clearConnectionState() {
             // Server assigned topic/key <-> name mappings
@@ -155,9 +156,6 @@
          * @param {number} [openTimeout=20] - Connection timeout in seconds
          */
         async connect(openTimeout = 20) {
-            // Before attempting a new connection, clear any previous state
-            this.clearConnectionState();
-
             let scaledOpenTimeout = openTimeout * this.timeoutScale;
 
             while (this.running && !this.connected) {
@@ -521,6 +519,9 @@
          * Start the client and send introduction message.
          */
         start() {
+            // Before attempting a new connection, clear any previous state
+            this.clearConnectionState();
+
             this.running = true;
             const introMsg = {
                 message_type: 'Introduction',
@@ -916,7 +917,8 @@
          * @param {string|null} [excludeKeyFilter=null] - Exclude key filter regex (cannot use with keyName)
          * @param {string|null} [excludeTopicFilter=null] - Exclude topic filter regex (cannot use with topicName)
          * @param {string|null} [maxHistory] - Maximum history to include
-         * @param {boolean} [includeDerived=false] - Include derived topics
+         * @param {boolean} [excludeDerived=false] - Exclude derived topics (derived topics are included by default)
+         * @param {boolean} [includeHeavy=false] - Include heavy derived topics (comprehensions, array-typed, heavy functions)
          * @param {boolean} [trimDefaultValues=false] - Trim records containing default values from the snapshot
          * @param {string|null} [workingNamespace] - Namespace for matching relative paths
          * @param {string|Array<string>|null} [restrictNamespace] - Restricts topics and keys to children of these namespaces (union). Defaults to the working namespace. Use ["::"] for root / no restriction.
@@ -940,7 +942,8 @@
             excludeKeyFilter = null,
             excludeTopicFilter = null,
             maxHistory = null,
-            includeDerived = false,
+            excludeDerived = false,
+            includeHeavy = false,
             trimDefaultValues = false,
             workingNamespace = null,
             restrictNamespace = null,
@@ -1028,8 +1031,11 @@
             if (density) {
                 valueDict.density = density;
             }
-            if (includeDerived) {
-                valueDict.include_derived = includeDerived;
+            if (excludeDerived) {
+                valueDict.exclude_derived = excludeDerived;
+            }
+            if (includeHeavy) {
+                valueDict.include_heavy = includeHeavy;
             }
             if (restrictNamespace) {
                 valueDict.restrict_namespace = typeof restrictNamespace === 'string' ? [restrictNamespace] : restrictNamespace;
@@ -1114,6 +1120,8 @@
                 null,
                 false,
                 false,
+                false,
+                null,
                 null,
                 null,
                 null,
@@ -1306,7 +1314,7 @@
          * @param {string|null} [workingNamespace]
          * @param {string|Array<string>|null} [restrictNamespace]
          * @param {string|Array<string>|null} [excludeNamespace]
-         * @param {boolean} [includeDerived=false]
+         * @param {boolean} [excludeDerived=false]
          * @param {number} [timeout=10.0] seconds
          * @param {number} [subscriptionGroupServerKeys=650704]
          * @param {number} [subscriptionGroupServerRecords=650705]
@@ -1324,7 +1332,7 @@
             workingNamespace = null,
             restrictNamespace = null,
             excludeNamespace = null,
-            includeDerived = false,
+            excludeDerived = false,
             timeout = 10.0,
             subscriptionGroupServerKeys = 650704,
             subscriptionGroupServerRecords = 650705,
@@ -1346,7 +1354,7 @@
             if (excludeKeyFilter != null) recordFilter.exclude_key_filter_regex = excludeKeyFilter;
             if (topicFilter != null) recordFilter.topic_filter_regex = topicFilter;
             if (excludeTopicFilter != null) recordFilter.exclude_topic_filter_regex = excludeTopicFilter;
-            if (includeDerived) recordFilter.include_derived = includeDerived;
+            if (excludeDerived) recordFilter.exclude_derived = excludeDerived;
             if (Array.isArray(historyTypes)) recordFilter.history_types = historyTypes;
 
             const resultContainer = { };
@@ -1404,11 +1412,13 @@
                         null,
                         null,
                         null,
-                        true,
+                        false,
+                        false,
                         false,
                         'g::deployment::Server',
                         null,
                         null,
+                        null,
                         subscriptionGroupServerRecords,
                     );
                 };
@@ -1452,11 +1462,13 @@
                     null,
                     null,
                     null,
-                    true,
+                    false,
+                    false,
                     false,
                     'g::deployment::RecordFilter',
                     null,
                     null,
+                    null,
                     subscriptionGroupServerKeys,
                 );
 

package/gar.js

@@ -117,6 +117,7 @@ class GARClient {
     /**
      * Reset all connection-related state:
      * server/client topic/key mappings, counters, grace flags, and records.
+     * Note: Clients must call this to safely reconnect before running start() on a separate thread
      */
     clearConnectionState() {
         // Server assigned topic/key <-> name mappings
@@ -149,9 +150,6 @@ class GARClient {
      * @param {number} [openTimeout=20] - Connection timeout in seconds
      */
     async connect(openTimeout = 20) {
-        // Before attempting a new connection, clear any previous state
-        this.clearConnectionState();
-
         let scaledOpenTimeout = openTimeout * this.timeoutScale;
 
         while (this.running && !this.connected) {
@@ -515,6 +513,9 @@ class GARClient {
      * Start the client and send introduction message.
      */
     start() {
+        // Before attempting a new connection, clear any previous state
+        this.clearConnectionState();
+
         this.running = true;
         const introMsg = {
             message_type: 'Introduction',
@@ -910,7 +911,8 @@ class GARClient {
      * @param {string|null} [excludeKeyFilter=null] - Exclude key filter regex (cannot use with keyName)
      * @param {string|null} [excludeTopicFilter=null] - Exclude topic filter regex (cannot use with topicName)
      * @param {string|null} [maxHistory] - Maximum history to include
-     * @param {boolean} [includeDerived=false] - Include derived topics
+     * @param {boolean} [excludeDerived=false] - Exclude derived topics (derived topics are included by default)
+     * @param {boolean} [includeHeavy=false] - Include heavy derived topics (comprehensions, array-typed, heavy functions)
      * @param {boolean} [trimDefaultValues=false] - Trim records containing default values from the snapshot
      * @param {string|null} [workingNamespace] - Namespace for matching relative paths
      * @param {string|Array<string>|null} [restrictNamespace] - Restricts topics and keys to children of these namespaces (union). Defaults to the working namespace. Use ["::"] for root / no restriction.
@@ -934,7 +936,8 @@ class GARClient {
         excludeKeyFilter = null,
         excludeTopicFilter = null,
         maxHistory = null,
-        includeDerived = false,
+        excludeDerived = false,
+        includeHeavy = false,
         trimDefaultValues = false,
         workingNamespace = null,
         restrictNamespace = null,
@@ -1022,8 +1025,11 @@ class GARClient {
         if (density) {
             valueDict.density = density;
         }
-        if (includeDerived) {
-            valueDict.include_derived = includeDerived;
+        if (excludeDerived) {
+            valueDict.exclude_derived = excludeDerived;
+        }
+        if (includeHeavy) {
+            valueDict.include_heavy = includeHeavy;
         }
         if (restrictNamespace) {
             valueDict.restrict_namespace = typeof restrictNamespace === 'string' ? [restrictNamespace] : restrictNamespace;
@@ -1108,6 +1114,8 @@ class GARClient {
             null,
             false,
             false,
+            false,
+            null,
             null,
             null,
             null,
@@ -1300,7 +1308,7 @@ class GARClient {
      * @param {string|null} [workingNamespace]
      * @param {string|Array<string>|null} [restrictNamespace]
      * @param {string|Array<string>|null} [excludeNamespace]
-     * @param {boolean} [includeDerived=false]
+     * @param {boolean} [excludeDerived=false]
      * @param {number} [timeout=10.0] seconds
      * @param {number} [subscriptionGroupServerKeys=650704]
      * @param {number} [subscriptionGroupServerRecords=650705]
@@ -1318,7 +1326,7 @@ class GARClient {
         workingNamespace = null,
         restrictNamespace = null,
         excludeNamespace = null,
-        includeDerived = false,
+        excludeDerived = false,
         timeout = 10.0,
         subscriptionGroupServerKeys = 650704,
         subscriptionGroupServerRecords = 650705,
@@ -1340,7 +1348,7 @@ class GARClient {
         if (excludeKeyFilter != null) recordFilter.exclude_key_filter_regex = excludeKeyFilter;
         if (topicFilter != null) recordFilter.topic_filter_regex = topicFilter;
         if (excludeTopicFilter != null) recordFilter.exclude_topic_filter_regex = excludeTopicFilter;
-        if (includeDerived) recordFilter.include_derived = includeDerived;
+        if (excludeDerived) recordFilter.exclude_derived = excludeDerived;
         if (Array.isArray(historyTypes)) recordFilter.history_types = historyTypes;
 
         const resultContainer = { };
@@ -1398,11 +1406,13 @@ class GARClient {
                     null,
                     null,
                     null,
-                    true,
+                    false,
+                    false,
                     false,
                     'g::deployment::Server',
                     null,
                     null,
+                    null,
                     subscriptionGroupServerRecords,
                 );
             };
@@ -1446,11 +1456,13 @@ class GARClient {
                 null,
                 null,
                 null,
-                true,
+                false,
+                false,
                 false,
                 'g::deployment::RecordFilter',
                 null,
                 null,
+                null,
                 subscriptionGroupServerKeys,
             );
 

package/package.json

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