@veltdev/react 1.0.68 → 1.0.70

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

@@ -1,7 +1,8 @@
+import { RecorderElement } from "@veltdev/types";
 /**
  * @beta This hook is in beta
  */
-export declare function useRecorderUtils(): any | undefined;
+export declare function useRecorderUtils(): RecorderElement | undefined;
 /**
  * @beta This hook is in beta
  */

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

@@ -1,4 +1,5 @@
+import { RewriterElement } from "@veltdev/types";
 /**
  * @beta This hook is in beta
  */
-export declare function useAIRewriterUtils(): any | undefined;
+export declare function useAIRewriterUtils(): RewriterElement | undefined;

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

@@ -1,4 +1,5 @@
+import { SelectionElement } from "@veltdev/types";
 /**
  * @beta This hook is in beta
  */
-export declare function useLiveSelectionUtils(): any | undefined;
+export declare function useLiveSelectionUtils(): SelectionElement | undefined;

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

@@ -1,9 +1,9 @@
-import { Location } from "@veltdev/types";
+import { Location, TagAnnotation, TagElement } from "@veltdev/types";
 /**
  * @beta This hook is in beta
  */
-export declare function useTagUtils(): any | undefined;
+export declare function useTagUtils(): TagElement | undefined;
 /**
  * @beta This hook is in beta
  */
-export declare function useTagAnnotations(documentId?: string, location?: Location): any;
+export declare function useTagAnnotations(documentId?: string, location?: Location): TagAnnotation[] | null;

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

@@ -2,7 +2,7 @@ export { useAddLocation, useSetLocation, useSetDocumentId, useIdentify, useClien
 export { useCommentUtils, useCommentAnnotations, useCommentAddHandler, useCommentModeState, useCommentUpdateHandler, useCommentDialogSidebarClickHandler, } from './CommentElement';
 export { useCursorUtils, useCursorUsers, } from './CursorElement';
 export { useHuddleUtils, } from './HuddleElement';
-export { useLiveStateSyncUtils, useLiveStateData, useSetLiveStateData, useUserEditorState, useEditor, useEditorAccessRequestHandler, } from './LiveStateSyncElement';
+export { useLiveStateSyncUtils, useLiveStateData, useSetLiveStateData, useUserEditorState, useEditor, useEditorAccessRequestHandler, useLiveState, } from './LiveStateSyncElement';
 export { usePresenceUtils, usePresenceUsers, } from './PresenceElement';
 export { useRecorderUtils, useRecorderAddHandler, } from './RecorderElement';
 export { useAIRewriterUtils, } from './RewriterElement';

package/esm/index.js

@@ -86,7 +86,7 @@ var loadVelt = function (callback, version, staging) {
     }
 };
 
