@veltdev/sdk 3.0.67 → 3.0.69

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

@@ -0,0 +1,142 @@
+import { CommentAccessMode } from "../../utils/enums";
+import { Attachment } from "./attachment.model";
+import { CommentAnnotation } from "./comment-annotation.data.model";
+import { Comment } from "./comment.data.model";
+import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
+import { ReactionItem } from "./reaction-annotation.data.model";
+import { User } from "./user.data.model";
+export declare class ActionOptions {
+    organizationId?: string;
+    documentId?: string;
+}
+export declare class UpdatePriorityConfig {
+    annotationId: string;
+    priority?: CustomPriority;
+    options?: ActionOptions;
+}
+export declare class UpdateStatusConfig {
+    annotationId: string;
+    status: CustomStatus;
+    options?: ActionOptions;
+}
+export declare class UpdateAccessConfig {
+    annotationId: string;
+    accessMode: CommentAccessMode;
+    options?: ActionOptions;
+}
+export declare class ResolveCommentAnnotationConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class GetLinkConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class CopyLinkConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class AddCommentAnnotationConfig {
+    annotation: CommentAnnotation;
+    options?: ActionOptions;
+}
+export declare class ApproveCommentAnnotationConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class AcceptCommentAnnotationConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class RejectCommentAnnotationConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class DeleteCommentAnnotationConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class AddCommentConfig {
+    annotationId: string;
+    comment: Comment;
+    assignedTo?: User;
+    options?: ActionOptions;
+}
+export declare class UpdateCommentConfig {
+    annotationId: string;
+    comment: Comment;
+    skipDeleteThreadConfirmation?: boolean;
+    merge?: boolean;
+    options?: ActionOptions;
+}
+export declare class DeleteCommentConfig {
+    annotationId: string;
+    commentId: number;
+    skipDeleteThreadConfirmation?: boolean;
+    options?: ActionOptions;
+}
+export declare class GetCommentConfig {
+    annotationId: string;
+    options?: ActionOptions;
+}
+export declare class AddAttachmentConfig {
+    annotationId: string;
+    files: File[];
+    options?: ActionOptions;
+}
+export declare class AddAttachmentResponse {
+    valid: boolean;
+    file?: File;
+    maxAllowedSize: number;
+    error?: string;
+    attachment?: Attachment;
+}
+export declare class DeleteAttachmentConfig {
+    annotationId: string;
+    commentId: number;
+    attachmentId: number;
+    options?: ActionOptions;
+}
+export declare class GetAttachmentConfig {
+    annotationId: string;
+    commentId: number;
+    options?: ActionOptions;
+}
+export declare class GetRecordingConfig {
+    annotationId: string;
+    commentId: number;
+    options?: ActionOptions;
+}
+export declare class DeleteRecordingConfig {
+    annotationId: string;
+    commentId: number;
+    recorderId: string;
+    options?: ActionOptions;
+}
+export declare class AddReactionConfig {
+    annotationId: string;
+    commentId: number;
+    reaction: {
+        reactionId: string;
+        customReaction?: ReactionItem;
+    };
+    options?: ActionOptions;
+}
+export declare class DeleteReactionConfig {
+    annotationId: string;
+    commentId: number;
+    reaction: {
+        reactionId: string;
+        customReaction?: ReactionItem;
+    };
+    options?: ActionOptions;
+}
+export declare class ToggleReactionConfig {
+    annotationId: string;
+    commentId: number;
+    reaction: {
+        reactionId: string;
+        customReaction?: ReactionItem;
+    };
+    options?: ActionOptions;
+}

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

@@ -1,6 +1,14 @@
-import { CommentStatus } from "../../utils/enums";
+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;
@@ -31,3 +39,120 @@ 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 {
+    annotationId?: string;
+    commentId?: number;
+    commentAnnotation?: CommentAnnotation;
+    attachment: Attachment;
+    metadata: CommentEventMetadata;
+}
+export interface AddCommentAnnotationEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
+}
+export interface ApproveCommentAnnotationEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
+}
+export interface AcceptCommentAnnotationEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
+}
+export interface RejectCommentAnnotationEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
+}
+export interface DeleteCommentAnnotationEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    metadata: CommentEventMetadata;
+}
+export interface AddCommentEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    comment: Comment;
+    metadata: CommentEventMetadata;
+}
+export interface UpdateCommentEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    comment: Comment;
+    metadata: CommentEventMetadata;
+}
+export interface DeleteCommentEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    comment: Comment;
+    metadata: CommentEventMetadata;
+}
+export interface DeleteRecordingEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    recording: RecordedData;
+    metadata: CommentEventMetadata;
+}
+export interface ReactionEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    commentId?: number;
+    reaction: ReactionAnnotation;
+    metadata: CommentEventMetadata;
+}
+export interface AddReactionEvent extends ReactionEvent {
+}
+export interface DeleteReactionEvent extends ReactionEvent {
+}
+export interface ToggleReactionEvent extends ReactionEvent {
+}
+export interface UpdateStatusEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    newStatus: CustomStatus;
+    oldStatus: CustomStatus;
+    metadata: CommentEventMetadata;
+}
+export interface UpdatePriorityEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    newPriority?: CustomPriority;
+    oldPriority?: CustomPriority;
+    metadata: CommentEventMetadata;
+}
+export interface UpdateAccessEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    newAccessMode?: CommentAccessMode;
+    oldAccessMode?: CommentAccessMode;
+    metadata: CommentEventMetadata;
+}
+export interface GetLinkEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    link: string | null;
+    metadata: CommentEventMetadata;
+}
+export interface CopyLinkEvent {
+    annotationId?: string;
+    commentAnnotation?: CommentAnnotation;
+    link: string;
+    metadata: CommentEventMetadata;
+}

