@veltdev/react 4.0.0-beta.2 → 4.0.0-beta.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/cjs/index.js +130 -69
  2. package/cjs/index.js.map +1 -1
  3. package/cjs/types/components/Snippyly/Snippyly.d.ts +2 -1
  4. package/cjs/types/components/SnippylyComments/SnippylyComments.d.ts +1 -0
  5. package/cjs/types/components/SnippylyRecorderNotes/SnippylyRecorderNotes.d.ts +2 -1
  6. package/cjs/types/components/SnippylyRecorderTool/SnippylyRecorderTool.d.ts +1 -0
  7. package/cjs/types/components/VeltCommentsSidebarWireframe/VeltCommentsSidebarFilter/VeltCommentsSidebarFilter.d.ts +2 -0
  8. package/cjs/types/components/VeltCommentsSidebarWireframe/VeltCommentsSidebarFilter/VeltCommentsSidebarFilterStatus/VeltCommentsSidebarFilterStatus.d.ts +12 -0
  9. package/cjs/types/components/VeltCommentsSidebarWireframe/VeltCommentsSidebarFilter/VeltCommentsSidebarFilterStatus/index.d.ts +1 -0
  10. package/cjs/types/components/VeltInlineCommentsSection/VeltInlineCommentsSection.d.ts +6 -0
  11. package/cjs/types/constants.d.ts +1 -1
  12. package/cjs/types/hooks/Client.d.ts +1 -0
  13. package/cjs/types/hooks/CommentActions.d.ts +28 -28
  14. package/cjs/types/hooks/RecorderActions.d.ts +2 -0
  15. package/cjs/types/hooks/index.d.ts +2 -1
  16. package/esm/index.js +129 -70
  17. package/esm/index.js.map +1 -1
  18. package/esm/types/components/Snippyly/Snippyly.d.ts +2 -1
  19. package/esm/types/components/SnippylyComments/SnippylyComments.d.ts +1 -0
  20. package/esm/types/components/SnippylyRecorderNotes/SnippylyRecorderNotes.d.ts +2 -1
  21. package/esm/types/components/SnippylyRecorderTool/SnippylyRecorderTool.d.ts +1 -0
  22. package/esm/types/components/VeltCommentsSidebarWireframe/VeltCommentsSidebarFilter/VeltCommentsSidebarFilter.d.ts +2 -0
  23. package/esm/types/components/VeltCommentsSidebarWireframe/VeltCommentsSidebarFilter/VeltCommentsSidebarFilterStatus/VeltCommentsSidebarFilterStatus.d.ts +12 -0
  24. package/esm/types/components/VeltCommentsSidebarWireframe/VeltCommentsSidebarFilter/VeltCommentsSidebarFilterStatus/index.d.ts +1 -0
  25. package/esm/types/components/VeltInlineCommentsSection/VeltInlineCommentsSection.d.ts +6 -0
  26. package/esm/types/constants.d.ts +1 -1
  27. package/esm/types/hooks/Client.d.ts +1 -0
  28. package/esm/types/hooks/CommentActions.d.ts +28 -28
  29. package/esm/types/hooks/RecorderActions.d.ts +2 -0
  30. package/esm/types/hooks/index.d.ts +2 -1
  31. package/index.d.ts +52 -30
  32. package/package.json +3 -3
@@ -1,5 +1,5 @@
1
1
  import React from 'react';
2
- import { Config, Velt } from '@veltdev/types';
2
+ import { Config, Velt, UserDataProvider } from '@veltdev/types';
3
3
  export interface IVeltProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
4
4
  apiKey: string;
5
5
  config?: Config & {
@@ -15,6 +15,7 @@ export interface IVeltProps extends React.DetailedHTMLProps<React.HTMLAttributes
15
15
  };
16
16
  };
17
17
  autoTranslation?: boolean;
18
+ userDataProvider?: UserDataProvider;
18
19
  onClientLoad?: (veltClient?: Velt) => any;
19
20
  }
20
21
  declare const SnippylyProvider: React.FC<IVeltProps>;
@@ -141,6 +141,7 @@ export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAt
141
141
  resolveStatusAccessAdminOnly?: boolean;
142
142
  seenByUsers?: boolean;
143
143
  readOnly?: boolean;
144
+ atHereEnabled?: boolean;
144
145
  }
145
146
  declare const SnippylyComments: React.FC<IVeltCommentsProps>;