-var VELT_SDK_VERSION = '1.0.83';
+var VELT_SDK_VERSION = '1.0.87';
 
 var SnippylyProvider = function (props) {
     var apiKey = props.apiKey, user = props.user, config = props.config, documentId = props.documentId, language = props.language, translations = props.translations, autoTranslation = props.autoTranslation, onClientLoad = props.onClientLoad, children = props.children;
@@ -585,7 +585,7 @@ function useCursorUtils() {
  */
 function useCursorUsers() {
     var cursorElement = useCursorUtils();
-    var _a = React.useState(), data = _a[0], setData = _a[1];
+    var _a = React.useState(null), data = _a[0], setData = _a[1];
     useEffect(function () {
         if (!cursorElement)
             return;
@@ -662,7 +662,7 @@ function useSetLiveStateData(liveStateDataId, liveStateData) {
  */
 function useUserEditorState() {
     var liveStateSyncElement = useLiveStateSyncUtils();
-    var _a = React.useState(), data = _a[0], setData = _a[1];
+    var _a = React.useState(null), data = _a[0], setData = _a[1];
     useEffect(function () {
         if (!(liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isUserEditor))
             return;
@@ -680,7 +680,7 @@ function useUserEditorState() {
  */
 function useEditor() {
     var liveStateSyncElement = useLiveStateSyncUtils();
-    var _a = React.useState(), data = _a[0], setData = _a[1];
+    var _a = React.useState(null), data = _a[0], setData = _a[1];
     useEffect(function () {
         if (!(liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.getEditor))
             return;
@@ -698,7 +698,7 @@ function useEditor() {
  */
 function useEditorAccessRequestHandler() {
     var liveStateSyncElement = useLiveStateSyncUtils();
-    var _a = React.useState(), data = _a[0], setData = _a[1];
+    var _a = React.useState(null), data = _a[0], setData = _a[1];
     useEffect(function () {
         if (!(liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isEditorAccessRequested))
             return;
@@ -711,6 +711,50 @@ function useEditorAccessRequestHandler() {
     }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isEditorAccessRequested]);
     return data;
 }
+/**
+ * @beta This hook is in beta
+ */
+function useLiveState(liveStateDataId, initialValue, debounceTime) {
+    if (debounceTime === void 0) { debounceTime = 50; }
+    var liveStateSyncElement = useLiveStateSyncUtils();
+    var _a = React.useState(initialValue), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.getLiveStateData))
+            return;
+        var subscription = liveStateSyncElement.getLiveStateData(liveStateDataId).subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.getLiveStateData]);
+    var useDebounce = function (callback) {
+        var callbackRef = useRef(callback);
+        var timerRef = useRef(null);
+        useEffect(function () {
+            callbackRef.current = callback;
+        });
+        var debounce = function (value, delay) {
+            if (timerRef.current) {
+                clearTimeout(timerRef.current);
+            }
+            timerRef.current = setTimeout(function () {
+                callbackRef.current(value);
+            }, delay);
+        };
+        return debounce;
+    };
+    var setDataFunction = function (value) {
+        setData(value);
+        debouncedOnInput(value, debounceTime); // default 50ms debounce time
+    };
+    var debouncedOnInput = useDebounce(function (value) {
+        if (liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.setLiveStateData) {
+            liveStateSyncElement.setLiveStateData(liveStateDataId, value);
+        }
+    });
+    return [data, setDataFunction];
+}
 
 /**
  * @beta This hook is in beta
@@ -731,7 +775,7 @@ function usePresenceUtils() {
  */
 function usePresenceUsers() {
     var presenceElement = usePresenceUtils();
-    var _a = React.useState(), data = _a[0], setData = _a[1];
+    var _a = React.useState(null), data = _a[0], setData = _a[1];
     useEffect(function () {
         if (!presenceElement)
             return;
@@ -827,7 +871,7 @@ function useTagUtils() {
  */
 function useTagAnnotations(documentId, location) {
     var tagElement = useTagUtils();
-    var _a = React.useState(), data = _a[0], setData = _a[1];
+    var _a = React.useState(null), data = _a[0], setData = _a[1];
     useEffect(function () {
         if (!tagElement)
             return;
@@ -841,5 +885,5 @@ function useTagAnnotations(documentId, location) {
     return data;
 }
 
-export { SnippylyArrowTool as VeltArrowTool, SnippylyArrows as VeltArrows, SnippylyCommentBubble as VeltCommentBubble, VeltCommentPlayerTimeline, SnippylyCommentTool as VeltCommentTool, SnippylyComments as VeltComments, SnippylyCommentsSidebar as VeltCommentsSidebar, SnippylyCursor as VeltCursor, SnippylyHuddle as VeltHuddle, SnippylyHuddleTool as VeltHuddleTool, SnippylyPresence as VeltPresence, SnippylyProvider as VeltProvider, SnippylyRecorderControlPanel as VeltRecorderControlPanel, SnippylyRecorderNotes as VeltRecorderNotes, SnippylyRecorderPlayer as VeltRecorderPlayer, SnippylyRecorderTool as VeltRecorderTool, SnippylySidebarButton as VeltSidebarButton, SnippylyTagTool as VeltTagTool, SnippylyTags as VeltTags, SnippylyUserInviteTool as VeltUserInviteTool, SnippylyUserRequestTool as VeltUserRequestTool, VeltVideoPlayer, useAIRewriterUtils, useAddLocation, useClient, useCommentAddHandler, useCommentAnnotations, useCommentDialogSidebarClickHandler, useCommentModeState, useCommentUpdateHandler, useCommentUtils, useCursorUsers, useCursorUtils, useEditor, useEditorAccessRequestHandler, useHuddleUtils, useIdentify, useLiveSelectionUtils, useLiveStateData, useLiveStateSyncUtils, usePresenceUsers, usePresenceUtils, useRecorderAddHandler, useRecorderUtils, useSetDocumentId, useSetLiveStateData, useSetLocation, useTagAnnotations, useTagUtils, useUserEditorState, useVeltClient };
+export { SnippylyArrowTool as VeltArrowTool, SnippylyArrows as VeltArrows, SnippylyCommentBubble as VeltCommentBubble, VeltCommentPlayerTimeline, SnippylyCommentTool as VeltCommentTool, SnippylyComments as VeltComments, SnippylyCommentsSidebar as VeltCommentsSidebar, SnippylyCursor as VeltCursor, SnippylyHuddle as VeltHuddle, SnippylyHuddleTool as VeltHuddleTool, SnippylyPresence as VeltPresence, SnippylyProvider as VeltProvider, SnippylyRecorderControlPanel as VeltRecorderControlPanel, SnippylyRecorderNotes as VeltRecorderNotes, SnippylyRecorderPlayer as VeltRecorderPlayer, SnippylyRecorderTool as VeltRecorderTool, SnippylySidebarButton as VeltSidebarButton, SnippylyTagTool as VeltTagTool, SnippylyTags as VeltTags, SnippylyUserInviteTool as VeltUserInviteTool, SnippylyUserRequestTool as VeltUserRequestTool, VeltVideoPlayer, useAIRewriterUtils, useAddLocation, useClient, useCommentAddHandler, useCommentAnnotations, useCommentDialogSidebarClickHandler, useCommentModeState, useCommentUpdateHandler, useCommentUtils, useCursorUsers, useCursorUtils, useEditor, useEditorAccessRequestHandler, useHuddleUtils, useIdentify, useLiveSelectionUtils, useLiveState, useLiveStateData, useLiveStateSyncUtils, usePresenceUsers, usePresenceUtils, useRecorderAddHandler, useRecorderUtils, useSetDocumentId, useSetLiveStateData, useSetLocation, useTagAnnotations, useTagUtils, useUserEditorState, useVeltClient };
 //# sourceMappingURL=index.js.map