@veltdev/react 1.0.50 → 1.0.52

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

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

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

@@ -1,9 +1,10 @@
-export { useAddLocation, useGetDocumentId, useSetLocation, useSetDocumentId, useSignOutUser, useUpdateUser, useIdentify, useClient, } from './Client';
-export { useGetCommentUtils, useGetAllCommentAnnotations, useIsUserGlobalContact, useOnCommentAdd, useOnCommentModeChange, useOnCommentUpdate, useOnSidebarButtonOnCommentDialogClick, } from './CommentElement';
-export { useGetCursorUtils, useGetOnlineCursorUsersOnCurrentDocument, } from './CursorElement';
-export { useGetLiveStateSyncUtils, useGetLiveStateData, useIsUserEditor, } from './LiveStateSyncElement';
-export { useGetPresenceUtils, useGetOnlinePresenceUsersOnCurrentDocument, } from './PresenceElement';
-export { useGetRecorderUtils, useOnRecordedData, } from './RecorderElement';
-export { useGetRewriterUtils, } from './RewriterElement';
-export { useGetSelectionUtils, } from './SelectionElement';
-export { useGetTagUtils, useGetAllTagAnnotations, } from './TagElement';
+export { useAddLocation, useSetLocation, useSetDocumentId, useIdentify, useClient, } from './Client';
+export { useCommentUtils, useCommentAnnotations, useCommentAddHandler, useCommentModeState, useCommentUpdateHandler, useCommentDialogSidebarClickHandler, } from './CommentElement';
+export { useCursorUtils, useCursorUsers, } from './CursorElement';
+export { useHuddleUtils, } from './HuddleElement';
+export { useLiveStateSyncUtils, useLiveStateData, useSetLiveStateData, useUserEditorState, } from './LiveStateSyncElement';
+export { usePresenceUtils, usePresenceUsers, } from './PresenceElement';
+export { useRecorderUtils, useRecorderAddHandler, } from './RecorderElement';
+export { useAIRewriterUtils, } from './RewriterElement';
+export { useLiveSelectionUtils, } from './SelectionElement';
+export { useTagUtils, useTagAnnotations, } from './TagElement';

package/cjs/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './components';
 export * from './loadSnippyly';
 export * from './context';
+export * from './hooks';

package/esm/index.js

@@ -86,7 +86,7 @@ var loadVelt = function (callback, version, staging) {
     }
 };
 
-var VELT_SDK_VERSION = '1.0.57';
+var VELT_SDK_VERSION = '1.0.62';
 
 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;
@@ -233,7 +233,7 @@ var SnippylyComments = function (props) {
 };
 
 var SnippylyCommentsSidebar = function (props) {
-    var embedMode = props.embedMode, enableUrlNavigation = props.enableUrlNavigation, urlNavigation = props.urlNavigation, pageMode = props.pageMode, openSidebar = props.openSidebar, onSidebarOpen = props.onSidebarOpen, onSidebarCommentClick = props.onSidebarCommentClick, onCommentClick = props.onCommentClick;
+    var embedMode = props.embedMode, enableUrlNavigation = props.enableUrlNavigation, urlNavigation = props.urlNavigation, pageMode = props.pageMode, currentLocationSuffix = props.currentLocationSuffix, openSidebar = props.openSidebar, onSidebarOpen = props.onSidebarOpen, onSidebarCommentClick = props.onSidebarCommentClick, onCommentClick = props.onCommentClick;
     var ref = useRef();
     useEffect(function () {
         if (ref.current) {
@@ -256,7 +256,7 @@ var SnippylyCommentsSidebar = function (props) {
             });
         }
     }, []);