146
147
  export default SnippylyComments;
@@ -1,5 +1,6 @@
1
1
  import React from 'react';
2
- export interface IVeltRecorderNotesProps {
2
+ export interface IVeltRecorderNotesProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
3
+ shadowDom?: boolean;
3
4
  }
4
5
  declare const SnippylyRecorderNotes: React.FC<IVeltRecorderNotesProps>;
5
6
  export default SnippylyRecorderNotes;
@@ -4,6 +4,7 @@ export interface IVeltRecorderToolProps extends React.DetailedHTMLProps<React.HT
4
4
  panelId?: string;
5
5
  buttonLabel?: string;
6
6
  darkMode?: boolean;
7
+ shadowDom?: boolean;
7
8
  }
8
9
  declare const SnippylyRecorderTool: React.FC<IVeltRecorderToolProps>;
9
10
  export default SnippylyRecorderTool;
@@ -10,6 +10,7 @@ import { IVeltCommentsSidebarFilterPriority } from './VeltCommentsSidebarFilterP
10
10
  import { IVeltCommentsSidebarFilterTitleProps } from './VeltCommentsSidebarFilterTitle/VeltCommentsSidebarFilterTitle';
11
11
  import { IVeltCommentsSidebarFilterVersions } from './VeltCommentsSidebarFilterVersions/VeltCommentsSidebarFilterVersions';
12
12
  import { IVeltCommentsSidebarFilterItem } from './VeltCommentsSidebarFilterItem/VeltCommentsSidebarFilterItem';
13
+ import { IVeltCommentsSidebarFilterStatus } from './VeltCommentsSidebarFilterStatus/VeltCommentsSidebarFilterStatus';
13
14
  export interface IVeltCommentsSidebarFilterProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
14
15
  variant?: string;
15
16
  }
@@ -25,6 +26,7 @@ export interface IVeltCommentsSidebarFilter extends React.FC<IVeltCommentsSideba
25
26
  GroupBy: IVeltCommentsSidebarFilterGroupBy;
26
27
  DoneButton: React.FC<IVeltCommentsSidebarFilterDoneButtonProps>;
27
28
  Item: IVeltCommentsSidebarFilterItem;
29
+ Status: IVeltCommentsSidebarFilterStatus;
28
30
  }
29
31
  declare const VeltCommentsSidebarFilter: IVeltCommentsSidebarFilter;
30
32
  export default VeltCommentsSidebarFilter;
@@ -0,0 +1,12 @@
1
+ import React from 'react';
2
+ import { IVeltCommentsSidebarFilterItem } from '../VeltCommentsSidebarFilterItem/VeltCommentsSidebarFilterItem';
3
+ import { IVeltCommentsSidebarFilterNameProps } from '../VeltCommentsSidebarFilterName/VeltCommentsSidebarFilterName';
4
+ export interface IVeltCommentsSidebarFilterStatusProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
5
+ variant?: string;
6
+ }
7
+ export interface IVeltCommentsSidebarFilterStatus extends React.FC<IVeltCommentsSidebarFilterStatusProps> {
8
+ Name: React.FC<IVeltCommentsSidebarFilterNameProps>;
9
+ Item: IVeltCommentsSidebarFilterItem;
10
+ }
11
+ declare const VeltCommentsSidebarFilterStatus: IVeltCommentsSidebarFilterStatus;
12
+ export default VeltCommentsSidebarFilterStatus;
@@ -0,0 +1 @@
1
+ export { default } from "./VeltCommentsSidebarFilterStatus";
@@ -19,7 +19,13 @@ export interface IVeltInlineCommentsSectionProps extends React.DetailedHTMLProps
19
19
  composerVariant?: string;
20
20
  shadowDom?: boolean;
21
21
  multiThread?: boolean;
22
+ /**
23
+ * @deprecated Use `sortBy` and `sortOrder` instead.
24
+ */
22
25
  sortData?: 'asc' | 'desc' | 'none';
26
+ composerPosition?: 'top' | 'bottom';
27
+ sortBy?: 'createdAt' | 'lastUpdated';
28
+ sortOrder?: 'asc' | 'desc';
23
29
  }
24
30
  declare const VeltInlineCommentsSection: React.FC<IVeltInlineCommentsSectionProps>;
25
31
  export default VeltInlineCommentsSection;
@@ -1,3 +1,3 @@
1
- export declare const VELT_SDK_VERSION = "4.0.0-beta.2";
1
+ export declare const VELT_SDK_VERSION = "4.0.0-beta.20";
2
2
  export declare const VELT_SDK_INIT_EVENT = "onVeltInit";
3
3
  export declare const VELT_TAB_ID = "veltTabId";
@@ -7,5 +7,6 @@ export declare function useSetDocuments(): {
7
7
  setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
8
8
  };
9
9
  export declare function useUnsetDocumentId(): void;
10
+ export declare function useUnsetDocuments(): void;
10
11
  export declare function useSetLocation(location: Location, appendLocation?: boolean): void;
11
12
  export declare function useVeltInitState(): boolean | undefined;
@@ -1,80 +1,80 @@
1
- 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";
1
+ 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";
2
2
  export declare function useAddCommentAnnotation(): {
3
- addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
3
+ addCommentAnnotation: (request: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
4
4
  };
5
5
  export declare function useApproveCommentAnnotation(): {
6
- approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
6
+ approveCommentAnnotation: (request: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
7
7
  };
8
8
  export declare function useRejectCommentAnnotation(): {
9
- rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
9
+ rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
10
10
  };
11
11
  export declare function useSubscribeCommentAnnotation(): {
12
- subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
12
+ subscribeCommentAnnotation: (request: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
13
13
  };
14
14
  export declare function useUnsubscribeCommentAnnotation(): {
15
- unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
15
+ unsubscribeCommentAnnotation: (request: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
16
16
  };
17
17
  export declare function useDeleteCommentAnnotation(): {
18
- deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
18
+ deleteCommentAnnotation: (request: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
19
19
  };
20
- export declare function useGetCommentAnnotations(getCommentAnnotationsRequest: GetCommentAnnotationsRequest): GetCommentAnnotationsResponse | null;
21
- export declare function useCommentAnnotationsCount(getCommentAnnotationsCountRequest: GetCommentAnnotationsCountRequest): GetCommentAnnotationsCountResponse | null;
20
+ export declare function useGetCommentAnnotations(query?: CommentRequestQuery): GetCommentAnnotationsResponse;
21
+ export declare function useCommentAnnotationsCount(query?: CommentRequestQuery): GetCommentAnnotationsCountResponse;
22
22
  export declare function useAssignUser(): {
23
- assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
23
+ assignUser: (request: AssignUserRequest) => Promise<AssignUserEvent | null>;
24
24
  };
25
25
  export declare function useUpdatePriority(): {
26
- updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
26
+ updatePriority: (request: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
27
27
  };
28
28
  export declare function useUpdateStatus(): {
29
- updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
29
+ updateStatus: (request: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
30
30
  };
31
31
  export declare function useUpdateAccess(): {
32
- updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
32
+ updateAccess: (request: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
33
33
  };
34
34
  export declare function useResolveCommentAnnotation(): {
35
- resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<ResolveCommentAnnotationRequest | null>;
35
+ resolveCommentAnnotation: (request: ResolveCommentAnnotationRequest) => Promise<ResolveCommentAnnotationRequest | null>;
36
36
  };
37
37
  export declare function useGetLink(): {
38
- getLink: (config: GetLinkRequest) => Promise<GetLinkResponse | null>;
38
+ getLink: (request: GetLinkRequest) => Promise<GetLinkResponse | null>;
39
39
  };
40
40
  export declare function useCopyLink(): {
41
- copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
41
+ copyLink: (request: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
42
42
  };
43
43
  export declare function useAddComment(): {
44
- addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
44
+ addComment: (request: AddCommentRequest) => Promise<AddCommentEvent | null>;
45
45
  };
46
46
  export declare function useUpdateComment(): {
47
- updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
47
+ updateComment: (request: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
48
48
  };
49
49
  export declare function useDeleteComment(): {
50
- deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
50
+ deleteComment: (request: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
51
51
  };
52
52
  export declare function useGetComment(): {
53
- getComment: (config: GetCommentRequest) => Promise<Comment[]>;
53
+ getComment: (request: GetCommentRequest) => Promise<Comment[]>;
54
54
  };
55
55
  export declare function useAddAttachment(): {
56
- addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[] | null>;
56
+ addAttachment: (request: AddAttachmentRequest) => Promise<AddAttachmentResponse[] | null>;
57
57
  };
58
58
  export declare function useDeleteAttachment(): {
59
- deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
59
+ deleteAttachment: (request: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
60
60
  };
61
61
  export declare function useGetAttachment(): {
62
- getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[] | null>;
62
+ getAttachment: (request: GetAttachmentRequest) => Promise<Attachment[] | null>;
63
63
  };
64
64
  export declare function useDeleteRecording(): {
65
- deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
65
+ deleteRecording: (request: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
66
66
  };
67
67
  export declare function useGetRecording(): {
68
- getRecording: (config: GetRecordingRequest) => Promise<RecordedData[] | null>;
68
+ getRecording: (request: GetRecordingRequest) => Promise<RecordedData[] | null>;
69
69
  };
70
70
  export declare function useAddReaction(): {
71
- addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
71
+ addReaction: (request: AddReactionRequest) => Promise<AddReactionEvent | null>;
72
72
  };
73
73
  export declare function useDeleteReaction(): {
74
- deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
74
+ deleteReaction: (request: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
75
75
  };
76
76
  export declare function useToggleReaction(): {
77
- toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
77
+ toggleReaction: (request: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
78
78
  };
79
79
  /**
80
80
  * @deprecated Use useCommentEventCallback hook instead.
@@ -0,0 +1,2 @@
1
+ import { RecorderEventTypesMap } from "@veltdev/types";
2
+ export declare function useRecorderEventCallback<T extends keyof RecorderEventTypesMap>(action: T): RecorderEventTypesMap[T];
@@ -1,4 +1,4 @@
1
- export { useSetLocation, useSetDocument, useSetDocumentId, useSetDocuments, useUnsetDocumentId, useIdentify, useClient, useVeltInitState, } from './Client';
1
+ export { useSetLocation, useSetDocument, useSetDocumentId, useSetDocuments, useUnsetDocumentId, useUnsetDocuments, useIdentify, useClient, useVeltInitState, } from './Client';
2
2
  export { useCommentUtils, useCommentAnnotations, useCommentAddHandler, useCommentModeState, useCommentUpdateHandler, useCommentDialogSidebarClickHandler, useCommentSelectionChangeHandler, useUnreadCommentCountByAnnotationId, useUnreadCommentAnnotationCountOnCurrentDocument, useUnreadCommentCountOnCurrentDocument, useUnreadCommentAnnotationCountByLocationId, useUnreadCommentCountByLocationId, useCommentCopyLinkHandler, useCommentAnnotationById, useCommentSidebarActionButtonClick, useCommentSidebarInit, useCommentSidebarData, } from './CommentElement';
3
3
  export { useAddAttachment, useDeleteAttachment, useGetAttachment, useDeleteRecording, useGetRecording, useAddReaction, useDeleteReaction, useToggleReaction, useAddComment, useUpdateComment, useDeleteComment, useAddCommentAnnotation, useDeleteCommentAnnotation, useApproveCommentAnnotation, useSubscribeCommentAnnotation, useUnsubscribeCommentAnnotation, useAssignUser, useCopyLink, useGetComment, useGetLink, useRejectCommentAnnotation, useResolveCommentAnnotation, useUpdateAccess, useUpdatePriority, useUpdateStatus, useCommentActionCallback, useCommentEventCallback, useGetCommentAnnotations, useCommentAnnotationsCount, } from './CommentActions';
4
4
  export { useVeltEventCallback } from './CoreActions';
@@ -7,6 +7,7 @@ export { useHuddleUtils, } from './HuddleElement';
7
7
  export { useLiveStateSyncUtils, useLiveStateData, useSetLiveStateData, useUserEditorState, useEditor, useEditorAccessTimer, useEditorAccessRequestHandler, useServerConnectionStateChangeHandler, useLiveState, } from './LiveStateSyncElement';
8
8
  export { usePresenceUtils, usePresenceUsers, } from './PresenceElement';
9
9
  export { useRecorderUtils, useRecorderAddHandler, useRecordingDataByRecorderId, } from './RecorderElement';
10
+ export { useRecorderEventCallback, } from './RecorderActions';
10
11
  export { useAIRewriterUtils, } from './RewriterElement';
11
12
  export { useLiveSelectionUtils, useLiveSelectionDataHandler, } from './SelectionElement';
12
13
  export { useTagUtils, useTagAnnotations, } from './TagElement';