@veltdev/types-dev 3.0.217 → 3.0.219

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.
@@ -2,8 +2,13 @@ import { CommentAccessMode, CommentStatus } from "../../utils/enums";
2
2
  import { Attachment } from "./attachment.model";
3
3
  import { AddAttachmentResponse } from "./comment-actions.data.model";
4
4
  import { CommentAnnotation, UpdateContextConfig } from "./comment-annotation.data.model";
5
+ import { Comment } from "./comment.data.model";
5
6
  import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
7
+ import { DocumentMetadata } from "./document-metadata.model";
6
8
  import { Location } from "./location.model";
9
+ import { OrganizationMetadata } from "./organization-metadata.model";
10
+ import { ReactionAnnotation } from "./reaction-annotation.data.model";
11
+ import { RecordedData } from "./recorder.model";
7
12
  import { User } from "./user.data.model";
8
13
  export interface CommentAddEventData {
9
14
  annotation: CommentAnnotation;
@@ -34,56 +39,83 @@ export interface CommentSuggestionEventData {
34
39
  replaceContentText?: string;
35
40
  annotation?: any;
36
41
  }
42
+ export interface CommentEventMetadata {
43
+ organizationMetadata?: OrganizationMetadata | null;
44
+ documentMetadata?: DocumentMetadata | null;
45
+ location?: Location | null;
46
+ }
37
47
  export interface AddAttachmentEvent {
48
+ annotationId?: string;
49
+ commentAnnotation?: CommentAnnotation;
38
50
  attachments: AddAttachmentResponse[];
51
+ metadata: CommentEventMetadata;
39
52
  }
40
53
  export interface DeleteAttachmentEvent {
41
- deletedAttachment: Attachment;
42
- annotationId: string;
43
- commentId: number;
44
- annotation: CommentAnnotation;
54
+ annotationId?: string;
55
+ commentId?: number;
56
+ commentAnnotation?: CommentAnnotation;
57
+ attachment: Attachment;
58
+ metadata: CommentEventMetadata;
45
59
  }
46
60
  export interface AddCommentAnnotationEvent {
47
- annotation: CommentAnnotation;
61
+ annotationId?: string;
62
+ commentAnnotation?: CommentAnnotation;
63
+ metadata: CommentEventMetadata;
48
64
  }
49
65
  export interface ApproveCommentAnnotationEvent {
50
- annotationId: string;
51
- annotation: CommentAnnotation;
66
+ annotationId?: string;
67
+ commentAnnotation?: CommentAnnotation;
68
+ metadata: CommentEventMetadata;
52
69
  }
53
70
  export interface AcceptCommentAnnotationEvent {
54
- annotationId: string;
55
- annotation: CommentAnnotation;
71
+ annotationId?: string;
72
+ commentAnnotation?: CommentAnnotation;
73
+ metadata: CommentEventMetadata;
56
74
  }
57
75
  export interface RejectCommentAnnotationEvent {
58
- annotationId: string;
59
- annotation: CommentAnnotation;
76
+ annotationId?: string;
77
+ commentAnnotation?: CommentAnnotation;
78
+ metadata: CommentEventMetadata;
60
79
  }
61
80
  export interface DeleteCommentAnnotationEvent {
62
- annotationId: string;
63
- annotation: CommentAnnotation;
81
+ annotationId?: string;
82
+ commentAnnotation?: CommentAnnotation;
83
+ metadata: CommentEventMetadata;
64
84
  }
65
85
  export interface AddCommentEvent {
86
+ annotationId?: string;
87
+ commentAnnotation?: CommentAnnotation;
88
+ commentId?: number;
89
+ comment: Comment;
90
+ metadata: CommentEventMetadata;
66
91
  }
67
92
  export interface UpdateCommentEvent {
68
- annotationId: string;
93
+ annotationId?: string;
94
+ commentAnnotation?: CommentAnnotation;
95
+ commentId?: number;
69
96
  comment: Comment;
70
- annotation: CommentAnnotation;
97
+ metadata: CommentEventMetadata;
71
98
  }
72
99
  export interface DeleteCommentEvent {
73
- annotationId: string;
74
- commentId: number;
75
- annotation: CommentAnnotation;
100
+ annotationId?: string;
101
+ commentAnnotation?: CommentAnnotation;
102
+ commentId?: number;
103
+ comment: Comment;
104
+ metadata: CommentEventMetadata;
76
105
  }
77
106
  export interface DeleteRecordingEvent {
78
- annotationId: string;
79
- commentId: number;
80
- recorderId: string;
81
- annotation: CommentAnnotation;
107
+ annotationId?: string;
108
+ commentAnnotation?: CommentAnnotation;
109
+ commentId?: number;
110
+ recording: RecordedData;
111
+ metadata: CommentEventMetadata;
82
112
  }
83
113
  export interface ReactionEvent {
84
- annotationId: string;
85
- commentId: number;
86
- annotation: CommentAnnotation;
114
+ annotationId?: string;
115
+ commentAnnotation?: CommentAnnotation;
116
+ commentId?: number;
117
+ reaction: ReactionAnnotation;
118
+ metadata: CommentEventMetadata;
87
119
  }
88
120
  export interface AddReactionEvent extends ReactionEvent {
89
121
  }
@@ -92,30 +124,35 @@ export interface DeleteReactionEvent extends ReactionEvent {
92
124
  export interface ToggleReactionEvent extends ReactionEvent {
93
125
  }
94
126
  export interface UpdateStatusEvent {
127
+ annotationId?: string;
128
+ commentAnnotation?: CommentAnnotation;
95
129
  newStatus: CustomStatus;
96
130
  oldStatus: CustomStatus;
97
- annotationId: string;
98
- annotation: CommentAnnotation;
131
+ metadata: CommentEventMetadata;
99
132
  }
100
133
  export interface UpdatePriorityEvent {
134
+ annotationId?: string;
135
+ commentAnnotation?: CommentAnnotation;
101
136
  newPriority?: CustomPriority;
102
137
  oldPriority?: CustomPriority;
103
- annotationId: string;
104
- annotation: CommentAnnotation;
138
+ metadata: CommentEventMetadata;
105
139
  }
106
140
  export interface UpdateAccessEvent {
107
- newAccessMode: CommentAccessMode;
108
- oldAccessMode: CommentAccessMode;
109
- annotationId: string;
110
- annotation: CommentAnnotation;
141
+ annotationId?: string;
142
+ commentAnnotation?: CommentAnnotation;
143
+ newAccessMode?: CommentAccessMode;
144
+ oldAccessMode?: CommentAccessMode;
145
+ metadata: CommentEventMetadata;
111
146
  }
112
147
  export interface GetLinkEvent {
148
+ annotationId?: string;
149
+ commentAnnotation?: CommentAnnotation;
113
150
  link: string | null;
114
- annotationId: string;
115
- annotation: CommentAnnotation;
151
+ metadata: CommentEventMetadata;
116
152
  }
117
153
  export interface CopyLinkEvent {
154
+ annotationId?: string;
155
+ commentAnnotation?: CommentAnnotation;
118
156
  link: string;
119
- annotationId: string;
120
- annotation: CommentAnnotation;
157
+ metadata: CommentEventMetadata;
121
158
  }
@@ -1,7 +1,7 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
3
  import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
4
- import { CommentAddEventData, CommentUpdateEventData } from "../data/comment-events.data.model";
4
+ import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
5
5
  import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
6
6
  import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
7
7
  import { AutocompleteData } from "../data/autocomplete.data.model";
@@ -916,107 +916,117 @@ export declare class CommentElement {
916
916
  /**
917
917
  * To add comment annotation
918
918
  */
919
- public addCommentAnnotation: (config: AddCommentAnnotationConfig) => any;
919
+ public addCommentAnnotation: (config: AddCommentAnnotationConfig) => Promise<AddCommentAnnotationEvent | null>;
920
920
 
921
921
  /**
922
922
  * To approve comment annotation
923
923
  */
924
- public approveCommentAnnotation: (config: ApproveCommentAnnotationConfig) => any;
924
+ public approveCommentAnnotation: (config: ApproveCommentAnnotationConfig) => Promise<ApproveCommentAnnotationEvent | null>;
925
925
 
926
926
  /**
927
927
  * To accept comment annotation
928
928
  */
929
- public acceptCommentAnnotation: (config: AcceptCommentAnnotationConfig) => any;
929
+ public acceptCommentAnnotation: (config: AcceptCommentAnnotationConfig) => Promise<AcceptCommentAnnotationEvent | null>;
930
930
 
931
931
  /**
932
932
  * To reject comment annotation
933
933
  */
934
- public rejectCommentAnnotation: (config: RejectCommentAnnotationConfig) => any;
934
+ public rejectCommentAnnotation: (config: RejectCommentAnnotationConfig) => Promise<RejectCommentAnnotationEvent | null>;
935
935
 
936
936
  /**
937
937
  * To delete comment annotation
938
938
  */
939
- public deleteCommentAnnotation: (config: DeleteCommentAnnotationConfig) => any;
939
+ public deleteCommentAnnotation: (config: DeleteCommentAnnotationConfig) => Promise<DeleteCommentAnnotationEvent | null>;
940
940
 
941
941
  /**
942
942
  * To update priority
943
943
  */
944
- public updatePriority: (config: UpdatePriorityConfig) => any;
944
+ public updatePriority: (config: UpdatePriorityConfig) => Promise<UpdatePriorityEvent | null>;
945
945
 
946
946
  /**
947
947
  * To update status
948
948
  */
949
- public updateStatus: (config: UpdateStatusConfig) => any;
949
+ public updateStatus: (config: UpdateStatusConfig) => Promise<UpdateStatusEvent | null>;
950
950
 
951
951
  /**
952
952
  * To update access
953
953
  */
954
- public updateAccess: (config: UpdateAccessConfig) => any;
954
+ public updateAccess: (config: UpdateAccessConfig) => Promise<UpdateAccessEvent | null>;
955
955
 
956
956
  /**
957
957
  * To resolve comment annotation
958
958
  */
959
- public resolveCommentAnnotation: (config: ResolveCommentAnnotationConfig) => any;
959
+ public resolveCommentAnnotation: (config: ResolveCommentAnnotationConfig) => Promise<any>;
960
960
 
961
961
  /**
962
962
  * To get link
963
963
  */
964
- public getLink: (config: GetLinkConfig) => GetLinkEvent | null;
964
+ public getLink: (config: GetLinkConfig) => Promise<GetLinkEvent | null>;
965
965
 
966
966
  /**
967
967
  * To copy link
968
968
  */
969
- public copyLink: (config: CopyLinkConfig) => CopyLinkEvent | null;
969
+ public copyLink: (config: CopyLinkConfig) => Promise<CopyLinkEvent | null>;
970
970
 
971
971
  /**
972
972
  * To add comment
973
973
  */
974
- public addComment: (config: AddCommentConfig) => any;
974
+ public addComment: (config: AddCommentConfig) => Promise<AddCommentEvent | null>;
975
975
 
976
976
  /**
977
977
  * To update comment
978
978
  */
979
- public updateComment: (config: UpdateCommentConfig) => any;
979
+ public updateComment: (config: UpdateCommentConfig) => Promise<UpdateCommentEvent | null>;
980
980
 
981
981
  /**
982
982
  * To delete comment
983
983
  */
984
- public deleteComment: (config: DeleteCommentConfig) => any;
984
+ public deleteComment: (config: DeleteCommentConfig) => Promise<DeleteCommentEvent | null>;
985
+
986
+ /**
987
+ * To get comment
988
+ */
989
+ public getComment: (config: GetCommentConfig) => Promise<Comment[]>;
990
+
991
+ /**
992
+ * To add attachment
993
+ */
994
+ public addAttachment: (config: AddAttachmentConfig) => Promise<AddAttachmentResponse[]>;
985
995
 
986
996
  /**
987
997
  * To get attachment
988
998
  */
989
- public getAttachment: (config: GetAttachmentConfig) => Attachment[];
999
+ public getAttachment: (config: GetAttachmentConfig) => Promise<Attachment[]>;
990
1000
 
991
1001
  /**
992
1002
  * To delete attachment
993
1003
  */
994
- public deleteAttachment: (config: DeleteAttachmentConfig) => any;
1004
+ public deleteAttachment: (config: DeleteAttachmentConfig) => Promise<DeleteAttachmentEvent | null>;
995
1005
 
996
1006
  /**
997
1007
  * To get recording
998
1008
  */
999
- public getRecording: (config: GetRecordingConfig) => RecordedData[];
1009
+ public getRecording: (config: GetRecordingConfig) => Promise<RecordedData[]>;
1000
1010
 
1001
1011
  /**
1002
1012
  * To delete recording
1003
1013
  */
1004
- public deleteRecording: (config: DeleteRecordingConfig) => any;
1014
+ public deleteRecording: (config: DeleteRecordingConfig) => Promise<DeleteRecordingEvent | null>;
1005
1015
 
1006
1016
  /**
1007
1017
  * To add reaction
1008
1018
  */
1009
- public addReaction: (config: AddReactionConfig) => Promise<any>;
1019
+ public addReaction: (config: AddReactionConfig) => Promise<AddReactionEvent | null>;
1010
1020
 
1011
1021
  /**
1012
1022
  * To delete reaction
1013
1023
  */
1014
- public deleteReaction: (config: DeleteReactionConfig) => Promise<any>;
1024
+ public deleteReaction: (config: DeleteReactionConfig) => Promise<DeleteReactionEvent | null>;
1015
1025
 
1016
1026
  /**
1017
1027
  * To toggle reaction
1018
1028
  */
1019
- public toggleReaction: (config: ToggleReactionConfig) => Promise<any>;
1029
+ public toggleReaction: (config: ToggleReactionConfig) => Promise<ToggleReactionEvent | null>;
1020
1030
 
1021
1031
  /**
1022
1032
  * Subscribe to comment actions
@@ -1992,6 +2002,11 @@ export declare class CommentElement {
1992
2002
  */
1993
2003
  private _deleteComment;
1994
2004
 
2005
+ /**
2006
+ * To get comment
2007
+ */
2008
+ private _getComment;
2009
+
1995
2010
  /**
1996
2011
  * To add attachment
1997
2012
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/types-dev",
3
- "version": "3.0.217",
3
+ "version": "3.0.219",
4
4
  "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.",
5
5
  "homepage": "https://velt.dev",
6
6
  "keywords": [