@veltdev/react 4.0.0-beta.3 → 4.0.0-beta.5

package/esm/types/constants.d.ts

@@ -1,3 +1,3 @@
-export declare const VELT_SDK_VERSION = "4.0.0-beta.3";
+export declare const VELT_SDK_VERSION = "4.0.0-beta.5";
 export declare const VELT_SDK_INIT_EVENT = "onVeltInit";
 export declare const VELT_TAB_ID = "veltTabId";

package/esm/types/hooks/CommentActions.d.ts

@@ -1,80 +1,80 @@
-import { AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationEvent, AddCommentAnnotationRequest, AddCommentEvent, AddCommentRequest, AddReactionEvent, AddReactionRequest, ApproveCommentAnnotationEvent, ApproveCommentAnnotationRequest, AssignUserEvent, AssignUserRequest, Attachment, CommentEventTypesMap, CopyLinkEvent, CopyLinkRequest, DeleteAttachmentEvent, DeleteAttachmentRequest, DeleteCommentAnnotationEvent, DeleteCommentAnnotationRequest, DeleteCommentEvent, DeleteCommentRequest, DeleteReactionEvent, DeleteReactionRequest, DeleteRecordingEvent, DeleteRecordingRequest, GetAttachmentRequest, GetCommentAnnotationsCountRequest, GetCommentAnnotationsCountResponse, GetCommentAnnotationsRequest, GetCommentAnnotationsResponse, GetCommentRequest, GetLinkRequest, GetLinkResponse, GetRecordingRequest, RecordedData, RejectCommentAnnotationEvent, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationEvent, SubscribeCommentAnnotationRequest, ToggleReactionEvent, ToggleReactionRequest, UnsubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationRequest, UpdateAccessEvent, UpdateAccessRequest, UpdateCommentEvent, UpdateCommentRequest, UpdatePriorityEvent, UpdatePriorityRequest, UpdateStatusEvent, UpdateStatusRequest } from "@veltdev/types";
+import { AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationEvent, AddCommentAnnotationRequest, AddCommentEvent, AddCommentRequest, AddReactionEvent, AddReactionRequest, ApproveCommentAnnotationEvent, ApproveCommentAnnotationRequest, AssignUserEvent, AssignUserRequest, Attachment, CommentEventTypesMap, CommentRequestQuery, CopyLinkEvent, CopyLinkRequest, DeleteAttachmentEvent, DeleteAttachmentRequest, DeleteCommentAnnotationEvent, DeleteCommentAnnotationRequest, DeleteCommentEvent, DeleteCommentRequest, DeleteReactionEvent, DeleteReactionRequest, DeleteRecordingEvent, DeleteRecordingRequest, GetAttachmentRequest, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetCommentRequest, GetLinkRequest, GetLinkResponse, GetRecordingRequest, RecordedData, RejectCommentAnnotationEvent, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationEvent, SubscribeCommentAnnotationRequest, ToggleReactionEvent, ToggleReactionRequest, UnsubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationRequest, UpdateAccessEvent, UpdateAccessRequest, UpdateCommentEvent, UpdateCommentRequest, UpdatePriorityEvent, UpdatePriorityRequest, UpdateStatusEvent, UpdateStatusRequest } from "@veltdev/types";
 export declare function useAddCommentAnnotation(): {
-    addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
+    addCommentAnnotation: (request: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
 };
 export declare function useApproveCommentAnnotation(): {
-    approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
+    approveCommentAnnotation: (request: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
 };
 export declare function useRejectCommentAnnotation(): {
-    rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
+    rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
 };
 export declare function useSubscribeCommentAnnotation(): {
-    subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
+    subscribeCommentAnnotation: (request: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
 };
 export declare function useUnsubscribeCommentAnnotation(): {
-    unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
+    unsubscribeCommentAnnotation: (request: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
 };
 export declare function useDeleteCommentAnnotation(): {
-    deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+    deleteCommentAnnotation: (request: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
 };
-export declare function useGetCommentAnnotations(getCommentAnnotationsRequest?: GetCommentAnnotationsRequest): GetCommentAnnotationsResponse;
-export declare function useCommentAnnotationsCount(getCommentAnnotationsCountRequest?: GetCommentAnnotationsCountRequest): GetCommentAnnotationsCountResponse;
+export declare function useGetCommentAnnotations(query?: CommentRequestQuery): GetCommentAnnotationsResponse;
+export declare function useCommentAnnotationsCount(query?: CommentRequestQuery): GetCommentAnnotationsCountResponse;
 export declare function useAssignUser(): {
-    assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
+    assignUser: (request: AssignUserRequest) => Promise<AssignUserEvent | null>;
 };
 export declare function useUpdatePriority(): {
-    updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
+    updatePriority: (request: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
 };
 export declare function useUpdateStatus(): {
-    updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
+    updateStatus: (request: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
 };
 export declare function useUpdateAccess(): {
-    updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
+    updateAccess: (request: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
 };
 export declare function useResolveCommentAnnotation(): {
-    resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<ResolveCommentAnnotationRequest | null>;
+    resolveCommentAnnotation: (request: ResolveCommentAnnotationRequest) => Promise<ResolveCommentAnnotationRequest | null>;
 };
 export declare function useGetLink(): {
-    getLink: (config: GetLinkRequest) => Promise<GetLinkResponse | null>;
+    getLink: (request: GetLinkRequest) => Promise<GetLinkResponse | null>;
 };
 export declare function useCopyLink(): {
-    copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
+    copyLink: (request: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
 };
 export declare function useAddComment(): {
-    addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
+    addComment: (request: AddCommentRequest) => Promise<AddCommentEvent | null>;
 };
 export declare function useUpdateComment(): {
-    updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
+    updateComment: (request: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
 };
 export declare function useDeleteComment(): {
-    deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
+    deleteComment: (request: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
 };
 export declare function useGetComment(): {
-    getComment: (config: GetCommentRequest) => Promise<Comment[]>;
+    getComment: (request: GetCommentRequest) => Promise<Comment[]>;
 };
 export declare function useAddAttachment(): {
-    addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[] | null>;
+    addAttachment: (request: AddAttachmentRequest) => Promise<AddAttachmentResponse[] | null>;
 };
 export declare function useDeleteAttachment(): {
-    deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
+    deleteAttachment: (request: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
 };
 export declare function useGetAttachment(): {
-    getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[] | null>;
+    getAttachment: (request: GetAttachmentRequest) => Promise<Attachment[] | null>;
 };
 export declare function useDeleteRecording(): {
-    deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
+    deleteRecording: (request: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
 };
 export declare function useGetRecording(): {
-    getRecording: (config: GetRecordingRequest) => Promise<RecordedData[] | null>;
+    getRecording: (request: GetRecordingRequest) => Promise<RecordedData[] | null>;
 };
 export declare function useAddReaction(): {
-    addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
+    addReaction: (request: AddReactionRequest) => Promise<AddReactionEvent | null>;
 };
 export declare function useDeleteReaction(): {
-    deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
+    deleteReaction: (request: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
 };
 export declare function useToggleReaction(): {
-    toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
+    toggleReaction: (request: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
 };
 /**
  * @deprecated Use useCommentEventCallback hook instead.

package/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import React from 'react';
-import { Config, Velt, ReactionMap, CommentAnnotation, AutocompleteItem, User, Options, DocumentMetadata, Document, SetDocumentsRequestOptions, Location as Location$1, CommentElement, UnreadCommentsCount, CommentAddEventData, CommentUpdateEventData, CommentSelectionChangeData, CommentSidebarCustomActionEventData, AddCommentAnnotationRequest, AddCommentAnnotationEvent, ApproveCommentAnnotationRequest, ApproveCommentAnnotationEvent, RejectCommentAnnotationRequest, RejectCommentAnnotationEvent, SubscribeCommentAnnotationRequest, SubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationEvent, DeleteCommentAnnotationRequest, DeleteCommentAnnotationEvent, GetCommentAnnotationsRequest, GetCommentAnnotationsResponse, GetCommentAnnotationsCountRequest, GetCommentAnnotationsCountResponse, AssignUserRequest, AssignUserEvent, UpdatePriorityRequest, UpdatePriorityEvent, UpdateStatusRequest, UpdateStatusEvent, UpdateAccessRequest, UpdateAccessEvent, ResolveCommentAnnotationRequest, GetLinkRequest, GetLinkResponse, CopyLinkRequest, CopyLinkEvent, AddCommentRequest, AddCommentEvent, UpdateCommentRequest, UpdateCommentEvent, DeleteCommentRequest, DeleteCommentEvent, GetCommentRequest, AddAttachmentRequest, AddAttachmentResponse, DeleteAttachmentRequest, DeleteAttachmentEvent, GetAttachmentRequest, Attachment, DeleteRecordingRequest, DeleteRecordingEvent, GetRecordingRequest, RecordedData, AddReactionRequest, AddReactionEvent, DeleteReactionRequest, DeleteReactionEvent, ToggleReactionRequest, ToggleReactionEvent, CommentEventTypesMap, CoreEventTypesMap, CursorElement, CursorUser, LiveStateSyncElement, UserEditorAccess, EditorAccessTimer, ServerConnectionState, PresenceElement, PresenceUser, RecorderElement, RewriterElement, SelectionElement, LiveSelectionData, TagElement, TagAnnotation, ViewsElement, ViewsByUser, ViewsByDate, NotificationElement, Notification, AutocompleteElement, AutocompleteChipData, ContactElement, SelectedUserContact } from '@veltdev/types';
+import { Config, Velt, ReactionMap, CommentAnnotation, AutocompleteItem, User, Options, DocumentMetadata, Document, SetDocumentsRequestOptions, Location as Location$1, CommentElement, UnreadCommentsCount, CommentAddEventData, CommentUpdateEventData, CommentSelectionChangeData, CommentSidebarCustomActionEventData, AddCommentAnnotationRequest, AddCommentAnnotationEvent, ApproveCommentAnnotationRequest, ApproveCommentAnnotationEvent, RejectCommentAnnotationRequest, RejectCommentAnnotationEvent, SubscribeCommentAnnotationRequest, SubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationEvent, DeleteCommentAnnotationRequest, DeleteCommentAnnotationEvent, CommentRequestQuery, GetCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, AssignUserRequest, AssignUserEvent, UpdatePriorityRequest, UpdatePriorityEvent, UpdateStatusRequest, UpdateStatusEvent, UpdateAccessRequest, UpdateAccessEvent, ResolveCommentAnnotationRequest, GetLinkRequest, GetLinkResponse, CopyLinkRequest, CopyLinkEvent, AddCommentRequest, AddCommentEvent, UpdateCommentRequest, UpdateCommentEvent, DeleteCommentRequest, DeleteCommentEvent, GetCommentRequest, AddAttachmentRequest, AddAttachmentResponse, DeleteAttachmentRequest, DeleteAttachmentEvent, GetAttachmentRequest, Attachment, DeleteRecordingRequest, DeleteRecordingEvent, GetRecordingRequest, RecordedData, AddReactionRequest, AddReactionEvent, DeleteReactionRequest, DeleteReactionEvent, ToggleReactionRequest, ToggleReactionEvent, CommentEventTypesMap, CoreEventTypesMap, CursorElement, CursorUser, LiveStateSyncElement, UserEditorAccess, EditorAccessTimer, ServerConnectionState, PresenceElement, PresenceUser, RecorderElement, RewriterElement, SelectionElement, LiveSelectionData, TagElement, TagAnnotation, ViewsElement, ViewsByUser, ViewsByDate, NotificationElement, Notification, AutocompleteElement, AutocompleteChipData, ContactElement, SelectedUserContact } from '@veltdev/types';
 
 interface IVeltProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     apiKey: string;
@@ -3750,81 +3750,81 @@ declare function useCommentSidebarInit(): CommentSidebarCustomActionEventData |
 declare function useCommentSidebarData(): CommentSidebarCustomActionEventData | null;
 
 declare function useAddCommentAnnotation(): {
-    addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
+    addCommentAnnotation: (request: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
 };
 declare function useApproveCommentAnnotation(): {
-    approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
+    approveCommentAnnotation: (request: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
 };
 declare function useRejectCommentAnnotation(): {
-    rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
+    rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
 };
 declare function useSubscribeCommentAnnotation(): {
-    subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
+    subscribeCommentAnnotation: (request: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
 };
 declare function useUnsubscribeCommentAnnotation(): {
-    unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
+    unsubscribeCommentAnnotation: (request: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
 };
 declare function useDeleteCommentAnnotation(): {
-    deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+    deleteCommentAnnotation: (request: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
 };
-declare function useGetCommentAnnotations(getCommentAnnotationsRequest?: GetCommentAnnotationsRequest): GetCommentAnnotationsResponse;
-declare function useCommentAnnotationsCount(getCommentAnnotationsCountRequest?: GetCommentAnnotationsCountRequest): GetCommentAnnotationsCountResponse;
+declare function useGetCommentAnnotations(query?: CommentRequestQuery): GetCommentAnnotationsResponse;
+declare function useCommentAnnotationsCount(query?: CommentRequestQuery): GetCommentAnnotationsCountResponse;
 declare function useAssignUser(): {
-    assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
+    assignUser: (request: AssignUserRequest) => Promise<AssignUserEvent | null>;
 };
 declare function useUpdatePriority(): {
-    updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
+    updatePriority: (request: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
 };
 declare function useUpdateStatus(): {
-    updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
+    updateStatus: (request: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
 };
 declare function useUpdateAccess(): {
-    updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
+    updateAccess: (request: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
 };
 declare function useResolveCommentAnnotation(): {
-    resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<ResolveCommentAnnotationRequest | null>;
+    resolveCommentAnnotation: (request: ResolveCommentAnnotationRequest) => Promise<ResolveCommentAnnotationRequest | null>;
 };
 declare function useGetLink(): {
-    getLink: (config: GetLinkRequest) => Promise<GetLinkResponse | null>;
+    getLink: (request: GetLinkRequest) => Promise<GetLinkResponse | null>;
 };
 declare function useCopyLink(): {
-    copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
+    copyLink: (request: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
 };
 declare function useAddComment(): {
-    addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
+    addComment: (request: AddCommentRequest) => Promise<AddCommentEvent | null>;
 };
 declare function useUpdateComment(): {
-    updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
+    updateComment: (request: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
 };
 declare function useDeleteComment(): {
-    deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
+    deleteComment: (request: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
 };
 declare function useGetComment(): {
-    getComment: (config: GetCommentRequest) => Promise<Comment[]>;
+    getComment: (request: GetCommentRequest) => Promise<Comment[]>;
 };
 declare function useAddAttachment(): {
-    addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[] | null>;
+    addAttachment: (request: AddAttachmentRequest) => Promise<AddAttachmentResponse[] | null>;
 };
 declare function useDeleteAttachment(): {
-    deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
+    deleteAttachment: (request: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
 };
 declare function useGetAttachment(): {
-    getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[] | null>;
+    getAttachment: (request: GetAttachmentRequest) => Promise<Attachment[] | null>;
 };
 declare function useDeleteRecording(): {
-    deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
+    deleteRecording: (request: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
 };
 declare function useGetRecording(): {
-    getRecording: (config: GetRecordingRequest) => Promise<RecordedData[] | null>;
+    getRecording: (request: GetRecordingRequest) => Promise<RecordedData[] | null>;
 };
 declare function useAddReaction(): {
-    addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
+    addReaction: (request: AddReactionRequest) => Promise<AddReactionEvent | null>;
 };
 declare function useDeleteReaction(): {
-    deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
+    deleteReaction: (request: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
 };
 declare function useToggleReaction(): {
-    toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
+    toggleReaction: (request: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
 };
 /**
  * @deprecated Use useCommentEventCallback hook instead.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/react",
-    "version": "4.0.0-beta.3",
+    "version": "4.0.0-beta.5",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [