@veltdev/react 3.0.37 → 3.0.38

package/cjs/types/constants.d.ts

@@ -1,3 +1,3 @@
-export declare const VELT_SDK_VERSION = "3.0.37";
+export declare const VELT_SDK_VERSION = "3.0.38";
 export declare const VELT_SDK_INIT_EVENT = "onVeltInit";
 export declare const VELT_TAB_ID = "veltTabId";

package/cjs/types/hooks/ContactElement.d.ts

@@ -1,3 +1,3 @@
-import { ContactElement, UserContactSelectedPayload } from "@veltdev/types";
+import { ContactElement, SelectedUserContact } from "@veltdev/types";
 export declare function useContactUtils(): ContactElement | undefined;
-export declare function useContactSelected(): UserContactSelectedPayload | undefined;
+export declare function useContactSelected(): SelectedUserContact | undefined;

package/esm/index.js

@@ -132,7 +132,7 @@ var loadVelt = function (callback, version, staging, develop, proxyDomain) {
     }
 };
 
-var VELT_SDK_VERSION = '3.0.37';
+var VELT_SDK_VERSION = '3.0.38';
 var VELT_SDK_INIT_EVENT = 'onVeltInit';
 var VELT_TAB_ID = 'veltTabId';
 
@@ -3418,21 +3418,40 @@ function useClient() {
 }
 function useIdentify(user, userOptions) {
     var client = useVeltClient().client;
+    // Memoize the identify call
+    var shouldIdentify = React.useMemo(function () {
+        return { user: user, userOptions: userOptions };
+    }, [JSON.stringify(user), JSON.stringify(userOptions)]);
     React.useEffect(function () {
-        client && client.identify(user, userOptions);
-    }, [client]);
+        if (client) {
+            client.identify(shouldIdentify.user, shouldIdentify.userOptions);
+        }
+    }, [client, shouldIdentify]);
 }
 function useSetDocument(documentId, documentMetadata) {
     var client = useVeltClient().client;
+    // Memoize the setDocument call
+    var shouldSetDocument = React.useMemo(function () {
+        return {
+            documentId: documentId,
+            documentMetadata: documentMetadata
+        };
+    }, [documentId, JSON.stringify(documentMetadata)]);
     React.useEffect(function () {
-        client && client.setDocument(documentId, documentMetadata);
-    }, [client]);
+        if (client) {
+            client.setDocument(shouldSetDocument.documentId, shouldSetDocument.documentMetadata);
+        }
+    }, [client, shouldSetDocument]);
 }
 function useSetDocumentId(documentId) {
     var client = useVeltClient().client;
+    // Memoize the documentId
+    var memoizedDocumentId = React.useMemo(function () { return documentId; }, [documentId]);
     React.useEffect(function () {
-        client && client.setDocumentId(documentId);
-    }, [client]);
+        if (client) {
+            client.setDocumentId(memoizedDocumentId);
+        }
+    }, [client, memoizedDocumentId]);
 }
 function useUnsetDocumentId() {
     var client = useVeltClient().client;
@@ -3442,9 +3461,15 @@ function useUnsetDocumentId() {
 }
 function useSetLocation(location, appendLocation) {
     var client = useVeltClient().client;
+    // Memoize the setLocation call
+    var shouldSetLocation = React.useMemo(function () {
+        return { location: location, appendLocation: appendLocation };
+    }, [JSON.stringify(location), appendLocation]);
     React.useEffect(function () {
-        client && client.setLocation(location, appendLocation);
-    }, [client]);
+        if (client) {
+            client.setLocation(shouldSetLocation.location, shouldSetLocation.appendLocation);
+        }
+    }, [client, shouldSetLocation]);
 }
 function useVeltInitState() {
     var client = useVeltClient().client;
@@ -3476,31 +3501,59 @@ function useCommentUtils() {
 function useCommentAnnotations(documentId, location) {
     var commentElement = useCommentUtils();
     var _a = React.useState(undefined), data = _a[0], setData = _a[1];
+    var subscriptionRef = React.useRef();
+    // Memoize the inputs
+    var inputs = React.useMemo(function () {
+        return { documentId: documentId, location: location };
+    }, [documentId, JSON.stringify(location)]);
     useEffect(function () {
         if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.getAllCommentAnnotations))
             return;
-        var subscription = commentElement.getAllCommentAnnotations(documentId, location).subscribe(function (res) {
+        // Unsubscribe from the previous subscription if it exists
+        if (subscriptionRef.current) {
+            subscriptionRef.current.unsubscribe();
+        }
+        var subscription = commentElement.getAllCommentAnnotations(inputs.documentId, inputs.location)
+            .subscribe(function (res) {
             setData(res);
         });
+        // Store the new subscription
+        subscriptionRef.current = subscription;
+        // Cleanup function
         return function () {
-            subscription.unsubscribe();
+            if (subscriptionRef.current) {
+                subscriptionRef.current.unsubscribe();
+            }
         };
-    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getAllCommentAnnotations]);
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getAllCommentAnnotations, inputs]);
     return data;
 }
 function useUnreadCommentCountByAnnotationId(annotationId) {
     var commentElement = useCommentUtils();
     var _a = React.useState({ count: 0 }), data = _a[0], setData = _a[1];
+    var subscriptionRef = React.useRef();
+    // Memoize the input
+    var memoizedAnnotationId = React.useMemo(function () { return annotationId; }, [annotationId]);
     useEffect(function () {
         if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentCountByAnnotationId))
             return;
-        var subscription = commentElement.getUnreadCommentCountByAnnotationId(annotationId).subscribe(function (res) {
+        // Unsubscribe from the previous subscription if it exists
+        if (subscriptionRef.current) {
+            subscriptionRef.current.unsubscribe();
+        }
+        var subscription = commentElement.getUnreadCommentCountByAnnotationId(memoizedAnnotationId)
+            .subscribe(function (res) {
             setData(res);
         });
+        // Store the new subscription
+        subscriptionRef.current = subscription;
+        // Cleanup function
         return function () {
-            subscription.unsubscribe();
+            if (subscriptionRef.current) {
+                subscriptionRef.current.unsubscribe();
+            }
         };
-    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentCountByAnnotationId]);
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentCountByAnnotationId, memoizedAnnotationId]);
     return data;
 }
 function useUnreadCommentAnnotationCountOnCurrentDocument() {
@@ -3536,31 +3589,57 @@ function useUnreadCommentCountOnCurrentDocument() {
 function useUnreadCommentCountByLocationId(locationId) {
     var commentElement = useCommentUtils();
     var _a = React.useState({ count: 0 }), data = _a[0], setData = _a[1];
+    var subscriptionRef = React.useRef();
+    // Memoize the input
+    var memoizedLocationId = React.useMemo(function () { return locationId; }, [locationId]);
     useEffect(function () {
         if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentCountByLocationId))
             return;
-        var subscription = commentElement.getUnreadCommentCountByLocationId(locationId).subscribe(function (res) {
+        // Unsubscribe from the previous subscription if it exists
+        if (subscriptionRef.current) {
+            subscriptionRef.current.unsubscribe();
+        }
+        var subscription = commentElement.getUnreadCommentCountByLocationId(memoizedLocationId)
+            .subscribe(function (res) {
             setData(res);
         });
+        // Store the new subscription
+        subscriptionRef.current = subscription;
+        // Cleanup function
         return function () {
-            subscription.unsubscribe();
+            if (subscriptionRef.current) {
+                subscriptionRef.current.unsubscribe();
+            }
         };
-    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentCountByLocationId]);
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentCountByLocationId, memoizedLocationId]);
     return data;
 }
 function useUnreadCommentAnnotationCountByLocationId(locationId) {
     var commentElement = useCommentUtils();
     var _a = React.useState({ count: 0 }), data = _a[0], setData = _a[1];
+    var subscriptionRef = React.useRef();
+    // Memoize the input
+    var memoizedLocationId = React.useMemo(function () { return locationId; }, [locationId]);
     useEffect(function () {
         if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentAnnotationCountByLocationId))
             return;
-        var subscription = commentElement.getUnreadCommentAnnotationCountByLocationId(locationId).subscribe(function (res) {
+        // Unsubscribe from the previous subscription if it exists
+        if (subscriptionRef.current) {
+            subscriptionRef.current.unsubscribe();
+        }
+        var subscription = commentElement.getUnreadCommentAnnotationCountByLocationId(memoizedLocationId)
+            .subscribe(function (res) {
             setData(res);
         });
+        // Store the new subscription
+        subscriptionRef.current = subscription;
+        // Cleanup function
         return function () {
-            subscription.unsubscribe();
+            if (subscriptionRef.current) {
+                subscriptionRef.current.unsubscribe();
+            }
         };
-    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentAnnotationCountByLocationId]);
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getUnreadCommentAnnotationCountByLocationId, memoizedLocationId]);
     return data;
 }
 function useCommentModeState() {
@@ -3658,16 +3737,29 @@ function useCommentCopyLinkHandler() {
 function useCommentAnnotationById(config) {
     var commentElement = useCommentUtils();
     var _a = React.useState(undefined), data = _a[0], setData = _a[1];
+    var subscriptionRef = React.useRef();
+    // Memoize the input
+    var memoizedConfig = React.useMemo(function () { return config; }, [config.annotationId, config.documentId]);
     useEffect(function () {
         if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.getCommentAnnotationById))
             return;
-        var subscription = commentElement.getCommentAnnotationById(config).subscribe(function (res) {
+        // Unsubscribe from the previous subscription if it exists
+        if (subscriptionRef.current) {
+            subscriptionRef.current.unsubscribe();
+        }
+        var subscription = commentElement.getCommentAnnotationById(memoizedConfig)
+            .subscribe(function (res) {
             setData(res);
         });
+        // Store the new subscription
+        subscriptionRef.current = subscription;
+        // Cleanup function
         return function () {
-            subscription.unsubscribe();
+            if (subscriptionRef.current) {
+                subscriptionRef.current.unsubscribe();
+            }
         };
-    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getCommentAnnotationById]);
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getCommentAnnotationById, memoizedConfig]);
     return data;
 }
 function useCommentSidebarActionButtonClick() {