package/app/models/data/reaction-annotation.data.model.d.ts

@@ -52,9 +52,10 @@ export declare class ReactionAnnotation {
     iconEmoji?: string;
 }
 export declare class ReactionMap {
-    [reactionId: string]: {
-        url?: string;
-        svg?: string;
-        emoji?: string;
-    };
+    [reactionId: string]: ReactionItem;
+}
+export declare class ReactionItem {
+    url?: string;
+    svg?: string;
+    emoji?: string;
 }

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

@@ -1,12 +1,13 @@
 // @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";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
+import { AcceptCommentAnnotationConfig, AddAttachmentConfig, AddAttachmentResponse, AddCommentAnnotationConfig, AddCommentConfig, AddReactionConfig, ApproveCommentAnnotationConfig, CopyLinkConfig, DeleteAttachmentConfig, DeleteCommentAnnotationConfig, DeleteCommentConfig, DeleteReactionConfig, DeleteRecordingConfig, GetAttachmentConfig, GetCommentConfig, GetLinkConfig, GetRecordingConfig, RejectCommentAnnotationConfig, ResolveCommentAnnotationConfig, ToggleReactionConfig, UpdateAccessConfig, UpdateCommentConfig, UpdatePriorityConfig, UpdateStatusConfig } from "../data/comment-actions.data.model";
 export declare class CommentElement {
   /**
    * Subscribe to comments on the current document.
@@ -912,6 +913,125 @@ export declare class CommentElement {
    */
   public disableShortUserName: () => void;
 
+  /**
+   * To add comment annotation
+   */
+  public addCommentAnnotation: (config: AddCommentAnnotationConfig) => Promise<AddCommentAnnotationEvent | null>;
+
+  /**
+   * To approve comment annotation
+   */
+  public approveCommentAnnotation: (config: ApproveCommentAnnotationConfig) => Promise<ApproveCommentAnnotationEvent | null>;
+
+  /**
+   * To accept comment annotation
+   */
+  public acceptCommentAnnotation: (config: AcceptCommentAnnotationConfig) => Promise<AcceptCommentAnnotationEvent | null>;
+
+  /**
+   * To reject comment annotation
+   */
+  public rejectCommentAnnotation: (config: RejectCommentAnnotationConfig) => Promise<RejectCommentAnnotationEvent | null>;
+
+  /**
+   * To delete comment annotation
+   */
+  public deleteCommentAnnotation: (config: DeleteCommentAnnotationConfig) => Promise<DeleteCommentAnnotationEvent | null>;
+
+  /**
+   * To update priority
+   */
+  public updatePriority: (config: UpdatePriorityConfig) => Promise<UpdatePriorityEvent | null>;
+
+  /**
+   * To update status
+   */
+  public updateStatus: (config: UpdateStatusConfig) => Promise<UpdateStatusEvent | null>;
+
+  /**
+   * To update access
+   */
+  public updateAccess: (config: UpdateAccessConfig) => Promise<UpdateAccessEvent | null>;
+
+  /**
+   * To resolve comment annotation
+   */
+  public resolveCommentAnnotation: (config: ResolveCommentAnnotationConfig) => Promise<any>;
+
+  /**
+   * To get link
+   */
+  public getLink: (config: GetLinkConfig) => Promise<GetLinkEvent | null>;
+
+  /**
+   * To copy link
+   */
+  public copyLink: (config: CopyLinkConfig) => Promise<CopyLinkEvent | null>;
+
+  /**
+   * To add comment
+   */
+  public addComment: (config: AddCommentConfig) => Promise<AddCommentEvent | null>;
+
+  /**
+   * To update comment
+   */
+  public updateComment: (config: UpdateCommentConfig) => Promise<UpdateCommentEvent | null>;
+
+  /**
+   * To delete comment
+   */
+  public deleteComment: (config: DeleteCommentConfig) => Promise<DeleteCommentEvent | null>;
+
+  /**
+   * To get comment
+   */
+  public getComment: (config: GetCommentConfig) => Promise<Comment[]>;
+
+  /**
+   * To add attachment
+   */
+  public addAttachment: (config: AddAttachmentConfig) => Promise<AddAttachmentResponse[]>;
+
+  /**
+   * To get attachment
+   */
+  public getAttachment: (config: GetAttachmentConfig) => Promise<Attachment[]>;
+
+  /**
+   * To delete attachment
+   */
+  public deleteAttachment: (config: DeleteAttachmentConfig) => Promise<DeleteAttachmentEvent | null>;
+
+  /**
+   * To get recording
+   */
+  public getRecording: (config: GetRecordingConfig) => Promise<RecordedData[]>;
+
+  /**
+   * To delete recording
+   */
+  public deleteRecording: (config: DeleteRecordingConfig) => Promise<DeleteRecordingEvent | null>;
+
+  /**
+   * To add reaction
+   */
+  public addReaction: (config: AddReactionConfig) => Promise<AddReactionEvent | null>;
+
+  /**
+   * To delete reaction
+   */
+  public deleteReaction: (config: DeleteReactionConfig) => Promise<DeleteReactionEvent | null>;
+
+  /**
+   * To toggle reaction
+   */
+  public toggleReaction: (config: ToggleReactionConfig) => Promise<ToggleReactionEvent | null>;
+
+  /**
+   * Subscribe to comment actions
+   */
+  public on: (action: CommentActionTypes) => Observable<any>;
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -1809,4 +1929,126 @@ export declare class CommentElement {
    * To disable short user name
    */
   private _disableShortUserName;
+
+  // actions
+
+  /**
+   * To add comment annotation
+   */
+  private _addCommentAnnotation;
+
+  /**
+   * To approve comment annotation
+   */
+  private _approveCommentAnnotation;
+
+  /**
+   * To accept comment annotation
+   */
+  private _acceptCommentAnnotation;
+
+  /**
+   * To reject comment annotation
+   */
+  private _rejectCommentAnnotation;
+
+  /**
+   * To delete comment annotation
+   */
+  private _deleteCommentAnnotation;
+
+  /**
+   * To update priority
+   */
+  private _updatePriority;
+
+  /**
+   * To update status
+   */
+  private _updateStatus;
+
+  /**
+   * To update access
+   */
+  private _updateAccess;
+
+  /**
+   * To resolve comment annotation
+   */
+  private _resolveCommentAnnotation;
+
+  /**
+   * To get link
+   */
+  private _getLink;
+
+  /**
+   * To copy link
+   */
+  private _copyLink;
+
+  /**
+   * To add comment
+   */
+  private _addComment;
+
+  /**
+   * To update comment
+   */
+  private _updateComment;
+
+  /**
+   * To delete comment
+   */
+  private _deleteComment;
+
+  /**
+   * To get comment
+   */
+  private _getComment;
+
+  /**
+   * To add attachment
+   */
+  private _addAttachment;
+
+  /**
+   * To delete attachment
+   */
+  private _deleteAttachment;
+
+  /**
+   * To get attachment
+   */
+  private _getAttachment;
+
+  /**
+   * To delete recording
+   */
+  private _deleteRecording;
+
+  /**
+   * To get recording
+   */
+  private _getRecording;
+
+  /**
+   * To add reaction
+   */
+  private _addReaction;
+
+  /**
+   * To delete reaction
+   */
+  private _deleteReaction;
+
+  /**
+   * To toggle reaction
+   */
+  private _toggleReaction;
+
+  /**
+   * Subscribe to comment actions
+   */
+  private _on;
 }

package/app/utils/enums.d.ts

@@ -16,6 +16,29 @@ export declare enum CommentStatus {
     SUBSCRIBED = "subscribed",
     UNSUBSCRIBED = "unsubscribed"
 }
+export declare enum CommentActionTypes {
+    ADD_COMMENT_ANNOTATION = "addCommentAnnotation",
+    UPDATE_COMMENT_ANNOTATION = "updateCommentAnnotation",
+    DELETE_COMMENT_ANNOTATION = "deleteCommentAnnotation",
+    APPROVE_COMMENT_ANNOTATION = "approveCommentAnnotation",
+    ACCEPT_COMMENT_ANNOTATION = "acceptCommentAnnotation",
+    REJECT_COMMENT_ANNOTATION = "rejectCommentAnnotation",
+    UPDATE_STATUS = "updateStatus",
+    UPDATE_PRIORITY = "updatePriority",
+    UPDATE_ACCESS = "updateAccess",
+    RESOLVE_COMMENT = "resolveComment",
+    ADD_COMMENT = "addComment",
+    UPDATE_COMMENT = "updateComment",
+    DELETE_COMMENT = "deleteComment",
+    ADD_ATTACHMENT = "addAttachment",
+    DELETE_ATTACHMENT = "deleteAttachment",
+    DELETE_RECORDING = "deleteRecording",
+    GET_LINK = "getLink",
+    COPY_LINK = "copyLink",
+    ADD_REACTION = "addReaction",
+    DELETE_REACTION = "deleteReaction",
+    TOGGLE_REACTION = "toggleReaction"
+}
 export declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",

package/models.d.ts

@@ -5,6 +5,7 @@ export * from './app/models/data/chatgpt.data.model';
 export * from './app/models/data/comment-annotation.data.model';
 export * from './app/models/data/comment-events.data.model';
 export * from './app/models/data/comment.data.model';
+export * from './app/models/data/comment-actions.data.model';
 export * from './app/models/data/config.data.model';
 export * from './app/models/data/cursor-position.data.model';
 export * from './app/models/data/cursor-user.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "3.0.67",
+    "version": "3.0.69",
     "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": [