-    return (React.createElement("velt-comments-sidebar", { ref: ref, "embed-mode": [true, false].includes(embedMode) ? (embedMode ? 'true' : 'false') : undefined, "enable-url-navigation": [true, false].includes(enableUrlNavigation) ? (enableUrlNavigation ? 'true' : 'false') : undefined, "url-navigation": [true, false].includes(urlNavigation) ? (urlNavigation ? 'true' : 'false') : undefined, "page-mode": [true, false].includes(pageMode) ? (pageMode ? 'true' : 'false') : undefined }));
+    return (React.createElement("velt-comments-sidebar", { ref: ref, "embed-mode": [true, false].includes(embedMode) ? (embedMode ? 'true' : 'false') : undefined, "enable-url-navigation": [true, false].includes(enableUrlNavigation) ? (enableUrlNavigation ? 'true' : 'false') : undefined, "url-navigation": [true, false].includes(urlNavigation) ? (urlNavigation ? 'true' : 'false') : undefined, "page-mode": [true, false].includes(pageMode) ? (pageMode ? 'true' : 'false') : undefined, "current-location-suffix": [true, false].includes(currentLocationSuffix) ? (currentLocationSuffix ? 'true' : 'false') : undefined }));
 };
 
 var SnippylyCommentTool = function (props) {
@@ -393,8 +393,8 @@ var SnippylyArrowTool = function (props) {
 };
 
 var SnippylyUserInviteTool = function (props) {
-    var type = props.type, source = props.source, title = props.title, placeholder = props.placeholder, accessControlDropdown = props.accessControlDropdown;
-    return (React.createElement("velt-user-invite-tool", { type: type, source: source, title: title, placeholder: placeholder, "access-control-dropdown": [true, false].includes(accessControlDropdown) ? accessControlDropdown : undefined }));
+    var type = props.type, source = props.source, title = props.title, placeholder = props.placeholder, accessControlDropdown = props.accessControlDropdown, documentUserAccessList = props.documentUserAccessList;
+    return (React.createElement("velt-user-invite-tool", { type: type, source: source, title: title, placeholder: placeholder, "access-control-dropdown": [true, false].includes(accessControlDropdown) ? accessControlDropdown : undefined, "document-user-access-list": [true, false].includes(documentUserAccessList) ? documentUserAccessList : undefined }));
 };
 
 var SnippylyUserRequestTool = function (props) {
@@ -423,5 +423,399 @@ var VeltVideoPlayer = function (props) {
     return (React.createElement("velt-video-player", { src: src, "dark-mode": [true, false].includes(darkMode) ? (darkMode ? 'true' : 'false') : undefined, sync: [true, false].includes(sync) ? (sync ? 'true' : 'false') : undefined }));
 };
 
-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, useVeltClient };
+/**
+ * @beta This hook is in beta
+ */
+function useClient() {
+    var client = useVeltClient().client;
+    var _a = React.useState(), veltClient = _a[0], setVeltClient = _a[1];
+    React.useEffect(function () {
+        if (!client || veltClient)
+            return;
+        setVeltClient(client);
+    }, [client, setVeltClient, veltClient]);
+    return veltClient;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useIdentify(user, userOptions) {
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        client && client.identify(user, userOptions);
+    }, [client]);
+}
+/**
+ * @beta This hook is in beta
+ */
+function useSetDocumentId(documentId) {
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        client && client.setDocumentId(documentId);
+    }, [client]);
+}
+/**
+ * @beta This hook is in beta
+ */
+function useSetLocation(location) {
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        client && client.setLocation(location);
+    }, [client]);
+}
+/**
+ * @beta This hook is in beta
+ */
+function useAddLocation(location) {
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        client && client.addLocation(location);
+    }, [client]);
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useCommentUtils() {
+    var _a = React.useState(), commentElement = _a[0], setCommentElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || commentElement)
+            return;
+        var loadedCommentElement = client.getCommentElement();
+        setCommentElement(loadedCommentElement);
+    }, [client, setCommentElement, commentElement]);
+    return commentElement;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useCommentAnnotations(documentId, location) {
+    var commentElement = useCommentUtils();
+    var _a = React.useState([]), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.getAllCommentAnnotations))
+            return;
+        var subscription = commentElement.getAllCommentAnnotations(documentId, location).subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.getAllCommentAnnotations]);
+    return data;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useCommentModeState() {
+    var commentElement = useCommentUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentModeChange))
+            return;
+        var subscription = commentElement.onCommentModeChange().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentModeChange]);
+    return data;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useCommentAddHandler() {
+    var commentElement = useCommentUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentAdd))
+            return;
+        var subscription = commentElement.onCommentAdd().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentAdd]);
+    return data;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useCommentUpdateHandler() {
+    var commentElement = useCommentUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentUpdate))
+            return;
+        var subscription = commentElement.onCommentUpdate().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onCommentUpdate]);
+    return data;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useCommentDialogSidebarClickHandler() {
+    var commentElement = useCommentUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(commentElement === null || commentElement === void 0 ? void 0 : commentElement.onSidebarButtonOnCommentDialogClick))
+            return;
+        var subscription = commentElement.onSidebarButtonOnCommentDialogClick().subscribe(function (res) {
+            setData(res === undefined ? new Date().getTime() : res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [commentElement === null || commentElement === void 0 ? void 0 : commentElement.onSidebarButtonOnCommentDialogClick]);
+    return data;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useCursorUtils() {
+    var _a = React.useState(), cursorElement = _a[0], setCursorElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || cursorElement)
+            return;
+        var loadedCursorElement = client.getCursorElement();
+        setCursorElement(loadedCursorElement);
+    }, [client, setCursorElement, cursorElement]);
+    return cursorElement;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useCursorUsers() {
+    var cursorElement = useCursorUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!cursorElement)
+            return;
+        var subscription = cursorElement.getOnlineUsersOnCurrentDocument().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [cursorElement]);
+    return data;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useHuddleUtils() {
+    var _a = React.useState(), huddleElement = _a[0], setHuddleElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || huddleElement)
+            return;
+        var loadedHuddleElement = client.getHuddleElement();
+        setHuddleElement(loadedHuddleElement);
+    }, [client, setHuddleElement, huddleElement]);
+    return huddleElement;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useLiveStateSyncUtils() {
+    var _a = React.useState(), liveStateSyncElement = _a[0], setLiveStateSyncElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || liveStateSyncElement)
+            return;
+        var loadedLiveStateSyncElement = client.getLiveStateSyncElement();
+        setLiveStateSyncElement(loadedLiveStateSyncElement);
+    }, [client, setLiveStateSyncElement, liveStateSyncElement]);
+    return liveStateSyncElement;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useLiveStateData(liveStateDataId) {
+    var liveStateSyncElement = useLiveStateSyncUtils();
+    var _a = React.useState(), 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]);
+    return data;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useSetLiveStateData(liveStateDataId, liveStateData) {
+    var liveStateSyncElement = useLiveStateSyncUtils();
+    React.useEffect(function () {
+        if (liveStateSyncElement && liveStateDataId && liveStateData) {
+            liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.setLiveStateData(liveStateDataId, liveStateData);
+        }
+    }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.setLiveStateData]);
+}
+/**
+ * @beta This hook is in beta
+ */
+function useUserEditorState() {
+    var liveStateSyncElement = useLiveStateSyncUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!(liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isUserEditor))
+            return;
+        var subscription = liveStateSyncElement.isUserEditor().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [liveStateSyncElement === null || liveStateSyncElement === void 0 ? void 0 : liveStateSyncElement.isUserEditor]);
+    return data;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function usePresenceUtils() {
+    var _a = React.useState(), presenceElement = _a[0], setPresenceElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || presenceElement)
+            return;
+        var loadedPresenceElement = client.getPresenceElement();
+        setPresenceElement(loadedPresenceElement);
+    }, [client, setPresenceElement, presenceElement]);
+    return presenceElement;
+}
+/**
+ * @beta This hook is in beta
+ */
+function usePresenceUsers() {
+    var presenceElement = usePresenceUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!presenceElement)
+            return;
+        var subscription = presenceElement.getOnlineUsersOnCurrentDocument().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [presenceElement]);
+    return data;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useRecorderUtils() {
+    var _a = React.useState(), recorderElement = _a[0], setRecorderElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || recorderElement)
+            return;
+        var loadedRecorderElement = client.getRecorderElement();
+        setRecorderElement(loadedRecorderElement);
+    }, [client, setRecorderElement, recorderElement]);
+    return recorderElement;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useRecorderAddHandler() {
+    var recorderElement = useRecorderUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!recorderElement)
+            return;
+        var subscription = recorderElement.onRecordedData().subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [recorderElement]);
+    return data;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useAIRewriterUtils() {
+    var _a = React.useState(), rewriterElement = _a[0], setRewriterElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || rewriterElement)
+            return;
+        var loadedRewriterElement = client.getRewriterElement();
+        setRewriterElement(loadedRewriterElement);
+    }, [client, setRewriterElement, rewriterElement]);
+    return rewriterElement;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useLiveSelectionUtils() {
+    var _a = React.useState(), selectionElement = _a[0], setSelectionElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || selectionElement)
+            return;
+        var loadedSelectionElement = client.getSelectionElement();
+        setSelectionElement(loadedSelectionElement);
+    }, [client, setSelectionElement, selectionElement]);
+    return selectionElement;
+}
+
+/**
+ * @beta This hook is in beta
+ */
+function useTagUtils() {
+    var _a = React.useState(), tagElement = _a[0], setTagElement = _a[1];
+    var client = useVeltClient().client;
+    React.useEffect(function () {
+        if (!client || tagElement)
+            return;
+        var loadedTagElement = client.getTagElement();
+        setTagElement(loadedTagElement);
+    }, [client, setTagElement, tagElement]);
+    return tagElement;
+}
+/**
+ * @beta This hook is in beta
+ */
+function useTagAnnotations(documentId, location) {
+    var tagElement = useTagUtils();
+    var _a = React.useState(), data = _a[0], setData = _a[1];
+    useEffect(function () {
+        if (!tagElement)
+            return;
+        var subscription = tagElement.getAllTagAnnotations(documentId, location).subscribe(function (res) {
+            setData(res);
+        });
+        return function () {
+            subscription.unsubscribe();
+        };
+    }, [tagElement]);
+    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, useHuddleUtils, useIdentify, useLiveSelectionUtils, useLiveStateData, useLiveStateSyncUtils, usePresenceUsers, usePresenceUtils, useRecorderAddHandler, useRecorderUtils, useSetDocumentId, useSetLiveStateData, useSetLocation, useTagAnnotations, useTagUtils, useUserEditorState, useVeltClient };
 //# sourceMappingURL=index.js.map