@veltdev/types-dev 3.0.217 → 3.0.218

package/app/models/data/comment-events.data.model.d.ts

@@ -2,8 +2,13 @@ import { CommentAccessMode, CommentStatus } from "../../utils/enums";
 import { Attachment } from "./attachment.model";
 import { AddAttachmentResponse } from "./comment-actions.data.model";
 import { CommentAnnotation, UpdateContextConfig } from "./comment-annotation.data.model";
+import { Comment } from "./comment.data.model";
 import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
+import { DocumentMetadata } from "./document-metadata.model";
 import { Location } from "./location.model";
+import { OrganizationMetadata } from "./organization-metadata.model";
+import { ReactionAnnotation } from "./reaction-annotation.data.model";
+import { RecordedData } from "./recorder.model";
 import { User } from "./user.data.model";
 export interface CommentAddEventData {
     annotation: CommentAnnotation;
@@ -34,56 +39,83 @@ export interface CommentSuggestionEventData {
     replaceContentText?: string;
     annotation?: any;
 }
+export interface CommentEventMetadata {
+    organizationMetadata?: OrganizationMetadata | null;
+    documentMetadata?: DocumentMetadata | null;
+    location?: Location | null;
+}
 export interface AddAttachmentEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
     attachments: AddAttachmentResponse[];
+    metadata: CommentEventMetadata;
 }
 export interface DeleteAttachmentEvent {
-    deletedAttachment: Attachment;
-    annotationId: string;
-    commentId: number;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentId?: number;
+    commentAnnotation?: CommentAnnotation;
+    attachment: Attachment;
+    metadata: CommentEventMetadata;
 }
 export interface AddCommentAnnotationEvent {
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface ApproveCommentAnnotationEvent {
-    annotationId: string;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface AcceptCommentAnnotationEvent {
-    annotationId: string;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface RejectCommentAnnotationEvent {
-    annotationId: string;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface DeleteCommentAnnotationEvent {
-    annotationId: string;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface AddCommentEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    comment: Comment;
+    metadata: CommentEventMetadata;
 }
 export interface UpdateCommentEvent {
-    annotationId: string;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
     comment: Comment;
-    annotation: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface DeleteCommentEvent {
-    annotationId: string;
-    commentId: number;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    comment: Comment;
+    metadata: CommentEventMetadata;
 }
 export interface DeleteRecordingEvent {
-    annotationId: string;
-    commentId: number;
-    recorderId: string;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    recording: RecordedData;
+    metadata: CommentEventMetadata;
 }
 export interface ReactionEvent {
-    annotationId: string;
-    commentId: number;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    reaction: ReactionAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface AddReactionEvent extends ReactionEvent {
 }
@@ -92,30 +124,35 @@ export interface DeleteReactionEvent extends ReactionEvent {
 export interface ToggleReactionEvent extends ReactionEvent {
 }
 export interface UpdateStatusEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
     newStatus: CustomStatus;
     oldStatus: CustomStatus;
-    annotationId: string;
-    annotation: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface UpdatePriorityEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
     newPriority?: CustomPriority;
     oldPriority?: CustomPriority;
-    annotationId: string;
-    annotation: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface UpdateAccessEvent {
-    newAccessMode: CommentAccessMode;
-    oldAccessMode: CommentAccessMode;
-    annotationId: string;
-    annotation: CommentAnnotation;
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    newAccessMode?: CommentAccessMode;
+    oldAccessMode?: CommentAccessMode;
+    metadata: CommentEventMetadata;
 }
 export interface GetLinkEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
     link: string | null;
-    annotationId: string;
-    annotation: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }
 export interface CopyLinkEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
     link: string;
-    annotationId: string;
-    annotation: CommentAnnotation;
+    metadata: CommentEventMetadata;
 }

package/app/models/element/comment-element.model.d.ts

@@ -1,7 +1,7 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
-import { CommentAddEventData, CommentUpdateEventData } from "../data/comment-events.data.model";
+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";
 import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
 import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
 import { AutocompleteData } from "../data/autocomplete.data.model";
@@ -916,107 +916,107 @@ export declare class CommentElement {
   /**
    * To add comment annotation
    */
-  public addCommentAnnotation: (config: AddCommentAnnotationConfig) => any;
+  public addCommentAnnotation: (config: AddCommentAnnotationConfig) => Promise<AddCommentAnnotationEvent | null>;
 
   /**
    * To approve comment annotation
    */
-  public approveCommentAnnotation: (config: ApproveCommentAnnotationConfig) => any;
+  public approveCommentAnnotation: (config: ApproveCommentAnnotationConfig) => Promise<ApproveCommentAnnotationEvent | null>;
 
   /**
    * To accept comment annotation
    */
-  public acceptCommentAnnotation: (config: AcceptCommentAnnotationConfig) => any;
+  public acceptCommentAnnotation: (config: AcceptCommentAnnotationConfig) => Promise<AcceptCommentAnnotationEvent | null>;
 
   /**
    * To reject comment annotation
    */
-  public rejectCommentAnnotation: (config: RejectCommentAnnotationConfig) => any;
+  public rejectCommentAnnotation: (config: RejectCommentAnnotationConfig) => Promise<RejectCommentAnnotationEvent | null>;
 
   /**
    * To delete comment annotation
    */
-  public deleteCommentAnnotation: (config: DeleteCommentAnnotationConfig) => any;
+  public deleteCommentAnnotation: (config: DeleteCommentAnnotationConfig) => Promise<DeleteCommentAnnotationEvent | null>;
 
   /**
    * To update priority
    */
-  public updatePriority: (config: UpdatePriorityConfig) => any;
+  public updatePriority: (config: UpdatePriorityConfig) => Promise<UpdatePriorityEvent | null>;
 
   /**
    * To update status
    */
-  public updateStatus: (config: UpdateStatusConfig) => any;
+  public updateStatus: (config: UpdateStatusConfig) => Promise<UpdateStatusEvent | null>;
 
   /**
    * To update access
    */
-  public updateAccess: (config: UpdateAccessConfig) => any;
+  public updateAccess: (config: UpdateAccessConfig) => Promise<UpdateAccessEvent | null>;
 
   /**
    * To resolve comment annotation
    */
-  public resolveCommentAnnotation: (config: ResolveCommentAnnotationConfig) => any;
+  public resolveCommentAnnotation: (config: ResolveCommentAnnotationConfig) => Promise<any>;
 
   /**
    * To get link
    */
-  public getLink: (config: GetLinkConfig) => GetLinkEvent | null;
+  public getLink: (config: GetLinkConfig) => Promise<GetLinkEvent | null>;
 
   /**
    * To copy link
    */
-  public copyLink: (config: CopyLinkConfig) => CopyLinkEvent | null;
+  public copyLink: (config: CopyLinkConfig) => Promise<CopyLinkEvent | null>;
 
   /**
    * To add comment
    */
-  public addComment: (config: AddCommentConfig) => any;
+  public addComment: (config: AddCommentConfig) => Promise<AddCommentEvent | null>;
 
   /**
    * To update comment
    */
-  public updateComment: (config: UpdateCommentConfig) => any;
+  public updateComment: (config: UpdateCommentConfig) => Promise<UpdateCommentEvent | null>;
 
   /**
    * To delete comment
    */
-  public deleteComment: (config: DeleteCommentConfig) => any;
+  public deleteComment: (config: DeleteCommentConfig) => Promise<DeleteCommentEvent | null>;
 
   /**
    * To get attachment
    */
-  public getAttachment: (config: GetAttachmentConfig) => Attachment[];
+  public getAttachment: (config: GetAttachmentConfig) => Promise<Attachment[]>;
 
   /**
    * To delete attachment
    */
-  public deleteAttachment: (config: DeleteAttachmentConfig) => any;
+  public deleteAttachment: (config: DeleteAttachmentConfig) => Promise<DeleteAttachmentEvent | null>;
 
   /**
    * To get recording
    */
-  public getRecording: (config: GetRecordingConfig) => RecordedData[];
+  public getRecording: (config: GetRecordingConfig) => Promise<RecordedData[]>;
 
   /**
    * To delete recording
    */
-  public deleteRecording: (config: DeleteRecordingConfig) => any;
+  public deleteRecording: (config: DeleteRecordingConfig) => Promise<DeleteRecordingEvent | null>;
 
   /**
    * To add reaction
    */
-  public addReaction: (config: AddReactionConfig) => Promise<any>;
+  public addReaction: (config: AddReactionConfig) => Promise<AddReactionEvent | null>;
 
   /**
    * To delete reaction
    */
-  public deleteReaction: (config: DeleteReactionConfig) => Promise<any>;
+  public deleteReaction: (config: DeleteReactionConfig) => Promise<DeleteReactionEvent | null>;
 
   /**
    * To toggle reaction
    */
-  public toggleReaction: (config: ToggleReactionConfig) => Promise<any>;
+  public toggleReaction: (config: ToggleReactionConfig) => Promise<ToggleReactionEvent | null>;
 
   /**
    * Subscribe to comment actions

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types-dev",
-    "version": "3.0.217",
+    "version": "3.0.218",
     "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": [