@veltdev/sdk 4.0.0-beta.3 → 4.0.0-beta.4

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

@@ -59,17 +59,10 @@ export interface DeleteCommentAnnotationRequest {
     annotationId: string;
     options?: RequestOptions;
 }
-export interface GetCommentAnnotationsRequest {
+export interface CommentRequestQuery {
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
-    options?: RequestOptions;
-}
-export interface GetCommentAnnotationsCountRequest {
-    documentIds?: string[];
-    locationIds?: string[];
-    statusIds?: string[];
-    options?: RequestOptions;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;

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

@@ -126,10 +126,6 @@ export interface DeleteCommentAnnotationEvent {
     commentAnnotation: CommentAnnotation;
     metadata: VeltEventMetadata;
 }
-export interface GetCommentAnnotationsEvent {
-    commentAnnotations: CommentAnnotation[];
-    metadata: VeltEventMetadata;
-}
 export interface GetCommentAnnotationsResponse {
     data: Record<string, CommentAnnotation[]> | null;
 }

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

@@ -7,7 +7,7 @@ import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.
 import { AutocompleteData } from "../data/autocomplete.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
-import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, GetCommentAnnotationsRequest, GetCommentAnnotationsCountRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, CommentRequestQuery, CommentRequestQuery, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
 import { UnreadCommentsCount } from "../data/comment-utils.data.model";
 export declare class CommentElement {
   /**
@@ -921,142 +921,142 @@ export declare class CommentElement {
   /**
    * To add comment annotation
    */
-  public addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
+  public addCommentAnnotation: (request: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
 
   /**
    * To approve comment annotation
    */
-  public approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
+  public approveCommentAnnotation: (request: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
 
   /**
    * To accept comment annotation
    */
-  public acceptCommentAnnotation: (config: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
+  public acceptCommentAnnotation: (request: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
 
   /**
    * To reject comment annotation
    */
-  public rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
+  public rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
 
   /**
    * To subscribe comment annotation
    */
-  public subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
+  public subscribeCommentAnnotation: (request: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
 
   /**
    * To unsubscribe comment annotation
    */
-  public unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
+  public unsubscribeCommentAnnotation: (request: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
 
   /**
    * To delete comment annotation
    */
-  public deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+  public deleteCommentAnnotation: (request: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
 
   /**
    * To get comment annotations
    */
-  public getCommentAnnotations: (config?: GetCommentAnnotationsRequest) => Observable<GetCommentAnnotationsEvent>;
+  public getCommentAnnotations: (query?: CommentRequestQuery) => Observable<GetCommentAnnotationsResponse>;
 
   /**
    * To get comment annotations count
    */
-  public getCommentAnnotationsCount: (config?: GetCommentAnnotationsCountRequest) => Observable<GetCommentAnnotationsCountEvent>;
+  public getCommentAnnotationsCount: (query?: CommentRequestQuery) => Observable<GetCommentAnnotationsCountResponse>;
 
   /**
    * To assign user to comment annotation
    */
-  public assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
+  public assignUser: (request: AssignUserRequest) => Promise<AssignUserEvent | null>;
 
   /**
    * To update priority
    */
-  public updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
+  public updatePriority: (request: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
 
   /**
    * To update status
    */
-  public updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
+  public updateStatus: (request: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
 
   /**
    * To update access
    */
-  public updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
+  public updateAccess: (request: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
 
   /**
    * To resolve comment annotation
    */
-  public resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<any>;
+  public resolveCommentAnnotation: (request: ResolveCommentAnnotationRequest) => Promise<any>;
 
   /**
    * To get link
    */
-  public getLink: (config: GetLinkRequest) => Promise<GetLinkEvent | null>;
+  public getLink: (request: GetLinkRequest) => Promise<GetLinkEvent | null>;
 
   /**
    * To copy link
    */
-  public copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
+  public copyLink: (request: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
 
   /**
    * To add comment
    */
-  public addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
+  public addComment: (request: AddCommentRequest) => Promise<AddCommentEvent | null>;
 
   /**
    * To update comment
    */
-  public updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
+  public updateComment: (request: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
 
   /**
    * To delete comment
    */
-  public deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
+  public deleteComment: (request: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
 
   /**
    * To get comment
    */
-  public getComment: (config: GetCommentRequest) => Promise<Comment[]>;
+  public getComment: (request: GetCommentRequest) => Promise<Comment[]>;
 
   /**
    * To add attachment
    */
-  public addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
+  public addAttachment: (request: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
 
   /**
    * To get attachment
    */
-  public getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[]>;
+  public getAttachment: (request: GetAttachmentRequest) => Promise<Attachment[]>;
 
   /**
    * To delete attachment
    */
-  public deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
+  public deleteAttachment: (request: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
 
   /**
    * To get recording
    */
-  public getRecording: (config: GetRecordingRequest) => Promise<RecordedData[]>;
+  public getRecording: (request: GetRecordingRequest) => Promise<RecordedData[]>;
 
   /**
    * To delete recording
    */
-  public deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
+  public deleteRecording: (request: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
 
   /**
    * To add reaction
    */
-  public addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
+  public addReaction: (request: AddReactionRequest) => Promise<AddReactionEvent | null>;
 
   /**
    * To delete reaction
    */
-  public deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
+  public deleteReaction: (request: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
 
   /**
    * To toggle reaction
    */
-  public toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
+  public toggleReaction: (request: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
 
   /**
    * Subscribe to comment actions

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.0.0-beta.3",
+    "version": "4.0.0-beta.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.",
     "homepage": "https://velt.dev",
     "keywords": [